40 lines
23 KiB
HTML
40 lines
23 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>threshold</title>
|
|
</head>
|
|
<body class="ns_body">
|
|
<p class="ns_wp_header">threshold</p>
|
|
<P>Configuration for Thresholds resource.</P>
|
|
<p class="heading">Read/write properties</p>
|
|
<p class="property_name">rule<span class="property_type"><String></span></p><p class="property_description">Rule.</p>
|
|
<p class="property_name">feature<span class="property_type"><String></span></p><p class="property_description">feature.</p>
|
|
<p class="property_name">city<span class="property_type"><String></span></p><p class="property_description">City.<br> Maximum length = 256</p>
|
|
<p class="property_name">is_enabled<span class="property_type"><String></span></p><p class="property_description">true or false.</p>
|
|
<p class="property_name">sms_profile<span class="property_type"><String></span></p><p class="property_description">SMS Profile.</p>
|
|
<p class="property_name">mail_profile<span class="property_type"><String></span></p><p class="property_description">Mail Profile.</p>
|
|
<p class="property_name">duration<span class="property_type"><String></span></p><p class="property_description">duration of metric to be checked against threshold.</p>
|
|
<p class="property_name">resource_type<span class="property_type"><String></span></p><p class="property_description">Resource Type.</p>
|
|
<p class="property_name">name<span class="property_type"><String></span></p><p class="property_description">name.</p>
|
|
<p class="property_name">stylebook_flag<span class="property_type"><Boolean></span></p><p class="property_description">Stylebook threshold configuration true or false.</p>
|
|
<p class="property_name">exporter_id<span class="property_type"><Double></span></p><p class="property_description">Exporter Id.</p>
|
|
<p class="property_name">group_name<span class="property_type"><String></span></p><p class="property_description">Group Name.</p>
|
|
<p class="property_name">region<span class="property_type"><String></span></p><p class="property_description">Region Code.<br> Maximum length = 256</p>
|
|
<p class="property_name">country<span class="property_type"><String></span></p><p class="property_description">Country Code.<br> Maximum length = 256</p>
|
|
<p class="property_name">ip_address<span class="property_type"><String></span></p><p class="property_description">Field to store the ip address as it is along with any extension.<br> Maximum length = 512</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 Thresholds configuration .<br> Maximum length = 256</p>
|
|
<p class="property_name">reference_key<span class="property_type"><String></span></p><p class="property_description">Reference Key.</p>
|
|
<p class="property_name">ctnsappname<span class="property_type"><String></span></p><p class="property_description">AppName.</p>
|
|
<p class="property_name">pagerduty_profile<span class="property_type"><String></span></p><p class="property_description">PagerDuty Profile.</p>
|
|
<p class="property_name">servicenow_profile<span class="property_type"><String></span></p><p class="property_description">Servicenow Profile.</p>
|
|
<p class="property_name">slack_profile<span class="property_type"><String></span></p><p class="property_description">Slack Profile.</p>
|
|
<p class="heading">Read only properties</p>
|
|
<p class="property_name">tenant_name<span class="property_type"><String></span></p><p class="property_description">Tenant 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><a href="#update" class="operation">update</a><a href="#add" class="operation">add</a><p class="heading"><a name="delete">delete</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/threshold/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/threshold</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/threshold<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 threshold 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/threshold<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the threshold resources in chunks.</span></p><p class="key"><b>count</b></p><p class="key"><span class="value">https://<MGMT-IP>/nitro/v2/config/threshold<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of threshold 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>, "threshold":[{<br> "rule":<String_value></font>,<br> "feature":<String_value></font>,<br> "city":<String_value></font>,<br> "is_enabled":<String_value></font>,<br> "sms_profile":<String_value></font>,<br> "mail_profile":<String_value></font>,<br> "tenant_name":<String_value></font>,<br> "duration":<String_value></font>,<br> "resource_type":<String_value></font>,<br> "name":<String_value></font>,<br> "stylebook_flag":<Boolean_value></font>,<br> "exporter_id":<Double_value></font>,<br> "group_name":<String_value></font>,<br> "region":<String_value></font>,<br> "country":<String_value></font>,<br> "ip_address":<String_value></font>,<br> "id":<String_value></font>,<br> "reference_key":<String_value></font>,<br> "ctnsappname":<String_value></font>,<br> "pagerduty_profile":<String_value></font>,<br> "servicenow_profile":<String_value></font>,<br> "slack_profile":<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/threshold/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>, "threshold":[{<br> "rule":<String_value></font>,<br> "feature":<String_value></font>,<br> "city":<String_value></font>,<br> "is_enabled":<String_value></font>,<br> "sms_profile":<String_value></font>,<br> "mail_profile":<String_value></font>,<br> "tenant_name":<String_value></font>,<br> "duration":<String_value></font>,<br> "resource_type":<String_value></font>,<br> "name":<String_value></font>,<br> "stylebook_flag":<Boolean_value></font>,<br> "exporter_id":<Double_value></font>,<br> "group_name":<String_value></font>,<br> "region":<String_value></font>,<br> "country":<String_value></font>,<br> "ip_address":<String_value></font>,<br> "id":<String_value></font>,<br> "reference_key":<String_value></font>,<br> "ctnsappname":<String_value></font>,<br> "pagerduty_profile":<String_value></font>,<br> "servicenow_profile":<String_value></font>,<br> "slack_profile":<String_value></font>}]}</p><p class="heading"><a name="update">update</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/threshold/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">{"threshold":{<br><font color=#FF0000><b> "id":<String_value></b></font>,<br><font color=#000000> "pagerduty_profile":<String_value></font>,<br><font color=#000000> "slack_profile":<String_value></font>,<br><font color=#000000> "ctnsappname":<String_value></font>,<br><font color=#000000> "ip_address":<String_value></font>,<br><font color=#000000> "group_name":<String_value></font>,<br><font color=#000000> "duration":<String_value></font>,<br><font color=#000000> "stylebook_flag":<Boolean_value></font>,<br><font color=#000000> "name":<String_value></font>,<br><font color=#000000> "feature":<String_value></font>,<br><font color=#000000> "reference_key":<String_value></font>,<br><font color=#000000> "region":<String_value></font>,<br><font color=#000000> "resource_type":<String_value></font>,<br><font color=#000000> "city":<String_value></font>,<br><font color=#000000> "exporter_id":<Double_value></font>,<br><font color=#000000> "country":<String_value></font>,<br><font color=#000000> "sms_profile":<String_value></font>,<br><font color=#000000> "mail_profile":<String_value></font>,<br><font color=#000000> "rule":<String_value></font>,<br><font color=#000000> "servicenow_profile":<String_value></font>,<br><font color=#000000> "is_enabled":<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>, "threshold":[{<br> "rule":<String_value></font>,<br> "feature":<String_value></font>,<br> "city":<String_value></font>,<br> "is_enabled":<String_value></font>,<br> "sms_profile":<String_value></font>,<br> "mail_profile":<String_value></font>,<br> "tenant_name":<String_value></font>,<br> "duration":<String_value></font>,<br> "resource_type":<String_value></font>,<br> "name":<String_value></font>,<br> "stylebook_flag":<Boolean_value></font>,<br> "exporter_id":<Double_value></font>,<br> "group_name":<String_value></font>,<br> "region":<String_value></font>,<br> "country":<String_value></font>,<br> "ip_address":<String_value></font>,<br> "id":<String_value></font>,<br> "reference_key":<String_value></font>,<br> "ctnsappname":<String_value></font>,<br> "pagerduty_profile":<String_value></font>,<br> "servicenow_profile":<String_value></font>,<br> "slack_profile":<String_value></font>}]}</p><p class="heading"><a name="add">add</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/threshold?onerror=<String_value></span></p><p class="key">HTTPS Method:<span class="value">POST</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">{"threshold": {<br><font color=#000000> "is_enabled":<String_value></font>,<br><font color=#000000> "servicenow_profile":<String_value></font>,<br><font color=#000000> "sms_profile":<String_value></font>,<br><font color=#000000> "mail_profile":<String_value></font>,<br><font color=#000000> "rule":<String_value></font>,<br><font color=#000000> "exporter_id":<Double_value></font>,<br><font color=#000000> "country":<String_value></font>,<br><font color=#000000> "resource_type":<String_value></font>,<br><font color=#000000> "city":<String_value></font>,<br><font color=#000000> "reference_key":<String_value></font>,<br><font color=#000000> "id":<String_value></font>,<br><font color=#000000> "region":<String_value></font>,<br><font color=#000000> "duration":<String_value></font>,<br><font color=#000000> "name":<String_value></font>,<br><font color=#000000> "stylebook_flag":<Boolean_value></font>,<br><font color=#000000> "feature":<String_value></font>,<br><font color=#000000> "pagerduty_profile":<String_value></font>,<br><font color=#000000> "slack_profile":<String_value></font>,<br><font color=#000000> "ctnsappname":<String_value></font>,<br><font color=#000000> "ip_address":<String_value></font>,<br><font color=#000000> "group_name":<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>, "threshold":[{<br> "rule":<String_value></font>,<br> "feature":<String_value></font>,<br> "city":<String_value></font>,<br> "is_enabled":<String_value></font>,<br> "sms_profile":<String_value></font>,<br> "mail_profile":<String_value></font>,<br> "tenant_name":<String_value></font>,<br> "duration":<String_value></font>,<br> "resource_type":<String_value></font>,<br> "name":<String_value></font>,<br> "stylebook_flag":<Boolean_value></font>,<br> "exporter_id":<Double_value></font>,<br> "group_name":<String_value></font>,<br> "region":<String_value></font>,<br> "country":<String_value></font>,<br> "ip_address":<String_value></font>,<br> "id":<String_value></font>,<br> "reference_key":<String_value></font>,<br> "ctnsappname":<String_value></font>,<br> "pagerduty_profile":<String_value></font>,<br> "servicenow_profile":<String_value></font>,<br> "slack_profile":<String_value></font>}]}</p>
|
|
</body>
|
|
</html>
|