Cisco Unified Communications Manager System Guide, Release 7.1(2)
Licensing
Downloads: This chapterpdf (PDF - 165.0KB) The complete bookPDF (PDF - 13.12MB) | Feedback

Licensing

Table Of Contents

Licensing

Licenses for Phones

Licenses for Adjunct Devices

Licenses for Applications

Licenses for Cisco IP Communicator

Licenses for Cisco Unified Mobility

Licenses for Cisco Unified Mobile Communicator

License Calculations

License File Contents

Splitting Licenses

Software License Version

Starter Licenses

Licensing and the Cisco CallManager Service

Alarms, Alerts, and License Status Notification

Where to Find More Information


Licensing


Use licensing in Cisco Unified Communications Manager Administration to accurately track the number of devices that are connected to Cisco Unified Communications Manager, including third-party phones that run SIP, and compare it with the number of unit licenses that have been purchased.

Licensing helps manage Cisco Unified Communications Manager licenses and enforces the licenses for Cisco Unified Communications Manager applications and the number of devices.

Licenses get generated for requested Cisco Unified Communications Manager nodes (servers in a Cisco Unified Communications Manager cluster) and the devices that are associated with those nodes.Two types of licenses exist: production licenses and starter licenses. Production licenses for Cisco Unified Communications Manager comprise licenses for devices and nodes that are purchased from Cisco. License device types include physical devices such as IP phones and applications such as IP communicator.

New installations of Cisco Unified Communications Manager include starter licenses that get replaced when a production license file gets uploaded. Cisco does not provide starter licenses for upgrades or migrations.

This section covers the following topics:

Licenses for Phones

Licenses for Adjunct Devices

Licenses for Applications

Licenses for Cisco IP Communicator

Licenses for Cisco Unified Mobility

License Calculations

License File Contents

Splitting Licenses

Software License Version

Starter Licenses

Licensing and the Cisco CallManager Service

Alarms, Alerts, and License Status Notification

Where to Find More Information

Licenses for Phones

Each phone type requires a fixed number of device license units. For example, Cisco Unified IP Wireless Phone 7920 requires four device license units, and Cisco Unified IP Phone 7970 requires five device license units. If you want licenses for four 7920 phones and four 7970 phones, you require 36 device license units.

Before you configure a phone in the Phone Configuration window, consider the following information:

If the Cisco Unified Communications Manager database contains a real MAC address for a phone, not the dummy MAC address that is created via the Bulk Administration Tool (BAT), licensing immediately consumes device license units for the phone after the phone gets added to the database.

If the number of used device license units and number of pending device licensing units do not exceed the total number of device license units that are available for use, the phone with the real MAC address gets added to the database.

If the number of used device license units and number of pending device licensing units exceed the total number of device license units that are available for use, the phone with the real MAC address does not get added to the database.

Licensing uses the Is Active check box in the Phone Configuration window in Cisco Unified Communications Manager Administration to determine whether to consume device license units for the phone. In addition, Cisco Unified Communications Manager uses this check box to determine whether a phone should register with Cisco Unified Communications Manager.

For a phone that uses a real MAC address, not the dummy MAC address that is created via BAT, the check box displays as checked and disabled, which indicates that the phone uses device license units and can register with Cisco Unified Communications Manager.

For a phone that uses the dummy MAC address that is created via BAT, the Is Active check box displays as unchecked and enabled. If you manually convert the dummy MAC address to a real MAC address in the Phone Configuration window, check the Is Active check box, which ensures that the phone can register with Cisco Unified Communications Manager and that licensing consumes device license units for the phone.

Cisco Unified Communications Manager allows you to provision phones with dummy MAC addresses via BAT as long as the number of used device license units and the number of pending device license units do not exceed the total number of device license units that are available for use.

If you use the Cisco Unified Communications Manager Auto-Register Phone Tool (TAPS) to associate an auto-registered phone with the BAT dummy settings, the Cisco Unified Communications Manager Auto-Register Phone Tool deletes the auto-registered phone from the database, and licensing gives you credits for the device license units for the deleted phone. After the Cisco Unified Communications Manager Auto-Register Phone Tool applies the device name to the phone that uses the dummy MAC address, the Cisco Unified Communications Manager Auto-Register Phone Tool updates the Is Active check box to display as checked and disabled. Licensing consumes device license units for the phone, and the phone can register with Cisco Unified Communications Manager, unless the number of used device license units exceeds the total number of device license units that are available for use.

