Manage Gateway Licenses

The Manage Gateway Licenses task is used to install or remove a license file for the gateway.
gateway94
The Manage Gateway Licenses task is used to install or remove a license file for the
Layer7 API Gateway
.
If you subscribe to the
Layer7 API Gateway
under a Portfolio License Agreement (PLA), you are required to configure telemetry settings. To learn how, see Product Licensing and Telemetry.
A signed XML license file comes with every
Layer7 API Gateway
. This license file unlocks specific
Layer7 API Gateway
features for a predetermined period. In license-enabled mode, the
Layer7 API Gateway
processes incoming service messages, provides ancillary services such as WSDL and policy discovery, and provides full administrative services to any connected Policy Manager. If a license is not installed or is expired, then most Policy Manager features will be disabled until a valid license is installed
A Primary license is required for any functionality to be enabled. You will be prompted to install a Primary license the first time the Policy Manager is used to connect to a
Layer7 API Gateway
or cluster. Once the Primary license is installed, you can install additional license files to activate new functionality at any time.
The
Layer7 API Gateway
is able to maintain multiple licenses. Use the Manage Gateway Licenses dialog box to install, remove, or view details of a license.
New
Layer7 API Gateway
s may have had their licenses auto-provisioned already. This means you will not need to install the license using the Manage Gateway Licenses dialog box. To confirm the details of your auto-provisioned license, click
View Details
on the Manage Gateway Licenses dialog. For more information, see Auto-Provision a Gateway.
To manage
Layer7 API Gateway
licenses
:
  1. Ensure that you are connected to a
    Layer7 API Gateway
    .
  2. In the Policy Manager, select [
    Help
    ] >
    Manage Gateway Licenses
    .
    The table of licenses appear on the Manage Gateway Licenses dialog.
  3. Install or remove a license as required.
  4. Click [
    Close
    ] when done.
Install a License File
You must install a license file in order to unlock the
Layer7 API Gateway
.
There are two types of licenses:
  1. Primary:
    Unlocks the base functionality of the
    Layer7 API Gateway
    . This license was supplied when the product suite was first purchased.
  2. Feature:
    Unlocks additional features that are purchased at a later date.
You are automatically prompted for a license file the first time the Policy Manager is connected to a
Layer7 API Gateway
or cluster. You can also update this license file at any time (for example, to replace an expired license or install a new license that unlocks different features).
These are common scenarios of installing a license.
(1) If the
Layer7 API Gateway
Primary license was auto-provisioned, you do not need to manually install it again. For more information, see Auto-Provision a Gateway. (2) Save any open policy before proceeding.
To install a Primary license for the first time
:
  1. Connect to the
    Layer7 API Gateway
    .
  2. The Gateway License warning dialog appears automatically when no license is present.
  3. Click [
    Install License
    ] in the Manage Gateway Licenses dialog. The file selection dialog appears.
  4. Select a valid license file from the file selection dialog and click [
    Open
    ].
  5. Click [
    I Agree
    ] to accept the license agreement.
To install an additional license
:
  1. Connect to the
    Layer7 API Gateway
    .
  2. From the Main Menu, select [
    Help
    ] >
    Manage Gateway Licenses
    . The Manage Gateway License dialog appears.
  3. Click [
    Install License
    ] in the
    Manage Gateway Licenses
    dialog. The file selection dialog appears.
  4. Click [
    I Agree
    ] to accept the license agreement.
To replace a license that has expired
:
  1. From the Main Menu, select [
    Help
    ] >
    Manage Gateway Licenses
    . The Manage Gateway License dialog appears.
  2. Select the expired license from the list of installed licenses.
  3. Click [
    Remove License
    ].
  4. Click [
    Yes
    ] in the Gateway License warning dialog to view the license manager.
  5. Click [
    Install License
    ] in the Manage Gateway Licenses dialog. The file selection dialog appears.
  6. Select a valid license file and click [
    Open
    ].
  7. Click [
    I Agree
    ] to accept the license agreement.
When a license is about to expire, you only need to install the newer version.
FIPS Compliancy
When installing a license that enforces the use of FIPS-compliant cryptographic algorithms, the enforcement takes effect after you restart the
Layer7 API Gateway
.
When a FIPS-compliant license is installed, it overrides the
security.fips.enabled
cluster property.
Remove a License File
You can remove a license by using the Manage Gateway License task.
WARNING:
Removing a license file is irreversible. It will disable all functionality that the license file allows. Be sure that you have a suitable replacement license prior to removing the license file.
To remove a license:
  1. Connect to the
    Layer7 API Gateway
    or cluster using Administrator credentials.
  2. From the Main Menu, select [
    Help
    ] >
    Manage Gateway Licenses
    . The Manage Gateway License dialog appears.
  3. Select a license from the list of installed licenses.
  4. Click [
    Remove License
    ].
  5. Select the check box and then click [
    OK
    ]. Due to the irrevocable nature of this action, you must select the check box first to enable the [
    OK
    ] button.
  6. Once you remove a license and close the Manage Gateway Licenses dialog, the Policy Manager will automatically disconnect from the
    Layer7 API Gateway
    .
If you have any unsaved policy changes, you will be prompted to export your policies. Click [
Save Policy
] to export to a file, or click [
Discard Policy
] to continue without exporting.
If you export to a file, you can import the policy back into the Policy Manager after re-licensing.