Configuring Smart Licensing

Prerequisites for Configuring Smart Licensing

You must have the following in CSSM:

  • Cisco Smart Account

  • One or more Virtual Account

  • User role with proper access rights

  • You should have accepted the Smart Software Licensing Agreement on CSSM to register devices.

  • Network reachability to https://tools.cisco.com.

Introduction to Smart Licensing

Cisco Smart Licensing is a flexible licensing model that provides you with an easier, faster, and more consistent way to purchase and manage software across the Cisco portfolio and across your organization. And it’s secure – you control what users can access. With Smart Licensing you get:

  • Easy Activation: Smart Licensing establishes a pool of software licenses that can be used across the entire organization—no more PAKs (Product Activation Keys).

  • Unified Management: My Cisco Entitlements (MCE) provides a complete view into all of your Cisco products and services in an easy-to-use portal, so you always know what you have and what you are using.

  • 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.

Use the CSSM to do the following tasks:

  • Create, manage, or view virtual accounts.

  • Create and manage Product Instance Registration Tokens.

  • Transfer licenses between virtual accounts or view licenses.

  • Transfer, remove, or view product instances.

  • Run reports against your virtual accounts.

  • Modify your email notification settings.

  • View overall account information.

CSSM Help describes the procedures for carrying out these tasks.

Overview of License Conversion Feature

The license conversion feature migrates the traditional licenses that are installed on Cisco Catalyst 3850 and Cisco Catalyst 3650 switches, from Cisco IOS XE Fuji 16.8.x or earlier to Cisco IOS XE Fuji 16.9.1or later. Subscription-based add-on licenses, that is DNA Advantage and DNA Essentials, are deposited in your Cisco smart account if purchased.

The license conversion feature migrates all the installed traditional licenses from the device to the Cisco Smart Software Manager. On initiating license conversion, the device converts the traditional licenses and sends the migration data to the Cisco Smart Software Manager, which in turn, creates license entitlements and deposits them in the user account.


Note

The license conversion process takes an hour or more to complete. Use the show license summary command to confirm that the license conversion is completed successfully.

Connecting to CSSM

The following illustration shows the various options available to connect to CSSM:

Figure 1. Connection Options

  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.

Configuring a Connection to CSSM and Setting Up the License Level

The following sections provide information about how to set up a connection to CSSM and set up the license level.

Setting Up a Connection to CSSM

The following steps show how to set up a Layer 3 connection to CSSM to verify network reachability. Skip this section if you already have Layer 3 connectivity to CSSM.

Procedure

  Command or Action Purpose

Step 1

enable

Example:

Device> enable

Enables privileged EXEC mode.

Enter your password, if prompted.

Step 2

configure terminal

Example:

Device# configure terminal

Enters global configuration mode.

Step 3

{ip | ipv6} name-server server-address 1 [server-address 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

Configures Domain Name System (DNS).

Step 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]

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

(Optional) Configures DNS on the VRF interface.

Note

 

You should configure this command as an alternative to the ip name-server command.

Step 5

ip domain lookup source-interface interface-type interface-number

Example:

Device(config)# ip domain lookup source-interface Vlan100

(Optional) Configures the source interface for the DNS domain lookup.

Step 6

ip domain name example.com

Example:

Device(config)# ip domain name example.com

Configures the domain name.

Step 7

ip host tools.cisco.com ip-address

Example:

Device(config)# ip host tools.cisco.com 209.165.201.30

(Optional) Configures static hostname-to-address mappings in the DNS hostname cache if automatic DNS mapping is not available.

Step 8

interface vlan_id

Example:


Device(config)# interface Vlan100
Device(config-if)# ip address 192.0.2.10 255.255.255.0
Device(config-if)# exit

Configures a Layer 3 interface.

Step 9

ntp server ip-address [version number] [key key-id] [prefer]

Example:

Device(config)# ntp server 198.51.100.100 version 2 prefer

Forms a server association with the specified system.

Note

 

The ntp server command is mandatory to ensure that the device time is synchronized with CSSM.

Step 10

switchport access vlan vlan_id

Example:


Device(config)# interface GigabitEthernet1/0/1
Device(config-if)# switchport access vlan 100
Device(config-if)# switchport mode access
Device(config-if)# exit
Device(config)#

(Optional) Enables the VLAN for which this access port carries traffic and sets the interface as a nontrunking nontagged single-VLAN Ethernet interface.

Note

 

This step is to be configured only if the switchport access mode is required.

Step 11

ip route ip-address ip-mask subnet mask

Example:


Device(config)# ip route 192.0.2.0 255.255.255.255 192.0.2.1