When a phone auto-registers for use with the Cisco Unified Communications Manager Auto-Register Phone Tool, it gets inserted into the database as long as the number of used device license units is less than the number of device license units that are available for use.

You can view the number of pending, used, and available device license units in the License Unit Report and the License Unit Calculator in Cisco Unified Communications Manager Administration.

Licenses for Adjunct Devices

With adjunct licensing, fewer device license units (DLUs) get consumed for adjunct (secondary) devices, such as Cisco IP Communicator, Cisco Unified Personal Communicator, and Cisco Unified Mobile Communicator, when these applications get used with a Cisco Unified IP Phone, which serves as the primary device. For adjunct licensing to work, the adjunct device must consume fewer or the same number of DLUs as the primary device.

For example, if you configure Cisco IP Communicator as a secondary device for the Cisco Unified IP Phone 7970, Cisco IP Communicator consumes only one DLU. Adjunct licensing works because the Cisco Unified IP Phone 7970 consumes five DLUs and Cisco IP Communicator consumes three DLUs.

In another example, if you configure Cisco IP Communicator as a secondary device for the Cisco Unified IP Phone 7906, adjunct licensing fails because the Cisco Unified IP Phone 7906 consumes two DLUs and Cisco IP Communicator consumes three DLUs. An error occurs when you configure an application, for example, Cisco IP Communicator, as the adjunct device, and the adjunct device requires more device license units (DLUs) than the primary device; for example, the Cisco Unified IP Phone 7906.

To ensure that Cisco Unified Communications Manager treats Cisco IP Communicator, Cisco Unified Personal Communicator, and Cisco Unified Mobile Communicator as adjunct (secondary) devices, configure the Primary Phone setting in the Phone Configuration window for Cisco IP Communicator, Cisco Unified Personal Communicator, and Cisco Unified Mobile Communicator.

The License Unit Calculator window displays (Adjunct) next to the applications that work as adjunct devices.

Licenses for Applications

Certain types of applications, such as Cisco IP Communicator, consume device license units for primary devices and adjunct devices, which are devices or applications that an end user uses in addition to the desktop phone; for example, Cisco IP Communicator becomes an adjunct device when the end user uses both the desktop phone and Cisco IP Communicator. Cisco IP Communicator becomes the primary device when the end user does not use a desktop phone.

For specific information on licensing for Cisco IP Communicator and Cisco Unified Mobility, see the following sections:

Licenses for Cisco IP Communicator

Licenses for Cisco Unified Mobility

Licenses for Cisco Unified Mobile Communicator

Licenses for Cisco IP Communicator

If Cisco IP Communicator gets configured as a primary device for an end user, it consumes three device license units. If it gets configured as an adjunct device (by choosing a phone in the Primary Phone field in Phone Configuration), it consumes one device license unit.

Licenses for Cisco Unified Mobility

Checking the Enable Mobility check box in the End User Configuration window triggers licensing to consume device license units for Mobile Connect. The number of device license units that are consumed depends on whether you assign the end user an adjunct device, that is, a desktop phone, for example, specifically for Cisco Unified Mobility. You assign the end user an adjunct device for Cisco Unified Mobility by choosing a device from the Primary User Device drop-down list box in the Mobility Information pane in the End User Configuration window, not by clicking the Device Association button in the same window.

Before you enable Mobile Connect, consider the following information:

Cisco Unified Communications Manager Administration does not allow you to assign the same device for Cisco Unified Mobility to multiple users.

When you plan your configuration, determine whether the user uses both a desktop phone and a cell phone. If the user uses both a cell phone and a desktop phone, make sure that you assign an adjunct device to the user after you enable Mobile Connect in the End User Configuration window.

The device that you assign serves as the adjunct device; that is, the device, such as a desktop phone, that the user uses in addition to the cell phone for Cisco Unified Mobility.

If you enable Mobile Connect and fail to assign the end user an adjunct device for Cisco Unified Mobility, four DLUs get consumed, as indicated in the Mobility Enabled End Users row in the License Unit Calculator window.

