ADM NITRO APIs

ns_event_message

June 20, 2023

Contributed by:

Configuration for Citrix ADC Events resource.

Properties

(click to see Operations )

Name	Permissions	Description
id	Read-write	Id is system generated key for all the events.
counter_threshold_value	Read-only	device threshold value for any threadhold violated traps.
source	Read-only	Source.
cmd_exec_status	Read-only	Command Execution Status if the event is generated for any config change or config save in device.
device_entity_type	Read-only	Device Entity Type.
entity	Read-only	Entity of Event.
device_type	Read-only	Device Type.
timestamp	Read-only	Time when the event occured.
operation_type	Read-only	Operation Type.
category	Read-only	Category of Event.
severity	Read-only	Severity of Event.
failureobj	Read-only	Failure objects are entity instances or counters for which an event has been generated, for example entity name.
source_event_id	Read-only	Internal Event ID used in the source device..
history	Read-only	History of the Event with same entity.
device_family	Read-only	Device Family.
total_count	Read-only	total_count.
message	Read-only	Event Message - All the other properties recevied in event trap which do not specific fields in this resource(In key : value pair).
user_name	Read-only	Username.
device_entity_name	Read-only	Device Entity Name.
config_cmd	Read-only	Config Command if the event is generated for any config change in device.
cmd_auth_status	Read-only	Command Authorization Status if the event is generated for any config change or config save in device.
counter_actual_value	Read-only	device actual value for any threadhold violated traps.

Operations

(click to see Properties )

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

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

get (all)

URL: https://<MGMT-IP>/nitro/v2/config/ns_event_message Query-parameters:

filter https://<MGMT-IP>/nitro/v2/config/ns_event_message ?filter=property-name1:property-value1,property-name2:property-value2 Use this query-parameter to get the filtered set of ns_event_message 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/ns_event_message ?pagesize=#no;pageno=#no Use this query-parameter to get the ns_event_message resources in chunks.

count https://<MGMT-IP>/nitro/v2/config/ns_event_message ?count=yes Use this query-parameter to get the count of ns_event_message 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:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ns_event_message":[{
"counter_threshold_value":<String_value>,
"source":<String_value>,
"cmd_exec_status":<String_value>,
"device_entity_type":<String_value>,
"trap_id":<Integer_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>,
"source_event_id":<Integer_value>,
"history":<String_value>,
"device_family":<String_value>,
"total_count":<Integer_value>,
"message":<String_value>,
"user_name":<String_value>,
"device_entity_name":<String_value>,
"config_cmd":<String_value>,
"cmd_auth_status":<String_value>,
"counter_actual_value":<String_value>}]}

<!--NeedCopy-->

get

URL: https://<MGMT-IP>/nitro/v2/config/ns_event_message/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 Headers:

Content-Type:application/json

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ns_event_message":[{
"counter_threshold_value":<String_value>,
"source":<String_value>,
"cmd_exec_status":<String_value>,
"device_entity_type":<String_value>,
"trap_id":<Integer_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>,
"source_event_id":<Integer_value>,
"history":<String_value>,
"device_family":<String_value>,
"total_count":<Integer_value>,
"message":<String_value>,
"user_name":<String_value>,
"device_entity_name":<String_value>,
"config_cmd":<String_value>,
"cmd_auth_status":<String_value>,
"counter_actual_value":<String_value>}]}

<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

ns_event_message

June 20, 2023

Contributed by:

June 20, 2023

Contributed by:

ns_event_message

Properties

Operations

get (all)

get

In this article