Configures a route on the device.

Note

 

You can configure either a static route or a dynamic route.

Step 12

license smart transport callhome

Example:

Device(config)# license smart transport callhome

Enables the transport mode as Call Home.

Note

 

The license smart transport callhome command is mandatory.

Step 13

ip http client source-interface interface-type interface-number

Example:

Device(config)# ip http client source-interface
Vlan100

Configures a source interface for the HTTP client.

Note

 

The ip http client source-interface interface-type interface-number command is mandatory.

Step 14

exit

Example:

Device(config)# exit

(Optional) Exits global configuration mode and returns to privileged EXEC mode.

Step 15

copy running-config startup-config

Example:

Device# copy running-config startup-config

(Optional) Saves your entries in the configuration file.

Configuring the Call Home Service for Direct Cloud Access


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:

Procedure

  Command or Action Purpose

Step 1

enable

Example:

Device> enable

Enables privileged EXEC mode.

Enter your password, if prompted.

Step 2

configure terminal

Example:

Device# configure terminal

Enters global configuration mode.

Step 3

call-home

Example:

Device(config)# call-home

Enters Call Home configuration mode.

Step 4

no http secure server-identity-check

Example:

Device(config-call-home)# no http secure server-identity-check

Disables server identity check when HTTP connection is established.

Step 5

contact-email-address email-address

Example:

Device(config-call-home)# contact-email-addr username@example.com

Assigns customer's email address. You can enter up to 200 characters in email address format with no spaces.

Step 6

profile CiscoTAC-1

Example:

Device(config-call-home)# profile CiscoTAC-1

By default, the CiscoTAC-1 profile is inactive. To use this profile with the Call Home service, you must enable the profile.

Step 7

destination transport-method http

Example:

Device(config-call-home-profile)# destination transport-method http

Enables the Call Home service via HTTP.

Step 8

destination address http url

Example:

Device(config-call-home-profile)# destination address http https://tools.cisco.com/its/service/oddce/services/DDCEService

Connects to CSSM.

Step 9

active

Example:

Device(config-call-home-profile)# active

Enables the destination profile.

Step 10

no destination transport-method email

Example:

Device(config-call-home-profile)# no destination transport-method email

Disables the Call Home service via email.

Step 11

exit

Example:

Device(config-call-home-profile)# exit

Exits Call Home destination profile configuration mode and returns to Call Home configuration mode.

Step 12

exit

Example:

Device(config-call-home)# exit

Exits Call Home configuration mode and returns to global configuration mode.

Step 13

service call-home

Example:

Device(config)# service call-home

Enables the Call Home feature.

Step 14

exit

Example:

Device(config)# exit

Exits global configuration mode and returns to privileged EXEC mode.

Step 15

copy running-config startup-config

Example:

Device# copy running-config startup-config

(Optional) Saves your entries in the configuration file.

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.


Note

Authenticated HTTPs proxy configurations are not supported.

To configure and enable the Call Home service through an HTTPs proxy, perform this procedure:

Procedure

  Command or Action Purpose

Step 1

enable

Example:

Device> enable

Enables privileged EXEC mode.

Enter your password, if prompted.

Step 2

configure terminal

Example:

Device# configure terminal

Enters global configuration mode.

Step 3

call-home

Example:

Device(config)# call-home

Enters Call Home configuration mode.

Step 4

contact-email-address email-address

Example:

Device(config-call-home)# contact-email-addr sch-smart-licensing@cisco.com

Configures the default email address as sch-smart-licensing@cisco.com.

Step 5

http-proxy proxy-address proxy-port port-number

Example:

Device(config-call-home)# http-proxy 198.51.100.10 port 3128

Configures the proxy server information to the Call Home service.

Step 6

profile CiscoTAC-1

Example:

Device(config-call-home)# profile CiscoTAC-1

By default, the CiscoTAC-1 profile is inactive. To use this profile with the Call Home service, you must enable the profile.

Step 7

destination transport-method http

Example:

Device(config-call-home-profile)# destination transport-method http

Enables the Call Home service via HTTP.

Step 8

no destination transport-method email

Example:

Device(config-call-home-profile)# no destination transport-method email

Disables the Call Home service via email.

Step 9

profile name

Example:

Device(config-call-home)# profile test1

Enters Call Home destination profile configuration mode for the specified destination profile name. If the specified destination profile does not exist, it is created.

Step 10

reporting smart-licensing-data

Example:

Device(config-call-home-profile)# reporting smart-licensing-data

Enables data sharing with the Call Home service via HTTP.

Step 11

destination transport-method http