If you enable Mobile Connect and assign the end user an adjunct device for Cisco Unified Mobility, two DLUs get consumed, as indicated in the Mobility Enabled End Users (Adjunct) row in the License Unit Calculator window.

If you enable Mobile Connect and later decide to assign an adjunct device for the feature to the end user, the system credits you with two DLUs, as indicated in the Mobility Enabled End Users row in the License Unit Calculator window.

For example, if you enable Mobile Connect, forget to assign the end user an adjunct device for the feature, and click Save, the system consumes four DLUs. If you then assign the end user an adjunct device for the feature and click Save, the system credits you with two DLUs.

If you delete the device from Cisco Unified Communications Manager Administration or remove the assignment after you enable Mobile Connect, two DLUs get consumed after you delete the device or remove the assignment, as indicated in the Mobility Enabled End Users row in the License Unit Calculator window.

Licenses for Cisco Unified Mobile Communicator

Cisco Unified Mobile Communicator uses one Device License Unit (DLU) if the user has a desktop phone and three DLUs if the user does not have a desktop phone.

License Calculations

To determine the number of license units that are required for each device, choose System > Licensing > License Unit Calculator in Cisco Unified Communications Manager Administration. This window lists the number of license units that are required for each type of device.

Table 14-1 provides an example of how Cisco Unified Communications Manager performs the calculations for primary and adjunct license units.

Table 14-1 Example of Device License Units Consumed for Certain Devices 

Type of Device Configured
Number of Device License Units

Cisco Unified IP Phone 7961

4

Cisco IP Communicator

3

Cisco Unified Personal Communicator

3

Associate the Cisco IP Communicator or Cisco Unified Personal Communicator to an existing device (such as the Cisco Unified IP Phone 7961)

Device license units get credited for Cisco IP Communicator or the Cisco Unified Personal Communicator, not for the desktop phone with which it gets associated.

If Cisco IP Communicator is associated with the Cisco Unified IP Phone 7961, the DLUs for Cisco IP Communicator get reduced from three to one. The DLUs for the Cisco Unified IP Phone 7961 remain unchanged.


To determine the number of units of licenses that are required for each phone and application, see Calculating License Units in the Cisco Unified Communications Manager Administration Guide.

License File Contents

The license file contains the following information:

Number of Cisco Unified Communications Manager nodes that are licensed—This indicates number of Cisco Unified Communications Manager servers in a cluster that are licensed to the customer.

Versions of the Cisco Unified Communications Manager that are supported.

Number of phone units that are licensed—Instead of creating a separate license for each phone type, the system uses the concept of license units. Each phone type corresponds to a fixed number of license units.


Note To determine the number of license units that are required for each device, choose System > Licensing > License Unit Calculator. This window lists the number of license units that are required for each type of device. See the "Calculating License Units" section in the Cisco Unified Communications Manager Administration Guide.


MAC address of the server, where the license file can be installed.

To upload a license file to the license server, see the "Uploading a License File" section in the Cisco Unified Communications Manager Administration Guide.

Sample License Files

The following examples (Example 14-1, Example 14-2, Example 14-3), respectively, describe license files for permanent IP phone licenses, permanent Cisco Unified Communications Manager node licenses, and software feature licenses.

Example 14-1 Permanent IP Phone Licenses

INCREMENT PHONE_UNIT cisco 6.0 permanent uncounted \
 
VENDOR_STRING=<Count>1000</Count><OrigMacId>000BCD4EE59D</OrigMacId><LicFileVersion>1.0</L
icFileVersion> \
 HOSTID=000bcd4ee59d OVERDRAFT=50 \
 NOTICE="<LicFileID>20050826140539162</LicFileID><LicLineID>2</LicLineID> \
 <PAK></PAK>" SIGN="112D 17E4 A755 5EDC F616 0F2B B820 AA9C \
 0313 A36F B317 F359 1E08 5E15 E524 1915 66EA BC9F A82B CBC8 \
 4CAF 2930 017F D594 3E44 EBA3 04CD 01BF 38BA BF1B" 

The preceding license file includes following information:

No expiration date for this license exists as indicated by the keyword permanent.

This license file provides 1000 PHONE_UNIT licenses.

OVERDRAFT=50 indicates (5 percent of 1000) allowed overdraft. Cisco determines the overdraft value.

The Cisco-specific fieldLicFileID identifies this license file.

