Implementing Smart Licensing Using Policy

This chapter provides the simplest and fastest way to implement Smart Licensing Using Policy for new deployments. If you are migrating from an existing licensing model, see Migrating to Smart Licensing Using Policy.

Workflow for Topology: Connected to Cisco SSM Through CSLU

Depending on whether you want to implement a product instance-initiated or CSLU-initiated method of communication, complete the corresponding sequence of tasks:

Tasks for Product Instance-Initiated Communication

CSLU Installation → CSLU Preference Settings → Product Instance Configuration → Authorization Code Installation (Only if Applicable)

  1. CSLU Installation

    Where task is performed: A laptop, destop, or a Virtual Machine (VM) running Windows 10 or Linux.

    Download the file from Smart Software Manager > Smart Licensing Utility.

    Refer to Cisco Smart License Utility Quick Start Setup Guide and Cisco Smart Licensing Utility User Guide for help with installation and set-up.

  2. CSLU Preference Settings

    Where tasks are performed: CSLU Interface

    1. Logging into Cisco (CSLU Interface)

    2. Configuring a Smart Account and a Virtual Account (CSLU Interface)

    3. Adding a Product-Initiated Product Instance in CSLU (CSLU Interface)

  3. Product Instance Configuration

    Where tasks are performed: Product Instance

    1. Ensuring Network Reachability for Product Instance-Initiated Communication

    2. Ensure that transport type is set to cslu.

      CSLU is the default transport type. If you have configured a different option, enter the license smart transport cslu command in global configuration mode. Save any changes to the configuration file. 
      Device(config)# license smart transport cslu
Device(config)# exit
Device# copy running-config startup-config

    3. Specify how you want CSLU to be discovered (choose one):

      • Option 1:

        No action required. Name server configured for Zero-touch DNS discovery of cslu-local

        Here, if you have configured DNS (The name server IP address is configured on the product instance), and the DNS server has an entry where hostname cslu-local is mapped to the CSLU IP address, then no further action is required. The product instance automatically discovers hostname cslu-local.

      • Option 2:

        No action required. Name server and domain configured for Zero-touch DNS discovery of cslu-local.<domain>

        Here if you have configured DNS, (The name server IP address and domain is configured on the product instance), and the DNS server has an entry where cslu-local.<domain> is mapped to the CSLU IP address, then no further action is required. The product instance automatically discovers hostname cslu-local.

      • Option 3:

        Configure a specific URL for CSLU.

        Enter the license smart url cslu http://<cslu_ip_or_host>:8182/cslu/v1/pi command in global configuration mode. For <cslu_ip_or_host>, enter the hostname or the IP address of the windows host where you have installed CSLU. 8182 is the port number and it is the only port number that CSLU uses. 
        Device(config)# license smart url cslu http://192.168.0.1:8182/cslu/v1/pi
Device(config)# exit
Device# copy running-config startup-config

  4. Authorization Code Installation (Only if Applicable)

    Where tasks is performed: Product Instance

    An export-controlled license is supported only on certain models of the Cisco Catalyst Access, Core, and Aggregation Switches (See Returning an Authorization Code). If you want to use an export-controlled license, complete the following task on supported platforms: Manually Requesting and Auto-Installing a SLAC.

Result:

Since the product instance initiates communication, it automatically sends out the first RUM report at the scheduled time, as per the policy. Along with this first report, if applicable, it sends a request for a UDI-tied trust code. CSLU forwards the RUM report to Cisco SSM and retrieves the ACK, which also contains the trust code. The ACK is applied to the product instance the next time the product instance contacts CSLU.

In the product instance-initiated mode, the product instance does not send more than one RUM report a day. You can override this for an on-demand synchronization between the product instance and CSLU, by entering the license smart sync command in privileged EXEC mode

To know when the product instance will be sending the next RUM report, enter the show license all command in privileged EXEC mode and in the output, check the date in the Next report push field.

To verify trust code installation, enter the show license status command in privileged EXEC mode. Check for the updated timestamp in the Trust Code Installed field.

If you want to change the boot level license, see Configuring a Base or Add-On License.

If you want to return an authorization code, see Returning an Authorization Code.

Tasks for CSLU-Initiated Communication

