device_usage

Configuration for NetScaler Usage information resource.

Read/write properties

bandwidth_usage<Double>

bandwidth usage of the Instance.

hostname<String>

Host name of the device.

timestamp<Double>

Max Device usage information per hour at this timestamp.

id<String>

Id is system generated key.

total_limit<Integer>

Total license limit for the user (including burst).

base_limit<Integer>

Base limit usage for the user (excluding burst).

timeslot<Double>

Device usage information at this timestamp.

Read only properties

license_usage<Integer>

License used by the NetScaler (Bandwidth/vCPU).

ip_address<String>

IP Address of the device.

license_name<String>

License name for the device.

Operations

NOTE: In request payload, Mandatory parameters are marked red and bold.

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

get

URL:https://<MGMT-IP>/nitro/v2/config/device_usage

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:JSON

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "device_usage":[{
      "license_usage":<Integer_value>,
      "bandwidth_usage":<Double_value>,
      "hostname":<String_value>,
      "timestamp":<Double_value>,
      "ip_address":<String_value>,
      "id":<String_value>,
      "total_limit":<Integer_value>,
      "base_limit":<Integer_value>,
      "timeslot":<Double_value>,
      "license_name":<String_value>}]}