License NGINX Controller

Follow these steps to license your NGINX Controller

Overview

This topic explains how to upload and manage licenses for NGINX Controller.

 


License Types

NGINX Controller licenses can be either connected or disconnected licenses:

  • A connected license sends telemetry data to F5, which enables pricing based on usage. When adding a connected license, you must provide a customer Association Token, which you can get from the MyF5 Customer Portal.
  • A disconnected license doesn’t send telemetry data to F5. To add a disconnected license, you can upload the license file using the NGINX Controller web interface or the NGINX Controller API.

 


Get Your License

To access your license, get your Customer Access Token, or sign up for a trial license, visit the MyF5 Customer Portal.

 


Add or Update a License

To add or update a license for NGINX Controller, take the following steps:

  1. Go to https://<Controller-FQDN>/platform/license.

  2. In the Upload a license section of the page, select an upload option:

    • Upload license file – Locate and select your license file in the file explorer.
    • Paste your Association Token or license file – Paste your customer Association Token or the contents of your NGINX Controller license file. These are available on the MyF5 Customer Portal.
  3. Select Save license.

See Also:
To add a license using the NGINX Controller REST API, send a PUT request to the /platform/license endpoint. Provide your CAT or NGINX Controller license as a base64-encoded string in the JSON request body.

 


View License Details

To view the details for your NGINX Controller license, take the following steps:

  1. On the NGINX Controller menu, select Platform > License > Controller License.
  2. On the Licenses page, you can view the details for the applied licenses, including license limitations, status, and the expiration date.
See Also:
To view the details for your license(s) using the NGINX Controller REST API, send a GET request to the /platform/license endpoint.

 


Delete a License

To delete a license using the NGINX Controller REST API, send a DELETE request to the /platform/license endpoint.

 


License Features

  • When you license NGINX Controller, you have full access to all of the features included in the license.

  • If you haven’t licensed NGINX Controller, or if your license has expired, you can still access the following restricted set of features using the NGINX Controller REST API:

    • Log in and out of NGINX Controller
    • Manage licenses
    • Manage users
    • Manage user groups
    • Manage roles
    • Manage integration accounts
    • Manage support bundles
    • Manage backups
    • View alerts

 


Licensing FAQs

How is a Workload Defined for Licensing Purposes?

Workloads are backend or upstream objects to NGINX Controller that receive traffic, such as applications and containers. Workloads are quantified for licensing purposes using a combination of location and server specifics (for example, unique IP address or unique instance ID).

How is Aggregate Data Defined for Licensing Purposes?

Aggregate data is represented by the total volume of bytes in/out per hour for all of the data planes managed by NGINX Controller.

How Do I Ensure My License for NGINX Controller Is Compliant?

To verify your license is compliant, check for the following:

  • Make sure your usage is within the capacity that your license allows. Refer to the View License Details section for instructions.

  • Ensure your license has not expired.

  • If you are using an Association Token, make sure to allow incoming and outgoing connections on port 443 TCP. If you’re running NGINX Controller v3.15 or earlier, also enable incoming and outgoing connections on port 8883 TCP. These ports are used for validating the entitlements for your license. Refer to the NGINX Controller Technical Specifications Guide for these and other firewall requirements.

 


Troubleshoot Licensing Issues

If NGINX Controller appears to be unlicensed after a version upgrade, try the following options to resolve the issue.

 


What’s Next

​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​ ​

This documentation applies to the following versions of NGINX Controller: 3.0, 3.1, 3.2, 3.3, 3.3, 3.4, 3.5, 3.6, 3.7, 3.8, 3.9, 3.10, 3.12, 3.13, 3.14, 3.15, 3.16.1, 3.17 and 3.18.