Guest

Cisco uBR10000 Series Universal Broadband Routers

Software License Activation on Cisco CMTS Routers

Table Of Contents

Software License Activation on Cisco CMTS Routers

Finding Feature Information

Contents

CMTS Devices that Require Software License Activation

Software License Activation on CMTS Line Cards

Automated Software Activation Using Cisco License Manager

License Registration Using the Product License Registration Portal and CLI

Software License Activation Using License Call Home

Software License Activation on Cisco uBR-MC3GX60V Cable Line Cards

3G60M - Minimum Mode Operation

Enforcement Policy

Cisco uBR-MC3GX60V Line Card License Revocation

Reload of the Cisco uBR-MC3GX60V Line Card

License Types

Permanent License

Temporary Licenses

License Transfer

License Transfer Between Two Working Devices

RMA License Transfer

Restrictions for RMA

License Upgrade

Upgrading the Line Card Software License

Verifying the License Upgrade

Upgrading the License When Line Card is in LCHA Mode

Restrictions for Software License Activation on the Cisco CMTS Routers

Troubleshooting Licensing By Using Software Activation

Additional References

Related Documents

Standards

MIBs

Technical Assistance


Software License Activation on Cisco CMTS Routers


First Published: January 18, 2010
Last Updated: November 29, 2010, OL-21519-03

The Cisco Software License Activation feature is a set of processes and components to activate Cisco IOS software feature sets by obtaining and validating fee-based Cisco software licenses. However, the CMTS licenses are used to control access to the RF channels and will be used for activating software licenses in the future.

To enable all software features, all new or upgraded Cisco devices that require software license activation, must be registered with Cisco. The registration process requires a Product Authorization Key (PAK), an 11-character alphanumeric key printed on the purchase order document shipped with your device hardware. The registration process converts the PAK to an electronic license file containing a unique key for your device hardware. The license file must then be installed on your device to unlock the product and its features.

Finding Feature Information

Your software release may not support all the features documented in this module. For the latest feature information and caveats, see the release notes for your platform and software release.

Use Cisco Feature Navigator to find information about platform support and Cisco IOS, Catalyst OS, and Cisco IOS XE software image support. To access Cisco Feature Navigator, go to http://www.cisco.com/go/cfn. An account on Cisco.com is not required.

Contents

CMTS Devices that Require Software License Activation

Software License Activation on CMTS Line Cards

License Types

License Transfer

License Upgrade

Restrictions for Software License Activation on the Cisco CMTS Routers

Troubleshooting Licensing By Using Software Activation

Additional References

CMTS Devices that Require Software License Activation

Table 1 lists the Cisco CMTS devices that require software activation and licensing to enable Cisco IOS software feature sets.


Note The hardware components introduced in a given Cisco IOS Release will be supported in all subsequent releases unless otherwise specified.


Table 1 CMTS Devices that Require Software License Activation

CMTS Device
CMTS Platform
Minimum Cisco IOS Release
Device Description

Cisco UBR-MC20X20V Cable Interface Line Card

Cisco uBR10012 Universal Broadband Router

Cisco IOS Release12.2(33)SCC

The Cisco UBR-MC20X20V cable interface line card is designed specifically for the Cisco uBR10012 universal broadband router. This card transmits and receives RF signals between the subscriber and the headend over hybrid fiber-coaxial (HFC) system.

The stock keeping unit (SKU) for the Cisco UBR-MC20X20V cable interface line card are:

UBR-MC20X20V-0D

UBR-MC20X20V-5D

UBR-MC20X20V-20D

Cisco uBR-MC88V Cable Interface Line Card

Cisco uBR7225VXR Universal Broadband Router and Cisco uBR7246VXR Universal Broadband Router

Cisco IOS Release 12.2(33)SCD

The Cisco uBR-MC88V cable interface line card is a DOCSIS 3.0 line card designed specifically for Cisco uBR7246VXR and Cisco uBR7225VXR universal broadband routers. This line card serves as the RF interface between the cable headend and the DOCSIS-compliant cable modems, EuroDOCSIS-compliant cable modems, or set-top boxes (STBs).

The SKU for the Cisco uBR-MC88V cable interface line card is UBR-MC8X8V-8D.

Cisco uBR-MC3GX60V Cable Interface Line Card

Cisco uBR10012 Universal Broadband Router

Cisco IOS Release 12.2(33)SCE

The Cisco uBR-MC3GX60V line card is a high density Modular CMTS line card that provides 72 Annex B downstream and 60 upstream channels. This line card facilitates increased bandwidth to the cable modems.

The licenses for the Cisco uBR-MC3GX60V cable interface line card are SWLIC-MC3GX60V-US and SWLIC-MC3GX60V-DS.



Note Software license activation procedure is required when you want to upgrade a lower SKU to a higher SKU. For example to upgrade from 0D to 5D, or 20D, in Cisco UBR-MC20X20V line cards.


Software License Activation on CMTS Line Cards

You can register licenses and enable the following licensed features with the Cisco Software License Activation feature:

Automated Software Activation Using Cisco License Manager

License Registration Using the Product License Registration Portal and CLI

Software License Activation Using License Call Home


Note During the initial product purchase, based on the customer order, Cisco installs the appropriate licenses. In such a case, no license activation is required.


Automated Software Activation Using Cisco License Manager

Cisco License Manager (CLM) is a software application that assists you in obtaining licenses from Cisco, deploying the licenses on to the Cisco devices in your network, discovering the devices, and managing and viewing your inventory of licenses and devices. CLM is used with Cisco devices that require Cisco licensing.


Note You do not require Internet connectivity from your device to Cisco to activate the software licenses using CLM.


See the User Guide for Cisco License Manager for more information.


Note You must add your Cisco devices to CLM before you can request a license file.


To use CLM to automate all license-related workflows, follow these steps:


Step 1 To log into CLM, click the Cisco License Manager Client icon on your desktop or select the Cisco License Manager Server.exe or Cisco License Manager Client.exe file.

Step 2 The Login window appears. Enter information for the User ID, Password, Server Host, and Server Port and click OK.

Step 3 The CLM GUI appears. Click Manage > Manage Devices, or click Devices in the Quick Links pane. The Manage Devices explorer appears in the Content Area.

Step 4 Select an existing device group folder or create a new folder to which you want to add a new device. Make sure to select a folder that makes sense to you so that you can easily locate and retrieve device and license information at a later date.

