Skip to content

devicewise_detail_summary

Configuration for Ns event devices summary resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
is_agent<Boolean>Read-writeIs this device acting as Gateway..
memory_usage<Double>Read-writememory usage of a device.
cityname<String>Read-writeCity Name.
Maximum length = 255
agent_name<String>Read-writeAgent Name.
Maximum length = 255
agent_id<String>Read-writeAgent Id.
Maximum length = 255
throughput<Double>Read-writeAssign throughput in Mbps to VM Instance.
type<String>Read-writeType of device, (Xen | NS).
Minimum length = 1
Maximum length = 64
instances<String>Read-onlyTotal number of devices managed by this agent.
agent_ip_address<String>Read-onlyTotal number of devices deployed city wise...
total_events<Integer>Read-onlyTotal minor events..
tenant_id<String>Read-onlyTenant Id.
vm_cpu_usage<Double>Read-onlyCPU Usage (%) of VM Instance.
ip_address<String>Read-onlyTotal number of devices deployed city wise...
instance_state<String>Read-onlyState of device, UP only if device accessible.

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/devicewise_detail_summary

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "devicewise_detail_summary":[{
"instances":<String_value>,
"is_agent":<Boolean_value>,
"memory_usage":<Double_value>,
"agent_ip_address":<String_value>,
"total_events":<Integer_value>,
"cityname":<String_value>,
"tenant_id":<String_value>,
"agent_name":<String_value>,
"agent_id":<String_value>,
"vm_cpu_usage":<Double_value>,
"throughput":<Double_value>,
"ip_address":<String_value>,
"instance_state":<String_value>,
"type":<String_value>}]}