Guest

Cisco Unified Communications Manager IM & Presence Service

Cisco Unified Presence Server Licensing Explained

Document ID: 116157

Updated: Jun 13, 2013

Contributed by Jasmeet Sandhu, Cisco TAC Engineer.

   Print

Introduction

This document describes licensing information for the Cisco Unified Presence Server (CUPS).

Prerequisites 

Requirements

There are no specific requirements for this document.

Components Used

The information in this document is based on CUPS Version 8.x.

The information in this document was created from the devices in a specific lab environment. All of the devices used in this document started with a cleared (default) configuration. If your network is live, make sure that you understand the potential impact of any command.

CUPS Licensing Explained

 
In order to fully license CUPS, these licenses are required within the license file:

  • ENT_PE_NODE is for the Cisco UP Presence Engine.
  • ENT_PROXY_NODE is for the Cisco UP SIP PROXY.
  • SW_FEATURE is required to upgrade from any prior version of CUPS to Version 8.x.

Note: A fresh installation of CUPS Version 8.x comes with a built-in SW_FEATURE license in the database.

Problem

After you upload the license file on the Presence Server, the system still displays license warnings.

There are two types of license warnings:

  • An Evaluation Period warning, which needs to be resolved in 90 days.
  • A Grace Period warning, which needs to be resolved in 30 days.


Evaluation Period means that the Presence Server is a fresh installation, and the system grants up to 90 days to upload the correct licenses.

Grace Period means that this Presence Server node was once fully licensed. Later, a network configuration was changed, such as Hostname/IP Address/Network Time Protocol (NTP)/Simple Mail Transfer Protocol (SMTP)/Domain/Domain Name System (DNS) that changed the License MAC field of the Presence Server. This warning is only seen on virtual machines because the License MAC for the Physical Server is associated with the Network Interface Controller (NIC) of that server. This warning is also seen when the Presence Server is migrated from a physical to a virtual machine or vice versa.

These reasons can cause the Presence Server to display the license warning:

  1. The HOSTID field of the license file does not match the License MAC field of the Presence Server.
  2. The Licenseinfo Table in the Presence Server database still contains the previous MAC address, which needs to be removed via ROOT Access to the Presence Server CLI.
  3. You uploaded the PHONE_UNITS license file onto the Presence Server, which then needs to be removed from the Presence Server Licenseinfo Table in the database via ROOT Access.

Solution 1

Verify the current License MAC field and whether the Presence Server node is on a virtual or physical machine.

In order to verify the License MAC field, enter the command show status on the Presence Server CLI and note the value of the field "License MAC."

    admin:show status

    Host Name    : cups863
    Date         : Mon Nov 5, 2012 22:43:35
    Time Zone    : Central Standard Time (America/Chicago)
    Locale       : en_US.UTF-8
    Product Ver  : 8.6.3.10000-20
    OS Ver       : 4.0.0.0-44
    License MAC  : 8001fc5ffc76

In the previous example, the License MAC field is 8001fc5ffc76.

Next, in order to verify if this server is virtual or physical, enter the command show hardware on the Presence Server CLI and note the value of the field "HW Platform."

admin: show hardware

HW Platform       : VMware Virtual Machine
Processors        : 1
Type              : Intel(R) Xeon(R) CPU E7- 2870  @ 2.40GHz
CPU Speed         : 2400
Memory            : 2048 MBytes
Object ID         : VMware
OS Version        : UCOS 4.0.0.0-44
Serial Number     : VMware-42 1c 56 21 03 fb 5c 86-37 2d 3f f1 5a 56 51 a5

The HW Platform parameter from the previous output indicates that this machine is a virtual machine.

Finally, match the License MAC of the Presence Server with the HOSTID Parameter in the license file.

Note: If the Presence Server is a virtual machine, then the HOSTID parameter of the license file should have HOSTID=HOSTNAME=License MAC. If it is a physical machine, then the HOSTID should be HOSTID=License Mac.

Note: The value for HOSTID should be ALL CAPS. Even though the show status command provides the output in lower case "8001fc5ffc76," the value in the License file for HOSTID should be "8001FC5FFC76."

Below is the sample license file, which is the Presence Engine and Proxy Licenses.

INCREMENT ENT_PE_NODE cisco 1.0 permanent uncounted \
    VENDOR_STRING=<Count>2</Count><OrigMacId>8001FC5FFC76</OrigMacId>
<LicMacId>8001FC5FFC76</LicMacId><LicFileVersion>2.0</LicFileVersion> \
    HOSTID=HOSTNAME=8001FC5FFC76 \
    NOTICE="<LicFileID>20120828112634008</LicFileID><LicLineID>1</LicLineID>
    <PAK></PAK>" SIGN="06E9 F551 A2DB 13F2 A2DF 2F75 A55E 50BF \
    0E37 0337 CC92 039D D36E 0CF5 FD88 1363 9594 6A66 5267 4588 \
    AA58 98B5 E112 F93A 652C 36A6 3805 2546 6280 5316"