Step 5 Select the device group folder, right-click, and select New Device. The New Device dialog box appears. Enter the requested information as prompted in CLM to add the new devices.

Step 6 Click Get License in the Quick Links pane, and follow the prompts to deploy the license to your device.


License Registration Using the Product License Registration Portal and CLI

The Cisco Software License Activation feature includes Cisco IOS EXEC commands that allow basic licensing tasks from the CLI.

To install a license using Cisco IOS commands:


Step 1 Obtain the PAK when you purchase Cisco devices or software upgrades.

Step 2 To obtain the specific unique device identifiers (UDI) for your device, log in to your router and use the show license udi command.

Step 3 Convert the PAK to a license by entering the appropriate information at the following URL:

http://www.cisco.com/go/license.

Enter the PAK to retrieve the Stock Keeping Units (SKU) and enter the UDI of the device where the license should be installed. A Download License button appears on the screen. You can select this button to download the license or use the license details provided in the e-mail sent to the customer.

Step 4 To install the licenses on the devices, use the license install command.


Figure 3 shows the process for registering a license using the Product License Registration Portal.

Figure 1 Product License Registration Work Flow


Note Starting from Cisco IOS Release 12.2(33)SCE, you can view license information as applied to RF channels on the CMTS chassis, using the show cable licenses all command.


For more information about using commands for Cisco software activation, see the Cisco Software Activation Tasks and Commands document.

Software License Activation Using License Call Home

You can access the Cisco Product License Registration portal directly using the Cisco License Call Home interface. This interface is included with the Cisco Software License Activation feature and described in the Cisco Software Activation Conceptual Overview document. The License Call Home feature works as a client or server model. Each transaction requires a separate connection to the Cisco licensing infrastructure.


Note You require Internet connectivity from your device to Cisco to activate the software licenses using Call Home feature.



Note The License Call Home feature is not supported for license activation on Cisco uBR10012 router with Cisco uBR-MC3GX60V line card. This method of license activation cannot be used for Cisco uBR10012 router with Cisco uBR-MC3GX60V line card.


The License Call Home feature displays prompts for obtaining required information, converting that information into a defined data structure, and then connecting to the Cisco licensing back-end to interact with the Cisco licensing infrastructure. A request is initiated by a License Call Home EXEC command, and the response is provided by the Cisco licensing infrastructure.


Note For requirements or restrictions of the Call Home feature, see the Installing and Upgrading Licenses Using License Call Home section in the Cisco Software Activation Tasks and Commands document.


To install a license using the License Call Home feature, follow these steps:


Step 1 Obtain the PAK when you purchase Cisco devices or software upgrades.

Step 2 To display the SKU list and features available for the PAK provided, use the show license call-home pak command in privileged EXEC mode.

Step 3 To install a license by using the Cisco License Call Home function, use the license call-home install pak command.

Step 4 Complete the license installation by entering yes when prompted to install the license and then entering the details requested.


Figure 2 shows the process for activating licenses using the Call Home interface.

Figure 2 Call Home License Work Flow

For more information about the CLI for Cisco Software Activation, see the Cisco Software Activation Tasks and Commands document.

Software License Activation on Cisco uBR-MC3GX60V Cable Line Cards

The Cisco uBR-MC3GX60V line card is a high density Modular CMTS line card that has 72 Annex B downstream and 60 upstream channels, and is introduced to provide increased bandwidth to the cable modems.


Note Downstream licenses that are multiples of 24 are displayed as XG, where X is 0, 1, 2, or 3. All other downstream license counts are displayed as number of channels.


The front panel has a four-character alphanumeric display that indicates the licensing status information of the upstream and downstream ports. The first two characters identify the downstream license count and the remaining characters identify the upstream license count of the line card. For example, 1G24, 2G40, 3G60, and others.


Note See the Software License Activation on CMTS Line Cards for a generic procedure to activate licensed features and register licenses for the Cisco uBR-MC3GX60V line card.
The Cisco uBR-MC3GX60V line card does not support the License Call Home feature.


The following sections are specific to the Cisco uBR-MC3GX60V line card:

3G60M - Minimum Mode Operation

Enforcement Policy

Cisco uBR-MC3GX60V Line Card License Revocation

Reload of the Cisco uBR-MC3GX60V Line Card

3G60M - Minimum Mode Operation

The 3G60M mode of operation, also known as the minimum mode (besides the normal mode), is used to install license for a clean board and perform any license operations when an error occurs due to non-availability of licenses. The Minimum mode or M mode refers to the state where no valid licenses are available.

In the minimum mode operation, the 3G60M will function with the following characteristics:

Fully functional license administrative interface.

Fully functional license management interface.

US and DS configurations are available but you cannot un-shut any RF channels.

Modems are not online and there is no network traffic.

Enforcement Policy

The Cisco uBR-MC3GX60V line card licensing feature allows any number of downstream and upstream channels to be licensed. The enforcement of the licensing policy will occur when the user un-shuts a specific RF channel.

The key characteristics of the license enforcement policy are:

The policy is applicable to upstream and downstream RF channels that are marked as administration no shut.

A line card reload is not required for new license upgrade to take effect.

When a line card subslot is provisioned or operational with a specific license, it is possible that a subsequent line card reload presents fewer licenses.

The channels that are allowed by the old license but restricted by the new license will be forced shut.

Subsequent license upgrade automatically restores forced-shut channels back to their original no-shut state

The show cable license command displays the forced shut channels.

Cisco uBR-MC3GX60V Line Card License Revocation

A license is revoked to rehost or transfer the existing license to another line card.

To revoke a Cisco uBR-MC3GX60V cable line card license, complete these steps:

1. Save the license credential.

2. Register the license credential to get a permission ticket.

3. Revoke the license with the permission ticket to get a rehost ticket.

4. Register the rehost ticket and get the rehosted license.

This example describes the rehosting or transferring of a 36x30 license from LC 7/0 (that originally has 72x60) to LC 5/1 (that originally has 24x20).

1. Save the license credential to disk0 as cd:

Router# license save credential disk0:cd s 7/0
Device credential saved ..... to disk0:cd

2. Use the more command to display the contents of device credential and copy it:

