In a disconnected environment without internet access, NGINX Plus sends usage data to NGINX Instance Manager. You’ll need to download the usage report from NGINX Instance Manager and submit it to F5 from a location with internet access. After F5 verifies the report, you can download the acknowledgement, which you must upload back to NGINX Instance Manager.

Before submitting usage data to F5, first configure NGINX Plus to report telemetry data to NGINX Instance Manager.

To configure NGINX Plus (R33 and later) to report usage data to NGINX Instance Manager:

{{< include "licensing-and-reporting/configure-nginx-plus-report-to-nim.md" >}}

{{< call-out "tip" "Using the REST API" "" >}}{{< include "nim/how-to-access-nim-api.md" >}}{{}}

{{}}

{{%tab name="bash script (recommended)"%}}

To submit a usage report in a disconnected environment, use the provided license_usage_offline.sh script. Run this script on a system that can access NGINX Instance Manager and connect to https://product.apis.f5.com/ on port 443. Replace each placeholder with your specific values.

1. {{<fa "download">}}Download license_usage_offline.sh.

2. Run the following command to allow the script to run:

   chmod +x <path-to-script>/license_usage_offline.sh

3. Run the script. Replace each placeholder with your specific values:

   ./license_usage_offline.sh \
     -j <license-filename>.jwt \
     -i <NIM-IP-address> \
     -u admin \
     -p <password> \
     -o report.zip \
     -s telemetry

   This command downloads the usage report (report.zip), submits the report to F5 for acknowledgment, and uploads the acknowledgment back to NGINX Instance Manager.

{{< include "nim/disconnected/license-usage-offline-script.md" >}}

{{%/tab%}}

{{%tab name="REST"%}}

To submit a usage report using curl, complete each of the following steps in order.

Run these curl commands on a system that can access NGINX Instance Manager and connect to https://product.apis.f5.com/ on port 443. Replace each placeholder with your specific values.

{{}}The -k flag skips SSL certificate validation. Use this only if your NGINX Instance Manager is using a self-signed certificate or if the certificate is not trusted by your system.{{}}

1. Prepare the usage report:

   curl -k --location 'https://<NIM-FQDN>/api/platform/v1/report/download?format=zip&reportType=telemetry&telemetryAction=prepare' \
   --header 'accept: application/json' \
   --header 'authorization: Basic <base64-encoded-credentials>' \
   --header 'referer: https://<NIM-FQDN>/ui/settings/license'

2. Download the usage report from NGINX Instance Manager:

   curl -k --location 'https://<NIM-FQDN>/api/platform/v1/report/download?format=zip&reportType=telemetry&telemetryAction=download' \
   --header 'accept: */*' \
   --header 'authorization: Basic <base64-encoded-credentials>' \
   --output report.zip

3. Submit the usage report to F5 for verification:

   curl --location 'https://product.apis.f5.com/ee/v1/entitlements/telemetry/bulk' \
   --header "Authorization: Bearer $(cat /path/to/jwt-file)" \
   --form 'file=@"<path-to-report>.zip"'

   After running this command, look for the "statusLink" in the response. The report-id is the last part of the "statusLink" value (the UUID). For example:

   {"statusLink":"/status/2214e480-3401-43a3-a54c-9dc501a01f83"}

   In this example, the report-id is 2214e480-3401-43a3-a54c-9dc501a01f83.

   You’ll need to use your specific report-id in the following steps.

4. Check the status of the usage acknowledgement:

   Replace <report-id> with your specific ID from the previous response.

   curl --location 'https://product.apis.f5.com/ee/v1/entitlements/telemetry/bulk/status/<report-id>' \
   --header "Authorization: Bearer $(cat /path/to/jwt-file)"

5. Download the usage acknowledgement from F5:

   curl --location 'https://product.apis.f5.com/ee/v1/entitlements/telemetry/bulk/download/<report-id>' \
   --header "Authorization: Bearer $(cat /path/to/jwt-file)" \
   --output <path-to-acknowledgement>.zip

6. Upload the usage acknowledgement to NGINX Instance Manager:

   curl -k --location 'https://<NIM-FQDN>/api/platform/v1/report/upload' \
   --header 'Authorization: Basic <base64-encoded-credentials>' \
   --form 'file=@"<path-to-acknowledgement>.zip"'

{{%/tab%}}

{{%tab name="Web interface"%}}

Download the usage report to send to F5:

• On the License > Overview page, select Download License Report.

You need to submit the usage report to F5 and download the acknowledgment over REST. To do do, follow steps 3–5 in the REST tab in this section.

To upload the the usage acknowledgement:

1. On the License > Overview page, select Upload Usage Acknowledgement.
2. Upload the acknowledgement by selecting Browse or dragging the file into the form.
3. Select Add.

{{%/tab%}}

{{}}

{{< include "licensing-and-reporting/reported-usage-data.md" >}}

{{< include "licensing-and-reporting/log-location-and-monitoring.md" >}}