Cisco Unified Communications Manager Features and Services Guide, Release 8.5(1)
Licensing
Downloads: This chapterpdf (PDF - 248.0KB) The complete bookPDF (PDF - 11.79MB) | Feedback

Licensing

Table Of Contents

Licensing

Checklist for Licensing

Licensing for Cisco Unified Communications Manager on VMware on Cisco UCS B-Series Blade Servers

Understanding Licensing

Understanding Licensing Terminology

Understanding Licensing-Related Windows

Understanding the Contents of the License File

Understanding How Licensing Works for Phones

Understanding How Adjunct Licensing Works

Understanding How Licensing Works for Applications

Interactions and Restrictions

Working with Licenses

Calculating the Number of Required License Units

Obtaining a License File

Obtaining Licenses for New Cisco Unified Communications Manager Nodes and Devices

Obtaining a Software Feature License

Verifying That the License Manager Service Is Running

Uploading a License File

Generating a License Unit Report

License Capabilities Assignment Configuration Settings

Finding a License Capabilities Assignment

Configuring the Capabilities Assignments for One User

Configuring the Capabilities Assignments for Multiple Users

Troubleshooting Licensing

Alarms, Alerts, and License Status Notification

Related Topics


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:

Checklist for Licensing

Licensing for Cisco Unified Communications Manager on VMware on Cisco UCS B-Series Blade Servers

Understanding Licensing

Understanding Licensing Terminology

Understanding Licensing-Related Windows

Understanding the Contents of the License File

Understanding How Licensing Works for Phones

Understanding How Adjunct Licensing Works

Understanding How Licensing Works for Applications

Interactions and Restrictions

Working with Licenses

Calculating the Number of Required License Units

Obtaining a License File

Verifying That the License Manager Service Is Running

Uploading a License File

Generating a License Unit Report

License Capabilities Assignment Configuration Settings

Finding a License Capabilities Assignment

Configuring the Capabilities Assignments for One User

Configuring the Capabilities Assignments for Multiple Users

Troubleshooting Licensing

Related Topics

Checklist for Licensing

Table 30-1 describes steps for licensing if you are installing or upgrading a server.


Note If you are replacing a server, see Replacing a Single Server or Cluster for Cisco Unified Communications Manager.



Note For information about licensing for Cisco Unified Communications Manager on VMware on Cisco UCS B-Series Blade Servers, see the document Installing Cisco Unified Communications Manager.


Table 30-1 Checklist for Licensing 

Configuration Steps
Related Procedures and Topics

Step 1 

Review the documentation on licensing.

Licensing

Step 2 

Determine the number of licenses and device license units that you need for your Cisco Unified Communications Manager system.

Calculating the Number of Required License Units

Step 3 

Obtain the license(s).

Understanding Licensing

Obtaining Licenses for New Cisco Unified Communications Manager Nodes and Devices

Obtaining a Software Feature License

Step 4 

Install or upgrade the servers in the cluster.

Cisco Unified Communications Operating System Administration Guide

Installing Cisco Unified Communications Manager Release 8.5(1)

Step 5 

Upload the license in Cisco Unified Communications Manager Administration. (System > Licensing > License File Upload)

Uploading a License File

Step 6 

After you upload the license, verify that the Cisco CallManager service is running on all nodes where it had previously been activated. If is it not running, restart the service. (Tools > Control Center—Feature Services)

Cisco Unified Serviceability Administration Guide

Licensing for Cisco Unified Communications Manager on VMware on Cisco UCS B-Series Blade Servers

For information about licensing for Cisco Unified Communications Manager on VMware on Cisco UCS B-Series Blade Servers, see the document Installing Cisco Unified Communications Manager.

Understanding 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.

Understanding Licensing Terminology

Table 30-2 describes common terminology that is used for licensing.

Table 30-2 Licensing Terminology

Term
Description

Adjunct Licensing/Adjunct Device

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.

Device License Unit (DLU)

Device license units are assigned to each device that is connected to Cisco Unified Communications Manager. Each device is assigned a unit number based on the type and capabilities of the device. Devices with more complex and high-end capabilities are assigned a higher number of units.

Product Authorization Key (PAK)

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.

Production License

Production licenses for Cisco Unified Communications Manager comprise licenses for devices and nodes that are purchased from Cisco.

Starter License (also called demo license)

