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.
A new licensing model, based on a single technology, has been designed for Cisco called Smart Licensing that is intended to provide Enterprise Level Agreement-like capabilities for all Cisco products. The Cisco Smart Licensing is based on the Trust but Verify model.
Your software release may not support all the features documented in this module. For the latest feature information and caveats, see the release notes for your platform and software release. To find information about the features documented in this module, and to see a list of the releases in which each feature is supported, see the Feature Information Table at the end of this document.
Use Cisco Feature Navigator to find information about platform support and Cisco software image support. To access Cisco Feature Navigator, go to http://tools.cisco.com/ITDIT/CFN/. An account on http://www.cisco.com/ is not required.
Note | The hardware components introduced in a given Cisco IOS-XE Release are supported in all subsequent releases unless otherwise specified. |
You must configure the DNS server using the ip name-server global configuration command.
You must configure the IP DNS-based hostname-to-address translation using the ip domain-lookup global configuration command.
Cisco Smart Licensing is enabled by default on the Cisco cBR router. However, you must ensure that the CiscoTAC-1 call-home profile points to the Cisco Smart Software Manager at the following URL using the show call-home profile CiscoTAC-1 command:
https://tools.cisco.com/its/service/oddce/services/DDCEService
The following is a sample output of the show call-home profile CiscoTAC-1 command:
Router# show call-home profile CiscoTAC-1 Load for five secs: 10%/1%; one minute: 9%; five minutes: 8% Time source is NTP, 16:49:35.525 PDT Thu Oct 29 2015 Profile Name: CiscoTAC-1 Profile status: ACTIVE Profile mode: Anonymous Reporting Only Reporting Data: Smart Call Home, Smart Licensing Preferred Message Format: xml Message Size Limit: 3145728 Bytes Transport Method: http Email address(es): callhome@cisco.com HTTP address(es): https://tools.cisco.com/its/service/oddce/services/DDCEService Periodic configuration info message is scheduled every 19 day of the month at 11:41 Periodic inventory info message is scheduled every 19 day of the month at 11:26 Alert-group Severity ------------------------ ------------ crash debug diagnostic minor environment minor inventory normal Syslog-Pattern Severity ------------------------ ------------ .* major
Ensure that you can ping the DNS server. If you are unable to ping the server, verify the connectivity to the NME port on the Cisco cBR router.
Note | If you are using a Virtual Routing and Forwarding (VRF) instance, ensure that you can ping the VRF instance. |
Cisco Smart Licensing is software-based licensing that consists of tools and processes to authorize the customers for the usage and reporting of the Cisco products. The feature has the capability to capture the customer order and communicate with the Cisco Cloud License Service through Smart Call Home transport media to complete the product registration and authorization. If the Cisco products stop communicating with the Cisco Cloud License Service for 90 days, the cable interfaces in the Cisco products will be locked, which means the customer can no longer enable/disable the cable interfaces.
The Cisco Smart Licensing feature is aimed at giving users an experience of a single, standardized licensing solution for all Cisco products.
In the Cisco Smart Licensing Model, you can activate licensed features (also known as entitlements) without the use of a special software key or upgrade license file. You can activate the new functionality using the appropriate product commands and configurations and the functionality is activated. A software reboot is not required for the Cisco cBR router.
The Cisco cBR router supports software activation using Cisco Smart Licensing. The Cisco Smart Licensing is enabled by default on the Cisco cBR router.
Note | A LCHA license is needed for each working linecard that is protected by the protect linecard. |
The DOCSIS 3.1 license scheme provides support to identify the DOCSIS 3.1 channels and their width. The DOCSIS 3.1 entitlement is DOCSIS 3.1 Downstream Channel License.
Note | Configuration of DOCSIS 3.1 Downstream OFDM channel consumes both DOCSIS 3.0 and DOCSIS 3.1 license in a 1:1 ratio with license units of 6 MHz. |
The following two events are responsible for triggering a DOCSIS configuration lock enforcement.
When a router is not registered with Smart License Manager for more than ninety days.
When a registered router fails to communicate with the Smart License Manager for more than ninety days.
When either of the above mentioned events occur, the Smart Agent sends a notification to the platform. The platform, upon receiving such notification, locks the following CLI commands:
[no] cable upstream shutdown upstream-port-number
contoller upstream-cable slot/subslot/controller-port-number
rf-chanchannel-number
Any attempt to configure the above mentioned CLIs in this condition would fail and a warning message will be displayed. Under this condition all other CLIs are configurable, some of which may be required to configure Cisco License Call Home, connect to cisco and register the device to come out of either of the above two events and enter into authorized or Out of Compliance (OOC) state.
You can copy the modified configuration file to the startup configuration file and reload the device to make that configuration effective. However, when the device is in enforced state, you can only copy the running configuration file to the startup configuration file.
Note | Any attempt to copy any other file fails and a warning message is displayed. |
This section contains the following:
Step 1 | Set up a Cisco Smart Account. See Setting Up a Cisco Smart Account. | ||
Step 2 | Log in to the Cisco Smart Software Manager. | ||
Step 3 | (Optional)
Create a virtual account. See
Creating Virtual Accounts.
| ||
Step 4 | Create a product instance registration token. See Creating a Product Instance Registration Token. | ||
Step 5 | Register the router with the Cisco Licensing Cloud using the product instance registration token. See Registering the Router with the Cisco Licensing Cloud Using the Registration Token. | ||
Step 6 | Log in to the
Cisco Smart Software Manager
for managing licenses.
For more information, see the Cisco Smart Software Manager User Guide, which is accessible from the Cisco Smart Software Manager tool. |
Cisco Smart Account enables you to fully utilize the license management features of the smart-enabled products.
Step 1 | Log in to Cisco Software Workspace (CSW) with your CCO ID. | ||
Step 2 | Hover the
cursor over the
Administration
tab and click
Create Smart
Accounts.
| ||
Step 3 | Perform one of
the following to select the Account Approver:
| ||
Step 4 | If you are the
Approver, perform the following:
| ||
Step 5 | If you are not
the Approver, perform the following:
| ||
Step 6 | If you are not
the Approver, the Approver will receive an e-mail and must perform the
following:
The Approver role is accepted and Cisco Smart Account is pending Account Domain approval. | ||
Step 7 | After the
Account Domain is approved, the Approver will receive an e-mail and must
perform the following:
You will receive an e-mail confirming the creation of the Cisco Smart Account. |
This procedure is optional. Virtual accounts are collections of licenses and product instances. You can create virtual accounts in Cisco Smart Software Manager to organize the licenses for your company into logical entities. A single virtual account is available by default.
Set up a Cisco Smart Account. See Setting Up a Cisco Smart Account.
Step 1 | Log in to the Cisco Smart Software Manager. |
Step 2 | Click the
+
(plus) symbol to create a virtual account.
|
Step 3 | In the
New Virtual
Account dialog box, enter the Name and Description.
|
Step 4 | Click Save. |
Product instance registration tokens are used to register and consume a product for Cisco Smart Licensing. You must generate a token to register the product and add the product instance to a specified virtual account. Registration tokens can be valid from 1 to 365 days.
Step 1 | Log in to the Cisco Smart Software Manager. |
Step 2 | Click an existing virtual account. |
Step 3 | In the
General
tab, click
New Token.
|
Step 4 | In the
Create
Registration Token
dialog box, enter the Description and Expire After information
and click
Create
Token.
|
Register the router with the Cisco Licensing Cloud. For more details, see the Registering the Router with the Cisco Licensing Cloud Using the Registration Token section.
The router registration is performed only once for each product instance.
Note | Ensure that you have the product instance registration token. |
enable license smart register idtoken id-token
Router#license smart register idtoken YjBkOWM5YTItMDFiOS00ZjBmLTllY2YtODEzMzg1YTMyZDVhLTEz ODE0MjE0%0ANzc5NDF8U1BDUTAySWFRTmJqa1NnbmlzRUIyaGlYU 053L0pHZTNvUW9VTFpE%0AekxCOD0%3D%0AThe system contacts the Cisco Smart Licensing servers to obtain authorization for Smart Licensing.
The license agent registers the product with Cisco and receives an identity certificate. This certificate is saved and automatically used for all future communications with Cisco. The license agent automatically renews the registration information with Cisco every 30 days.
Note | Smart licensing may fail if IPv6 is configured on any interface, and the router does not have IPv6 connectivity to the Internet or Cisco Smart Software Agent (at tools.cisco.com). Log file error messages similar to the following may appear. %SMART_LIC-3-AGENT_REG_FAILED: Smart Agent for Licensing Registration with Cisco licensing cloud failed: Fail to send out Call Home HTTP message. %SMART_LIC-3-COMM_FAILED: Communications failure with Cisco licensing cloud: Fail to send out Call Home HTTP message.If connectivity fails due to this issue, see the Re-establishing Connectivity to Cisco Smart Call Home Server section. |
After connectivity is established, register the router with the Cisco Licensing Cloud.
This section describes what to do when the router fails to connect to the Cisco Smart Call Home Server and IPv6 is configured.
The following scenarios are applicable:
If the interface is configured using the ip http client source-interface interface CLI and has the IPv6 address, the router establishes a session with the remote server with IPv6 connectivity.
If the interface is configured using the ip http client source-interface interface command and has the IPv4 address, the router establishes a session with the remote server with IPv4 connectivity.
If the interface is configured using ip http client source-interface interfacecommand, and has an IPv6 address and an IPv4 address, the router establishes a session with the remote server with IPv6 connectivity.
If the interface is not configured using the ip http client source-interface interface, the router establishes a session with the remote server with the IPv6 address.
ip http client source-interface interface
The steps below describe how to configure Cisco smart licensing using transport gateway solution.
Use the following commands to verify the Cisco Smart Licensing Configuration on the Cisco cBR router:
show license all—Displays all the license information.
The following is a sample output of this command:
Router# show license all Smart Licensing Status ====================== Smart Licensing is ENABLED Registration: Status: REGISTERED Virtual Account: auto-test-1 Initial Registration: SUCCEEDED on Mar 5 02:01:03 2015 UTC Last Renewal Attempt: None Next Renewal Attempt: Sep 1 02:03:51 2015 UTC Registration Expires: Never License Authorization: Status: OUT OF COMPLIANCE on Mar 5 03:34:54 2015 UTC Last Communication Attempt: SUCCEEDED on Mar 5 03:35:57 2015 UTC Next Communication Attempt: Mar 5 15:35:57 2015 UTC Communication Deadline: Jun 3 03:32:51 2015 UTC License Usage ============== (US_License): Description: Count: 64 Version: 1.0 Status: AUTHORIZED (DS_License): Description: Count: 768 Version: 1.0 Status: AUTHORIZED (WAN_License): Description: Count: 8 Version: 1.0 Status: OUT OF COMPLIANCE Product Information =================== UDI: PID:CBR-8-CCAP-CHASS,SN:FXS1739Q0NT HA UDI List: Active:PID:CBR-8-CCAP-CHASS,SN:FXS1739Q0NT Standby:PID:CBR-8-CCAP-CHASS,SN:FXS1739Q0NT Agent Version ============= Smart Agent for Licensing: 1.2.1_throttle/5 Component Versions: SA:(1_2_1_throttle)1.1.0, SI:(rel20)1.0.1, CH:(rel4)1.0.15, PK:(rel16)1.0.7
show license status—Displays the license status information.
The following is a sample output of this command:
Router# show license status Smart Licensing is ENABLED Registration: Status: REGISTERED Virtual Account: auto-test-1 Initial Registration: SUCCEEDED on Mar 5 02:01:03 2015 UTC Last Renewal Attempt: None Next Renewal Attempt: Sep 1 02:03:51 2015 UTC Registration Expires: Never License Authorization: Status: OUT OF COMPLIANCE on Mar 5 03:34:54 2015 UTC Last Communication Attempt: SUCCEEDED on Mar 5 03:35:57 2015 UTC Next Communication Attempt: Mar 5 15:35:56 2015 UTC Communication Deadline: Jun 3 03:32:50 2015 UTC
show license summary—Displays the license summary information.
The following is a sample output of this command:
Router# show license summary Smart Licensing is ENABLED Registration: Status: REGISTERED Virtual Account: auto-test-1 Last Renewal Attempt: None Next Renewal Attempt: Sep 1 02:03:51 2015 UTC License Authorization: Status: OUT OF COMPLIANCE Last Communication Attempt: SUCCEEDED Next Communication Attempt: Mar 5 15:35:56 2015 UTC License Usage: License Entitlement tag Count Status --------------------------------------------------------------- (US_License) 64 AUTHORIZED (DS_License) 768 AUTHORIZED (WAN_License) 8 OUT OF COMPLIANCE
show license tech support—Displays the license technical support information.
The following is a sample output of this command:
Router# show license tech support Smart Licensing Tech Support info Smart Licensing Status ====================== Smart Licensing is ENABLED Registration: Status: REGISTERED Virtual Account: auto-test-1 Initial Registration: SUCCEEDED on Mar 5 02:01:03 2015 UTC Last Renewal Attempt: None Next Renewal Attempt: Sep 1 02:03:51 2015 UTC Registration Expires: Never License Authorization: Status: OUT OF COMPLIANCE on Mar 5 03:34:54 2015 UTC Last Communication Attempt: SUCCEEDED on Mar 5 03:35:57 2015 UTC Next Communication Attempt: Mar 5 15:35:57 2015 UTC Communication Deadline: Jun 3 03:32:51 2015 UTC Evaluation Period: Evaluation Mode: Not In Use Evaluation Period Remaining: 89 days, 23 hours, 25 minutes, 40 seconds License Usage ============= Handle: 1 License: 'nullPtr' Entitlement Tag: regid.2014-11.com.cisco.US_License,1.0_a3f32909-2c71-426c-b3e0-eeefc946f9b3 Description: <empty> Count: 64 Version: 1.0 Status: AUTHORIZED(3) Status time: Mar 5 03:34:54 2015 UTC Request Time: Mar 5 03:34:17 2015 UTC Handle: 2 License: 'nullPtr' Entitlement Tag: regid.2014-11.com.cisco.DS_License,1.0_71ad0ae1-5e5e-4f02-b380-d2e1b8dcfa03 Description: <empty> Count: 768 Version: 1.0 Status: AUTHORIZED(3) Status time: Mar 5 03:34:54 2015 UTC Request Time: Mar 5 03:34:17 2015 UTC Handle: 3 License: 'nullPtr' Entitlement Tag: regid.2014-11.com.cisco.WAN_License,1.0_3d8bb7ba-1a92-4f01-a4aa-a4479f1d7612 Description: <empty> Count: 8 Version: 1.0 Status: OUT OF COMPLIANCE(4) Status time: Mar 5 03:34:54 2015 UTC Request Time: Mar 5 03:34:17 2015 UTC Product Information =================== UDI: PID:CBR-8-CCAP-CHASS,SN:FXS1739Q0NT HA UDI List: Active:PID:CBR-8-CCAP-CHASS,SN:FXS1739Q0NT Standby:PID:CBR-8-CCAP-CHASS,SN:FXS1739Q0NT Agent Version ============= Smart Agent for Licensing: 1.2.1_throttle/5 Component Versions: SA:(1_2_1_throttle)1.1.0, SI:(rel20)1.0.1, CH:(rel4)1.0.15, PK:(rel16)1.0.7 Upcoming Scheduled Jobs ======================= Current time: Mar 5 03:37:46 2015 UTC IdCert Expiration Warning: Jan 4 02:00:41 2016 UTC (304 days, 22 hours, 22 minutes, 55 seconds remaining) Daily: Mar 6 03:21:11 2015 UTC (23 hours, 43 minutes, 25 seconds remaining) Certificate Renewal: Sep 1 02:03:51 2015 UTC (179 days, 22 hours, 26 minutes, 5 seconds remaining) Certificate Expiration Check: Mar 4 02:00:41 2016 UTC (364 days, 22 hours, 22 minutes, 55 seconds remaining) Authorization Renewal: Mar 5 15:35:57 2015 UTC (11 hours, 58 minutes, 11 seconds remaining) Authorization Expiration Check: Jun 3 03:32:51 2015 UTC (89 days, 23 hours, 55 minutes, 5 seconds remaining) Init Flag Check: Not Available License Certificates ==================== Production Cert: True PIID: 36bf91ae-0577-4213-9e62-1b6ee0add02f Licensing Certificated: Id certificate Info: Start Date: Mar 5 01:57:54 2015 UTC Expiry Date: Mar 4 01:57:54 2016 UTC Version Number: 3 Serial Number: 134418 Common Name: 05FB26B1A58A106DEA6878C346432186D08BC1C5::1,2 Signing certificate Info: Start Date: Jun 14 20:18:52 2013 UTC Expiry Date: Apr 24 21:55:42 2033 UTC Version Number: 3 Serial Number: 3 Common Name: MMI Signer Sub CA Info: Start Date: Apr 24 22:19:15 2013 UTC Expiry Date: Apr 24 21:55:42 2033 UTC Version Number: 3 Serial Number: 2 Common Name: Smart Licensing CA - DEV HA Info ========== RP Role: Active Chassis Role: Active Behavior Role: Active RMF: True CF: True CF State: Stateless Other Info ========== Software ID: regid.2014-12.com.cisco.CBR8V1,1.0_95948658-0b8b-4e8f-838d-b17020364ca9 Agent State: OOC TS enable: True Transport: Callhome Locale: en_US.UTF-8 Debug flags: 0x7 Privacy Send Hostname: True Privacy Send IP: True Build type:: Production sizeof(char) : 1 sizeof(int) : 4 sizeof(long) : 4 sizeof(char *): 8 sizeof(time_t): 4 sizeof(size_t): 8 Endian: Big enableOnInit: True routingReadyByEvent: True systemInitByEvent: True WaitForHaRole: False standbyIsHot: True chkPtType: 2 delayCommInit: False roleByEvent: True maxTraceLength: 150 traceAlwaysOn: False debugFlags: 7
show license udi—Displays the license Unique Device Identifier (UDI) information.
The following is a sample output of this command:
Router# show license udi UDI: PID:CBR-8-CCAP-CHASS,SN:FXS1739Q0NT HA UDI List: Active:PID:CBR-8-CCAP-CHASS,SN:FXS1739Q0NT Standby:PID:CBR-8-CCAP-CHASS,SN:FXS1739Q0NT
show license usage—Displays the license usage information.
The following is a sample output of this command:
Router# show license usage License Authorization: Status: OUT OF COMPLIANCE on Mar 5 03:34:54 2015 UTC (US_License): Description: Count: 64 Version: 1.0 Status: AUTHORIZED (DS_License): Description: Count: 768 Version: 1.0 Status: AUTHORIZED (WAN_License): Description: Count: 8 Version: 1.0 Status: OUT OF COMPLIANCE
show call-home profile all—Displays the call home profile information for all configured profiles.
The following is a sample output of this command:
Router# 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 Email address(es): callhome@cisco.com HTTP address(es): https://tools.cisco.com/its/service/oddce/services/DDCEService Periodic configuration info message is scheduled every 25 day of the month at 10:03 Periodic inventory info message is scheduled every 25 day of the month at 09:48 Alert-group Severity ------------------------ ------------ crash debug diagnostic minor environment minor inventory normal Syslog-Pattern Severity ------------------------ ------------ .* major
show call-home smart-licensing statistics—Displays the call home smart licensing statistics information.
The following is a sample output of this command:
Router# show call-home smart-licensing statistics Success: Successfully sent and response received. Failed : Failed to send or response indicated error occurred. Inqueue: In queue waiting to be sent. Dropped: Dropped due to incorrect call-home configuration. Msg Subtype Success Failed Inqueue Dropped Last-sent (GMT-06:00) ---------------------------------------------------------------------- REGISTRATION 1 0 0 0 2015-03-13 13:12:13 ACKNOWLEDGEMENT 1 0 0 0 2015-03-13 13:12:20 ENTITLEMENT 5 0 0 0 2015-03-13 13:22:18
Use the following commands to verify the DOCSIS 3.1 Downstream License on the Cisco cBR router:
show cable license all | begin D3.1—Displays all the DOCSIS 3.1 downstream license information.
The following is a sample output of this command:
Router# show cable license all | begin D3.1 Load for five secs: 21%/1%; one minute: 52%; five minutes: 52% Time source is NTP, 10:41:11.175 PST Mon May 9 2016 -------------------------------------------- Entitlement: DOCSIS 3.1 Downstream Channel License Consumed count: 31 Consumed count reported to SmartAgent: 0 Enforced state: No Enforcement
Use the following commands to verify the DOCSIS 3.1 Upstream Exclusive License on the Cisco cBR router:
• show cable licenses us_d31_exclusive—Displays the DOCSIS 3.1 upstream exclusive license information.
The following is a sample output of this command:
Router# show cable licenses us_d31_exclusive Load for five secs: 99%/2%; one minute: 21%; five minutes: 6% Time source is NTP, *10:14:30.935 CST Tue Jun 6 2017 -------------------------------------------- Entitlement: DOCSIS 3.1 Upstream Channel Exclusive License Total Licensed Spectrum: 188000000Hz Consumed count: 188 Consumed count reported to SmartAgent: 188 Enforced state: No Enforcement
Before taking the steps below to troubleshoot the Cisco Smart Licensing, the customers should first make sure the configuration is correct and see if they are able to ping the HTTP address they have configured for the smart license. The output of the show call-home smart-licensing statistics command should have REGISTERED and ACKNOWLEDGE information. And check the output of show logging | include SMART | CALL.
The license agent automatically renews the registration information with Cisco every 30 days. You may need to manually renew the registration if the license is out of compliance and it needs to be registered immediately.
Command or Action | Purpose |
---|
You can unregister the router from Cisco Smart Licensing. You may need to unregister the router for the Return Material Authorization (RMA) of the router.
Command or Action | Purpose |
---|
Related Topic | Document Title |
---|---|
Cisco IOS commands | Cisco IOS Master Command List, All Releases |
Cisco Smart Licensing | Cisco Smart Software Licensing |
Description | Link |
---|---|
The Cisco Support website provides extensive online 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. |
Use Cisco Feature Navigator to find information about platform support and software image support. Cisco Feature Navigator enables you to determine which software images support a specific software release, feature set, or platform. To access Cisco Feature Navigator, go to http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Note | The table below lists only the software release that introduced support for a given feature in a given software release train. Unless noted otherwise, subsequent releases of that software release train also support that feature. |
Feature Name |
Releases |
Feature Information |
---|---|---|
Cisco Smart Licensing |
Cisco IOS XE Fuji 16.7.1 |
This feature was integrated on the Cisco cBR Series Converged Broadband Routers. |
DOCSIS 3.1 US Channel Licensing |
Cisco IOS XE Fuji 16.7.1 |
This feature was integrated on the Cisco cBR Series Converged Broadband Routers. |