nslicenseserverpool¶
Configuration for licenseserver resource.
Properties¶
(click to see Operations )
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| instancetotal | <Integer> | Read-write | Instance Total. |
| instanceavailable | <Integer> | Read-write | Instance Available. |
| standardbandwidthtotal | <Integer> | Read-write | Standard Bandwidth Total. |
| standardbandwidthavailable | <Integer> | Read-write | Standard Bandwidth Available. |
| enterprisebandwidthtotal | <Integer> | Read-write | Enterprise Bandwidth Total. |
| enterprisebandwidthavailable | <Integer> | Read-write | Enterprise Bandwidth Available. |
| platinumbandwidthtotal | <Integer> | Read-write | Platinum Bandwidth Total. |
| platinumbandwidthavailable | <Integer> | Read-write | Platinum Bandwidth Available. |
| standardcputotal | <Integer> | Read-write | Standard CPU Total. |
| standardcpuavailable | <Integer> | Read-write | Standard CPU Available. |
| enterprisecputotal | <Integer> | Read-write | Enterprise CPU Total. |
| enterprisecpuavailable | <Integer> | Read-write | Enterprise CPU Available. |
| platinumcputotal | <Integer> | Read-write | Platinum CPU Total. |
| platinumcpuavailable | <Integer> | Read-write | Platinum CPU Available. |
| cpxinstancetotal | <Integer> | Read-write | CP1000 Instance Total. |
| cpxinstanceavailable | <Integer> | Read-write | CP1000 Instance Available. |
| vpx1stotal | <Integer> | Read-write | VPX1S Total. |
| vpx1savailable | <Integer> | Read-write | VPX1S Available. |
| vpx1ptotal | <Integer> | Read-write | VPX1P Total. |
| vpx1pavailable | <Integer> | Read-write | VPX1P Available. |
| vpx5stotal | <Integer> | Read-write | VPX5S Total. |
| vpx5savailable | <Integer> | Read-write | VPX5S Available. |
| vpx5ptotal | <Integer> | Read-write | VPX5P Total. |
| vpx5pavailable | <Integer> | Read-write | VPX5P Available. |
| vpx10stotal | <Integer> | Read-write | VPX10S Total. |
| vpx10savailable | <Integer> | Read-write | VPX10S Available. |
| vpx10etotal | <Integer> | Read-write | VPX10E Total. |
| vpx10eavailable | <Integer> | Read-write | VPX10E Available. |
| vpx10ptotal | <Integer> | Read-write | VPX10P Total. |
| vpx10pavailable | <Integer> | Read-write | VPX10P Available. |
| vpx25stotal | <Integer> | Read-write | VPX25S Total. |
| vpx25savailable | <Integer> | Read-write | VPX25S Available. |
| vpx25etotal | <Integer> | Read-write | VPX25E Total. |
| vpx25eavailable | <Integer> | Read-write | VPX25E Available. |
| vpx25ptotal | <Integer> | Read-write | VPX25P Total. |
| vpx25pavailable | <Integer> | Read-write | VPX25P Available. |
| vpx50stotal | <Integer> | Read-write | VPX50S Total. |
| vpx50savailable | <Integer> | Read-write | VPX50S Available. |
| vpx50etotal | <Integer> | Read-write | VPX50E Total. |
| vpx50eavailable | <Integer> | Read-write | VPX50E Available. |
| vpx50ptotal | <Integer> | Read-write | VPX50P Total. |
| vpx50pavailable | <Integer> | Read-write | VPX50P Available. |
| vpx100stotal | <Integer> | Read-write | VPX100S Total. |
| vpx100savailable | <Integer> | Read-write | VPX100S Available. |
| vpx100etotal | <Integer> | Read-write | VPX100E Total. |
| vpx100eavailable | <Integer> | Read-write | VPX100E Available. |
| vpx100ptotal | <Integer> | Read-write | VPX100P Total. |
| vpx100pavailable | <Integer> | Read-write | VPX100P Available. |
| vpx200stotal | <Integer> | Read-write | VPX200S Total. |
| vpx200savailable | <Integer> | Read-write | VPX200S Available. |
| vpx200etotal | <Integer> | Read-write | VPX200E Total. |
| vpx200eavailable | <Integer> | Read-write | VPX200E Available. |
| vpx200ptotal | <Integer> | Read-write | VPX200P Total. |
| vpx200pavailable | <Integer> | Read-write | VPX200P Available. |
| vpx500stotal | <Integer> | Read-write | VPX500S Total. |
| vpx500savailable | <Integer> | Read-write | VPX500S Available. |
| vpx500etotal | <Integer> | Read-write | VPX500E Total. |
| vpx500eavailable | <Integer> | Read-write | VPX500E Available. |
| vpx500ptotal | <Integer> | Read-write | VPX500P Total. |
| vpx500pavailable | <Integer> | Read-write | VPX500P Available. |
| vpx1000stotal | <Integer> | Read-write | VPX1000S Total. |
| vpx1000savailable | <Integer> | Read-write | VPX1000S Available. |
| vpx1000etotal | <Integer> | Read-write | VPX1000E Total. |
| vpx1000eavailable | <Integer> | Read-write | VPX1000E Available. |
| vpx1000ptotal | <Integer> | Read-write | VPX1000P Total. |
| vpx1000pavailable | <Integer> | Read-write | VPX1000P Available. |
| vpx2000ptotal | <Integer> | Read-write | VPX2000P Total. |
| vpx2000pavailable | <Integer> | Read-write | VPX2000P Available. |
| vpx3000stotal | <Integer> | Read-write | VPX3000S Total. |
| vpx3000savailable | <Integer> | Read-write | VPX3000S Available. |
| vpx3000etotal | <Integer> | Read-write | VPX3000E Total. |
| vpx3000eavailable | <Integer> | Read-write | VPX3000E Available. |
| vpx3000ptotal | <Integer> | Read-write | VPX3000P Total. |
| vpx3000pavailable | <Integer> | Read-write | VPX3000P Available. |
| vpx4000ptotal | <Integer> | Read-write | VPX4000P Total. |
| vpx4000pavailable | <Integer> | Read-write | VPX4000P Available. |
| vpx5000stotal | <Integer> | Read-write | VPX5000S Total. |
| vpx5000savailable | <Integer> | Read-write | VPX5000S Available. |
| vpx5000etotal | <Integer> | Read-write | VPX5000E Total. |
| vpx5000eavailable | <Integer> | Read-write | VPX5000E Available. |
| vpx5000ptotal | <Integer> | Read-write | VPX5000P Total. |
| vpx5000pavailable | <Integer> | Read-write | VPX5000P Available. |
| vpx8000stotal | <Integer> | Read-write | VPX8000S Total. |
| vpx8000savailable | <Integer> | Read-write | VPX8000S Available. |
| vpx8000etotal | <Integer> | Read-write | VPX8000E Total. |
| vpx8000eavailable | <Integer> | Read-write | VPX8000E Available. |
| vpx8000ptotal | <Integer> | Read-write | VPX8000P Total. |
| vpx8000pavailable | <Integer> | Read-write | VPX8000P Available. |
| vpx10000stotal | <Integer> | Read-write | VPX10000S Total. |
| vpx10000savailable | <Integer> | Read-write | VPX10000S Available. |
| vpx10000etotal | <Integer> | Read-write | VPX10000E Total. |
| vpx10000eavailable | <Integer> | Read-write | VPX10000E Available. |
| vpx10000ptotal | <Integer> | Read-write | VPX10000P Total. |
| vpx10000pavailable | <Integer> | Read-write | VPX10000P Available. |
| vpx15000stotal | <Integer> | Read-write | VPX15000S Total. |
| vpx15000savailable | <Integer> | Read-write | VPX15000S Available. |
| vpx15000etotal | <Integer> | Read-write | VPX15000E Total. |
| vpx15000eavailable | <Integer> | Read-write | VPX15000E Available. |
| vpx15000ptotal | <Integer> | Read-write | VPX15000P Total. |
| vpx15000pavailable | <Integer> | Read-write | VPX15000P Available. |
| vpx25000stotal | <Integer> | Read-write | VPX25000S Total. |
| vpx25000savailable | <Integer> | Read-write | VPX25000S Available. |
| vpx25000etotal | <Integer> | Read-write | VPX25000E Total. |
| vpx25000eavailable | <Integer> | Read-write | VPX25000E Available. |
| vpx25000ptotal | <Integer> | Read-write | VPX25000P Total. |
| vpx25000pavailable | <Integer> | Read-write | VPX25000P Available. |
| vpx40000stotal | <Integer> | Read-write | VPX40000S Total. |
| vpx40000savailable | <Integer> | Read-write | VPX40000S Available. |
| vpx40000etotal | <Integer> | Read-write | VPX40000E Total. |
| vpx40000eavailable | <Integer> | Read-write | VPX40000E Available. |
| vpx40000ptotal | <Integer> | Read-write | VPX40000P Total. |
| vpx40000pavailable | <Integer> | Read-write | VPX40000P Available. |
| vpx100000stotal | <Integer> | Read-write | VPX100000S Total. |
| vpx100000savailable | <Integer> | Read-write | VPX100000S Available. |
| vpx100000etotal | <Integer> | Read-write | VPX100000E Total. |
| vpx100000eavailable | <Integer> | Read-write | VPX100000E Available. |
| vpx100000ptotal | <Integer> | Read-write | VPX100000P Total. |
| vpx100000pavailable | <Integer> | Read-write | VPX100000P 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 red and 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 error
Response Header:
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>
}]}