Cisco Nexus 1000V License Configuration Guide, Release 4.2(1)SV1(5.2)
Installing and Configuring Licenses
Download this chapter
Installing and Configuring LicensesInstalling and Configuring Licenses
Download the complete book
Cisco Nexus 1000V License Configuration Guide, Release 4.2(1)SV1(5.2)Cisco Nexus 1000V License Configuration Guide, Release 4.2(1)SV1(5.2) (PDF - 1 MB)
 Feedback

Installing and Configuring Licenses

This chapter includes the following sections:

Information About Licenses

For detailed information about licenses, see the Overview section.

Licensing Guidelines and Limitations

Use the following guidelines and limitations when configuring the permanent licenses:

  • If you modify a permanent license key file, it is invalidated.
  • When you purchase permanent licenses, the license key file is sent to you in an e-mail. The license key authorizes use on only the host ID device. You must obtain a separate license key file for each of your VSMs.
  • A license file contains the number of licenses ordered for your VSM. One license is required for each CPU on each VEM.
  • A VSM can have more than one license file depending on the number of installed VEM CPUs.
  • You must have a role equivalent to that of network-admin to install, uninstall, or copy a permanent license file. For information about user accounts and roles, see the Cisco Nexus 1000V Security Configuration Guide.
  • If you are installing multiple permanent licenses for the same VSM, also called license stacking, each permanent license key filename must be unique.
  • Licenses cannot be applied to a VEM unless there are sufficient licenses in the pool to cover all of its CPUs.
  • If a license is in use, you cannot delete its license file. You must first transfer all licenses from the VEMs to the VSM license pool before uninstalling the license file.
  • When you install a permanent license file, all default licenses are invalidated. Installing a permanent license file has no effect on evaluation licenses.

Default License Configuration Settings

Table 1 License Defaults
Parameter Default

license filename

n1kv_license.lic

volatile license

disabled

By default, the licenses are not returned to the VSM pool when a VEM is removed from the service.

Obtaining and Installing a License

This section describes how to obtain the license file that is required for each VSM and then install it. This section includes the following topics:

  • Obtaining the License File
  • Installing the License File on the VSM
Before You Begin

Before beginning the procedures in this section, you must know or do the following:

  • A license file is tied to each VSM by the host ID or the serial number associated with the VSM device.
  • A license file contains the number of licenses ordered for your VSM. One license is required for each CPU on each VEM.
  • A VSM can have more than one license file depending on the number of installed VEM CPUs.

Obtaining the License File

You can obtain a license file for a VSM.

  • A license file is tied to each VSM by the host ID or the serial number associated with the VSM device.
  • A license file contains the number of licenses ordered for your VSM. One license is required for each CPU on each VEM.
  • A VSM can have more than one license file depending on the number of installed VEM CPUs.
Before You Begin
  • Make sure that you have your product authorization key (PAK),which is in your software license claim certificate. If you cannot locate your software license claim certificate, contact contact Cisco Technical Support.
  • You are logged in to the CLI in EXEC mode.
  • In this procedure, you must copy a license file. This process requires that your username has a role equivalent to that of the network-admin role which allows you to copy files. For information about user accounts and roles, see the Cisco Nexus 1000V Security Configuration Guide.
Procedure
    Step 1   Obtain the serial number, also called the host ID, for your VSM: show license host-id 
    switch# show license host-id
License hostid: VDH=1280389551234985805
    Note   

    The host ID includes everything that appears after the equal sign (=). In this example, the host ID is 1280389551234985805.

    Step 2   From your software license claim certificate, locate the product authorization key (PAK).
    Step 3   Go to the Software Download site.
    Step 4   From the Software Download site, go to the Product License Registration site.
    Step 5   From the Product License Registration website, follow the instructions for registering your VSM license.

    The license key file is sent to you in an e-mail. The license key authorizes use on only the host ID device. You must obtain separate license key file(s) for each of your VSMs.

    Caution   

    The license key file is invalidated if you modify it.

    Step 6   Save your license to a TFTP server.
    Step 7   Copy your license to bootflash on the VSM. 
    switch# copy scp://user@linux-box.cisco.com/home/user/n1kv_license.lic bootflash: 
Enter vrf (If no input, current vrf 'default' is considered):
user@linux-box.cisco.com's password:
n1kv_license.lic                                   100%  252     0.3KB/s   00:00