Example:

Device(config-call-home-profile)# destination transport-method http

Enables the HTTP message transport method.

Step 12

destination address http url

Example:

Device(config-call-home-profile)# destination address http 
https://tools.cisco.com/its/service/oddce/services/DDCEService

Connects to CSSM.

Step 13

active

Example:

Device(config-call-home-profile)# active

Enables the destination profile.

Step 14

exit

Example:

Device(config-call-home-profile)# exit

Exits Call Home destination profile configuration mode and returns to Call Home configuration mode.

Step 15

exit

Example:

Device(config-call-home)# exit

Exits Call Home configuration mode and returns to global configuration mode.

Step 16

service call-home

Example:

Device(config)# service call-home

Enables the Call Home feature.

Step 17

ip http client proxy-server proxy-address proxy-port port-number

Example:

Device(config)# ip http client proxy-server 198.51.100.10 port 3128

Enables the Call Home feature.

Step 18

exit

Example:

Device(config)# exit

Exits global configuration mode and returns to privileged EXEC mode.

Step 19

copy running-config startup-config

Example:

Device# copy running-config startup-config

(Optional) Saves your entries in the configuration file.

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, perform this procedure:

Procedure

  Command or Action Purpose

Step 1

enable

Example:

Device> enable

Enables privileged EXEC mode.

Enter your password if prompted.

Step 2

configure terminal

Example:

Device# configure terminal

Enters global configuration mode.

Step 3

call-home

Example:

Device(config)# call-home

Enters Call Home configuration mode.

Step 4

no http secure server-identity-check

Example:

Device(config-call-home)# no http secure server-identity-check

Disables server identity check when HTTP connection is established.

Step 5

profile name

Example:

Device(config-call-home)# profile test1

Enters Call Home destination profile configuration mode for the specified destination profile name. If the specified destination profile does not exist, it is created.

Step 6

reporting smart-licensing-data

Example:

Device (config-call-home-profile)# reporting smart-licensing-data

Enables data sharing with the Call Home service via HTTP.

Step 7

destination transport-method http

Example:

Device(config-call-home-profile)# 
destination address http https://209.165.201.15:443/Transportgateway/services/DeviceRequestHandler

or

Device(config-call-home-profile)# 
destination address http http://209.165.201.15:80/Transportgateway/services/DeviceRequestHandler

Configures the destination URL (CSSM) to which Call Home messages are sent.

Note

Ensure the IP address or the fully qualified domain name (FQDN) in the destination URL matches the IP address or the FQDN as configured for the Satellite Name on the Cisco Smart Software Manager On-Prem.

Step 8

destination address http url

Example:

Device(config-call-home-profile)# destination address http https://url.example.com

Configures the destination URL (CSSM) to which Call Home messages are sent.

Step 9

destination preferred-msg-format {long-text | short-text | xml}

Example:

Device(config-call-home-profile)# destination preferred-msg-format xml

(Optional) Configures a preferred message format. The default is XML.

Step 10

active

Example:

Device(config-call-home-profile)# active

Enables the destination profile. By default, a profile is enabled when it is created.

Step 11

exit

Example:

Device(config-call-home-profile)# exit

Exits Call Home destination profile configuration mode and returns to Call Home configuration mode.

Step 12

exit

Example:

Device(config-call-home)# exit

Exits Call Home configuration mode and returns to global configuration mode.

Step 13

ip http client source-interface interface-type interface-number

Example:

Device(config)# ip http client source-interface Vlan100

Configures a source interface for the HTTP client.

Note

 

The ip http client source-interface interface-type interface-number command is mandatory for a vrf interface.

Step 14

crypto pki trustpoint name

Example:

Device(config)# crypto pki trustpoint SLA-TrustPoint

(Optional) Declares the trustpoint and a given name and enters ca-trustpoint configuration mode.

Step 15

revocation-check none

Example:

Device(ca-trustpoint)# revocation-check none

(Optional) Specifies that certificate checking is ignored.

Step 16

end

Example:

Device(ca-trustpoint)# end

(Optional) Exits ca-trustpoint configuration mode and returns to privileged EXEC mode.

Step 17

copy running-config startup-config

Example:

Device# copy running-config startup-config

(Optional) Saves your entries in the configuration file.

Configuring the License Level

This procedure is optional. You can use this procedure to:

  • Downgrade or upgrade licenses.

  • Enable or disable an evaluation or extension license.

  • Clear an upgrade license.

Configure the required license levels on the device before registering. The following are the license levels available for Cisco Catalyst 3000 Series Switches:

