Download full document:

nslicenseserverpool

Configuration for licenseserver resource.

Properties

(click to see Operations)

NameData TypePermissionsDescription
instancetotal<Integer>Read-onlyInstance Total.
instanceavailable<Integer>Read-onlyInstance Available.
standardbandwidthtotal<Integer>Read-onlyStandard Bandwidth Total.
standardbandwidthavailable<Integer>Read-onlyStandard Bandwidth Available.
enterprisebandwidthtotal<Integer>Read-onlyEnterprise Bandwidth Total.
enterprisebandwidthavailable<Integer>Read-onlyEnterprise Bandwidth Available.
platinumbandwidthtotal<Integer>Read-onlyPlatinum Bandwidth Total.
platinumbandwidthavailable<Integer>Read-onlyPlatinum Bandwidth Available.
standardcputotal<Integer>Read-onlyStandard CPU Total.
standardcpuavailable<Integer>Read-onlyStandard CPU Available.
enterprisecputotal<Integer>Read-onlyEnterprise CPU Total.
enterprisecpuavailable<Integer>Read-onlyEnterprise CPU Available.
platinumcputotal<Integer>Read-onlyPlatinum CPU Total.
platinumcpuavailable<Integer>Read-onlyPlatinum CPU Available.
cpxinstancetotal<Integer>Read-onlyCP1000 Instance Total.
cpxinstanceavailable<Integer>Read-onlyCP1000 Instance Available.
vpx1stotal<Integer>Read-onlyVPX1S Total.
vpx1savailable<Integer>Read-onlyVPX1S Available.
vpx1ptotal<Integer>Read-onlyVPX1P Total.
vpx1pavailable<Integer>Read-onlyVPX1P Available.
vpx5stotal<Integer>Read-onlyVPX5S Total.
vpx5savailable<Integer>Read-onlyVPX5S Available.
vpx5ptotal<Integer>Read-onlyVPX5P Total.
vpx5pavailable<Integer>Read-onlyVPX5P Available.
vpx10stotal<Integer>Read-onlyVPX10S Total.
vpx10savailable<Integer>Read-onlyVPX10S Available.
vpx10etotal<Integer>Read-onlyVPX10E Total.
vpx10eavailable<Integer>Read-onlyVPX10E Available.
vpx10ptotal<Integer>Read-onlyVPX10P Total.
vpx10pavailable<Integer>Read-onlyVPX10P Available.
vpx25stotal<Integer>Read-onlyVPX25S Total.
vpx25savailable<Integer>Read-onlyVPX25S Available.
vpx25etotal<Integer>Read-onlyVPX25E Total.
vpx25eavailable<Integer>Read-onlyVPX25E Available.
vpx25ptotal<Integer>Read-onlyVPX25P Total.
vpx25pavailable<Integer>Read-onlyVPX25P Available.
vpx50stotal<Integer>Read-onlyVPX50S Total.
vpx50savailable<Integer>Read-onlyVPX50S Available.
vpx50etotal<Integer>Read-onlyVPX50E Total.
vpx50eavailable<Integer>Read-onlyVPX50E Available.
vpx50ptotal<Integer>Read-onlyVPX50P Total.
vpx50pavailable<Integer>Read-onlyVPX50P Available.
vpx100stotal<Integer>Read-onlyVPX100S Total.
vpx100savailable<Integer>Read-onlyVPX100S Available.
vpx100etotal<Integer>Read-onlyVPX100E Total.
vpx100eavailable<Integer>Read-onlyVPX100E Available.
vpx100ptotal<Integer>Read-onlyVPX100P Total.
vpx100pavailable<Integer>Read-onlyVPX100P Available.
vpx200stotal<Integer>Read-onlyVPX200S Total.
vpx200savailable<Integer>Read-onlyVPX200S Available.
vpx200etotal<Integer>Read-onlyVPX200E Total.
vpx200eavailable<Integer>Read-onlyVPX200E Available.
vpx200ptotal<Integer>Read-onlyVPX200P Total.
vpx200pavailable<Integer>Read-onlyVPX200P Available.
vpx500stotal<Integer>Read-onlyVPX500S Total.
vpx500savailable<Integer>Read-onlyVPX500S Available.
vpx500etotal<Integer>Read-onlyVPX500E Total.
vpx500eavailable<Integer>Read-onlyVPX500E Available.
vpx500ptotal<Integer>Read-onlyVPX500P Total.
vpx500pavailable<Integer>Read-onlyVPX500P Available.
vpx1000stotal<Integer>Read-onlyVPX1000S Total.
vpx1000savailable<Integer>Read-onlyVPX1000S Available.
vpx1000etotal<Integer>Read-onlyVPX1000E Total.
vpx1000eavailable<Integer>Read-onlyVPX1000E Available.
vpx1000ptotal<Integer>Read-onlyVPX1000P Total.
vpx1000pavailable<Integer>Read-onlyVPX1000P Available.
vpx2000ptotal<Integer>Read-onlyVPX2000P Total.
vpx2000pavailable<Integer>Read-onlyVPX2000P Available.
vpx3000stotal<Integer>Read-onlyVPX3000S Total.
vpx3000savailable<Integer>Read-onlyVPX3000S Available.
vpx3000etotal<Integer>Read-onlyVPX3000E Total.
vpx3000eavailable<Integer>Read-onlyVPX3000E Available.
vpx3000ptotal<Integer>Read-onlyVPX3000P Total.
vpx3000pavailable<Integer>Read-onlyVPX3000P Available.
vpx4000ptotal<Integer>Read-onlyVPX4000P Total.
vpx4000pavailable<Integer>Read-onlyVPX4000P Available.
vpx5000stotal<Integer>Read-onlyVPX5000S Total.
vpx5000savailable<Integer>Read-onlyVPX5000S Available.
vpx5000etotal<Integer>Read-onlyVPX5000E Total.
vpx5000eavailable<Integer>Read-onlyVPX5000E Available.
vpx5000ptotal<Integer>Read-onlyVPX5000P Total.
vpx5000pavailable<Integer>Read-onlyVPX5000P Available.
vpx8000stotal<Integer>Read-onlyVPX8000S Total.
vpx8000savailable<Integer>Read-onlyVPX8000S Available.
vpx8000etotal<Integer>Read-onlyVPX8000E Total.
vpx8000eavailable<Integer>Read-onlyVPX8000E Available.
vpx8000ptotal<Integer>Read-onlyVPX8000P Total.
vpx8000pavailable<Integer>Read-onlyVPX8000P Available.
vpx10000stotal<Integer>Read-onlyVPX10000S Total.
vpx10000savailable<Integer>Read-onlyVPX10000S Available.
vpx10000etotal<Integer>Read-onlyVPX10000E Total.
vpx10000eavailable<Integer>Read-onlyVPX10000E Available.
vpx10000ptotal<Integer>Read-onlyVPX10000P Total.
vpx10000pavailable<Integer>Read-onlyVPX10000P Available.
vpx15000stotal<Integer>Read-onlyVPX15000S Total.
vpx15000savailable<Integer>Read-onlyVPX15000S Available.
vpx15000etotal<Integer>Read-onlyVPX15000E Total.
vpx15000eavailable<Integer>Read-onlyVPX15000E Available.
vpx15000ptotal<Integer>Read-onlyVPX15000P Total.
vpx15000pavailable<Integer>Read-onlyVPX15000P Available.
vpx25000stotal<Integer>Read-onlyVPX25000S Total.
vpx25000savailable<Integer>Read-onlyVPX25000S Available.
vpx25000etotal<Integer>Read-onlyVPX25000E Total.
vpx25000eavailable<Integer>Read-onlyVPX25000E Available.
vpx25000ptotal<Integer>Read-onlyVPX25000P Total.
vpx25000pavailable<Integer>Read-onlyVPX25000P Available.
vpx40000stotal<Integer>Read-onlyVPX40000S Total.
vpx40000savailable<Integer>Read-onlyVPX40000S Available.
vpx40000etotal<Integer>Read-onlyVPX40000E Total.
vpx40000eavailable<Integer>Read-onlyVPX40000E Available.
vpx40000ptotal<Integer>Read-onlyVPX40000P Total.
vpx40000pavailable<Integer>Read-onlyVPX40000P Available.
vpx100000stotal<Integer>Read-onlyVPX100000S Total.
vpx100000savailable<Integer>Read-onlyVPX100000S Available.
vpx100000etotal<Integer>Read-onlyVPX100000E Total.
vpx100000eavailable<Integer>Read-onlyVPX100000E Available.
vpx100000ptotal<Integer>Read-onlyVPX100000P Total.
vpx100000pavailable<Integer>Read-onlyVPX100000P Available.

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 redand placeholder content is marked in <green>.

get (all)

URL:http://<netscaler-ip-address>/nitro/v1/config/nslicenseserverpool

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 errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "nslicenseserverpool": [ {
"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>
}]}