Cisco Smart Licensing Client
Cisco Smart Licensing Client
• License Flexibility: Your software is not node-locked to your hardware, so you can easily use and transfer
licenses as needed.
To use Smart Licensing, you must first set up a Smart Account on Cisco Software Central (software.cisco.com).
For a more detailed overview on Cisco Licensing, go to cisco.com/go/licensingguide.
Note Licenses are managed as Smart licenses from Cisco IOS XE Fuji 16.9.1 and later. Right-to-Use licenses are
deprecated from Cisco IOS XE Fuji 16.9.1.
Overview of CSSM
CSSM enables you to manage all your Cisco smart software licenses from one centralized portal. With CSSM,
you can organize and view your licenses in groups called virtual accounts (collections of licenses and product
instances).
You can access the CSSM on https://software.cisco.com/#, by clicking the Smart Software Licensing link
under the License tab.
Note Use a Chrome 32.0, Firefox 25.0, or Safari 6.0.5 web browser to access CSSM. Also, ensure that Javascript
1.5 or a later version is enabled in your browser.
CSSM Help describes the procedures for carrying out these tasks.
Connecting to CSSM
The following illustration shows the various options available to connect to CSSM:
1. Direct cloud access: In this method, Cisco products send usage information directly over the internet to
Cisco.com; no additional components are needed for the connection.
2. Direct cloud access through an HTTPs proxy: In this method, Cisco products send usage information over
the internet through a proxy server - either a Call Home Transport Gateway or an off-the-shelf proxy
(such as Apache) to Cisco.com.
3. Mediated access through a connected on-premises collector: In this method, Cisco products send usage
information to a locally-connected collector, which acts as a local license authority. Periodically, this
information is exchanged to keep the databases synchronized.
4. Mediated access through a disconnected on-premises collector: In this method, Cisco products send usage
information to a local disconnected collector, which acts as a local license authority. Exchange of
human-readable information takes place occasionally (maybe once a month) to keep the databases
synchronized.
Options 1 and 2 provide an easy connection option, and options 3 and 4 provide a secure environment
connection option. Cisco Smart Software Manager On-Prem (formerly known as Cisco Smart Software
Manager satellite) provides support for options 3 and 4.
SUMMARY STEPS
1. enable
2. configure terminal
3. {ip | ipv6} name-server server-address 1 [server-address 2] [server-address 3] [server-address 4]
[server-address 5] [server-address 6]
4. ip name-server vrf Mgmt-vrf server-address 1 [server-address 2] [server-address 3] [server-address
4] [server-address 5] [server-address 6]
5. ip domain lookup source-interface interface-type interface-number
6. ip domain name example.com
7. ip host tools.cisco.com ip-address
8. interface vlan_id
9. ntp server ip-address [version number] [key key-id] [prefer]
10. switchport access vlan vlan_id
11. ip route ip-address ip-mask subnet mask
12. license smart transport callhome
13. ip http client source-interface interface-type interface-number
14. exit
15. copy running-config startup-config
DETAILED STEPS
Step 3 {ip | ipv6} name-server server-address 1 [server-address Configures Domain Name System (DNS).
2] [server-address 3] [server-address 4] [server-address
5] [server-address 6]
Example:
Device(config)# ip name-server 209.165.201.1
209.165.200.225 209.165.201.14 209.165.200.230
Step 4 ip name-server vrf Mgmt-vrf server-address 1 (Optional) Configures DNS on the VRF interface.
[server-address 2] [server-address 3] [server-address 4]
Note You should configure this command as an
[server-address 5] [server-address 6]
alternative to the ip name-server command.
Example:
Device(config)# ip name-server vrf Mgmt-vrf
209.165.201.1 209.165.200.225 209.165.201.14
209.165.200.230
Step 5 ip domain lookup source-interface interface-type (Optional) Configures the source interface for the DNS
interface-number domain lookup.
Example:
Device(config)# ip domain lookup source-interface
Vlan100
Step 9 ntp server ip-address [version number] [key key-id] Forms a server association with the specified system.
[prefer]
Note The ntp server command is mandatory to
Example: ensure that the device time is synchronized with
CSSM.
Device(config)# ntp server 198.51.100.100 version
2 prefer
Step 11 ip route ip-address ip-mask subnet mask Configures a route on the device.
Example: Note You can configure either a static route or a
dynamic route.
Device(config)# ip route 192.0.2.0 255.255.255.255
192.0.2.1
Step 12 license smart transport callhome Enables the transport mode as Call Home.
Example: Note The license smart transport callhome
Device(config)# license smart transport callhome command is mandatory.
Step 13 ip http client source-interface interface-type Configures a source interface for the HTTP client.
interface-number
Note The ip http client source-interface
Example: interface-type interface-number command is
Device(config)# ip http client source-interface mandatory.
Vlan100
Step 15 copy running-config startup-config (Optional) Saves your entries in the configuration file.
Example:
Device# copy running-config startup-config
Note By default, the CiscoTAC-1 profile is already set up on the device. Use the show call-home profile all
command to check the profile status.
The Call Home service provides email-based and web-based notification of critical system events to CSSM.
To configure and enable the Call Home service, perform this procedure:
SUMMARY STEPS
1. enable
2. configure terminal
3. call-home
4. no http secure server-identity-check
5. contact-email-address email-address
6. profile CiscoTAC-1
7. destination transport-method http
8. destination address http url
9. active
10. no destination transport-method email
11. exit
12. exit
13. service call-home
14. exit
15. copy running-config startup-config
DETAILED STEPS
Step 4 no http secure server-identity-check Disables server identity check when HTTP connection is
established.
Example:
Device(config-call-home)# no http secure
server-identity-check
Step 5 contact-email-address email-address Assigns customer's email address. You can enter up to 200
characters in email address format with no spaces.
Example:
Device(config-call-home)# contact-email-addr
[email protected]
Step 6 profile CiscoTAC-1 By default, the CiscoTAC-1 profile is inactive. To use this
profile with the Call Home service, you must enable the
Example:
profile.
Device(config-call-home)# profile CiscoTAC-1
Step 7 destination transport-method http Enables the Call Home service via HTTP.
Example:
Step 10 no destination transport-method email Disables the Call Home service via email.
Example:
Device(config-call-home-profile)# no destination
transport-method email
Step 12 exit Exits Call Home configuration mode and returns to global
configuration mode.
Example:
Device(config-call-home)# exit
Step 15 copy running-config startup-config (Optional) Saves your entries in the configuration file.
Example:
Device# copy running-config startup-config
Configuring the Call Home Service for Direct Cloud Access through an HTTPs
Proxy Server
The Call Home service can be configured through an HTTPs proxy server. This configuration requires no
user authentication to connect to CSSM.
To configure and enable the Call Home service through an HTTPs proxy, perform this procedure:
SUMMARY STEPS
1. enable
2. configure terminal
3. call-home
4. contact-email-address email-address
5. http-proxy proxy-address proxy-port port-number
6. profile CiscoTAC-1
7. destination transport-method http
8. no destination transport-method email
9. profile name
10. reporting smart-licensing-data
11. destination transport-method http
12. destination address http url
13. active
14. exit
15. exit
16. service call-home
17. ip http client proxy-server proxy-address proxy-port port-number
18. exit
19. copy running-config startup-config
DETAILED STEPS
Step 5 http-proxy proxy-address proxy-port port-number Configures the proxy server information to the Call Home
service.
Example:
Device(config-call-home)# http-proxy 198.51.100.10
port 3128
Step 6 profile CiscoTAC-1 By default, the CiscoTAC-1 profile is inactive. To use this
profile with the Call Home service, you must enable the
Example:
profile.
Device(config-call-home)# profile CiscoTAC-1
Step 7 destination transport-method http Enables the Call Home service via HTTP.
Example:
Device(config-call-home-profile)# destination
transport-method http
Step 8 no destination transport-method email Disables the Call Home service via email.
Example:
Device(config-call-home-profile)# no destination
transport-method email
Step 9 profile name Enters Call Home destination profile configuration mode
for the specified destination profile name. If the specified
Example:
destination profile does not exist, it is created.
Device(config-call-home)# profile test1
Step 10 reporting smart-licensing-data Enables data sharing with the Call Home service via HTTP.
Example:
Device(config-call-home-profile)# reporting
smart-licensing-data
Step 11 destination transport-method http Enables the HTTP message transport method.
Example:
Device(config-call-home-profile)# destination
transport-method http
Step 15 exit Exits Call Home configuration mode and returns to global
configuration mode.
Example:
Device(config-call-home)# exit
Step 17 ip http client proxy-server proxy-address proxy-port Enables the Call Home feature.
port-number
Example:
Device(config)# ip http client proxy-server
198.51.100.10 port 3128
Step 19 copy running-config startup-config (Optional) Saves your entries in the configuration file.
Example:
Device# copy running-config startup-config
Configuring the Call Home Service for Cisco Smart Software Manager On-Prem
For information about Cisco Smart Software Manager On-Prem (formerly known as Cisco Smart Software
Manager satellite), see https://www.cisco.com/c/en/us/buy/smart-accounts/software-manager-satellite.html.
To configure the Call Home service for the Cisco Smart Software Manager On-Prem (formerly known as
Cisco Smart Software Manager satellite), perform this procedure:
SUMMARY STEPS
1. enable
2. configure terminal
3. call-home
4. no http secure server-identity-check
5. profile name
6. reporting smart-licensing-data
7. destination transport-method http
8. destination address http url
9. destination preferred-msg-format {long-text | short-text | xml}
10. active
11. exit
12. exit
13. ip http client source-interface interface-type interface-number
14. crypto pki trustpoint name
15. revocation-check none
16. end
17. copy running-config startup-config
DETAILED STEPS
Step 4 no http secure server-identity-check Disables server identity check when HTTP connection is
established.
Example:
Device(config-call-home)# no http secure
server-identity-check
Step 5 profile name Enters Call Home destination profile configuration mode
for the specified destination profile name. If the specified
Example:
destination profile does not exist, it is created.
Device(config-call-home)# profile test1
Step 6 reporting smart-licensing-data Enables data sharing with the Call Home service via HTTP.
Example:
Device(config-call-home-profile)# reporting
smart-licensing-data
Step 7 destination transport-method http Enables the HTTP message transport method.
Example:
Device(config-call-home-profile)# destination
transport-method http
Step 8 destination address http url Configures the destination URL (CSSM) to which Call
Home messages are sent.
Example:
Note
Step 9 destination preferred-msg-format {long-text | short-text (Optional) Configures a preferred message format. The
| xml} default is XML.
Example:
Device(config-call-home-profile)# destination
preferred-msg-format xml
Step 12 exit Exits Call Home configuration mode and returns to global
configuration mode.
Example:
Device(config-call-home)# exit
Step 13 ip http client source-interface interface-type Configures a source interface for the HTTP client.
interface-number
Note The ip http client source-interface
Example: interface-type interface-number command is
Device(config)# ip http client source-interface mandatory for a vrf interface.
Vlan100
Step 14 crypto pki trustpoint name (Optional) Declares the trustpoint and a given name and
enters ca-trustpoint configuration mode.
Example:
Device(config)# crypto pki trustpoint
SLA-TrustPoint
The required license level(s) needs to be configured on the device before registering. The following are the
license levels available for Cisco Catalyst 9000 Series Switches:
Base licenses
• Network Essentials
• Network Advantage (includes Network Essentials)
Add-on licenses—These can be subscribed for a fixed term of three, five, or seven years.
• Digital Networking Architecture (DNA) Essentials
• DNA Advantage (includes DNA Essentials)
SUMMARY STEPS
1. enable
2. configure terminal
3. license boot level license_level
4. exit
5. write memory
6. show version
7. reload
DETAILED STEPS
Step 3 license boot level license_level Activates the licenses on the switch.
Example:
Device(config)# license boot level
network-essentials
On successful registration, the device will receive an identity certificate. This certificate is saved on your
device and automatically used for all future communications with Cisco. CSSM will attempt to renew the
registration information every 30 days..
Additionally, license usage data is collected and a report is sent to you every month. If required, you can
configure your Call Home settings to filter out sensitive information (like hostname, username and password)
from the usage report.
Note Downgrading a device from Cisco IOS XE Fuji 16.9.1 to any prior release will migrate the smart license to
traditional license. All smart license information on the device will be removed. In case the device needs to
be upgraded back to Cisco IOS XE Fuji 16.9.1, the license status will remain in evaluation mode until the
device is registered again in CSSM.
Step 9 Check the Allow export-controlled functionality on the products registered with this token checkbox.
Enabling this checkbox ensures Cisco compliance with US and country-specific export policies and guidelines. For
more information, see https://www.cisco.com/c/en/us/about/legal/global-export-trade.html.
SUMMARY STEPS
1. enable
DETAILED STEPS
Step 2 license smart register idtoken token_ID Registers the device with the back-end server using the
token generated from CSSM.
Example:
Device# license smart register idtoken
$Tl4UytrNXBzbEs1ck8veUtWaG5abnZJOFdDa1FwbVRa%0AblRMbz0%3D%0A
Device> enable
Device# show license all
Smart Licensing Status
======================
Registration:
Status: REGISTERED
Smart Account: Smart Account Name
Virtual Account: Virtual Account 1
Export-Controlled Functionality: Allowed
Initial Registration: First Attempt Pending
Last Renewal Attempt: SUCCEEDED on Jul 19 14:49:49 2018 IST
Next Renewal Attempt: Jan 15 14:49:48 2019 IST
Registration Expires: Jul 19 14:43:48 2019 IST
License Authorization:
Status: AUTHORIZED on Jul 28 07:02:56 2018 IST
Last Communication Attempt: SUCCEEDED on Jul 28 07:02:56 2018 IST
Next Communication Attempt: Aug 27 07:02:56 2018 IST
Communication Deadline: Oct 26 06:57:50 2018 IST
Utility:
Status: DISABLED
Data Privacy:
Sending Hostname: yes
Callhome hostname privacy: DISABLED
Smart Licensing hostname privacy: DISABLED
Version privacy: DISABLED
Transport:
Type: Callhome
License Usage
==============
Product Information
===================
UDI: PID:C9200L-48P-4X,SN:JPG221300KP
Agent Version
=============
Smart Agent for Licensing: 4.4.13_rel/116
Component Versions: SA:(1_3_dev)1.0.15, SI:(dev22)1.2.1, CH:(rel5)1.0.3, PK:(dev18)1.0.3
Reservation Info
================
License reservation: DISABLED
SUMMARY STEPS
1. enable
2. license smart deregister
DETAILED STEPS
Command Purpose
Command Purpose
show license summary Displays the summary of all the active licenses.
Example
To display the Call Home profile, use the show call-home profile all command:
Device> enable
Device# show call-home profile all
Profile Name: CiscoTAC-1
Profile status: ACTIVE
Profile mode: Full Reporting
Reporting Data: Smart Call Home, Smart Licensing
Preferred Message Format: xml
Message Size Limit: 3145728 Bytes
Transport Method: http
HTTP address(es): https://tools.cisco.com/its/service/oddce/services/DDCEService
Other address(es): default
Periodic configuration info message is scheduled every 1 day of the month at 09:15
Periodic inventory info message is scheduled every 1 day of the month at 09:00
Alert-group Severity
------------------------ ------------
crash debug
diagnostic minor
environment warning
inventory normal
Syslog-Pattern Severity
------------------------ ------------
APF-.-WLC_.* warning
.* major
Example
To display the license entitlements, use the show license all command:
Device> enable
Device# show license all
Smart Licensing Status
======================
Registration:
Status: UNREGISTERED
Export-Controlled Functionality: Not Allowed
License Authorization:
Status: EVAL MODE
Evaluation Period Remaining: 68 days, 0 hours, 30 minutes, 5 seconds
Utility:
Status: DISABLED
Data Privacy:
Sending Hostname: yes
Callhome hostname privacy: DISABLED
Smart Licensing hostname privacy: DISABLED
Version privacy: DISABLED
Transport:
Type: Callhome
License Usage
==============
Product Information
===================
UDI: PID:C9200L-48P-4X,SN:JPG221300KP
Agent Version
=============
Smart Agent for Licensing: 4.4.13_rel/116
Component Versions: SA:(1_3_dev)1.0.15, SI:(dev22)1.2.1, CH:(rel5)1.0.3, PK:(dev18)1.0.3
Reservation Info
================
License reservation: DISABLED
Example
To display the license usage information, use the show license usage command:
Device> enable
Device# show license usage
Load for five secs: 1%/0%; one minute: 0%; five minutes: 0%
No time source, 09:28:34.123 EDT Fri Jul 13 2018
License Authorization:
Status: EVAL MODE
Evaluation Period Remaining: 68 days, 0 hours, 29 minutes, 38 seconds
Example
To display all the license summaries, use the show license summary command:
Device> enable
Device# show license summary
Registration:
Status: UNREGISTERED
Export-Controlled Functionality: Not Allowed
License Authorization:
Status: EVAL MODE
Evaluation Period Remaining: 68 days, 0 hours, 29 minutes, 33 seconds
License Usage:
License Entitlement tag Count Status
-----------------------------------------------------------------------------
(C9200L-DNA-A-48) 1 EVAL MODE
(C9200L-NW-A-48) 1 EVAL MODE
Example
To display the license status information, use the show license status command:
Device> enable
Device# show license status
Load for five secs: 1%/0%; one minute: 0%; five minutes: 0%
No time source, 09:28:37.683 EDT Fri Jul 13 2018
Utility:
Status: DISABLED
Data Privacy:
Sending Hostname: yes
Callhome hostname privacy: DISABLED
Smart Licensing hostname privacy: DISABLED
Version privacy: DISABLED
Transport:
Type: Callhome
Registration:
Status: UNREGISTERED
Export-Controlled Functionality: Not Allowed
License Authorization:
Status: EVAL MODE
Evaluation Period Remaining: 68 days, 0 hours, 29 minutes, 35 seconds
Example
To register a device, use the license smart register idtoken command:
Device> enable
Device# license smart register idtoken
Tl4UytrNXBzbEs1ck8veUtWaG5abnZJOFdDa1FwbVRa%0AblRMbz0%3D%0A
Device# write memory
Example
To display the license entitlements, use the show license all command:
Device> enable
Device# show license all
Smart Licensing Status
======================
Registration:
Status: REGISTERED
Smart Account: Smart Account Name
Virtual Account: Virtual Account 1
Export-Controlled Functionality: Allowed
Initial Registration: First Attempt Pending
Last Renewal Attempt: SUCCEEDED on Jul 19 14:49:49 2018 IST
Next Renewal Attempt: Jan 15 14:49:48 2019 IST
License Authorization:
Status: AUTHORIZED on Jul 28 07:02:56 2018 IST
Last Communication Attempt: SUCCEEDED on Jul 28 07:02:56 2018 IST
Next Communication Attempt: Aug 27 07:02:56 2018 IST
Communication Deadline: Oct 26 06:57:50 2018 IST
Utility:
Status: DISABLED
Data Privacy:
Sending Hostname: yes
Callhome hostname privacy: DISABLED
Smart Licensing hostname privacy: DISABLED
Version privacy: DISABLED
Transport:
Type: Callhome
License Usage
==============
Product Information
===================
UDI: PID:C9200L-48P-4X,SN:JPG221300KP
Agent Version
=============
Smart Agent for Licensing: 4.4.13_rel/116
Component Versions: SA:(1_3_dev)1.0.15, SI:(dev22)1.2.1, CH:(rel5)1.0.3, PK:(dev18)1.0.3
Reservation Info
================
License reservation: DISABLED
Example
To display license usage information, use the show license usage command:
Device> enable
Device# show license usage
License Authorization:
Status: AUTHORIZED on Jul 28 07:02:56 2018 IST
Count: 1
Version: 1.0
Status: AUTHORIZED
Example
To display all the license summaries, use the show license summary command:
Device> enable
Device# show license summary
Smart Licensing is ENABLED
Registration:
Status: REGISTERED
Smart Account: Smart Account Name
Virtual Account: Virtual Account 1
Export-Controlled Functionality: Allowed
Last Renewal Attempt: SUCCEEDED
Next Renewal Attempt: Jan 15 14:49:48 2019 IST
License Authorization:
Status: AUTHORIZED
Last Communication Attempt: SUCCEEDED
Next Communication Attempt: Aug 27 07:02:56 2018 IST
License Usage:
License Entitlement tag Count Status
-----------------------------------------------------------------------------
C9200L DNA Advantage... (C9200L-DNA-A-48) 1 AUTHORIZED
C9200L Network Advan... (C9200L-NW-A-48) 1 AUTHORIZED
Example
To display the license status information, use the show license status command:
Device> enable
Device# show license status
Utility:
Status: DISABLED
Data Privacy:
Sending Hostname: yes
Callhome hostname privacy: DISABLED
Smart Licensing hostname privacy: DISABLED
Version privacy: DISABLED
Transport:
Type: Callhome
Registration:
Status: REGISTERED
Smart Account: Smart Account Name
Virtual Account: Virtual Account 1
Export-Controlled Functionality: Allowed
Initial Registration: First Attempt Pending
Last Renewal Attempt: SUCCEEDED on Jul 19 14:49:49 2018 IST
Next Renewal Attempt: Jan 15 14:49:47 2019 IST
Registration Expires: Jul 19 14:43:47 2019 IST
License Authorization:
Status: AUTHORIZED on Jul 28 07:02:56 2018 IST
Last Communication Attempt: SUCCEEDED on Jul 28 07:02:56 2018 IST
Next Communication Attempt: Aug 27 07:02:56 2018 IST
Communication Deadline: Oct 26 06:57:50 2018 IST
Additional References
Related Documents
Cisco Smart Software Manager On-Prem Cisco Smart Software Manager On-Prem
Technical Assistance
Description Link
The Cisco Support website provides extensive online http://www.cisco.com/support
resources, including documentation and tools for
troubleshooting and resolving technical issues with
Cisco products and technologies.
To receive security and technical information about
your products, you can subscribe to various services,
such as the Product Alert Tool (accessed from Field
Notices), the Cisco Technical Services Newsletter,
and Really Simple Syndication (RSS) Feeds.
Access to most tools on the Cisco Support website
requires a Cisco.com user ID and password.
Smart Cisco IOS XE Fuji Smart Licensing is a cloud-based, software license management
Licensing 16.9.2 solution that allows you to manage and track the status of your
license and hardware and software usage trends.