switch#

    Installing the License File on the VSM

    You can install the license files on a VSM. Installing multiple licenses is called stacking.

    Before You Begin
    • Default licenses are invalidated when a permanent license file is installed. Make sure that the license file you are installing contains the number of licenses needed to cover all VEMs.
    • This procedure installs the license file using the name, license_file.lic. You can specify a different name if needed.
    • If you are installing multiple licenses for the same VSM, also called license stacking, make sure that each license key filename is unique.
    • Repeat this procedure for each additional license file you are installing, or stacking, on the VSM.
    • You are logged in to the CLI in EXEC mode.
    • You must have a role with privileges equivalent to that of the network-admin role to install a license. For information about user accounts and roles, see the Cisco Nexus 1000V Security Configuration Guide, Release 4.2(1)SV1(5.1).
    Procedure
       Command or ActionPurpose
      Step 1switch# install license bootflash: filename  

      Installs the license from the active VSM console.

      Note   

      If you specify a license filename, the file is installed with the specified name. Otherwise, the default filename is used.

      The license is installed on the VSM and each VEM automatically acquires a license for every CPU socket.

       
      Step 2switch# show license file filename  

      Verifies the license installation by displaying the license configured for the VSM.

       
      Step 3switch# show license usage package_name  

      Verifies the license installation by displaying it in the license usage table.

      Note   

      If you already have VEMs installed, the output of this command shows installed VEMs and sockets.

       
      Step 4switch# copy running-config startup-config  (Optional)

      Saves the change persistently through reboots and restarts by copying the running configuration to the startup configuration.

       

      This example shows how to install a license file and then display its contents and usage:

      switch# install license bootflash:license_file.lic 
Installing license ..done 
switch# show license file license_file.lic
SERVER this_host ANY
VENDOR cisco
INCREMENT NEXUS1000V_LAN_SERVICES_PKG cisco 1.0 permanent 10 \
        HOSTID=VDH=1575337335122974806 \
        NOTICE="<LicFileID>license_file.lic</LicFileID><LicLineID>0</LicLineID> \
        <PAK>PAK12345678</PAK>" SIGN=3AF5C2D26E1A
switch# show license usage NEXUS1000V_LAN_SERVICES_PKG
----------------------------------------
Feature Usage Info
----------------------------------------
       Installed Licenses : 10
    Default Eval Licenses : 0
   Max Overdraft Licenses : 16
Installed Licenses in Use : 4
Overdraft Licenses in Use : 0
  Default Eval Lic in Use : 0
   Default Eval days left : 0
       Licenses Available : 22
          Shortest Expiry : Never
----------------------------------------
Application
----------------------------------------
VEM 3 - Socket 1
VEM 4 - Socket 1
VEM 4 - Socket 2
VEM 5 - Socket 1
----------------------------------------
switch#

      Verifying the License Configuration

      To verify the license configuration, perform one of the following tasks:

      Table 2 License Configuration Show Commands
      Command Purpose

      show license

      Displays the license filename for the VSM.

      show license brief

      Displays the license installed on the VSM.

      show license file filename

      Displays the contents of the license file installed on the VSM, including the license filename and the expiration date for evaluation licenses.

      show license usage

      Displays the total number of licenses in use on the VEMs.

      show license usage package_name

      Displays statistics about the number of evaluation and permanent licenses available, installed, and in use on the VSM.

      show module vem [module] license-info

      Displays the license mode and the usage of licenses by each module.

      Transferring Licenses

      This section includes the following topics that describe how to transfer licenses between VEMs and uninstall a license by transferring it from a VEM to the VSM license pool:

      • Transferring Licenses Between VEMs
      • Transferring Licenses to the License Pool
      • Transferring Licenses from the License Pool to VEMs

      Transferring Licenses Between VEMs

      You can transfer licenses from one VEM to another, for example, after moving a VM from one host to another.

      • Licenses cannot be transferred to a VEM unless there are sufficient licenses in the pool to cover all of its CPUs.
      • When licenses are successfully transferred from one VEM to another, the virtual Ethernet interfaces on the source VEM are removed from service, and the virtual Ethernet interfaces on the destination VEM are brought into service. The licenses on the source VEM are checked in regardless of any failure that might occur while the destination module is being licensed.
      Before You Begin
      • You are logged in to the CLI in EXEC mode.
      • You know the VEM that you want to transfer licenses from and the number of licenses it has.
      • You know the VEM that you are transferring licenses to and the number of licenses required.
      • You know the number of CPUs installed on the destination VEM.
      Procedure
         Command or ActionPurpose
        Step 1switch# svs license transfer src-vem vem_no dst-vem vem_no 

        Transfers the licenses from one VEM to another.

         
        Step 2switch# show license usage package_name 

        Verifies the transfer by displaying the licenses in use on each VEM.

         

        This example shows how to transfer a license from VEM 3 to VEM 5 and verify the transfer in the license usage:

        switch# svs license transfer src-vem 3 dst-vem 5