Base licenses

  • LAN Base—Supports Layer 2 features.

  • IP Base—Supports Layer 2 and Layer 3 features.

  • IP Services—Supports Layer 2, Layer 3, and IPv6 features.

Add-on licenses—These licenses can be subscribed for a fixed term of three, five, or seven years.

  • Digital Networking Architecture (DNA) Essentials

  • DNA Advantage (includes DNA Essentials)

To configure the license levels, follow this procedure:

Procedure

  Command or Action Purpose

Step 1

enable

Example:

Device> enable

Enables privileged EXEC mode.

Enter your password, if prompted.

Step 2

configure terminal

Example:

Device# configure terminal

Enters global configuration mode.

Step 3

license boot level license_level

Example:

Device(config)# license boot level ipservices

Activates the licenses on the switch.

Step 4

exit

Example:

Device(config)# exit

Returns to privileged EXEC mode.

Step 5

write memory

Example:

Device# write memory

Saves the license information on the switch.

Step 6

show version

Example:

Device# show version
Snippet
------------------------------------------------------------------------------
Technology-package Current     Type                     Technology-package Next reboot                                                 
------------------------------------------------------------------------------
ipbasek9                       Smart License                    ipservicesk9            
None                           Subscription Smart License       None

Shows license-level information.

Step 7

reload

Example:

Device# reload

Reloads the device.

Registering a Device in CSSM

The following sections provide information about how to register a device in CSSM.

Generating a New Token from CSSM

Tokens are generated to register new product instances to the virtual account.

Procedure

Step 1

Log in to CSSM from https://software.cisco.com/#.

You must log in to the portal using the username and password provided by Cisco.

Step 2

Click the Inventory tab.

Step 3

From the Virtual Account drop-down list, choose the required virtual account.

Step 4

Click the General tab.

Step 5

Click New Token.

The Create Registration Token window is displayed.

Step 6

In the Description field, enter the token description.

Step 7

In the Expire After field, enter the number of days the token must be active.

Step 8

(Optional) In the Max. Number of Uses field, enter the maximum number of uses allowed after which the token expires.

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.

Step 10

Click Create Token to create a token.

Step 11

After the token is created, click Copy to copy the newly created token.

What to do next

Registering Device with Token

Registering a Device with the New Token

To register a device with the new token, perform this procedure:

Procedure

  Command or Action Purpose

Step 1

enable

Example:

Device> enable

Enables privileged EXEC mode.

Enter your password, if prompted.

Step 2

license smart register idtoken token_ID

Example:

Device# license smart register idtoken $Tl4UytrNXBzbEs1ck8veUtWaG5abnZJOFdDa1FwbVRa%0AblRMbz0%3D%0A

Registers the device with the back-end server using the token generated from CSSM.

Step 3

write memory

Example:

Device# write memory

Saves the license information on the device.

Verifying the License Status After Registration

To verify the status of a license after registration, use the show license all command. 


Device> enable
Device# show license all
Smart Licensing Status
======================

Smart Licensing is ENABLED

Registration:
  Status: REGISTERED
  Smart Account: Smart Account Name
  Virtual Account: Virtual Account 1
  Export-Controlled Functionality: Allowed
  Initial Registration: SUCCEEDED on Jul 09 10:08:19 2018 UTC
  Last Renewal Attempt: None
  Next Renewal Attempt: Jan 05 10:08:19 2019 UTC
  Registration Expires: Jul 09 10:02:35 2019 UTC

License Authorization: 
  Status: OUT OF COMPLIANCE on Jul 09 10:08:25 2018 UTC
  Last Communication Attempt: SUCCEEDED on Jul 09 10:08:25 2018 UTC
  Next Communication Attempt: Jul 09 22:08:24 2018 UTC
  Communication Deadline: Oct 07 10:02:43 2018 UTC

License Conversion:
  Automatic Conversion Enabled: False
  Active: PID:WS-C3850-24P,SN:FOC1842U0FC
  Status: Not started
  Standby: PID:WS-C3850-24P,SN:FOC1842U0CZ
  Status: Not started
  Member: PID:WS-C3850-24P,SN:FOC1842X0FD
  Status: Not started

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
==============

C3850-DNA-E-24 (C3850-24 DNA Essentials):
  Description: C3850-DNA-E
  Count: 3
  Version: 1.0
  Status: AUTHORIZED

C3850_24_Lanbase (C3850-24 LAN Base):
  Description: C3850 24 Port Lanbase
  Count: 3
  Version: 1.0
  Status: OUT OF COMPLIANCE

Product Information
===================
UDI: PID:WS-C3850-24P,SN:FOC1842U0FC

