Smart Licensing

Feature Summary and Revision History

Summary Data

Table 1. Summary Data

Applicable Products or Functional Area

SMF

Applicable Platform(s)

SMI

Feature Default Setting

Disabled - Configuration Required

Related Changes in this Release

Not Applicable

Related Documentation

Not Applicable

Revision History

Table 2. Revision History
Revision Details Release
First introduced. Pre-2020.02.0

Smart Software Licensing

Smart Licensing is a cloud-based approach to licensing that simplifies the purchase, deployment, and management of Cisco software assets. Entitlements are purchased through your Cisco account via Cisco Commerce Workspace (CCW) and immediately deposited into your Virtual Account for usage. This eliminates the need to install license files on every device. Products that are smart enabled communicate directly to Cisco to report consumption. A single location is available to customers to manage Cisco software licenses — the Cisco Software Central (CSC). License ownership and consumption are readily available to help make better purchase decision based on consumption or business need. See https://www.cisco.com/c/en/us/buy/smart-accounts/software-licensing.html for more information about Cisco Smart Licensing.

Comparison Between Legacy Licensing and Smart Licensing

Cisco employs two types of license models - Legacy Licensing and Smart Software Licensing. Legacy Licensing consists of software activation by installing Product Activation Keys (PAK) on to the Cisco product. A Product Activation Key is a purchasable item, ordered in the same manner as other Cisco equipment and used to obtain license files for feature set on Cisco Products. Smart Software Licensing is a cloud-based licensing of the end-to-end platform through the use of a few tools that authorize and deliver license reporting. Smart Software Licensing functionality incorporated into the NFs complete the product registration and authorization.

Cisco Software Central

Cisco Software Central (CSC) enables the management of software licenses and Smart Account from a single portal. The interface allows you to activate your product, manage entitlements, and renew and upgrade software. A functioning Smart Account is required to complete the registration process. To access the Cisco Software Central, see https://software.cisco.com.

Smart Accounts/Virtual Accounts

A Smart Account provides a single location for all Smart-enabled products and entitlements. It helps speed procurement, deployment, and maintenance of Cisco Software. When creating a Smart Account, you must have the authority to represent the requesting organization. After submitting, the request goes through a brief approval process.

A Virtual Account exists as a sub-account within the Smart Account. Virtual Accounts are a customer-defined structure based on organizational layout, business function, geography or any defined hierarchy. They are created and maintained by the Smart Account administrator.

See https://software.cisco.com to learn about the set up or manage the Smart Accounts.

Request a Cisco Smart Account

A Cisco Smart Account is an account where all products enabled for Smart Licensing are deposited. A Cisco Smart Account allows you to manage and activate your licenses to devices, monitor license use, and track Cisco license purchases. Through transparent access, you have a real-time view into your Smart Licensing products. IT administrators can manage licenses and account users within your organization's Smart Account through the Software Central.

Procedure


Step 1

In a browser window, enter the following URL:

https://software.cisco.com

Step 2

Log in using your credentials, and then click Request a Smart Account in the Administration area.

The Smart Account Request window is displayed.

Step 3

Under Create Account, select one of the following options:

  • Yes, I have authority to represent my company and want to create the Smart Account – If you select this option, you agree to authorization to create and manage product and service entitlements, users, and roles on behalf of your organization.

  • No, the person specified below will create the account – If you select this option, you must enter the email address of the person who will create the Smart Account.

Step 4

Under Account Information:

  1. Click Edit beside Account Domain Identifier.

  2. In the Edit Account Identifier dialog box, enter the domain, and click OK. By default, the domain is based on the email address of the person creating the account and must belong to the company that will own this account.

  3. Enter the Account Name (typically, the company name).

Step 5

Click Continue.

The Smart Account request will be in pending status until it has been approved by the Account Domain Identifier. After approval, you will receive an email confirmation with instructions for completing the setup process.

SMF Smart Licensing

At present, the Smart Licensing feature supports application entitlement for online and offline licensing for all 5G applications (PCF, SMF and NRF). The application usage is unrestricted during all stages of licensing including Out of Compliance (OOC) and expired stages.


Note

A 90 day evaluation period is granted for all licenses in use. Currently, the functionality and operation of the 5G applications is unrestricted even after the end of the evaluation period.


Software Tags and Entitlement Tags

Tags for the following software and entitlements have been created to identify, report, and enforce licenses.

Software Tags

Software tags uniquely identify each licenseable software product or product suite on a device. The following software tags exist for the SMF.