switch(config)#
switch# show license usage NEXUS1000V_LAN_SERVICES_PKG 
----------------------------------------
Feature Usage Info
----------------------------------------
       Installed Licenses : 29
    Default Eval Licenses : 0
   Max Overdraft Licenses : 16
Installed Licenses in Use : 2
Overdraft Licenses in Use : 0
  Default Eval Lic in Use : 0
   Default Eval days left : 0
       Licenses Available : 43
          Shortest Expiry : 01 Jul 2011
----------------------------------------
Application
----------------------------------------
VEM 5 - Socket 1
VEM 5 - Socket 2
----------------------------------------
switch#

        Transferring Licenses to the License Pool

        You can transfer licenses from a VEM to the VSM license pool when, for example, removing a license from a VEM.

        Before You Begin
        • You are logged in to the CLI in EXEC mode.
        • When you transfer its licenses to the VSM license pool, all virtual Ethernet interfaces on the VEM are removed from service.
        Procedure
           Command or ActionPurpose
          Step 1switch# svs license transfer src-vem vem_no license_pool 

          Transfers the licenses from a VEM to the license pool.

           
          Step 2switch# show license usage package_name 

          Verifies the transfer by displaying the licenses in use on each VEM.

           

          This example shows how to display the licenses in use on each VEM. Notice that the licenses on VEM 3 are no longer in use.

          switch# show license usage NEXUS1000V_LAN_SERVICES_PKG 
----------------------------------------
Feature Usage Info
----------------------------------------
       Installed Licenses : 10
    Default Eval Licenses : 0
   Max Overdraft Licenses : 16
Installed Licenses in Use : 3
Overdraft Licenses in Use : 0
  Default Eval Lic in Use : 0
   Default Eval days left : 0
       Licenses Available : 23
          Shortest Expiry : Never
----------------------------------------
Application
----------------------------------------
VEM 4 - Socket 1
VEM 4 - Socket 2
VEM 5 - Socket 1
----------------------------------------
switch#

          Transferring Licenses from the License Pool to VEMs

          You can use this procedure to transfer licenses from a license pool to a VEM. The VEM will be licensed only if there are enough available licenses.

          When you transfer licenses from the license pool to the VEM, if there are enough licenses available the module will be licensed and all the virtual Ethernet interfaces that were powered down will be powered up.

          Before You Begin

          You are logged in to the CLI in EXEC mode.

          Procedure
             Command or ActionPurpose
            Step 1switch#svs license transfer license_pool dst-vem module  

            Transfers a license from the license pool to the VEM.

            The value of module can be from 3 to 66.

             
            Step 2switch# show module vem module license-info  

            Verifies the transfer by displaying the licenses in use on each VEM.

             

            This example shows how to display the licenses in use on each VEM.

            switch# show module vem 3 license-info 
Licenses are Sticky 
Mod     Socket Count   License Usage Count      License Version   License Status
---     ------------   -------------------      ---------------   --------------
3       1              1                        1.0               licensed
switch#

            Uninstalling a License

            You can uninstall a license that is not in use. If a license is in use, you cannot delete it. This procedure includes instructions for transferring all licenses from the VEMs to the VSM license pool before uninstalling the license file.


            Caution

            Service Disruption—When you uninstall a license file from a VSM, the vEthernet interfaces on the VEMs are removed from service and the traffic flowing to them from virtual machines is dropped. This traffic flow is not resumed until you add a new license file with licenses for the VEMs. We recommend that you notify the server administrator that you are uninstalling a license, and this action will cause the vEthernet interfaces to shut down.

            Before You Begin
            • You are logged in to the CLI in EXEC mode.
            • Only users with the network-admin role can uninstall licenses. For information on user accounts and roles, see the Cisco Nexus 1000V Security Configuration Guide.
            Procedure
               Command or ActionPurpose
              Step 1switch# copy running-config tftp://server/path/filename 

              Copies the VSM running configuration to a remote server.

               
              Step 2switch# show license brief 

              Identifies the name of the license file to uninstall.

               
              Step 3switch# show license usage package_name 

              Displays the licenses in use on each VEM so that you can transfer them back to the VSM license pool before uninstalling the license file.

               
              Step 4switch# svs license transfer src-vem vem_no license_pool 

              Transfers the licenses from the VEM back to the VSM license pool.

               
              Step 5Repeat the above step for each VEM until all licenses in use have been transferred back to the VSM license pool.   
              Step 6switch# clear license license_name 

              Begins the uninstall of the named license file.

               
              Step 7switch# copy running-config startup-config  (Optional)

              Saves the change persistently through reboots and restarts by copying the running configuration to the startup configuration.

               

              This example shows how to uninstall a license that is no longer in use. In this example, the file to uninstall is the Enterprise.lic file. 

              switch# show license brief
