Cisco Unified Communications Manager Administration Guide, Release 6.1(1)
License File Upload
Downloads: This chapterpdf (PDF - 410.0KB) The complete bookPDF (PDF - 17.26MB) | Feedback

License File Upload

Table Of Contents

License File Upload

Starting the License Manager Service

Obtaining a License File

New Cisco Unified Communications Manager Nodes and Devices

Upgrading From Cisco Unified CallManager 4.x Releases

Upgrading From Cisco Unified Communications Manager 5.x Releases

License File Contents

Uploading a License File

Related Topics


License File Upload


License files contain the information that is needed to enforce licenses for Cisco Unified Communications Manager. This chapter contains the following topics:

Starting the License Manager Service

Obtaining a License File

License File Contents

Uploading a License File

Related Topics

Starting the License Manager Service

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 publisher server only.) For information on license files, refer to the "Obtaining a License File" 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 should be up and running after 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.

Cisco License Manager displays in list under Service Name column, in the Platform Services.

Step 3 Click the radio button that corresponds to Cisco License Manager.

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

The service starts, and the message, Service Started Successfully, displays.

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

The service stops, and the message, Service Successfully Stopped, displays.

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

The service restarts, and the message, Service Successfully Restarted, displays.


Additional Information

See the Related Topics.

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:

New Cisco Unified Communications Manager Nodes and Devices

Upgrading From Cisco Unified CallManager 4.x Releases

Upgrading From Cisco Unified Communications Manager 5.x Releases

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 require four license units, and Cisco Unified IP Phone 7970 require 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 licence when you obtain and upload your permanent licenses. For more information on starter licenses, see the "Starter Licenses" section in the Cisco Unified Communications Manager System Guide.

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, refer to the "Calculating License Units" section on page 27-1.


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 "License File Contents" 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.

Upgrading From Cisco Unified CallManager 4.x Releases

When you upgrade from supported Cisco Unified CallManager 4.x releases, the system calculates the licenses that are required for existing devices and existing nodes and generates an intermediate file (XML file) that contains this information. You use this file to obtain license files that you can upgrade into Cisco Unified Communications Manager Administration. You receive these licenses free of cost because you are already using these phones for a Cisco Unified CallManager 4.x release.

Use the following procedure to obtain licenses for Cisco Unified Communications Manager when upgrading from supported 4.x releases.

Procedure


Step 1 After you complete the Cisco Unified Communications Manager Administration upgrade process, as described in Upgrading Cisco Unified Communications Manager, navigate to Cisco Unified Communications Manager Administration and choose System > Licensing > License File Upload.

The License File Upload window displays.

Step 2 Choose the licugrade_<upgrade version>.lic file from the Existing Files drop-down list and click View File. A pop-up window displays that has the license information for existing devices and nodes. Copy this information. To copy the contents on this window, you can use Ctrl-A (Select All) and Ctrl-C (Copy).

Step 3 Navigate to the License Registration web tool at https://tools.cisco.com/SWIFT/Licensing/PrivateRegistrationServlet?FormId=806.

Step 4 Enter the MAC address of the Ethernet 0 NIC of the first node of the Cisco Unified Communications Manager in the cluster.

Step 5 In the text box that is provided, paste the license file contents that you copied in Step 4 by using the appropriate keyboard shortcuts, such as Ctrl-V.

Step 6 Enter a valid e-mail address and click Continue. A license file generates.

The system sends the license file to you via e-mail by using the E-mail address that you provided.

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

Step 8 You can obtain licenses for new devices that you are adding to the upgraded system, if your system requires additional device license units. For detailed instructions, see the "New Cisco Unified Communications Manager Nodes and Devices" section.


Additional Information

See the Related Topics.

Upgrading From Cisco Unified Communications Manager 5.x Releases

You must obtain a software feature license if you are upgrading from Cisco Unified Communications Manager 5.x. A software feature license activates features on your system for the specified license version. To use 5.0 device licenses with Cisco Unified Communications Manager 6.(x) or later, 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 using the e-mail address that you provided. To view the contents of a software feature license, see Example 28-3.

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.

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 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 on page 27-1.


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.

Sample License Files

The following examples describe license files for permanent IP phone licenses and permanent Cisco Unified Communications Manager node licenses:

Example 28-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% 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 28-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 is the signature that gets generated by FlexLM and gets used by the FlexLM validation package 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. None of the INCREMENT lines should be identical, and each of them should be signed independently.

Example 28-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 "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 "Obtaining a License File" section. The Cisco Unified Communications Manager server where the license file is loaded takes on the functionality of the license manager.


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 is complete, the Upload Result file displays.

Step 6 Click Close.

Step 7 In the License File Upload window, the status of the uploaded file displays.


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.

Related Topics

Starting the License Manager Service

Upgrading From Cisco Unified CallManager 4.x Releases

Obtaining a License File

License File Contents

Uploading a License File

Calculating License Units, page 27-1

Generating a License Unit Report, page 26-1

Licensing, Cisco Unified Communications Manager System Guide