Product Type / Description Software Tag

Ultra Cloud Core - Session Management Function (SMF), Base Minimum

regid.2020-04.com.cisco.SMF,1.0_37ffdc21-3e95-4192-bcda-d3225b6590ce

Entitlement Tags

The following entitlement tags identify licenses in use:

Product Type / Description Entitlement Tag

Ultra Cloud Core - Session Management Function (SMF), Base Minimum

regid.2020-04.com.cisco.SMF_BASE,1.0_b49f5997-21aa-4d15-9606-0cff88729f69


Note

The license information is retained during software upgrades and rollback.


Configuring Smart Licensing

You can configure Smart Licensing after a new SMF deployment.

Users with Access to CSC

This section describes how to configure Smart Licensing if you have access to CSC portal from your environment.

Setting Up the Product and Entitlement in CSC

Before you begin, you need to setup your product and entitlement in the CSC. To setup your product and entitlement:

  1. Log in to your CSC account.

  2. Click Add Product and enter the following details.

    • Product name – Specify the name of the deployed product. For example, SMF.

    • Primary PM CEC ID – Specify the primary Project Manager's CEC ID for the deployed product.

    • Dev Manager CEC ID – Specify the Development Manager's CEC ID for the deployed product.

    • Description (Optional) – Specify a brief description of the deployed product.

    • Product Type – Specify the product type.

    • Software ID Tag – Specify the software ID Tag provided by the Cisco Accounts team.

  3. Click Create.

  4. Select your product from the Product/Entitlement Setup grid.

  5. Click Entitlement drop-down and select Create New Entitlement.

  6. Select New Entitlement in Add Entitlement and enter the following details.

    • Entitlement Name – Specify the license entitlement name. For example, SMF_BASE.

    • Description (Optional) – Specify a breif description about the license entitlement.

    • Entitlement Tag – Specify the entitlement tag provided by the Cisco Accounts team.

    • Entitlement Type – Specify the type of license entitlement.

    • Vendor String – Specify the vendor name.

  7. Click Entitlement Allocation.

  8. Click Add Entitlement Allocation.

  9. In New License Allocation, provide the following details:

    • Product – Select your product from the drop-down list.

    • Entitlement – Select your entitlement from the drop-down list.

  10. Click Continue.

  11. In New License Allocation window, provide the following details:

    • Quantity – Specify the number of licenses.

    • License Type – Specify the type of license.

    • Expiring Date – Specify the date of expiry for the license purchased.

  12. Click Create.

  13. Verify the status of Smart Licensing using the following command.

    show license all 

    Example:

    SMF# 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: 83 days, 0 hr, 15 min, 8 sec
      Last Communication Attempt: NONE
    
    License Conversion: 
     Automatic Conversion Enabled: true
     Status: NOT STARTED
    
    Utility:
      Status: DISABLED
    
    Transport:
      Type: CALLHOME
    
    Evaluation Period:
      Evaluation Mode: In Use
      Evaluation Period Remaining: 83 days, 0 hr, 15 min, 8 sec
    
    License Usage
    =============
    License Authorization Status: EVALUATION MODE
      Evaluation Period Remaining: 83 days, 0 hr, 15 min, 8 sec
    
    UCC 5G SMF BASE (SMF_BASE)
      Description: Ultra Cloud Core - Session Management Function (SMF), Base Minimum
      Count: 1
      Version: 1.0
      Status: EVAL MODE
      Export status: RESTRICTED_NOTALLOWED
      Feature Name: <empty>
      Feature Description: <empty>
    
    Product Information
    ===================
    UDI: PID:SMF,SN:6GKJ2OA-NMUWA7Y
    
    Agent Version
    =============
    Smart Agent for Licensing: 3.0.13
    

Registering Smart Licensing

