Skip to content

device_license_info

Configuration for Device License Info resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
last_updated_time<Double>Read-writeLast Updated Time.
configured_on_vm<Integer>Read-onlyConfigured license capacity of VM.
current_throughput<String>Read-onlyCurrent Througput of device.
license_pool<String>Read-onlyLicense Pool.
allocated_on_vm<Integer>Read-onlyRunning license capacity of VM.
name<String>Read-onlyName of managed device.
days_to_expiry<Integer>Read-onlyNo of days after which grace license expires.
grace<Boolean>Read-onlyTrue if this device is managed by NMX.
managed_device_id<String>Read-onlyDevice id managaed device.
license_state<String>Read-onlyState of device, UP only if device accessible.
allocated<Integer>Read-onlyAllocate license on License server.
ip_address<String>Read-onlyIP Address for this managed device.
type<String>Read-onlyType 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>.

get (all)

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

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "device_license_info":[{
"configured_on_vm":<Integer_value>,
"current_throughput":<String_value>,
"license_pool":<String_value>,
"allocated_on_vm":<Integer_value>,
"name":<String_value>,
"days_to_expiry":<Integer_value>,
"grace":<Boolean_value>,
"managed_device_id":<String_value>,
"license_state":<String_value>,
"last_updated_time":<Double_value>,
"allocated":<Integer_value>,
"ip_address":<String_value>,
"type":<String_value>}]}