Feedback
Contents
- Licensing Cisco NX-OS Software Features
- Information About Licensing
- Feature-Based Licenses
- Module-based Licenses
- Licensing Terminology
- Licensing Virtualization Support
- Licensing High Availability
- License Installation
- Obtaining a Factory-Installed License
- Performing a Manual Installation
- Obtaining the License Key File
- Installing the License Key File
- Backing Up Licenses
- Backing Up the License Key File
- Backing Up an Installed License
- Identifying License Features in Use
- Uninstalling Licenses
- Updating Licenses
- Configuring the Grace Period Feature
- Grace Period Alerts
- Enabling the License Grace Period
- Disabling the License Grace Period
- Associating a License with a Module
- License Transfers Between Devices
- Verifying the License Configuration
- Additional References
- Feature History for Licensing
Licensing Cisco NX-OS Software Features
This publication contains information related to licensing types, options, procedures, installation, and management for the Cisco NX-OS software.
NoteCisco Data Center Network Manager (DCNM) is a graphical user interface that you can use to manage your data center infrastructure. See the Cisco DCNM Installation and Licensing Guide for details about installing and licensing Cisco DCNM.
- Information About Licensing
- Licensing Terminology
- Licensing Virtualization Support
- Licensing High Availability
- License Installation
- Obtaining the License Key File
- Installing the License Key File
- Backing Up Licenses
- Identifying License Features in Use
- Uninstalling Licenses
- Updating Licenses
- Configuring the Grace Period Feature
- Associating a License with a Module
- License Transfers Between Devices
- Verifying the License Configuration
- Additional References
- Feature History for Licensing
Information About Licensing
Licensing allows you to access specified premium features on the device after you install the appropriate license for that feature.
Feature-Based Licenses
Feature-based licenses make features available to the entire physical device, so you only need one copy of the license for a device. Each license only supports the listed features. Licenses may be specific to a particular hardware platform.
Any feature not included in a license package is bundled with the Cisco NX-OS software and is provided at no extra charge to you.
The licenses are independent of each other. If you want to use features that are covered by different licenses, you must install all appropriate licenses.
NoteStarting with Cisco NX-OS Release 6.1, Cisco TrustSec (CTS) does not require a feature license. CTS is included with the Cisco NX-OS software.
This table lists the feature-based license packages for the Cisco Nexus 6000 Series switches.
Table 2 Feature-Based Licenses for the Cisco Nexus 6000 SeriesFeature License
Product ID
Features
FabricPath Services Package
ENHANCED_LAYER2_PKG
N6K-EL2-SSK9
FabricPath
FCoE NPV Package
FCOE_NPV_PKG
N6K-FNPV-SSK9
FCoE NPV
Layer 3 Base Services Package
LAN_BASE_SERVICES_PKG
N6K-BAS1K9
Layer 3 Enterprise Services Package
LAN_ENTERPRISE_SERVICES_PKG
N6K-LAN1K9
Storage Protocols Services Package
FC_FEATURES_PKG
N6K-16P-10GE-SSK9
N6K-4P-40GE-SSK9
VM-FEX Package
N6K-VMFEXK9
VM-FEX
1 Although this feature can be enabled and configured in the CLI without this license, it will not function until the license is installed.2 Although this feature can be enabled and configured in the CLI without this license, it will not function until the license is installed.
This table lists the feature-based license packages for the Cisco Nexus 5000 Series switches.
Note The prefix of the Product ID number indicates the platform for which the license applies. For example, N5548 indicates that the license is for the Cisco Nexus 5548 switch only, and N5K indicates that the license is for all Cisco Nexus 5000 Series switches.
Table 3 Feature-Based Licenses for the Cisco Nexus 5000 SeriesFeature License
Product ID
Features
FabricPath Services Package
ENHANCED_LAYER2_PKG
N5548-EL2-SSK9
N5596-EL2-SSK9
FabricPath
FCoE NPV Package
FCOE_NPV_PKG
N5010-FNPV-SSK9
N5020-FNPV-SSK9
N5548-FNPV--SSK9
N5596-FNPV-SSK9
FCoE NPV
Layer 3 Base Services Package
LAN_BASE_SERVICES_PKG
N55-BAS1K9
Layer 3 Enterprise Services Package
LAN_ENTERPRISE_SERVICES_PKG
N55-LAN1K9
Storage Protocols Services Package
FC_FEATURES_PKG
N5010-SSK9
N5020-SSK9
N55-8P-SSK9
N55-48P-SSK9
N55-96P-SSK9
VM-FEX Package
N55-VMFEXK9
VM-FEX
3 Although this feature can be enabled and configured in the CLI without this license, it will not function until the license is installed.4 Although this feature can be enabled and configured in the CLI without this license, it will not function until the license is installed.
This table lists the feature-based license packages for the Cisco Nexus 4000 Series.
Table 4 Feature-Based Licenses for the Cisco Nexus 4000 SeriesFeature License
Product ID
Features
Basic Storage Services Package
BASIC_STORAGE_SERVICES_PKG
N4K-4005I-SSK9
FIP snooping feature
This table lists the feature-based license packages for the Cisco Nexus 3000 Series.
Table 5 Feature-Based Licenses for the Cisco Nexus 3500 SeriesFeature License
Product ID
Features
Layer 3 Base Services Package
LAN_BASE_SERVICES_PKG
N3548-BAS1K9
Layer 3 Enterprise Services Package
LAN_ENTERPRISE_SERVICES_PKG
N3548-LAN1K9
Note Requires Base Services Package.
Cisco Nexus 3500 Algo Boost License
ALGO_BOOST_SERVICES_PKG
N3548-ALGK9
This table lists the feature-based license packages for the Cisco Nexus 3000 Series.
Table 6 Feature-Based Licenses for the Cisco Nexus 3000 SeriesFeature License
Product ID
Features
Layer 3 Base Services Package
LAN_BASE_SERVICES_PKG
N3K-BAS1K9
Layer 3 Enterprise Services Package
LAN_ENTERPRISE_SERVICES_PKG
N3K-LAN1K9
Note Requires Base Services Package.
Module-based Licenses
Module-based licenses make features available to one module on the physical device, so you need one copy of the license for each module that you want to enable the features on. Each license only supports the listed features. Licenses may be specific to a particular hardware platform or module.
Note
Any feature not included in a license package is bundled with the Cisco NX-OS software and is provided at no extra charge to you.
This table lists the module license packages for the Cisco Nexus 7000 Series.
Table 7 Module-Based Licenses for the Cisco Nexus 7000 SeriesModule License
Product ID
Features
FCoE Services Package
(FCOE_PKG)
N7K-FCOEF132XP=
Note You do not need the Advanced Services Package to enable the storage VDC required for FCoE.
FCoE F2-Series
(FCoE_F2)
N7K-FCOEF248XP
Note
The licenses are independent of each other. If you want to use features that are covered by different licenses, you must install all appropriate licenses. For example, if you want to use EIGRP and VDCs on the Cisco Nexus 7000 Series, you must install both the Enterprise Services Package license and the Advanced Services Package license.Related Tasks
Licensing Terminology
The following terms are used in this document:
- Licensed feature
- Permission to use a particular feature through a license file, a hardware object, or a legal contract. This permission is limited to the number of users, number of instances, time span, and the implemented device.
- Licensed application
- A software feature that requires a license to be used.
- License enforcement
- A mechanism that prevents a feature from being used without first obtaining a license.
- Node-locked license
- A license that can only be used on a particular device using the device’s unique host ID.
- Host IDs
- A unique chassis serial number that is specific to each device.
- Software license claim certificate
- A document entitling its rightful owner to use licensed features on one device as described in that document.
- Product Authorization Key (PAK)
- The PAK allows you to obtain a license key from one of the sites listed in the software license claim certificate document. After registering at the specified website, you will receive your license key file and installation instructions through e-mail.
- License key file
- A device-specific unique file that specifies the licensed features. Each file contains digital signatures to prevent tampering and modification. License keys are required to use a licensed feature. License keys are enforced within a specified time span.
- Missing license
- If the bootflash has been corrupted or a supervisor module replaced after you have installed a license, that license shows as missing. The feature still works. You should reinstall the license as soon as possible.
- Evaluation license
- A temporary license. Evaluation licenses are time bound (valid for a specified number of days) and are tied to a host ID (device serial number).
- Permanent license
- A license that is not time bound is called a permanent license.
- Grace period
- The amount of time the features in a license package can continue functioning without a license.
- Support
- If you purchased Cisco support through a Cisco reseller, contact the reseller directly. If you purchased support directly from Cisco, contact Cisco Technical Support at this URL: http://www.cisco.com/en/US/support/tsd_cisco_worldwide_contacts.html
Licensing Virtualization Support
On the Cisco Nexus 7000 Series, you install and manage licenses on the physical device in the default virtual device context (VDC) (VDC 1). Licenses apply to features in all VDCs and Virtual Routing and Forwarding instances (VRFs) on the physical device. You do not need to obtain a separate license for each VDC or VRF. For more information on VDCs, see the Cisco Nexus 7000 Series NX-OS Virtual Device Context Configuration Guide.
Licensing High Availability
As with other Cisco NX-OS features, the licensing feature also maintains the following high-availability standards:
- Installing any license in the device is a nondisruptive process.
- Installing a license automatically saves a copy of permanent licenses to the chassis.
- If you have enabled the grace period feature, enabling a licensed feature that does not have a license key starts a counter on the grace period. You then have 120 days to install the appropriate license keys, disable the use of that feature, or disable the grace period feature. If at the end of the 120-day grace period the device does not have a valid license key for the feature, the Cisco NX-OS software automatically disables the feature and removes the configuration from the device.
Note
Some licenses, for example, Cisco TrustSec for the Cisco Nexus 7000 Series or Layer 3 Enterprise Services for the Cisco Nexus 5000 Series, do not have a grace period.
Devices with dual supervisors have the following additional high-availability features:
License Installation
Obtaining a Factory-Installed License
Procedure
Step 1 Contact your reseller or Cisco representative and request this service.
Note If you purchased Cisco support through a Cisco reseller, contact the reseller directly. If you purchased support directly from Cisco, contact Cisco Technical Support at this URL: http://www.cisco.com/en/US/support/tsd_cisco_worldwide_contacts.html
Your device is shipped with the required licenses installed in the system.
Step 2 Start using the device and the licensed features.
Performing a Manual Installation
If you have existing devices or if you wish to install the licenses on your own, you must first obtain the license key file and then install that file in the device.
NoteAll licenses for the Cisco Nexus 5000 Series and the Cisco Nexus 4000 Series are factory-installed. Manual installation is not required.
Obtaining the License Key File
Procedure
Command or Action Purpose
Step 1 Obtain the serial number for your device by entering the show license host-id command. The host ID is also referred to as the device serial number.
Tip Use the entire ID that appears after the equal sign (=). In this example, the host ID is FOX064317SQ.
Step 2 Obtain your claim software license certificate document. If you cannot locate your software license claim certificate, contact Cisco Technical Support at this URL: http://www.cisco.com/en/US/support/tsd_cisco_worldwide_contacts.html Step 3 Locate the product authorization key (PAK) from the software license claim certificate document. Step 4 Locate the website URL from the software license claim certificate document. You can access the Product License Registration website from this URL: https://tools.cisco.com/SWIFT/LicensingUI/Home Step 5 Follow the instructions on the Product License Registration website to register the license for your device. The license key file is sent to you by e-mail and is digitally signed to only authorize use on the requested device. The requested features are also enabled once the Cisco NX-OS software on the specified device accesses the license key file.
Caution Do not make any modifications to the license key file. It will alter the digital signature and render the license invalid.
A license is permanent. If you do not have a license, the grace period for using a feature starts from the first time you start using a feature offered by a license.
Note Cisco TrustSec for the Cisco Nexus 7000 Series and Layer 3 Enterprise for the Cisco Nexus 5000 Series do not have a grace period. You must obtain an Advanced Services license to use Cisco TrustSec.
Step 6 For the Cisco Nexus 7000 Series, use the copy licenses command from the default VDC to save your license file to one of four locations—the bootflash: directory, the slot0: device, the usb1: device, or the usb2: device. For all other platforms, use the copy licenses command to save your license file to one of two locations—the bootflash: directory or the volatile: directory.
Note Only users with the network-admin role can copy licenses on Cisco NX-OS devices. For information on user accounts and roles, see the Security Configuration Guide for your platform.
Installing the License Key File
ProcedureYou can install the license to enable features on your device.
Tip
If you need to install multiple licenses in any device, be sure to provide unique filenames for each license key file.
Note
If you have a single supervisor module on your Cisco NX-OS device and you replace the supervisor module, you must reinstall the license key file.
If you are currently running with a grace period license, to avoid service disruptions when you install your permanent license, do not disable the grace period by using the no license grace-period command. Instead, just install your new license. The license manager will automatically transition from grace licensing to the installed license.
Backing Up Licenses
If the configuration or bootflash memory on your device becomes corrupted, you might need to reinstall your license. You can do a reinstallation from a backed up copy of the license key file. If you do not have a license key file, you can create a copy of the license key file from your installed license.
Note
If you have a single supervisor module on your Cisco NX-OS device and you replace the supervisor module, you must reinstall the license key file. You cannot reinstall the license key file from the backed-up copy.
Caution
If you erase any existing licenses installed on your device, you can only reinstall them by using the install license command using the license key file.
Backing Up the License Key File
You can back up your license key file to a remote server or to an external device by using the copy command.
This example shows how to save a license key file to a remote server:
switch# copy bootflash:license_file.lic tftp://10.10.1.1//license_file.licSome Cisco NX-OS platforms support external flash devices. This example shows how to save a license key file to an external Flash device:
switch# copy bootflash:license_file.lic slot0:license_file.licBacking Up an Installed License
You can back up your license key file to a remote server or to an external device by using the copy command.
This example saves all licenses installed on your device to a .tar file and copies it to a remote UNIX-based server:
switch# copy licenses bootflash:Enterprise.tar Backing up license done switch# copy bootflash:lEnterprise.tar tftp://10.10.1.1//Enterprise.tarYou can uncompress the .tar file on the remote UNIX-based server to create one or more backup license key files, depending on how many licenses you have installed. You can also extract the license files on your Cisco NX-OS device by using the tar extract command.
This example shows how to extract license files from a .tar file:
switch# tar extract bootflash:Enterprise.tarUninstalling Licenses
ProcedureYou can only uninstall a permanent license that is not in use. If you try to delete a permanent license that is currently being used, the software rejects the request and issues an error message. Uninstalling an unused license causes the grace period to come into effect. The grace period is counted from the first use of the feature without a license and is reset when a valid license file is installed.
Note
Permanent licenses cannot be uninstalled if they are currently being used. Features turned on by permanent licenses must first be disabled, before that license is uninstalled.
Tip
If you are using an evaluation license and would like to install a new permanent license, you can do so without service disruption and before the evaluation license expires. Removing an evaluation license immediately triggers a grace period without service disruption.
Caution
You must disable the features that are related to the feature before uninstalling a license. The delete procedure fails if the license is in use.
Step 1 Save your running configuration to a remote server by using the copy command. switch# copy running-config tftp://server/path/filenameStep 2 Display a list of all installed license key files and identify the file to be uninstalled by using the show license brief command. In this example, the file to be uninstalled is the Enterprise.lic file. Step 3 Disable the features provided by the license to be uninstalled. Use the show license usage package_name command to view the enabled features for a specified package. Step 4 Uninstall the Enterprise.lic file by using the clear license filename command, where filename is the name of the installed license key file. switch# clear license Enterprise.lic Clearing license Enterprise.lic: SERVER this_host ANY VENDOR ciscoStep 5 Continue uninstalling the license by entering y for yes. Do you want to continue? (y/n) y Clearing license ..doneThe Enterprise.lic license key file is now uninstalled.
Updating Licenses
ProcedureIf your license is time bound, you must obtain and install an updated license. Contact technical support to request an updated license.
Note
If you purchased Cisco support through a Cisco reseller, contact the reseller directly. If you purchased support directly from Cisco, contact Cisco Technical Support at this URL: http://www.cisco.com/en/US/support/tsd_cisco_worldwide_contacts.html
Step 1 Obtain the updated license file. Step 2 Save your running configuration to a remote server by using the copy command. Step 3 Verify the name of the file to be updated by using the show license brief command. switch# show license brief Enterprise.licStep 4 Update the license file by using the update license url command, where url specifies the bootflash:, slot0:, usb1:, or usb2: location of the updated license file. switch# update license bootflash:Enterprise1.lic Enterprise.licStep 5 Continue with the license update by entering y (yes is the default). Do you want to continue? (y/n) y Updating license ..done switch#The Enterprise.lic license key file is now updated.
Related Tasks
Configuring the Grace Period Feature
Grace Period Alerts
The Cisco NX-OS software gives you a 120-day grace period. This grace period starts or continues when you are evaluating a feature for which you have not installed a license.
The grace period stops if you disable a feature that you are evaluating, but if you enable that feature again without a valid license, the grace period countdown continues where it left off.
NoteWhen you install the permanent license, to avoid service disruptions, do not disable the grace period by using the no license grace-period command. Instead, just install your new license. The license manager will automatically transition from grace licensing to the installed license.
Once the license manager is using your installed license, the grace period alerts will cease.
The grace period operates across all features in a license package. License packages can contain several features. If you disable a feature during the grace period and there are other features in that license package that are still enabled, the countdown does not stop for that license package. To suspend the grace period countdown for a license package, you must disable every feature in that license package.
The Cisco NX-OS license counter keeps track of all licenses on a device. If you are evaluating a feature and the grace period has started, you will receive console messages, SNMP traps, system messages, and Call Home messages on a daily basis. The frequency of these messages become hourly during the last seven days of the grace period.
In addition to the grace period alerts, Cisco NX-OS will display a banner at login in the last 15 days of the grace period:
NOTICE: NX-OS LICENSED FEATURES NEED ATTENTION ----------------------------------------------------------------------------- Feature Ins Lic Status Expiry Date Comments Count ----------------------------------------------------------------------------- LAN_ENTERPRISE_SERVICES_PKG No - In use Grace 14D 6H ----------------------------------------------------------------------------- **** WARNING: License(s) about to expire. When license(s) expire, all licensed conditional features will be disabled ****During the last seven days of the grace period, the banner will include a prompt which you must dismiss before you can complete login:
NOTICE: NX-OS LICENSED FEATURES NEED ATTENTION ----------------------------------------------------------------------------- Feature Ins Lic Status Expiry Date Comments Count ----------------------------------------------------------------------------- LAN_ENTERPRISE_SERVICES_PKG No - In use Grace 3D 23H ----------------------------------------------------------------------------- **** WARNING: License(s) about to expire. When license(s) expire, all licensed conditional features will be disabled **** CISCO TAC must be contacted asap for required licenses to prevent imminent downtime/service disruption. Please press Enter to confirm you understand this risk and wish to continue: [ENTER]For example, if you enabled a licensed feature on January 30, you will receive grace period ending messages as follows:
- Daily alerts from January 30 to May 21. Starting from May 15, Cisco NX-OS would display the banner at login.
- Hourly alerts from May 22 to May 30. The login banner would require you to dismiss its prompt before you can complete login.
On May 31, the grace period ends, and the licensed feature is automatically disabled. You will not be allowed to use the licensed feature until you purchase a valid license.
Note
You cannot modify the frequency of the grace period messages.
Caution
After the final seven days of the grace period, the feature is turned off and your network traffic may be disrupted. Any future upgrade to Cisco NX-OS will enforce license requirements and the 120-day grace period.
Use the show license usage command to display grace period information for a device.
Enabling the License Grace Period
Enable the grace period feature by using the license grace-period command:
switch# configure terminal switch(config)# license grace-period.
You might have to enable a licensed feature to configure it. To enable a licensed feature, use the feature feature-name command in global configuration mode. For example, you can enable the BGP feature as follows:
switch# configure terminal switch(config)# feature bgpDisabling the License Grace Period
ProcedureTo disable the grace period, you must disable all features that use the license grace period. Otherwise, the Cisco NX-OS software rejects the request and issues an error message.
NoteTo avoid service disruptions, you should not disable the grace period before you install a permanent license.
Step 1 Display the licenses using the grace period by using the show license usage command. . switch# show license usage Feature Ins Lic Status Expiry Date Comments Count -------------------------------------------------------------------------------- LAN_ADVANCED_SERVICES_PKG Yes - In use Never - LAN_ENTERPRISE_SERVICES_PKG No - In use Grace 119D 22H --------------------------------------------------------------------------------Step 2 Disable the features provided by the license using the grace period. Display the enabled features for a specified package by using the show license usage package_name command. . Step 3 Disable the grace period. switch# configure terminal switch(config)# no license grace-period
Associating a License with a Module
License Transfers Between Devices
A license is specific to the physical device for which it is issued and is not valid on any other physical device. If you need to transfer a license from one physical device to another, contact your customer service representative.
NoteIf you have a single supervisor module on your Cisco NX-OS device and you replace the supervisor module, you must reinstall the license key file.
If you are evaluating a license when you replace the supervisor module, the grace period of the license is usually set to 120 days. On a dual supervisor system, the grace period of the license will be overwritten from the existing active supervisor module to the new stand-by supervisor module.
Note
If you purchased Cisco support through a Cisco reseller, contact the reseller directly. If you purchased support directly from Cisco, contact Cisco Technical Support at this URL: http://www.cisco.com/en/US/support/tsd_cisco_worldwide_contacts.html
Verifying the License Configuration
To display the license configuration information, perform one of the following tasks:
Command
Purpose
show license [brief]
Displays information for all installed license files.
show license feature package mapping
Displays information about features available in installed license packages.
show license file
Displays information for a specific license file.
show license host-id
Displays the host ID for the physical device.
show license usage
Displays the usage information for installed licenses.
For detailed information about the fields in the output from these commands, see the for your platform.
Additional References
Table 8 Applicable MIBs MIBs
MIBs Link
To locate and download MIBs, go to the following URL:
http://www.cisco.com/public/sw-center/netmgmt/cmtk/mibs.shtml
Feature History for Licensing
This table lists the release history for this feature.
Table 9 Feature History for LicensingFeature Name
Release
Feature Information
All licenses
Cisco Nexus 6000 Switch NX-OS Release 6.0(2)N1(1)
Added all licenses for the new Cisco Nexus 6000 Series platform.
Layer 3 Base Services Package
Cisco Nexus 3548 Switch NX-OS Release 5.0(3)A1(1)
Added the Cisco Nexus 3548 Layer 3 Base License.
Layer 3 Enterprise Services Package
Cisco Nexus 3548 Switch NX-OS Release 5.0(3)A1(1)
Added the Cisco Nexus 3548 Layer 3 Enterprise License.
Static NAT, Warp Mode, Warp SPAN
Cisco Nexus 3548 Switch NX-OS Release 5.0(3)A1(1)
Added the new 3500 Algo Boost License.
N7K-C7004-XL license
Cisco Nexus 7000 Series NX-OS Release 6.1(2)
Added the Cisco Nexus 7004 Scalable Feature License.
VDC and FCoE F2 Series
Cisco Nexus 7000 Series NX-OS Release 6.1(1)
Added licenses for VDCs and FCoE on F2 Series modules.
Removed Cisco TrustSec from the Advanced Services Package.
MPLS, LISP, and FCoE
Cisco Nexus 7000 Series NX-OS Release 5.2(1)
Added licenses for the MPLS, LISP, and FCoE features.
Grace period
Cisco Nexus 7000 Series NX-OS Release 4.2(1)
Automatic checkpoints are created for configured licensed features when the grace period expires.
