Cisco ASR 9000 Series Aggregation Services Router System Management Configuration Guide, Release 4.2.x
Software Entitlement on the Cisco ASR 9000 Series Router
Download this chapter
Software Entitlement on the Cisco ASR 9000 Series RouterSoftware Entitlement on the Cisco ASR 9000 Series Router
Download the complete book
Cisco ASR 9000 Series Aggregation Services Router System Management Configuration Guide, Release 4.2.xCisco ASR 9000 Series Aggregation Services Router System Management Configuration Guide, Release 4.2.x (PDF - 4 MB)
 Feedback

Software Entitlement on the Cisco ASR 9000 Series Router

Cisco IOS XR software contains all the supported features for a given release. Before the introduction of software entitlement on Cisco IOS XR software, you could freely activate all available software packages on your network devices and could enable all the bundled features. To enable the pay-as-you-grow model—where you pay only for the features that you need today—but can upgrade when necessary while keeping your investment safe, software entitlement has been introduced. Licensing enables you to purchase individual software features and upgrade hardware capacity in a safe and reliable way.

For complete descriptions of the commands listed in this module, see Related Documents. To locate documentation for other commands that might appear in the course of performing a configuration task, search online in Cisco ASR 9000 Series Aggregation Services Router Commands Master List.

Table 1 Feature History for Software Entitlement

Release

Modification

Release 3.9.0

The software entitlement feature was introduced.

This model contains the following topics:

Related References

Prerequisites for Configuring Software Entitlement

You must be in a user group associated with a task group that includes the proper task IDs. The command reference guides include the task IDs required for each command. If you suspect user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Information About Cisco IOS XR Software Entitlement

To configure process placement policies, you need to understand the concepts described in this module.

What Is Software Entitlement?

Software entitlement is a system that consists of a license manager on a Cisco IOS XR device that manages licenses for various software and hardware features. The license manager parses and authenticates a license before accepting it. The software features on the router use the license manager APIs to check out and release licenses. Licenses are stored in persistent storage on the router.

Core routing features are available for use without any license. The following features can be enabled on your router using licenses:

Layer 3 VPN

Layer 3 (virtual private network) VPN can be configured only if there is an available Layer 3 VPN license for the line card slot on which the feature is being configured. If the advanced IP license is enabled, 4096 Layer 3 VPN routing and forwarding instances (VRFs) can be configured on a line card. If the infrastructure VRF license is enabled, eight Layer 3 VRFs can be configured on the line card.

See the following modules in Cisco ASR 9000 Series Aggregation Services Router MPLS Configuration Guide for information about Layer 3 VPN configurations:

  • Implementing MPLS Layer 3 VPNs on the Cisco ASR 9000 Series Router
  • Implementing Virtual Private LAN Services on the Cisco ASR 9000 Series Router
G.709
If a G.709 license is available, G.709 can be enabled on 10-Gigabit Ethernet interfaces on the following line cards:
  • 2-port 10 Gigabit Ethernet / 20-port Gigabit Ethernet line card
  • 8-port 10 Gigabit Ethernet line card
  • 24-port 10 Gigabit Ethernet line card
  • 36-port 10 Gigabit Ethernet line card
  • 4-port 10 Gigabit Ethernet modular port adapter
  • 2-port 10 Gigabit Ethernet modular port adapter

Refer to the Configuring Dense Wavelength Division Multiplexing Controllers on the Cisco ASR 9000 Series Router module in Cisco ASR 9000 Series Aggregation Services Router Interface and Hardware Component Configuration Guide.

Video Monitoring

Video monitoring can be enabled for the Cisco ASR 9000 chassis by using a video monitoring license.

Satellite Network Virtualization (nV)

The Satellite nV license entitles satellite devices to connect to the Cisco ASR 9000 chassis. Satellite licenses are chassis licenses, and can provide the ability for one, five or 20 satellites to connect to a Cisco ASR 9000 host remotely.

Types of Licenses

The following types of licenses are currently defined:

  • Permanent licenses—Licenses that enable a designated feature permanently, as long as the license resides on the router.
  • Evaluation or metered licenses—Licenses that enable a feature for a limited period of time. The feature stops working immediately on license expiry. If multiple evaluation licenses are added for the same feature, the expiry period is counted from when the first evaluation license is added to the router.

Router License Pools

License pools are maintained by the router. By default, all added licenses are allocated to the owner SDR license pool, and they can be freely allocated to any slot in the router. Features on cards belonging to the owner SDR are granted licenses based on availability in the owner SDR license pool.

Chassis-Locked Licenses

