Skip to content

sdx_license

Configuration for License Information resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
std_bw_available<String>Read-onlyAvailable standard Bandwidth in Mbps.
max_number_of_ns_instances<Integer>Read-onlyMaximum NetScaler Instances.
std_bw_config<String>Read-onlyConfigured Standard Bandwidth in Mbps.
ent_bw_total<String>Read-onlyTotal enterprise Bandwidth in Mbps.
provisioned_swg_instances<Integer>Read-onlyProvisioned number of SWG Instances.
act_id<String>Read-onlyActivity Id.
available_throughput<String>Read-onlyAvailable Throughput in Mbps.
instances_config<Integer>Read-onlyInstances Configured .
plt_bw_total<String>Read-onlyMaximum platinum Bandwidth in Mbps.
platform<String>Read-onlyPlatform.
max_number_of_instances<Integer>Read-onlyMaximum Instances.
max_number_of_br_instances<Integer>Read-onlyMaximum NetScaler SD-WAN Instances.
plt_bw_available<String>Read-onlyAvailable platinum Bandwidth in Mbps.
provisioned_nonswg_instances<Integer>Read-onlyProvisioned number of NS/ADC/Third-party VM Instances.
ent_bw_config<String>Read-onlyConfigured Enterpise Bandwidth in Mbps.
cluster<Boolean>Read-onlyCluster License.
available_number_of_ns_instances<Integer>Read-onlyAvailable NetScaler Instances (Shared).
max_throughput<String>Read-onlyMaximum Throughput in Mbps.
available_nonswg_instances<Integer>Read-onlyAvailable number of NS/ADC/Third-party VM Instances.
std_bw_total<String>Read-onlyTotal standard Bandwidth in Mbps.
ent_bw_available<String>Read-onlyAvailable enterprise Bandwidth in Mbps.
plt_bw_config<String>Read-onlyConfigured platinum Bandwidth in Mbps.
available_swg_instances<Integer>Read-onlyAvailable number of SWG Instances.
is_pooled_license<Boolean>Read-onlyPlatform license for Triscaler feature.
swg_license_present<Boolean>Read-onlyIndication for SWG License.
available_number_of_instances<Integer>Read-onlyAvailable Instances.

Operations

(click to see Properties)

APPLY| GET

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>.

apply

URL: https://<MGMT-IP>/nitro/v1/config/sdx_license?action=apply;onerror=<String_value>

HTTP Method: null

Request Payload:

{"sdx_license": { }}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>}

get

URL: https://<MGMT-IP>/nitro/v1/config/sdx_license

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "sdx_license":[{
"std_bw_available":<String_value>,
"max_number_of_ns_instances":<Integer_value>,
"std_bw_config":<String_value>,
"ent_bw_total":<String_value>,
"provisioned_swg_instances":<Integer_value>,
"act_id":<String_value>,
"available_throughput":<String_value>,
"instances_config":<Integer_value>,
"plt_bw_total":<String_value>,
"platform":<String_value>,
"max_number_of_instances":<Integer_value>,
"max_number_of_br_instances":<Integer_value>,
"plt_bw_available":<String_value>,
"provisioned_nonswg_instances":<Integer_value>,
"ent_bw_config":<String_value>,
"cluster":<Boolean_value>,
"available_number_of_ns_instances":<Integer_value>,
"max_throughput":<String_value>,
"available_nonswg_instances":<Integer_value>,
"std_bw_total":<String_value>,
"ent_bw_available":<String_value>,
"sync_operation":<Boolean_value>,
"plt_bw_config":<String_value>,
"available_swg_instances":<Integer_value>,
"is_pooled_license":<Boolean_value>,
"swg_license_present":<Boolean_value>,
"available_number_of_instances":<Integer_value>}]}