Router# more disk0:cd
<?xml version="1.0" encoding="UTF-8"?><CISCO_WT_ARTIFACTS 
version="1.0"><CISCO_WT_REHOST_ARTIFACT version="1.0"><HEADER><ARTIFACT_TYPE>Device 
Credentials</ARTIFACT_TYPE><ARTIFACT_VERSION>1.0</ARTIFACT_VERSION><TRANSACTION_ID>T 
and I trans 
encoding="BASE64">AAEAAgALAAsAVAECAQl3v/jPk/AWjh/8BCZDlVGWqn3tXgAAAAAAAAAAAAAAAC3ma7/u
wdGzEFBHbe310J+kFk5thbQWu/KV01Hru8Z3ZryOIHq3dbc1mC+VDGltkA==</SIGNATURE_INFO></CONTENT
></CISCO_WT_REHOST_ARTIFACT></CISCO_WT_ARTIFACTS>

3. Go to this website and paste the device credential to register and request a license transfer: (Use your Cisco.com user name and password to log in to the server.)

https://tools.cisco.com/SWIFT/Licensing/LicenseAdminServlet/licenseLookup

4. Run the show license detail command before rehosting the license from 7/0 to 5/1.

Router# show license detail s 7/0
Load for five secs: 1%/0%; one minute: 1%; five minutes: 2%
Time source is hardware calendar, *23:13:52.838 UTC Thu Sep 23 2010
Index: 1        Feature: DS_License                        Version: 1.0
        License Type: Permanent
        License State: Active, In Use
        License Count: 72/72/0  (Active/In-use/Violation)
        License Priority: Medium
        Store Index: 0
        Store Name: Primary License Storage
Index: 2        Feature: DS_License                        Version: 1.0
        License Type: Evaluation
        License State: Inactive
            Evaluation total period: 8  weeks 4  days 
            Evaluation period left: 0  minute  0  second  
        License Count: 72/0/0  (Active/In-use/Violation)
        License Priority: Low
        Store Index: 1
        Store Name: Evaluation License Storage
Index: 3        Feature: US_License                        Version: 1.0
        License Type: Permanent
        License State: Active, In Use
        License Count: 60/60/0  (Active/In-use/Violation)
        License Priority: Medium
        Store Index: 2
        Store Name: Primary License Storage
Index: 4        Feature: US_License                        Version: 1.0
        License Type: Evaluation
        License State: Inactive
            Evaluation total period: 8  weeks 4  days 
            Evaluation period left: 0  minute  0  second  
        License Count: 60/0/0  (Active/In-use/Violation)
        License Priority: Low
        Store Index: 0
        Store Name: Evaluation License Storage
Router# show license detail s 5/1
Load for five secs: 2%/0%; one minute: 1%; five minutes: 2%
Time source is hardware calendar, *23:15:27.394 UTC Thu Sep 23 2010
Index: 1        Feature: DS_License                        Version: 1.0
        License Type: Permanent
        License State: Active, In Use
        License Count: 24/24/0  (Active/In-use/Violation)
        License Priority: Medium
        Store Index: 1
        Store Name: Primary License Storage
Index: 2        Feature: DS_License                        Version: 1.0
        License Type: Evaluation
        License State: Inactive
            Evaluation total period: 8  weeks 4  days 
            Evaluation period left: 0  minute  0  second  
        License Count: 72/0/0  (Active/In-use/Violation)
        License Priority: Low
        Store Index: 1
        Store Name: Evaluation License Storage
Index: 3        Feature: US_License                        Version: 1.0
        License Type: Permanent
        License State: Active, In Use
        License Count: 20/20/0  (Active/In-use/Violation)
        License Priority: Medium
        Store Index: 0
        Store Name: Primary License Storage
Index: 4        Feature: US_License                        Version: 1.0
        License Type: Evaluation
        License State: Inactive
            Evaluation total period: 8  weeks 4  days 
            Evaluation period left: 0  minute  0  second  
        License Count: 60/0/0  (Active/In-use/Violation)
        License Priority: Low
        Store Index: 0
        Store Name: Evaluation License Storage

5. Copy the permission ticket (pt.lic) to the TFTP server and download it to the CMTS.

Router# copy tftp disk0:
Address or name of remote host []? network
Source filename []? computer/pt.lic
Destination filename [pt.lic]?   
Accessing tftp://network/computer/pt.lic...
Loading computer/pt.lic from 223.255.254.254 (via FastEthernet0/0/0): !
[OK - 8872 bytes]
8872 bytes copied in 0.472 secs (18797 bytes/sec)

6. Run the license revoke command.

Router# license revoke disk0:pt.lic disk0:rt
Following Permanent license(s) will be revoked from this device
        Feature Name: US_License : Count = 60
        Feature Name: DS_License : Count = 72
Following Permanent license(s) will be installed on this device
        Feature Name: DS_License : Count = 36
        Feature Name: US_License : Count = 30
Following Extension license(s) will be installed on this device
        Feature Name: DS_License : Count = 72
        Feature Name: US_License : Count = 60
