Table Of Contents
Feature Information for Cisco IOS Software Licensing
Cisco IOS Software Licensing
First Published: January 31, 2007Last Updated: February 12, 2007This document describes command-line interface (CLI) commands for managing Cisco IOS software licenses on Cisco Catalyst 3560-E and 3750-E switches.
Finding Feature Information in This Module
Your Cisco IOS software release may not support all of the features documented in this module. To reach links to specific feature documentation in this module and to see a list of the releases in which each feature is supported, use the "Feature Information for Cisco IOS Software Licensing" section.
Finding Support Information for Platforms and Cisco IOS and Catalyst OS Software Images
Use Cisco Feature Navigator to find information about platform support and Cisco IOS and Catalyst OS 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
•Feature Information for Cisco IOS Software Licensing
Additional References
The following sections provide references related to Cisco IOS Software Licensing.
Related Documents
MIBs
Technical Assistance
Command Reference
This section documents only commands that are new or modified.
debug license
To enable controlled Cisco IOS software license debugging activity on a device, use the debug license command in privileged EXEC mode.
debug license {agent {all | error} | core {all | error | event} | errors | events | ipc}
Syntax Description
Command Default
Debugging activity does not occur.
Command Modes
Privileged EXEC
Command History
Usage Guidelines
Use this command to help troubleshoot issues with licenses on a device.
Examples
The following example shows how to enable debugging for license warnings and errors on a router:
Router# debug license errorsThe following example shows how to enable debugging for all license agent information on a switch:
Switch# debug license agent alllicense agent app https[0x43FBC7C]: urlhook functionlicense agent app https[0x43FBC7C]: https action functionLIC_AGENT:Processing XML message<?xml version="1.0" encoding="UTF-8"?><SOAP:Envelope xmlns:SOAP="http://www.w3.org/2003/05/soap-envelope"><SOAP:Header><clm:Header version="1.0" xmlns:clm="http://www.cisco.com/clm"><clm:Time>2003-04-23T20:27:19.827Z</clm:Time></clm:Header></SOAP:Header><SOAP:Body><lica:request xmlns:lica="http://www.cisco.com/clm"><lica:installRequest><lica:license encoding="BASE64">PENJU0NPX1dUX0FSVElGQUNUUyB2ZXJzaW9uPSIxLjAiPjxDSVNDT19XVF9MSUNFTlNFIHZlcnNpb249IjEuMCI+PEZFQVRVUkVfTkFNRT5pcGJhc2U8L0ZFQVRVUkVfTkFNRT48RkVBVFVSRV9WRVJTSU9OPjEuMDwvRkVBVFVSRV9WRVJTSU9OPjxVREk+PFBJRD5CVUxMU0VZRTI0PC9QSUQ+PFNOPkNBVDEwMDZSMEU4PC9TTj48L1VEST48U09VUkNFPkNpc2NvIEhRPC9TT1VSQ0U+PENSRUFURV9EQVRFPjIwMDYtMTEtMjJUMDA6MzM6NTA8L0NSRUFURV9EQVRFPjxMSUNFTlNFX0xJTkVfSEFTSCBoYXNoQWxnbz0iU0hBMSI+NDJiNFVWWFpOd3pJK0ZNdEV6QlNZSDRWdzFFPTwvTElDRU5TRV9MSU5FX0hBU0g+PFRZUEU+UkVHVUxBUjwvVFlQRT48TElDRU5TRV9MSU5FPjwhW0NEQVRBWzExIGlwYmFzZSAxLjAgTE9ORyBOT1JNQUwgU1RBTkRBTE9ORSBFWENMIElORklOSVRFX0tFWVMgSU5GSU5JVEVfS0VZUyBORVZFUiBORVZFUiBOaUwgU0xNX0NPREUgQ0xfTkRfTENLIE5pTCAqMVZBUlY5WlJESzREOU5UNDAwIE5pTCBOaUwgTmlMIDVfTUlOUyA8VURJPjxQSUQ+QlVMTFNFWUUyNDwvUElEPjxTTj5DQVQxMDA2UjBFODwvU04+PC9VREk+IGUxWW8wS1U2VnJLOnBJZXRib1dJVkEyZlVaVGdieUlEaklHWERRVXc3dkxOYWlXRzZ0dUJOMG5lTXpKaHpzQ2tMN1l3TWFxS2paem05YW5FbVJHUUVPTHlDdmRVZkswQmNLN0pPcnZsUkw0VjMyJDxXTEM+QVFFQklRQUIvLy9GbS8vWDkybThNb0NOZkVMSHJiVzRjWDFMZGNpdDNMVU5GWlV1OWppT0phcXB5Q2N6TTFpaUlKbVE3NEd5WHJFY3F2UGlBbVdTYUVtVVQ1NnJzdGs2Z3ZtaitFUUtSZkQ5QTBpbWUxY3pyZEt4ZklMVDBMYVhUNDE2bndtZnA5MlR5YTZ2SVE0Rm5sQmRxSjFzTXpYZVNxOFBtVmNUVTlBNG85aGlsOXZLdXI4TjlGODg1RDlHVkYwYkpIY2lUNU09PC9XTEM+XV0+PC9MSUNFTlNFX0xJTkU+PFVTRVJfTU9ESUZJQUJMRV9DT01NRU5UIGZpZWxkUmVzdHJpY3Rpb25zPSJNYXggOTkgQVNDSUkgY2hhcmFjdGVycyBpbiBsZW5ndGguIj48L1VTRVJfTU9ESUZJQUJMRV9DT01NRU5UPjwvQ0lTQ09fV1RfTElDRU5TRT48L0NJU0NPX1dUX0FSVElGQUNUUz4=</lica:license></lica:installRequest></lica:request></SOAP:Body></SOAP:Envelope>LIC_AGENT: XML received opcode(1)LIC_AGENT: License ipbase%IOS_LICENSE_IMAGE_APPLICATION-6-LICENSE_LEVEL: Next reboot level = ipbase and License = ipbaseLIC_AGENT: Notification Event type = 1 License InstalledLIC_AGENT: Notification Event type = 13 License Annotate
license clear
To remove a license entry from license storage, use the license clear command in privileged EXEC mode. This command does not have a no form.
Cisco Router Platforms
license clear feature-name
Cisco Catalyst 3560-E Switch Platforms
license clear feature-name
Cisco Catalyst 3750-E Switch and Switch Stack Platforms
license clear feature-name [switch switch-num]
Cisco Catalyst 3750-E Switch Mixed Stack Platforms
license clear feature-name switch switch-num
Syntax Description
Command Default
Licenses are not removed.
Command Modes
Privileged EXEC
Command History
Usage Guidelines
The license clear command verifies that the license line is valid and explicitly installed. Only explicit licenses that have been added using the license install command are removed. Implicit evaluation licenses are not removed.
When a switch is specified, the license clear command is executed only on that switch. When a mixed stack platform is used, the master switch has installed the minimum licensing feature needed to support the licensing operations of the slave switches. The license clear command is used to clear a license from license storage, which a master switch does not have. When the command is issued from the master switch, the switch number is required to clear a license on a specific switch.
If a license line is in use, the license clear command fails. For image-based licensing, the infrastructure has a dedicated callback to check in the license, so the clear command could succeed. In this case, after the license is cleared, error messages indicate that the device is running without a valid license. This option is not available for feature licenses.
Examples
The following example shows how to clear a license associated with feature12:
Router# license clear feature12
The following example shows how to clear a license associated with feature12 on switch 9:
Switch# license clear feature12 switch 9
license comment
To add or remove a comment about a feature license, use the license comment command in privileged EXEC mode. This command does not have a no form.
Cisco Router Platforms
license comment {add feature-name comment | delete}
Cisco Catalyst 3560-E Switch Platforms
license comment {add feature-name comment | delete}
Cisco Catalyst 3750-E Switch Platforms
license comment {add feature-name comment switch switch-num | delete}
Syntax Description
Command Default
Comments are not added or deleted.
Command Modes
Privileged EXEC
Command History
Usage Guidelines
This command checks if a license associated with the specified feature is present in license storage. If a license is present and multiple license lines are stored, you are prompted to select a license line. If a comment exists in the license line, the comment is displayed before you are prompted to delete a comment or enter a new one.
This command is useful for both tracking a license when multiple licenses are stored on a device and for clarifying or adding information about a specific license.
Related Commands
license install
To install a license stored in a license file, use the license install command in privileged EXEC mode. This command does not have a no form.
license install file-sys:file-sys://lic-location
Syntax Description
Command Default
A license is not installed.
Command Modes
Privleged EXEC
Command History
Usage Guidelines
When a license is successfully installed, an informational message is displayed. This message states that the license installation is successful and says whether or not the licensed feature is present in the current image.
Examples
The following example shows how to install a license named test.lic from a flash file system:
Switch# license install flash:flash//test.lic
Related Commands
Command Descriptionlicense comment
Adds or removes a comment about a feature license.
license clear
Removes a license entry from a permanent license file.
license save
To save a copy of a permanent license in a Cisco IOS device to a specified license file, use the license save command in privileged EXEC mode. This command does not have a no form.
license save file-sys:file-sys://lic-location
Syntax Description
Command Default
Licenses are not saved.
Command Modes
Privileged EXEC
Command History
Usage Guidelines
Issuing this command stores the license line and comment in Extensible Markup Language (XML) format as required by the command. Issuing this command saves copies of all permanent licenses.
Saved licenses may be restored using the license install command.
Examples
The following example shows how to save a license named feat1.lic in the FTP file system:
Router# license save ftp:feat1.lic
Related Commands
Command Descriptionlicense install
Installs a license stored in a license file on a device.
license save credential
Saves the identity information associated with a license to a specified URL.
license save credential
To save the identity information associated with a device to a specified URL, use the license save credential command in privileged EXEC mode. This command does not have a no form.
license save credential file-sys:file-sys://lic-location
Syntax Description
Command Default
License credentials are not saved.
Command Modes
Privileged EXEC
Command History
Usage Guidelines
Use this command to save credential information about a device.
Examples
The following example shows how to save identity information about a license named feat1.lic in the http file system:
Switch# license save credential http:feat1.lic
The following example shows how to save identity information about a license named feat2.lic in the scp file system:
Router# license save credential scp:feat2.lic
Related Commands
Command Descriptionlicense install
Installs a license stored in a license file on a device.
license save
Saves a copy of a permanent license in a Cisco IOS device to a specified license file.
show license
To display information about a Cisco IOS software license, use the show license command in either user EXEC or privileged EXEC mode.
Cisco Router Platforms
show license {all | detail feature-name | feature | file | handle | parser schema | status | udi}
Cisco Catalyst 3560-E and 3750-E Switch Platforms
show license {agent {counters | schema | session} | {all | detail feature-name | feature | file | handle | status | udi} switch switch-num | parser schema}
Cisco Catalyst 3750-E Mixed Switch Stacks
show license {agent {counters | schema | session} | detail {feature-name switch switch-num | switch switch-num} | {all | feature | file | handle | status | udi} switch switch-num | parser schema}
Syntax Description
Command Default
License-related information is not displayed.
Command Modes
User EXEC
Privileged EXEC
Command History
Usage Guidelines
Use this command to display license information and to help with troubleshooting issues related to Cisco IOS software licenses. This command displays all the licenses in the system.
This command also displays the features that are available but not licensed to execute. Output is grouped according to how the features are stored in license storage.
If a switch ID is specified, information from that switch is displayed. If a switch ID is not specified, details of the local switch are displayed.
Examples
Following is sample output from the show license all command:
Router# show license all
License Store: Primary License Storage StoreIndex: 0 Feature: TEST_FEATURE_1 Version: 1.0 License Type: Trial License State: Active, Not in Use, EULA accepted Trial total period: 1 day 0 hour Trial period left: 0 second Lock type: Node locked Vendor info <PID>AS54XM-AC-RPS</PID><SN>JAE0948QXJW</SN> License Addition: Additive License Generation version 135266304 License Precedence: 1
Table 1 describes the significant fields shown in the display.
show subsys
To display the subsystem information, use the show subsys command in privileged EXEC mode.
show subsys [class class | name name]
Syntax Description
Command Modes
Privileged EXEC
Command History
Usage Guidelines
Use the show subsys command to confirm that all required features are in the running image.
Examples
Following is sample output from the show subsys command:
Router# show subsysName Class Versionstatic_map Kernel 1.000.001arp Kernel 1.000.001ether Kernel 1.000.001compress Kernel 1.000.001alignment Kernel 1.000.002monvar Kernel 1.000.001slot Kernel 1.000.001oir Kernel 1.000.001atm Kernel 1.000.001ip_addrpool_sys Library 1.000.001chat Library 1.000.001dialer Library 1.000.001flash_services Library 1.000.001ip_localpool_sys Library 1.000.001nvram_common Driver 1.000.001ASP Driver 1.000.001sonict Driver 1.000.001oc3suni Driver 1.000.001oc12suni Driver 1.000.001ds3suni Driver 1.000.001Following is sample output from the show subsys command that includes the license class:Router# show subsys
Name Class Versionlicense_mgmt_local Management 1.000.001license_admin_local Management 1.000.001license_debug_core Management 1.000.001license_test_ui Management 1.000.001test_license_parser Management 1.000.001license_ui Management 1.000.001license_parser Management 1.000.001license_registry Registry 1.000.001license_client License 1.000.001Table 2 describes the fields shown in the display.
show subsys license
To display the subsystem running for a feature set, use the show subsys license command in either user EXEC or privileged EXEC mode.
show subsys license subsystem
Syntax Description
Command Default
Subsystem information is not displayed.
Command Modes
User EXEC
Privileged EXEC
Command History
Usage Guidelines
Use this command to display license information and to help with troubleshooting issues related to Cisco IOS software licenses.
Examples
Following is sample output that shows the subsystem running for the IP base feature set:
Router# show subsys license ipbase
License level: ipbaseName Class Versionobfl_env_app Kernel 1.000.001exception Kernel 1.000.001xml_proxy_client Kernel 1.000.000proto_counter Kernel 1.000.001sched_ui Kernel 1.000.001policy_manager Kernel 1.000.001fib_table_trace Kernel 1.000.001ifmibapi_access Kernel 1.000.000xml_engine Kernel 1.000.000fddi_mtu Kernel 1.000.001fib_trace Kernel 1.000.001...qos_set Protocol 1.000.001rip Protocol 1.000.001ipdiag Protocol 1.000.001aaa_peruser Protocol 1.000.001identity_cli Management 1.000.001notification_log_mib Management 1.000.000pagpmib Management 1.000.000ifmib Management 1.000.000rtty_chain Management 1.000.001cdpmib Management 1.000.000vlmem Management 1.000.000...psecure_registry Registry 1.000.001ip_ios_registry Registry 1.000.001sys_name_registry Registry 1.000.001INIT SystemInit 2.000.001parser EHSA 1.000.001tmpsys_ifs EHSA 1.000.001hulc_fib_rf_ehsa EHSA 1.000.001regexp_ui EHSA 1.000.001system_ifs EHSA 1.000.001chunk_ui EHSA 1.000.001rbcp EHSA 1.000.000gdb_ui EHSA 1.000.001ifs_image_elf EHSA 1.000.001nvram_common EHSA 1.000.001ifs_image_ascii EHSA 1.000.001clock_ui EHSA 1.000.001nv_ifs EHSA 1.000.001sff8472 Pre-Driver 1.000.001aggmgr Pre-Driver 1.000.000ifindex_pers Pre-Driver 1.000.001sff8472_fixed Pre-Driver 1.000.000fib_rp_predriver Pre-Driver 1.000.001system_capability Pre-Driver 1.000.001fib_lc_predriver Pre-Driver 1.000.001fib_ios_chain Pre-Driver 1.000.001transceiver Pre-Driver 1.000.002fib_ios_predriver Pre-Driver 1.000.001license_client License 1.000.001hulc_flash License 1.000.001ios_licensing_image_application License 1.000.001ifs License 1.000.001sdb License 1.000.001boot_upgrade License 1.000.001hulc_universal_only License 1.000.001Table 3 describes the fields shown in the display.
Feature Information for Cisco IOS Software Licensing
Table 4 lists the release history for this feature.
Not all commands may be available in your Cisco IOS software release. For release information about a specific command, see the command reference documentation.
Use Cisco Feature Navigator to find information about platform support and software image support. Cisco Feature Navigator enables you to determine which Cisco IOS and Catalyst OS 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 4 lists only the Cisco IOS software release that introduced support for a given feature in a given Cisco IOS software release train. Unless noted otherwise, subsequent releases of that Cisco IOS software release train also support that feature.
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.
© 2007 Cisco Systems, Inc. All rights reserved.