CA API Gateway 9.1

9.4 9.1

Manage Gateway Licenses

A signed XML license file comes with every . This license file unlocks specific  features for a predetermined period. In license-enabled mode, the  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
gateway83
A signed XML license file comes with every
API Gateway
. This license file unlocks specific
API Gateway
 features for a predetermined period. In license-enabled mode, the
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
API Gateway
 or cluster. Once the Primary license is installed, you can install additional license files to activate new functionality at any time.
The
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
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, see View Details. For more information, see Auto-Provision a License.
To manage
API Gateway
 licenses
:
  1. Ensure that you are connected to a
    API Gateway
    .
  2. In the Policy Manager, select [
    Help
    ] >
    Manage Gateway Licenses
    .
    The table of licenses appear on the Manage Gateway Licenses dialog.
  3. Select a task to perform:
    To...
    Do this...
    Install a license
    1. Click [
      InstallLicenses
      ].
    2. Select a license file to install.
    3. Click [
      Open
      ].
    4. Review the License Agreement and then click [
      I agree
      ].
    For more information, see Install a License File.
    Remove a license
    1. Select a license to remove.
    2. Click [
      Remove Licenses
      ].
    3. Select the check box and then click [
      OK
      ].
    For more information, see Remove a License File.
    View Details
    1. Select a license to view.
    2. Click [
      View Details
      ] to see more information about the license. If you need to review the contents of the License Agreement, click [
      View EULA
      ].
  4. Click [
    Close
    ] when done.
Install a License File
You must install a license file in order to unlock the
API Gateway
.
There are two types of licenses:
  1. Primary: Unlocks the base functionality of the
    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
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.
If the
API Gateway
 Primary license was auto-provisioned, you do not need to install the license file as described below. For more information, see Auto-Provision a License.
To avoid possible data loss, save any policy changes prior to installing or removing a license.
To install a Primary license for the first time
:
  1. Connect to the
    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
    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.
Enforce FIPS Compliancy
If you are installing a license that enforces the use of FIPS-compliant cryptographic algorithms, you must restart the
API Gateway
 after installing the license for the enforcement to take effect.
 
When a FIPS-compliant license is installed, it will override the security.fips.enabled  cluster property.
 
Remove a License File
You can remove a license by using the Manage Gateway License task.
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
    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
    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. For more information, see Import a Policy.

Content feedback and comments