Retrieve firmware and licensing information for a Citrix ADC VPX Appliance¶

Citrix supports NITRO REST APIs for retrieving firmware and licensing information for a Citrix ADC appliance. The firmware information includes the version and build number of the firmware running on the appliance. The licensing information includes the list of available ADC features, and the type and mode of the license used in the appliance.

Before you begin¶

Before you find firmware and licencing information for a Citrix ADC appliance, make sure that:

You have deployed a Citrix ADC VPX appliance and the appliance is UP and running in your setup. For more information, see Deploy a Citrix ADC VPX instance.
You have a basic understanding of Citrix ADC Licenses. For more information, see:
- Citrix ADC Licensing
- Manage Citrix ADC licenses using Citrix ADM

Retrieve firmware information for a Citrix ADC appliance¶

You use the _nsversion_NITRO API object to find information about the firmware running on a Citrix ADC appliance,.The Citrix ADC appliance responds with the version and build number of the firmware running on the appliance.

For more information about the _nsversion_object and its properties, see Citrix NITRO API reference for nsversion.

Request components¶

Request field	Value
HTTP Method	`GET`
URL	`http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/nsversion`
Request Headers	`Content-Type: application/json`

Curl request¶

curl -X GET -H "Content-Type: application/json" -u nsroot:examplepassword  http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/nsversion

Retrieve licensing information for a Citrix ADC appliance¶

You use the nslicense NITRO API object to find information about the licenses on a Citrix ADC appliance.

The Citrix ADC appliance responds with the following information:

List of ADC features available (marked as true) or not (marked as false) in the appliance
modelid. This attribute represents different numbers for two types of licenses.
- Bandwidth licenses. Specifies the throughput bandwidth licensed for this appliance. For example, for 20 Gbps, modelid: 20000
- vCPU licenses. Specifies number of vCPUs licensed for this appliance. For example, for 4 vCPU, modelid: 4 vCPUs
licensingmode. Thisattribute represents the mode of the license for this appliance:
- Local
- Pooled
- CICO
- EXPRESS
- CPU
- CPU-Local

For more information about the nslicense object and its properties, see Citrix NITRO API reference for nslicense.

Request components¶

Request field	Value
HTTP Method	`GET`
URL	`http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/nslicense` or `http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/nslicense?attrs=modelid,licensingmode`
Request Headers	`Content-Type: application/json`

Curl request¶

Use the following curl command syntax to find detailed licensing information for a Citrix ADC appliance:

curl -X GET -H "Content-Type: application/json" -u <username>:<examplepassword>  http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/nslicense

Use the following curl command syntax to find licensing information limited to modelid and licensing mode attributes:

curl -X GET -H "Content-Type: application/json" -u nsroot:examplepassword  http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/nslicense?attrs=modelid,licensingmode