You must register the product entitled to the license with CSC. In order to register, you must generate an ID token from CSC.

  1. Log in to your CSC account.

  2. Click General > New Token and enter the following details:

    • Description – Specify a brief description about the ID token.

    • Expires After – Specify the number of days for the token to expire.

    • Max. Number Users – Specify the maximum number of users.

  3. Click Create Token.

  4. Select new ID token in Product Instance Registration Token.

  5. Click Actions > Copy.

  6. Log in to SMF Ops Center CLI and paste the ID token using the following command.

    license smart register idtoken 

    Example:

    SMF# license smart register
    Value for 'idtoken' (<string>): MTI2Y2FlNTAtOThkMi00YTAxLWE4M2QtOTNhNzNjNjY4ZmFiLTE2MTc4N
    Tky%0AMTA5MDh8ck1jUHNwc3k1ZC9nWFFCSnVEcUp4QU1jTFoxOGxDTU5kQ3lpa25E%0Ab04wST0%3D%0A
    SMF# 
    
  7. Verify the Smart Licensing status using the following command.

    show license all 

    Example:

    SMF# show license all 
    
    Smart Licensing Status
    =======================
    Smart Licensing is ENABLED
    
    Registration:
      Status: REGISTERED
      Smart Account: Cisco Systems, Inc.
      Virtual Account: SMF-SMF
      Export-Controlled Functionality: Allowed
      Initial Registration: SUCCEEDED on Apr 15 05:45:07 2020 GMT
      Last Renewal Attempt: SUCCEEDED on Apr 15 05:45:07 2020 GMT
      Next Renewal Attempt: Oct 12 05:45:07 2020 GMT
      Registration Expires: Apr 15 05:40:31 2021 GMT
    
    License Authorization:
      Status: AUTHORIZED on Apr 15 05:45:12 2020 GMT
      Last Communication Attempt: SUCCEEDED on Apr 15 05:45:12 2020 GMT
      Next Communication Attempt: May 15 05:45:12 2020 GMT
      Communication Deadline: Jul 14 05:40:40 2020 GMT
    
    License Conversion: 
     Automatic Conversion Enabled: true
     Status: NOT STARTED
    
    Utility:
      Status: DISABLED
    
    Transport:
      Type: CALLHOME
    
    Evaluation Period:
      Evaluation Mode: Not In Use
      Evaluation Period Remaining: 83 days, 0 hr, 10 min, 43 sec
    
    License Usage
    =============
    License Authorization Status: AUTHORIZED as of Apr 15 05:45:12 2020 GMT
    
    UCC 5G SMF BASE (SMF_BASE)
      Description: Ultra Cloud Core - Session Management Function (SMF), Base Minimum
      Count: 1
      Version: 1.0
      Status: AUTHORIZED
      Export status: RESTRICTED_ALLOWED
      Feature Name: <empty>
      Feature Description: <empty>
    
    Product Information
    ===================
    UDI: PID:SMF,SN:6GKJ2OA-NMUWA7Y
    
    Agent Version
    =============
    Smart Agent for Licensing: 3.0.13
    

    NOTES:

    • license smart register – Registers Smart Licensing with CSC.

    • idtoken – Specifies the ID token generated from CSC.

Deregistring Smart Licensing

To deregister Smart Licensing:

  1. Log in to SMF Ops Center CLI and use the following command.

    license smart deregister 
  2. Verify the Smart Licensing status using the following command.

    show license all 

    Example:

    SMF# 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: 83 days, 0 hr, 10 min, 43 sec
      Last Communication Attempt: NONE
    
    License Conversion: 
     Automatic Conversion Enabled: true
     Status: NOT STARTED
    
    Utility:
      Status: DISABLED
    
    Transport:
      Type: CALLHOME
    
    Evaluation Period:
      Evaluation Mode: In Use
      Evaluation Period Remaining: 83 days, 0 hr, 10 min, 43 sec
    
    License Usage
    =============
    License Authorization Status: EVALUATION MODE
      Evaluation Period Remaining: 83 days, 0 hr, 10 min, 43 sec
    
    UCC 5G SMF BASE (SMF_BASE)
      Description: Ultra Cloud Core - Session Management Function (SMF), Base Minimum
      Count: 1
      Version: 1.0
      Status: EVAL MODE
      Export status: RESTRICTED_NOTALLOWED
      Feature Name: <empty>
      Feature Description: <empty>
    
    Product Information
    ===================
    UDI: PID:SMF,SN:6GKJ2OA-NMUWA7Y
    
    Agent Version
    =============
    Smart Agent for Licensing: 3.0.13
    
    SMF#
    

    NOTES:

    • license smart deregister – Deregisters Smart Licensing from CSC.

Users without Access to CSC

The Smart License Reservation feature – Perpetual Reservation – is reserved for customers without access to CSC from their internal environments. With this feature, Cisco allows customers to reserve licenses from their virtual account and tie them to their devices Unique Device Identifier (UDI). This enables customers to use their devices with reserved licenses in a disconnected mode.

The subsequent sections describe the procedure involved in reserving Smart License for users without access to CSC from their internal environment.

Enabling Smart License Reservation

