device_summary
Configuration for City wise devices summary resource.
(click to see Operations)
Properties
(click to see Operations)
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| cityname | <String> | Read-write | City Name. Maximum length = 255 |
| total_critical_events | <Integer> | Read-only | Total Critical events city wise.. |
| longitude | <Double> | Read-only | longitude of the city. |
| total_devices_outofservice | <Integer> | Read-only | Total devices out of service city wise.. |
| total_major_events | <Integer> | Read-only | Total major events.. |
| total_events | <Integer> | Read-only | Total events city wise.. |
| total_agents_outofservice | <Integer> | Read-only | Total agents out of service city wise.. |
| tenant_id | <String> | Read-only | Tenant Id. |
| total_agents_up | <Integer> | Read-only | Total agents up city wise.. |
| total_number_of_devices | <Integer> | Read-only | Total number of devices deployed city wise... |
| total_devices_down | <Integer> | Read-only | Total agents down city wise.. |
| latitude | <Double> | Read-only | latitude of the city. |
| total_devices_up | <Integer> | Read-only | Total agents down city wise.. |
| total_number_of_agents | <Integer> | Read-only | Total number of agents deployed city wise.. |
| total_agents_down | <Integer> | Read-only | Total agents down city wise.. |
Operations
(click to see Properties)
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>}]}