Skip to main content

License management

Install a new license​

The current system leverages an “offline” process, meaning that you need to activate a new license and add it to the appliance. For this, a 3-step process is required, it is described in this section.

Get the license request file​

The License Request File (LRF) is used on the Anapaya portal to generate a license. The LRF can be retrieved either via the Anapaya CONSOLE, or via the appliance CLI as described below.

  1. Click on Appliances in the left menu.
  2. Select the appliance, for which you want a license request file.
  3. Click on the Software button.
  4. Click on the Get License Request button.

Associate the LRF with the subscription in the Anapaya portal​

info

In case you purchased the license through a reseller, please contact them for assistance with this step.

To associate the LRF with the corresponding subscription in the Anapaya portal, follow the steps below:

note

This step requires that a subscription has been ordered beforehand in the Anapaya portal.

  1. Connect to the Anapaya portal with a user granted with the Activate licenses permission.

  2. Go to the SERVICE INVENTORY module and select the List of the ICs menu.

  3. Select the relevant Individual Contract (IC) from the list.

    Service Inventory
    note

    Check the “Status” filter to make sure you can see all the relevant ICs.

  4. Upload the LRF file by clicking the Upload LRF and Generate License icon on the right and check the parameters.

    Upload LRF

  5. Submit the LRF by clicking Activate and generate license. Activate and generate license

  6. Retrieve the signed license and store it for the next steps, by clicking the Copy license button.

    Copy license

Upload the signed license​

Use the Anapaya CONSOLE or the appliance CLI to upload the signed license to the appliance.

  1. Click on Appliances in the left menu.
  2. Select the appliance, for which you want to add a license.
  3. Click on the Software button.
  4. Click on the Add License button.

Check the license status​

To check the status of the license on the appliance, either use the Anapaya CONSOLE or the appliance CLI as described below.

  1. Click on Appliances in the left menu.
  2. Select the appliance, for which you want to check the license status.
  3. Click on the Software button.
  4. The license status is shown in the Installed License field.

Furthermore, you can check the status of the license in the Anapaya portal under the module Service inventory.

The status contains information about the license lifecycle, the product type and the product tier.

Install a renewed license​

Depending on the license terms, it should be renewed periodically. To do this, you do not need to upload the LRF again; simply copy the automatically renewed license from the portal and upload it to the appliance. You can renew licenses in advance, as they are marked as active 25 days before their actual activation date.

Retrieve the renewed license in the Anapaya portal​

  1. Connect to the Anapaya portal with a user granted with the Activate licenses permission.

  2. Go to the SERVICE INVENTORY module and select the List of the ICs menu.

  3. Select the relevant Individual Contract from the list.

    Service Inventory

  4. Find the latest license in the “History” section, check the parameters and retrieve the renewed license by clicking the View & copy license icon on the right. Service Inventory History

  5. Copy the license and store it for the next step by clicking the Copy license button.

    Copy license

Upload the signed license​

Use the Anapaya CONSOLE or the appliance CLI to upload the signed license to the appliance.

  1. Click on Appliances in the left menu.
  2. Select the appliance, for which you want to add a license.
  3. Click on the Software button.
  4. Click on the Add License button.

Multiple licenses on the same Anapaya appliance​

Multiple licenses can be installed on the same appliance. The system prioritizes valid licenses first by the number of features they enable, in descending order, and then by the expiry date. Licenses are never combined, meaning that only one license at the time is active.

List all installed licenses:

appliance-cli get software/licenses

Check which license is currently active:

appliance-cli info license
appliance-cli get software/licenses/status

If the wrong license is active, you need to remove it:

potential of restricted functionality

Removing the active license may result in restricted-functionality mode.

appliance-cli delete software/licenses/$license_id

Troubleshooting​

This section provides some initial steps to troubleshoot issues with the license management system.

Common issues​

Appliance-level issues​

If you encounter any issues when interacting with the appliance, please check the logs of the appliance-controller:

journalctl -eu appliance-controller.service

If you’re not able to resolve the problem, please contact the Anapaya support team.

Portal-level issues​

In this case, please contact the Anapaya portal team.

Required information

When contacting support, please provide as much information as possible:

  • The precise description of the issue and the potential error messages.
  • The output of the appliance-controller logs for the given time frame.
  • Any additional information that might be relevant (LRF, license file, etc.).
  • The subscription identifier (IC) from the Anapaya portal.

Helpful commands​

You can refer to Management API specification for the complete list of software-license endpoints to interact with the licenses on the system. Here are some useful appliance-cli commands to check the API endpoints:

  • Check the status of the licensing system:

    appliance-cli info license
    appliance-cli get software/licenses/status

  • List licenses:

    appliance-cli get software/licenses

  • Add license:

    appliance-cli post software/licenses 'license: $license'

  • Get a specific license:

    appliance-cli get software/licenses/$license_id

  • Remove a license:

    Potential reduced functionality

    Removing licenses from the appliance is generally not required, and removing the active license may result in restricted-functionality mode.

    appliance-cli delete software/licenses/$license_id