To enable Smart License reservation through SMF Ops Center CLI:

  1. Log in to SMF Ops Center CLI and use the following configuration.

    configure terminal 
      license smart reservation 
      commit 
      exit 

    NOTES:

    • license smart reservation – Enables license reservation.

Generating Smart License Reservation Request Code

To generate the Smart License reservation request code:

  1. Log in to SMF Ops Center CLI.

  2. To enable reservation, use the following configuration.

    configure terminal 
      license smart reservation  
      commit 
      exit 
  3. To request for a reservation code, use the following command.

    license smart reservation request 

    Example:

    SMF# license smart reservation request
    reservation-request-code CJ-ZSMF:6GKJ2OA-NMUWA7Y-Ai75GxtBs-3B
    SMF# 
    Message from confd-api-manager at 2020-04-15 05:51:37...
    Global license change NotifyReservationInProgress reason code Success - Successful.
    SMF# 
    

    NOTES:

    • license smart reservation – Enables license reservation request code.

    • license smart reservation request – Generates the license reservation request code.


      Important

      You must copy the generated license request code from the SMF Ops Center CLI.


Generating an Authorization Code from CSC

To generate an authorization code from CSC using the license reservation request code:

  1. Log in to your CSC account.

  2. Click License Reservation.

  3. Enter the Request Code: Paste the license reservation request code copied from the SMF Ops Center CLI in the Reservation Request Code text-box.

  4. Select the Licenses: Click Reserve a Specific License radio-button and select UCC 5G SMF BASE.


    Note

    In the Reserve text-box enter the value 1.


  5. Review your selection.

  6. Click Generate Authorization Code.

  7. Download the response file: The authorization code is generated and displayed on-screen. Click Download as File to download the authorization code.

  8. Click Close.

Reserving Smart Licensing

To reserve Smart License for the deployed product using the authorization code generated in CSC:

  1. Log in to SMF Ops Center CLI and use the following command.

    license smart reservation install authorization_code 

    Example:

    SMF# license smart reservation install
    Value for 'key' (<string>): <specificPLR><authorizationCode><flag>A</flag><version>C</version>
    <piid>35757dc6-2bdf-4fa1-ba7e-4190f5b6ea22</piid><timestamp>1586929992297</timestamp>
    <entitlements><entitlement><tag>regid.2020-04.com.cisco.SMF_BASE,1.0_60b1da6f-3832-4687-90c9-8879dc815a27</tag>
    <count>1</count><startDate>2020-Apr-08 UTC</startDate><endDate>2020-Oct-05 UTC</endDate>
    <licenseType>TERM</licenseType><displayName>UCC 5G SMF BASE</displayName>
    <tagDescription>Ultra Cloud Core - Session Management Function (SMF), Base Minimum</tagDescription>
    <subscriptionID></subscriptionID></entitlement></entitlements></authorizationCode>
    <signature>MEYCIQC/9v5LpgFoEk2l4omIgjjk83g5WXjzs09kQnsO8D0jRgIhAMh+
    D6DRuYmqh1TlfJoZxNte0fPKw6fHEY5CEF3+kPQj</signature>
    <udi>P:SMF,S:6GKJ2OA-NMUWA7Y</udi></specificPLR>
    SMF# 
    
  2. Verify the smart licensing status using the following command.

    show license all 

    Example:

    SMF# show license all
    
    Smart Licensing Status
    =======================
    Smart Licensing is ENABLED
    License Reservation is ENABLED
    
    Registration:
      Status: REGISTERED - SPECIFIC LICENSE RESERVATION 
      Export-Controlled Functionality: Allowed
      Initial Registration: SUCCEEDED on Wed Apr 15 05:53:31 GMT 2020
      Last Renewal Attempt: None
    
    License Authorization:
      Status: AUTHORIZED - RESERVED on Wed Apr 15 05:53:31 GMT 2020 
    
    Utility:
      Status: DISABLED
    
    Transport:
      Type: CALLHOME
    
    Evaluation Period:
      Evaluation Mode: Not In Use
      Evaluation Period Remaining: 83 days, 0 hr, 5 min, 15 sec
    
    License Usage
    =============
    License Authorization Status: 
      Status: AUTHORIZED - RESERVED  on Wed Apr 15 05:53:31 GMT 2020
      Last Communication Attempt: SUCCEEDED on Apr 15 05:53:31 2020 GMT
      Next Communication Attempt: NONE
      Communication Deadline: NONE
    
    UCC 5G SMF BASE (SMF_BASE)
      Description: Ultra Cloud Core - Session Management Function (SMF), Base Minimum
      Count: 1
      Version: 1.0
      Status: AUTHORIZED 
      Export status: NOT RESTRICTED
      Feature Name: <empty>
      Feature Description: <empty>
      Reservation:
        Reservation Status: SPECIFIC INSTALLED
        Total Reserved Count: 1
        Term expiration: 2020-Oct-05 GMT
    
    Product Information
    ===================
    UDI: PID:SMF,SN:6GKJ2OA-NMUWA7Y
    
    Agent Version
    =============
    Smart Agent for Licensing: 3.0.13
    

    NOTES:

    • license smart reservation install authorization_code – Installs a Smart License Authorization code.

