ADC NITRO APIs

nslicenseserverpool

May 23, 2024

Contributed by:

Configuration for licenseserver resource.

Properties

(click to see Operations )

Name	Permissions	Description
getalllicenses	Read-write	If this flag is used while doing getinventory, it displays all licenses from licenseserver.
instancetotal	Read-only	Instance Total.
instanceavailable	Read-only	Instance Available.
standardbandwidthtotal	Read-only	Standard Bandwidth Total.
standardbandwidthavailable	Read-only	Standard Bandwidth Available.
enterprisebandwidthtotal	Read-only	Enterprise Bandwidth Total.
enterprisebandwidthavailable	Read-only	Enterprise Bandwidth Available.
platinumbandwidthtotal	Read-only	Platinum Bandwidth Total.
platinumbandwidthavailable	Read-only	Platinum Bandwidth Available.
standardcputotal	Read-only	Standard CPU Total.
standardcpuavailable	Read-only	Standard CPU Available.
enterprisecputotal	Read-only	Enterprise CPU Total.
enterprisecpuavailable	Read-only	Enterprise CPU Available.
platinumcputotal	Read-only	Platinum CPU Total.
platinumcpuavailable	Read-only	Platinum CPU Available.
cpxinstancetotal	Read-only	CP1000 Instance Total.
cpxinstanceavailable	Read-only	CP1000 Instance Available.
vpx1stotal	Read-only	VPX1S Total.
vpx1savailable	Read-only	VPX1S Available.
vpx1ptotal	Read-only	VPX1P Total.
vpx1pavailable	Read-only	VPX1P Available.
vpx5stotal	Read-only	VPX5S Total.
vpx5savailable	Read-only	VPX5S Available.
vpx5ptotal	Read-only	VPX5P Total.
vpx5pavailable	Read-only	VPX5P Available.
vpx10stotal	Read-only	VPX10S Total.
vpx10savailable	Read-only	VPX10S Available.
vpx10etotal	Read-only	VPX10E Total.
vpx10eavailable	Read-only	VPX10E Available.
vpx10ptotal	Read-only	VPX10P Total.
vpx10pavailable	Read-only	VPX10P Available.
vpx25stotal	Read-only	VPX25S Total.
vpx25savailable	Read-only	VPX25S Available.
vpx25etotal	Read-only	VPX25E Total.
vpx25eavailable	Read-only	VPX25E Available.
vpx25ptotal	Read-only	VPX25P Total.
vpx25pavailable	Read-only	VPX25P Available.
vpx50stotal	Read-only	VPX50S Total.
vpx50savailable	Read-only	VPX50S Available.
vpx50etotal	Read-only	VPX50E Total.
vpx50eavailable	Read-only	VPX50E Available.
vpx50ptotal	Read-only	VPX50P Total.
vpx50pavailable	Read-only	VPX50P Available.
vpx100stotal	Read-only	VPX100S Total.
vpx100savailable	Read-only	VPX100S Available.
vpx100etotal	Read-only	VPX100E Total.
vpx100eavailable	Read-only	VPX100E Available.
vpx100ptotal	Read-only	VPX100P Total.
vpx100pavailable	Read-only	VPX100P Available.
vpx200stotal	Read-only	VPX200S Total.
vpx200savailable	Read-only	VPX200S Available.
vpx200etotal	Read-only	VPX200E Total.
vpx200eavailable	Read-only	VPX200E Available.
vpx200ptotal	Read-only	VPX200P Total.
vpx200pavailable	Read-only	VPX200P Available.
vpx500stotal	Read-only	VPX500S Total.
vpx500savailable	Read-only	VPX500S Available.
vpx500etotal	Read-only	VPX500E Total.
vpx500eavailable	Read-only	VPX500E Available.
vpx500ptotal	Read-only	VPX500P Total.
vpx500pavailable	Read-only	VPX500P Available.
vpx1000stotal	Read-only	VPX1000S Total.
vpx1000savailable	Read-only	VPX1000S Available.
vpx1000etotal	Read-only	VPX1000E Total.
vpx1000eavailable	Read-only	VPX1000E Available.
vpx1000ptotal	Read-only	VPX1000P Total.
vpx1000pavailable	Read-only	VPX1000P Available.
vpx2000ptotal	Read-only	VPX2000P Total.
vpx2000pavailable	Read-only	VPX2000P Available.
vpx3000stotal	Read-only	VPX3000S Total.
vpx3000savailable	Read-only	VPX3000S Available.
vpx3000etotal	Read-only	VPX3000E Total.
vpx3000eavailable	Read-only	VPX3000E Available.
vpx3000ptotal	Read-only	VPX3000P Total.
vpx3000pavailable	Read-only	VPX3000P Available.
vpx4000ptotal	Read-only	VPX4000P Total.
vpx4000pavailable	Read-only	VPX4000P Available.
vpx5000stotal	Read-only	VPX5000S Total.
vpx5000savailable	Read-only	VPX5000S Available.
vpx5000etotal	Read-only	VPX5000E Total.
vpx5000eavailable	Read-only	VPX5000E Available.
vpx5000ptotal	Read-only	VPX5000P Total.
vpx5000pavailable	Read-only	VPX5000P Available.
vpx8000stotal	Read-only	VPX8000S Total.
vpx8000savailable	Read-only	VPX8000S Available.
vpx8000etotal	Read-only	VPX8000E Total.
vpx8000eavailable	Read-only	VPX8000E Available.
vpx8000ptotal	Read-only	VPX8000P Total.
vpx8000pavailable	Read-only	VPX8000P Available.
vpx10000stotal	Read-only	VPX10000S Total.
vpx10000savailable	Read-only	VPX10000S Available.
vpx10000etotal	Read-only	VPX10000E Total.
vpx10000eavailable	Read-only	VPX10000E Available.
vpx10000ptotal	Read-only	VPX10000P Total.
vpx10000pavailable	Read-only	VPX10000P Available.
vpx15000stotal	Read-only	VPX15000S Total.
vpx15000savailable	Read-only	VPX15000S Available.
vpx15000etotal	Read-only	VPX15000E Total.
vpx15000eavailable	Read-only	VPX15000E Available.
vpx15000ptotal	Read-only	VPX15000P Total.
vpx15000pavailable	Read-only	VPX15000P Available.
vpx25000stotal	Read-only	VPX25000S Total.
vpx25000savailable	Read-only	VPX25000S Available.
vpx25000etotal	Read-only	VPX25000E Total.
vpx25000eavailable	Read-only	VPX25000E Available.
vpx25000ptotal	Read-only	VPX25000P Total.
vpx25000pavailable	Read-only	VPX25000P Available.
vpx40000stotal	Read-only	VPX40000S Total.
vpx40000savailable	Read-only	VPX40000S Available.
vpx40000etotal	Read-only	VPX40000E Total.
vpx40000eavailable	Read-only	VPX40000E Available.
vpx40000ptotal	Read-only	VPX40000P Total.
vpx40000pavailable	Read-only	VPX40000P Available.
vpx100000stotal	Read-only	VPX100000S Total.
vpx100000savailable	Read-only	VPX100000S Available.
vpx100000etotal	Read-only	VPX100000E Total.
vpx100000eavailable	Read-only	VPX100000E Available.
vpx100000ptotal	Read-only	VPX100000P Total.
vpx100000pavailable	Read-only	VPX100000P Available.
licensemode	Read-only	This paramter indicates type of license customer interested while configuring add/set licenseserver. Possible values = Pooled, VCPU, CICO, SelfManagedPool, SelfManagedvCPU