Cisco Unified Communications Manager contains a starter license that you can use to begin new installations of Cisco Unified Communications Manager before you install the production 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 production licenses.


Understanding Licensing-Related Windows

The configuration windows in Table 30-3 support licensing in Cisco Unified Communications Manager Administration:

Table 30-3 Licensing Windows in
Cisco Unified Communications Manager Administration 

Window
Description

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.

System > Licensing > License Unit Report

This window displays the total license capacity and the number of licenses in use. Cisco Unified Communications Manager generates a report that lists the total number of available licenses. The license unit report also displays the software license version that is installed on the Cisco Unified Communications Manager server.

This window displays the status of a license file. For example, the Status column for each license type may display Demo, Missing, Invalid, or Uploaded.

System > Licensing > License Unit Calculator

This window allows you to calculate the number of device license units that are required for a phone model or application.

System > Licensing > License File Upload

This window allows you to upload the license file that you obtained. In addition, this window displays a message that uploading the license file removes the starter licenses for the feature. You can also view the license file from this window.

System > Licensing > Capabilities Assignment

This window triggers licensing to consume device license units for Cisco Unified Presence (CUP) and Cisco Unified Personal Communicator (CUPC) users.

User Management > End User

This window displays the Enable Mobility check box, which triggers licensing to consume device license units for Cisco Unified Mobility. For more information, see the "Licenses for Cisco Unified Mobility" section.

Device > Phone

This window displays the Device Is Active message, which triggers licensing to consume device license units for the phone.

This window displays the Primary Phone drop-down list box for Cisco IP Communicator, Cisco Unified Mobile Communicator, Cisco Unified Personal Communicator, and Client Services Framework. Configuring the Primary Phone setting triggers licensing to consume fewer device license units for the application because it serves as an adjunct device, not the primary device.


Understanding the Contents of the License File

The license file, which you can view from the License File Upload window, 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.


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

Sample License Files

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

Example 30-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 30-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 30-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.

Understanding How Licensing Works 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.

The Device Is Active message in the Phone Configuration window in Cisco Unified Communications Manager Administration displays when a phone consumes device license units and when a phone can 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 Device Is Active message displays, 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 Device Is Active message does not display. If you manually convert the dummy MAC address to a real MAC address in the Phone Configuration window, the Device Is Active message displays after you save the configuration; this 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 Device Is Active message displays in Phone Configuration window. 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.

Understanding How Adjunct Licensing Works

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.

Understanding How Licensing Works for Applications

Certain types of applications, such as Cisco IP Communicator, consume device license units as primary devices or 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 specific applications, see the following sections:

Licenses for Cisco IP Communicator

Licenses for Cisco Unified Mobility

Licenses for Cisco Unified Mobile Communicator

Licenses for Cisco Unified Personal 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; that is, if the user uses Cisco Unified Mobile Communicator as the primary device. When you configure the Cisco Unified Mobile Communicator in the Phone Configuration window, choose a primary phone from the Primary Phone drop-down list box if Cisco Unified Mobile Communicator is the adjunct (secondary) device.

Licenses for Client Services Framework

When you configure Client Services Framework in the Phone Configuration window, choose a primary phone from the Primary Phone drop-down list box if Client Services Framework is the adjunct (secondary) device.

Licenses for Cisco Unified Personal Communicator

Configuring the License Capabilities Assignments settings in Cisco Unified Communications Manager Administration triggers licensing to consume device license units for Cisco Unified Personal Communicator. See the "License Capabilities Assignment Configuration Settings" section.

Interactions and Restrictions

The following interactions and restrictions exist for licensing:

Cisco strongly recommends that you obtain the license by using Microsoft Outlook as your email client. Using other email clients to obtain the license file may cause additional characters to display in the license file.

Before you upload a license file in Cisco Unified Communications Manager Administration, verify in Cisco Unified Serviceability that the Cisco License Manager service is running.

The license manager service keeps track of the licenses that get purchased and used. It refers to the processes that control the checkin and checkout of the licenses, and it keeps track of the number of license units that are required for each phone and application type. The license manager has responsibility for issuing and reclaiming licenses and for detecting whether an overdraft of licenses occurs.

You do not need to obtain new licenses if you are upgrading within a software release train, such as Cisco Unified Communications Manager 6.0(1) to 6.1(1).

