Table of Contents
Software licensing allows a product to ship with a base set of functionality enabled, while containing advanced functionality that can be offered without a change in the underlying hardware. Using executable licenses helps in preventing the illegal use of the advanced functions.
The Cisco Software License Activation feature contains a set of processes and license keys, and Cisco IOS commands used to activate Cisco IOS software feature sets by obtaining and validating fee-based Cisco software licenses. The Cisco RF Gateway 10 (RFGW-10) licenses are used to control access to the RF channels.
The Cisco RFGW-10 DS-384 line card supports QAM-capacity licensing where a partial QAM-capacity can be invested on the line card. There are two types of QAM-capacity licenses, downstream license for standard QAM channels (pilot QAM channels) and downstream span license (RF spanning license) for replicate QAM channels. The licensing feature on the Cisco RFGW-10 DS-384 line card also supports dual encryption features such as PowerKEY and Digital Video Broadcasting (DVB) scrambling that enable the customer to defer investing in QAM encryption until the entire network is ready for deployment.
Note Effective with Cisco IOS-XE Release 3.3.0SQ, PowerKEY license is supported on the Cisco RFGW-10 DS-384 line card. Effective with Cisco IOS-XE Release 3.4.0SQ, DVB license is supported on the Cisco RFGW-10 DS-384 line card. PowerKEY and DVB licenses cannot be used simultaneously on a Cisco RFGW-10 DS-384 line card.
The following sections describe the procedures to install, upgrade, and maintain licenses on the Cisco RFGW-10 DS-384 line card. This document also discusses platform-specific features such as Online insertion and Removal (OIR), license Return Merchandise Authorization (RMA), high-availability, and the implication of licensing on them.
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. To find information about the features documented in this module, and to see a list of the releases in which each feature is supported, see the “Understanding Cisco RFGW-10 Licensing” section.
Use Cisco Feature Navigator to find information about platform support and Cisco software image support. To access Cisco Feature Navigator, go to http://www.cisco.com/go/cfn . An account on Cisco.com is not required.
Note When you order a new Cisco RFGW-10 DS-384 Universal Edge QAM line card, it is shipped preinstalled with the software image and the corresponding permanent licenses for the packages and features. You do not need to activate or register the software before use.
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.
- Purchase the software package or feature you want to install. You will receive a product activation key (PAK) with your purchase.
- Register at Cisco.com if you do not have a cisco.com username and password.
- Understand the Cisco software licensing concepts detailed in the Cisco Software Activation Conceptual Overview chapter in Software Activation Configuration Guide, Cisco IOS XE Release 3S .
- Standard QAM downstream channel capacity
- Replicate QAM downstream channel capacity
- PowerKEY encryption license capability
- DVB scrambling license capability
The Cisco RFGW-10 DS-384 line card is a high-density line card that is installed in the Cisco RFGW-10 UEQAM. This card supports 1, 2, 4, 8, 12, and up to 128 QAM channels per port, and up to 384 downstream channels. The Cisco RFGW-10 DS-384 line card requires software licensing to enable appropriate number of QAM channels per card. It supports a maximum of 384 downstream channels through flexible QAM-capacity licensing.
Table 2 lists the different licenses available for the Cisco RFGW-10 DS-384 line card.
Quack is a tamper-proof chip that stores the serial number and product ID combined to form the universal device identifier (UDI). The UDI has two main components: the product ID (PID) and the serial number (SN). The UDI is printed on a label located on the back of most Cisco hardware devices. The show license udi command displays the UDIs for the line card.
Note The show license udi command is executed only from the line card console. For more information, see the “Installing and Upgrading Licenses using Software Activation Commands” section.
All license operations on the Cisco RFGW-10 DS-384 line card such as installing, rehosting, upgrading, and downgrading licenses are performed using the Cisco License Manager (CLM) or by using the Cisco IOS commands.
- license install —Installs the license on the line card.
- license clear —Invalidates the installed license on the line card.
- license comment—Adds or removes a comment about a feature license.
- license revoke —Revokes a software license from one device and transfers it to another.
- license save —Saves a copy of the permanent license to a specified license file.
- license save credentials —Saves the identity information associated with a device to a specified URL.
- license modify priority —Modifies a priority of a license.
- show license detail —Displays detailed information about the license.
- show license all —Displays information about all licenses available on the line card.
- show license feature —Displays a list of licensed features available in an image.
- show license statistics —Displays license statistics information.
- show license status —Displays the status of the license.
- show license udi —Displays all the UDI values that can be licensed in a system.
- rehost license —Revokes the license from the line card and issues a new node-locked license for another line card.
- upgrade license —Upgrades the licenses on the line card. New QAM licenses are enforced immediately.
- downgrade license —Downgrades the license on the line card.
- show cable licenses all | slot-id —Displays all the licenses configured on the Supervisor card.
- debug cable csl —Enables license related debug information.
For information on managing licenses using the software activation commands, see the Configuring the Cisco IOS Software Activation Feature chapter in the Software Activation Configuration Guide, Cisco IOS XE Release 3S , and see the Configuring the Cisco IOS Software Activation Feature .
The Cisco RFGW-10 DS-384 line card licensing feature provides flexible QAM capacity licensing. The number of downstream channels that can be licensed range from 0 to 384 QAM channels. When a Cisco RFGW-10 DS-384 line card is initially purchased, the card must be configured with a minimum of 64 QAM licenses. The RFGW-DS384-SP= which is used for sparing, is shipped with no licenses.
The licensing policy is enforced when a QAM channel is unshut ( rf-unshut operation). For replicate QAM channels, the license policy is enforced when the corresponding pilot QAM channel is unshut. The Supervisor card enforces the license only after validating that the number of unshut QAM channels in the running configuration with the license. Based on the license, the first n channels are unshut, and the rest are shutdown.
- The policy is applicable to QAM channels that are marked as administration no shut.
- A line card reload is not required for new QAM license upgrade to take effect.
- The show cable license command displays the forced shut channels. If the line card has feature licenses, such as PowerKEY or DVB, then appropriate encryptions can be enabled or disabled. Though the encryption can be enabled per channel, the license enforcement is per line card.
The QAM module generates the configurations based on the downstream ports defined by the maximum port density. When the system boots up for the first time, the maximum port density may be zero and the line cards may boot up with the licenses. The QAM configurations can be set using the cable downstream max-carriers command.
The rf-shutdown command changes the QAM channel state to RF-SHUT state. If a license is available, the no rf-shutdown command changes the QAM channel state to the NOT-SHUT state. If the license is unavailable, the no rf-shutdown command cannot be used. Licenses are not consumed if the QAM channel is in RF-SHUT or LIC-SHUT state. The RF-SHUT state represents a QAM channel that is manually shut using the rf-shutdown command. The LIC-SHUT state represents a QAM channel that is forced shut due to insufficient QAM license capacity.
The default channel state for each QAM channel is RF-SHUT. The channels with license configurations can be in NOT-SHUT state, and the remaining channels are in either the manual RF-SHUT state or forced LIC-SHUT state. Therefore, if 192 licenses exist on a line card with a maximum port density of 384 QAM channels, 192 channels are marked are in NOT-SHUT state, and the remaining192 channels are in the RF-SHUT state.
If a line card boots up with too few licenses available to support the QAM channels configured with the no rf-shutdown command, only the licensed channels remain in NOT-SHUT state. The state of non-licensed channels changes to LIC-SHUT state.
When there is a maximum port density change, the enforcement policy ensures that the new downstream configuration reflects the current port density, and the license state is synchronized with the new configuration.
Table 3 shows an example where the maximum port density configuration for a QAM license count of 192 licenses is set to a maximum port density for 48 channels per port on a line card.
If all 128 channels are configured on the second, third and fourth port on the line card, the maximum port density should be set accordingly (see Table 4).
The rf-shutdown command can be used to shut down the desired licensed channels on the line card. Whenever a channel is manually shut, the channel state changes to RF-SHUT and the available license count increments. The no rf-shutdown command can be used if the available license count is greater than zero.
Upgrade licenses increase the QAM channel availability on the line card. For example, consider Table 4 where you have the 192 QAM license are installed and the licenses are configured on second, third, and fourth QAM ports.
Table 5 lists the maximum port density of 128 channels with a 32 upgrade QAM license.
An OIR or RMA of a line card may result in a license downgrade. Consider an example, where OIR is performed on the (192+32 licenses) line card and the replacement line card has only a 96 QAM upgrade license. When the line card boots, the maximum port density and the status of the line card is checked. The channels that are marked NOT-SHUT are checked and 96 licenses are used on these channels.The other NOT-SHUT channels are marked LIC-SHUT. The channels marked LIC-SHUT require to be shut down due to lack of licenses.
Table 6 lists the above scenario of a license downgrade.
During a line card RMA, the faulty line card is replaced with another line card. The new line card boots up with zero downstream license count, which may not be the original license count on the line card. The original license count and configuration is restored after the line card is returned from repair.
RF spanning license is used for the replicate QAM channels. Pilot QAM channels use the downstream QAM license. For replicate QAM channels, the license policy is enforced when the corresponding pilot QAM channel is unshut.
In the Cisco RFGW-10, encryption is applied on a line card, and the communication that occurs between the remote server and the Supervisor recognizes the messages on the line card. So, every time a line card boots up or whenever there is an encryption license change event, a discovery message is sent to the server from the Supervisor.
Effective with Cisco IOS-XE Release 3.3.0SQ, PowerKEY license is supported on the Cisco RFGW-10 DS-384 line card. Effective with Cisco IOS-XE Release 3.4.0SQ, DVB license is supported on the Cisco RFGW-10 DS-384 line card.
The Minimum mode or M mode refers to the state where no valid licenses are available. The Cisco RFGW-10 DS-384 line card is always shipped with preinstalled licenses purchased with the order. The Minimum mode (besides the normal mode) is used to install a license for a new line card and perform any license operations when an error occurs due to non-availability of licenses.
When line card redundancy is configured on the Cisco RFGW-10 DS-384 line cards, the secondary line card has a superset of the licenses of the primary line card. The line cards (primary or secondary), are added to the redundancy configuration group if they obey the licensing count policy.
A secondary line card is not allowed to join the group if the (superset) policy is violated. A primary line card with a higher count than the secondary line card is allowed to join the group only with a count equal to the secondary line card. When the secondary is upgraded with a count equal to or greater than the primary line card, the primary line card is automatically allowed to use all the available licenses.
- 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 where 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.
The Cisco RFGW-10 support fully automated, customer-initiated, transfer of licenses. Licenses can be transferred using 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.
Figure 1 shows the processes involved for rehosting (transferring) a license.
1. Obtain the UDI and device credentials from the source and destination devices using the Cisco IOS-XE commands. For more information, see the Configuring the Cisco IOS Software Activation Feature module.
4. Apply the permissions ticket to the source device by using the license revoke command as described in the Configuring the Cisco IOS Software Activation Feature 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.
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 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 2 shows the RMA replacement license process.
- If the line card is not part of the line card high availability (LCHA), follow the steps in Upgrading the License.
- If the line card is part of the LCHA and the RMA is for the secondary line card, follow the steps listed in the Troubleshooting Licensing.
- If the RMA is for the primary line card, the service automatically switches over to the secondary line card. To verify this:
– Upgrade the primary line card. For more information, see the “Reloading the Cisco RFGW-10 DS-384 Line Card” section.
- Installing Licenses Using the Cisco License Manager
- Registering Licenses Using the Product License Registration Portal and CLI
The 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.
Step 1 Log in to CLM by clicking the Cisco License Manager Client icon on your desktop or select the Cisco License Manager Server.exe or Cisco License Manager Client.exe file. The Login window appears.
Step 4 Select an existing device group folder or create a new folder where you want to add a new device. Make sure you select a folder that so that you can easily locate so that you can and retrieve device and license information at a later date.
Step 3 Convert the PAK to a license by entering the appropriate information at the following URL:
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 option appears on the screen. Select this option to download the license or use the license details provided in the e-mail sent to the customer.
Figure 3 shows the process for registering a license using the Product License Registration Portal.
The Cisco RFGW-10 DS-384 line card does not require a reload for a new license upgrade or downgrade. However, if there are no licenses on the Cisco RFGW-10 DS-384 line card except the image in-built evaluation license, then to make that evaluation license effective, you must reload the line card.
- The line card must be reloaded after activating the software license.
- Upgrade the secondary line card’s license before upgrading the primary line card’s license during the line card high availability issue.
- If the N+1 line card redundancy is configured, a secondary line card is not allowed to join the group if the (superset) policy is violated. A primary line card with a higher count than the secondary line card is allowed to join the group, only with a count equal to the secondary line card. When the secondary line card is upgraded with a count equal to or greater than the primary line card, the primary line card is automatically allowed to use all the available licenses. To view the restricted effect of the license, use the show cable license command.
- When the license is restricted, reload the primary line card for a complete license upgrade.
- If the N+1 line card redundancy is configured, and licenses on the line card are made effective such that the secondary 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.
- There are no effective licenses available. This requires a reload.
- The available licenses are of a lower value. This does not require a reload.
Perform the following to upgrade the licenses on the Cisco RFGW-10. Table 2 lists the licenses available for upgrade.
Step 3 Select the SKU and enter the UDI, which is 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.
Step 4 Install the license file returned from the license portal by using Cisco IOS-XE 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.
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 .
- Understand the licensing concepts in the “Licensing on Cisco RFGW-10” section.
- To install or upgrade a license using the license install command, you must have already received the license file from the Cisco Product License Registration portal at http://www.cisco.com/go/license (or you have a back up of the license using the license save command).
Convert the PAK to a license by entering the PAK and the UDI into the Cisco Product License Registration portal: http://www.cisco.com/go/license .
Note Upgrade the secondary line card before upgrading the primary line card. If the primary line card is upgraded first, it leads to an error condition and the upgrade would be effective only for the number of downstream licenses effective on the secondary line card.
The license clear command clears all licenses, but some licenses such as built-in licenses cannot be cleared. Only licenses that have been added by using the license install command are removed. Evaluation licenses are not removed.
If a license is not in use, the license clear command displays all the licenses related to this feature and prompts you to make a selection. Different prompts are displayed, depending upon whether single or multiple licenses are available on the device. The selected licenses are removed from the router or switch. If a license is in use, the license clear command might fail. However, depending on the application policy using the license, some licenses might be cleared.
For information on removing licenses from permanent license files, see the Removing Licenses by Using Software Activation Commands in the Software Activation Configuration Guide, Cisco IOS XE Release 3S , and also see Configuring the Cisco IOS Software Activation Feature .
Use the license revoke command to revoke or transfer licenses between two devices. For information on revoking or transferring licenses, see the Removing Licenses by Using Software Activation Commands in Software Activation Configuration Guide, Cisco IOS XE Release 3S , and also see Configuring the Cisco IOS Software Activation Feature .
Reinstall the license file from Cisco.com or the SWIFT server.
Reload the line card and reinstall the license file from Cisco.com.
Use Cisco Feature Navigator to find information about platform support and software image support. Cisco Feature Navigator enables you to determine which software images support a specific software release, feature set, or platform. To access Cisco Feature Navigator, go to http://www.cisco.com/go/cfn . An account on Cisco.com is not required.
Note Table 7 lists only the software release that introduced support for a given feature in a given software release train. Unless noted otherwise, subsequent releases of that software release train also support that feature.
Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: www.cisco.com/go/trademarks. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (1110R)
Any Internet Protocol (IP) addresses used in this document are not intended to be actual addresses. Any examples, command display output, and figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses in illustrative content is unintentional and coincidental.