HA UDI List:
    Active:PID:WS-C3850-24P,SN:FOC1842U0FC
    Standby:PID:WS-C3850-24P,SN:FOC1842U0CZ
    Member:PID:WS-C3850-24P,SN:FOC1842X0FD

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

Canceling a Device's Registration in CSSM

When your device is taken off the inventory, shipped elsewhere for redeployment, or returned to Cisco for replacement using the return merchandise authorization (RMA) process, you can use the deregister command to cancel the registration of your device.

To cancel device registration, follow this procedure:

Before you begin

Layer 3 connection to CSSM must be available to successfully deregister the device.

Procedure

  Command or Action Purpose

Step 1

enable

Example:

Device> enable

Enables privileged EXEC mode.

Enter your password, if prompted.

Step 2

license smart deregister

Example:

Device# license smart deregister

Cancels the device's registration, and sends the device into evaluation mode. All smart licensing entitlements and certificates on the corresponding platform are removed. The device product instance stored on CSSM is also removed.

Migrating a License with License Conversion Feature

The following sections provide information about how to enable license conversion in CSSM and convert licenses on a device using license conversion.

Enabling License Conversion in CSSM

License conversion must be enabled before starting the conversion. Failure to enable license conversion will result in the CSSM displaying an insufficient licenses error.

Before you begin

You must be logged in as a Smart Account administrator.

Procedure

Step 1

Log in to CSSM from https://software.cisco.com/#.

You must log in to the portal using the username and password provided by Cisco.

Step 2

Click the Convert to Smart Licensing tab.

Step 3

Click the Conversion Settings tab.

Step 4

In the Device Led Conversion to Smart Licensing pane, select Enabled in the drop-down list.

Converting Licenses on a Device Using License Conversion

To convert licenses on a device using license conversion, perform this procedure:

Procedure

  Command or Action Purpose

Step 1

enable

Example:

Device> enable

Enables privileged EXEC mode.

Enter your password, if prompted.

Step 2

license smart conversion start

Example:

Device# license smart conversion start

Migrates the license to CSSM.

License Status Change for Evaluation and Expired Evaluation Licenses

To ensure audit compliance for all your licenses, starting with Cisco IOS XE Gibraltar 16.12.6, a device that is not connected to CSSM will see a change in the license status field, only for evaluation and expired evaluation licenses.

This change does not alter any Smart Licensing functionality.

The following sections clarify the various aspects of this change:

Change Details and Sample Output

Example 1: EVAL MODE → IN-USE

Sample outputs of the show license summary command on a Catalyst 3850 switch displays the following:

  • What was displayed as EVAL MODE (evaluation license) prior to Cisco IOS XE Gibraltar 16.12.6, is displayed as IN-USE starting from Cisco IOS XE Gibraltar 16.12.6.

  • The accompanying notification relating to the remaining evaluation period is no longer displayed.

  • The registration status remains unchanged.

Example 2: EVAL EXPIRED → IN-USE

Sample outputs of the show license summary command on a Catalyst 3850 switch displays the following:

  • What was displayed as EVAL EXPIRED (expired evaluation license) prior to Cisco IOS XE Gibraltar 16.12.6, is displayed as IN-USE starting from Cisco IOS XE Gibraltar 16.12.6.

  • The registration status remains unchanged.

This change is also displayed in all other show commands where license status information is included in the output. See the System Management Commands section of the Command Reference:

Command Reference, Cisco IOS XE Gibraltar 16.12.x (Catalyst 3650 Switches)

Command Reference, Cisco IOS XE Gibraltar 16.12.x (Catalyst 3850 Switches)

Conditions

This change is effective only under the following conditions:

  • The device was using an evaluation license or an expired evaluation license prior to Cisco IOS XE Gibraltar 16.12.6.

  • The device is not connected to CSSM.

  • The device is now running Cisco IOS XE Gibraltar 16.12.6 or a later release.


Note

If a device is connected to CSSM, there will be no change in the license status field for an evaluation or expired evaluation license.

Applicable Devices

Only Cisco Catalyst 3650 Series Switches and Cisco Catalyst 3850 Series Switches.

Monitoring Smart Licensing Configuration

Use the following commands in privileged EXEC mode to monitor smart licensing configuration.

Table 1. Commands to Monitor Smart Licensing Configuration

Command

Purpose

show license status