After some upgrades to 8.5(1), 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 8.5(1), upload the software feature license that is required for Cisco Unified Communications Manager 8.5(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 8.5(1).

After you upload the license file, you must restart the Cisco CallManager service in Cisco Unified Serviceability.

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.

The system uploads the license file into the database only if the version that is specified in the license file is greater than or equal to the Cisco Unified Communications Manager version that is running in the cluster. If the version check fails, an alarm gets generated, and you should get a new license file with the correct version. The system bases the version check only on major releases.

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.

You cannot delete a license file name through Cisco Unified Communications Manager Administration. For information on how to delete a license file name, see the Command Line Interface Reference Guide for Cisco Unifed Communications Solutions.

The format of the license file that you receive specifies CCM<timestamp>.lic. If you retain the .lic extension, you can rename the license file. You cannot use the license if you edit the contents of the file in any way.

The Device Is Active message in the Phone Configuration window in Cisco Unified Communications Manager Administration indicates that a phone consumes device license units and can register with Cisco Unified Communications Manager. For more information on this topic, see the "Understanding How Licensing Works for Phones" section.

If you replace a server, review the document, Replacing a Single Server or Cluster for Cisco Unified Communications Manager, for considerations on how to handle licenses.

Working with Licenses

This section contains information on the following topics:

Calculating the Number of Required License Units

Obtaining a License File

Verifying That the License Manager Service Is Running

Uploading a License File

Generating a License Unit Report

License Capabilities Assignment Configuration Settings

Finding a License Capabilities Assignment

Configuring the Capabilities Assignments for One User

Configuring the Capabilities Assignments for Multiple Users

Alarms, Alerts, and License Status Notification

Calculating the Number of Required License Units

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 after you install or upgrade Cisco Unified Communications Manager, choose System > Licensing > License Unit Calculator in Cisco Unified Communications Manager Administration. Use the License Unit Calculator window to calculate the number of phone unit licenses that are required for a specific configuration of a type of phones and number of phones of each type. A device license unit refers to a fixed number of license units that corresponds to each phone type. Cisco Unified IP Wireless Phone 7920 requires four license units, and a Cisco Unified IP Phone 7970 requires five units. If you are adding four 7920 phones and four 7970 phones, you require 36 phone license units.

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

Table 30-4 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.


Use the following procedure to calculate the number of phone licenses that are required when the number of phone types and the total number of phones per phone type are entered.

Procedure


Step 1 Choose System > Licensing> License Unit Calculator.

The License Unit Calculator window displays. The number of license units that are consumed per device displays, corresponding to the node or device.

Step 2 In the Number of Devices column, update the number of needed devices, corresponding to each node or phone.

Step 3 Click Calculate.

The total number of Cisco Unified Communications Manager node license units and phone license units displays.


Additional Information

See the "Related Topics" section.

Obtaining a License File

Licensing helps manage Cisco Unified Communications Manager licenses and enforces the licenses for Cisco Unified Communications Manager applications and the number of devices. This section provides information on obtaining licenses for new Cisco Unified Communications Manager systems and/or device installations as well as for Cisco Unified Communications Manager nodes that have been upgraded from various releases.


Note You do not need to obtain new licenses if you are upgrading within a software release train, such as Cisco Unified Communications Manager 6.0(1) to 6.1(1).


To obtain a license, see the section that applies to your situation:

If you are installing new Cisco Unified Communications Manager servers or devices that require additional device license units, see the "Obtaining Licenses for New Cisco Unified Communications Manager Nodes and Devices" section.

If you are upgrading from supported versions of Cisco Unified Communications Manager 6.x, see the "Obtaining a Software Feature License" section.

Obtaining Licenses for New Cisco Unified Communications Manager Nodes and Devices

Use the following procedure to obtain a node license file for new Cisco Unified Communications Manager nodes (servers) and to obtain device licenses for new devices that require additional device license units.

Each node in your cluster requires one node license unit. Each device type requires a fixed number of licenses units, depending on the type. For example, Cisco Unified IP Phone 7920 requires four license units, and Cisco Unified IP Phone 7970 requires five units. If you want licenses for four Cisco Unified IP Phones 7920 and four Cisco Unified IP Phones 7970 phones, you require 36 phone license units.

Cisco Unified Communications Manager contains a starter licenses that you can use to begin new installations of Cisco Unified Communications Manager. The system overwrites the starter license when you obtain and upload your permanent licenses.

You use the Product Authorization Key (PAK) that came with your product to obtain the necessary permanent licenses, as described in the following procedure.

Procedure


Step 1 Enter the Product Authorization Key (PAK) that you received with your Cisco Unified Communications Manager or phone order in the License Registration web tool at http://www.cisco.com/go/license.

Step 2 Click Submit.

Step 3 Follow the system prompts. You must enter the MAC address of the Ethernet 0 NIC of the first node of the Cisco Unified Communications Manager cluster. You must enter a valid e-mail address as well as the number of nodes and device license units for which you want licenses.


Note For information on calculating the number of device license units that are required for the devices in your system, see the "Calculating the Number of Required License Units" section.


The system sends the license file(s) to you via e-mail by using the E-mail ID that you provided. The format of a license file specifies CCM<timestamp>.lic. If you retain the .lic extension, you can rename the license file. You cannot use the license if you edit the contents of the file in any way.


Note One license file may apply to more than one node in your cluster. For information on how to interpret the license file, see the "Uploading a License File" section.


Step 4 You must upload the license file to the server with the matching MAC address that you provided in Step 3. See the "Uploading a License File" section. This server then takes on the functionality of the license manager.



Note You can use the licenses that are specified in the license file only within the cluster on which the license file is uploaded.


Additional Information

See the "Related Topics" section.

Obtaining a Software Feature License

A software feature license activates features on your system for the specified license version. To use previous device license versions with this version of Cisco Unified Communications Manager, make sure that you obtain the software feature license for the Cisco Unified Communications Manager version that is running on your system.

Use this procedure to obtain a software feature license:

Procedure


Step 1 Navigate to the License Registration web tool at http://www.cisco.com/go/license.

Step 2 Enter the Product Authorization Key (PAK) that you received with your Cisco Unified Communications Manager upgrade.

Step 3 Click Submit.

Step 4 Follow the system prompts. You must enter the MAC address of the Ethernet 0 NIC of the first node of the Cisco Unified Communications Manager cluster. You must also enter a valid e-mail address.

The system sends the license file to you via e-mail by using the e-mail address that you provided. To view the contents of a software feature license, see the "Understanding the Contents of the License File" section.

Step 5 You must upload the software license file to the server with the matching MAC address that you provided in Step 4. See the "Uploading a License File" section.


Additional Information

See the "Related Topics" section.

Verifying That the License Manager Service Is Running

The Cisco Unified Communications Manager server where the license file is loaded assumes the functionality of a license manager. (The license file gets loaded on the first node only.) For information on license files, see the "Understanding How Licensing Works for Phones" section.

The license manager serves as the logical component that keeps track of the licenses that get purchased and used. It refers to the processes that control the checkin and checkout of the licenses. It keeps track of the number of license units that are required for each phone and application type. The license manager has responsibility for issuing and reclaiming licenses and for detecting whether an overdraft of licenses occurs.

Start the license manager service by using Cisco Unified Serviceability. This section describes the procedures to start, stop, or restart the service.


Note Because license manager is a network service, it automatically starts and runs after the Cisco Unified Communications Manager installation.


Procedure


Step 1 In Cisco Unified Serviceability, choose Tools > Control Center - Network Services.

The Control Center-Network Services window displays.

Step 2 Choose the Cisco Unified Communications Manager server from the Servers drop-down list box.

Step 3 Click the radio button for Cisco License Manager.

Step 4 If you want to start the License Manager service, click Start.

Step 5 If you want to stop the License Manager service, click Stop.

Step 6 If you want to restart the License Manager, click Restart.


Additional Information

See the "Related Topics" section.

Uploading a License File

Use the following procedure to upload a license file to the Cisco Unified Communications Manager server with the matching MAC address that is provided when a license file is requested. For information about obtaining a license file, see the "Understanding How Licensing Works for Phones" section. The Cisco Unified Communications Manager server where the license file is loaded takes on the functionality of the license manager.

The License File Upload window may display a message that uploading the license file removes the starter (demo) licenses for the feature.

After you upgrade to Cisco Unified Communications Manager 8.5(1) from a compatible Cisco Unified CM 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 8.5(1), upload the software feature license that is required for Cisco Unified Communications Manager 8.5(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 8.5(1).


Note Upload the license file only on the first node of Cisco Unified Communications Manager cluster.


Procedure


Step 1 Choose System > Licensing > License File Upload.

The License File Upload window displays.

Step 2 The Existing License Files drop-down list box displays the license files that are already uploaded to the server.


Note To view the file content of any existing files, choose the file from the drop-down list box and click View File.


Step 3 To choose a new license file to upload, click Upload License File.

The Upload File pop-up window displays.

Step 4 To upload to the server, click Browse to choose a license file.


Note The format of the license file that you receive specifies CCM<timestamp>.lic. If you retain the .lic extension, you can rename the license file. You cannot use the license if you edit the contents of the file in any way.


Step 5 Click Upload.

After the upload process completes, the Upload Result file displays.

Step 6 Click Close.

Step 7 In the License File Upload window, the status of the uploaded file displays. In Cisco Unified Serviceability, restart the Cisco CallManager service.


Note The system uploads the license file into the database only if the version that is specified in the license file is greater than or equal to the Cisco Unified Communications Manager version that is running in the cluster. If the version check fails, an alarm gets generated, and you should get a new license file with the correct version. The system bases the version check only on major releases.



Additional Information

See the "Related Topics" section.

Generating a License Unit Report

Use the license unit report to display the total license capacity and the number of licenses in use. This tool generates a report that lists the total number of available licenses. The license unit report also displays the software license version that is installed on the Cisco Unified Communications Manager server.


Note For more information on requesting licenses, see the "Obtaining a License File" section.


A unit license refers to a fixed number of device license units that correspond to each phone type. For example, Cisco Unified IP Wireless 7920 requires four device license units, and a Cisco Unified IP Phone 7970 requires five device license units. If you are provisioning four 7920 phones and four 7970 phones, you require 36 phone license units.

The number of licensed units in the license file corresponds to the number of unit licenses for all the phone types that are purchased.

The License Unit Report window displays the status of a license file. For example, the Status column for each license type may display Demo, Missing, Invalid, or Uploaded. If the status is Invalid, verify that the license files have been obtained with a correct license MAC; that is, issue the show status cli command from the command line interface to obtain the license MAC and compare that value to the value that displays in the contents of the license file, which you view in the License File Upload window. If the values do not match, obtain license files for the correct license MAC and upload in the License File Upload window. For more information on cli commands, see the Command Line Interface Reference Guide for Cisco Unifed Communications Solutions.


Note To determine the number of license unit 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.


Use the following procedure to generate a report for the number of licenses that are available.

Procedure


Step 1 Choose System > Licensing > License Unit Report.

Step 2 The License Unit Report window displays. This window displays the number of phone licenses, number of node licenses, and software license versions. Phone and node licenses that are available display by

Units Authorized

Units Used

Units Remaining

The software license version displays the

License Server Name

Cisco Unified Communications Manager Software Version


Additional Information

See the "Related Topics" section.

License Capabilities Assignment Configuration Settings

Capabilities Assignment allows system administrators to enable the Cisco Unified Presence (CUP) and Cisco Unified Personal Communicator (CUPC) capabilities for users. You must ensure that licenses for CUP and CUPC are available.

Make license capabilities assignments to existing users. Before you begin, ensure that users exist on your system by choosing User Management > End User and clicking Find.

Before you begin configuring the capabilities assignments for users, determine how many CUP (servers and clients) and CUPC licenses are required for your system by choosing Licensing > License Unit Calculator. Acquire the required licenses by using Licensing > License File Upload. Verify the total licenses by using Licensing > License Unit Report.

Table 30-5 describes the license capabilities assignment configuration settings. For related procedures, see the "Related Topics" section.

Table 30-5 License Capabilities Assignment Configuration Settings 

Field
Description
User Information

User ID

Displays the name of the user for which you are enabling capabilities assignment.

Capabilities Assignment Information

Enable CUP (Cisco Unified Presence)

To enable CUP for this user, check the Enable CUP (Cisco Unified Presence) check box.

Enable CUPC (Cisco Unified Personal Communicator)

To enable CUPC for this user, check the Enable UPC (Cisco Unified Personal Communicator) check box. You can enable both CUP and CUPC; however, if you want CUPC, you must also enable CUP.


Finding a License Capabilities Assignment

Because you might have several license capabilities assignments for users in your network, Cisco Unified Communications Manager Administration lets you locate specific capabilities assignments on the basis of specific criteria. Use the following procedure to find locations.


Note During your work in a browser session, Cisco Unified Communications Manager Administration retains your location search preferences. If you navigate to other menu items and return to this menu item, Cisco Unified Communications Manager Administration retains your location search preferences until you modify your search or close the browser.


Procedure


Step 1 Choose System > Licensing > Capabilities Assignment.

The Find and List Capabilities Assignment window displays.

Step 2 To find all records in the database, ensure the dialog box is empty; go to Step 3.

To filter or search records

From the first drop-down list box, select a search parameter.

From the second drop-down list box, select a search pattern.

Specify the appropriate search text, if applicable.


Note To add additional search criteria, click the + button. When you add criteria, the system searches for a record that matches all criteria that you specify. To remove criteria, click the - button to remove the last added criteria or click the Clear Filter button to remove all added search criteria.


Step 3 Click Find.

All or matching records display. You can change the number of items that display on each page by choosing a different value from the Rows per Page drop-down list box.

Step 4 From the list of records that display, click the link for the record that you want to view.


Note To reverse the sort order, click the up or down arrow, if available, in the list header.


The window displays the item that you choose.


Additional Information

See the "Related Topics" section.

Configuring the Capabilities Assignments for One User

This section describes how to add or update a capabilities assignment for a user to the Cisco Unified Communications Manager database.

Before You Begin

Before configuring a capabilities assignment, you must obtain licenses from Cisco Systems by using the License File Upload under the System menu.

Procedure


Step 1 Choose System > Licensing > Capabilities Assignment.

The Find and List Capabilities Assignment window displays.

Step 2 To add a new capabilities assignment or update an existing capabilities assignment, locate the appropriate capabilities assignment as described in the "Uploading a License File" section and continue with Step 3.

The Capabilities Assignments Configuration window displays.

Step 3 Check the appropriate check box as described in Table 30-5.

Step 4 To save the capabilities assignment information in the database, click Save.


Additional Information

See the "Related Topics" section.

Configuring the Capabilities Assignments for Multiple Users

This section describes how to add or update capabilities assignments for multiple users to the Cisco Unified Communications Manager database.

Before You Begin

Before configuring a capabilities assignment, you must obtain licenses from Cisco Systems by using the License File Upload under the System menu.


Note You can assign licenses for up to 250 users when you are using the bulk assignment capability.


Procedure


Step 1 Choose System > Licensing > Capabilities Assignment.

The Find and List Capabilities Assignment window displays.

Step 2 To add a new capabilities assignment or update an existing capabilities assignment, locate the appropriate capabilities assignment as described in the "Uploading a License File" section and continue with Step 3.

Step 3 To enable a new capabilities assignment or to update an existing capabilities assignment for multiple users, check the check boxes next to the users or click the Select All button.

Step 4 Click the Bulk Assignment button.

The Capabilities Assignments Configuration window displays.

Step 5 Check the appropriate check box as described in Table 30-5.

Step 6 To save the capabilities assignment information in the database, click Save.


Additional Information

See the "Related Topics" section.

Troubleshooting Licensing

This section contains information on the following topics:

Alarms, Alerts, and License Status Notification

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, if it is an invalid 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. For more information on this topic, see the "Understanding Licensing-Related Windows" section.


Tip If the status is Invalid, verify that the license files have been obtained with a correct license MAC; that is, issue the show status cli command from the command line interface to obtain the license MAC and compare that value to the value that displays in the contents of the license file, which you view in the License File Upload window.


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. See 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, see the Cisco Unified 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 "Related Topics" section.

Related Topics

Checklist for Licensing

Understanding Licensing

Understanding Licensing Terminology

Understanding Licensing-Related Windows

Understanding the Contents of the License File

Understanding How Licensing Works for Phones

Understanding How Adjunct Licensing Works

Understanding How Licensing Works for Applications

Interactions and Restrictions

Working with Licenses

Calculating the Number of Required License Units

Obtaining a License File

Verifying That the License Manager Service Is Running

Uploading a License File

Generating a License Unit Report

License Capabilities Assignment Configuration Settings

Finding a License Capabilities Assignment

Configuring the Capabilities Assignments for One User

Configuring the Capabilities Assignments for Multiple Users

Troubleshooting Licensing

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

Replacing a Single Server or Cluster for Cisco Unified Communications Manager

Cisco Unified Serviceability Administration Guide

Cisco Unified Real Time Monitoring Tool Administration Guide

Command Line Interface Reference Guide for Cisco Unifed Communications Solutions