Licenses are locked to a unique device identifier (UDI). The UDI is comprised of the chassis serial number, along with an additional identifier. The complete set of UDI information can be displayed using the show license udi command. The license manager parses the user-provided license and verifies that it is valid for the chassis it is running on and determines if the license is being readded.

Slot-Based Licenses

Feature licenses are allocated to router slots and not cards. Therefore, if a card is replaced, the existing license is applied to the newly inserted card. For example, if you have eight licenses for Layer 3 VPN in the system, you can configure Layer 3 VPN features on any eight cards in the router, and the licenses are allocated to the slots within which the cards are installed. If a card is removed from one of these licensed slots, say slot 3, and entered into an empty slot with no license, say slot 5, the license remains with slot 3 and the feature cannot be activated on slot 5 with the permanent license entered earlier by the user. In this case, you can release the license to the appropriate license pool by removing the configuration of the card (while it is inserted), or by using the license move slot command. When you configure the feature on slot 5, the license is checked out.

Features that Require Licenses After a Software Image Upgrade

When you upgrade your Cisco IOS XR software image from a release that does not support software entitlement to one that does, a warning message is displayed to the console port for each feature that requires a license. You must acquire either an evaluation license or a permanent license in order to continue using any features that require a license.

During an install activate operation, if the installation fails to acquire a license (through the license manager) for a package that requires licensing then the install operation is allowed but a warning message similar to the following is displayed:

Install operation 10 '(admin) install activate disk0:asr9k-optic-4.0.1.06I'
started by user 'root' via CLI at 09:57:15 pst Tue Aug 10 2010.
RP/0/RSP0/CPU0:Aug 10 09:57:15.058 : instdir[206]: 
%INSTALL-INSTMGR-6-INSTALL_OPERATION_STARTED : 
Install operation 10 '(admin) install activate disk0:asr9k-optic-4.0.1.06I' started by 
user 'root' 
/ 1% complete: The operation can still be aborted (ctrl-c for options)RP/0/RSP0/CPU0:
Aug 10 09:57:18.691 : licmgr[237]: %LICENSE-LICMGR-4-PACKAGE_LICENSE_INVALID : 
Package A9K-ADV-OPTIC-LIC activated without a valid license/ valid configuration
Warning:  There is no valid license for the following package:
Warning:   
Warning:      disk0:asr9k-optics-supp-4.0.1.06I
Warning:   
Info:     Install Method: Parallel Process Restart
\ 1% complete: The operation can still be aborted (ctrl-c for options)RP/0/RSP0/CPU0:
Aug 10 09:57:18.692 : instdir[206]: %INSTALL-INSTMGR-4-INSTALL_OPERATION_WARNING : 
A warning occurred during install operation 10. See 'show install log 10 detail' 
for more information. 
The install operation will continue asynchronously.
LC/0/0/CPU0:Aug 10 09:57:46.358 : sysmgr[87]: %OS-SYSMGR-7-INSTALL_NOTIFICATION : 
notification of software installation received LC/0/0/CPU0:Aug 10 09:57:46.389 : 
sysmgr[87]: 
%OS-SYSMGR-7-INSTALL_FINISHED : software installation is finished LC/0/1/CPU0:
Aug 10 09:57:46.477 : 
sysmgr[90]: %OS-SYSMGR-7-INSTALL_NOTIFICATION : notification of software installation received 
LC/0/1/CPU0:Aug 10 09:57:46.482 : sysmgr[90]: %OS-SYSMGR-7-INSTALL_FINISHED : 
software installation is finished RP/0/RSP0/CPU0:Aug 10 09:58:01.402 : sysmgr[95]: 
%OS-SYSMGR-7-INSTALL_NOTIFICATION : notification of software installation 
received RP/0/RSP0/CPU0:
Aug 10 09:58:01.417 : sysmgr[95]: %OS-SYSMGR-7-INSTALL_FINISHED : software installation 
is finished 
Info:     The changes made to software configurations will not be persistent
Info:     across system reloads. Use the command '(admin) install commit' to
Info:     make changes persistent.
Info:     Please verify that the system is consistent following the software
Info:     change using the following commands:
Info:         show system verify
Info:         install verify packages
RP/0/RSP0/CPU0:Aug 10 09:58:11.154 : instdir[206]: 
%INSTALL-INSTMGR-4-ACTIVE_SOFTWARE_COMMITTED_INFO : 
The currently active software is not committed. If the system reboots 
then the committed software will be used. Use 'install commit' to commit 
the active software. 
RP/0/RSP0/CPU0:Aug 10 09:58:11.155 : instdir[206]: 
%INSTALL-INSTMGR-6-INSTALL_OPERATION_COMPLETED_SUCCESSFULLY : 
Install operation 10 completed successfully Install operation 10 completed 
successfully at 09:58:11 pst Tue Aug 10 2010.