Displays the compliance status of smart licensing. The following is the list of possible statuses:

  • Enabled: Indicates that smart licensing is enabled.

  • Waiting: Indicates the initial state after your device has made a license entitlement request. The device establishes communication with Cisco and successfully registers itself with the CSSM.

  • Registered: Indicates that your device is able to communicate with the CSSM, and is authorized to initiate requests for license entitlements.

  • Authorized: Indicates that your device is in Compliance status and is authorized to use the requested type and count of licenses. The Authorization status has a lifetime of 90 days. At the end of 30 days, the device will send a new entitlement authorization request to the CSSM to renew the authorization.

  • Out Of Compliance: Indicates that one or more of your licenses are out of compliance. You must buy additional licenses.

  • Eval Mode: You must register the device with the CSSM within 90 days (of device usage). Otherwise, your device's evaluation period will expire.

  • Eval Expired: At the end of 90 days, if your device has not registered, the device enters Evaluation Expired mode.

  • In-Use: Indicates that the license is being used on the device, and that the device is not connected to CSSM.

    Only a device that is running Cisco IOS XE Gibraltar 16.12.6 or later release, and one that is not connected to CSSM, will see this license status displayed for what used to be an evaluation or expired evaluation license prior to Cisco IOS XE Gibraltar 16.12.6.

    See License Status Change for Evaluation and Expired Evaluation Licenses

show license all

Displays all the entitlements in use. Additionally, it shows the associated licensing certificates, compliance status, UDI, and other details.

show tech-support license

Displays the detailed debug output.

show license usage

Displays the license usage information.

show license summary

Displays the summary of all the active licenses.

Configuration Examples for Smart Licensing

The following sections provide various Smart Licensing configuration examples.

Example: Viewing the Call Home Profile

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: Viewing the License Information Before Registering

Example

To display the license entitlements, use the show license all command: 


Device> enable
Device# show license all
Smart Licensing Status
======================

Smart Licensing is ENABLED

Registration:
  Status: UNREGISTERED
  Export-Controlled Functionality: Not Allowed

License Authorization: 
  Status: EVAL MODE
  Evaluation Period Remaining: 88 days, 21 hours, 58 minutes, 12 seconds

License Conversion:
  Automatic Conversion Enabled: False
  Active: PID:WS-C3850-24P,SN:FOC1842U0FC
  Status: Not started
  Standby: PID:WS-C3850-24P,SN:FOC1842U0CZ
  Status: Not started
  Member: PID:WS-C3850-24P,SN:FOC1842X0FD
  Status: Not started

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
==============

(C3850-24 DNA Essentials):
  Description: 
  Count: 3
  Version: 1.0
  Status: EVAL MODE

(C3850-24 LAN Base):
  Description: 
  Count: 3
  Version: 1.0
  Status: EVAL MODE

Product Information
===================
UDI: PID:WS-C3850-24P,SN:FOC1842U0FC

HA UDI List:
    Active:PID:WS-C3850-24P,SN:FOC1842U0FC
    Standby:PID:WS-C3850-24P,SN:FOC1842U0CZ
    Member:PID:WS-C3850-24P,SN:FOC1842X0FD

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
License Authorization: 
  Status: EVAL MODE
  Evaluation Period Remaining: 88 days, 21 hours, 57 minutes, 31 seconds

(C3850-24 DNA Essentials):
  Description: 
  Count: 3
  Version: 1.0
  Status: EVAL MODE

(C3850-24 LAN Base):
  Description: 
  Count: 3
  Version: 1.0
  Status: EVAL MODE

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: UNREGISTERED
  Export-Controlled Functionality: Not Allowed

License Authorization: 
  Status: EVAL MODE
  Evaluation Period Remaining: 88 days, 21 hours, 57 minutes, 23 seconds

License Usage:
  License                 Entitlement tag               Count Status
  -----------------------------------------------------------------------------
                          (C3850-24 DNA Essentials)         3 EVAL MODE
                          (C3850-24 LAN Base)               3 EVAL MODE

Example

To display the license status information, use the show license status command: 


Device> enable
Device# show license status
Smart Licensing is ENABLED

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: 88 days, 21 hours, 57 minutes, 15 seconds

License Conversion:
  Automatic Conversion Enabled: False
  Active: PID:WS-C3850-24P,SN:FOC1842U0FC
  Status: Not started
  Standby: PID:WS-C3850-24P,SN:FOC1842U0CZ
  Status: Not started
  Member: PID:WS-C3850-24P,SN:FOC1842X0FD
  Status: Not started

Example: Registering a Device

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: Viewing the License Status After Registering

After registration, but before license conversion, a device is not authorized to use the perpetual license, and its status will be shown as Out Of Compliance.

Example

To display the license entitlements, use the show license all command: 


Device> enable
Device# show license all
Smart Licensing Status
======================

