Cisco Unified Communications Manager Administration Guide, Release 7.1(2)
License File Upload
Downloads: This chapterpdf (PDF - 144.0KB) The complete bookPDF (PDF - 16.95MB) | 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

Obtaining a Software Feature License

Upgrading Product Licenses

Uploading a License File

Deleting a License File Name

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 on uploading license files:

Starting the License Manager Service

Obtaining a License File

Uploading a License File

Deleting a License File Name

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 first node 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 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.

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 or devices that require additional device license units, see the "New Cisco Unified Communications Manager Nodes and Devices" section.

If you are upgrading from Cisco Unified CallManager 4.x, obtain a software feature license as described in "Obtaining a Software Feature License" section and then upgrade the product licenses as described in the "Upgrading Product Licenses" section.

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

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. 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 31-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 "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, refer to "License File Contents" in the Cisco Unified Communications Manager System Guide.

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.

Step 6 If you are upgrading from Cisco Unified CallManager 4.x, perform the procedure that is described in the "Upgrading Product Licenses" section.


Additional Information

See the Related Topics.

Upgrading Product Licenses

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 import into Cisco Unified Communications Manager Administration. (Refer to Procedure 2.) Alternately, you can use the license file that Data Migration Assistant (DMA) generates. (Refer to Procedure 1.)

You receive these licenses free of cost because you are already using these phones for a Cisco Unified CallManager 4.x release.

Use either Procedure 1 or Procedure 2 to obtain licenses for Cisco Unified Communications Manager when you upgrade from supported 4.x releases.

Procedure 1


Step 1 When you use Data Migration Assistant to migrate your data, choose the Export > Storage Location > Destination Option for License File tool to specify a local directory destination for the license file licupgrade.lic


Note Do not specify a mapped network directory for the Local Directory. If you do, be aware that DMA may not be able to create the destination folder.


Step 2 Run DMA according to instructions in the Data Migration Assistant User Guide.

Step 3 Upgrade the Cisco Unified Communications Manager servers according to instructions in the document Upgrading Cisco Unified Communications Manager Release 7.1(2) from Cisco Unified Communications Manager 4.x Releases.

Step 4 Upload the license file to the server with the matching MAC address of the Ethernet 0 NIC of the first node of the Cisco Unified Communications Manager cluster.

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


Procedure 2


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. The window refreshes and displays 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 2 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 through 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.

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.

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


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.

Deleting a License File Name

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

Related Topics

Starting the License Manager Service

Obtaining a License File

Upgrading Product Licenses

Uploading a License File

Deleting a License File Name

Calculating License Units, page 31-1

Generating a License Unit Report, page 30-1

Licensing, Cisco Unified Communications Manager System Guide

Command Line Interface Reference Guide for Cisco Unified Solutions