If you activate an SMU whose corresponding package requires a license but a license was not acquired successfully, then the install operation is allowed but a warning message similar to the following is displayed:

Wed Nov 25 15:02:23.418 PST
 
Install operation 8 started by user 'lab' via CLI at 14:59:46 PST Wed Nov 25 2009.
(admin) install activate id 7
Install operation 8 completed successfully at 15:02:13 PST Wed Nov 25 2009.
 
Install logs:
    Install operation 8 '(admin) install activate id 7' started by user 'lab' 
      via CLI at 14:59:46 PST Wed Nov 25 2009.
    Info:     This operation will activate the following packages:
    Info:         disk0:comp-asr9k-4.0.0.3P.CSCee40001-1.0.0
    Info:         disk0:comp-asr9k-4.0.0.3P.CSCee30001-1.0.0
    Info:         disk0:comp-asr9k-4.0.0.3P.CSCee20001-1.0.0
    Info:         disk0:comp-asr9k-4.0.0.3P.CSCee10001-1.0.0
    Info:     The following SMUs are not being activated as they do not apply to 
    Info:     any packages on the router:
    Info:      
    Info:         disk0:asr9k-diags-supp-4.0.0.3P.CSCee30001-1.0.0
    Info:         disk0:asr9k-fpd-4.0.0.3P.CSCee40001-1.0.0
    Info:      
    Warning:  There is no valid license found for package 'disk0:asr9k-mcast-supp-4.0.0.3P' 
    Warning:  when activating SMU 'disk0:asr9k-mcast-supp-4.0.0.3P.CSCee10001-1.0.0'.
    Warning:  There is no valid license found for package 'disk0:asr9k-mgbl-supp-4.0.0.3P' 
    Warning:  when activating SMU 'disk0:asr9k-mgbl-supp-4.0.0.3P.CSCee20001-1.0.0'.
    Warning:   
    Info:     The following sequence of sub-operations has been determined to minimize any
    Info:     impact:    
    Info:     Sub-operation 1:
    Info:         Install Method: Parallel Process Restart
    Info:         asr9k-mcast-supp-4.0.0.3P.CSCee10001-1.0.0
    Info:         
    Info:     Sub-operation 2:
    Info:         Install Method: Parallel Process Restart
    Info:         asr9k-mgbl-supp-4.0.0.3P.CSCee20001-1.0.0
    Info:      
    Info:     The changes made to software configurations will not be persistent 
    Info:     across system reloads. Use the command '(admin) install commit' to 
    Info:     make changes persistent.
    Info:     Please verify that the system is consistent following the software 
    Info:     change using the following commands:
    Info:         show system verify
    Info:         install verify packages
    Install operation 8 completed successfully at 15:02:13 PST Wed Nov 25 2009.
Related Tasks

How to Configure Cisco IOS XR Software Entitlement

Adding a License for a New Feature

This task describes how to acquire a permanent license for a feature that you have purchased or an evaluation license for a feature that you have arranged with your sales representative to try. Use this procedure to replace evaluation licenses with permanent licenses.

Before You Begin

You must have purchased the feature for which you are adding the license. When you purchase the feature, you are provided with a product authorization key (PAK) that you use to download the license.

SUMMARY STEPS

    1.    admin

    2.    show license udi

    3.    http:/​/​www.cisco.com/​go/​license

    4.    Copy the license to your TFTP server.

    5.    admin

    6.    license add license-name [ sdr sdr-name ]

    7.    configure

    8.    license license-name location {all | node-id}

    9.    exit


DETAILED STEPS
     Command or ActionPurpose
    Step 1 admin


    Example: 
    RP/0/RSP0/CPU0:router# admin
     

    Enters administration EXEC mode.

     
    Step 2 show license udi


    Example: 
    
RP/0/RSP0/CPU0:router(admin)# show license udi

Mon Jul 13 04:36:32.715 PST