CSLU Installation → CSLU Preference Settings→ Product Instance Configuration→ Authorization Code Installation (Only if Applicable) → Usage Synchronization

  1. CSLU Installation

    Where task is performed: A laptop, destop, or a Virtual Machine (VM) running Windows 10 or Linux.

    Download the file from Smart Software Manager > Smart Licensing Utility.

    Refer to Cisco Smart License Utility Quick Start Setup Guide and Cisco Smart Licensing Utility User Guide for help with installation and set-up.

  2. CSLU Preference Settings

    Where tasks are performed: CSLU Interface

    1. Logging into Cisco (CSLU Interface)

    2. Configuring a Smart Account and a Virtual Account (CSLU Interface)

    3. Adding a Product-Initiated Product Instance in CSLU (CSLU Interface)

  3. Product Instance Configuration

    Where tasks is performed: Product Instance

    Ensuring Network Reachability for Product Instance-Initiated Communication

  4. Authorization Code Installation (Only if Applicable)

    Where tasks are performed: CSLU Interface and Cisco SSM Web UI

    An export-controlled license is supported only on certain models of the Cisco Catalyst Access, Core, and Aggregation Switches (See Returning an Authorization Code). If you want to use an export-controlled license, complete the following tasks on supported platforms:

    1. Manually Requesting and Auto-Installing a SLAC

    2. Requesting SLAC for One or More Product Instance (CSLU Interface)

    3. Generating and Downloading SLAC from Cisco SSM to a File

    4. Import from Cisco SSM (CSLU Interface)

  5. Usage Synchronization

    Where tasks is performed: CSLU Interface

Result:

Since CSLU is logged into Cisco SSM, the reports are automatically sent to the associated Smart Account and Virtual Account in Cisco SSM and Cisco SSM will send an ACK to CSLU as well as to the product instance. It gets the ACK from Cisco SSM and sends this back to the product instance for installation. The ACK from Cisco SSM contains the trust code and SLAC if this was requested.

Trust code request and installation is supported starting with Cisco IOS XE Cupertino 17.9.1.

If you want to change the boot level license, see Configuring a Base or Add-On License.

If you want to return an authorization code, see Returning an Authorization Code.

Adding a Product-Initiated Product Instance in CSLU (CSLU Interface)

Complete these steps to add a device-created Product Instance using the Preferences tab.

Procedure

Step 1

Click the Preferences tab.

Step 2

In the Preferences screen, de-select the Validate Device check box.

Step 3

Set the Default Connect Method to Product Instance Initiated and then click Save.

Adding a CSLU-Initiated Product Instance in CSLU (CSLU Interface)

Using the CSLU interface, you can configure the connect method to be CSLU Initiated. This connect method (mode) enables CSLU to retrieve product instance information.


Note
The default Connect Method is set in the Preferences tab.

Complete these steps to add a Product Instance from the Inventory tab

Procedure

Step 1

Go to the Inventory tab and from the Product Instances table, select Add Single Product.

Step 2

Enter the Host (IP address of the host).

Step 3

Select the Connect Method and select an appropriate CSLU Initiated connect method.

Step 4

In the right panel, click Product Instance Login Credentials. The left panel of the screen changes to show the User Name and Password fields

Step 5

Enter the product instance User Name and Password.

Step 6

Click Save.

The information is saved to the system and the device is listed in the Product Instances table with the Last Contact listed as never.

Workflow for Topology: Connected Directly to Cisco SSM

Smart Account Set-Up → Product Instance Configuration → Trust Establishment with Cisco SSM→ Authorization Code Installation (Only if Applicable)

  1. Smart Account Set-Up

    Where task is performed: Cisco SSM Web UI, https://software.cisco.com/.

    Ensure that you have a user role with proper access rights to a Smart Account and the required Virtual Accounts.

  2. Product Instance Configuration

    Where tasks are performed: Product Instance

    1. Set-Up product instance connection to Cisco SSM: Setting Up a Connection to Cisco SSM.

    2. Configure a connection method and transport type (choose one)

  3. Trust Establishment with Cisco SSM

    Where task is performed: Cisco SSM Web UI and then the product instance

    1. Generate one token for each Virtual Account you have. You can use same token for all the product instances that are part of one Virtual Account: Generating a New Token for a Trust Code from CSSM.

    2. Having downloaded the token, you can now install the trust code on the product instance: Establishing Trust with an ID Token.

  4. Authorization Code Installation (Only if Applicable)

    Where tasks are performed: Product Instance

    An export-controlled license is supported only on certain models of the Cisco Catalyst Access, Core, and Aggregation Switches (See Returning an Authorization Code). If you want to use an export-controlled license, complete the following task on supported platforms: Manually Requesting and Auto-Installing a SLAC.

