Skip to content

active_event

Configuration for Active Event resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
counter_threshold_value<String>Read-writedevice threshold value for any threadhold violated traps.
cmd_exec_status<String>Read-writeCommand Execution Status.
Maximum length = 255
device_entity_type<String>Read-writeDevice Entity Type.
Maximum length = 255
device_type<String>Read-writeDevice Type.
Minimum length = 1
Maximum length = 64
id<String>Read-writeId is system generated key for all the events.
device_family<String>Read-writeDevice Family.
user_name<String>Read-writeUsername.
Maximum length = 255
config_cmd<String>Read-writeConfig Command.
cmd_auth_status<String>Read-writeCommand Authorization Status.
Maximum length = 255
device_entity_name<String>Read-writeDevice Entity Name.
counter_actual_value<String>Read-writedevice actual value for any threadhold violated traps.
hostname<String>Read-writeAssign hostname to managed device, if this is not provided, name will be set as host name .
Minimum length = 1
Maximum length = 256
source<String>Read-onlySource.
entity<String>Read-onlyEntity of Event.
timestamp<Integer>Read-onlyEvent Time.
operation_type<String>Read-onlyOperation Type.
category<String>Read-onlyCategory of Event.
severity<String>Read-onlySeverity of Event.
failureobj<String>Read-onlyFailure Object.
message<String>Read-onlyEvent Message.
ids_list_arr<String[]>Read-onlyList of IDS.
current_value<String>Read-onlyCurrent Value, cab be used while sending traps.
threshold_value<String>Read-onlyThreshold Value, cab be used while sending traps.
entity_type<String>Read-onlyEntity Type.
matched_filters<String>Read-onlyMatched Event Filter Ids separated by comma.

Operations

(click to see Properties)

UPDATE_STATUS| DELETE| GET (ALL)| GET

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>.

update_status

URL: https://<MGMT-IP>/nitro/v1/config/active_event?action=update_status;onerror=<String_value>

HTTP Method: null

Request Payload:

{active_event: {
"counter_threshold_value":<String_value>,
"cmd_exec_status":<String_value>,
"hostname":<String_value>,
"device_type":<String_value>,
"id":<String_value>,
"device_family":<String_value>,
"user_name":<String_value>,
"cmd_auth_status":<String_value>,
"config_cmd":<String_value>,
"device_entity_type":<String_value>,
"device_entity_name":<String_value>,
"counter_actual_value":<String_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "active_event":[{
"counter_threshold_value":<String_value>,
"source":<String_value>,
"cmd_exec_status":<String_value>,
"device_entity_type":<String_value>,
"entity":<String_value>,
"device_type":<String_value>,
"timestamp":<Integer_value>,
"operation_type":<String_value>,
"id":<String_value>,
"category":<String_value>,
"severity":<String_value>,
"failureobj":<String_value>,
"device_family":<String_value>,
"message":<String_value>,
"user_name":<String_value>,
"config_cmd":<String_value>,
"cmd_auth_status":<String_value>,
"device_entity_name":<String_value>,
"counter_actual_value":<String_value>,
"ids_list_arr":<String_value>,
"current_value":<String_value>,
"threshold_value":<String_value>,
"entity_type":<String_value>,
"hostname":<String_value>,
"matched_filters":<String_value>,
"managed_device_id":<String_value>}]}

delete

URL: https://<MGMT-IP>/nitro/v1/config/active_event/id_value<String>

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value> }

get (all)

URL: https://<MGMT-IP>/nitro/v1/config/active_event

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "active_event":[{
"counter_threshold_value":<String_value>,
"source":<String_value>,
"cmd_exec_status":<String_value>,
"device_entity_type":<String_value>,
"entity":<String_value>,
"device_type":<String_value>,
"timestamp":<Integer_value>,
"operation_type":<String_value>,
"id":<String_value>,
"category":<String_value>,
"severity":<String_value>,
"failureobj":<String_value>,
"device_family":<String_value>,
"message":<String_value>,
"user_name":<String_value>,
"config_cmd":<String_value>,
"cmd_auth_status":<String_value>,
"device_entity_name":<String_value>,
"counter_actual_value":<String_value>,
"ids_list_arr":<String_value>,
"current_value":<String_value>,
"threshold_value":<String_value>,
"entity_type":<String_value>,
"hostname":<String_value>,
"matched_filters":<String_value>,
"managed_device_id":<String_value>}]}

get

URL: https://<MGMT-IP>/nitro/v1/config/active_event/id_value<String>

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "active_event":[{
"counter_threshold_value":<String_value>,
"source":<String_value>,
"cmd_exec_status":<String_value>,
"device_entity_type":<String_value>,
"entity":<String_value>,
"device_type":<String_value>,
"timestamp":<Integer_value>,
"operation_type":<String_value>,
"id":<String_value>,
"category":<String_value>,
"severity":<String_value>,
"failureobj":<String_value>,
"device_family":<String_value>,
"message":<String_value>,
"user_name":<String_value>,
"config_cmd":<String_value>,
"cmd_auth_status":<String_value>,
"device_entity_name":<String_value>,
"counter_actual_value":<String_value>,
"ids_list_arr":<String_value>,
"current_value":<String_value>,
"threshold_value":<String_value>,
"entity_type":<String_value>,
"hostname":<String_value>,
"matched_filters":<String_value>,
"managed_device_id":<String_value>}]}