Local Chassis UDI Information:
  PID         : ASR-9010-AC
  S/N         : FOX1232H67M
  Operation ID: 1
     

    Displays the UDI of the chassis. This consists of a product identifier (PID), serial number (S/N), and operation identifier (Operation ID).

     
    Step 3 http:/​/​www.cisco.com/​go/​license
     

    Go to the license tool on Cisco.com. You must log in to the site before you can access the license tool. Follow the instructions for product license registration. You are required to enter the feature PAK and the chassis UDI to acquire the license.

    Note   

    If you are installing a permanent license, you should have received the PAK when you purchased the feature. If you are installing an evaluation license, your sales representative should provide you with the PAK.

     
    Step 4Copy the license to your TFTP server. 

    You will be issued a license. You can copy the license and store it on your computer, or alternatively, you can request that the license be sent to you in an e-mail. When you have received the license, copy it to a TFTP server that is accessible by your router.

     
    Step 5 admin


    Example: 
    RP/0/RSP0/CPU0:router# admin
     

    Enters administration EXEC mode.

     
    Step 6 license add license-name [ sdr sdr-name ]


    Example: RP/0/RSP0/CPU0:router(admin)# license add tftp://192.10.10.10/mylicenses/lc40g_lic  

    Adds the license to the SDR license pool. By default, the license is added to the owner SDR license pool.

     
    Step 7 configure


    Example: 
    RP/0/RSP0/CPU0:router(admin)# configure
     

    Enters administration configuration mode.

     
    Step 8 license license-name location {all | node-id}


    Example: 
    RP/0/RSP0/CPU0:router(admin-config)# license A9K-ADV-OPTIC-LIC 
location 0/0/CPU0
     

    Binds the license to the slot where it is to be used.

     
    Step 9 exit


    Example: 
    RP/0/RSP0/CPU0:router(admin)# exit
     

    Exits administration EXEC mode.

     
    What to Do Next

    To use the feature associated with the added license, you must configure it on your router. To configure Layer 3 VPN, see the Implementing MPLS Layer 3 VPNs on Cisco IOS XR Software module in Cisco ASR 9000 Series Aggregation Services Router MPLS Configuration Guide.

    To verify that your Layer 3 VPN configuration is operational, use the show rsi interface all global command.

    Backing Up Licenses

    When your router is configured with the licenses that you require, you should perform this task to back up all licenses. Backing up licenses makes it easier to restore them if there is a problem.

    SUMMARY STEPS

      1.    admin

      2.    license backup backup-file

      3.    show license backup backup-file


    DETAILED STEPS
       Command or ActionPurpose
      Step 1 admin


      Example: 
      RP/0/RSP0/CPU0:router# admin
       

      Enters administration EXEC mode.

       
      Step 2 license backup backup-file


      Example:

      RP/0/RSP0/CPU0:router(admin)# license backup disk1:/license_back

      License command "license backup disk1:/license_back" completed successfully.

       

      Backs up all licenses on the router to a backup file in the specified location. The backup file can be a local file or a remote file on a TFTP or RCP server.

       
      Step 3 show license backup backup-file


      Example: 
      


RP/0/RSP0/CPU0:router(admin)# show license backup disk1:/license_back
       

      Displays the contents of the backup file.

       

      Examples

      The following example shows sample output from the show license backup command. 

      
RP/0/RSP0/CPU0:router(admin)# show license backup disk1:/license_back

Local Chassis UDI Information:
  S/N         : TBA09370035
  Operation ID:   5
Licenses      :
FeatureID    Type                     #installed
CRS-MSC-40G  Slot based,    Permanent          2
XC-L3VPN     Slot based,    Permanent          1

      
RP/0/RSP0/CPU0:router(admin)# show license backup disk0:/lic_backup.pkg

Tue Jul 27 17:12:44.982 pst