Operations

(click to see Properties )

GET (ALL)

Some options that you can use for each operations:

Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the 'warning' query parameter as 'yes'. For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

http:// <netscaler-ip-address> /nitro/v1/config/login?warning=yes

If any, the warnings are displayed in the response payload with the HTTP code '209 X-NITRO-WARNING'.
Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

To do this, you must specify the username and password in the request header of the NITRO request as follows:

X-NITRO-USER: <username>

X-NITRO-PASS: <password>

Note: In such cases, make sure that the request header DOES not include the following:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

*Note:* Mandatory parameters are marked in red and placeholder content is marked in green

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/nslicenseserverpool Query-parameters: args http:// <netscaler-ip-address> /nitro/v1/config/nslicenseserverpool? args=getalllicenses: <Boolean_value>

Use this query-parameter to get nslicenseserverpool resources based on additional properties.

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response: HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{ "nslicenseserverpool": [ {
getalllicenses:<Boolean_value>"instancetotal":<Integer_value>,
"instanceavailable":<Integer_value>,
"standardbandwidthtotal":<Integer_value>,
"standardbandwidthavailable":<Integer_value>,
"enterprisebandwidthtotal":<Integer_value>,
"enterprisebandwidthavailable":<Integer_value>,
"platinumbandwidthtotal":<Integer_value>,
"platinumbandwidthavailable":<Integer_value>,
"standardcputotal":<Integer_value>,
"standardcpuavailable":<Integer_value>,
"enterprisecputotal":<Integer_value>,
"enterprisecpuavailable":<Integer_value>,
"platinumcputotal":<Integer_value>,
"platinumcpuavailable":<Integer_value>,
"cpxinstancetotal":<Integer_value>,
"cpxinstanceavailable":<Integer_value>,
"vpx1stotal":<Integer_value>,
"vpx1savailable":<Integer_value>,
"vpx1ptotal":<Integer_value>,
"vpx1pavailable":<Integer_value>,
"vpx5stotal":<Integer_value>,
"vpx5savailable":<Integer_value>,
"vpx5ptotal":<Integer_value>,
"vpx5pavailable":<Integer_value>,
"vpx10stotal":<Integer_value>,
"vpx10savailable":<Integer_value>,
"vpx10etotal":<Integer_value>,
"vpx10eavailable":<Integer_value>,
"vpx10ptotal":<Integer_value>,
"vpx10pavailable":<Integer_value>,
"vpx25stotal":<Integer_value>,
"vpx25savailable":<Integer_value>,
"vpx25etotal":<Integer_value>,
"vpx25eavailable":<Integer_value>,
"vpx25ptotal":<Integer_value>,
"vpx25pavailable":<Integer_value>,
"vpx50stotal":<Integer_value>,
"vpx50savailable":<Integer_value>,
"vpx50etotal":<Integer_value>,
"vpx50eavailable":<Integer_value>,
"vpx50ptotal":<Integer_value>,
"vpx50pavailable":<Integer_value>,
"vpx100stotal":<Integer_value>,
"vpx100savailable":<Integer_value>,
"vpx100etotal":<Integer_value>,
"vpx100eavailable":<Integer_value>,
"vpx100ptotal":<Integer_value>,
"vpx100pavailable":<Integer_value>,
"vpx200stotal":<Integer_value>,
"vpx200savailable":<Integer_value>,
"vpx200etotal":<Integer_value>,
"vpx200eavailable":<Integer_value>,
"vpx200ptotal":<Integer_value>,
"vpx200pavailable":<Integer_value>,
"vpx500stotal":<Integer_value>,
"vpx500savailable":<Integer_value>,
"vpx500etotal":<Integer_value>,
"vpx500eavailable":<Integer_value>,
"vpx500ptotal":<Integer_value>,
"vpx500pavailable":<Integer_value>,
"vpx1000stotal":<Integer_value>,
"vpx1000savailable":<Integer_value>,
"vpx1000etotal":<Integer_value>,
"vpx1000eavailable":<Integer_value>,
"vpx1000ptotal":<Integer_value>,
"vpx1000pavailable":<Integer_value>,
"vpx2000ptotal":<Integer_value>,
"vpx2000pavailable":<Integer_value>,
"vpx3000stotal":<Integer_value>,
"vpx3000savailable":<Integer_value>,
"vpx3000etotal":<Integer_value>,
"vpx3000eavailable":<Integer_value>,
"vpx3000ptotal":<Integer_value>,
"vpx3000pavailable":<Integer_value>,
"vpx4000ptotal":<Integer_value>,
"vpx4000pavailable":<Integer_value>,
"vpx5000stotal":<Integer_value>,
"vpx5000savailable":<Integer_value>,
"vpx5000etotal":<Integer_value>,
"vpx5000eavailable":<Integer_value>,
"vpx5000ptotal":<Integer_value>,
"vpx5000pavailable":<Integer_value>,
"vpx8000stotal":<Integer_value>,
"vpx8000savailable":<Integer_value>,
"vpx8000etotal":<Integer_value>,
"vpx8000eavailable":<Integer_value>,
"vpx8000ptotal":<Integer_value>,
"vpx8000pavailable":<Integer_value>,
"vpx10000stotal":<Integer_value>,
"vpx10000savailable":<Integer_value>,
"vpx10000etotal":<Integer_value>,
"vpx10000eavailable":<Integer_value>,
"vpx10000ptotal":<Integer_value>,
"vpx10000pavailable":<Integer_value>,
"vpx15000stotal":<Integer_value>,
"vpx15000savailable":<Integer_value>,
"vpx15000etotal":<Integer_value>,
"vpx15000eavailable":<Integer_value>,
"vpx15000ptotal":<Integer_value>,
"vpx15000pavailable":<Integer_value>,
"vpx25000stotal":<Integer_value>,
"vpx25000savailable":<Integer_value>,
"vpx25000etotal":<Integer_value>,
"vpx25000eavailable":<Integer_value>,
"vpx25000ptotal":<Integer_value>,
"vpx25000pavailable":<Integer_value>,
"vpx40000stotal":<Integer_value>,
"vpx40000savailable":<Integer_value>,
"vpx40000etotal":<Integer_value>,
"vpx40000eavailable":<Integer_value>,
"vpx40000ptotal":<Integer_value>,
"vpx40000pavailable":<Integer_value>,
"vpx100000stotal":<Integer_value>,
"vpx100000savailable":<Integer_value>,
"vpx100000etotal":<Integer_value>,
"vpx100000eavailable":<Integer_value>,
"vpx100000ptotal":<Integer_value>,
"vpx100000pavailable":<Integer_value>,
"licensemode":<String_value>
}]}

<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

nslicenseserverpool

May 23, 2024

Contributed by:

May 23, 2024

Contributed by:

nslicenseserverpool

Properties

Operations

get (all)

In this article