Returning the Reserved License

You can return the reserved license to CSC if required. Use the following procedure to return the reserved license:

  1. When the license reservation authorization code is installed in the SMF Ops Center.

    1. Log in to the SMF Ops Center CLI and use the following command.

      license smart reservation return 

      Example:

      SMF# license smart reservation return 
      reservation-return-code CJ6m3k-RAvu6b-hMNmwf-mrdcko-NoSwKL-tF7orz-9aNtEu-yVjGAm-D6j
      SMF# 
      
    2. Copy the license reservation return code generated in SMF Ops Center CLI.

    3. Log in to your CSC account.

    4. Select your product instance from the list.

    5. Click Actions > Remove.

    6. Paste the license reservation return code in Return Code text-box.

    NOTES:

    • license smart reservation return – Returns a reserved Smart License.

  2. When the license reservation authorization code is not installed in the SMF Ops Center.

    1. Log in to the SMF Ops Center CLI and use the following command to generate the return code.

      license smart reservation return 
      authorization_code 

      Important

      Paste the license reservation authorization code generated in CSC to generate the return code.


    2. Log in to your CSC account.

    3. Select your product instance from the list.

    4. Click Actions > Remove.

    5. Paste the license reservation return code in Return Code text-box.

  3. Verify the smart licensing status using the following command.

    show license all 
    Example:
    SMF# show license all
    
    Smart Licensing Status
    =======================
    Smart Licensing is ENABLED
    License Reservation is ENABLED
    
    Registration:
      Status: UNREGISTERED
      Export-Controlled Functionality: Not Allowed
    
    License Authorization:
      Status: EVAL MODE
      Evaluation Period Remaining: 83 days, 0 hr, 5 min, 15 sec
      Last Communication Attempt: SUCCEEDED on Apr 15 05:53:31 2020 GMT
      Next Communication Attempt: NONE
      Communication Deadline: NONE
    
    License Conversion: 
     Automatic Conversion Enabled: true
     Status: NOT STARTED
    
    Utility:
      Status: DISABLED
    
    Transport:
      Type: CALLHOME
    
    Evaluation Period:
      Evaluation Mode: In Use
      Evaluation Period Remaining: 83 days, 0 hr, 5 min, 15 sec
    
    License Usage
    =============
    License Authorization Status: EVALUATION MODE
      Evaluation Period Remaining: 83 days, 0 hr, 5 min, 15 sec
    
    UCC 5G SMF BASE (SMF_BASE)
      Description: Ultra Cloud Core - Session Management Function (SMF), Base Minimum
      Count: 1
      Version: 1.0
      Status: EVAL MODE
      Export status: RESTRICTED_NOTALLOWED
      Feature Name: <empty>
      Feature Description: <empty>
    
    Product Information
    ===================
    UDI: PID:SMF,SN:6GKJ2OA-NMUWA7Y
    
    Agent Version
    =============
    Smart Agent for Licensing: 3.0.13
    
    SMF#
    

Monitoring and Troubleshooting Smart Licensing

You can use the following show commands to view Smart Licensing related information in the SMF Ops Center.

show license [ all | UDI | displaylevel | reservation | smart | status | summary | tech-support | usage ] 

NOTES:

  • all – Displays an overview of Smart Licensing information that includes license status, usage, product information and Smart Agent version.

  • UDI – Displays Unique Device Identifiers (UDI) details.

  • displaylevel – Depth to display information.

  • reservation – Displays Smart Licensing reservation information.

  • smart – Displays Smart Licensing information.

  • status – Displays the overall status of Smart Licensing.

  • summary – Displays a summary of Smart Licensing.

  • tech-support – Displays Smart Licensing debugging information.

  • usage – Displays the license usage information for all the entitlements that are currently in use.