Local Chassis UDI Information:
  S/N         : FOX1316G5TL  
  Operation ID:   9  

  FeatureID: A9K-ADV-OPTIC-LIC (Slot based, Permanent) 
  Total licenses  1
    Pool: Owner  1
    Allocated Node(s): 
      0/0/CPU0 1 [Owner]

  FeatureID: A9K-ADV-VIDEO-LIC (Slot based, Evaluation) 
  Total licenses  1
    Pool: Owner  1
    Allocated Node(s): 
      0/RSP0/CPU0 1 [Owner]

  FeatureID: A9K-AIP-LIC-B (Slot based, Permanent) 
  Total licenses  2
    Pool: Owner  2
    Allocated Node(s): 
      0/6/CPU0 1 [Owner]
      0/1/CPU0 1 [Owner]

  FeatureID: A9K-AIP-LIC-E (Slot based, Permanent) 
  Total licenses  2
    Pool: Owner  2
    Allocated Node(s): 
      0/4/CPU0 1 [Owner]

  FeatureID: A9K-iVRF-LIC (Slot based, Permanent) 
  Total licenses  1
    Pool: Owner  1

  FeatureID: A9K-iVRF-LIC (Slot based, Evaluation) 
  Total licenses  3
    Pool: Owner  3
    Allocated Node(s): 
      0/1/CPU0 1 [Owner]

      Restoring Licenses

      If your licenses become corrupted, and you have previously created a backup of your licenses, you can perform this task to restore the licenses to your router.

      Before You Begin

      You must have created a backup file of your licenses before you can restore them on your router.

      SUMMARY STEPS

        1.    admin

        2.    show license backup backup-file

        3.    license restore backup-file


      DETAILED STEPS
         Command or ActionPurpose
        Step 1 admin


        Example: 
        RP/0/RSP0/CPU0:router# admin
         

        Enters administration EXEC mode.

         
        Step 2 show license backup backup-file


        Example: RP/0/RSP0/CPU0:router(admin)# show license backup disk1:/license_back  

        Displays the contents of the backup file. You should verify the contents of the backup file before you restore your licenses.

         
        Step 3 license restore backup-file


        Example: RP/0/RSP0/CPU0:router(admin)# license restore disk1:/license_back  

        Restores all licenses on the router from a backup file in the specified location. This can be a local file, or a remote file on a TFTP or RCP server.

         

        Examples

        This example shows sample output from the license restore command. 

        RP/0/RSP0/CPU0:router(admin)# license restore disk1:/license_back

Info: This command will erase all existing licenses.
Info: It is strongly recommended to backup existing licenses first.
Do you wish to proceed? [yes/no]: y

License command "license restore disk1:/license_back" completed successfully.

        Troubleshooting License Issues after a Software Upgrade

        In the instance that you were running Cisco IOS XR Release 3.9.0 and had the optic feature enabled on a interface and the A9K-ADV-OPTIC-LIC license was active on a particular slot, when you upgrade to Cisco IOS XR Release 4.0.0, the A9K-ADV-OPTIC-LIC license is still active, but you may get the following warning message:

        RP/0/RSP0/CPU0:Jul 27 14:22:22.594 : licmgr[236]: 
%LICENSE-LICMGR-4-PACKAGE_LOCATION_LICENSE_INVALID : 
Feature associated to package A9K-ADV-OPTIC-LIC configured 
on node 0/4/CPU0 without a valid license

        To solve this issue, configure the license command in administration EXEC mode. This binds the A9K-ADV-OPTIC-LIC license to the slot on which you are using the license. For example:

        RP/0/RSP0/CPU0:router(admin-config)# license A9K-ADV-OPTIC-LIC location 0/4/CPU0 
RP/0/RSP0/CPU0:router(admin-config)# commit

        Additional References

        The following sections provide references related to Cisco IOS XR software entitlement.

        Related Documents

        Related Topic

        Document Title

        Cisco IOS XR software entitlement commands

        Software Entitlement Commands on the Cisco ASR 9000 Series Router module of Cisco ASR 9000 Series Aggregation Services Router System Management Command Reference

        Layer 2 VPN configuration

        		 Implementing MPLS Layer 2 VPNs module of Cisco ASR 9000 Series Aggregation Services Router MPLS Configuration Guide

        Layer 3 VPN configuration

        Implementing MPLS Layer 3 VPNs on the Cisco ASR 9000 Series Router module of Cisco ASR 9000 Series Aggregation Services Router MPLS Configuration Guide

        Cisco IOS XR software commands

        Cisco ASR 9000 Series Aggregation Services Router Commands Master List

        Information on getting started with Cisco IOS XR software

        Cisco ASR 9000 Series Aggregation Services Router Getting Started Guide

        Information about user groups and task IDs

        Configuring AAA Services on the Cisco ASR 9000 Series Router module of Cisco ASR 9000 Series Aggregation Services Router System Security Configuration Guide

        Standards

        Standards

        Title

        No new or modified standards are supported by this feature, and support for existing standards has not been modified by this feature.

        		—

        MIBs

        MIBs

        MIBs Link

        —

        To locate and download MIBs using Cisco IOS XR software, use the Cisco MIB Locator found at the following URL and choose a platform under the Cisco Access Products menu: http:/​/​cisco.com/​public/​sw-center/​netmgmt/​cmtk/​mibs.shtml

        RFCs

        RFCs

        Title

        No new or modified RFCs are supported by this feature, and support for existing RFCs has not been modified by this feature.

        —

        Technical Assistance

        Description

        Link

        The Cisco Technical Support website contains thousands of pages of searchable technical content, including links to products, technologies, solutions, technical tips, and tools. Registered Cisco.com users can log in from this page to access even more content.

        http:/​/​www.cisco.com/​cisco/​web/​support/​index.html