PLEASE  READ THE  FOLLOWING TERMS  CAREFULLY. INSTALLING THE LICENSE OR
LICENSE  KEY  PROVIDED FOR  ANY CISCO  PRODUCT  FEATURE  OR  USING SUCH
PRODUCT  FEATURE  CONSTITUTES  YOUR  FULL ACCEPTANCE  OF  THE FOLLOWING
TERMS. YOU MUST NOT PROCEED FURTHER IF YOU ARE NOT WILLING TO  BE BOUND
BY ALL THE TERMS SET FORTH HEREIN.
You hereby  acknowledge  and  agree that  the  product feature  license
is terminable and that the product  feature  enabled  by  such  license
may  be  shut  down or  terminated by  Cisco  after  expiration of  the
applicable  term  of  the license  (e.g., 30-day  trial  period). Cisco
reserves the  right to terminate or shut down  any such product feature
electronically  or by  any other  means available. While alerts or such
messages  may  be provided, it is  your sole  responsibility to monitor
your terminable  usage of any  product  feature enabled by  the license
and to ensure that your systems and  networks are prepared for the shut
down of the product feature. You acknowledge  and agree that Cisco will
not have any liability  whatsoever for  any damages, including, but not
limited to, direct, indirect, special, or consequential damages related
to any product  feature  being shutdown or terminated. By clicking  the
"accept" button  or typing "yes" you are  indicating  you have read and
agree to be bound by all the terms provided herein.
ACCEPT? (yes/[no]): yes
Rehost ticket saved ..... to disk0:rt
Router#
SLOT 7/0: Sep 23 23:25:19.474: %LICENSE-6-EULA_ACCEPTED: EULA for feature DS_License 
1.0 has been accepted. UDI=UBR-MC3GX60V:CSJ13462933; StoreIndex=1:Primary License 
Storage
SLOT 7/0: Sep 23 23:25:19.778: %LICENSE-6-EULA_ACCEPTED: EULA for feature US_License 
1.0 has been accepted. UDI=UBR-MC3GX60V:CSJ13462933; StoreIndex=3:Primary License 
Storage
SLOT 7/0: Sep 23 23:25:19.810: %LICENSE-6-RECOVERED: The IOS license storage on this 
device was recovered. UDI=UBR-MC3GX60V:CSJ13462933
SLOT 7/0: Sep 23 23:25:19.810: %LICENSE-6-RECOVERED: The IOS license storage on this 
device was recovered. UDI=UBR-MC3GX60V:CSJ13462933
SLOT 7/0: Sep 23 23:25:19.810: %LICENSE-6-INSTALL: Feature DS_License 1.0 was 
installed in this device. UDI=UBR-MC3GX60V:CSJ13462933; StoreIndex=1:Primary License 
Storage
SLOT 7/0: Sep 23 23:25:19.810: %LICENSE-6-RECOVERED: The IOS license storage on this 
device was recovered. UDI=UBR-MC3GX60V:CSJ13462933
SLOT 7/0: Sep 23 23:25:19.810: %LICENSE-6-RECOVERED: The IOS license storage on this 
device was recovered. UDI=UBR-MC3GX60V:CSJ13462933
SLOT 7/0: Sep 23 23:25:19.814: %LICENSE-6-INSTALL: Feature US_License 1.0 was 
installed in this device. UDI=UBR-MC3GX60V:CSJ13462933; StoreIndex=3:Primary License 
Storage
SLOT 7/0: Sep 23 23:25:19.814: %LICENSE-6-REVOKED: License for feature DS_License 1.0 
has been revoked. UDI=UBR-MC3GX60V:CSJ13462933; StoreIndex=0:Primary License Storage
SLOT 7/0: Sep 23 23:25:19.814: %LICENSE-6-INSTALL: Feature DS_License 1.0 was 
installed in this device. UDI=UBR-MC3GX60V:CSJ13462933; StoreIndex=0:Primary License 
Storage
SLOT 7/0: Sep 23 23:25:19.818: %LICENSE-6-RECOVERED: The IOS license storage on this 
device was recovered. UDI=UBR-MC3GX60V:CSJ13462933
SLOT 7/0: Sep 23 23:25:19.818: %LICENSE-6-RECOVERED: The IOS license storage on this 
device was recovered. UDI=UBR-MC3GX60V:CSJ13462933
SLOT 7/0: Sep 23 23:25:19.818: %LICENSE-6-RECOVERED: The IOS license storage on this 
device was recovered. UDI=UBR-MC3GX60V:CSJ13462933

7. Run the show license detail command after the 36x30 license is revoked.

Router# show license d s 7/0
Load for five secs: 1%/0%; one minute: 1%; five minutes: 1%
Time source is hardware calendar, *01:42:32.163 UTC Fri Sep 24 2010
Index: 1        Feature: DS_License                        Version: 1.0
        License Type: Evaluation
        License State: Active, In Use
            Evaluation total period: 8  weeks 4  days 
            Evaluation period left: 8  weeks 3  days 
            Expiry date: Nov 23 2010 01:40:31
        License Count: 72/72/0  (Active/In-use/Violation)
        License Priority: High
        Store Index: 2
        Store Name: Primary License Storage
Index: 2        Feature: DS_License                        Version: 1.0
        License Type: Permanent
        License State: Inactive
        License Count: 72/0/0  (Active/In-use/Violation)
        License Priority: Medium
        Store Index: 1
        Store Name: Primary License Storage
Index: 3        Feature: DS_License                        Version: 1.0
        License Type: Permanent
        License State: Inactive
        License Count: 36/0/0  (Active/In-use/Violation)
        License Priority: Medium
        Store Index: 4
        Store Name: Primary License Storage
Index: 4        Feature: DS_License                        Version: 1.0
        License Type: Evaluation
        License State: Inactive
            Evaluation total period: 8  weeks 4  days 
            Evaluation period left: 0  minute  0  second  
        License Count: 72/0/0  (Active/In-use/Violation)
        License Priority: Low
        Store Index: 1
        Store Name: Evaluation License Storage
Index: 5        Feature: US_License                        Version: 1.0
        License Type: Evaluation
        License State: Active, In Use
            Evaluation total period: 8  weeks 4  days 
            Evaluation period left: 8  weeks 3  days 
            Expiry date: Nov 23 2010 01:40:31
        License Count: 60/60/0  (Active/In-use/Violation)
        License Priority: High
        Store Index: 3
        Store Name: Primary License Storage
Index: 6        Feature: US_License                        Version: 1.0
        License Type: Permanent
        License State: Inactive
        License Count: 60/0/0  (Active/In-use/Violation)
        License Priority: Medium
        Store Index: 0
        Store Name: Primary License Storage
Index: 7        Feature: US_License                        Version: 1.0
        License Type: Permanent
        License State: Inactive
        License Count: 30/0/0  (Active/In-use/Violation)
        License Priority: Medium
        Store Index: 5
        Store Name: Primary License Storage
Index: 8        Feature: US_License                        Version: 1.0
        License Type: Evaluation
        License State: Inactive
            Evaluation total period: 8  weeks 4  days 
            Evaluation period left: 0  minute  0  second  
        License Count: 60/0/0  (Active/In-use/Violation)
        License Priority: Low
        Store Index: 0
        Store Name: Evaluation License Storage
Router# show license d s 5/1
Load for five secs: 1%/0%; one minute: 1%; five minutes: 1%
Time source is hardware calendar, *01:43:08.139 UTC Fri Sep 24 2010
Index: 1        Feature: DS_License                        Version: 1.0
        License Type: Permanent
        License State: Active, In Use
        License Count: 24/24/0  (Active/In-use/Violation)
        License Priority: Medium
        Store Index: 1
        Store Name: Primary License Storage
Index: 2        Feature: DS_License                        Version: 1.0
        License Type: Evaluation
        License State: Inactive
            Evaluation total period: 8  weeks 4  days 
            Evaluation period left: 0  minute  0  second  
        License Count: 72/0/0  (Active/In-use/Violation)
        License Priority: Low
        Store Index: 1
        Store Name: Evaluation License Storage