You can add multiple increment lines for same feature (phone unit license or node license) in a license file to increase the license count. Identical INCREMENT lines should not exist, and each line should be signed independently.

To use 5.0 device licenses with Cisco Unified Communications Manager 6.0(1) or later, make sure that you obtain the software feature license for the Cisco Unified Communications Manager version that is running on your system.

Example 14-2 Permanent CCM_Node licenses

# Optional usage agreement, legal language, tracking information 
# Some other comments 

INCREMENT CCM_NODE cisco 6.0 permanent uncounted \
VENDOR_STRING=<Count>2</Count><OrigMacId>000e7feeebbd</OrigMacId><LicFileVersion>1.0</LicF
ileVersion> \
HOSTID=000e7feeebbd \
NOTICE="<LicFileID>20060309193216861</LicFileID><LicLineID>1</LicLineID> \
<PAK></PAK>" SIGN="1375 87CA 021E 6ABD C2EF C1D2 1E1A 9A08 \
6A0C 6624 1F21 E5CC 8D83 E154 202F 0A2A 4F75 00D6 C102 E5B9 \
5DA2 A3F9 AE38 CD9A CC86 3F14 9455 28F9 CBC8 31CC"

The preceding license file includes the following information:

No expiration date for this license exists as indicated by the keyword permanent. Permanent indicates that the license file is not temporary. A temporary license would have a date here instead.

This license file provides two licenses for the version 5.0 of the feature CCM_NODES.

Original Mac Id specifies the Mac ID for which license file was first issued.

Host ID specifies the MAC ID of the publisher server. This would differ from the OrigMacID only if a rehost procedure was done for the license file.

The Cisco specific fieldLicFileID identifies this license file.

SIGN represents the signature that FlexLM generates, and the FlexLM validation package uses it in Cisco Unified Communications Manager to detect whether license file tampering occurred.

You can add multiple increment lines for same feature in a license file to increase the license count. Ensure that none of the INCREMENT lines is identical, and ensure that each of them is signed independently.

Example 14-3 Software Feature licenses

INCREMENT SW_FEATURE cisco 6.0 permanent uncounted \
	
VENDOR_STRING=<Count>1</Count><OrigMacId>111222333444</OrigMacId><LicFileVersion>1.0</LicF
ileVersion> \
	HOSTID=111222333444 \
	NOTICE="<LicFileID>20070911134257196</LicFileID><LicLineID>1</LicLineID> \
	<PAK></PAK>" SIGN="15CF FEF2 BB28 3A61 014F AEC1 7F18 8F8D \
	6EC8 7BA7 8ACE 0267 BA34 DE1D BF94 0230 96A6 6DA6 83B6 D0CC \
	1E53 E091 1304 9246 C7A3 CCEB 12E6 6FA3 E95C 6C92"

The preceding license file includes the following information:

No expiration date for this license exists as indicated by the keyword permanent.

The INCREMENT SW_FEATURE line indicates that this license provides feature support for Cisco Unified Communications Manager 6.0.

To use 5.0 device licenses with Cisco Unified Communications Manager 6.0(1) or later, make sure that you obtain the software feature license for the Cisco Unified Communications Manager version that is running on your system.

Additional Information

See the "Where to Find More Information" section.

Splitting Licenses

When you place an order for Cisco devices, Cisco provides a Product Authorization Key (PAK). Using PAK, you can split the licenses across multiple clusters when over 1,000 device license unit bundles are purchased.

For example, you request 20 Cisco Unified Communications Manager nodes and 20000 phone units in one purchase order. A PAK gets issued after the request is approved. Using this PAK, you can split the licenses across multiple clusters with 1 license file containing 15 Cisco Unified Communications Manager nodes and 15000 phone units and another license file with 5 Cisco Unified Communications Manager nodes and 5000 phone units.

To determine the number of license units that are required for each device, in Cisco Unified Communications Manager Administration, choose System > Licensing > License Unit Calculator. This window lists the number of license units that are required for each type of device.

Additional Information

See the "Where to Find More Information" section.

Software License Version

Cisco Unified Communications Manager keeps track of the software license version. Each time that the Cisco CallManager service restarts, this version check gets performed. If Cisco Unified Communications Manager fails to load (for example, because the license file is missing), the Service Manager tries to restart the Cisco CallManager service three times. At each attempt to restart, the license file check gets performed, and an alarm gets written to syslog.