Result:

After establishing trust, Cisco SSM returns a policy. The policy is automatically installed on all product instances of that Virtual Account. The policy specifies if and how often the product instance reports usage.

The following applies only to Cisco IOS XE Amsterdam 17.3.6 and later releases of the 17.3.x train and Cisco IOS XE Bengaluru 17.6.4 and later releases of the 17.6.x train: the product instance does not send more than one RUM report a day. You can override this for an on-demand synchronization between the product instance and CSLU, by entering the license smart sync command in privileged EXEC mode.

If you want to change your reporting interval to report more frequently: on the product instance, configure the license smart usage interval command in global configuration mode. For syntax details see the license smart (privileged EXEC) command in the Command Reference for the corresponding release.

If you want to change the boot level license, see Configuring a Base or Add-On License.

If you want to return an authorization code, see Returning an Authorization Code.

Workflow for Topology: Connected to Cisco SSM Through a Controller

To deploy Cisco DNA Center as the controller, complete the following workflow:

Product Instance Configuration → Cisco DNA Center Configuration

  1. Product Instance Configuration

    Where task is performed: Product Instance

    Enable NETCONF. Cisco DNA Center uses the NETCONF protocol to provision configuration and retrieve the required information from the product instance - the product instance must therefore have NETCONF enabled, to facilitate this.

    For more information, see the Programmability Configuration Guide, Cisco IOS XE Amsterdam 17.3.x. In the guide, go to Model-Driven Programmability > NETCONF Protocol.

  2. Cisco DNA Center Configuration

    Where tasks is performed: Cisco DNA Center GUI

    An outline of the tasks you must complete and the accompanying documentation reference is provided below. The document provides detailed steps you have to complete in the Cisco DNA Center GUI:

    1. Set-up the Smart Account and Virtual Account.

      Enter the same log in credentials that you use to log in to the Cisco SSM Web UI. This enables Cisco DNA Center to establish a connection with Cisco SSM.

      See the Cisco DNA Center Administrator Guide of the required release (Release 2.2.2 onwards) > Manage Licenses > Set Up License Manager.

    2. Add the required product instances to Cisco DNA Center inventory and assign them to a site.

      This enables Cisco DNA Center to push any necessary configuration, including the required certificates, for Smart Licensing Using Policy to work as expected.

      See the Cisco DNA Center User Guide of the required release (Release 2.2.2 onwards) > Display Your Network Topology > Assign Devices to a Site.

Result:

After you implement the topology, you must trigger the very first ad hoc report in Cisco DNA Center, to establish a mapping between the Smart Account and Virtual Account, and product instance. See the Cisco DNA Center Administrator Guide of the required release (Release 2.2.2 onwards) > Manage Licenses > Upload Resource Utilization Details to Cisco SSM. Once this is done, Cisco DNA Center handles subsequent reporting based on the reporting policy.

If multiple policies are available, Cisco DNA Center maintains the narrowest reporting interval. You can change this, but only to report more frequently (a narrower interval). See the Cisco DNA Center Administrator Guide of the required release (Release 2.2.2 onwards) > Manage Licenses > Modify License Policy.

If you want to change the license level after this, see the Cisco DNA Center Administrator Guide of the required release (Release 2.2.2 onwards) > Manage Licenses > Change License Level.

Workflow for Topology: CSLU Disconnected from Cisco SSM

Depending on whether you want to implement a product instance-initiated or CSLU-initiated method of communication. Complete the corresponding table of tasks below.

Tasks for Product Instance-Initiated Communication