Index: 3        Feature: US_License                        Version: 1.0
        License Type: Permanent
        License State: Active, In Use
        License Count: 20/20/0  (Active/In-use/Violation)
        License Priority: Medium
        Store Index: 0
        Store Name: Primary License Storage
Index: 4        Feature: US_License                        Version: 1.0
        License Type: Evaluation
        License State: Inactive
            Evaluation total period: 8  weeks 4  days 
            Evaluation period left: 0  minute  0  second  
        License Count: 60/0/0  (Active/In-use/Violation)
        License Priority: Low
        Store Index: 0
        Store Name: Evaluation License Storage

8. Use the more command to display the contents of the rehost ticket and copy it.

Router# more disk0:rt
<?xml version="1.0" encoding="UTF-8"?><CISCO_WT_ARTIFACTS 
version="1.0"><CISCO_WT_REHOST_ARTIFACT version="1.0"><HEADER><ARTIFACT_TYPE>Rehost 
Artifact</ARTIFACT_TYPE><ARTIFACT_VERSION>1.0</ARTIFACT_VERSION><TRANSACTION_ID>008079
65C0</TRANSACTION_ID><UDI><PID>UBR-MC3GX60V</PID><SN>CSJ13462933</SN></UDI><SOURCE>Dev
ice</SOURCE><CREATE_DATE>2010-09-24T04:48:41.619Z</CREATE_DATE><CISCO_REHOST_CHANGES><
CISCO_REHOST_ADD><CISCO_WT_LICENSE 
dtaxSslY9d3w7XhoVvObxHQiTczpRA084jgKoqQ0iBbt4jMKdhlVA==</SIGNATURE_INFO></CONTENT></CI
SCO_WT_REHOST_ARTIFACT></CISCO_WT_ARTIFACTS>

9. Go to this website and paste the rehost ticket to register and get the rehosted license.

https://tools.cisco.com/SWIFT/Licensing/LicenseAdminServlet/viewUploadRehostTkt

10. Run the show license detail command for 5/1 after installing the rehosted 36x30 license. The count changes to 60/50 as expected.

Router# show license d s 5/1
Load for five secs: 1%/0%; one minute: 1%; five minutes: 1%
Time source is hardware calendar, *01:49:07.819 UTC Fri Sep 24 2010
Index: 1        Feature: DS_License                        Version: 1.0
        License Type: Permanent
        License State: Active, In Use
        License Count: 60/60/0  (Active/In-use/Violation)
        License Priority: Medium
        Store Index: 3
        Store Name: Primary License Storage
Index: 2        Feature: DS_License                        Version: 1.0
        License Type: Permanent
        License State: Inactive
        License Count: 24/0/0  (Active/In-use/Violation)
        License Priority: Medium
        Store Index: 1
        Store Name: Primary License Storage
Index: 3        Feature: DS_License                        Version: 1.0
        License Type: Evaluation
        License State: Inactive
            Evaluation total period: 8  weeks 4  days 
            Evaluation period left: 0  minute  0  second  
        License Count: 72/0/0  (Active/In-use/Violation)
        License Priority: Low
        Store Index: 1
        Store Name: Evaluation License Storage
Index: 4        Feature: US_License                        Version: 1.0
        License Type: Permanent
        License State: Active, In Use
        License Count: 50/50/0  (Active/In-use/Violation)
        License Priority: Medium
        Store Index: 2
        Store Name: Primary License Storage
Index: 5        Feature: US_License                        Version: 1.0
        License Type: Permanent
        License State: Inactive
        License Count: 20/0/0  (Active/In-use/Violation)
        License Priority: Medium
        Store Index: 0
        Store Name: Primary License Storage
Index: 6        Feature: US_License                        Version: 1.0
        License Type: Evaluation
        License State: Inactive
            Evaluation total period: 8  weeks 4  days 
            Evaluation period left: 0  minute  0  second  
        License Count: 60/0/0  (Active/In-use/Violation)
        License Priority: Low
        Store Index: 0
        Store Name: Evaluation License Storage

Reload of the Cisco uBR-MC3GX60V Line Card

The Cisco uBR-MC3GX60V line card does not require a reload for a new license upgrade or downgrade to take effect.

However, if there are no licenses on the Cisco uBR-MC3GX60V line card except the image in-built evaluation license, then to make that evaluation license effective, you must reload the line card.

Evaluation licenses can be made effective when:

There are no effective licenses available. This requires a reload.

The available licenses are of a lower value. This does not require a reload.

The following is the sample output when there are no effective licenses on the line card:

Router# show running-config | include license
card 5/0 ubr10k-clc-3g60 license none
Router# show cable license 5/0
Subslot 5/0 : License Configuration : none
--------------------------------------------
        Downstream Licenses : Installed : 0   Consumed : 0   Available : 0
Forced-Shut : 0
        Upstream Licenses   : Installed : 0   Consumed : 0   Available : 0
Forced-Shut : 0
        License IPC Received : TRUE

License Types

These are the license types available for the Cisco CMTS routers.

Permanent License

Temporary Licenses

Permanent License

Permanent licenses are not time-bound, and upon installation, they provide all the permissions needed to access features in the software image. All permanent licenses are validated by the Cisco IOS licensing infrastructure during software installation. Cisco manufacturing pre-installs the appropriate permanent license on the ordered device for the purchased feature set. No customer interaction with the Cisco IOS Software Activation processes is required to enable a license on new hardware.

Temporary Licenses

Temporary licenses are limited to a specific usage period (for example, 60-days). You must accept the end-user license agreement before the temporary licenses can be activated.

There are three types of temporary licenses: those embedded in Cisco IOS images, evaluation licenses obtained from the Cisco Product License Registration portal, and extension licenses that are obtained from the Cisco TAC.

Although the embedded license can also be used for evaluation purposes, we recommend that you use the embedded license for emergency use only and obtain an evaluation license from the self-serve Cisco Product Licensing Registration portal.


Caution When the temporary license is about to expire, the following error message is observed on the Cisco CMTS:
%LICENSE-1-EXPIRING: License for feature US_License 1.0 will expire in 5 minutes
Ensure that an equivalent permanent license is installed on the Cisco CMTS to avoid any service disruptions. For more information on how to obtain a permanent license, see License Registration Using the Product License Registration Portal and CLI. Contact TAC if further assistance is required.

