Table Of Contents
Cisco IOS Software Activation Commands
license boot module
license call-home install pak
license call-home resend
license call-home revoke
license call-home url
license clear
Cisco IOS Software Activation Commands
license boot module
To configure a new software license, use the license boot module command in global configuration mode.
license boot module module-name level license-level switch-id
Cisco uBR10012 Universal Broadband Router
license boot module module-name technology-package package-name {disable}
no license boot module module-name technology-package package-name {disable}
Syntax Description
module-name
|
Module to be configured (for example: c880-data).
|
level license-level
|
Level at which the given module should boot (for example, advipservices).
|
switch-id
|
Switch or slot ID in a stackable environment.
|
module-name
|
Router to be configured (for example: c3900).
|
technology-package
|
Keyword for upgrading or downgrading a software license, or for enabling or disabling an evaluation license
|
package-name
|
Package or feature set the given module should boot (for example, data).
|
disable
|
Disables the package or feature set.
|
Command Modes
Global configuration mode
Command History
Release
|
Modification
|
12.4(15)XZ
|
This command was introduced.
|
12.4(20)T
|
This command was integrated into Cisco IOS Release 12.4(20)T.
|
15.0(1)M
|
This command was implemented on the Cisco 3900 Series, 2900 Series, and on the 1900 Series Integrated Services Router platforms. The technology-package command name was added.
|
Usage Guidelines
The license boot module command is used for the following 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.
1.
When rebooting the router, the licensing infrastructure checks the configuration in the startup-config/rommon for any licenses. If there is a license, the router boots with that license. If there is no license in the configuration, the licensing infrastructure follows the image hierarchy to check for licenses.
2.
If the forced boot evaluation license expires, the licensing infrastructure follows the regular hierarchy to check for licenses.
3.
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 module-name level license-level 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 configure a license:
Router(config)# license boot module c880-data level advipservices
The following example shows how to enable an evaluation license:
Router(config)# license boot module c3900 technology-package data
The following example shows how to make an evaluation license inactive:
Router(config)# no license boot module c3900 technology-package data
Related Commands
Command
|
Description
|
license install
|
Installs a license stored in a license file on a device.
|
license save
|
Saves a copy of a permanent license in a specified license file.
|
license call-home install pak
To install a license using a product authorization key (PAK) and the Cisco License Call Home feature, use the license call-home install command in privileged EXEC mode.
license call-home install pak pak-id
Note
The Cisco License Call Home feature allows a Cisco router to communicate with the Cisco licensing infrastructure via the Internet and retrieve licensing information. This command requires that the router be connected to the Internet.
Syntax Description
pak
|
The product authorization key.
|
pak-id
|
A product authorization key sent via e-mail or regular mail by manufacturing to authorize software upgrades.
|
Command Modes
Privileged EXEC (#)
Command History
Release
|
Modification
|
12.2(35)SE2
|
This command was introduced.
|
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.
|
Usage Guidelines
This command requires the following:
•
The router or switch must have an Internet connection and use HTTPS to connect to the Cisco licensing infrastructure. See the "HTTP 1.1 Web Server and Client" chapter in the Cisco IOS Network Management Configuration Guide, Release 12.4T, for the procedure to set up a secure HTTP connection.
•
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 also need a CCO 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).
Issuing the license call-home install command initiates several actions, as follows:
1.
Information about the stock keeping unit (SKU) is displayed, which maps 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, 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 using a PAK and the Cisco License Call Home feature. Use the show license feature command to verify the installation.
Router# license call-home install pak 3XPXR9E7D30
CCO password : ************
Pak Fulfillment type: SINGLE
Feature name: gatekeeper Count: Uncounted
Do you want to install the above listed SKU(s)? [yes/no]: yes
Please enter the user's detail:
Title : Software Engineer
Company Name : Cisco Systems
Address1 : 510 McCarthy Blvd.
Installing...Feature:gatekeeper...Successful
Related Commands
Command
|
Description
|
license call-home resend
|
Restores a lost license using the Cisco License Call Home feature.
|
license call-home revoke
|
Revokes and transfers a license using the Cisco License Call Home feature.
|
show license call-home
|
Displays the SKU list and features available in a PAK using the Cisco License Call Home feature.
|
license call-home resend
To request a license be resent using the Cisco License Call Home feature, use the license call-home resend command in privileged EXEC mode.
license call-home resend dest-lic-location
Note
The Cisco License Call Home feature allows a Cisco router to communicate with the Cisco licensing infrastructure via the Internet and retrieve licensing information. This command requires that the router be connected to the Internet.
Syntax Description
dest-lic-location
|
Indicates the location where the Cisco IOS software license is to be stored. Valid location file systems are archive, bs, flash, flashn, 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 flashn file system, where n 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.
|
Command Modes
Privileged EXEC (#)
Command History
Release
|
Modification
|
12.2(35)SE2
|
This command was introduced.
|
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.
|
Usage Guidelines
This command contacts Cisco's licensing back end and obtains licenses that are valid for a specified Universal 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.
•
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 the steps in this section.
•
You also need a CCO user login account.
Use this command to obtain licenses stored in the specified destination URL. Following is a summary of the actions initiated by this command:
1.
The device credential is retrieved from the device and sent to the Cisco licensing infrastructure.
2.
This command invokes the Cisco licensing infrastructure to request all licenses with the device credential information be sent to the device. The Cisco licensing infrastructure will provide all purchased licenses for the given UDI.
3.
This command stores all licenses in the destination URL.
Examples
The following example shows the commands, prompts, and responses required to request a license be sent from the Cisco licensing infrastructure and store it in the requested destination using the License Call Home feature:
Router# license call-home resend flash:licenseresend.xml
CCO password : ************
Email Address: User1@cisco.com
Alternate Email Address: User1@cisco.com
Getting Licenses from SWIFT ..........
Saving it to flash:licenseresend.xml.....Done
Related Commands
Command
|
Description
|
license call-home install
|
Installs a license using the Cisco License Call Home feature.
|
license call-home revoke
|
Revokes and transfers a license using the Cisco License Call Home feature.
|
show license call-home
|
Displays the SKU list and features available in a PAK using the Cisco License Call Home feature.
|
license call-home revoke
To rehost (revoke and transfer) a license using Universal Device Identifiers (UDIs) and the Cisco License Call Home feature, use the license call-home revoke command in privileged EXEC mode.
license call-home revoke [target-udi] output-of-rehosted-license-url [permission-ticket-url]
[rehost-ticket-url]
Note
The Cisco License Call Home feature allows a Cisco router to communicate with the Cisco licensing infrastructure via the Internet and retrieve licensing information. This command requires that the router be connected to the Internet.
Syntax Description
target-udi
|
(Optional) The target Universal Device Identifier.
|
output-of-rehosted-license-url
|
(Optional) Output received from the rehosted license URL.
|
permission-ticket-url
|
(Optional) The path to the permission ticket, which will be used for the call-home revoke process.
|
rehost-ticket-url
|
(Optional) The path to the rehost ticket, which will be used for the call-home revoke process.
|
Command Modes
Privileged EXEC (#)
Command History
Release
|
Modification
|
12.4(15)XZ
|
This command was introduced.
|
12.4(20)T
|
This command was integrated into Cisco IOS Release 12.4(20)T.
|
Usage Guidelines
If you do not specify a target UDI, the rehost ticket is stored at 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 URL specified. If one of the operation fails in the callhome revoke operations, then 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.
•
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 also need a CCO user login account.
The license call-home revoke EXEC command performs following 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 get the SKU details for this UDI from Cisco's licensing portal. The request will contain the source UDI.
3.
Cisco's licensing portal will respond that either the target UDI is not correct or it will list the SKUs available on the device for rehosting.
4.
The Cisco licensing infrastructure requests the permission ticket from the Cisco's licensing portal by providing the SKU and user's e-mail address.
5.
Cisco's licensing portal provides the permission's file to the Cisco licensing infrastructure.
6.
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.
Cisco's licensing back end generates a new license file and sends it using the e-mail address collected in the prompts.
Examples
The following example shows the commands, prompts, and responses to revoke a license, with the Cisco License Call Home feature, using UDIs:
Router# $license call-home revoke udi CISCO887W:FHH1124P02Y flash:REHOSTED_LICENSE
Retrieving the sku from swift ..........!.....................
Description : For Internal purposes only
Feature name: lwapp Count: Uncounted
Description : For Internal purposes only
Feature name: advipservices Count: Uncounted
Description : For Internal purposes only
Feature name: lwapp Count: Uncounted
Description : For Internal purposes only
Feature name: advsecurity Count: Uncounted
Please select the sku number you want to revoke : 3
Retrieving the permission ticket from swift ..........!... Output file saved ..... to
flash: REHOSTED_LICENSE
Retrieving the rehost ticket from the device ....................!.
Following Permanent license(s) will be revoked from this device
Following Extension license(s) will be installed on this device
PLEASE READ THE FOLLOWING TERMS CAREFULLY. INSTALLING THE LICENSE OR
LICENSE KEY PROVIDED FOR ANY CISCO PRODUCT FEATURE OR USING SUCH
PRODUCT FEATURE CONSTITUTES YOUR FULL ACCEPTANCE OF THE FOLLOWING
TERMS. YOU MUST NOT PROCEED FURTHER IF YOU ARE NOT WILLING TO BE BOUND
BOUND BY ALL THE TERMS SET FORTH HEREIN.
You hereby acknowledge and agree that the product feature license
is terminable and that the product feature enabled by such license
may be shut down or terminated by Cisco after expiration of the
applicable term of the license (e.g., 30-day trial period). Cisco
reserves the right to terminate or shut down any such product feature
electronically or by any other means available. While alerts or such
messages may be provided, it is your sole responsibility to monitor
your terminable usage of any product feature enabled by the license
and to ensure that your systems and networks are prepared for the shut
down of the product feature. You acknowledge and agree that Cisco will
not have any liability whatsoever for any damages, including, but not
limited to, direct, indirect, special, or consequential damages related
to any product feature being shutdown or terminated. By clicking the
"accept" button or typing "yes" you are indicating you have read and
agree to be bound by all the terms provided herein.
Output file saved ..... to flash: REHOSTED_LICENSE
Retrieving the revoked license line from the swift ..........Output file saved ..... to
flash: REHOSTED_LICENSE
Related Commands
Command
|
Description
|
license call-home install
|
Installs a license using the Cisco License Call Home feature.
|
license call-home resend
|
Restores a lost license using the Cisco License Call Home feature.
|
show license call-home
|
Displays the SKU list and features available in a PAK using the Cisco License Call Home feature.
|
license call-home url
To configure a new URL for accessing the Cisco licensing infrastructure, use the license call-home url command in global configuration mode. To change the URL, use the no form of this command.
license call-home url licensing-infrastructure-url
no license call-home url
Syntax Description
licensing-infrastructure-url
|
The HTTP address where the Cisco licensing infrastructure can be accessed.
|
Command Modes
Global configuration (config)
Command History
Release
|
Modification
|
12.4(15)XZ
|
This command was introduced.
|
12.4(20)T
|
This command was integrated into Cisco IOS Release 12.4(20)T.
|
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.
•
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 also need a CCO user login account.
Examples
The following example shows how to change the URL to http://cisco.com/newserver:
license call-home url http://cisco.com/newserver
Related Commands
Command
|
Description
|
license call-home install
|
Installs a license using the Cisco License Call Home feature.
|
license call-home resend
|
Restores a lost license using the Cisco License Call Home feature.
|
license call-home revoke
|
Revokes and transfers a license using the Cisco License Call Home feature.
|
show license call-home
|
Displays the SKU list and features available in a PAK 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 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
feature-name
|
Name of the feature to be removed.
|
switch
|
(Optional) Specifies a switch in a switch stack.
Specifies a switch in a mixed switch stack.
|
switch-num
|
(Optional) Integer from 1 to 9 that identifies a switch in a switch stack.
Integer from 1 to 9 that identifies a switch in a mixed switch stack.
|
Command Default
Licenses are not removed.
Command Modes
Privileged EXEC (#)
Command History
Release
|
Modification
|
12.2(35)SE2
|
This command was introduced.
|
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.
|
Usage Guidelines
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 needed to support the licensing operations of the secondary switches. The license clear command is used to clear 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.
If a license line is in use, the license clear command fails.
Examples
The following example shows how to clear a license associated with the advsecurity feature:
Router# license clear advsecurity
1 License Type: Permanent
Start Date: N/A, End Date: Jan 01 2010
License State: Active, In Use
License Addition: Exclusive
Comment: Permanent License
Store Name: Primary License Storage
2 License Type: Evaluation
Evaluation total period: 8 weeks 4 days
Evaluation period left: 8 weeks 4 days
License Addition: Additive
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 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 file
|
Displays information in a Cisco IOS software license file.
|