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

License File Upload

Table Of Contents

License File Upload

Starting the License Manager Service

Migrating from Cisco Unified Communications Manager 4.2(3) to 6.0(1)

Upgrading to Cisco Unified Communications Manager Release 6.0(1)

Obtaining a License File

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

Migrating from Cisco Unified Communications Manager 4.2(3) to 6.0(1)

Upgrading to Cisco Unified Communications Manager Release 6.0(1)

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.

Migrating from Cisco Unified Communications Manager 4.2(3) to 6.0(1)

When you migrate from Cisco Unified Communications Manager Release 4.2(3) to Release 6.0(1), the system calculates the licenses that are required for existing phones and existing Cisco Unified Communications Manager nodes, and an intermediate file (XML file) that contains these licenses generates during the Cisco Unified Communications Manager migration process. You receive these licenses free of cost because you are already using these phones for Cisco Unified Communications Manager Release 4.2(3). If you are adding new phones and nodes after migrating to Cisco Unified Communications Manager Release 6.0(1), you need to paste the intermediate license file in the License Registration window on Cisco Connection Online (CCO).

Use the following procedure to register existing licenses and request new licenses.

Procedure


Step 1 In Cisco Unified Communications Manager Administration, choose System > Licensing > License File Upload.

The License File Upload window displays.

Step 2 Click View File. A pop-up window displays that has the license information for existing phones and nodes. Copy this information. To copy the contents on this windrow, you can use Ctrl-A (Select All) and Ctrl-C (Copy).

Step 3 On the License Registration window of CCO website, in the text box that is provided, paste the file contents by using Ctrl-V. (See the "Obtaining a License File" section.)

Step 4 You must enter the MAC address of the Cisco Unified Communications Manager server for which you are requesting the licenses and a valid e-mail ID.

Step 5 To obtain the actual license file, click Submit. A license file generates.

Step 6 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. This node takes on the functionality of the license manager.


Additional Information

See the Related Topics.

Upgrading to Cisco Unified Communications Manager Release 6.0(1)

To successfully upgrade to release 6.0(1), perform the following procedure.

Procedure


Step 1 Obtain the license file for release 6.0(1) (see the "Obtaining a License File" section).

Step 2 Upgrade to Cisco Unified Communications Manager, Release 6.0(1). (See the Upgrading Cisco Unified Communications Manager Release 6.0(1) document.)


Note The Cisco CallManager service will not activate due to lack of licenses. An alarm and alert get generated (see the Syslog for information).


Step 3 After the upgrade, upload the appropriate license file that you obtained in the previous step. See Uploading a License File for information on obtaining the appropriate license file. Request a Release 6.0 Software Feature license file.

Step 4 Using Cisco Unified Serviceability, restart the Cisco CallManager service.


Additional Information

See the Related Topics.

Obtaining a License File

Use the following procedure to obtain a license file for a new installation of Cisco Unified Communications Manager phones and users and for updating the licenses when new phones and users get added.

Procedure


Step 1 When you place an order for Cisco devices, Cisco provides a Product Authorization Key (PAK).

Step 2 Register the PAK with Cisco Unified Communications Manager by using the License Registration tool at http://www.cisco.com/go/license.

Step 3 You must enter the MAC address of the Cisco Unified Communications Manager server for which you are requesting the licenses and a valid e-mail ID. You must enter the number of nodes and phone units for which you want licenses.


Note You can determine the number of phone unit licenses that you will require for each phone type by using License Calculator in Cisco Unified Communications Manager Administration. See the "Calculating License Units" section on page 27-1.


Step 4 CCO generates a license file with the number of unit licenses that you requested and sends it to you via e-mail by using the e-mail ID that you provided in Step 2.

Step 5 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 When you buy new phones and you want to update your licenses, go to the License Registration tool at http://www.cisco.com/go/license and follow Step 3 through Step 5.



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.



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.

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.

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.

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

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.


Additional Information

See the "Related Topics" section.

Related Topics

Starting the License Manager Service

Migrating from Cisco Unified Communications Manager 4.2(3) to 6.0(1)

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