Enterprise.lic
switch#
switch# show license usage NEXUS1000V_LAN_SERVICES_PKG 
----------------------------------------
Feature Usage Info
----------------------------------------
       Installed Licenses : 29
    Default Eval Licenses : 0
   Max Overdraft Licenses : 16
Installed Licenses in Use : 2
Overdraft Licenses in Use : 0
  Default Eval Lic in Use : 0
   Default Eval days left : 0
       Licenses Available : 43
          Shortest Expiry : 01 Jul 2011
----------------------------------------
Application
----------------------------------------
VEM 5 - Socket 1
VEM 5 - Socket 2
----------------------------------------
switch# svs license transfer src-vem 3 license_pool 
switch# clear license Enterprise.lic 
Clearing license Enterprise.lic:
SERVER this_host ANY
VENDOR cisco
Do you want to continue? (y/n) y
Clearing license ..done
switch(config)# copy running-config startup-config
switch(config)#

              Configuring Volatile Licenses

              This section provides information about enabling and disabling the volatile license feature and includes the following sections:

              • Enabling Volatile Licenses
              • Disabling Volatile Licenses

              Enabling Volatile Licenses

              You can enable volatile licenses so that whenever a VEM is taken out of service, its licenses are returned to the VSM pool of available licenses.


              Note

              Service Disruption—Volatile licenses are removed from a VEM during a loss in connectivity and the system will try to get the required licenses when connectivity resumes. We recommend that the volatile licenses remain disabled and that you transfer unused licenses using the Transferring Licenses to the License Pool section.

              A volatile license is disabled by default. That is, by default, licenses are not returned to the VSM pool when a VEM is removed from service.

              Before You Begin

              You are logged in to the CLI in EXEC mode.

              Procedure
                 Command or ActionPurpose
                Step 1switch# configure terminal 

                Enters global configuration mode.

                 
                Step 2 switch# svs license volatile 

                Enables volatile licenses in the running configuration.

                 
                Step 3switch(config)# copy running-config startup-config  (Optional)

                Saves the change persistently through reboots and restarts by copying the running configuration to the startup configuration.

                 

                This example shows how to enable a volatile license:

                switch# configure terminal
switch(config)# svs license volatile
switch(config)# copy running-config startup-config
switch(config)#

                Disabling Volatile Licenses

                You can disable volatile licenses so that whenever a VEM is taken out of service its licenses are not returned to the VSM pool of available licenses.


                Note

                By default, the licenses are non volatile (sticky) in nature, which is the recommended configuration. This configuration ensures that the licenses are reserved for a VEM. Even after a period of brief connectivity loss between the VEM and the VSM, the VEM is guaranteed to get the needed licenses.

                Before You Begin

                You are logged in to the CLI in EXEC mode.

                Procedure
                   Command or ActionPurpose
                  Step 1switch# configure terminal 

                  Enters global configuration mode.

                   
                  Step 2 switch# no svs license volatile 

                  Disables volatile licenses in the running configuration.

                   
                  Step 3switch(config)# copy running-config startup-config  (Optional)

                  Saves the change persistently through reboots and restarts by copying the running configuration to the startup configuration.

                   

                  This example shows how to disable a volatile license:

                  switch# configure terminal