These sections further define the types of temporary licenses:

Evaluation License

Emergency License

Extension License

Evaluation License

Evaluation licenses are also temporary and used to evaluate a feature set on a new line card.

You obtain evaluation licenses from the Cisco licensing portal: https://tools.cisco.com/SWIFT/Licensing/PrivateRegistrationServlet?DemoKeys=Y

You can enable or disable evaluation licenses for Cisco uBR-MC3GX60V and Cisco UBR-MC20X20V cable interface line cards only. A cable interface line card evaluation license is not enabled by default. To enable an evaluation license, run the license feature evaluation enable command in global configuration mode. To disable an evaluation license, run the license feature evaluation disable command in global configuration mode.

The software licenses issued for the Cisco uBR-MC3GX60V line card are not interchangeable with licenses of other line cards.

The following example is a typical evaluation license command.

Router(config)#license feature evaluation enable all subslot 8/0

Note Upgrade the existing license status on the Cisco Product License Registration portal, before the evaluation license expires.


Emergency License

To avoid network down time in the event of device failure and if the replaced device does not have the same licenses as the failed device, you can use an evaluation license embedded in the software image, which ensures that you can configure the needed features without requiring a license key. However, you must still accept an end-user license agreement and must acknowledge that there is a 60-day usage limit for the evaluation license.


Note Obtain a permanent RMA replacement license from the Cisco Product License Registration portal.


Extension License

When the evaluation licenses expires, contact TAC to obtain an extension license. Similar to an evaluation license, extension licenses are node locked and valid for a specific period (for example, 60 days) based on usage.

License Transfer

The CMTS routers support two scenarios to transfer licenses between devices:

The first scenario has both the source and destination devices active and functional. In this scenario, the license is revoked on the source device, and a new permanent license is issued for the destination device.

The second is a failure scenario in which one of the devices is unavailable. In this scenario, the license from the failed device is transferred to the RMA or to the replaced device by using the RMA License Transfer process on the Cisco Product License Registration portal.

License Transfer Between Two Working Devices

The CMTS routers support fully automated, customer-initiated, transfer of licenses. You can transfer licences with a process known as rehosting. The rehosting process transfers a license from one UDI to another by revoking the license from the source device and installing it on a new device.

You perform a license transfer (rehosting) by using one of these methods:

Cisco Product License Registration portal

Cisco IOS License Call Home commands

Cisco License Manager application


Note Starting with Cisco IOS Release 12.2(33)SCC, preinstalled licenses from manufacturing cannot be rehosted.


Figure 3 shows the processes involved for rehosting (transferring) a license.

Figure 3 License Transfer Work Flow

This is a summary of a license transfer process using the Cisco Product License Registration portal:

1. Obtain the UDI and device credentials from the source and destination devices by using Cisco IOS commands. For more information, see the Cisco IOS Software Activation Tasks and Commands module.

2. Contact the Product License Registration page on Cisco.com, and enter the source device credentials and the UDI into the license transfer portal tool.

3. The portal displays licenses that can be transferred from the source device.

Select the licenses that need to be transferred. A permission ticked is issued. Use this permission ticket to start the rehost process by using Cisco IOS commands.

4. Apply the permissions ticket to the source device by using the license revoke command as described in the Cisco IOS Software Activation Tasks and Commands module. The source device then provides a rehost ticket indicating proof of revocation. A sixty-day grace period license is also installed on the device to allow enough time to transfer the licenses to the destination device.

5. Enter the rehost ticket into the license transfer portal tool on Cisco.com along with destination device UDI.

6. Receive the license key through email.

7. Install the license key on the destination device.

When you use the license call-home resend command, the source device contacts the Cisco Product License Registration portal and obtains a license key for the destination device after revoking it from the source device. The license key stored on the source device can then be installed on the destination device to complete the transfer.

By using Cisco License Manager, you can select the source and destination devices from a GUI wizard for automated processing.

RMA License Transfer

When a line card fails, a replacement card is required with equivalent licenses for restoring the services completely. If the failed line card has the same license as the shipping order, the return materials authorization (RMA) replacement and spares will also have the same license as the failed line card.

