The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
Contents
This 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.
Your software release may not support all the features documented in this module. For the latest caveats and feature information, see Bug Search Tool and 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 table at the end of this module.
Use Cisco Feature Navigator to find information about platform support and Cisco software image support. To access Cisco Feature Navigator, go to www.cisco.com/go/cfn. An account on Cisco.com is not required.
Not all Cisco hardware 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.
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.
Read and understand the license activation process concepts in the in the “Cisco IOS Software Activation Conceptual Overview” module.
To install or upgrade a license by 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 already backed up the license by using the license save command).
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.
Note | The installation process does not install duplicate licenses. This message appears when duplicate licenses are detected: Installing...Feature:xxx-xxx-xxx...Skipped:Duplicate |
Note | A standby device reboots twice when there is a mismatch of licenses. |
1. Obtain the PAK.
2.
enable
3.
show license udi
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.
5.
license install
stored-location-url
6.
configure terminal
7.
license boot level {metroaggrservices}
8.
write memory
9.
reload
Command or Action | Purpose | |||
---|---|---|---|---|
Step 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. | ||
Step 2 |
enable
Example: Device> enable |
Enables privileged EXEC mode. | ||
Step 3 |
show license udi
Example: Device# show license udi |
Displays all the UDI values that can be licensed in a system. | ||
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:
or | ||
Step 5 |
license install
stored-location-url
Example: Device# license install tftp://infra-sun/<user>/license/5400/38a.lic |
Installs the license. | ||
Step 6 |
configure terminal
Example: Device# configure terminal |
Enters the global configuration mode. | ||
Step 7 |
license boot level {metroaggrservices}
Example: Device(config)# license boot level metroaggrservices | Activates the metroaggrservices license on the device upon the next reload. | ||
Step 8 |
write memory
Example: Device# write memory |
Saves the running configuration to NVRAM. | ||
Step 9 |
reload
Example: Device# reload |
(Optional) Restarts the device to enable the new feature set.
|
1.
enable
2.
license comment add
feature-name comment [switch
switch-num]
3.
show license file [switch
switch-num]
1.
enable
2.
license save
file-sys://lic-location [switch
switch-num]
Before you can start the rehost or resend process, a device credential is required. Cisco software 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.
1.
enable
2.
license save credential
file-sys://lic-location [switch
switch-num]
Command or Action | Purpose |
---|
1.
enable
2.
show license all
Command or Action | Purpose |
---|
1.
enable
2.
show license detail [feature-name]
Command or Action | Purpose |
---|
1.
enable
2.
show license feature
Command or Action | Purpose |
---|
1.
enable
2.
license clear
feature-name [switch
switch-num]
3.
show license detail
Read and understand the license transfer between devices concepts in the “Cisco IOS Software Activation Conceptual Overview” module.
Cisco software 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.
1.
enable
2.
license revoke
revoke
permission-file-url output-rehost-ticket-url
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}
The following example shows how to use the license install command to install a license saved in TFTP on the device. The display is truncated for easier readability:
Device# license install tftp://infra-sun/<user>/license/5400/38a.lic Installing 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-pack PLEASE READ THE FOLLOWING TERMS CAREFULLY. . . ACCEPT? [yes/no]: yes Issue 'license feature gsmamrnb-codec-pack' command to enable the license Installing...Feature:gsmamrnb-codec-pack...Successful:Supported
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.
Device# license comment add gsmamrnb-codec-pack “Use this permanent license” Feature: gsmamrnb-codec-pack 1 License Type: Evaluation License State: Inactive Evaluation total period: 20 hours 0 minute Evaluation period left: 20 hours 0 minute License Addition: Additive Comment: Store Index: 0 Store Name: Primary License Storage 2 License Type: Permanent License State: Active, Not in Use License Addition: Exclusive Comment: Store Index: 1 Store Name: Primary License Storage Select Index to Add Comment [1-2]: 2 % Success: Adding comment "Use this permanent license" succeeded Device# show license file License Store: Primary License Storage Store Index: 0 License: 11 gsmamrnb-codec-pack 1.0 LONG TRIAL DISABLED 20 DISABLED STANDA LONE ADD INFINITE_KEYS INFINITE_KEYS NEVER NEVER NiL SLM_CODE CL_ ND_LCK NiL *1YCHJRBMWKZAED2400 NiL NiL NiL 5_MINS <UDI><PID>AS54X M-AC-RPS</PID><SN>JAE0948QXKD</SN></UDI> ,Jx8qaVf:iXWaH9PsXjkVnmz 7gWh:cxdf9nUkzY6o8fRuQbu,7wTUz237Cz6g9VjfrCk,0a2Pdo,Ow6LWxcCRFL:x cTxwnffn9i,4,aUWv8rL50opDUdAsFnxLsvoFRkcAfm$<WLC>AQEBIQAB//9NA+1m Uwfs/lD0dmdF9kyX8wDrua1TZhnnAy6Mxs1dTboIcRaahKxJJdj4Oi1w3wscqvPiA mWSaEmUT56rstk6gvmj+EQKRfD9A0ime1czrdKxfILT0LaXT416nwmfp92Tya6vIQ 4FnlBdqJ1sMzXeSq8PmVcTU9A4o9hil9vKur8N9F885D9GVF0bJHciT5M=</WLC> Comment: Use this permanent license. Hash: E1WjIQo4qsl9g8cpnpoogP/0DeY= Device#
The following example shows how to use the license save command to save copies of all licenses to the flash file system:
Device# license save flash:all_licenses.lic license lines saved ..... to flash:all_licenses.lic
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.
Device# license clear standard Feature: standard 1 License Type: Evaluation License State: Inactive Evaluation total period: 20 hours 0 minute Evaluation period left: 20 hours 0 minute License Addition: Additive Comment: Store Index: 0 Store Name: Primary License Storage 2 License Type: Permanent License State: Active, Not in Use License Addition: Exclusive Comment: Store Index: 1 Store Name: Primary License Storage Select Index to Clear [1-2]: 1 Are you sure you want to clear? (yes/[no]): yes Device# show license detail Feature: premium Period left: 1 hour 0 minute Index: 1 Feature: premium Version: 1.0 License Type: Evaluation License State: Active, Not in Use, EULA not accepted Evaluation total period: 1 hour 0 minute Evaluation period left: 1 hour 0 minute License Count: Non-Counted License Priority: None Store Index: 0 Store Name: Evaluation License Storage
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:
Device# license revoke tftp://infra-sun/ramanp/pt.lic flash:rt.lic Following Permanent license(s) will be revoked from this device Feature Name: gsmamrnb-codec-pack Following Extension license(s) will be installed in this device Feature Name: gsmamrnb-codec-pack PLEASE READ THE FOLLOWING TERMS CAREFULLY. . . ACCEPT? [yes/no]: yes Issue 'license feature gsmamrnb-codec-pack' command to enable the license Rehost ticket saved ..... to flash:rt.lic
The generic commands described in the following sections are enhanced with licensing information:
The reload command shows the expired licenses, followed by expiring licenses sorted by the period left and end date:
Device# reload The 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 days Proceed with reload? [confirm]
The show running-config command displays the unique device identifier (UDI) of a 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.
Device# show running-config Building configuration... Current configuration : 4772 bytes ! version 12.4 no service pad service timestamps debug datetime msec service timestamps log datetime msec no service password-encryption service internal ! hostname csl-xfr-enhance-2951 ! ... ... license udi pid CISCO2951 sn FHH1211P037 license boot module c2951 technology-package securityk9 disable license boot module c2951 technology-package uc license boot module c2951 technology-package data license call-home url https://tools-stage.cisco.com/SWIFT/Licensing license agent listener http plaintext /lic-agent authenticate none ! ! archive log config hidekeys ! . . .
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.
Device# show tech-support ------------------ show license udi ------------------ Device# PID SN UDI ----------------------------------------------------------------------------- *0 CISCO2951 FHH1211P037 CISCO2951:FHH1211P037 ------------------ show license feature ------------------ Feature name Enforcement Evaluation Subscription Enabled ipbasek9 no no no no securityk9 yes yes no no uc yes yes no yes data yes yes no no gatekeeper yes yes no no LI yes no no no SSL_VPN yes yes no no ios-ips-update yes yes yes no SNASw yes yes no no ------------------ show license file ------------------ License Store: Primary License Storage License Store: Evaluation License Storage Store Index: 0 License: 11 securityk9 1.0 LONG TRIAL DISABLED 1440 DISABLED STANDALONE AD D INFINITE_KEYS INFINITE_KEYS NEVER NEVER NiL SLM_CODE DEMO NiL N iL Ni NiL NiL 5_MINS NiL GT5YVbrMAdt0NY50UcKGfvLTjQ17P2o3g84hE8Tq sOfu3Xph0N:2AmMdpMNxxKXSVG$<WLC>AQEBIQAB//+FugzZgqFJn/XhIxoyelg63 YJD++i6Qx6vVp0MVqrX2EinbufbTfGzc7/GHNZaDZqRqwInXo3s+nsLU7rOtdOxoI xYZAo3LYmUJ+MFzsqlhKoJVlPyEvQ8H21MNUjVbhoN0gyIWsyiJaM8AQIkVBQFzhr 10GYolVzdzfJfEPQIx6tZ++/Vtc/q3SF/5Ko8XCY=</WLC> Comment: Hash: CLWUVZgY84BMRTO3JIlYmIqwAQA= ------------------ show license detail ------------------ Index: 1 Feature: SNASw Version: 1.0 License Type: Evaluation License State: Active, Not in Use, EULA not accepted Evaluation total period: 8 weeks 4 days Evaluation period left: 8 weeks 4 days Lock type: Non Node locked Vendor info: License Addition: Additive License Generation version: 0x8100000 License Count: Non-Counted License Priority: None Store Index: 5 Store Name: Evaluation License Storage ------------------ show license status ------------------ License Type Supported permanent Non-expiring node locked license extension Expiring node locked license evaluation Expiring non node locked license paid subscription Expiring node locked subscription license with valid end date extension subscription Expiring node locked subscription license evaluation subscription Expiring node locked subscription license ... ... ------------------ show license statistics ------------------ Administrative statistics Install success count: 0 Install failure count: 0 Install duplicate count: 0 Comment add count: 0 Comment delete count: 0 Clear count: 0 Save count: 0 Save cred count: 1 Client statistics Request success count: 1 Request failure count: 3 Release count: 0 Global Notify count: 4
The show version command displays the license UDI information:
Device> show version Cisco 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 rifu ROM: System Bootstrap, Version 12.4(20090303:092436) [BLD-xformers_dev.XFR_20090303-20090303_0101-53 107], DEVELOPMENT SOFTWARE csl-xfr-enhance-2951 uptime is 3 days, 4 hours, 28 minutes System returned to ROM by reload at 18:48:45 PST Mon Nov 26 1956 System 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 FHH1211P037 3 Gigabit Ethernet interfaces 1 terminal line 1 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 FHH1211P037 Technology Package License Information for Module:'c2951' ---------------------------------------------------------------- Technology Technology-package Technology-package Current Type Next reboot ----------------------------------------------------------------- ipbase ipbasek9 None ipbasek9 security disable None disable uc uc Evaluation uc data None None None Configuration register is 0x0
Related Topic |
Document Title |
---|---|
Cisco License Manager application |
User Guide for Cisco License Manager |
Software activation conceptual overview |
“Cisco IOS Software Activation Conceptual Overview” module |
Software activation commands |
Software Activation Command Reference |
Cisco IOS commands |
|
Integrated Services Routers licensing |
Software Activation on Cisco Integrated Services Routers |
MIB |
MIBs Link |
---|---|
CISCO-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: |
Description |
Link |
---|---|
The Cisco Support and Documentation website provides online resources to download documentation, software, and tools. Use these resources to install and configure the software and to troubleshoot and resolve technical issues with Cisco products and technologies. Access to most tools on the Cisco Support and Documentation website requires a Cisco.com user ID and password. |
The following table provides release information about the feature or features described in this module. This table 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.
Use Cisco Feature Navigator to find information about platform support and Cisco software image support. To access Cisco Feature Navigator, go to www.cisco.com/go/cfn. An account on Cisco.com is not required.
Feature Name |
Releases |
Feature Information |
---|---|---|
Cisco IOS Software Activation |
12.4(15)XZ 12.4(20)T 15.0(1)M 15.4(1)S |
Cisco IOS Software Activation EXEC commands support basic licensing processes. This feature is platform-independent. 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 In Cisco IOS Release 15.4(1)S, support was added for the Cisco ASR 901S series router. |
CISL-SNMP support (MIB) |
12.4(20)T 15.0(1)M |
SNMP support for the CISCO-LICENSE-MGMT-MIB was added. These commands were introduced or modified by this feature: snmp-server enable traps, snmp-server host |