Cisco IOS Software Activation Command Reference
Cisco IOS Software Activation Command Reference
Americas Headquarters
Cisco Systems, Inc.
170 West Tasman Drive
San Jose, CA 95134-1706
USA
http://www.cisco.com
Tel: 408 526-4000
800 553-NETS (6387)
Fax: 408 527-0883
THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS,
INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.
THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH
THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY,
CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.
The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB's public domain version
of the UNIX operating system. All rights reserved. Copyright © 1981, Regents of the University of California.
NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED “AS IS" WITH ALL FAULTS.
CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE.
IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUT
LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERS
HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
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.
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: http://
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)
CHAPTER 2 license accept end user agreement through request license new-udi 7
license accept end user agreement 9
license agent default 10
license agent listener 12
license agent max-sessions 14
license agent notify 15
license boot level 17
license boot module 21
license call-home install pak 24
license call-home resend 27
license call-home revoke 30
license call-home url 34
license clear 36
license comment 39
license expand nvram 42
license feature 44
license feature snasw 46
license install 47
license modify priority 51
license purge 53
license revoke 55
license right-to-use activate 57
license right-to-use deactivate 58
license save 59
Cisco IOS XE Release 3.5S This command was integrated into Cisco IOS XE Release 3.5S and
implemented on the Cisco ASR 903 router.
Related Commands
Command Description
show license Displays information about a Cisco IOS software
license.
debug license
To enable controlled Cisco IOS software license debugging activity on a device, use the debug license
command in privileged EXEC mode. To disable debugging, use the no form of this command.
debug license {agent {all| error}| core {all| errors| events}| errors| events| ipc}
no debug license {agent {all| error}| core {all| errors| events}| errors| events| ipc}
12.4(15)XZ This command was integrated into Cisco IOS Release 12.4(15)XZ.
12.4(20)T This command was integrated into Cisco IOS Release 12.4(20)T.
Cisco IOS XE Release 3.2S This command was integrated into Cisco IOS XE Release 3.2S and
implemented on the Cisco ASR 1001 router.
Cisco IOS XE Release 3.5S This command was modified. The feature atm keywords were added
for the Cisco ASR 903 router.
Usage Guidelines Use this command to help troubleshoot issues with licenses on a device.
On the Cisco ASR 1001 router, the output from the debug license command is not in standard IOS format.
You must execute the request platform software trace rotate all privileged EXEC command to make the
output in the log files in the bootflash:tracelogs directory.
Examples The following example shows how to enable debugging for license warnings and errors on a router:
VXc3dkxOYWlXRzZ0dUJOMG5lTXpKaHpzQ2tMN1l3TWFxS2paem05YW5FbVJHUUVPTHlDdmRVZksw
QmNLN0pPcnZsUkw0VjMyJDxXTEM+QVFFQklRQUIvLy9GbS8vWDkybThNb0NOZkVMSHJiVzRjWDFM
ZGNpdDNMVU5GWlV1OWppT0phcXB5Q2N6TTFpaUlKbVE3NEd5WHJFY3F2UGlBbVdTYUVtVVQ1NnJz
dGs2Z3ZtaitFUUtSZkQ5QTBpbWUxY3pyZEt4ZklMVDBMYVhUNDE2bndtZnA5MlR5YTZ2SVE0Rm5s
QmRxSjFzTXpYZVNxOFBtVmNUVTlBNG85aGlsOXZLdXI4TjlGODg1RDlHVkYwYkpIY2lUNU09PC9X
TEM+XV0+PC9MSUNFTlNFX0xJTkU+PFVTRVJfTU9ESUZJQUJMRV9DT01NRU5UIGZpZWxkUmVzdHJp
Y3Rpb25zPSJNYXggOTkgQVNDSUkgY2hhcmFjdGVycyBpbiBsZW5ndGguIj48L1VTRVJfTU9ESUZJ
QUJMRV9DT01NRU5UPjwvQ0lTQ09fV1RfTElDRU5TRT48L0NJU0NPX1dUX0FSVElGQUNUUz4=
</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 =
ipbase
LIC_AGENT: Notification Event type = 1 License Installed
LIC_AGENT: Notification Event type = 13 License Annotate
Usage Guidelines The license accept end user agreement command is used to accept the EULA for all Cisco IOS software
packages and features. After the command is issued and the EULA accepted, it is automatically applied for
all Cisco IOS software packages and feature licenses.
• If this configuration command is part of the start-up configuration, it implies that the EULA is accepted.
The EULA is automatically applied to any subsequent license that is activated; the EULA is not displayed
and the user is not prompted to accept the EULA.
• A copy of the terms of the EULA is available at http://www.cisco.com/en/US/docs/general/warranty/
English/EU1KEN_.html
Related Commands
Command Description
license install Installs a stored license file.
Command Default The license agent is enabled, and it monitors the HTTP path /lic-agent by using plaintext.
15.0(1.1)M This command was modified. The no form of the command was
removed.
Cisco IOS XE Release 3.5S This command was integrated into Cisco IOS XE Release 3.5S and
implemented on the Cisco ASR 903 router.
Usage Guidelines By default, the license agent starts automatically when the device boots up.
The agent responds to ConnectRequest XML messages and, depending on the configuration of the license
agent listener http command, all other Cisco License Manager XML messages.
Examples The following example shows how to use the default HTTP mechanism for authentication:
Related Commands
Command Description
license agent listener Configures the path that the license agent
authentication monitors.
Command Description
license agent max-sessions Limits the number of HTTP sessions to the license
agent.
license agent notify Specifies the URL to send license agent notifications.
license agent listener http {encrypt| plaintext} url-path authenticate [acl access-list] [max-message size]
[none]
no license agent listener http
acl access-list (Optional) Uses the specified access list for trusted
clients on this session. The range is 1 to 65536.
Command Default The license agent authentication monitors the HTTP path /lic-agent by using plaintext.
Cisco IOS XE Release 3.5S This command was integrated into Cisco IOS XE Release 3.5S and
implemented on the Cisco ASR 903 router.
Usage Guidelines This command starts the license agent in listener mode.
If the value for the url-path argument is not /lic-agent, then /lic-agent (for example, license agent default)
accepts only the ConnectRequest message. Otherwise, if the value for the url-path argument is /lic-agent (and
encrypt is specified), then encrypt /lic-agent accepts all requests and plaintext /lic-agent accepts only the
ConnectRequest message.
Examples The following example shows how to authenticate the license agent by using the HTTP encrypted authentication
mechanism:
Related Commands
Command Description
license agent default Configures license agent authentication.
license agent max-sessions Limits the number of HTTP sessions to the license
agent.
license agent notify Specifies the URL to send license agent notifications.
Cisco IOS XE Release 3.5S This command was integrated into Cisco IOS XE Release 3.5S and
implemented on the Cisco ASR 903 router.
Examples The following example shows how to limit the number of concurrent license agent sessions on a router:
Related Commands
Command Description
license agent default Configures license agent authentication.
license agent listener Configures the path that the license agent
authentication monitors.
license agent notify Specifies the URL to send license agent notifications.
Cisco IOS XE Release 3.5S This command was integrated into Cisco IOS XE Release 3.5S and
implemented on the Cisco ASR 903 router.
Usage Guidelines You can also configure this command by using the Cisco License Manager message ConnectRequest.
Examples The following example shows how to specify the URL to send license agent notifications:
Related Commands
Command Description
license agent default Configures license agent authentication.
Command Description
license agent listener Configures the path that the license agent
authentication monitors.
license agent max-sessions Limits the number of HTTP sessions to the license
agent
Syntax Description license-level Level at which the switch is booted (for example,
ipservices).
The license levels available in a universal/universalk9
image are:
• entservices
• ipbase
• lanbase
12.4(20)T This command was integrated into Cisco IOS Release 12.4(20)T.
Cisco IOS XE Release 3.1.0SG This command was integrated into Cisco IOS XE Release 3.1.0SG
on Catalyst 4500E series switches.
Cisco IOS XE Release 3.5S This command was integrated into Cisco IOS XE Release 3.5S and
implemented on the Cisco ASR 903 router.
Cisco IOS XE Release 3.10S This command was integrated into Cisco IOS XE Release 3.10S and
implemented on the Cisco CSR 1000V router.
Usage Guidelines Use the license boot level command for these purposes:
• Downgrade or upgrade licenses
• Enable or disable an evaluation or extension license
• Clear an upgrade license
This command forces the licensing infrastructure to boot the configured license level instead of the license
hierarchy maintained by the licensing infrastructure for a given module.
• When the switch reloads, the licensing infrastructure checks the configuration in the startup configuration
for any licenses. If there is a license in the configuration, the switch boots with that license. If there is
no license, the licensing infrastructure follows the image hierarchy to check for licenses.
• If the forced boot evaluation license expires, the licensing infrastructure follows the regular hierarchy
to check for licenses.
• If the configured boot license is already expired, the licensing infrastructure follows the hierarchy to
check for licenses.
This command takes effect at the next reboot of any of the supervisors (Act or stby). This configuration must
be saved to the startup configuration for it to be effective. After you configure the level, the next time the
standby supervisor boots up, this configuration is applied to it.
To boot the standby supervisor to a different level than active, configure that level by using this command
and then bring up the standby.
If the show license all command displays the license as "Active, Not in Use, EULA not accepted," you can
use the license boot level command to enable the license and accept the end-user license agreement (EULA).
Examples The following example shows how to activate the ipbase license on the switch upon the next reload:
Related Commands
Command Description
license install Installs a stored license file.
show license all Shows information about all licenses in the system.
Cisco 860, 880, and 890 Series Routers, and Cisco 1900, 2900, and 3900 Series Integrated Services Router
Platforms
license boot module module-name level license-level
no license boot module module-name level license-level
level license-level Boots the device or module at the specified level (for
example, advipservices).
12.4(20)T This command was integrated into Cisco IOS Release 12.4(20)T.
Cisco IOS XE Release 3.2S This command was modified. The group, all, feature, and level keywords
were added for the Cisco ASR 1001 router.
Usage Guidelines Use the license boot module command for these purposes:
• Downgrade or upgrade licenses
• Enable or disable an evaluation or extension license
• Clear an upgrade license
This command forces the licensing infrastructure to boot the configured license level instead of the license
hierarchy maintained by the licensing infrastructure for a given module.
• When the router reboots, the licensing infrastructure checks the configuration in the startup
configuration/rommon for any licenses. If there is a license in the configuration, the router boots with
that license. If there is no license, the licensing infrastructure follows the image hierarchy to check for
licenses.
• If the forced boot evaluation license expires, the licensing infrastructure follows the regular hierarchy
to check for licenses.
• If the configured boot license is already expired, the licensing infrastructure follows the hierarchy to
check for licenses.
To make the evaluation license inactive, use the no license boot module technology-package command. To
re-activate the evaluation license, use the license boot module technology-package command.
If the show license all command displays the license as "Active, Not in Use, EULA not accepted," you can
use the license boot module command to enable the license and accept the EULA. Do not confuse the license
boot module global configuration command with a similarly named command available in privileged EXEC
mode.
Examples The following example shows how to activate the ipbase image license that is part of the group all on the
ASR 1001 module at the next reboot:
Related Commands
Command Description
license install Installs a stored license file.
show license all Shows information about all licenses in the system.
Cisco 860, 880, and 890 Series Routers, and Cisco 1900, 2900, and 3900 Series Integrated Services Router
Platforms
license call-home install pak pak-id
12.4(15)XZ This command was integrated into Cisco IOS Release 12.4(15)XZ.
12.4(20)T This command was integrated into Cisco IOS Release 12.4(20)T.
Cisco IOS XE Release 3.3SG This command was integrated into Cisco IOS XE Release 3.3SG and
implemented on the Cisco Catalyst 4500E series switch.
Release Modification
15.1(1)SG This command was integrated into Cisco IOS Release 15.1(1)SG and
implemented on the Cisco Catalyst 4500E series switch.
Usage Guidelines The Cisco License Call Home feature allows a Cisco router to communicate with the Cisco licensing
infrastructure through the Internet and retrieve licensing information. This command requires that the router
be connected to the Internet.
This command requires the following:
• The router or switch must have an Internet connection and use HTTPS to connect to the Cisco licensing
infrastructure. To set up a secure HTTP connection, see the HTTP 1.1 Web Server and Client module
in the Cisco IOS Network Management Configuration Guide.
• Only certain platforms support the Cisco License Call Home feature, and those devices must be running
a Cisco IOS crypto K9 image.
• You must obtain the device certificate from the Cisco licensing infrastructure.
• You must have a Cisco.com user login account.
The PAK is a unique token supplied to allow partial fulfillment of licenses. A PAK is not tied to any particular
device, but rather to a product identifier (PID).
When you issue the license call-home install pak command, these events occur:
1 Information about the stock keeping unit (SKU) is displayed. SKUs map to one or more Cisco software
features.
2 You receive prompts at the command line for required fields such as an e-mail address, username, and
password to access the Cisco website and SKU quantities.
3 The user-entered data is validated and processed, and then the license is installed on the router. If data is
not validated, warning messages are displayed.
Examples The following example shows the commands, prompts, and responses required to install a license by using a
PAK and the Cisco License Call Home feature. Use the show license clear command to verify the installation.
Related Commands
Command Description
license call-home resend Restores a lost license by using the Cisco License
Call Home feature.
license call-home revoke Rehosts (revokes and transfers) a license by using the
Cisco License Call Home feature.
show license call-home Displays the SKU list and features available in a PAK
by using the Cisco License Call Home feature.
Cisco 860, 880, and 890 Series Routers, and Cisco 1900, 2900, and 3900 Series Integrated Services Router
Platforms
license call-home resend dest-lic-location
Syntax Description dest-lic-location The location where the Cisco IOS software license is
to be stored. Valid location file systems are archive,
bs, flash, flash n, ftp, http, https, null, nvram,
pram, rcp, scp, syslog, system, tftp, tmpsys, vb.
The license location can also be a directory.
• The bs://, null://, and vb:// file systems do not
accept filenames.
• The bs file system is available only on mixed
Cisco 3750-E switch stacks.
• The archive, pram scp, and syslog file systems
are available only on router platforms.
• The flash n file system, where r, is an integer
in the range from 1 to 9, is available only on
Cisco 3750-E switches and stacks.
• The https file system is not available on mixed
Cisco 3750-E switch stacks and the Cisco
3560-E switch.
12.4(15)XZ This command was integrated into Cisco IOS Release 12.4(15)XZ.
12.4(20)T This command was integrated into Cisco IOS Release 12.4(20)T.
Cisco IOS XE Release 3.3SG This command was integrated into Cisco IOS XE Release 3.3SG and
implemented on the Cisco Catalyst 4500E series switch.
15.1(1)SG This command was integrated into Cisco IOS Release 15.1(1)SG and
implemented on the Cisco Catalyst 4500E series switch.
Usage Guidelines The Cisco License Call Home feature allows a Cisco router to communicate with the Cisco licensing
infrastructure through the Internet and retrieve licensing information. This command requires that the router
be connected to the Internet.
This command contacts the Cisco licensing back-end fulfillment system and obtains licenses that are valid
for a specified unique device identifier (UDI). The license call-home resend command also stores the received
license lines in the specified destination URL.
This command requires the following:
• The router or switch must have an Internet connection and use HTTPS to connect to the Cisco licensing
infrastructure. To set up a secure HTTP connection, see the HTTP 1.1 Web Server and Client module
in the Cisco IOS Network Management Configuration Guide.
• Only certain platforms support the Cisco License Call Home feature, and those devices must be running
a Cisco IOS crypto K9 image.
• You must obtain the device certificate from the Cisco licensing infrastructure before starting.
• You must have a Cisco.com user login account.
Examples The following example shows the commands, prompts, and responses required to request a license to be sent
from the Cisco licensing infrastructure and to be stored in the requested destination file system:
Related Commands
Command Description
license call-home install Installs a license by using the Cisco License Call
Home feature.
license call-home revoke Rehosts (revokes and transfers) a license by using the
Cisco License Call Home feature.
show license call-home Displays the SKU list and features available in a PAK
by using the Cisco License Call Home feature.
Cisco 860, 880, and 890 Series Routers, and Cisco 1900, 2900, and 3900 Series Integrated Services Router
Platforms
license call-home revoke [udi target-udi] output-of-rehosted-license-url [permission-ticket
permission-ticket-url] [rehost-ticket rehost-ticket-url]
Syntax Description udi target-udi (Optional) Revokes license information for this target
UDI.
12.4(20)T This command was integrated into Cisco IOS Release 12.4(20)T.
Cisco IOS XE Release 3.3SG This command was integrated into Cisco IOS XE Release 3.3SG and
implemented on the Cisco Catalyst 4500E series switch.
15.1(1)SG This command was integrated into Cisco IOS Release 15.1(1) SG and
implemented on the Cisco Catalyst 4500E series switch.
Usage Guidelines The Cisco License Call Home feature allows a Cisco router to communicate with the Cisco licensing
infrastructure through the Internet and retrieve licensing information. This command requires that the router
be connected to the Internet.
If you do not specify a target UDI, the rehost ticket is stored in the specified URL. If you do specify a target
UDI, this command sends the rehost ticket to the Cisco licensing infrastructure with the target UDI, converts
it to a license file, and stores it in the specified URL. If one of the operations fails in the call-home revoke
operations, the intermediate results are stored at the specified URL and a message explaining what to do next
is displayed.
This command requires the following:
• The router or switch must have an Internet connection and use HTTPS to connect to the Cisco licensing
infrastructure. To set up a secure HTTP connection, see the HTTP 1.1 Web Server and Client module
in the Cisco IOS Network Management Configuration Guide.
• Only certain platforms support the Cisco License Call Home feature, and those devices must be running
a Cisco IOS crypto K9 image.
• You must obtain the device certificate from the Cisco licensing infrastructure.
• You must have a Cisco.com user login account.
The license call-home revoke EXEC command performs this sequence of operations:
1 The Cisco licensing module establishes communication with the Cisco licensing infrastructure to start the
rehost operation.
2 The Cisco licensing infrastructure sends a signed request to obtain the SKU details for this UDI from the
Cisco licensing portal. The request contains the source UDI.
3 The Cisco licensing portal responds that either the target UDI is not correct or lists the stock keeping units
(SKUs) available on the device for rehosting.
4 The Cisco licensing infrastructure requests the permission ticket from the licensing portal by providing
the SKU and the e-mail address of the user.
5 The Cisco licensing portal provides the permission file to the Cisco licensing infrastructure.
6 The software uses this permission ticket file to generate the rehost ticket.
7 This rehost ticket is sent to the licensing back end along with the target UDI and optional e-mail address.
8 The Cisco licensing back end generates a new license file and sends it by using the e-mail address collected
in the prompts.
Examples The following example shows how to use the license call-home revoke command to revoke a license on the
device with the specified UDI. In the display, the user selects the SKU called SL-LWAPP= to revoke the
license for the lwapp feature. This command sends the rehost ticket to the Cisco licensing infrastructure with
the target UDI, converts it to a license file, and stores it in the specified URL (flash: REHOSTED_LICENSE):.
Related Commands
Command Description
license call-home install Installs a license by using the Cisco License Call
Home feature.
license call-home resend Restores a lost license by using the Cisco License
Call Home feature.
show license call-home Displays the SKU list and features available in a PAK
by using the Cisco License Call Home feature.
Syntax Description licensing-infrastructure-url The HTTP address where the Cisco licensing
infrastructure can be accessed.
12.4(20)T This command was integrated into Cisco IOS Release 12.4(20)T.
Cisco IOS XE Release 3.3SG This command was integrated into Cisco IOS XE Release 3.3SG and
implemented on the Cisco Catalyst 4500E series switch.
15.1(1)SG This command was integrated into Cisco IOS Release 15.1(1)SG and
implemented on the Cisco Catalyst 4500E series switch.
Usage Guidelines Use this command to configure a new URL for accessing the Cisco licensing infrastructure.
This feature requires that:
• The router or switch must have an Internet connection and use HTTPS to connect to the Cisco licensing
infrastructure. To set up a secure HTTP connection, see the HTTP 1.1 Web Server and Client module
in the Cisco IOS Network Management Configuration Guide.
• Only certain platforms support the Cisco License Call Home feature, and those devices must be running
a Cisco IOS crypto K9 image.
• You must obtain the device certificate from the Cisco licensing infrastructure.
• You must have a Cisco.com user login account.
Examples The following example shows how to change the URL to http://cisco.com/newserver:
Related Commands
Command Description
license call-home install Installs a license by using the Cisco License Call
Home feature.
license call-home resend Restores a lost license by using the Cisco License
Call Home feature.
license call-home revoke Rehosts (revokes and transfers) a license by using the
Cisco License Call Home feature.
show license call-home Displays the SKU list and features available in a PAK
by using the Cisco License Call Home feature.
license clear
To remove a license entry from license storage, use the license clear command in privileged EXEC mode.
Cisco ASR 1001 Routers, Cisco 860, 880, and 890 Series Routers, and Cisco 1900, 2900, and 3900 Series Integrated
Services Router Platforms
license clear feature-name
12.4(15)XZ This command was integrated into Cisco IOS Release 12.4(15)XZ.
12.4(20)T This command was integrated into Cisco IOS Release 12.4(20)T.
Release Modification
Cisco IOS XE Release 3.2S This command was integrated into Cisco IOS XE Release 3.2S on the
Cisco ASR 1001 router.
Cisco IOS XE Release 3.5S This command was modified. The standby keyword was added for
the Cisco ASR 903 router.
Usage Guidelines For the ASR 1001 router, the license clear command clears only image-level licenses that are not in-use.
Once the throughput feature license is in-use, it cannot be cleared.
The license clear command clears all licenses, but some licenses, such as built-in licenses, cannot be cleared.
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.
For some devices, the license clear command verifies that the license line is valid and explicitly installed.
Only licenses that have been added using the license install command are removed. 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 primary switch has installed the minimum licensing feature required to support the
licensing operations of the secondary switches. The license clear command clears a license from license
storage, which a primary switch does not have. When the command is issued from the primary switch, the
switch number is required to clear a license on a specific switch.
Examples The following example shows how to display the installed licenses on an ASR 1001 router and how to clear
the throughput license. Note that active, in-use licenses cannot be cleared:
Feature: advsecurity
1 License Type: Permanent
License State: Active, In Use
License Addition: Exclusive
Comment: Permanent License
Store Index: 0
Store Name: Primary License Storage
2 License Type: Evaluation
License State: Inactive
Evaluation total period: 8 weeks 4 days
Evaluation period left: 8 weeks 4 days
License Addition: Additive
Comment:
Store Index: 1
Store Name: Primary License Storage
Select Index to Clear [1-2]: 2
Are you sure you want to clear? (yes/[no]): yes
Related Commands
Command Description
license install Installs a stored license file.
license comment
To add or remove a comment about a feature license, use the license comment command in privileged EXEC
mode.
Cisco 860, 880, and 890 Series Routers, and Cisco 1900, 2900, and 3900 Series Integrated Services Router
Platforms
license comment {add feature-name comment| delete feature-name}
12.4(15)XZ This command was integrated into Cisco IOS Release 12.4(15)XZ.
12.4(20)T This command was integrated into Cisco IOS Release 12.4(20)T.
Cisco IOS XE Release 3.2S This command was modified. The feature keyword was added for
the Cisco ASR 1001 router.
Cisco IOS XE Release 3.5S This command was modified. The standby keyword was added for
the Cisco ASR 903 router.
Usage Guidelines This command is useful for tracking a license when multiple licenses are stored on a device, and for adding
or deleting information about a specific license. You can also use the license comment command to verify
that a license associated with the specified feature is present in license storage.
Use the show license file command to display comments added to the license file.
The license comment command performs these operations:
• Verifies that the license associated with the specified feature is present in the license storage.
• If there are multiple license lines, the command prompts for license line selection.
• If a comment exists in the license line, the command displays the comment first before prompting for a
new comment. Up to 99 characters are stored in license storage.
• If a switch number is specified, this command is executed on the specified switch.
Examples The following example shows how to add a comment to a license file on the Cisco ASR 1001 router by using
the license comment command and by verifying it with the show license file command:
Comment: newest
Hash: ZJJz5MveEOPePQA3ATs6+OxF4bw=
The following example shows how to add a comment to a license file. You are prompted to select the index
number of the license to add the comment to.
Related Commands
Command Description
license clear Removes a license entry from a permanent license
file.
Usage Guidelines License storage expansion reduces the amount of NVRAM available for configuration file storage. If the
configuration files are too large to fit into the reduced NVRAM, you must run file compression on the
configuration files by using the service compress-config command.
Examples The following example shows how to expand the allocation for license storage in NVRAM:
Error: startup-config is too large. Compress the config with "service compress-config"
followed by "copy system:running-config nvram:startup-config" and rerun "licence expand
nvram".
The following response shows that a configuration file is still too large for the resized NVRAM:
Error: cannot expand the license storage. Insufficient NVRAM to store compressed
configuration.
The following response shows that expansion cannot take place because the size of the block files is too large:
Error: cannot expand the license storage. Existing block files are too large. Back up
existing block files, delete them from nvram and reissue “license expand nvram”.
The following response indicates that this command is being issued on an already expanded NVRAM:
Related Commands
Command Description
service compress-config Compresses startup configuration files.
license feature
To activate the specified license feature, use the license feature command in global configuration mode. To
deactivate the specified license feature, use the no form of this command.
XE 3.5S This command was integrated into Cisco IOS XE Release 3.5S and
implemented on the Cisco ASR 903 router.
Usage Guidelines Use the license feature command to activate the specified license feature.
Examples The following example shows how to activate the memory license feature on the Cisco 1905 router:
Related Commands
Command Description
license install Installs a stored license file.
Usage Guidelines The license feature snasw command is used to activate the SNASw feature license.
Examples The following example shows how to enable the SNASw feature license:
Related Commands
Command Description
license install Installs a stored license file.
license install
To install a stored license file, use the license install command in privileged EXEC mode.
Syntax Description stored-location-url The location within a device where Cisco IOS
software licenses are stored. Depending on the
hardware platform, valid URL location file systems
might be: archive, bootflash, bs, flash, flash n, ftp,
http, https, null, nvram, pram, rcp, scp, syslog,
system, tftp, tmpsys, usb0, vb.
• The bs://, null://, and vb:// file systems do not
accept filenames.
• The bs file system is available only on mixed
Cisco 3750-E switch stacks.
• The archive, pram scp, and syslog file systems
are available only on router platforms.
• The flash n file system, where r, is an integer
in the range from 1 to 9, is available only on
Cisco 3750-E switches and stacks.
• The https file system is not available on mixed
Cisco 3750-E switch stacks and the Cisco
3560-E switch.
12.4(15)XZ This command was integrated into Cisco IOS Release 12.4(15)XZ.
12.4(20)T This command was integrated into Cisco IOS Release 12.4(20)T.
Cisco IOS XE Release 3.1.0.SG This command was modified. The standby keyword was added for
the Cisco Catalyst 4500E series switches.
Cisco IOS XE Release 3.2S This command was modified. The file keyword was added for the
Cisco ASR 1001 router.
Cisco IOS XE Release 3.5S This command was implemented on the Cisco ASR 903 router.
Usage Guidelines You must have already purchased the license and obtained the license file from either the Cisco licensing
portal or by using the license save EXEC command.
For Cisco Catalyst 6500 series switches, the active supervisor allows the license to be installed on both the
active and the standby supervisors. The license keys are stored in NVRAM for both the active and standby
supervisors. Each supervisor requires a separate license key.
When the license install command is issued, these actions are initiated:
• The license module parses the license file and retrieves the unique device identifier (UDI), license line,
and license comments.
• If the UDI in the license file is not local, this command passes the license line and user comments to the
specified switch where the information is provided to the license security application.
• If the license is a trial license, this command initiates an end-user license agreement prompting you to
accept it. If you do not accept the end-user license agreement, the license line installation is stopped.
• Upon successful completion, the application notifies you about the installation of the license.
• The command displays an information message stating that the license installation is successful and
whether the licensed feature is present in the current image.
The installation process does not install duplicate licenses. This message appears when duplicate licenses are
detected:
Installing...Feature:xxx-xxx-xxx...Skipped:Duplicate
On some hardware platforms, you must reload (or reboot) the device to make a newly installed license active.
When the standby keyword is specified, the license is available only on the standby device. The active
supervisor is not able to use it.
Examples The following example shows how to install a license from the bootflash system on the Cisco ASR 1001
router. The license is a duplicate and is not installed as shown in the display:
Related Commands
Command Description
license clear Removes a license entry from a permanent license
file.
Syntax Description feature-name Name of the feature whose priority you want to
modify.
Cisco IOS XE Release 3.2S This command was integrated into Cisco IOS XE Release 3.2S for
the Cisco ASR 1001 router.
Cisco IOS XE Release 3.5S This command was modified. The standby keyword was added for
the Cisco ASR 903 router.
Usage Guidelines This command adjusts the priority of a license. This command generates a list of metered licenses available
for a feature and prompts you to select one from the list. If only one license is present, it is automatically
selected. If the selected license is an evaluation license and the feature has not been activated, the end-user
license agreement (EULA) is shown, and you are prompted to accept or reject the agreement. If you accept
the EULA, the priority of the selected license to the permanent license increases or decreases, and the selected
license becomes the active license.
Examples The following example shows how the license modify priority command is used to modify the priority of a
license:
Related Commands
Command Description
show license Displays information about a Cisco IOS software
license.
license purge
To purge unneeded licenses (licenses that are not associated with the current chassis unique device identifier
[UDI]), use the license purge command in privileged EXEC mode.
license purge
Cisco IOS XE Release 3.5S This command was modified. The standby keyword was added
for the Cisco ASR 903 router.
Usage Guidelines Use this command to remove licenses that are not associated with the current chassis UDI. Removing these
licenses frees up additional space.
When supervisors are moved from one chassis to another, the licenses that were installed on the supervisor
might be tied to the old chassis. These license are not usable when the supervisor is present on the new chassis.
This command removes licenses from storage that do not belong to the current chassis.
Related Commands
Command Description
license install Installs a stored license file.
license revoke
To revoke a software license from one device and transfer it to another, use the license revoke command in
privileged EXEC mode.
Syntax Description permission-file-url URL of the location to get to the permission ticket.
12.4(20)T This command was integrated into Cisco IOS Release 12.4(20)T.
Cisco IOS XE Release 3.2S This command was integrated into Cisco IOS XE Release 3.2S for
the Cisco ASR 1001 router.
Cisco IOS XE Release 3.5S This command was implemented on the Cisco ASR 903 router.
Usage Guidelines The license revoke command removes the original, permanent license from the device and provides a license
for the new device by accomplishing these operations:
• Obtains a permission ticket from the Cisco licensing infrastructure portal that allows the license to be
moved.
• Parses the permission ticket file to extract data related to generating the rehosting ticket.
• Uploads the rehost ticket to the Cisco licensing infrastructure portal so you can obtain the final license.
• The license security application processes the data and offers a grace-period license.
• Once you accept the end-user license agreement, the licensing infrastructure processes the permission
ticket and generates the rehost ticket.
Note Cisco IOS licensing requires that the license files generated by the Cisco licensing back end 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
licensing back end requires the device credential information. Use the license save credential command
to save device credential information to a specified file system.
Examples The following example shows how 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:
Related Commands
Command Description
license install Installs a stored license file.
Command Default
Command Modes
Usage Guidelines
Examples
Related Commands
Command Description
Command Default
Command Modes
Usage Guidelines
Examples
Related Commands
Command Description
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.
Cisco 860, 880, and 890 Series Routers, and Cisco 1900, 2900, and 3900 Series Integrated Services Router
Platforms
license save file file-sys//lic-location
12.4(15)XZ This command was integrated into Cisco IOS Release 12.4(15)XZ.
12.4(20)T This command was integrated into Cisco IOS Release 12.4(20)T.
Cisco IOS XE Release 3.2S This command was modified. The file file-sys:filename keyword and
argument were added for the Cisco ASR 1001 router.
Release Modification
Cisco IOS XE Release 3.5S This command was modified. The standby keyword was added for
the Cisco ASR 903 router.
Usage Guidelines Issuing this command stores the license line and comment in XML format as required by the command. Issuing
this command saves copies of all permanent licenses.
Saved licenses can be restored by using the license install command.
Examples The following example shows how to save a license named throughput-license to the bootflash on the Cisco
ASR 1001 router:
Related Commands
Command Description
license install Installs a stored license file.
Cisco 860, 880, and 890 Series Routers, and Cisco 1900, 2900, and 3900 Series Integrated Services Router
Platforms
license save credential file file-sys//lic-location
12.4(15)XZ This command was integrated into Cisco IOS Release 12.4(15)XZ.
12.4(20)T This command was integrated into Cisco IOS Release 12.4(20)T.
Cisco IOS XE Release 3.2S This command was modified. The file file-sys:filename keyword and
argument were added for the Cisco ASR 1001 router.
Cisco IOS XE Release 3.5S This command was modified. The standby keyword was added for
the Cisco ASR 903 router.
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 tput-license to the
bootflash system on the Cisco ASR 1001 router:
Related Commands
Command Description
license install Installs a stored license file.
Usage Guidelines Use the platform enable controller sonet command before performing an ISSU upgrade from the Cisco IOS
XE Release 3.9S to Cisco IOS XE Release 3.10S.
Use the platform enable controller sonet command to enable the ports after the license is installed on the
router.
Note The slot number for the controller sonet is always zero on the Cisco ASR 903 Router.
Example:
Examples This example shows how to enable the controller sonet on the router.
Router# configure terminal
Router(config)# platform enable controller sonet 0/1/2
Command Description
controller sonet Selects the controller to configure and enters the
controller configuration mode.
Usage Guidelines A virtual UDI (vUDI) is generated when the Cisco CSR 1000V is first booted. The vUDI contains the format
ProductID:SerialNumber.
If you plan to clone the VM, you must also request a new virtual UDI on the cloned VM; if a new virtual UDI
is not requested, you have two Cisco CSR 1000V VM instances using the same vUDI and license in both
VMs, violating the terms of the Cisco EULA.
Caution If the Cisco CSR 1000V software is copied illegally to another physical host, then the vUDI becomes
invalid and the license is invalidated. You will receive a notice about the pending expiration of the license.
Examples The following example requests that a new vUDI be assigned to the Cisco CSR 1000V license:
se-10-0-0-0# request license new-udi
show license
To display information about a Cisco IOS software license, use the show license command in privileged
EXEC mode.
Cisco 860, 880, and 890 Series Routers, and Cisco 1900, 2900, and 3900 Series Integrated Services Router
Platforms
show license [agent {counters| session}| all| detail [ feature-name ]| feature| file| statistics| status| udi
[modules]]
Cisco Catalyst 3560-E and Cisco Catalyst 3750-E Switch and Switch Stack Platforms
show license [agent {counters| session}| all| detail [ feature-name ]| feature| file| image levels| statistics|
status| udi [modules] switch switch-num]
12.4(20)T This command was integrated into Cisco IOS Release 12.4(20)T.
12.2(33)SCC This command was integrated into Cisco IOS Release 12.2(33)SCC on the
Cisco UBR-10 MC20X20V line card.
15.0(1)M This command was modified. The modules keyword was added.
12.2(33)SCD This command was modified. The subslot slot / subslot keyword and
arguments were added for the Cisco uBR7225VXR and Cisco
uBR7246VXR routers.
Cisco IOS XE Release 3.2S This command was modified. The expiring, image-levels, in-use, and
permanent keywords were added for the Cisco ASR 1001 router.
Cisco IOS XE Release 3.3S This command was modified. The output for the show license feature
command now includes information about the cube_ent-100 feature license
for the Cisco ASR 1001 router.
Cisco IOS XE Release 3.5S This command was modified. The handle keyword was added for the Cisco
ASR 903 router.
Cisco IOS XE Release 3.9S This command was modified. The EULA and UDI history keywords were
added for the Cisco CSR 1000V router. This command was implemented
on Cisco 4400 Series ISRs.
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 number is specified, information from that switch is displayed. If a switch number is not specified,
details of the local switch are displayed.
If the show license all command displays the license as Active, Not in Use, EULA not accepted, you can use
the license boot module global configuration command to enable the license and accept the end-user license
agreement (EULA). Do not confuse the license boot module global configuration command with a similarly
named command available in privileged EXEC mode.
Cisco uBR10012 Universal Broadband Router Usage Guidelines
In a Cisco uBR10012 router, the line card is identified with a slot ID, which is a combination of the slot /
subslot. Use the subslot keyword with the show license command syntax, when appropriate.
The show license udi command shows the UDI values for all cable interface line cards. When the command
is used with the subslot keyword, the UDI value for the specified line card is displayed.
Keywords such as all, detail, feature, file, and status require the subslot slot / subslot keyword and arguments
to execute the show license command.
To enable evaluation license on the Cisco uBR10012 router, use the license modify command.
Cisco uBR7225VXR and Cisco uBR7246VXR Universal Broadband Routers Usage Guidelines
To enable evaluation license on the Cisco uBR7225VXR and Cisco uBR7246VXR routers, use the license
modify command.
Note The agent keyword is not supported in Cisco IOS Release 12.2(33)SCD on the Cisco uBR7225VXR and
on the Cisco uBR7246VXR routers.
Examples The following is sample output from the show license agent counters command:
The table below describes the significant fields shown in the display.
Field Description
License Store Name of the license line in the license storage.
The following is sample output from the show license detail command:
hoN0gyIWsyiJaM8AQIkVBQFzhr10GYolVzdzfJfEPQIx6tZ++/Vtc/q3SF/5Ko8XC
Y=</WLC>
Comment: --
Hash: ZJJz5MveEOPePQA3ATs6+OxF4bw=
Store Index: 1
License: 11 adventerprisek9 1.0 LONG NORMAL STANDALONE EXCL INFINITE_KEYS
INFINITE_KEYS NEVER NEVER NiL SLM_CODE CL_ND_LCK NiL *12MDFXFBE6T
EQR5400 NiL NiL NiL 5_MINS <UDI><PID>ASR1001</PID><SN>JAE14020AT5
</SN></UDI> dFCG4MGqCj5nRQGYuTNELNjulmgkdTIxsGBaysKmB1f8it6t76IbU
1nDky:q5h843EeHBw9JMwZWcMfbveX8j93UWZckXYU8gSablS79TVo5Vg$<WLC>AQ
EBIQAB///Y5fwUA9AySxZ1dkpw8MgMeMEbPYi4rEAcdDnsmUIwbp0xMUblmtUwhaC
QMd/pCaGRqwInXo3s+nsLU7rOtdOxoIxYZAo3LYmUJ+MFzsqlhKoJVlPyEvQ8H21M
NUjVbhoN0gyIWsyiJaM8AQIkVBQFzhr10GYolVzdzfJfEPQIx6tZ++/Vtc/q3SF/5
Ko8XCY=</WLC>
Comment:
Hash: 7AlBc9W0+DqIdv/3EgOMsXW19Xs=
The following is sample output from the show license image levels command on the Catalyst 3750E switch:
Examples The following is sample output from the show license all command, where subslot 8/1 denotes the line card
for which all license information is requested. The table below describes the fields shown in the command
output.
Field Description
Feature name Shows the feature name; for example, Downstream
(DS) license.
The following is sample output from the show license udi command, where subslot 8/1 specifies the line card
for which UDI information is requested:
Field Description
SlotID The slot/subslot number of the line card on the
uBR10012 router.
The following is sample output from the show license file command:
Examples The following is sample output from the show license all command, where slot 5 denotes the line card for
which the license information is requested. The table below describes the fields shown in the command output.
Field Description
SlotID The slot number of the line card on the Cisco
uBR7225VXR or Cisco uBR7246VXR router.
The following is sample output from the show license file command:
Hash: rYHlS/Q7961pN+kZpf3LQ9UR+dY=
Store Index: 1
License: 11 US_License 1.0 LONG NORMAL STANDALONE EXCL 8_KEYS INFINITE_KEY
S NEVER NEVER NiL SLM_CODE CL_ND_LCK NiL *1VDWSEZNBXMDUF6400 NiL
NiL NiL 5_MINS <UDI><PID>UBR-MC88U</PID><SN>CSJ12514210</SN></UDI
> yxU,2eYAsVZXLX1UhO:zfDWS4rE7OZr5g:cYy:rCOcVBi97MjRUZUzWb6Vi8MB2
3VVvaGQBN4tni,0BsTsufqgLjXaryA,NexvAPypO9AJRh3soHjqW,COT2V6fbgzPt
5u35$<WLC>AQEBIQAB//9uV7Zp1YcBuFy6gMM/gAYOXR7dm/+O06pGceLT3qUNUug
l4skFZoucJkLd0ojdk+mRqwInXo3s+nsLU7rOtdOxoIxYZAo3LYmUJ+MFzsqlhKoJ
VlPyEvQ8H21MNUjVbhoN0gyIWsyiJaM8AQIkVBQFzhr10GYolVzdzfJfEPQIx6tZ+
+/Vtc/q3SF/5Ko8XCY=</WLC>
Comment:
Hash: Hg6bxVO8ZZITGbFg7NoAQU/QGhs=
License Store: Evaluation License Storage
Store Index: 0
License: 11 US_License 1.0 LONG TRIAL DISABLED 1440 DISABLED STANDALONE AD
D 8_KEYS INFINITE_KEYS NEVER NEVER NiL SLM_CODE DEMO NiL NiL Ni N
iL NiL 5_MINS NiL V7kIRj,EZLjQ4gpW6nQYL40zCTx,wvk1k9buST3EOhLRys9
slYKaMRsXbMSuz3iHfA$<WLC>AQEBIQAB///QgcWXs1rLFOkfnLaMbSpR5sFnSmYb
dL0ZcysI1rlNaK9yrCLeW3aidzf+WNvFg86RqwInXo3s+nsLU7rOtdOxoIxYZAo3L
YmUJ+MFzsqlhKoJVlPyEvQ8H21MNUjVbhoN0gyIWsyiJaM8AQIkVBQFzhr10GYolV
zdzfJfEPQIx6tZ++/Vtc/q3SF/5Ko8XCY=</WLC>
Comment:
Hash: Rox9tmRbNJOygotZlWYmr0OOvY4=
Store Index: 1
License: 11 DS_License 1.0 LONG TRIAL DISABLED 1440 DISABLED STANDALONE AD
D 8_KEYS INFINITE_KEYS NEVER NEVER NiL SLM_CODE DEMO NiL NiL Ni N
iL NiL 5_MINS NiL Hp5gBr76OsVcoCNVW8Hi33rQs2xMyd5YU6sDI6oQSdVTrxI
vaLwepwAB4GXyk1zvLP$<WLC>AQEBIQAB//8c0JDyC40fqQGUTylDKqaN/AyL43ZV
PdJH0HolJAgOF5mjctCLuw5RaXRSPAJ09LaRqwInXo3s+nsLU7rOtdOxoIxYZAo3L
YmUJ+MFzsqlhKoJVlPyEvQ8H21MNUjVbhoN0gyIWsyiJaM8AQIkVBQFzhr10GYolV
zdzfJfEPQIx6tZ++/Vtc/q3SF/5Ko8XCY=</WLC>
Comment:
Hash: 3bm6gofelRl4J0rO/J44poj+dEY=
Related Commands
Command Description
license boot module Boots a new software license.
license call-home install Installs a license using the Cisco License Call Home
feature.
license call-home resend Restores a lost license by using the Cisco License
Call Home feature.
license call-home revoke Revokes and transfers a license by using the Cisco
License Call Home feature.
Cisco 860, 880, and 890 Series Routers, and Cisco 1900, 2900, and 3900 Series Integrated Services Router
Platforms
show license call-home pak pak-id
12.4(20)T This command was integrated into Cisco IOS Release 12.4(20)T.
12.2(33)SCC This command was integrated into Cisco IOS Release 12.2(33)SCC on
the Cisco uBR10012 universal broadband router.
Cisco IOS XE Release 3.3SG This command was integrated into Cisco IOS XE Release 3.3SG on the
Cisco Catalyst 4500E series switch.
15.1(1)SG This command was integrated into Cisco IOS Release15.1(1)SG on the
Cisco Catalyst 4500E series switch.
Usage Guidelines The Cisco License Call Home feature allows a Cisco router to communicate with the Cisco licensing
infrastructure through the Internet and retrieve licensing information. This command requires that the router
be connected to the Internet.
This command requires the following:
• The router or switch must have an Internet connection and use HTTPS to connect to the Cisco licensing
infrastructure. To set up a secure HTTP connection, see the HTTP 1.1 Web Server and Client module
in the Cisco IOS Network Management Configuration Guide.
• Only certain platforms support the Cisco License Call Home feature, and those devices must be running
a Cisco IOS crypto K9 image.
• You must obtain the device certificate from the Cisco licensing infrastructure.
• You need a Cisco.com user login account.
Issuing the show license call-home command causes these actions to occur:
• The Cisco licensing infrastructure returns parsed XML content to the command line. The parsed content
contains information about SKUs and feature names. The content might also contain warning messages.
• The SKU information and any warning messages are displayed as formatted output on the router command
line.
Examples The following example shows the PAKs and SKUs associated with a software license:
Field Description
Pak Number Product authorization key number, which is provided
to you when you order and 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.
SKU Name Stock keeping unit name, which maps to one or more
Cisco software features.
Related Commands
Command Description
license call-home install Installs a license by using the Cisco License Call
Home feature.
license call-home resend Restores a lost license by using the Cisco License
Call Home feature.
license call-home revoke Rehosts (revokes and transfers) a license by using the
Cisco License Call Home feature.
Command Default
Command Modes
Usage Guidelines
Examples
Related Commands
Command Description
Cisco 860, 880, and 890 Series Routers, and Cisco 1900, 2900, and 3900 Series Integrated Services Router
Platforms
show license statistics
12.4(20)T This command was integrated into Cisco IOS Release 12.4(20)T.
12.2(33)SCC This command was integrated into Cisco IOS Release 12.2(33)SCC on
Cisco uBR10012 universal broadband routers.
12.2(33)SCD This command was modified. The slot slot keyword and argument were
added for the Cisco uBR7225VXR and Cisco uBR7246VXR routers.
Cisco IOS XE Release 3.5S This command was modified. The standby keyword was added for the
Cisco ASR 903 router.
Examples The following is sample output from the show license statistics command:
Examples The following is sample output from the show license statistics subslot 8/1 command executed on the Cisco
uBR10012 router:
Field Description
Administrative statistics
• Install success count--Number of successful
installations
• Install failure count--Number of failed
installation attempts
• Install duplicate count--Number of duplicate
installations
• Comment add count--Number of added
comments
• Comment delete count--Number of deleted
comments
• Clear count--Number of License Clear events
• Save count--Number of License Save events
• Save cred count--Number of License Save
Credentials
Field Description
Client statistics
• Request success count--Number of successful
license requests
• Request failure count--Number of failed license
requests
• Release count--Number of released licenses
• Global Notify count--Number of global
notifications
Examples The following is sample output from the show license statistics slot 5 command executed on the Cisco
uBR7246VXR router:
Field Description
Administrative statistics
• Install success count--Number of successful
installations
• Install failure count--Number of failed
installation attempts
• Install duplicate count--Number of duplicate
installations
• Comment add count--Number of added
comments
• Comment delete count--Number of deleted
comments
• Clear count--Number of License Clear events
• Save count--Number of License Save events
• Save cred count--Number of License Save
Credentials
Client statistics
• Request success count--Number of successful
license requests
• Request failure count--Number of failed license
requests
• Release count--Number of released licenses
• Global Notify count--Number of global
notifications
Related Commands
Command Description
debug license Enables controlled debugging options in the Cisco
software licensing module.
12.4(20)T This command was integrated into Cisco IOS Release 12.4(20)T.
Usage Guidelines Use this command to display license information and to help with troubleshooting issues related to Cisco IOS
software licenses.
Examples The following is sample output that shows the subsystem running the IP base feature set:
Field Description
License level Feature set for which the license is issued; for
example, Advanced IP services, IP services, or IP
base.
12.0(2)T The rsvp notification type was added in Cisco IOS Release 12.0(2)T.
12.0(3)T The hsrp notification type was added in Cisco IOS Release 12.0(3)T.
12.0(24)S This command was integrated into Cisco IOS Release 12.0(24)S.
12.2(14)SX Support for this command was implemented on the Supervisor Engine 720.
12.2(18)S This command was integrated into Cisco IOS Release 12.2(18)S.
12.2(17d)SXB Support for this command on the Supervisor Engine 2 was integrated into
Cisco IOS Release 12.2(17d)SXB.
12.3(11)T The vrrpnotification type was added in Cisco IOS Release 12.3(11)T.
12.4(4)T Support for the alarms severity notification type and argument was added in
Cisco IOS Release 12.4(4)T. Support for the dsp and dsp oper-state
notification types was added in Cisco IOS Release 12.4(4)T.
12.2(28)SB This command was integrated into Cisco IOS Release 12.2(28)SB.
Release Modification
12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA.
12.4(11)T The dot1x notification type was added in Cisco IOS Release 12.4(11)T.
12.2(33)SRB This command was integrated into Cisco IOS Release 12.2(33)SRB.
12.2SX This command is supported in the Cisco IOS Release 12.2SX train. Support
in a specific 12.2SX release of this train depends on your feature set, platform,
and platform hardware.
12.2(33)SXH The l2tc keyword was added and supported on the Catalyst 6500 series switch.
12.2(33)SXI The following keywords were added and supported on the Catalyst 6500
series switch:
auth-fail-vlan
entity-diag
guest-vlan
module-auto-shutdown
no-auth-fail-vlan
no-guest-vlan
sys-threshold
Cisco IOS XE Release 2.6 This command was integrated into Cisco IOS XE Release 2.6.
For additional notification types, see the Related Commands table for this command.
SNMP notifications can be sent as traps or inform requests. This command enables both traps and inform
requests for the specified notification types. To specify whether the notifications should be sent as traps or
informs, use the snmp-server host [traps | informs] command.
To configure the router to send these SNMP notifications, you must enter at least one snmp-server enable
traps command. If you enter the command with no keywords, all notification types are enabled. If you enter
the command with a keyword, only the notification type related to that keyword is enabled. To enable multiple
types of notifications, you must issue a separate snmp-server enable traps command for each notification
type and notification option.
Most notification types are disabled by default but some cannot be controlled with the snmp-server enable
traps command.
The snmp-server enable traps command is used in conjunction with the snmp-server host command. Use
the snmp-server host command to specify which host or hosts receive SNMP notifications. To send
notifications, you must configure at least one snmp-server host command.
The following MIBs were enhanced or supported in Cisco IOS Release 12.2(33)SXI and later releases on the
Catalyst 6500 series switch:
• CISCO-L2-TUNNEL-CONFIG-MIB-LLDP--Enhancement. The CISCO-L2-TUNNEL-CONFIG-MIB
provides SNMP access to the Layer 2 tunneling-related configurations.
• CISCO-PAE-MIB--Enhancement for critical condition and includes traps when the port goes into the
Guest Vlan or AuthFail VLAN.
• CISCO-MODULE-AUTO-SHUTDOWN-MIB--Supported. The
CISCO-MODULE-AUTO-SHUTDOWN-MIB provides SNMP access to the Catalyst 6500 series switch
Module Automatic Shutdown component.
• CISCO-AUTH-FRAMEWORK-MIB--Supported. The CISCO-AUTH-FRAMEWORK-MIB provides
SNMP access to the Authentication Manager component.
• CISCO-ENTITY-DIAG-MIB--The CISCO-ENTITY-DIAG-MIB provides SNMP traps for generic
online diagnostics (GOLD) notification enhancements.
Examples The following example shows how to enable the router to send all traps to the host specified by the name
myhost.cisco.com, using the community string defined as public:
Related Commands
Command Description
snmp-server enable traps atm pvc Enables ATM PVC SNMP notifications.
snmp-server enable traps atm pvc extension Enables extended ATM PVC SNMP notifications.
snmp-server enable traps bgp Enables BGP server state change SNMP notifications.
snmp-server enable traps calltracker Enables Call Tracker callSetup and callTerminate
SNMP notifications.
snmp-server enable traps frame-relay Enables Frame Relay DLCI link status change SNMP
notifications.
snmp-server enable traps memory Enables memory pool and buffer pool SNMP
notifications.
snmp-server enable traps mpls ldp Enables MPLS LDP SNMP notifications.
snmp-server enable traps mpls traffic-eng Enables MPLS TE tunnel state-change SNMP
notifications.
snmp-server enable traps mpls vpn Enables MPLS VPN specific SNMP notifications.
Command Description
snmp-server enable traps snmp Enables RFC 1157 SNMP notifications.
snmp-server enable traps syslog Enables the sending of system logging messages via
SNMP.
snmp-server trap illegal-address Issues an SNMP trap when a MAC address violation
is detected on an Ethernet hub port of a Cisco 2505,
Cisco 2507, or Cisco 2516 router.
snmp-server host
To specify the recipient of a Simple Network Management Protocol (SNMP) notification operation, use the
snmp-server host command in global configuration mode. To remove the specified host from the configuration,
use the no form of this command.
snmp-server host {hostname| ip-address} [vrf vrf-name| informs| traps| version {1| 2c| 3 [auth| noauth|
priv]}] community-string [udp-port port [ notification-type ]| notification-type]
no snmp-server host {hostname| ip-address} [vrf vrf-name| informs| traps| version {1| 2c| 3 [auth| noauth|
priv]}] community-string [udp-port port [ notification-type ]| notification-type]
Command Syntax on Cisco ME 3400, ME 3400E, and Catalyst 3750 Metro Switches
snmp-server host ip-address {community-string| informs| traps} {community-string| version {1| 2c| 3 {auth|
noauth}}} {community-string| vrf vrf-name {informs| traps}} [notification-type]
no snmp-server host ip-address {community-string| informs| traps} {community-string| version {1| 2c| 3
{auth| noauth}}} {community-string| vrf vrf-name {informs| traps}} [notification-type]
Syntax Description hostname Name of the host. The SNMP notification host is
typically a network management station (NMS) or
SNMP manager. This host is the recipient of the
SNMP traps or informs.
Command Default This command behavior is disabled by default. A recipient is not specified to receive notifications.
Release Modification
12.0(3)T This command was modified.
• The version 3 [auth | noauth | priv] syntax was added as part of the
SNMPv3 Support feature.
• The hsrp notification-type keyword was added.
• The voice notification-type keyword was added.
12.1(3)T This command was modified. The calltracker notification-type keyword was
added for the Cisco AS5300 and AS5800 platforms.
Release Modification
12.3(8)T This command was modified. The iplocalpool notification-type keyword was
added for the Cisco 7200 and 7301 series routers.
12.3(11)T This command was modified. The vrrp keyword was added.
12.4(20)T This command was modified. The license notification-type keyword was added.
12.0(21)ST This command was modified. The mpls-ldp notification-type keyword was
added.
12.0(26)S This command was modified. The memory notification-type keyword was
added.
Release Modification
12.0(27)S This command was modified.
• Support for SNMP over IPv6 transport was added. Either an IP or IPv6
Internet address can be specified as the hostname argument.
• The vrf vrf-name keyword and argument combination was added to
support multiple Lightweight Directory Protocol (LDP) contexts for
VPNs.
12.2(18)S This command was integrated into Cisco IOS Release 12.2(18)S.
12.2(28)SB This command was integrated into Cisco IOS Release 12.2(28)SB.
12.2(33)SRA This command was integrated into Cisco IOS Release 12.2(33)SRA.
12.2(33)SXH This command was integrated into Cisco IOS Release 12.2(33)SXH.
12.2(33)SB This command was integrated into Cisco IOS Release 12.2(33)SB.
12.2(54)SE This command was modified. See the snmp-server host, on page 103 for the
command syntax for these switches.
12.2(33)SXJ This command was integrated into Cisco IOS Release 12.2(33)SXJ. The public
storm-control notification-type keyword was added.
15.0(1)S This command was modified. The flowmon notification-type keyword was
added.
Release Modification
Cisco IOS XE Release 2.1 This command was integrated into Cisco IOS XE Release 2.1.
Usage Guidelines If you enter this command with no optional keywords, the default is to send all notification-type traps to the
host. No informs will be sent to the host.
The no snmp-server host command with no keywords disables traps, but not informs, to the host. To disable
informs, use the no snmp-server host informs command.
Note If a community string is not defined using the snmp-server community command prior to using this
command, the default form of the snmp-server community command will automatically be inserted into
the configuration. The password (community string) used for this automatic configuration of the
snmp-server community command will be the same as that specified in the snmp-server host command.
This automatic command insertion and use of passwords is the default behavior for Cisco IOS Release
12.0(3) and later releases. However, in Cisco IOS Release 12.2(33)SRE and later releases, you must
manually configure the snmp-server community command. That is, the snmp-server community
command will not be seen in the configuration.
SNMP notifications can be sent as traps or inform requests. Traps are unreliable because the receiver does
not send acknowledgments when it receives traps. The sender cannot determine if the traps were received.
However, an SNMP entity that receives an inform request acknowledges the message with an SNMP response
protocol data unit (PDU). If the sender never receives the response, the inform request can be sent again.
Thus, informs are more likely to reach their intended destination than traps.
Compared to traps, informs consume more resources in the agent and in the network. Unlike a trap, which is
discarded as soon as it is sent, an inform request must be held in memory until a response is received or the
request times out. Also, traps are sent only once; an inform may be tried several times. The retries increase
traffic and contribute to a higher overhead on the network.
If you do not enter an snmp-server host command, no notifications are sent. To configure the router to send
SNMP notifications, you must enter at least one snmp-server host command. If you enter the command with
no optional keywords, all trap types are enabled for the host.
To enable multiple hosts, you must issue a separate snmp-server host command for each host. You can
specify multiple notification types in the command for each host.
When multiple snmp-server host commands are given for the same host and kind of notification (trap or
inform), each succeeding command overwrites the previous command. Only the last snmp-server host
command will be in effect. For example, if you enter an snmp-server host inform command for a host and
then enter another snmp-server host inform command for the same host, the second command will replace
the first.
The snmp-server host command is used in conjunction with the snmp-server enable command. Use the
snmp-server enable command to specify which SNMP notifications are sent globally. For a host to receive
most notifications, at least one snmp-server enable command and the snmp-server host command for that
host must be enabled.
Some notification types cannot be controlled with the snmp-server enable command. Some notification types
are always enabled, and others are enabled by a different command. For example, the linkUpDown notifications
are controlled by the snmp trap link-status command. These notification types do not require an snmp-server
enable command.
The availability of notification-type options depends on the router type and the Cisco IOS software features
supported on the router. For example, the envmon notification type is available only if the environmental
monitor is part of the system. To see what notification types are available on your system, use the command
help ? at the end of the snmp-server host command.
The vrf keyword allows you to specify the notifications being sent to a specified IP address over a specific
VRF VPN. The VRF defines a VPN membership of a user so that data is stored using the VPN.
In the case of the NMS sending the query having a correct SNMP community but not having a read or a write
view, the SNMP agent returns the following error values:
• For a get or a getnext query, returns GEN_ERROR for SNMPv1 and AUTHORIZATION_ERROR for
SNMPv2C.
• For a set query, returns NO_ACCESS_ERROR.
Notification-Type Keywords
The notification type can be one or more of the following keywords.
Note The available notification types differ based on the platform and Cisco IOS release. For a complete list
of available notification types, use the question mark (?) online help function.
• aaa server --Sends SNMP authentication, authorization, and accounting (AAA) traps.
• adslline --Sends Asymmetric Digital Subscriber Line (ADSL) LINE-MIB traps.
• atm --Sends ATM notifications.
• authenticate-fail --Sends an SNMP 802.11 Authentication Fail trap.
• auth-framework --Sends SNMP CISCO-AUTH-FRAMEWORK-MIB notifications.
• bgp --Sends Border Gateway Protocol (BGP) state change notifications.
• bridge --Sends SNMP STP Bridge MIB notifications.
• bstun --Sends Block Serial Tunneling (BSTUN) event notifications.
• bulkstat --Sends Data-Collection-MIB notifications.
• c6kxbar --Sends SNMP crossbar notifications.
• callhome --Sends Call Home MIB notifications.
• calltracker -- Sends Call Tracker call-start/call-end notifications.
• casa --Sends Cisco Appliances Services Architecture (CASA) event notifications.
• ccme --Sends SNMP Cisco netManager Event (CCME) traps.
• cef --Sends notifications related to Cisco Express Forwarding.
• chassis --Sends SNMP chassis notifications.
• cnpd --Sends Cisco Network-based Application Recognition (NBAR) Protocol Discovery (CNPD)
traps.
• config --Sends configuration change notifications.
• config-copy --Sends SNMP config-copy notifications.
• config-ctid --Sends SNMP config-ctid notifications.
• cpu --Sends CPU-related notifications.
• csg --Sends SNMP Content Services Gateway (CSG) notifications.
• deauthenticate --Sends an SNMP 802.11 Deauthentication trap.
• dhcp-snooping --Sends DHCP snooping MIB notifications.
• director --Sends notifications related to DistributedDirector.
• disassociate --Sends an SNMP 802.11 Disassociation trap.
• dlsw --Sends data-link switching (DLSW) notifications.
• dnis --Sends SNMP Dialed Number Identification Service (DNIS) traps.
• dot1x --Sends 802.1X notifications.
• dot11-mibs --Sends dot11 traps.
• dot11-qos --Sends SNMP 802.11 QoS Change trap.
• ds1 --Sends SNMP digital signaling 1 (DS1) notifications.
• ds1-loopback --Sends ds1-loopback traps.
• dspu --Sends downstream physical unit (DSPU) notifications.
• eigrp --Sends Enhanced Interior Gateway Routing Protocol (EIGRP) stuck-in-active (SIA) and neighbor
authentication failure notifications.
• energywise --Sends SNMP energywise notifications.
• entity --Sends Entity MIB modification notifications.
• entity-diag --Sends SNMP entity diagnostic MIB notifications.
• envmon --Sends Cisco enterprise-specific environmental monitor notifications when an environmental
threshold is exceeded.
• errdisable --Sends error disable notifications.
• ethernet-cfm --Sends SNMP Ethernet Connectivity Fault Management (CFM) notifications.
• event-manager --Sends SNMP Embedded Event Manager notifications.
• firewall --Sends SNMP Firewall traps.
• flash --Sends flash media insertion and removal notifications.
• flexlinks --Sends FLEX links notifications.
• flowmon --Sends flow monitoring notifications.
• frame-relay --Sends Frame Relay notifications.
Note To enable RFC-2233-compliant link up/down notifications, you should use the snmp
server link trap command.
6 See the Cisco IOS Multiprotocol Label Switching Command Reference for documentation of this command.
Examples If you want to configure a unique SNMP community string for traps but prevent SNMP polling access with
this string, the configuration should include an access list. The following example shows how to name a
community string comaccess and number an access list 10:
Note The “at” sign (@) is used as a delimiter between the community string and the context in which it is used.
For example, specific VLAN information in BRIDGE-MIB may be polled using community @VLAN-ID
(for example, public@100), where 100 is the VLAN number.
The following example shows how to send RFC 1157 SNMP traps to a specified host named myhost.cisco.com.
Other traps are enabled, but only SNMP traps are sent because only snmp is specified in the snmp-server
host command. The community string is defined as comaccess.
The following example shows how to enable all NHRP traps, and how to send all NHRP traps to the notification
receiver with the IP address 10.0.0.0 using the community string public:
Related Commands
Command Description
show snmp host Displays recipient details configured for SNMP
notifications.
snmp-server enable peer-trap poor qov Enables poor quality of voice notifications for
applicable calls associated with a specific voice dial
peer.
snmp-server enable traps nhrp Enables SNMP notifications (traps) for NHRP.