47 lines
17 KiB
HTML
47 lines
17 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
|
<link href="../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
|
|
<link href="../../index.css" rel="stylesheet" type="text/css" />
|
|
<title>event</title>
|
|
</head>
|
|
<body class="ns_body">
|
|
<p class="ns_wp_header">event</p>
|
|
<P>Configuration for System Event resource.</P>
|
|
<p class="heading">Read/write properties</p>
|
|
<p class="property_name">severity<span class="property_type"><String></span></p><p class="property_description">Severity of Event.<br> Minimum length = 1<br> Maximum length = 32</p>
|
|
<p class="property_name">id<span class="property_type"><String></span></p><p class="property_description">Id is system generated key for all the events.</p>
|
|
<p class="property_name">event_history<span class="property_type"><eventHistory[]></span></p><p class="property_description">previous status of event.</p>
|
|
<p class="heading">Read only properties</p>
|
|
<p class="property_name">cmd_exec_status<span class="property_type"><String></span></p><p class="property_description">Command Execution Status if the event is generated for any config change or config save in device.</p>
|
|
<p class="property_name">message<span class="property_type"><String></span></p><p class="property_description">Event Message.</p>
|
|
<p class="property_name">operation_type<span class="property_type"><String></span></p><p class="property_description">Operation Type of the event.</p>
|
|
<p class="property_name">history<span class="property_type"><String></span></p><p class="property_description">History of the Event with same entity.</p>
|
|
<p class="property_name">user_name<span class="property_type"><String></span></p><p class="property_description">Username.</p>
|
|
<p class="property_name">counter_actual_value<span class="property_type"><String></span></p><p class="property_description">device actual value for any threadhold violated traps.</p>
|
|
<p class="property_name">device_entity_name<span class="property_type"><String></span></p><p class="property_description">Device Entity Name.</p>
|
|
<p class="property_name">device_family<span class="property_type"><String></span></p><p class="property_description">Family of device for which we have received the event.</p>
|
|
<p class="property_name">source_event_id<span class="property_type"><Integer></span></p><p class="property_description">Internal Event ID used in the source device..</p>
|
|
<p class="property_name">source_system_ip<span class="property_type"><String></span></p><p class="property_description">Source (System IP Address) of ADM HA from where the event is generated.</p>
|
|
<p class="property_name">entity<span class="property_type"><String></span></p><p class="property_description">Entity of Event.</p>
|
|
<p class="property_name">config_cmd<span class="property_type"><String></span></p><p class="property_description">Config Command if the event is generated for any config change in device.</p>
|
|
<p class="property_name">counter_threshold_value<span class="property_type"><String></span></p><p class="property_description">device threshold value for any threadhold violated traps.</p>
|
|
<p class="property_name">source<span class="property_type"><String></span></p><p class="property_description">Source from where the event is generated.</p>
|
|
<p class="property_name">timestamp<span class="property_type"><Integer></span></p><p class="property_description">Time when the event is received.</p>
|
|
<p class="property_name">cmd_auth_status<span class="property_type"><String></span></p><p class="property_description">Command Authorization Status if the event is generated for any config change or config save in device.</p>
|
|
<p class="property_name">rpt_sample_time<span class="property_type"><Double></span></p><p class="property_description">Report Sample time..</p>
|
|
<p class="property_name">device_entity_type<span class="property_type"><String></span></p><p class="property_description">Device Entity Type.</p>
|
|
<p class="property_name">failureobj<span class="property_type"><String></span></p><p class="property_description">Failure objects are entity instances or counters for which an event has been generated.</p>
|
|
<p class="property_name">category<span class="property_type"><String></span></p><p class="property_description">Category of Event.</p>
|
|
<p class="property_name">device_type<span class="property_type"><String></span></p><p class="property_description">Type of device for which we have received the event.</p>
|
|
<p class="property_name">current_value<span class="property_type"><String></span></p><p class="property_description">Current Value, cab be used while sending traps.</p>
|
|
<p class="property_name">managed_device_id<span class="property_type"><String></span></p><p class="property_description">Managed Device ID.</p>
|
|
<p class="property_name">threshold_value<span class="property_type"><String></span></p><p class="property_description">Threshold Value, cab be used while sending traps.</p>
|
|
<p class="property_name">entity_type<span class="property_type"><String></span></p><p class="property_description">Entity Type.</p>
|
|
<p class="property_name">hostname<span class="property_type"><String></span></p><p class="property_description">Assign hostname to managed device, if this is not provided, name will be set as host name .</p>
|
|
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
|
|
<p class="property_name">onerror<span class=\"property_type\"> <String_value></span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#delete" class="operation">delete</a><a href="#get_all" class="operation">get (all)</a><a href="#get" class="operation">get</a><p class="heading"><a name="delete">delete</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/event/id_value<String></span></p><p class="key">HTTPS Method:<span class="value">DELETE</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": <String_value> }</p><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/event</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>filter</b></p><p class="key"><span class="value">https://<MGMT-IP>/nitro/v2/config/event<b>?filter=property-name1:property-value1,property-name2:property-value2</b></span></p><p class="key"><span class="value">Use this query-parameter to get the filtered set of event resources configured on the system. You can set a filter on any property of the resource.</span></p><p class="key"><b>pagesize=#no&pageno=#no</b></p><p class="key"><span class="value">https://<MGMT-IP>/nitro/v2/config/event<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the event resources in chunks.</span></p><p class="key"><b>count</b></p><p class="key"><span class="value">https://<MGMT-IP>/nitro/v2/config/event<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of event resources.</span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": <String_value>, "event":[{<br> "cmd_exec_status":<String_value></font>,<br> "message":<String_value></font>,<br> "operation_type":<String_value></font>,<br> "history":<String_value></font>,<br> "user_name":<String_value></font>,<br> "counter_actual_value":<String_value></font>,<br> "trap_id":<Integer_value></font>,<br> "device_entity_name":<String_value></font>,<br> "device_family":<String_value></font>,<br> "source_event_id":<Integer_value></font>,<br> "source_system_ip":<String_value></font>,<br> "entity":<String_value></font>,<br> "config_cmd":<String_value></font>,<br> "counter_threshold_value":<String_value></font>,<br> "source":<String_value></font>,<br> "timestamp":<Integer_value></font>,<br> "severity":<String_value></font>,<br> "cmd_auth_status":<String_value></font>,<br> "id":<String_value></font>,<br> "rpt_sample_time":<Double_value></font>,<br> "device_entity_type":<String_value></font>,<br> "event_history":[{<br> "id":<String_value></font>,<br> "severity":<String_value></font>,<br> "timestamp":<Integer_value></font>,<br> "source_system_ip":<String_value></font>,<br> "parent_id":<String_value></font>,<br> "message":<String_value></font>,<br> "parent_name":<String_value></font>}],<br> "failureobj":<String_value></font>,<br> "category":<String_value></font>,<br> "device_type":<String_value></font>,<br> "current_value":<String_value></font>,<br> "managed_device_id":<String_value></font>,<br> "threshold_value":<String_value></font>,<br> "matched_filters":<String_value></font>,<br> "entity_type":<String_value></font>,<br> "hostname":<String_value></font>}]}</p><p class="heading"><a name="get">get</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/event/id_value<String></span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": <String_value>, "event":[{<br> "cmd_exec_status":<String_value></font>,<br> "message":<String_value></font>,<br> "operation_type":<String_value></font>,<br> "history":<String_value></font>,<br> "user_name":<String_value></font>,<br> "counter_actual_value":<String_value></font>,<br> "trap_id":<Integer_value></font>,<br> "device_entity_name":<String_value></font>,<br> "device_family":<String_value></font>,<br> "source_event_id":<Integer_value></font>,<br> "source_system_ip":<String_value></font>,<br> "entity":<String_value></font>,<br> "config_cmd":<String_value></font>,<br> "counter_threshold_value":<String_value></font>,<br> "source":<String_value></font>,<br> "timestamp":<Integer_value></font>,<br> "severity":<String_value></font>,<br> "cmd_auth_status":<String_value></font>,<br> "id":<String_value></font>,<br> "rpt_sample_time":<Double_value></font>,<br> "device_entity_type":<String_value></font>,<br> "event_history":[{<br> "id":<String_value></font>,<br> "severity":<String_value></font>,<br> "timestamp":<Integer_value></font>,<br> "source_system_ip":<String_value></font>,<br> "parent_id":<String_value></font>,<br> "message":<String_value></font>,<br> "parent_name":<String_value></font>}],<br> "failureobj":<String_value></font>,<br> "category":<String_value></font>,<br> "device_type":<String_value></font>,<br> "current_value":<String_value></font>,<br> "managed_device_id":<String_value></font>,<br> "threshold_value":<String_value></font>,<br> "matched_filters":<String_value></font>,<br> "entity_type":<String_value></font>,<br> "hostname":<String_value></font>}]}</p>
|
|
</body>
|
|
</html>
|