PDF(1.0 MB) View with Adobe Reader on a variety of devices
ePub(1.1 MB) View in various apps on iPhone, iPad, Android, Sony Reader, or Windows Phone
Mobi (Kindle)(703.8 KB) View on Kindle device or Kindle app on multiple devices
Updated:November 18, 2022
The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
This document describes the steps required for the configuration and registration of a Cisco IOS®-XErouter with Smart Licensing Using Policy feature.
Cisco recommends that you have knowledge of these topics:
Smart Licensing Using Policy registration
Smart Licensing Using Policy transport methods
The information in this document is based on these software versions:
Cisco Smart License Utility version 1.0.0-2 installed on Windows Personal Computer (PC) with Smart Account and Virtual Account configured
On Integrated Services Routers (ISR), Aggregation Services Routers (ASR) 1000, Catalyst 8300, 8500 and 9000: Cisco IOS-XE 17.3.2
On Catalyst 8200 and 1100: Cisco IOS-XE 17.4.1
Cloud Services Router (CSR) and ISR virtual require an upgrade to Catalyst 8000v and Cisco IOS-XE 17.4.1
The information in this document was created from the devices in a specific lab environment. All of the devices used in this document started with a cleared (default) configuration. If your network is live, ensure that you understand the potential impact of any command.
This document describes the next four possible topologies and configurations required when you use Smart Licensing Using Policy, these options depend on how the router is connected to the network.
Router connected to Cisco Smart Software Manager (CSSM) through Cisco Smart License Utility (CSLU).
Router directly connected to CSSM.
Router connected to CSLU and CSLU disconnected from CSSM.
Router not connected to the CSSM and without CSLU in place.
Router Connected to CSSM Through CSLU
On this topology, the product instances in the network are connected to CSSM through CSLU. CSLU becomes the single point of communication with CSSM.
In this section, it is explained Pull and Push methods and their respective configuration.
Push Method Configuration
On this method, the product instance initiates the communication with CSLU, by a connection to a Representational State Transfer (REST) endpoint in CSLU.
The data that is sent includes Real User Monitoring (RUM) reports and requests for authorization codes, trust codes and policies.
Step 1. Log in to CSLU Interface and choose Add Single Product.
Step 2. Choose Product Instance Initiated only, and define the IP address of the product instance to be registered.
Step 3. On the router, configure the transport method to cslu.
Device(config)# license smart transport cslu
Step 4. Enter the CSLU URL with the CSLU IP address.
Step 5. Configure the interface by which the HTTP message.
5.1. Configure the interface by which the HTTP message is sent with this command:
Device(config)# ip http client source-interface interface-type-number
5.2. If you use a VRF to reach CSLU and instead of an ip address you use cslu-local to resolve, you need to add the hostname resolution for cslu-local with this command:
Device(config)# ip host vrf Name_VRF cslu-local cslu-ip-address
Step 6. Initiate the communication and report of usage. Verify logs for correct policy installation.
Device# license smart sync
*Apr 14 12:08:06.235: %SMART_LIC-6-POLICY_INSTALL_SUCCESS: A new licensing policy was successfully installed
Pull Method Configuration
On this method, CSLU initiates the communication with the product instance in order to retrieve its information.
CSLU uses Network Configuration Protocol (NETCONF), Representational State Transfer Configuration Protocol (RESTCONF), google Remote Procedure Calls (gRPC) with Yet Another Next Generation (YANG) models, or REST Application Programming Interfaces (APIs) to connect to the product instances.
Step 1. On the router, configure your preferred method of connectivity (NETCONF, RESTCONF, or REST API).
Step 2. Log in to CSLU Interface and choose Add Single Product.
Step 3. Choose any of the CSLU Initiated options related to the desired connection method (NETCONF, RESTCONF, or REST API), and define the IP address of the product instance to be registered.
Step 4. Choose from the list of Product Instances, the device to be registered and navigate to Actions for Selected and Collect Usage.
Step 5. Verify the completion of the collection of license usage under that product instance.
Step 6. On the registered device, you must see a licensing policy installation successful log.
*Nov 18 23:22:12.929: %SMART_LIC-6-POLICY_INSTALL_SUCCESS: A new licensing policy was succesfully installed
Router Directly Connected to CSSM
On this topology, you establish a direct and trusted connection from a product instance to CSSM, and you have 2 possible transport methods:
Call-home Transport Method. Call-home provides e-mail-based and web-based notification of critical system events.®
Smart Transport Method Configuration
Step 1. Configure the interface by which the HTTP message is sent.
Device(config)# ip http client source-interface interface-type-number
Step 2. Define smart transport method, as the desired license transport method.
Device(config)# license smart transport smart
Step 3. Set the license smart Uniform Resource Locator (URL) as default.
3.1. In order to set license smart URL as default use this command:
Device(config)# license smart url default
3.2. If you use a proxy to reach CSSM, you need to add the proxy for smart:
Device(config)# license smart proxy X.X.X.X port XXXX
Step 4. Generate a new token from CSSM under your Smart Account and Virtual Account and copy the generated token.
Step 5. Register the device with the token generated.
Step 6. Verify in show license status command the correct installation. At the end of the output, on Trust Code Installed section, it must be updated with the registration date.
Device# show license status Transport: Type: Callhome URL: https://tools.cisco.com/its/service/oddce/services/DDCEService Proxy: Not Configured <snippet> Trust Code Installed: Feb 10 20:56:02 2021 UTC <snippet>
Router connected to CSLU and CSLU disconnected from CSSM
The communication between the CSLU and CSSM is sent and received in the form of signed files that are saved offline and then uploaded to or downloaded from the CSLU or CSSM.
On this topology, CSLU provides you the option to work disconnected from the CSSM.
Step 1. On the CSLU navigate to Product Instances and choose Download All For Cisco.
Step 2. On the CSSM Navigate to Reports and select Usage Data Files.
Step 3. Upload the file downloaded from the CSLU.
Step 4. Download the Acknowledge file generated. It is presented on the Usage Data Files list.
Step 5. On the CSLU, navigate to Product Instances and choose Upload from Cisco. Upload the Acknowledge file downloaded from CSSM.
Router not Connected to the CSSM and without CSLU in place
On this topology, you have a product instance that is disconnected from CSSM, and without any other intermediary utilities or components. All communication is in the form of uploaded and downloaded files.
Step 1. Configure on the instance the smart-off license transport method and save the configuration.
Device(config)# license smart transport off Device(config)# exit Device# copy running-config startup-config
Step 2. Save the usage of licenses on a text file inside of the bootflash and extract it out of the router.
Device# license smart save usage all file bootflash:all_rum.txt Device# copy bootflash:all_rum.txt tftp://X.X.X.X/all_rum.txt
Step 3. On the CSSM, navigate to Reports, choose Usage Data Files and upload the usage data file created by the router.
Step 4. Download the Acknowledge file generated and transfer it to the device.
Step 5. On the router, import the file and verify the correct installation.
Device# license smart import bootflash:ack_usage.txt Import Data Successful
*Apr 14 12:08:06.235: %SMART_LIC-6-POLICY_INSTALL_SUCCESS: A new licensing policy was succesfully installed
Use this section to confirm that your configuration works properly.
On all of the topologies, you can verify the registered product instances on CSSM. The next options are suggested steps in order to confirm the successful registration of the device.
Step 1. Navigate to Product Instances and on the search box type the Serial Number of the registered device. You must see the device with its UDI as the name of the instance.
Device# show license udi UDI: PID:ISR4451-X/K9,SN:FOC17513VM6
Step 2. Verify the correct status of license installation with show license status.
Device# show license status
Smart Licensing Using Policy: Status: ENABLED
Policy: Policy in use: Installed On Mar 18 21:20:38 2021 UTC Policy name: SLE Policy Reporting ACK required: yes (Customer Policy) Unenforced/Non-Export Perpetual Attributes: First report requirement (days): 30 (Customer Policy) Reporting frequency (days): 60 (Customer Policy) Report on change (days): 60 (Customer Policy) Unenforced/Non-Export Subscription Attributes: First report requirement (days): 120 (Customer Policy) Reporting frequency (days): 150 (Customer Policy) Report on change (days): 120 (Customer Policy) Enforced (Perpetual/Subscription) License Attributes: First report requirement (days): 0 (CISCO default) Reporting frequency (days): 90 (Customer Policy) Report on change (days): 60 (Customer Policy) Export (Perpetual/Subscription) License Attributes: First report requirement (days): 0 (CISCO default) Reporting frequency (days): 30 (Customer Policy) Report on change (days): 30 (Customer Policy)
Miscellaneous: Custom Id: <empty>
Usage Reporting: Last ACK received: Mar 18 21:20:38 2021 UTC Next ACK deadline: May 17 21:20:38 2021 UTC Reporting push interval: 30 days Next ACK push check: Feb 23 20:24:13 2021 UTC Next report push: Mar 30 15:45:55 2021 UTC Last report push: Mar 18 21:16:38 2021 UTC Last report file write: <none>
This section provides information you can use to troubleshoot your configuration.
1. Ensure the correct DNS resolution with CSLU (Connected to CSSM Through CSLU topology), smartreceiver.cisco.com and tools.cisco.com (Connected Directly to CSSM topology).