license smart (global config)
To configure licensing-related settings such as the mode of transport and URL that the product instance uses to communicate with Cisco Smart Software Manager (CSSM), or Cisco Smart Licensing Utility (CSLU), or Smart Software Manager On-Prem (SSM On-Prem), the usage reporting interval, the information that must be exluded or included in a license usage report (RUM report), a VRF to send licensing data, enter the license smart command in global configuration mode. Use the no form of the command to revert to default values.
license smart { custom_id ID | enable | privacy { all | hostname | version } | proxy { address address_hostname | port port } | reservation | server-identity-check | transport { automatic | callhome | cslu | off | smart } | url { url | cslu cslu_or_on-prem_url | default | smart smart_url | utility secondary_url } | usage { customer-tags { tag1 | tag2 | tag3 | tag4 } tag_value | interval interval_in_days } | utility [ customer_info { city city | country country | id id | name name | postalcode postalcode | state state | street street } ] | vrf vrf_string }
no license smart { custom_id | enable | privacy { all | hostname | version } | proxy { address address_hostname | port port } | reservation | server-identity-check | transport | url { url | cslu cslu_or_on-prem_url | default | smart smart_url | utility secondary_url } | usage { customer-tags { tag1 | tag2 | tag3 | tag4 } tag_value | interval interval_in_days } | utility [ customer_info { city city | country country | id id | name name | postalcode postalcode | state state | street street } ] | vrf vrf_string }
Syntax Description
custom_id ID |
Although visible on the CLI, this option is not supported. |
||
enable |
Although visible on the CLI, configuring this keyword has no effect. Smart Licensing is always enabled. |
||
privacy { all | hostname | version } |
Sets a privacy flag to prevent the sending of the specified data privacy related information. When the flag is disabled, the corresponding information is sent in a message or offline file created by the product instance. Depending on the topology this is sent to one or more components, including CSSM, CSLU, and SSM On-Prem. All data privacy settings are disabled by default. You must configure the option you want to exclude from all communication:
|
||
proxy { address address_hostname | port port } |
Configures a proxy for license usage synchronization with CSLU or CSSM. This means that you can use this option to configure a proxy only if the transport mode is license smart transport smart (CSSM), or license smart transport cslu (CSLU). However, you cannot configure a proxy for license usage synchronization in an SSM On-Prem deployment, which also uses license smart transport cslu as the transport mode. When a proxy is configured, messages are sent to the proxy along with the final destination URL (CSSM). The proxy sends the message on to CSSM. Configure the following options:
|
||
reservation |
Enables the reservation mode for Permanent License Reservation (PLR) in the Smart Licensing Using Policy environment. In the Smart Licensing Using Policy environment, PLR is supported starting from Cisco IOS XE Dublin 17.10.1 only. The product instances that support PLR are only Catalyst 8000V Edge Software and Cloud Services Router 1000v on which a .bin upgrade to Catalyst 8000V Edge Software is performed. The no form of the command disables reservation. You must enable the reservation mode using this keyword before you can access the privileged EXEC commands used to cancel, install, request, and return a PLR code. |
||
server-identity-check |
Enables or disables the HTTP secure server identity check. |
||
transport { automatic | callhome | cslu | off | smart } |
Configures the mode of transport the product instance uses to communicate with CSSM. Choose from the following options:
|
||
url { url | cslu cslu_or_on-prem_url | default | smart smart_url | utility secondary_url } |
Sets URL that is used for the configured transport mode. Choose from the following options:
|
||
usage { customer-tags { tag1 | tag2 | tag3 | tag4 } tag_value | interval interval_in_days } |
Provides usage reporting settings. You can set the following options:
|
||
utility [ customer_info { city city | country country | id id | name name | postalcode postalcode | state state | street street } ] |
Enables the utility mode on the product instance. The utility mode must be enabled if you have an MSLA and use licenses with subscription IDs. When enabled, all communication to and from the product instance is flagged accordingly. For a product instance in the utility mode, you can optionally include the additional information in a RUM report. This information is not used by Cisco. To include optional information in the RUM report, enter the customer_info keyword, followed by one or more of the following options:
The no form of the license smart utility command disables the utility mode. |
||
vrf vrf_string |
Configures a Virtual Routing and Forwarding (VRF) name that is used by the product instance. The product instance uses the VRF to send licensing-related data to CSSM, CSLU, or SSM On-Prem. For vrf_string , enter the VRF name you have defined. Ensure that the following requirements are met:
|
Command Default
Starting from Cisco IOS XE Amsterdam 17.3.2, Smart Licensing Using Policy is enabled by default.
Command Modes
Global config (Device(config)# )
Command History
Release | Modification |
---|---|
This command was introduced in a release earlier than Cisco IOS XE Amsterdam 17.3.2 |
This command was introduced. |
Cisco IOS XE Amsterdam 17.3.2 |
The following keywords and variables were introduced with Smart Licensing Using Policy:
The following keywords and variables under the license smart command are deprecated and no longer available on the CLI: enable and conversion automatic . |
Cisco IOS XE Amsterdam 17.3.3 |
SSM On-Prem support was introduced. For product instance-initiated communication in an SSM On-Prem deployment, the existing
[no ]license smart url cslucslu_or_on-prem_url command supports the configuration of a URL for SSM On-Prem as well. But the required URL format for SSM On-Prem is: The corresponding transport mode that must be configured is also an existing command (license smart transport cslu ). |
Cisco IOS XE Cupertino 17.7.1a |
If version privacy is disabled (no license smart privacy version global configuration command), the Cisco IOS-XE software version running on the product instance and the Smart Agent version is included in the RUM report. To exclude version information from the RUM report, version privacy must be enabled (license smart privacy version ). |
Cisco IOS XE Cupertino 17.9.1a |
|
Cisco IOS XE Dublin 17.10.1 |
Support for the reservation keyword was introduced. The [no] license smart reservation command enables or disables the reservation mode on supported product instances. |
Usage Guidelines
Data Privacy Settings
When you disable a privacy setting, the topology you have implemented determines the recipient and how the information reaches its destination:
-
The recipient of the information may be one or more of the following: CSSM, CSLU, and SSM On-Prem. The privacy setting has no effect on a controller (Cisco DNA Center).
In case of the hostname keyword, after the hostname information is received by CSSM, CSLU, or SSM On-Prem, it is also displayed on the corresponding UIs – as applicable. If you then enable privacy, the corresponding UIs revert to displaying the UDI of the product instance.
-
How the information is sent.
-
In case of a topology where the product instance initiates communication, the product instance initiates the sending of this information in a message, to CSSM, or CSLU, or SSM On-Prem.
The product instance sends the hostname sent every time one of the following events occur: the product instance boots up, the hostname changes, there is a switchover in a High Availability set-up.
-
In case of a topology where CSLU or SSM On-Prem initiate communication, the corresponding component initiates the retrieval of privacy information from the product instance.
The hostname is retrieved at the frequency you configure in CSLU or SSM On-Prem.
-
In case of a topology where the product instance is in an air-gapped network, privacy information is included in the offline file that is generated when you enter the license smart save usage privileged EXEC command.
Note
For all topologies, data privacy related information is not included in the RUM report.
Data privacy related information it is not stored by the product instance prior to sending or saving. This ensures that if and when information is sent, it is consistent with the data privacy setting at the time of sending or saving.
-
Communication failure and reporting
The reporting interval that you configure (license smart usage interval interval_in_days command), determines the date and time at which the product instance sends out the RUM report. If the scheduled interval coincides with a communication failure, the product instance attempts to send out the RUM report for up to four hours after the scheduled time has expired. If it is still unable to send out the report (because the communication failure persists), the system resets the interval to 15 minutes. Once the communication failure is resolved, the system reverts the reporting interval to the value that you last configured.
The system message you may see in case of a communicatin failure is %SMART_LIC-3-COMM_FAILED. See the Troubleshooting Smart Licensing Using Policy section for information about resolving this error and restoring the reporting interval value.
Proxy server acceptance
When configuring the license smart proxy
{ address address_hostname
|
portport} command, note the change in the criteria for the acceptance of proxy servers, starting with Cisco IOS XE Bengaluru 17.6.1:
only the status code of the proxy server response is verified by the system and not the reason phrase. The RFC format is status-line = HTTP-version SP status-code SP reason-phrase CRLF
, where the status code is a three-digit numeric code. For more information about the status line, see section 3.1.2 of RFC 7230.
Setting the Utility Mode
If the utility mode is enabled (license smart utility ) and a license without a subscription ID is in use, the %SMART_LIC-4-UTILITY_SUBSCRIPTION_LICENSE system message is generated - once, for every license, and 30 days after the use of the license without the subscription ID is detected.
To remedy the situation, ensure that subscription IDs are deposited in the correct Smart Account and Virtual Account in CSSM. This enables all communication to be flagged accordingly.
To support the utility mode, the transport type must be set to one of the following options only:
-
smart, if the product instance is directly connected to CSSM).
-
cslu, if the product instance is connected to CSSM via CSLU or SSM On-Prem.
-
off, if the product instance is in an air-gapped network.
Using a VRF
When you use the license smart vrf vrf_string global configuration command, the topology you implement must be one where the product instance is connected to CSSM, or CSLU, or SSM-OnPrem. (The supported transport types when using a VRF are smart and cslu only.)
Further, if connected to CSSM via CSLU or SSM On-Prem, you must implement a topology where the product instance initiates communication. CSLU or SSM On-Prem can be connected to CSSM or disconnected from it.
In order to use a VRF to send licensing data, other supporting VRF configuration may also be required. This will depend on your network. For more information, see IP Routing: Protocol-Independent Configuration Guide, Cisco IOS XE 17.
Sample VRF configuration is provided in the Examples section below.
Examples
Examples for Data Privacy
The following examples show how to configure data privacy related information using license smart privacy command in global configuration mode. The accompanying show license status output displays the privacy options that are enabled and those that are disabled.
Note |
The output of the show command only tells you if a particular option is enabled or disabled. |
Device# configure terminal
Device(config)# license smart privacy all
Device(config)# exit
Device# show license status
<output truncated>
Data Privacy:
Sending Hostname: no
Callhome hostname privacy: ENABLED
Smart Licensing hostname privacy: ENABLED
Version privacy: ENABLED
Transport:
Type: Callhome
<output truncated>
Here, hostname is included and version information is excluded in the message initiated from the product instance. The product instance is directly connected to CSSM (transport type is smart, with the corresponding URL).
Device# configure terminal
Device(config)# license smart privacy version
Device(config)# no license smart privacy hostname
Device(config)# exit
Device# show license all
<output truncated>
Data Privacy:
Sending Hostname: no
Callhome hostname privacy: DISABLED
Smart Licensing hostname privacy: ENABLED
Version privacy: DISABLED
Transport:
Type: Smart
URL: https://smartreceiver.cisco.com/licservice/license
Proxy:
Not Configured
VRF:
Not Configured
<output truncated>
Examples for Transport Type and URL
The following examples show how to configure some of the transport types using the license smart transport and the license smart url commands in global configuration mode. The accompanying show license all output displays configured information.
Device# configure terminal
Device(config)# license smart transport cslu
Device(config)# license smart url default
Device(config)# exit
Device# show license all
<output truncated>
Transport:
Type: cslu
Cslu address: http://192.168.0.1:8182/cslu/v1/pi
Proxy:
Not Configured
<output truncated>
Device# configure terminal
Device(config)# license smart transport smart
Device(config)# license smart url smart https://smartreceiver.cisco.com/licservice/license
Device(config)# exit
Device# show license all
<output truncated>
Transport:
Type: Smart
URL: https://smartreceiver-stage.cisco.com/licservice/license
Proxy:
Not Configured
<output truncated>
Examples for Usage Reporting Options
The following examples show how to configure some of the usage reporting settings using the license smart usage command in global configuration mode. The accompanying show running-config output displays configured information.
Device# configure terminal
Device(config)# license smart usage customer-tags tag1 SA/VA:01
Device(config)# exit
Device# show running-config | include tag1
license smart usage customer-tags tag1 SA/VA:01
Device# show license status
<output truncated>
Usage Reporting:
Last ACK received: Sep 22 13:49:38 2020 PST
Next ACK deadline: Dec 21 12:02:21 2020 PST
Reporting push interval: 30 days
Next ACK push check: Sep 22 12:20:34 2020 PST
Next report push: Oct 22 12:05:43 2020 PST
Last report push: Sep 22 12:05:43 2020 PST
Last report file write: <none>
<output truncated>
Device# configure terminal
Device(config)# license smart usage interval 20
Device(config)# exit
Device# show license status
<output truncated>
Usage Reporting:
Last ACK received: Sep 22 13:49:38 2020 PST
Next ACK deadline: Nov 22 12:02:21 2020 PST
Reporting push interval: 20 days
Next ACK push check: Sep 22 12:20:34 2020 PST
Next report push: Oct 12 12:05:43 2020 PST
Last report push: Sep 22 12:05:43 2020 PST
Last report file write: <none>
<output truncated>
Example for Using VRF
Here, SLP_VRF is used to send licensing data from the product instance. The license smart vrf vrf_string command is used to specify the VRF that will be used to send licensing data. The rest of the supporting configuration is for example purposes.
Device (config)# vrf definition SLP_VRF
Device(config-vrf)# address-family ipv4
Device(config-vrf-af)# exit
Device(config-vrf)# interface GigabitEthernet 0/0/0
Device (config-if)# no shutdown
Device (config-if)# vrf forwarding SLP_VRF
Device (config-if)# ip address 192.168.0.47 255.255.0.0
Device (config-if)# exit
Device (config)# ip route vrf SLP_VRF 0.0.0.0 0.0.0.0 192.168.0.1
Device (config)# ip name-server vrf SLP_VRF 173.37.137.85
Device (config)# license smart transport smart
Device (config)# license smart url https://smartreceiver.cisco.com/licservice/license
Device (config)# license smart vrf SLP_VRF
Device (config)# ip http client source-interface GigabitEthernet 0/0/0