Smart Licensing is ENABLED

Registration:
  Status: REGISTERED
  Smart Account: Smart Account Name
  Virtual Account: Virtual Account 1
  Export-Controlled Functionality: Allowed
  Initial Registration: SUCCEEDED on Jul 09 10:08:19 2018 UTC
  Last Renewal Attempt: None
  Next Renewal Attempt: Jan 05 10:08:19 2019 UTC
  Registration Expires: Jul 09 10:02:35 2019 UTC

License Authorization: 
  Status: OUT OF COMPLIANCE on Jul 09 10:08:25 2018 UTC
  Last Communication Attempt: SUCCEEDED on Jul 09 10:08:25 2018 UTC
  Next Communication Attempt: Jul 09 22:08:24 2018 UTC
  Communication Deadline: Oct 07 10:02:43 2018 UTC

License Conversion:
  Automatic Conversion Enabled: False
  Active: PID:WS-C3850-24P,SN:FOC1842U0FC
  Status: Not started
  Standby: PID:WS-C3850-24P,SN:FOC1842U0CZ
  Status: Not started
  Member: PID:WS-C3850-24P,SN:FOC1842X0FD
  Status: Not started

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
==============

C3850-DNA-E-24 (C3850-24 DNA Essentials):
  Description: C3850-DNA-E
  Count: 3
  Version: 1.0
  Status: AUTHORIZED

C3850_24_Lanbase (C3850-24 LAN Base):
  Description: C3850 24 Port Lanbase
  Count: 3
  Version: 1.0
  Status: OUT OF COMPLIANCE

Product Information
===================
UDI: PID:WS-C3850-24P,SN:FOC1842U0FC

HA UDI List:
    Active:PID:WS-C3850-24P,SN:FOC1842U0FC
    Standby:PID:WS-C3850-24P,SN:FOC1842U0CZ
    Member:PID:WS-C3850-24P,SN:FOC1842X0FD

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: OUT OF COMPLIANCE on Jul 09 10:08:25 2018 UTC

C3850-DNA-E-24 (C3850-24 DNA Essentials):
  Description: C3850-DNA-E
  Count: 3
  Version: 1.0
  Status: AUTHORIZED

C3850_24_Lanbase (C3850-24 LAN Base):
  Description: C3850 24 Port Lanbase
  Count: 3
  Version: 1.0
  Status: OUT OF COMPLIANCE

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: None
  Next Renewal Attempt: Jan 05 10:08:19 2019 UTC

License Authorization: 
  Status: OUT OF COMPLIANCE
  Last Communication Attempt: SUCCEEDED
  Next Communication Attempt: Jul 09 22:08:24 2018 UTC

License Usage:
  License                 Entitlement tag               Count Status
  -----------------------------------------------------------------------------
  C3850-DNA-E-24          (C3850-24 DNA Essentials)         3 AUTHORIZED
  C3850_24_Lanbase        (C3850-24 LAN Base)               3 OUT OF COMPLIANCE

Example

To display the license status information, use the show license status command: 


Device> enable
Device# show license status
Smart Licensing is ENABLED

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: SUCCEEDED on Jul 09 10:08:19 2018 UTC
  Last Renewal Attempt: None
  Next Renewal Attempt: Jan 05 10:08:20 2019 UTC
  Registration Expires: Jul 09 10:02:36 2019 UTC

License Authorization: 
  Status: OUT OF COMPLIANCE on Jul 09 10:08:25 2018 UTC
  Last Communication Attempt: SUCCEEDED on Jul 09 10:08:25 2018 UTC
  Next Communication Attempt: Jul 09 22:08:25 2018 UTC
  Communication Deadline: Oct 07 10:02:44 2018 UTC

License Conversion:
  Automatic Conversion Enabled: False
  Active: PID:WS-C3850-24P,SN:FOC1842U0FC
  Status: Not started
  Standby: PID:WS-C3850-24P,SN:FOC1842U0CZ
  Status: Not started
  Member: PID:WS-C3850-24P,SN:FOC1842X0FD
  Status: Not started

Example: Migrating License Using License Conversion


Note

Use the license smart conversion start command only for migrating license information of Cisco Catalyst 3650 and Cisco Catalyst 3850 Switch upgraded to Cisco IOS XE Fuji 16.9.1.

License conversion takes an hour or more to complete.

To start license conversion use the license smart conversion start command. 


Device> enable
Device# license smart conversion start

Example: Viewing License Information on Initiating License Conversion

Example

To display the license usage information, use the show license usage command: 