switch(config)# no svs license volatile
switch(config)# copy running-config startup-config
switch(config)#

                  Changing the Serial Number in a License

                  You can change the serial number, or host ID, associated with a license. This process is also called rehosting and is required if you replace a VSM in your network with a new VSM.


                  Caution

                  Service Disruption—When you remove a VSM from your network, the vEthernet interfaces on the VEMs are removed from service and the traffic flowing to them from virtual machines is dropped. This traffic flow is not resumed until you add a new VSM and new license file with the new host ID.

                  • A license file is tied to each VSM by the host ID, or the serial number, associated with the VSM device.
                  • A license file contains the number of licenses ordered for your VSM. One license is required for each CPU on each VEM.
                  • A VSM can have more than one license file depending on the number of installed VEM CPUs.
                  • If you have multiple license files stacked on your VSM, repeat this process for each license file.
                  Before You Begin
                  • You have a copy of your existing license files with the host ID of the existing VSM.
                  • You are logged in to the CLI in EXEC mode.
                  • You must copy a license file. Your username must have the network-admin role that allows you to copy files. For information about user accounts and roles, see the Cisco Nexus 1000V Security Configuration Guide.
                  Procedure
                    Step 1   Obtain the serial number, also called the host ID, for your new VSM: 
                    switch# show license host-id
License hostid: VDH=1280389551234985805
                    Note   

                    The host ID number appears after the equal sign (=). In this example, the host ID is 1280389551234985805.

                    Step 2   E-mail the following information to licensing@cisco.com, requesting the license file be rehosted to the new host ID:
                    • The new host ID
                    • The new host ID

                    A new license key file, with the host ID of the new VSM, is sent to you in e-mail within 48 hours.

                    Note   

                    Do not modify the license key file. The license key file is invalidated if you modify it.

                    Step 3   Save your license to a TFTP server.
                    Step 4   Copy your license to bootflash on the VSM. 
                    switch# copy scp://user@linux-box.cisco.com/home/user/n1kv_license.lic bootflash: 
Enter vrf (If no input, current vrf 'default' is considered):
user@linux-box.cisco.com's password:
n1kv_license.lic                                   100%  252     0.3KB/s   00:00
switch#

                    Obtaining a License File for Rehosting

                    You can obtain a license file for a new VSM host, if the old VSM host is lost or destroyed.

                    Before You Begin

                    Before beginning this procedure, you must know or do the following:

                    • A license file is tied to each VSM by the host ID, or the VSM serial number.
                    • You are logged in to the CLI in EXEC mode.
                    • You must copy a license file. Your username must have the network-admin role that allows you to copy files. For information about user accounts and roles, see the Cisco Nexus 1000V Security Configuration Guide.
                    Procedure
                      Step 1   Obtain the serial number, also called the host ID, for your new VSM: 
                      switch# show license host-id
License hostid: VDH=1280389551234985805
                      Note   

                      NoteThe host ID number appears after the equal sign (=). In this example, the host ID is 1280389551234985805. You will need the host ID in step 5.



                      Example:

                      Step 2   E-mail the following information to licensing@cisco.com, requesting the license file be rehosted to the new host ID:

                      The new host ID

                      A copy of the existing license file from the old VSM

                      Note   

                      Do not modify the license key file. The license key file is invalidated if you modify it.

                      Step 3   Save your license to a TFTP server.
                      Step 4   Copy your license to bootflash on the VSM. 
                      switch# copy scp://user@linux-box.cisco.com/home/user/n1kv_license.lic bootflash: 
Enter vrf (If no input, current vrf 'default' is considered):
user@linux-box.cisco.com's password:
n1kv_license.lic                                   100%  252     0.3KB/s   00:00

switch#

                      Feature History for Licenses

                      This table includes only the updates for those releases that have resulted in additions or changes to the feature.

                      Table 3 Feature History
                      Feature Name Releases Feature Information

                      Default license

                      4.2(1)SV1(5.2)

                      512 default licenses that are valid for 240 days are included in the software image.

                      Evaluation license

                      4.0(4)SV1(3)

                      16 evaluation licenses that are valid for 60 days are included in the software image. More evaluation licenses of varied durations can be downloaded from Cisco.com and installed separately.

                      Evaluation license

                      4.0(4)SV1(2)

                      Evaluation licenses are part of the software installation or upgrade. A separate evaluation license file no longer needs to be installed.

                      show license usage package_name command

                      4.0(4)SV1(2)

                      The show license usage package_name command output is updated to show statistics about the number of evaluation and permanent licenses available, installed, and in use on the VSM.

                      License

                      4.0(4)SV1(1)

                      This feature was introduced.