enable license

enable license {software} [key ]

Description

Enables software license or feature pack that allows you to use advanced features.

Syntax Description

software Applies base license.
key Specifies your hexadecimal license key in format xxxx-xxxx-xxxx-xxxx-xxxx (10 hex digits) or xxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx (14 hex digits).

Default

N/A.

Usage Guidelines

The software license levels that apply to ExtremeXOS software are described in the Switch Engine 32.3 Feature License Requirements document.

To obtain a software license, specify the key in the format xxxx-xxxx-xxxx-xxxx-xxxx.

You obtain the software license key (or feature pack key) either by ordering it from the factory or by obtaining a license voucher from your Extreme Networks supplier. You can obtain a regular software license or a trial software license, which allows you use of the license for either 30, 60 or 90 days; you cannot downgrade software licenses.

The voucher contains all the necessary information on the software license, whether regular or trial, and number of days for trial software license.

After you enable the software license or feature pack by entering the software key, the system returns a message that you either successfully or unsuccessfully set the license.

Once you enable the software license (or if you do not use the correct key, attempt to downgrade the license, or already installed the software license) you see one of the following messages:

 Enabled license successfully. Error: Unable to set license using supplied key. Error: Unable to set license - downgrade of licenses is not supported. Error: Unable to set license - license is already enabled. Error: Unable to set license - trial license already enabled. 

If you enable a trial license, the system generates a daily message showing the number of days until expiry.

If you attempt to execute a command and you do not either have the required software license or have reached the limits defined by the current software license level, the system returns one of the following messages:

 Error: This command cannot be executed at the current license level. Error: You have reached the maximum limit for this feature at this license level. 

If you attempt to execute a command and you do not have the required feature pack, the system also returns a message.

To protect against attacks to install maliciously created license keys, the system has an exponential delay of each failed attempt to install a license.

To view the type of software license you are currently running on the switch, use the show licenses command. The license key number is not displayed, but the type of software license is displayed in the show licenses output. This command can be run on any node in a SummitStack, regardless of its node role (master, standby, or backup).

Messages for different scenarios:
  • Key format is incorrect:
    "Error: Incorrect key format."
  • Attempted to apply Switch Port Speed License to another switch model:
    Error: Unable to set license - platform incompatible with license.
  • Attempted to apply Switch Port Speed License beyond number of ports available on switch:
    Error: Unable to set license - platform only supports ports in range 1 to <max for platform>. 
  • EEPROM Read/Write failure for Switch Port Speed License:
    Error: Unable to set license. Read from EEPROM failed. 
  • Attempted to apply Switch Port Speed License when it is already applied:
    Error: Unable to set license - license is already enabled. 
  • Attempted to apply Switch Port Speed License license for fewer ports groups than is currently enabled. You cannot downgrade the license this way. However, you can remove the license using the clear license command, and then apply a license enabling fewer port groups:
    Error: Unable to set license - downgrade of port speed license not supported. <num_ports> ports already licensed. Current license can be cleared via 'clear license-info port-speed'.
  • EEPROM Read/Write failure for Switch Port Speed License:
    Error: Unable to set license - write to EEPROM failed. 

Example

The following command enables a software license on the switch:

enable license 2d5e-0e84-e87d-c3fe-bfff
Warning: A reboot switch or disable and enable slot 3 is required before the new license takes effect.

History

This command was first available in ExtremeXOS 11.1.

The software parameter was added in ExtremeXOS 11.6.

The capacity-key variable was added in ExtremeXOS 15.4.

The capacity-key variable was removed in ExtremeXOS 22.2.

Platform Availability

This command is available on ExtremeSwitching 5320, 5420, 5520, and 5720 series switches.