Citrix ADM NITRO API Reference

device_license_info

June 20, 2023

Contributed by:

Configuration for Device License Info resource.

Properties

(click to see Operations )

Name	Permissions	Description
instance_mode	Read-write	instance mode of device.
details	Read-write	Details about license state.
last_updated_time	Read-write	Last Updated Time.
configured_on_vm	Read-only	Configured license capacity of VM.
current_throughput	Read-only	Current Througput of device.
license_pool	Read-only	License Pool.
allocated_on_vm	Read-only	Running license capacity of VM.
name	Read-only	Name of managed device.
grace	Read-only	True if this device is managed by NMX.
managed_device_id	Read-only	Device id managaed device.
license_state	Read-only	State of device, UP only if device accessible.
allocated	Read-only	Allocate license on License server.
hours_to_expiry	Read-only	No of Hours after which grace license expires.
ip_address	Read-only	IP Address for this managed device.
type	Read-only	Type of device, (Xen \| NS).

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

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

get (all)

URL: https://<MGMT-IP>/nitro/v2/config/device_license_info Query-parameters:

filter https://<MGMT-IP>/nitro/v2/config/device_license_info ?filter=property-name1:property-value1,property-name2:property-value2 Use this query-parameter to get the filtered set of device_license_info resources configured on the system. You can set a filter on any property of the resource.

pagesize=#no;pageno=#no https://<MGMT-IP>/nitro/v2/config/device_license_info ?pagesize=#no;pageno=#no Use this query-parameter to get the device_license_info resources in chunks.

count https://<MGMT-IP>/nitro/v2/config/device_license_info ?count=yes Use this query-parameter to get the count of device_license_info resources.

HTTPS Method: GET

Request Headers: Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

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, "device_license_info":[{
"configured_on_vm":<Integer_value>,
"current_throughput":<String_value>,
"license_pool":<String_value>,
"allocated_on_vm":<Integer_value>,
"name":<String_value>,
"instance_mode":<String_value>,
"details":<String_value>,
"grace":<Boolean_value>,
"managed_device_id":<String_value>,
"license_state":<String_value>,
"last_updated_time":<Double_value>,
"allocated":<Integer_value>,
"hours_to_expiry":<Integer_value>,
"ip_address":<String_value>,
"type":<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

device_license_info

June 20, 2023

Contributed by:

June 20, 2023

Contributed by:

device_license_info

Properties

Operations

get (all)

In this article