Device> enable
Device# show license usage
License Authorization: 
  Status: OUT OF COMPLIANCE on Jul 09 10:08:25 2018 UTC

C3850-DNA-E-24 (C3850-24 DNA Essentials):
  Description: C3850-DNA-E
  Count: 3
  Version: 1.0
  Status: AUTHORIZED

C3850_24_Lanbase (C3850-24 LAN Base):
  Description: C3850 24 Port Lanbase
  Count: 3
  Version: 1.0
  Status: OUT OF COMPLIANCE

Example

To display the license status information, use the show license status command: 


Device> enable
Device# show license status
Smart Licensing is ENABLED

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: SUCCEEDED on Jul 09 10:08:19 2018 UTC
  Last Renewal Attempt: None
  Next Renewal Attempt: Jan 05 10:08:19 2019 UTC
  Registration Expires: Jul 09 10:02:35 2019 UTC

License Authorization: 
  Status: OUT OF COMPLIANCE on Jul 09 10:08:25 2018 UTC
  Last Communication Attempt: SUCCEEDED on Jul 09 10:14:50 2018 UTC
  Next Communication Attempt: Jul 09 22:14:49 2018 UTC
  Communication Deadline: Oct 07 10:09:08 2018 UTC

License Conversion:
  Automatic Conversion Enabled: False
  Active: PID:WS-C3850-24P,SN:FOC1842U0FC
  Status: Polling on Jul 09 10:16:01 2018 UTC
  Next response check: Jul 09 11:16:05 2018 UTC
  Standby: PID:WS-C3850-24P,SN:FOC1842U0CZ
  Status: Not started
  Member: PID:WS-C3850-24P,SN:FOC1842X0FD
  Status: Not started

Example: Viewing the License Status After License Conversion

After license conversion is completed, the device is authorized to use the perpetual license and the status will change to Authorized.

Example

To display license usage information, use the show license usage command: 


Device> enable
Device# show license usage
License Authorization: 
  Status: AUTHORIZED on Jul 09 11:16:10 2018 UTC

C3850-DNA-E-24 (C3850-24 DNA Essentials):
  Description: C3850-DNA-E
  Count: 3
  Version: 1.0
  Status: AUTHORIZED

C3850_24_Lanbase (C3850-24 LAN Base):
  Description: C3850 24 Port Lanbase
  Count: 3
  Version: 1.0
  Status: AUTHORIZED

Example

To display the license status information, use the show license status command: 


Device> enable
Device# show license status
Smart Licensing is ENABLED

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: SUCCEEDED on Jul 09 10:08:19 2018 UTC
  Last Renewal Attempt: None
  Next Renewal Attempt: Jan 05 10:08:19 2019 UTC
  Registration Expires: Jul 09 10:02:35 2019 UTC

License Authorization: 
  Status: AUTHORIZED on Jul 09 11:16:10 2018 UTC
  Last Communication Attempt: SUCCEEDED on Jul 09 11:16:10 2018 UTC
  Next Communication Attempt: Aug 08 11:16:09 2018 UTC
  Communication Deadline: Oct 07 11:10:28 2018 UTC

License Conversion:
  Automatic Conversion Enabled: False
  Active: PID:WS-C3850-24P,SN:FOC1842U0FC
  Status: Successful on Jul 09 11:16:06 2018 UTC
  Standby: PID:WS-C3850-24P,SN:FOC1842U0CZ
  Status: Successful on Jul 09 11:16:06 2018 UTC
  Member: PID:WS-C3850-24P,SN:FOC1842X0FD
  Status: Successful on Jul 09 11:16:06 2018 UTC

Additional References

Related Documents

Related Topic Document Title

Cisco Smart Software Manager Help

Smart Software Manager Help

Cisco Smart Software Manager On-Prem

Cisco Smart Software Manager On-Prem

Configuring DNS

Setting up DNS

Configuring Call Home service

Smart Call Home Guide

Technical Assistance

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.

http://www.cisco.com/support

Feature History For Smart Licensing

This table provides release and related information for features explained in this module.

These features are available on all releases subsequent to the one they were introduced in, unless noted otherwise.

Command History

Release

Modification

Cisco IOS XE Fuji 16.9.1

This feature was introduced.

Cisco IOS XE Gibraltar 16.12.6

License status change for evaluation and expired evaluation license.

If a device is not connected to CSSM, what was displayed as EVAL MODE and EVAL EXPIRED (prior to Cisco IOS XE Gibraltar 16.12.6), is displayed as IN-USE starting from Cisco IOS XE Gibraltar 16.12.6.

For detailed information, see License Status Change for Evaluation and Expired Evaluation Licenses