INCREMENT ENT_PROXY_NODE cisco 1.0 permanent uncounted \
    VENDOR_STRING=<Count>2</Count><OrigMacId>8001FC5FFC76</OrigMacId>
<LicMacId>8001FC5FFC76</LicMacId><LicFileVersion>2.0</LicFileVersion> \
    HOSTID=HOSTNAME=8001FC5FFC76 \
    NOTICE="<LicFileID>20120828112634008</LicFileID><LicLineID>2</LicLineID> \
    <PAK></PAK>" SIGN="18ED 8670 308B 9300 9BC8 7D03 A1EE 4ED9 \
    4432 98CF CF92 6B71 73C4 B603 410F 1A93 A4AE 69D1 0B29 EC0D \
    202E 8AB3 5F75 790F B951 B87B 01F7 59A0 07FF 3E79"

In the previous example, the Presence Server is a virtual machine with a License MAC of "8001fc5ffc76." The HOSTID value in the license file should be HOSTID=HOSTNAME=8001FC5FFC76.
If the HOSTID does not match, the system generates license warnings. In order to resolve this problem, open a case with the Cisco Licensing Team and provide this information:

  1. The correct MAC address.
  2. Whether the machine is virtual or physical.
  3. If the HOSTID is all CAPS or lower case.

If the warning still persists after you upload the correct file, verify that the correct information is stored in the Licenseinfo Table on the Presence Server database.

Solution 2

Verify the content in the Licenseinfo Table of the CUPS database.

In order to view the content of the Licenseinfo Table, enter the command run sql select * from licenseinfo on the Presence Server Publisher CLI.

admin:run sql select * from licenseinfo
pkid                                 fklicenseserver                      tklicensefeature licenseunits overdraftunits macaddress   version origmacid    licfileid         licfileversion isdemo licenselineid upgradefromwindows permanent daystoexpiry fileid isvalid
==================================== ==================================== ================ ============ ============== ============ ======= ============ ================= ============== ====== ============= ================== ========= ============ ====== =======
7f18d7c8-d1e4-43d9-9592-e7aedbed80b8 78893507-f5dc-4a9c-bcce-77824a14b9b7 3                1            0                           8.0                  12345             1.0            t      1             f                  t         0                  
t50966b38-dc45-4a94-82b8-c4c85d159e58 78893507-f5dc-4a9c-bcce-77824a14b9b7 4                2            0              8001fc5ffc76 1.0     8001fc5ffc76 20120828112634008 2.0            f      2             f                  t         0                  
tfc175de4-e6ae-4cae-90f8-1711563cee94 78893507-f5dc-4a9c-bcce-77824a14b9b7 5                2            0              8001fc5ffc76 1.0     8001fc5ffc76 20120828112634008 2.0            f      1             f                  t         0                   t

In the previous output, these fields should be noted:

tklicensefeature - Indicates the license feature: PE License, Proxy License, or SW_FEATURE

    tklicensefeature=3 (refers to the Software Version) //Introduced in 8.x
    tklicensefeature=4 (refers to the CUP Proxy)
    tklicensefeature=5 (refers to the CUP Presence Engine)

    If there is any value other than 3/4/5, then that row needs to be removed via ROOT Access.
    
macaddress - This value should match the current License MAC field. The value in the database does not show "HOSTNAME=" even if it is a virtual machine or if the License MAC field is uppercase as with the file.

Licfileid - Provides the NAME of the License file that has been uploaded to the Presence Server.

As an example, in order to remove the junk file from the database, verify the file name and the content of that file name from the previous output. If the MAC Address "8001fc5ffc76" is not the correct address, remove it from the database:

In order to remove the file from the File System, enter this command:

admin:file delete license UPS20120828112634008.lic
Delete the File UPS20120828112634008.lic?
Enter "y" followed by return to continue: y
files: found = 1, deleted = 1

Warning: After you remove any file, you should restart the "Cisco License Manager" Service so that the File System is replicated to the database. The Service can be restarted from the Presence Server Serviceability Page > Tools > Control Center - Network Services > Cisco License Manager. Restart of this service does NOT impact service and can be done during production hours.

In order to view the content of the Licenseinfo Table and verify that the junk information has been removed, enter the command again.

admin:run sql select * from licenseinfo
pkid                                 fklicenseserver                      tklicensefeature licenseunits overdraftunits macaddress   version origmacid    licfileid         licfileversion isdemo licenselineid upgradefromwindows permanent daystoexpiry fileid isvalid
==================================== ==================================== ================ ============ ============== ============ ======= ============ ================= ============== ====== ============= ================== ========= ============ ====== =======
7f18d7c8-d1e4-43d9-9592-e7aedbed80b8 78893507-f5dc-4a9c-bcce-77824a14b9b7 3                1            0                           8.0                  12345             1.0            t      1             f                  t         0                   t

Now, both the rows that were associated to the licfileid 20120828112634008 have been removed.

In some scenarios, the database still does not clear after you remove the file. In this situation, a root account needs to be generated to clean the values directly in the database. Please contact the Cisco Technical Assistance Center to perform that procedure.

Related Information

Updated: Jun 13, 2013
Document ID: 116157