device_event_summary
Configuration for devices events summary resource.
(click to see Operations)
Properties
(click to see Operations)
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| id | <String> | Read-write | Id is system generated key. |
| device_ip_address | <String> | Read-write | ip_address of the device.. |
| type | <String> | Read-write | Device Family. Minimum length = 1 Maximum length = 64 |
| hostname | <String> | Read-write | Assign hostname to managed device, if this is not provided, name will be set as host name . Minimum length = 1 Maximum length = 256 |
| total_critical_events | <Integer> | Read-only | Total Critical events city wise.. |
| total_major_events | <Integer> | Read-only | Total major events.. |
| total_events | <Integer> | Read-only | Total events. |
| instance_state | <String> | Read-only | State of device, UP only if device accessible. |
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_event_summary
HTTP Method: null
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "device_event_summary":[{
"total_critical_events":<Integer_value>,
"total_major_events":<Integer_value>,
"id":<String_value>,
"device_ip_address":<String_value>,
"total_events":<Integer_value>,
"type":<String_value>,
"hostname":<String_value>,
"instance_state":<String_value>}]}
get
URL: https://<MGMT-IP>/nitro/v1/config/device_event_summary/id_value<String>
HTTP Method: null
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "device_event_summary":[{
"total_critical_events":<Integer_value>,
"total_major_events":<Integer_value>,
"id":<String_value>,
"device_ip_address":<String_value>,
"total_events":<Integer_value>,
"type":<String_value>,
"hostname":<String_value>,
"instance_state":<String_value>}]}