CSLU Installation → CSLU Preference Settings → Product Instance Configuration→ Authorization Code Installation (Only if Applicable)→ Usage Synchronization

  1. CSLU Installation

    Where task is performed: A Windows host (laptop, destop, or a Virtual Machine (VM)

    Download the file from Smart Software Manager > Smart Licensing Utility.

    Refer to the Cisco Smart License Utility Quick Start Setup Guide for help with installation and set-up.

  2. CSLU Preference Settings

    Where tasks are performed: CSLU interface

    1. In the CSLU Preferences tab, click the Cisco Connectivity toggle switch to off. The field switches to “Cisco Is Not Available”.

    2. Configuring a Smart Account and a Virtual Account (CSLU Interface)

    3. Adding a Product-Initiated Product Instance in CSLU (CSLU Interface)

  3. Product Instance Configuration

    Where tasks are performed: Product Instance

    1. Ensuring Network Reachability for Product Instance-Initiated Communication

    2. Ensure that transport type is set to cslu.

      CSLU is the default transport type. If you have configured a different option, enter the license smart transport cslu command in global configuration mode. Save any changes to the configuration file.
      Device(config)# license smart transport cslu
Device(config)# exit
Device# copy running-config startup-config

    3. Specify how you want CSLU to be discovered (choose one)

      • Option 1:

        No action required. Name server configured for Zero-touch DNS discovery of cslu-local

        Here, if you have configured DNS (The name server IP address is configured on the product instance), and the DNS server has an entry where hostname cslu-local is mapped to the CSLU IP address, then no further action is required. The product instance automatically discovers hostname cslu-local.

      • Option 2:

        No action required. Name server and domain configured for Zero-touch DNS discovery of cslu-local.<domain>

        Here if you have configured DNS, (The name server IP address and domain is configured on the product instance), and the DNS server has an entry where cslu-local.<domain> is mapped to the CSLU IP address, then no further action is required. The product instance automatically discovers hostname cslu-local.

      • Option 3:

        Configure a specific URL for CSLU.

        Enter the license smart url cslu http://<cslu_ip_or_host>:8182/cslu/v1/pi command in global configuration mode. For <cslu_ip_or_host>, enter the hostname or the IP address of the windows host where you have installed CSLU. 8182 is the port number and it is the only port number that CSLU uses. 
        Device(config)# license smart url cslu http://192.168.0.1:8182/cslu/v1/pi
Device(config)# exit
Device# copy running-config startup-config

  4. Authorization Code Installation (Only if Applicable)

    Where tasks are performed: Product Instance and Cisco SSM Web UI

    An export-controlled license is supported only on certain models of the Cisco Catalyst Access, Core, and Aggregation Switches (See Authorization Code). If you want to use an export-controlled license, complete the following tasks on supported platforms:

    1. Manually Requesting and Auto-Installing a SLAC

    2. Requesting SLAC for One or More Product Instance (CSLU Interface)

    3. Generating and Downloading SLAC from Cisco SSM to a File

    4. Import from Cisco SSM (CSLU Interface)

  5. Usage Synchronization

    Where tasks are performed: CSLU and Cisco SSM

    Since the product instance initiates communication, it automatically sends out the first RUM report at the scheduled time, as per the policy. You can also enter the license smart sync privileged EXEC command to trigger this. Along with this first report, if applicable, it sends a request for a UDI-tied trust code. Since CSLU is disconnected from Cisco SSM, perform the following tasks to send the RUM Reports to Cisco SSM.

    1. Export to Cisco SSM (CSLU Interface)

    2. Uploading Data or Requests to Cisco SSM and Downloading a File

    3. Import from Cisco SSM (CSLU Interface)

Result:

The ACK you have imported from Cisco SSM contains the trust code if this was requested. The ACK is applied to the product instance the next time the product instance contacts CSLU.

The following applies only to Cisco IOS XE Amsterdam 17.3.6 and later releases of the 17.3.x train and Cisco IOS XE Bengaluru 17.6.4 and later releases of the 17.6.x train: in the product instance-initiated mode, the product instance does not send more than one RUM report a day. You can override this for an on-demand synchronization between the product instance and CSLU, by entering the license smart sync command in privileged EXEC mode.

To know when the product instance will be sending the next RUM report, enter the show license all command in privileged EXEC mode and in the output, check the date for the Next report push field.

If you want to change the boot level license, see Configuring a Base or Add-On License.

If you want to return an authorization code, see Returning an Authorization Code.

Tasks for CSLU-Initiated Communication

CSLU Installation → CSLU Preference Settings → Product Instance Configuration → Authorization Code Installation (Only if Applicable) → Usage Synchronization

  1. CSLU Installation

    Where task is performed: A Windows host (laptop, destop, or a Virtual Machine (VM)

    Download the file from Smart Software Manager > Smart Licensing Utility.

    Refer to the Cisco Smart License Utility Quick Start Setup Guide for help with installation and set-up.

  2. CSLU Preference Settings

    Where tasks is performed: CSLU

    1. In the CSLU Preferences tab, click the Cisco Connectivity toggle switch to off. The field switches to “Cisco Is Not Available”.

    2. Configuring a Smart Account and a Virtual Account (CSLU Interface)

    3. Adding a CSLU-Initiated Product Instance in CSLU (CSLU Interface)

    4. Collecting Usage Reports: CSLU Initiated (CSLU Interface)

  3. Product Instance Configuration

    Where task is performed: Product Instance

    Ensuring Network Reachability for CSLU-Initiated Communication

  4. Authorization Code Installation (Only if Applicable)

    Where tasks are performed: Product Instance

    An export-controlled license is supported only on certain models of the Cisco Catalyst Access, Core, and Aggregation Switches (See Returning an Authorization Code). If you want to use an export-controlled license, complete the following tasks on supported platforms:

    1. Manually Requesting and Auto-Installing a SLAC

    2. Requesting SLAC for One or More Product Instance (CSLU Interface)

    3. Generating and Downloading SLAC from Cisco SSM to a File

    4. Import from Cisco SSM (CSLU Interface)

  5. Usage Synchronization

    Where tasks are performed: CSLU and Cisco SSM

    Collect usage data from the product instance. Since CSLU is disconnected from Cisco SSM, you then save usage data which CSLU has collected from the product instance to a file. Then, from a workstation that is connected to Cisco, upload it to Cisco SSM. After this, download the ACK from Cisco SSM. In the workstation where CSLU is installed and connected to the product instance, upload the file to CSLU.

    1. Export to Cisco SSM (CSLU Interface)

    2. Uploading Data or Requests to Cisco SSM and Downloading a File

    3. Import from Cisco SSM (CSLU Interface)

Result:

The uploaded ACK is applied to the product instance the next time CSLU runs an update.

If you want to change the boot level license, see Configuring a Base or Add-On License.

If you want to return an authorization code, see Returning an Authorization Code.

Adding a Product-Initiated Product Instance in CSLU (CSLU Interface)

Complete these steps to add a device-created Product Instance using the Preferences tab.

Procedure

Step 1

Click the Preferences tab.

Step 2

In the Preferences screen, de-select the Validate Device check box.

Step 3

Set the Default Connect Method to Product Instance Initiated and then click Save.

Adding a CSLU-Initiated Product Instance in CSLU (CSLU Interface)

Using the CSLU interface, you can configure the connect method to be CSLU Initiated. This connect method (mode) enables CSLU to retrieve product instance information.


Note
The default Connect Method is set in the Preferences tab.

Complete these steps to add a Product Instance from the Inventory tab

Procedure

Step 1

Go to the Inventory tab and from the Product Instances table, select Add Single Product.

Step 2

Enter the Host (IP address of the host).

Step 3

Select the Connect Method and select an appropriate CSLU Initiated connect method.

Step 4

In the right panel, click Product Instance Login Credentials. The left panel of the screen changes to show the User Name and Password fields

Step 5

Enter the product instance User Name and Password.

Step 6

Click Save.

The information is saved to the system and the device is listed in the Product Instances table with the Last Contact listed as never.

Workflow for Topology: No Connectivity to Cisco SSM and No CSLU

Since you do not have to configure connectivity to any other component, the list of tasks required to set-up the topology is a small one. See, the Results section at the end of the workflow to know how you can complete requisite usage reporting after you have implemented this topology.

Product Instance Configuration → Authorization Code Installation (Only if Applicable)

  1. Product Instance Configuration

    Where task is performed: Product Instance

    Set transport type to off.

    Enter the license smart transport off command in global configuration mode. Save any changes to the configuration file.
    Device(config)# license smart transport off
Device(config)# exit
Device# copy running-config startup-config

  2. Authorization Code Installation (Only if Applicable)

    Where task is performed: Cisco SSM Web UI and Product Instance

    An export-controlled license is supported only on certain models of the Cisco Catalyst Access, Core, and Aggregation Switches (See Returning an Authorization Code). If you want to use an export-controlled license, choose one of the options to install SLAC:

Result:

All communication to and from the product instance is disabled. To report license usage you must save RUM reports to a file (on your product instance) and upload it to Cisco SSM (from a workstation that has connectivity to the internet, and Cisco):

  1. Generate and save RUM reports

    Enter the license smart save usage command in provileged EXEC mode. In the example below, all RUM reports are saved to the flash memory of the product instance, in file all_rum.txt.

    Starting with Cisco IOS XE Cupertino 17.7.1, configuring this command automatically includes a trust code request in the RUM report - if a trust code does not already exist on the product instance. 

    Device# license smart save usage all file bootflash:all_rum.txt 
Device# copy bootflash:all_rum.txt tftp://10.8.0.6/user01

  2. Upload usage data to Cisco SSM: Uploading Data or Requests to Cisco SSM and Downloading a File

  3. Install the ACK on the product instance: Installing a File on the Product Instance

If you want to change the boot level license, see Configuring a Base or Add-On License.

If you want to return an authorization code, see Returning an Authorization Code.

Workflow for Topology: SSM On-Prem Deployment

Depending on whether you want to implement a product instance-initiated method of communicatio (push) or SSM On-Prem-initiated method of communication (pull), complete the corresponding sequence of tasks:

Tasks for Product Instance-Initiated Communication

SSM On-Prem Installation → Addition and Validation of Product Instances (Only if Applicable) → Product Instance Configuration→ Initial Usage Synchronization

Procedure

Step 1

SSM On-Prem Installation

Where task is performed: A physical server such as a Cisco UCS C220 M3 Rack Server, or a hardware-based server that meets the necessary requirements.

Download the file from Smart Software Manager > Smart Software Manager On-Prem.

Refer to the Cisco Smart Software On‐Prem Installation Guide and the Cisco Smart Software On‐Prem User Guide for help with installation.

Installation is complete when you have deployed SSM On-Prem, configured a common name on SSM On-Prem (Security Widget > Certificates), synchronized the NTP server (Settings widget > Time Settings), and created, registered, and synchronized (Synchronization widget) the SSM On-Prem local account with your Smart Account and Virtual Account in Cisco SSM.

Note

 
Licensing functions in the On-Prem Licensing Workspace are greyed-out until you complete the creation, registration, and synchronization of the local account with your Smart Account in Cisco SSM. The local account synchronization with Cisco SSM is for the SSM On-Prem instance to be known to Cisco SSM, and is different from usage synchronization which is performed in 4. Initial Usage Synchronization below.

Step 2

Addition and Validation of Product Instances

Where tasks are performed: SSM On-Prem UI

This step ensures that the product instances are validated and mapped to the applicable Smart Account and Virtual account in Cisco SSM. This step is required only in the following cases:

  • If you want your product instances to be added and validated in SSM On-Prem before they are reported in Cisco SSM (for added security).

  • If you want to use a license that requires authorization before use (enforcement type: enforced or export-controlled). Such a product instance must be added to SSM On-Prem before you can request the necessary SLAC in Step 3 d below.

  • If you have created local virtual accounts (in addition to the default local virtual account) in SSM On-Prem. In this case you must provide SSM On-Prem with the Smart Account and Virtual Account information for the product instances in these local virtual accounts, so that SSM On-Prem can report usage to the correct license pool in Cisco SSM.

  1. Assigning a Smart Account and Virtual Account (SSM On-Prem UI)

  2. Validating Devices (SSM On-Prem UI)

    Note

     

    If your product instance is in a NAT set-up, also enable support for a NAT Setup when you enable device validation – both toggle switches are in the same window.

Step 3

Product Instance Configuration

Where tasks are performed: Product Instance and the SSM On-Prem UI

Remember to save any configuration changes on the product instance, by entering the copy running-config startup-config command in privileged EXEC mode.

  1. Ensuring Network Reachability for Product Instance-Initiated Communication

  2. Retrieving the Transport URL (SSM On-Prem UI)

  3. Setting the Transport Type, URL, and Reporting Interval

    The transport type configuration for CSLU and SSM On-Prem are the same (license smart transport cslu command in global configuration mode), but the URLs are different.

  4. An export-controlled license is supported only on certain models of the Cisco Catalyst Access, Core, and Aggregation Switches (See Returning an Authorization Code). Complete these sub-steps only if you want to use an export-controlled license on supported platforms: Submitting an Authorization Code Request (SSM On-Prem UI) and Manually Requesting and Auto-Installing a SLAC

Step 4

Initial Usage Synchronization

Where tasks are performed: Product instance, SSM On-Prem UI, Cisco SSM.

  1. Synchronize the product instance with SSM On-Prem.

    On the product instance, enter the license smart sync {all| local} command, in privileged EXEC mode. This synchronizes the product instance with SSM On-Prem, to send and receive any pending data.
    Device(config)# license smart sync local

    You can verify this in the SSM On-Prem UI. Log in and select the Smart Licensing workspace. Navigate to the Inventory > SL Using Policy tab. In the Alerts column of the corresponding product instance, the following message is displayed: Usage report from product instance.

    Note

     

    If you have not performed Step 2 above (Addition and Validation of Product Instances), completing this sub-step will add the product instance to the SSM On-Prem database.

  2. Synchronize usage information with Cisco SSM (choose one):

    • Option 1:

      SSM On-Prem is connected to Cisco SSM: In the SSM On-Prem UI, Smart Licensing workspace, nagivate to Reports > Usage Schedules > Synchronize now with Cisco.

    • Option 2:

      SSM On-Prem is not connected to Cisco SSM: See Exporting and Importing Usage Data (SSM On-Prem UI).

You have completed initial usage synchronization. Product instance and license usage information is now displayed in SSM On-Prem.

For subsequent reporting, you have the following options:

  • To synchronize data between the product instance and SSM On-Prem:

    Schedule periodic synchronization between the product instance and the SSM On-Prem, by configuring the reporting interval. Enter the license smart usage interval interval_in_days command in global configuration mode.

    The following applies only to Cisco IOS XE Amsterdam 17.3.6 and later releases of the 17.3.x train and Cisco IOS XE Bengaluru 17.6.4 and later releases of the 17.6.x train: in the product instance-initiated mode, the product instance does not send more than one RUM report a day. You can override this for an on-demand synchronization between the product instance and CSLU, by entering the license smart sync command in privileged EXEC mode.

    To know when the product instance will be sending the next RUM report, enter the show license all command in privileged EXEC mode and in the output, check the Next report push: field.

  • To synchronize usage information with Cisco SSM:

    • Schedule periodic synchronization with Cisco SSM. In the SSM On-Prem UI, navigate to Reports > Usage Schedules > Synchronization schedule with Cisco. Enter the following frequency information and save:

      • Days: Refers to how often synchronization occurs. For example, if you enter 2, synchronization occurs once every two days.

      • Time of Day:: Refers to the time at which synchronization occurs, in the 24-hour notation system. For example, if you enter 14 hours and 0 minutes, synchronization occurs at 2 p.m. (1400) in your local time zone.

    • Upload and download the required files for reporting: Exporting and Importing Usage Data (SSM On-Prem UI)).

If you want to change the boot level license, see Configuring a Base or Add-On License.

If you want to return an authorization code, see Returning an Authorization Code.

Tasks for SSM On-Prem Instance-Initiated Communication

SSM On-Prem Installation → Product Instance Addition → Product Instance Configuration→ Initial Usage Synchronization

Before you begin

Procedure

Step 1

SSM On-Prem Installation

Where task is performed: A physical server such as a Cisco UCS C220 M3 Rack Server, or a hardware-based server that meets the necessary requirements.

Download the file from Smart Software Manager > Smart Software Manager On-Prem.

Refer to the Cisco Smart Software On‐Prem Installation Guide and the Cisco Smart Software On‐Prem User Guide for help with installation.

Installation is complete when you have deployed SSM On-Prem, configured a common name on SSM On-Prem (Security Widget > Certificates), synchronized the NTP server (Settings widget > Time Settings), and created, registered, and synchronized (Synchronization widget) the SSM On-Prem local account with your Smart Account and Virtual Account in Cisco SSM.

Note

 

Licensing functions in the On-Prem Licensing Workspace are greyed-out until you complete the creation, registration, and synchronization of the local account with your Smart Account in Cisco SSM. The local account synchronization with Cisco SSM is for the SSM On-Prem instance to be known to Cisco SSM, and is different from usage synchronization which is performed in 4. Initial Usage Synchronization below.

Step 2

Product Instance Addition

Where task is performed: SSM On-Prem UI

Depending on whether you want to add a single product instance or multiple product instances, follow the corresponding sub-steps: Adding One or More Product Instances (SSM On-Prem UI).

Step 3

Product Instance Configuration

Where tasks are performed: Product Instance

Remember to save any configuration changes on the product instance, by entering the copy running-config startup-config command in privileged EXEC mode.

  1. Ensuring Network Reachability for SSM On-Prem-Initiated Communication

  2. An export-controlled license is supported only on certain models of the Cisco Catalyst Access, Core, and Aggregation Switches (See Returning an Authorization Code). Complete these sub-steps only if you want to use an export-controlled license on supported platforms: Submitting an Authorization Code Request (SSM On-Prem UI).

    The uploaded codes are applied to the product instances the next time SSM On-Prem runs an update. An initial usage synchronization with the product instance is being performed in Step 4 below so this will be completed then.

Step 4

Initial Usage Synchronization

Where tasks are performed: SSM On-Prem, and Cisco SSM.

  1. Retrieve usage information from the product instance.

    In the SSM On-Prem UI, navigate to Reports > Synchronisation pull schedule with the devices > Synchronise now with the device.

    In the Alerts column, the following message is displayed: Usage report from product instance.

    Tip

     
    It takes 60 seconds before synchronization is triggered. To view progress, navigate to the On-Prem Admin Workspace, and click the Support Centre widget. The system logs here display progress.

  2. Synchronize usage information with Cisco SSM (choose one)

    • Option 1:

      SSM On-Prem is connected to Cisco SSM: In the SSM On-Prem UI, Smart Licensing workspace, nagivate to Reports > Usage Schedules > Synchronize now with Cisco.

    • Option 2:

      SSM On-Prem is not connected to Cisco SSM. See: Exporting and Importing Usage Data (SSM On-Prem UI).

You have completed initial usage synchronization. Product instance and license usage information is now displayed in SSM On-Prem. SSM On-Prem automatically sends the ACK back to the product instance. To verify that the product instance has received the ACK, enter the show license status command in privileged EXEC mode, and in the output, check the date for the Last ACK received field.

For subsequent reporting, you have the following options:

  • To retrieve usage information from the product instance, you can:

    • In the SSM On-Prem UI, Smart Licensing workspace, nagivate to Reports > Usage Schedules > Synchronize now with Cisco.

    • Schedule periodic retrieval of information from the product instance by configuring a frequency. In the SSM On-Prem UI, Smart Licensing workspace, nagivate to Reports > Usage Schedules > Synchronisation pull schedule with the devices. Enter values in the following fields:

      • Days: Refers to how often synchronization occurs. For example, if you enter 2, synchronization occurs once every two days.

      • Time of Day:: Refers to the time at which synchronization occurs, in the 24-hour notation system. For example, if you enter 14 hours and 0 minutes, synchronization occurs at 2 p.m. (1400).

    • Collect usage data from the product instance without being connected to Cisco SSM. In the SSM On-Prem UI, Smart Licensing workspace, nagivate to Inventory > SL Using Policy tab. Select one or more product instances by enabling the coresponding check box. Click Actions for Selected... > Collect Usage. On-Prem connects to the selected Product Instance(s) and collects the usage reports. These usage reports are then stored in On-Prem’s local library. These reports can then be transferred to Cisco if On-Prem is connected to Cisco, or (if you are not connected to Cisco) you can manually trigger usage collection by selecting Export/Import All.. > Export Usage to Cisco.

  • To synchronize usage information with Cisco SSM, you can:

    • Schedule periodic synchronization with Cisco SSM. In the SSM On-Prem UI, navigate to Reports > Usage Schedules > Synchronization schedule with Cisco. Enter the following frequency information and save:

      • Days: Refers to how often synchronization occurs. For example, if you enter 2, synchronization occurs once every two days.

      • Time of Day:: Refers to the time at which synchronization occurs, in the 24-hour notation system. For example, if you enter 14 hours and 0 minutes, synchronization occurs at 2 p.m. (1400).

    • Upload and download the required files for reporting: Exporting and Importing Usage Data (SSM On-Prem UI)).

If you want to change the boot level license, see Configuring a Base or Add-On License.

If you want to return an authorization code, see Returning an Authorization Code.