Table Of Contents
Configuring the Cisco IOS Software Activation Feature
Finding Feature Information in This Module
Restrictions for Cisco IOS Software Activation
Information About the Cisco IOS Software Activation
License Activation MIB Support
How to Activate Software from a Cisco IOS Device
Installing and Upgrading Licenses by Using Software Activation Commands
Managing Licenses by Using Software Activation Commands
Adding a Comment to a License File
Saving All Licenses to a Specified Storage Area
Saving License Credential Information Associated with a Device to a Specified Storage Area
Displaying All Licenses in a Device
Displaying Detailed Information about Licensed Features
Displaying Licensed Feature Sets Available in an Image
Removing Licenses by Using Software Activation Commands
Removing a License Entry from a Permanent License File
Rehosting (Revoking and Transferring) a License
Troubleshooting License Operations by Using Software Activation Commands
Configuring Examples for Software Licensing
Example: Installing and Upgrading Licenses
Example: Adding a Comment to a License File
Example: Saving All Licenses to a Specified Storage Area
Example: Rehosting (Revoking and Transferring) a License
Example: Generic Command Enhanced with Licensing Information
Feature Information for Cisco IOS Software Activation
Configuring the Cisco IOS Software Activation Feature
First Published: July 5, 2008Last Updated: June 7, 2010This document describes the tasks used to activate software by using the Cisco IOS Software Activation feature, license keys, and Cisco EXEC commands. When you activate software from a Cisco device, you can license software without the need for additional application software.
Finding Feature Information in This Module
Your software release might 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"Feature Information for Cisco IOS Software Activation" 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.
Contents
•
Restrictions for Cisco IOS Software Activation
•
Information About the Cisco IOS Software Activation
•
How to Activate Software from a Cisco IOS Device
•
Configuring Examples for Software Licensing
•
Feature Information for Cisco IOS Software Activation
Restrictions for Cisco IOS Software Activation
Not all Cisco router and switch platforms can use the Cisco IOS Software Activation feature. Use the Cisco Feature Navigator at http://www.cisco.com/go/cfn and the table in the "Feature Information for Cisco IOS Software Activation" section, to determine which platforms and images support the Cisco IOS Software Activation feature.
For the stackable switches that support the Cisco IOS Software Activation feature, one switch must act as primary and the others as secondaries. The primary switch performs management and administrative operations on itself as well as on the secondary switches.
Information About the Cisco IOS Software Activation
•
License Activation MIB Support
License Activation MIB Support
The Cisco IOS Software Activation feature introduces the CISCO-LICENSE-MGMT-MIB to allow SNMP-based license management and administrative tasks. A description of this MIB can be found by using tools at this URL: http://tools.cisco.com/ITDIT/MIBS/servlet/index
Use the MIB Locator tool and the Search for MIB selection box to select CISCO-LICENSE-MGMT-MIB.
The unique device identifier (UDI) is also associated with the Entity Name and Product Description data elements for the management information base (MIB) system. The MIB nomenclature for Entity Name is entPhysicalName and for Product Description is entPhysicalDescr.
How to Activate Software from a Cisco IOS Device
•
Installing and Upgrading Licenses by Using Software Activation Commands (required)
•
Managing Licenses by Using Software Activation Commands (optional)
•
Removing Licenses by Using Software Activation Commands (optional)
•
Troubleshooting License Operations by Using Software Activation Commands (optional)
Installing and Upgrading Licenses by Using Software Activation Commands
Use this task to install or upgrade a license by using the software activation commands.
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 cause it to be 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.
Prerequisites
Read and understand the concepts in the "License Activation Process" section of the Cisco IOS Software Activation Conceptual Overview module.
You can perform this task to install or upgrade a license by using the Cisco IOS 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 already backed up the license by using the Cisco IOS license save command).
Restrictions
The installation process does not install duplicate licenses. This message appears when duplicate licenses are detected:
Installing...Feature:xxx-xxx-xxx...Skipped:Duplicate
SUMMARY STEPS
1.
Obtain the product authorization key (PAK).
2.
enable
3.
show license udi
4.
Convert the PAK to a license by entering the PAK and the unique device identifier (UDI) into the Cisco Product License Registration portal: http://www.cisco.com/go/license.
5.
license install stored-location-url
6.
reload
DETAILED STEPS
Command or Action PurposeStep 1
Obtain the PAK.
The PAK is provided to you when you order or purchase the right to use a feature set for a particular platform.
•
The PAK serves as a receipt and is used as part of the process to obtain a license.
Step 2
enable
Example:Router> enable
Enables privileged EXEC mode.
•
Enter your password if prompted.
Step 3
show license udi
Example:Router# show license udi
Displays all the UDI values that can be licensed in a system.
•
You need the UDI of the device as part of the process to obtain a license.
Step 4
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.
After entering the appropriate information, you will receive an e-mail containing the license information that you can use to install the license:
•
Copy the license file received from the Cisco Product License Registration portal to the appropriate file system on the device.
or
•
Click the Install button on the web page.
Step 5
license install stored-location-url
Example:Router# license install tftp://infra-sun/<user>/license/5400/38a.lic
Installs the license.
•
Accept the end-user license agreement if prompted.
Step 6
reload
Example:Router# reload
(Optional) Restarts the device to enable the new feature set.
Managing Licenses by Using Software Activation Commands
•
Adding a Comment to a License File (optional)
•
Saving All Licenses to a Specified Storage Area (optional)
•
Saving License Credential Information Associated with a Device to a Specified Storage Area (optional)
•
Displaying All Licenses in a Device (optional)
•
Displaying Detailed Information about Licensed Features (optional)
•
Displaying Licensed Feature Sets Available in an Image (optional)
Adding a Comment to a License File
Perform this task to add comments to a license file.
SUMMARY STEPS
1.
enable
2.
license comment add feature-name comment (Cisco router and Catalyst 3560-E switch platforms)
or
license comment add feature-name comment switch switch-num (Cisco Catalyst 3750-E switch platforms)3.
show license file [switch switch-num]
DETAILED STEPS
Saving All Licenses to a Specified Storage Area
Perform this task to save copies of all licenses to a specified storage area. Saved licenses are restored by using the license install command.
SUMMARY STEPS
1.
enable
2.
license save file-sys://lic-location [switch switch-num]
DETAILED STEPS
Saving License Credential Information Associated with a Device to a Specified Storage Area
Perform this task to save license credential information associated with a device to a specified storage area.
Prerequisites
Before you can start the rehost or resend process, a device credential is required. Cisco IOS licensing requires that the license files generated by the Cisco back-end licensing system for its devices be secure and tamper-resistant. Security features are in place to authenticate a license by means of encrypted license credentials. If it becomes necessary to transfer a license from one device to another (which is called rehosting), a permission ticket is required. To generate the permission ticket, the Cisco back-end licensing system requires the device credential information.
SUMMARY STEPS
1.
enable
2.
license save credential file-sys://lic-location [switch switch-num]
DETAILED STEPS
Displaying All Licenses in a Device
Perform this task to display all licenses in a device.
SUMMARY STEPS
1.
enable
2.
show license all
DETAILED STEPS
Displaying Detailed Information about Licensed Features
Perform this task to display detailed information about licensed features.
SUMMARY STEPS
1.
enable
2.
show license detail [feature-name]
DETAILED STEPS
Displaying Licensed Feature Sets Available in an Image
Perform this task to display the licensed feature sets available in an image.
SUMMARY STEPS
1.
enable
2.
show license feature
DETAILED STEPS
Removing Licenses by Using Software Activation Commands
•
Removing a License Entry from a Permanent License File (optional)
•
Rehosting (Revoking and Transferring) a License (optional)
Removing a License Entry from a Permanent License File
Perform this task to remove a license entry from a permanent license file.
Restrictions
•
The license clear command lists 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 in 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.
•
When a switch is specified, the license clear command is issued on that switch. When a mixed stack platform is used, the primary switch must have installed the minimum licensing features required to support the licensing operations of the secondary switches. When this command is issued from a primary switch, the switch number is required to clear a license on that switch.
SUMMARY STEPS
1.
enable
2.
license clear feature-name
or
license clear feature-name switch switch-num (Cisco Catalyst 3750-E mixed stack switch and Cisco Catalyst 3560-E switch and switch stack platforms)3.
show license detail
DETAILED STEPS
Rehosting (Revoking and Transferring) a License
Perform this task to rehost (revoke and transfer) a license. The license revoke command removes the original, permanent license from the device and provides a license for the new device.
Prerequisites
Read and understand the concepts in the "License Transfer between Devices" section of the Cisco IOS Software Activation Conceptual Overview module.
Cisco IOS licensing requires that the license files generated by the Cisco back-end licensing system for its devices be secure and tamper-resistant. Security features are in place to authenticate a license by means of encrypted license credentials. Rehosting requires a permission ticket. To generate the permission ticket, the Cisco back-end licensing system requires the device credential information. Use the license save credential command to save device credential information to a specified file system.
SUMMARY STEPS
1.
enable
2.
license revoke permission-file-url output-rehost-ticket-url
DETAILED STEPS
Troubleshooting License Operations by Using Software Activation Commands
Perform this task to troubleshoot license operations.
SUMMARY STEPS
1.
enable
2.
show license file [switch switch-num]
3.
show license statistics
4.
show license status [switch switch-num]
5.
debug license {all | core | errors | events}
6.
no debug license {all | core | errors | events}
DETAILED STEPS
Configuring Examples for Software Licensing
•
Example: Installing and Upgrading Licenses
•
Example: Adding a Comment to a License File
•
Example: Saving All Licenses to a Specified Storage Area
•
Example: Rehosting (Revoking and Transferring) a License
•
Example: Generic Command Enhanced with Licensing Information
Example: Installing and Upgrading Licenses
The following example shows how to use the license install command to install a license saved in TFTP on the router. The display is truncated for easier readability:
Router# license install tftp://infra-sun/<user>/license/5400/38a.licInstalling licenses from "tftp://infra-sun/<user>/license/5400/38a.lic"Loading <user>/license/5400/38a.lic from 172.19.211.47 (via GigabitEthernet0/0): ![OK - 1192 bytes]Extension licenses are being installed in the device with UDI "AS54XM-AC-RPS:JAE0948QXKD" for the following features:Feature Name: gsmamrnb-codec-packPLEASE READ THE FOLLOWING TERMS CAREFULLY. . .ACCEPT? [yes/no]: yesIssue 'license feature gsmamrnb-codec-pack' command to enable the licenseInstalling...Feature:gsmamrnb-codec-pack...Successful:SupportedExample: Adding a Comment to a License File
The following example shows how to use the license comment command to add or delete information about a specific license. The command checks that a license associated with the specified feature is present in license storage. If a switch number is specified, this command is executed on the specified switch.
As the example shows, when the license is present and multiple license lines are stored, you are prompted to select a license line. This action helps to distinguish licenses. Type the number at the Select Index to Add Comment prompt to select the license.
Router# license comment add gsmamrnb-codec-pack "Use this permanent license"Feature: gsmamrnb-codec-pack1 License Type: EvaluationLicense State: InactiveEvaluation total period: 20 hours 0 minuteEvaluation period left: 20 hours 0 minuteLicense Addition: AdditiveComment:Store Index: 0Store Name: Primary License Storage2 License Type: PermanentLicense State: Active, Not in UseLicense Addition: ExclusiveComment:Store Index: 1Store Name: Primary License StorageSelect Index to Add Comment [1-2]: 2% Success: Adding comment "Use this permanent license" succeededRouter# show license fileLicense Store: Primary License StorageStore Index: 0License: 11 gsmamrnb-codec-pack 1.0 LONG TRIAL DISABLED 20 DISABLED STANDALONE ADD INFINITE_KEYS INFINITE_KEYS NEVER NEVER NiL SLM_CODE CL_ND_LCK NiL *1YCHJRBMWKZAED2400 NiL NiL NiL 5_MINS <UDI><PID>AS54XM-AC-RPS</PID><SN>JAE0948QXKD</SN></UDI> ,Jx8qaVf:iXWaH9PsXjkVnmz7gWh:cxdf9nUkzY6o8fRuQbu,7wTUz237Cz6g9VjfrCk,0a2Pdo,Ow6LWxcCRFL:xcTxwnffn9i,4,aUWv8rL50opDUdAsFnxLsvoFRkcAfm$<WLC>AQEBIQAB//9NA+1mUwfs/lD0dmdF9kyX8wDrua1TZhnnAy6Mxs1dTboIcRaahKxJJdj4Oi1w3wscqvPiAmWSaEmUT56rstk6gvmj+EQKRfD9A0ime1czrdKxfILT0LaXT416nwmfp92Tya6vIQ4FnlBdqJ1sMzXeSq8PmVcTU9A4o9hil9vKur8N9F885D9GVF0bJHciT5M=</WLC>Comment: Use this permanent license.Hash: E1WjIQo4qsl9g8cpnpoogP/0DeY=Router#Example: Saving All Licenses to a Specified Storage Area
The following example shows how to use the license save command to save copies of all licenses to the flash file system:
Router# license save flash:all_licenses.liclicense lines saved ..... to flash:all_licenses.licExample: Removing Licenses
The following examples shows how to use the license clear command to remove a license entry from license storage once it has been verified that the license line is valid and was explicitly installed.
You must select the index number of the license to clear. Type the number at the Select Index to Clear prompt as shown in this example.
Router# license clear standardFeature: standard1 License Type: EvaluationLicense State: InactiveEvaluation total period: 20 hours 0 minuteEvaluation period left: 20 hours 0 minuteLicense Addition: AdditiveComment:Store Index: 0Store Name: Primary License Storage2 License Type: PermanentLicense State: Active, Not in UseLicense Addition: ExclusiveComment:Store Index: 1Store Name: Primary License StorageSelect Index to Clear [1-2]: 1Are you sure you want to clear? (yes/[no]): yesRouter# show license detailFeature: premium Period left: 1 hour 0 minuteIndex: 1 Feature: premium Version: 1.0License Type: EvaluationLicense State: Active, Not in Use, EULA not acceptedEvaluation total period: 1 hour 0 minuteEvaluation period left: 1 hour 0 minuteLicense Count: Non-CountedLicense Priority: NoneStore Index: 0Store Name: Evaluation License StorageExample: Rehosting (Revoking and Transferring) a License
The following example shows how to use the license revoke command to revoke a license stored in TFTP and how to transfer it to a license stored in flash memory. You might need to read and accept the terms and conditions of the license type being transferred. The following example is truncated for readability:
Router# license revoke tftp://infra-sun/ramanp/pt.lic flash:rt.licFollowing Permanent license(s) will be revoked from this deviceFeature Name: gsmamrnb-codec-packFollowing Extension license(s) will be installed in this deviceFeature Name: gsmamrnb-codec-packPLEASE READ THE FOLLOWING TERMS CAREFULLY. . .ACCEPT? [yes/no]: yesIssue 'license feature gsmamrnb-codec-pack' command to enable the licenseRehost ticket saved ..... to flash:rt.licExample: Generic Command Enhanced with Licensing Information
The generic commands described in the following sections are enhanced with licensing information:
reload
The reload command shows the expired licenses, followed by expiring licenses sorted by the period left and end date:
Router# reloadThe following license(s) are expiring or have expired.Features with expired licenses may not work after Reload.Feature: uc,Status: expiring, Period Left: 7 wks 5 daysProceed with reload? [confirm]show running-config
The show running-config command displays the UDI of the device. If the configuration file was copied from a different device, a warning is displayed upon reload. A UDI mismatch warning is also displayed during reload if the startup-config file has a different UDI than the platform UDI.
Router# show running-configBuilding configuration...Current configuration : 4772 bytes!version 12.4no service padservice timestamps debug datetime msecservice timestamps log datetime msecno service password-encryptionservice internal!hostname csl-xfr-enhance-2951!......license udi pid CISCO2951 sn FHH1211P037license boot module c2951 technology-package securityk9 disablelicense boot module c2951 technology-package uclicense boot module c2951 technology-package datalicense call-home url https://tools-stage.cisco.com/SWIFT/Licensinglicense agent listener http plaintext /lic-agent authenticate none!!archivelog confighidekeys!...show tech-support
The show tech-support command displays the output of the show license udi, show license file, show license detail, show license status, and the show license statistics commands.
Router# show tech-support------------------ show license udi ------------------Device# PID SN UDI-----------------------------------------------------------------------------*0 CISCO2951 FHH1211P037 CISCO2951:FHH1211P037------------------ show license feature ------------------Feature name Enforcement Evaluation Subscription Enabledipbasek9 no no no nosecurityk9 yes yes no nouc yes yes no yesdata yes yes no nogatekeeper yes yes no noLI yes no no noSSL_VPN yes yes no noios-ips-update yes yes yes noSNASw yes yes no no------------------ show license file ------------------License Store: Primary License StorageLicense Store: Evaluation License StorageStore Index: 0License: 11 securityk9 1.0 LONG TRIAL DISABLED 1440 DISABLED STANDALONE ADD INFINITE_KEYS INFINITE_KEYS NEVER NEVER NiL SLM_CODE DEMO NiL NiL Ni NiL NiL 5_MINS NiL GT5YVbrMAdt0NY50UcKGfvLTjQ17P2o3g84hE8TqsOfu3Xph0N:2AmMdpMNxxKXSVG$<WLC>AQEBIQAB//+FugzZgqFJn/XhIxoyelg63YJD++i6Qx6vVp0MVqrX2EinbufbTfGzc7/GHNZaDZqRqwInXo3s+nsLU7rOtdOxoIxYZAo3LYmUJ+MFzsqlhKoJVlPyEvQ8H21MNUjVbhoN0gyIWsyiJaM8AQIkVBQFzhr10GYolVzdzfJfEPQIx6tZ++/Vtc/q3SF/5Ko8XCY=</WLC>Comment:Hash: CLWUVZgY84BMRTO3JIlYmIqwAQA=------------------ show license detail ------------------Index: 1 Feature: SNASw Version: 1.0License Type: EvaluationLicense State: Active, Not in Use, EULA not acceptedEvaluation total period: 8 weeks 4 daysEvaluation period left: 8 weeks 4 daysLock type: Non Node lockedVendor info:License Addition: AdditiveLicense Generation version: 0x8100000License Count: Non-CountedLicense Priority: NoneStore Index: 5Store Name: Evaluation License Storage------------------ show license status ------------------License Type Supportedpermanent Non-expiring node locked licenseextension Expiring node locked licenseevaluation Expiring non node locked licensepaid subscription Expiring node locked subscription licensewith valid end dateextension subscription Expiring node locked subscription licenseevaluation subscription Expiring node locked subscription license......------------------ show license statistics ------------------Administrative statisticsInstall success count: 0Install failure count: 0Install duplicate count: 0Comment add count: 0Comment delete count: 0Clear count: 0Save count: 0Save cred count: 1Client statisticsRequest success count: 1Request failure count: 3Release count: 0Global Notify count: 4show version
The show version command displays the license UDI information:
Router> show versionCisco IOS Software, C2951 Software (C2951-UNIVERSALK9-M), Experimental Version 12.4(20090326:052343)[rifu-xformers_3_25 130]Copyright (c) 1986-2009 by Cisco Systems, Inc.Compiled Thu 26-Mar-09 21:49 by rifuROM: System Bootstrap, Version 12.4(20090303:092436) [BLD-xformers_dev.XFR_20090303-20090303_0101-53107], DEVELOPMENT SOFTWAREcsl-xfr-enhance-2951 uptime is 3 days, 4 hours, 28 minutesSystem returned to ROM by reload at 18:48:45 PST Mon Nov 26 1956System image file is "flash0:c2951-universalk9-mz.SSA"Last reload reason: Reload Command......Cisco C2951 (revision 1.0) with 1005568K/43008K bytes of memory.Processor board ID FHH1211P0373 Gigabit Ethernet interfaces1 terminal line1 cisco Special Services Engine(s)DRAM configuration is 72 bits wide with parity enabled.255K bytes of non-volatile configuration memory.250880K bytes of ATA System CompactFlash 0 (Read/Write)License Info:License UDI:-------------------------------------------------Device# PID SN-------------------------------------------------*0 CISCO2951 FHH1211P037Technology Package License Information for Module:'c2951'----------------------------------------------------------------Technology Technology-package Technology-packageCurrent Type Next reboot-----------------------------------------------------------------ipbase ipbasek9 None ipbasek9security disable None disableuc uc Evaluation ucdata None None NoneConfiguration register is 0x0Additional References
Related Documents
Standards
MIBs
MIB MIBs LinkCISCO-LICENSE-MGMT-MIB
To locate and download MIBs for selected platforms, Cisco software releases, and feature sets, use Cisco MIB Locator found at the following URL:
RFCs
Technical Assistance
Feature Information for Cisco IOS Software Activation
Table 1 lists the features in this module and provides links to specific configuration information.
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 1 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.
Table 1 Feature Information for Cisco IOS Software Activation
Feature Name Releases Feature InformationCisco IOS Software Activation
12.4(15)XZ 12.4(20)T
15.0(1)MCisco IOS Software Activation EXEC commands support basic licensing processes.
This feature is platform-independent.
These sections provide information about this feature:
•
Installing and Upgrading Licenses by Using Software Activation Commands
•
Managing Licenses by Using Software Activation Commands
•
Removing Licenses by Using Software Activation Commands
•
Troubleshooting License Operations by Using Software Activation Commands
These commands were introduced or modified by this feature: debug license, license clear, license comment, license install, license revoke, license save, license save credential, show license all, show license detail, show license feature, show license file, show license statistics, show license status, show license udi.
CISL-SNMP support (MIB)
12.4(20)T
15.0(1)MSNMP support for the CISCO-LICENSE-MGMT-MIB was added.
The following sections provide information about this feature:
•
License Activation MIB Support
•
MIBs
These commands were introduced or modified by this feature: snmp-server enable traps, snmp-server host.
Cisco and the Cisco Logo are trademarks of Cisco Systems, Inc. and/or its affiliates in the U.S. and other countries. A listing of Cisco's trademarks can be found at 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. (1005R)
Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, network topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is unintentional and coincidental.
© 2008-2010 Cisco Systems, Inc. All rights reserved.