active_event

Configuration for Active Event resource.

Read/write properties

severity<String>

Severity of Event.

id<String>

Id is system generated key for all the events.

Read only properties

timestamp<Integer>

Time when the event occured.

cmd_auth_status<String>

Command Authorization Status if the event is generated for any config change or config save in device.

operation_type<String>

Operation Type.

source<String>

Source from where the event is originated.

cmd_exec_status<String>

Command Execution Status if the event is generated for any config change or config save in device.

message<String>

Event Message - All the other properties recevied in event trap which do not specific fields in this resource(In key : value pair).

counter_threshold_value<String>

device threshold value for any threadhold violated traps.

entity<String>

Entity of Event.

device_type<String>

Type of device from which we have received the event.

config_cmd<String>

Config Command if the event is generated for any config change in device.

device_family<String>

Family of device from which we have received the event.

category<String>

Category of Event.

counter_actual_value<String>

device actual value for any threadhold violated traps.

device_entity_name<String>

Device Entity Name.

device_entity_type<String>

Device Entity Type.

user_name<String>

Username.

failureobj<String>

Failure objects are entity instances or counters for which an event has been generated, for example entity name.

hostname<String>

Assign hostname to managed device, if this is not provided, name will be set as host name .

entity_type<String>

Entity Type.

ids_list_arr<String[]>

List of IDS.

threshold_value<String>

Threshold Value, cab be used while sending traps.

current_value<String>

Current Value, can be used while sending traps.

Operations

NOTE: In request payload, Mandatory parameters are marked red and bold.

The following parameters can be used in the nitro request :

onerror <String_value>

Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.
Default value: EXIT
Possible values = EXIT, CONTINUE

delete update_status get (all)get

delete

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

HTTPS Method:DELETE

Request Headers:

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload:JSON

{ "errorcode": 0, "message": "Done", "severity": <String_value> }

update_status

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

HTTPS Method:POST

Request Headers:

Content-Type:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:JSON

{"active_event": {
"severity":<String_value>,
"id":<String_value>}}

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload:JSON

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

get (all)

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

Query-parameters:

filter

https://<MGMT-IP>/nitro/v2/config/active_event?filter=property-name1:property-value1,property-name2:property-value2

Use this query-parameter to get the filtered set of active_event resources configured on the system. You can set a filter on any property of the resource.

pagesize=#no&pageno=#no

https://<MGMT-IP>/nitro/v2/config/active_event?pagesize=#no&pageno=#no

Use this query-parameter to get the active_event resources in chunks.

count

https://<MGMT-IP>/nitro/v2/config/active_event?count=yes

Use this query-parameter to get the count of active_event resources.

HTTPS Method:GET

Request Headers:

Accept:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:JSON

get

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

HTTPS Method:GET

Request Headers:

Accept:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:JSON