ADM NITRO APIs

perf_threshold

June 20, 2023

Contributed by:

Configuration for PerfThreshold resource.

Properties

(click to see Operations )

Name	Data Type	Permissions	Description
sms_profile		Read-write	SMS Profile.
clear_message		Read-write	Clear Message.
slack_profile		Read-write	Slack Profile.
threshold_type		Read-write	Threshold Type.
id		Read-write	Id is system generated key for all the perf thresholds configuration . Maximum length = 256
report_name		Read-write	Report Name for which the threshold is configured. Minimum length = 1 Maximum length = 100
severity		Read-write	Severity.
mail_profile		Read-write	Mail Profile.
is_enabled		Read-write	enabled or disabled.
pagerduty_profile		Read-write	PagerDuty Profile.
device_family		Read-write	Device Family of which this threshold belongs to.
instances		Read-write	counter instances. Minimum length = 1 Maximum length = 100
threshold_value		Read-write	Threshold Value.
name		Read-write	name. Minimum length = 1 Maximum length = 128
counter_name		Read-write	Counter Name for which the threshold is configured. Minimum length = 1 Maximum length = 100
devices		Read-write	On which devices the threshold is enabled.
message		Read-write	Message.
clear_value		Read-write	Clear Value.
servicenow_profile		Read-write	ServiceNow Profile.
devices_array	<String[]>	Read-write	Devices list.
instances_array	<String[]>	Read-write	Instances list.

Operations

(click to see Properties )

ADD
DELETE
GET (ALL)
GET
UPDATE

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

add

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

{"perf_threshold": {
"clear_message":<String_value>,
"devices_array":<String_value[]>,
"threshold_type":<String_value>,
"name":<String_value>,
"report_name":<String_value>,
"instances_array":<String_value[]>,
"counter_name":<String_value>,
"clear_value":<Double_value>,
"sms_profile":<String_value>,
"slack_profile":<String_value>,
"id":<String_value>,
"mail_profile":<String_value>,
"is_enabled":<Boolean_value>,
"device_family":<String_value>,
"pagerduty_profile":<String_value>,
"threshold_value":<Double_value>,
"devices":<String_value>,
"servicenow_profile":<String_value>,
"severity":<String_value>,
"instances":<String_value>,
"message":<String_value>}}

<!--NeedCopy-->

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:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "perf_threshold":[{
"sms_profile":<String_value>,
"clear_message":<String_value>,
"slack_profile":<String_value>,
"threshold_type":<String_value>,
"clear_event":<Boolean_value>,
"id":<String_value>,
"report_name":<String_value>,
"severity":<String_value>,
"mail_profile":<String_value>,
"tenant_name":<String_value>,
"is_enabled":<Boolean_value>,
"pagerduty_profile":<String_value>,
"device_family":<String_value>,
"instances":<String_value>,
"threshold_value":<Double_value>,
"name":<String_value>,
"duration":<String_value>,
"counter_name":<String_value>,
"devices":<String_value>,
"message":<String_value>,
"clear_value":<Double_value>,
"servicenow_profile":<String_value>,
"devices_array":<String_value>,
"instances_array":<String_value>}]}

<!--NeedCopy-->

delete

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

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt }

<!--NeedCopy-->

get (all)

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

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

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

Content-Type:application/json

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "perf_threshold":[{
"sms_profile":<String_value>,
"clear_message":<String_value>,
"slack_profile":<String_value>,
"threshold_type":<String_value>,
"clear_event":<Boolean_value>,
"id":<String_value>,
"report_name":<String_value>,
"severity":<String_value>,
"mail_profile":<String_value>,
"tenant_name":<String_value>,
"is_enabled":<Boolean_value>,
"pagerduty_profile":<String_value>,
"device_family":<String_value>,
"instances":<String_value>,
"threshold_value":<Double_value>,
"name":<String_value>,
"duration":<String_value>,
"counter_name":<String_value>,
"devices":<String_value>,
"message":<String_value>,
"clear_value":<Double_value>,
"servicenow_profile":<String_value>,
"devices_array":<String_value>,
"instances_array":<String_value>}]}

<!--NeedCopy-->

get

URL: https://<MGMT-IP>/nitro/v2/config/perf_threshold/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, "perf_threshold":[{
"sms_profile":<String_value>,
"clear_message":<String_value>,
"slack_profile":<String_value>,
"threshold_type":<String_value>,
"clear_event":<Boolean_value>,
"id":<String_value>,
"report_name":<String_value>,
"severity":<String_value>,
"mail_profile":<String_value>,
"tenant_name":<String_value>,
"is_enabled":<Boolean_value>,
"pagerduty_profile":<String_value>,
"device_family":<String_value>,
"instances":<String_value>,
"threshold_value":<Double_value>,
"name":<String_value>,
"duration":<String_value>,
"counter_name":<String_value>,
"devices":<String_value>,
"message":<String_value>,
"clear_value":<Double_value>,
"servicenow_profile":<String_value>,
"devices_array":<String_value>,
"instances_array":<String_value>}]}

<!--NeedCopy-->

update

URL: https://<MGMT-IP>/nitro/v2/config/perf_threshold/id_value<String> HTTPS Method: PUT

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:

{"perf_threshold":{
<b>"id":<String_value></b>,
"clear_message":<String_value>,
"devices_array":<String_value[]>,
"threshold_type":<String_value>,
"name":<String_value>,
"report_name":<String_value>,
"instances_array":<String_value[]>,
"counter_name":<String_value>,
"clear_value":<Double_value>,
"sms_profile":<String_value>,
"slack_profile":<String_value>,
"mail_profile":<String_value>,
"is_enabled":<Boolean_value>,
"device_family":<String_value>,
"pagerduty_profile":<String_value>,
"threshold_value":<Double_value>,
"devices":<String_value>,
"servicenow_profile":<String_value>,
"severity":<String_value>,
"instances":<String_value>,
"message":<String_value>}}

<!--NeedCopy-->

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "perf_threshold":[{
"sms_profile":<String_value>,
"clear_message":<String_value>,
"slack_profile":<String_value>,
"threshold_type":<String_value>,
"clear_event":<Boolean_value>,
"id":<String_value>,
"report_name":<String_value>,
"severity":<String_value>,
"mail_profile":<String_value>,
"tenant_name":<String_value>,
"is_enabled":<Boolean_value>,
"pagerduty_profile":<String_value>,
"device_family":<String_value>,
"instances":<String_value>,
"threshold_value":<Double_value>,
"name":<String_value>,
"duration":<String_value>,
"counter_name":<String_value>,
"devices":<String_value>,
"message":<String_value>,
"clear_value":<Double_value>,
"servicenow_profile":<String_value>,
"devices_array":<String_value>,
"instances_array":<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

perf_threshold

June 20, 2023

Contributed by:

June 20, 2023

Contributed by:

perf_threshold

Properties

Operations

add

delete

get (all)

get

update

In this article