Skip to main content

License management

Install a license​

The current system leverages an “offline” process, meaning that you need to activate a 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. Get License Request

Associate the LRF with the subscription in the Anapaya portal​

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 “license activation” permission.

  2. Go to the Quotation/Ordering module and select the License Activation menu.

  3. Select the relevant subscription from the list and click on the pencil to take an action.

    Select subscription

    note

    If the license was already manually activated in the past (meaning the validity period of the license has already started), make sure to toggle “Show activated licenses” to see these licenses in the list.

  4. Upload the LRF file by click the Upload LRF button 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. Retrieve 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. Add license

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. License status

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.

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 ops@anapaya.net.

Portal-level issues​

In this case, please contact portal@anapaya.net.

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>