To transfer a software license from a failed device to a new device, the devices must interact with the Cisco Product License Registration portal to initiate an RMA replacement license (http://www.cisco.com/go/license).

If you need assistance to obtain a license, contact Cisco technical support at: http://www.cisco.com/cisco/web/support/index.html

Figure 4 shows the RMA replacement license process.

Figure 4 RMA Replacement License Work Flow

The RMA replacement license process involves these steps:

1. Obtain the UDI of the defective and RMA devices.

2. Enter the UDI into the RMA License portal tool on Cisco.com.

3. The license portal determines licenses associated with defective device.

4. The license portal issues replacement licenses.

5. Install the new license on the new device.


Note During initial releases, the Cisco Service Depot will ship products with 0X0 license.


Restrictions for RMA

These are restrictions for RMA:

If the line card is not part of the LCHA, follow the steps in License Upgrade.

If the line card is part of the LCHA, and the RMA is for the protect line card, follow the steps in Upgrading the License When Line Card is in LCHA Mode.

If the RMA is for the working line card, the service automatically switches over to the protect line card. To verify this:

Insert the replacement line card.

Verify the effective license for the working line card by running the show running-config | include license command.

If effective license is not the same as previous license in slot, do the following:

Upgrade the working line card. For more information, see License Upgrade.

Verify the installed license on the working line card by running the show license detail subslot command.

Ensure that the working line card continues to be on the HCCP standby.

Reload the working line card.

Verify the effective license by running the show running-config | include license command.

Revert to the upgraded line card.

Run the no shut command on all upstream and downstream channels.

License Upgrade

To enable all software features, all new or upgraded Cisco devices that require software activation must be registered with Cisco. The registration process requires a Product Authorization Key (PAK), which is an 11-character alphanumeric key printed on the purchase order document shipped with your device hardware. The registration process converts the PAK to an electronic license file containing a unique key for your device hardware. The license file must then be installed on your device to unlock the product and its features.

This feature consists of the following sections:

Upgrading the Line Card Software License

Verifying the License Upgrade

Upgrading the License When Line Card is in LCHA Mode

Upgrading the Line Card Software License

To upgrade and install a license, perform these steps:

1. Purchase a Product Authorization Key (PAK) for the required type of license. For example, the UBR-MC2G40 (which provides the 48 downstream channel and 40 upstream channel license for the Cisco uBR-MC3GX60V line card).

2. Submit the PAK code and UDI of the line card to the Cisco Product License Registration portal. The portal retrieves the stock keeping units (SKUs) associated with the PAK.

3. Select the SKU and enter the UDI—a unique and unchangeable identifier of the device where the license should be installed. A license key is then e-mailed to you, which you can use to upgrade the license.

4. Install the license file returned from the license portal by using Cisco IOS commands. (This step can also be completed using the Cisco License Manager, which can be downloaded at http://www.cisco.com/go/clm.)


Note If you use Microsoft Entourage and receive the license file from Cisco in an e-mail attachment, the license file will contain UTF-8 marking. These extra bytes in the license file makes it unusable during license installation. To work around this issue, you can use a text editor to remove the extra characters and then install the license file. For more information about UTF-8 encoding, go to this URL: http://www.w3.org/International/questions/qa-utf8-bom


5. Reset the line card with the hw-module subslot slot/subslot reset command.

You can manually upgrade a license by using the install license command. However, before you upgrade the license you must have already received the license file from Cisco Product License Registration at http://www.cisco.com/go/license.


Note In the case of Cisco UBR-MC20X20V cable interface line card, to upgrade to a 10DS or 15DS license, you can purchase either a Cisco UBR-MC20X20V-0D or Cisco UBR-MC20X20V-5D cable interface line cards and then purchase multiples of +5DS licenses. Alternatively, you could directly purchase +10DS or +15DS licenses.


SUMMARY STEPS

1. Obtain the PAK.

2. enable

3. show license udi

4. Convert the PAK to a license.

5. license install stored-location-url

DETAILED STEPS


Step 1 Obtain the PAK.

Step 2 enable

This command enables privileged EXEC mode.

Router> enable

Enter password, if prompted.

Step 3 show license udi

This command displays all licensable UDIs in the system. The following is the sample output from this command:

Router# show license udi
SlotID   PID                    SN                      UDI
--------------------------------------------------------------------------------
 5       UBR-MC88U             CSJ13054214     UBR-MC88U:CSJ13054214

Step 4 Convert the PAK to a license (http://www.cisco.com/go/license).

After entering the appropriate information, you will receive an e-mail with the license information that you can use to install the license.

Step 5 license install stored-location-url

This command installs the license. Follow the instructions on the screen.

When a license is successfully installed, a message confirms the installation and states whether or not the licensed feature is present in the current image.

Router# license install tftp://223.255.254.254/<user>/licenses/CSJ13462916_72X60.lic 

Installing licenses from tftp://223.255.254.254/<user>/licenses/CSJ13462916_72X60.lic

Loading <user>/licenses/CSJ13462916_72X60.lic from 223.255.254.254 (via FastEthernet0/0/0):!

[OK - 2239 bytes]

*Apr 25 12:33:22.823Installing...Feature:US_License...Successful:Supported

Installing...Feature:DS_License...Successful:Supported

2/2 licenses were successfully installed

0/2 licenses were existing licenses

0/2 licenses were failed to install

Router#


Verifying the License Upgrade

You can verify the license upgrade by using the following commands:

show running-config | include license

This command displays the running configuration for each cable interface. The following is the sample output from this command:

Router# show running-config | include license
card 5/1 ubr10k-clc-3g60 license 72X60
card 8/1 ubr10k-clc-3g60 license 72X60
Router#

show diag slot/subslot

This command displays diagnostic information for port adapters, or modules, or both. This is the sample output from this command:

Router# show diag 5/1
 
Slot/Subslot 5/1:
        ubr10k-clc-3g60 card, 15 ports
        Card is half slot size
        Card is analyzed
        Card detected 1d06h ago
        Card uptime 1 days, 6 hours, 25 minutes, 15 seconds
        Card idle time N/A
        Voltage status: 3.3V Nominal 2.5V Nominal 1.8V Nominal 1.5V Nominal 1.2V
 Nominal 1.0V Nominal 1.0V Nominal 1.1V Core Nominal 1.1V Cpu Plat Nominal
EEPROM contents, slot 5/1:
        Controller Type          : 1629
        Hardware Revision        : 1.10
        Top Assy. Part Number    : 800-33189-01
        Top Assy. Revision       : 02
        Product Identifier (PID) : UBR-MC3GX60VV
        Version Identifier (VID) : V01
        CLEI Code                : NOCLEICODE
        Deviation Number         : 0
        Fab Version              : 03
        PCB Serial Number        : CSJ13382914
        RMA Test History         : 00
        RMA Number               : 0-0-0-0
        RMA History              : 00
        Asset ID                 : P1B-14
        Asset Alias              : tonliu
        License                  : 72X60
        Licensing Transaction ID : 0 DS, 20 US
        Ordered Software PIDs    :
                SWLIC-MC3GX60VV-DS  : 0
                SWLIC-MC3GX60VV-US  : 20
LCMON version, slot 5/1
        Cisco IOS Software, 10000 Software (UBR10KG4CLC-EBOOT-M), Version 12.2(P
EREGRINE_20100120) EARLY DEPLOYMENT DATECODE BUILD, synced to V122_32_7_13_SCD
        Compiled Wed 20-Jan-10 05:40 by narana
        Reset due to: power-on
Operational Image version, slot 5/1
        Cisco IOS Software, 10000 Software (UBR10KG4CLC-LCK8-M), Experimental Ve
rsion 12.2(20100622:211925) [yuel-cobra_cable_0622 105]
        Compiled Tue 22-Jun-10 21:16 by yuel
        SW Version 1.0
        Code MD5 F76CCE5FFDF6DEFE17492B8D37B60071
        FPGA MD5 00000000000000000000000000000000
        Expected Switchover Action: NO INFORMATION

show license detail

This command displays the details of the license. This is the sample output from this command:

Router# show license detail subslot 5/1
Index: 1        Feature: DS_License                        Version: 1.0
        License Type: Permanent
        License State: Active, In Use
        License Count: 72/72/0  (Active/In-use/Violation)
        License Priority: Medium
        Store Index: 0
        Store Name: Primary License Storage
Index: 2        Feature: DS_License                        Version: 1.0
        License Type: Evaluation
        License State: Inactive
            Evaluation total period: 8  weeks 4  days
            Evaluation period left: 8  weeks 4  days
        License Count: 72/0/0  (Active/In-use/Violation)
        License Priority: None
        Store Index: 1
        Store Name: Evaluation License Storage
Index: 3        Feature: US_License                        Version: 1.0
        License Type: Permanent
        License State: Active, In Use
        License Count: 60/60/0  (Active/In-use/Violation)
        License Priority: Medium
        Store Index: 1
        Store Name: Primary License Storage
Index: 4        Feature: US_License                        Version: 1.0
        License Type: Evaluation
        License State: Inactive
            Evaluation total period: 8  weeks 4  days
            Evaluation period left: 8  weeks 4  days
        License Count: 60/0/0  (Active/In-use/Violation)
        License Priority: None
        Store Index: 0
        Store Name: Evaluation License Storage

show cable license all

This command displays details of all licenses in the chassis. This is the sample output from this command:

Router# show cable license all
Subslot 5/1 : License Configuration : 72X60
--------------------------------------------
        Downstream Licenses : Installed : 72  Consumed : 0   Available : 72  Forced-Shut : 
0
        Upstream Licenses   : Installed : 60  Consumed : 0   Available : 60  Forced-Shut : 
0
Subslot 8/1 : License Configuration : 72X60
--------------------------------------------
        Downstream Licenses : Installed : 72  Consumed : 0   Available : 72  Forced-Shut : 
0
        Upstream Licenses   : Installed : 60  Consumed : 0   Available : 60  Forced-Shut : 
0

Upgrading the License When Line Card is in LCHA Mode


Note Upgrade the protect line card before upgrading the working line card. If the working line card is upgraded first, it leads to an error condition and the upgrade would be effective only for the number of downstream and upstream licenses effective on the protect line card.


If the Cisco uBR-MC3G0X60 line card is in the line card high availability (LCHA) mode, complete the following steps while upgrading:

1. Ensure that the working line card is active.

2. Install the license on the protect line card.

3. Verify the installed license by using the show license detail subslot command.

4. Verify the effective license by using the show running-config | include license command.

5. Install the license on the working line card.

6. Verify the installed license by using the show license detail subslot command.

7. Verify the effective license by using the show running-config | include license command.

8. Repeat step 5. through step 7. for each working line card to be upgraded.


Note For information about upgrading the license when the Cisco UBR-MC20X20V line card is in LCHA mode, refer to the Configuring the Cisco UBR-MC20X20V Cable Interface Line Card document.


Restrictions for Software License Activation on the Cisco CMTS Routers

The line card must be reloaded after activating the software license.

Always upgrade the protect line card's license first, before upgrading the working line card's license during the line card high availability issue.

If the N+1 line card redundancy is configured, and the protect line card is functional, the effective license on the working line card is artificially restricted to the effective license on the protect line card. To view the restricted effect of the license, use the show cable license command.

When the license is restricted, it is necessary to reload the working line card for the complete license upgrade to be effective.

If the N+1 line card redundancy is configured, and licenses on the line card are made effective such that the protect line card no longer has the superset of the licenses, the line card that boots up with the violating license effective, is marked non-functional. In this case, the line card redundancy is lost and further line card switchovers are blocked.


Note Unlike other line cards that must be reloaded, the Cisco uBR-MC3GX60V line card does not require a reload after activating the license.


Troubleshooting Licensing By Using Software Activation

This section provides troubleshooting tips and procedures that you can use while activating the licenses on the different line cards.

Scenario
Workaround

The license file from the SWIFT server is corrupted.

Ensure that the cable line card is in the minimum mode of operation.

The line card Bootflash disk is corrupted.

Ensure that the cable line card is in the minimum mode of operation.

The license storage partition space is full.

Run the license clear command to clear the storage space.

Quack Authentication Error

Ensure that the cable line card is in the normal mode of operation.

The no shut operation has failed.

Check the output of show cable license all and show license detail commands and ensure that the required licenses that are available.

The license file has expired and results in the downgrade of the line card.

Install the permanent license as soon as the warning messages are seen.


Additional References

These topics provide references related to the Software License Activation feature and the CMTS routers.

Related Documents

Document Title
URL

Cisco IOS Software Activation Configuration Guide

http://www.cisco.com/en/US/docs/ios-xml/ios/csa/configuration/15-0m/csa-15-0m-book.html

Cisco IOS Software Activation Command Reference

http://www.cisco.com/en/US/docs/ios-xml/ios/csa/command/csa-cr-book.html

Cisco IOS Software Activation Tasks and Commands

http://www.cisco.com/en/US/docs/ios/csa/configuration/guide/csa_commands.html

Introduction to Cisco Software Activation

http://www.cisco.com/assets/cdc_content_elements/flash/ios/csa/csa_softwareactivation.htm

Cisco IOS Commands for the Cisco CMTS Routers

http://www.cisco.com/en/US/docs/ios/cable/command/reference/cbl_book.html

Cisco IOS CMTS Cable Software Configuration Guide, Release 12.2SC

http://www.cisco.com/web/techdoc/cable/Config/Sw_conf.html


Standards

Standard
Title

CableLabs™ DOCSIS 1.1 specifications

http://www.cablelabs.com/cablemodem/

CableLabs™ PacketCable specifications

http://www.cablelabs.com/packetcable/

CableLabs™ PacketCable MultiMedia specifications

http://www.cablelabs.com/packetcable/specifications/multimedia.html


MIBs

MIB
MIBs Link

MIBs for the Cisco Cable Modem Termination System

Cisco CMTS Universal Broadband Series Router MIB Specifications Guide 12.2SC

http://www.cisco.com/en/US/docs/cable/cmts/mib/12_2sc/reference/guide/ubrmibv5.html

MIBs Supporting Cisco IOS

To locate and download MIBs for selected platforms, Cisco IOS releases, and feature sets, use Cisco MIB Locator found at the following URL:

http://www.cisco.com/go/mibs


Technical Assistance

Description
Link

The Cisco Support website provides extensive online resources, including documentation and tools for troubleshooting and resolving technical issues with Cisco products and technologies.

To receive security and technical information about your products, you can subscribe to various services, such as the Product Alert Tool (accessed from Field Notices), the Cisco Technical Services Newsletter, and Really Simple Syndication (RSS) Feeds.

Access to most tools on the Cisco Support website requires a Cisco.com user ID and password.

http://www.cisco.com/cisco/web/support/index.html