The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
This chapter contains the following sections:
The Cisco VSG software is available for download at the following URL:http://www.cisco.com/en/US/products/ps11208/index.html
When you download the software from the above location, you are prompted to fill the online form. When the form has been completed appropriately, you will receive an email that contains the software license claim certificate. The number of licenses you receive depends on how many VEMs you indicate you have and how many CPU sockets you indicate are available on those VEMs.
Before you upgrade VSM to the latest Microsoft Hyper-V release, ensure that sufficient VSG Hyper-V licenses are installed on the VSM. Follow the standard license installation procedure to install a new license.
Parameter | Default |
---|---|
volatile license |
Enabled Licenses are returned to the VSM pool when a VEM has no VM that has Cisco VSG service configured or the VEM is out of service. |
Obtain the license file that is required for each VSM, and then install it.
Use the following procedure to obtain a license file for a VSM.
Step 1 |
switch# show license host-id Obtain the serial number, also called the host ID, for your VSM.
License hostid: VDH=1280389551234985805 |
||
Step 2 |
From your software license claim certificate, locate the product authorization key (PAK). You will need the PAK for Product License Registration. |
||
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 site, 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.
|
||
Step 6 |
Save your license to a TFTP server. |
||
Step 7 |
switch# copy scp://user@license_path/file bootflash: Copy your license to bootflash on the VSM. Example:The following example shows you how to 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# |
Use the following procedure to install the license file(s) on a VSM. Installing multiple licenses is called stacking.
switch# install license bootflash:license_file.lic Installing license ..done switch# show license file license_file.lic switch# show license usage NEXUS_VSG_MSFT_SERVICES_PKG switch# copy running-config startup-config
The following example shows how to install a license file and then display its contents and usage:
n1000v# install license bootflash:license_file.lic Installing license ..done switch# show license file license_file.lic SERVER this_host ANY VENDOR cisco INCREMENT NEXUS_VSG_MSFT_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 NEXUS_VSG_MSFT_SERVICES_PKG -------------------------------------- Feature Usage Info -------------------------------------- Installed Licenses : 10 Default Eval Licenses : 0 Max Overdraft Licenses : 16 Installed Licenses in Use : 2 Overdraft Licenses in Use : 0 Default Eval Lic in Use : 0 Licenses Available : 24 Shortest Expiry : Never -------------------------------------- Application -------------------------------------- VEM 3 - Socket 1 VEM 3 - Socket 2 --------------------------------------
You can transfer licenses between VEMs and uninstall a license by transferring it from a VEM to the VSM license pool.
Use the following procedure to transfer licenses from one VEM to another. For example, you might transfer licenses between VEMs after moving a VM from one host to another.
Step 1 |
vservice license type vsg transfer src-module mod_no dst-module mod_no Transfers the licenses from one VEM to another. mod_no—The VEM module number |
Step 2 |
show license usage package_name Verifies the transfer by displaying the licenses in use on each VEM. |
switch# vservice license type vsg transfer src-module 5 dst_module 6 switch# show license usage
The following example shows how to transfer a license from VEM 3 to VEM 5 and verify the transfer in the license usage:
switch# vservice license type vsg src-module 3 dst_module 5 switch# show license usage NEXUS_VSG_MSFT_SERVICES_PKG -------------------------------------- Feature Usage Info -------------------------------------- Installed Licenses : 10 Eval Licenses : 0 Max Overdraft Licenses : 512 Installed Licenses in Use : 4 Overdraft Licenses in Use : 0 Eval Licenses in Use : 0 Licenses Available : 512 -------------------------------------- Application -------------------------------------- VEM 4 - Socket 1 VEM 4 - Socket 2 VEM 5 - Socket 1 VEM 5 - Socket 2 --------------------------------------
Use the following procedure to transfer licenses from a VEM to the VSM license pool. For example, you might remove a license from a VEM and transfer it to the VSM license pool.
Step 1 |
vservice license type vsg transfer src-module mod_no license_pool Transfers the licenses from a VEM to the license pool. All virtual machines on the VEM can no longer use the Cisco VSG service. |
Step 2 |
show license usage package_name Verifies the transfer by displaying the licenses in use on each VEM. |
switch(config)# vservice license type vsg transfer src-module 5 license-pool switch# show license usage
switch# vservice license type vsg transfer src-module 5 license-pool switch# show license usage NEXUS_VSG_MSFT_SERVICES_PKG -------------------------------------- Feature Usage Info -------------------------------------- Installed Licenses : 10 Eval Licenses : 0 Max Overdraft Licenses : 16 Installed Licenses in Use : 2 Overdraft Licenses in Use : 0 Eval Licenses in Use : 0 Licenses Available : 24 -------------------------------------- Application -------------------------------------- VEM 4 - Socket 1 VEM 4 - Socket 2 --------------------------------------
Note |
You can use the following command to transfer a license from a license pool to a VEM machine: vservice license type vsg transfer license-pool dst-module mode_no |
Use the following procedure to uninstall a license that is not in use.
Caution |
When you uninstall a license file from a VSM, the VMs on the VEMs can no longer use Cisco VSG services, which could cause a service disruption in your network. |
Command or Action | Purpose | |||
---|---|---|---|---|
Step 1 | copy running-configure terminal ftp://server/path/filename |
Copies the VSM running configuration to a remote server. |
||
Step 2 | show license brief |
Identifies the name of the license file to uninstall. |
||
Step 3 | 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 4 | vservice license type vsg transfer src-module mod_no license-pool |
Transfers the licenses from the VEM back to the VSM license pool.
|
||
Step 5 | clear license license_name |
Begins the uninstall of the named license file |
||
Step 6 | copy running-config startup-config |
(Optional) Saves the running configuration persistently through reboots and restarts by copying it to the startup configuration |
switch# copy running-configure terminalftp: switch# show license brief Enterprise.lic switch# switch# show license usage switch# vsg license type vsg transfer src-module 3 license-pools switch# 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# show license brief Enterprise.lic switch# switch# show license usage NEXUS_VSG_MSFT_SERVICES_PKG -------------------------------------- Feature Usage Info -------------------------------------- Installed Licenses : 512 Eval Licenses : 0 Max Overdraft Licenses : 512 Installed Licenses in Use : 4 Overdraft Licenses in Use : 0 Eval Licenses in Use : 0 Licenses Available : 512 -------------------------------------- Application -------------------------------------- VEM 3 - Socket 1 VEM 3 - Socket 2 VEM 4 - Socket 1 VEM 4 - Socket 2 -------------------------------------- switch# vservice license type vsg transfer src-module 3 license-pool switch# vservice license type vsg transfer src-module 4 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 This example displays the licenses in use on each VEM. switch# show license usage NEXUS_VSG_MSFT_SERVICES_PKG -------------------------------------- Feature Usage Info -------------------------------------- Installed Licenses : 512 Eval Licenses : 0 Max Overdraft Licenses : 512 Installed Licenses in Use : 4 Overdraft Licenses in Use : 0 Eval Licenses in Use : 0 Licenses Available : 512 -------------------------------------- Application -------------------------------------- VEM 3 - Socket 1 VEM 3 - Socket 2 VEM 4 - Socket 1 VEM 4 - Socket 2 -------------------------------------- switch#
Configuring Nonvolatile Licenses
Use the following procedure to enable nonvolatile licenses so that whenever a VEM is taken out of service, it keeps its license and does not return the license to the VSM pool of available licenses.
Command or Action | Purpose | |
---|---|---|
Step 1 | configure terminal |
Places you into global configuration mode. |
Step 2 | no vservice license type vsg volatile |
Enables nonvolatile licenses in the running configuration. |
Step 3 | copy running-config startup-config |
(Optional) Saves the running configuration persistently through reboots and restarts by copying it to the startup configuration. |
switch# configure terminal switch(config)# no vservice license type vsg volatile switch(config)# copy running-config startup-config
Use the following procedure to disable nonvolatile licenses so that when a VEM is taken out of service, its licenses are returned to the VSM pool of available licenses.
Note |
For the Cisco VSG, the licenses are by default volatile. We recommend that you leave the Cisco VSG license configuration to be volatile by default. The volatile licenses feature is disabled by default for the Cisco Nexus 1000V Series Switch. That is, the licenses in VEMs are nonvolatile and are not released when a VEM is removed from service. If you configure the license from nonvolatile to volatile, if the VEM does not use the Cisco VSG services, the license possessed by the VEM is returned to the license pool. |
Command or Action | Purpose | |
---|---|---|
Step 1 | configure terminal |
Places you into global configuration mode. |
Step 2 | vservice license type vsg volatile |
Disables nonvolatile licenses in the running configuration. |
Step 3 | copy running-config startup-config |
(Optional) Saves the running configuration persistently through reboots and restarts by copying it to the startup configuration. |
switch# configure terminal switch(config)# vservice license type vsg volatile switch(config)# copy running-config startup-config
Use one of the following commands to verify the configuration:
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. |
The following example shows how to use the show license usage command to display the license usage.
switch# show license usage NEXUS_VSG_MSFT_SERVICES_PKG -------------------------------------- Feature Usage Info -------------------------------------- Installed Licenses : 10 Default Eval Licenses : 0 Max Overdraft Licenses : 16 Installed Licenses in Use : 2 Overdraft Licenses in Use : 0 Default Eval Lic in Use : 0 Licenses Available : 24 Shortest Expiry : 25 May 2010 -------------------------------------- Application -------------------------------------- VEM 3 - Socket 1 VEM 4 - Socket 1 -------------------------------------- The following example shows how to use the show license brief command to display the license name: switch# show license brief Enterprise.lic switch# The following example shows how to use the show license file command to display the evaluation license parameters: switch# show license file eval.lic SERVER this_host ANY VENDOR cisco INCREMENT NEXUS_VSG_MSFT_SERVICES_PKG cisco 1.0 1-dec-2010 16 \ HOSTID=VDH=0871396331270074457 \ NOTICE="<LicFileID>eval.lic</LicFileID><LicLineID>0</LicLineID> \ <PAK>dummyPak</PAK>" SIGN=E08A38544DBE The following example shows how to use the show license file command to display the evaluation license parameters: switch# show license file Enterprise.lic SERVER this_host ANY VENDOR cisco INCREMENT NEXUS_VSG_MSFT_SERVICES_PKG cisco 1.0 permanent 16 \ HOSTID=VDH=0871396331270074457 \ NOTICE="<LicFileID>Enterprise.lic</LicFileID><LicLineID>0</LicLineID> \ <PAK>dummyPak</PAK>" SIGN=E08A38544DBE
Use the following procedure to 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 |
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 the 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. |
Use the following procedure to obtain a license file for a new VSM host, if the old VSM host is lost or destroyed.
Step 1 |
switch# show license host-id
Obtain the serial number, also called the host ID, for your new VSM. License hostid: VDH=1280389551234985805 |
||
Step 2 |
|
||
Step 3 |
Save your license to a TFTP server. |
||
Step 4 |
switch#copy scp://user@linux-box.cisco.com/home/user/n1kv_license.lic bootflash: 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#