27 lines
11 KiB
HTML
27 lines
11 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>trap_settings</title>
|
|
</head>
|
|
<body class="ns_body">
|
|
<p class="ns_wp_header">trap_settings</p>
|
|
<P>Configuration for trap severities resource.</P>
|
|
<p class="heading">Read/write properties</p>
|
|
<p class="property_name">user_defined_severity<span class="property_type"><String></span></p><p class="property_description">user defined severity of trap.</p>
|
|
<p class="property_name">default_severity<span class="property_type"><String></span></p><p class="property_description">default severity of trap.</p>
|
|
<p class="property_name">id<span class="property_type"><String></span></p><p class="property_description">Id is system generated key.</p>
|
|
<p class="property_name">trap_category<span class="property_type"><String></span></p><p class="property_description">Trap Category.</p>
|
|
<p class="property_name">trap_description<span class="property_type"><String></span></p><p class="property_description">Trap Description.</p>
|
|
<p class="property_name">device_family<span class="property_type"><String></span></p><p class="property_description">Device Family.</p>
|
|
<p class="property_name">source<span class="property_type"><String></span></p><p class="property_description">Source.</p>
|
|
<p class="property_name">oid<span class="property_type"><String></span></p><p class="property_description">Trap OID.</p>
|
|
<p class="property_name">is_suppress<span class="property_type"><Boolean></span></p><p class="property_description">if trap needs to be suppressed or not.</p>
|
|
<p class="property_name">source_array<span class="property_type"><String[]></span></p><p class="property_description">Source list.</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="#update" class="operation">update</a><a href="#get_all" class="operation">get (all)</a><a href="#get" class="operation">get</a><p class="heading"><a name="update">update</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/trap_settings/id_value<String></span></p><p class="key">HTTPS Method:<span class="value">PUT</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Content-Type:<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">Request Payload:<span class="value">JSON</span></p><p class="payload">{"trap_settings":{<br><font color=#FF0000><b> "id":<String_value></b></font>,<br><font color=#000000> "is_suppress":<Boolean_value></font>,<br><font color=#000000> "trap_category":<String_value></font>,<br><font color=#000000> "user_defined_severity":<String_value></font>,<br><font color=#000000> "device_family":<String_value></font>,<br><font color=#000000> "source":<String_value></font>,<br><font color=#000000> "default_severity":<String_value></font>,<br><font color=#000000> "oid":<String_value></font>,<br><font color=#000000> "source_array":<String_value[]></font>,<br><font color=#000000> "trap_description":<String_value></font>}}</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>, "trap_settings":[{<br> "user_defined_severity":<String_value></font>,<br> "default_severity":<String_value></font>,<br> "id":<String_value></font>,<br> "trap_category":<String_value></font>,<br> "trap_description":<String_value></font>,<br> "device_family":<String_value></font>,<br> "source":<String_value></font>,<br> "oid":<String_value></font>,<br> "is_suppress":<Boolean_value></font>,<br> "source_array":<String_value></font>}]}</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/trap_settings</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/trap_settings<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 trap_settings 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/trap_settings<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the trap_settings resources in chunks.</span></p><p class="key"><b>count</b></p><p class="key"><span class="value">https://<MGMT-IP>/nitro/v2/config/trap_settings<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of trap_settings 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>, "trap_settings":[{<br> "user_defined_severity":<String_value></font>,<br> "default_severity":<String_value></font>,<br> "id":<String_value></font>,<br> "trap_category":<String_value></font>,<br> "trap_description":<String_value></font>,<br> "device_family":<String_value></font>,<br> "source":<String_value></font>,<br> "oid":<String_value></font>,<br> "is_suppress":<Boolean_value></font>,<br> "source_array":<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/trap_settings/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>, "trap_settings":[{<br> "user_defined_severity":<String_value></font>,<br> "default_severity":<String_value></font>,<br> "id":<String_value></font>,<br> "trap_category":<String_value></font>,<br> "trap_description":<String_value></font>,<br> "device_family":<String_value></font>,<br> "source":<String_value></font>,<br> "oid":<String_value></font>,<br> "is_suppress":<Boolean_value></font>,<br> "source_array":<String_value></font>}]}</p>
|
|
</body>
|
|
</html>
|