sdx_license
Configuration for License Information resource.
Properties
(click to see Operations )
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| std_bw_available | <String> | Read-only | Available standard Bandwidth in Mbps. |
| max_number_of_ns_instances | <Integer> | Read-only | Maximum Citrix ADC Instances. |
| std_bw_config | <String> | Read-only | Configured Standard Bandwidth in Mbps. |
| ent_bw_total | <String> | Read-only | Total enterprise Bandwidth in Mbps. |
| act_id | <String> | Read-only | Activity Id. |
| available_throughput | <String> | Read-only | Available Throughput in Mbps. |
| instances_config | <Integer> | Read-only | Instances Configured . |
| plt_bw_total | <String> | Read-only | Maximum platinum Bandwidth in Mbps. |
| platform | <String> | Read-only | Platform. |
| max_number_of_instances | <Integer> | Read-only | Maximum Instances. |
| max_number_of_br_instances | <Integer> | Read-only | Maximum Citrix SD-WAN Instances. |
| plt_bw_available | <String> | Read-only | Available platinum Bandwidth in Mbps. |
| ent_bw_config | <String> | Read-only | Configured Enterpise Bandwidth in Mbps. |
| cluster | <Boolean> | Read-only | Cluster License. |
| available_number_of_ns_instances | <Integer> | Read-only | Available Citrix ADC Instances (Shared). |
| max_throughput | <String> | Read-only | Maximum Throughput in Mbps. |
| license_server_name | <String> | Read-only | License Server Configured in SDX . |
| std_bw_total | <String> | Read-only | Total standard Bandwidth in Mbps. |
| ent_bw_available | <String> | Read-only | Available enterprise Bandwidth in Mbps. |
| plt_bw_config | <String> | Read-only | Configured platinum Bandwidth in Mbps. |
| is_pooled_license | <Boolean> | Read-only | Platform license for Triscaler feature. |
| available_number_of_instances | <Integer> | Read-only | Available 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=yesIf 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
The following parameters can be used in the nitro request : onerror <String_value>
Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.
Default value: EXIT
Possible values = EXIT, CONTINUE
apply
URL: https://<MGMT-IP>/nitro/v2/config/sdx_license?action=apply;onerror=<String_value> HTTPS Method: POST
Request Headers: Content-Type: application/json
X-NITRO-USER:username_value<String>
X-NITRO-PASS:password_value<String>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
Request Payload:
{"sdx_license": { }}
Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt}
get
URL: https://<MGMT-IP>/nitro/v2/config/sdx_license HTTPS Method: GET
Request Headers: Accept: application/json
X-NITRO-USER:username_value<String>
X-NITRO-PASS:password_value<String>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error
Response Headers:
Content-Type:application/json
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "sdx_license":[{
"std_bw_available":<String_value>,
"max_number_of_ns_instances":<Integer_value>,
"std_bw_config":<String_value>,
"ent_bw_total":<String_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>,
"ent_bw_config":<String_value>,
"cluster":<Boolean_value>,
"available_number_of_ns_instances":<Integer_value>,
"max_throughput":<String_value>,
"license_server_name":<String_value>,
"std_bw_total":<String_value>,
"ent_bw_available":<String_value>,
"sync_operation":<Boolean_value>,
"plt_bw_config":<String_value>,
"is_pooled_license":<Boolean_value>,
"available_number_of_instances":<Integer_value>}]}