The software license version displays in the License Unit Report window of Cisco Unified Communications Manager Administration. See License Unit Report in the Cisco Unified Communications Manager Administration Guide.

Additional Information

See the "Where to Find More Information" section.

Starter Licenses

Cisco Unified Communications Manager contains a starter licenses that you can use to begin new installations of Cisco Unified Communications Manager before you install the permanent license. Starter licenses, which are available in limited quantities, have no expiration date. You can use starter licenses only for fresh installations; you cannot use them for upgrades or migrations from previous releases. Starter licenses support only one Cisco Unified Communications Manager node and up to 50 device license units.

The system overwrites the starter licence when you obtain and upload your permanent licenses.

Additional Information

See the "Where to Find More Information" section.

Licensing and the Cisco CallManager Service

After you upgrade to Cisco Unified Communications Manager 7.1 from a compatible Cisco Unified CM 5.X or 6.X release, the Cisco CallManager service does not automatically run, even though Cisco Unified Serviceability shows that the Cisco CallManager service is activated.

Immediately after you complete the upgrade to Cisco Unified Communications Manager 7.1, upload the software feature license that is required for Cisco Unified Communications Manager 7.1 in Cisco Unified Communications Manager Administration and restart the Cisco CallManager service in Cisco Unified Serviceability. Until you perform these tasks, devices fail to register with Cisco Unified Communications Manager 7.1.

Alarms, Alerts, and License Status Notification

Cisco Unified Communications Manager identifies the state of a license; that is, if it is missing, if it is a demo license, or if it is an uploaded license. In addition, Cisco Unified Communications Manager Administration warns you whether Cisco Unified Communications Manager currently operates with starter licenses, with an insufficient number of licenses, or with an incorrect software feature license. The following windows in Cisco Unified Communications Manager Administration may display information about the state of a license:

Main Window—After you log in to Cisco Unified Communications Manager Administration, messages may display that indicate the current state of licenses for Cisco Unified Communications Manager. For example, Cisco Unified Communications Manager may identify the following situations:

Cisco Unified Communications Manager currently operates with starter licenses, so upload the appropriate license files.

Cisco Unified Communications Manager currently operates with an insufficient number of licenses, so upload additional license files.

Cisco Unified Communications Manager does not currently use the correct software feature license. In this case, the Cisco CallManager service stops and does not start until you upload the appropriate software version license and restart the Cisco CallManager service.

License File Upload (System > Licensing > License File Upload)—This window displays a message that uploading the license file removes the starter licenses for the feature.

License Unit Report (System > Licensing > License Unit Report)—This window displays the status of a license file. For example, the Status column for each license type may display Demo, Missing, or Uploaded.

The following alarms get generated for licensing:

CiscoLicenseManagerDown

CiscoLicenseOverDraft

CiscoLicenseRequestFailed

CiscoLicenseDataStoreError

CiscoLicenseInternalError

CiscoLicenseFileError


Tip To find these alarms, access the JavaApplications Alarm Catalog in Cisco Unified Serviceability. Refer to the Cisco Unified Serviceability Administration Guide for more information on alarms.


If Cisco Unified Communications Manager does not have the appropriate license file, an alert gets generated; for information on alerts, refer to the Cisco Unified Communications Manager Real-Time Monitoring Tool Administration Guide.

For DNS, make sure that you map the IP addresses of all servers, including dummy nodes, to the hostnames on the DNS server. If you do not perform this task, Cisco Unified Communications Manager generates alarms that the License Manager service is down.

Additional Information

See the "Where to Find More Information" section.

Where to Find More Information

License File Upload, Cisco Unified Communications Manager Administration Guide

License Unit Calculator, Cisco Unified Communications Manager Administration Guide

License Unit Report, Cisco Unified Communications Manager Administration Guide

Configuring Speed-Dial Buttons or Abbreviated Dialing, Cisco Unified Communications Manager Administration Guide

Licensing for Third-Party Phones That Are Running SIP, Cisco Unified Communications Manager Administration Guide

Cisco Unified Serviceability Administration Guide

Cisco Unified Communications Manager Real-Time Monitoring Tool Administration Guide

Command Line Interface Reference Guide for Cisco Unified Solutions