Skip to content

device_summary

Configuration for City wise devices summary resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
cityname<String>Read-writeCity Name.
Maximum length = 255
total_critical_events<Integer>Read-onlyTotal Critical events city wise..
longitude<Double>Read-onlylongitude of the city.
total_devices_outofservice<Integer>Read-onlyTotal devices out of service city wise..
total_major_events<Integer>Read-onlyTotal major events..
total_events<Integer>Read-onlyTotal events city wise..
total_agents_outofservice<Integer>Read-onlyTotal agents out of service city wise..
tenant_id<String>Read-onlyTenant Id.
total_agents_up<Integer>Read-onlyTotal agents up city wise..
total_number_of_devices<Integer>Read-onlyTotal number of devices deployed city wise...
total_devices_down<Integer>Read-onlyTotal agents down city wise..
latitude<Double>Read-onlylatitude of the city.
total_devices_up<Integer>Read-onlyTotal agents down city wise..
total_number_of_agents<Integer>Read-onlyTotal number of agents deployed city wise..
total_agents_down<Integer>Read-onlyTotal agents down city wise..

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_summary

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "device_summary":[{
"total_critical_events":<Integer_value>,
"longitude":<Double_value>,
"total_devices_outofservice":<Integer_value>,
"total_major_events":<Integer_value>,
"total_events":<Integer_value>,
"cityname":<String_value>,
"total_agents_outofservice":<Integer_value>,
"tenant_id":<String_value>,
"total_agents_up":<Integer_value>,
"total_number_of_devices":<Integer_value>,
"total_devices_down":<Integer_value>,
"latitude":<Double_value>,
"total_devices_up":<Integer_value>,
"total_number_of_agents":<Integer_value>,
"total_agents_down":<Integer_value>}]}