Citrix ADM NITRO API Reference

agent_resource_threshold

June 20, 2023

Contributed by:

Configuration for Agent Resource Utilization Threshold resource.

Properties

(click to see Operations )

Name	Permissions	Description
name	Read-write	name.
region	Read-write	Region Code. Maximum length = 256
cpu_usage_threshold	Read-write	CPU usage threshold. Maximum value =
rule	Read-write	Rule.
stylebook_flag	Read-write	Stylebook threshold configuration true or false.
country	Read-write	Country Code. Maximum length = 256
sms_profile	Read-write	SMS Profile.
slack_profile	Read-write	Slack Profile.
feature	Read-write	feature.
ctnsappname	Read-write	AppName.
id	Read-write	Id is system generated key for all the Thresholds configuration . Maximum length = 256
disk_usage_threshold	Read-write	Disk usage threshold. Maximum value =
resource_type	Read-write	Resource Type.
mail_profile	Read-write	Mail Profile.
is_enabled	Read-write	true or false.
pagerduty_profile	Read-write	PagerDuty Profile.
duration	Read-write	duration of metric to be checked against threshold.
memory_usage_threshold	Read-write	Memory usage threshold. Maximum value =
servicenow_profile	Read-write	Servicenow Profile.
city	Read-write	City. Maximum length = 256
ip_address	Read-write	Field to store the ip address as it is along with any extension. Maximum length = 512
group_name	Read-write	Group Name.
reference_key	Read-write	Reference Key.
exporter_id	Read-write	Exporter Id.
disk_usage	Read-write	Total disk space usage..
disk_count	Read-write	Shows for how long agent disk threshold breach, each value of count increases after every 5 minutes.
cpu_count	Read-write	Shows for how long agent cpu threshold breach, each value of count increases after every 5 minutes.
memory_count	Read-write	Shows for how long agent memory threshold breach, each value of count increases after every 5 minutes.
memory_usage	Read-write	Total memory usage..
agent_ip_address	Read-write	Agent IP Address for this threshold breach.
cpu_usage	Read-write	Total CPU usage..
tenant_name	Read-only	Tenant Name.

Operations

(click to see Properties )

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

get (all)

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

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

count https://<MGMT-IP>/nitro/v2/config/agent_resource_threshold ?count=yes Use this query-parameter to get the count of agent_resource_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: 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, "agent_resource_threshold":[{
"name":<String_value>,
"region":<String_value>,
"cpu_usage_threshold":<Integer_value>,
"rule":<String_value>,
"stylebook_flag":<Boolean_value>,
"country":<String_value>,
"sms_profile":<String_value>,
"slack_profile":<String_value>,
"feature":<String_value>,
"ctnsappname":<String_value>,
"id":<String_value>,
"disk_usage_threshold":<Integer_value>,
"resource_type":<String_value>,
"mail_profile":<String_value>,
"is_enabled":<String_value>,
"pagerduty_profile":<String_value>,
"duration":<String_value>,
"memory_usage_threshold":<Integer_value>,
"servicenow_profile":<String_value>,
"city":<String_value>,
"ip_address":<String_value>,
"tenant_name":<String_value>,
"group_name":<String_value>,
"reference_key":<String_value>,
"exporter_id":<Double_value>,
"disk_usage":<Double_value>,
"disk_count":<Integer_value>,
"cpu_count":<Integer_value>,
"memory_count":<Integer_value>,
"memory_usage":<Double_value>,
"agent_ip_address":<String_value>,
"cpu_usage":<Double_value>}]}

<!--NeedCopy-->

get

URL: https://<MGMT-IP>/nitro/v2/config/agent_resource_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, "agent_resource_threshold":[{
"name":<String_value>,
"region":<String_value>,
"cpu_usage_threshold":<Integer_value>,
"rule":<String_value>,
"stylebook_flag":<Boolean_value>,
"country":<String_value>,
"sms_profile":<String_value>,
"slack_profile":<String_value>,
"feature":<String_value>,
"ctnsappname":<String_value>,
"id":<String_value>,
"disk_usage_threshold":<Integer_value>,
"resource_type":<String_value>,
"mail_profile":<String_value>,
"is_enabled":<String_value>,
"pagerduty_profile":<String_value>,
"duration":<String_value>,
"memory_usage_threshold":<Integer_value>,
"servicenow_profile":<String_value>,
"city":<String_value>,
"ip_address":<String_value>,
"tenant_name":<String_value>,
"group_name":<String_value>,
"reference_key":<String_value>,
"exporter_id":<Double_value>,
"disk_usage":<Double_value>,
"disk_count":<Integer_value>,
"cpu_count":<Integer_value>,
"memory_count":<Integer_value>,
"memory_usage":<Double_value>,
"agent_ip_address":<String_value>,
"cpu_usage":<Double_value>}]}

<!--NeedCopy-->

update

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

{"agent_resource_threshold":{
<b>"id":<String_value></b>,
"cpu_count":<Integer_value>,
"region":<String_value>,
"name":<String_value>,
"agent_ip_address":<String_value>,
"cpu_usage_threshold":<Integer_value>,
"disk_usage":<Double_value>,
"stylebook_flag":<Boolean_value>,
"rule":<String_value>,
"country":<String_value>,
"sms_profile":<String_value>,
"slack_profile":<String_value>,
"feature":<String_value>,
"ctnsappname":<String_value>,
"disk_usage_threshold":<Integer_value>,
"mail_profile":<String_value>,
"resource_type":<String_value>,
"is_enabled":<String_value>,
"pagerduty_profile":<String_value>,
"duration":<String_value>,
"memory_usage_threshold":<Integer_value>,
"cpu_usage":<Double_value>,
"servicenow_profile":<String_value>,
"disk_count":<Integer_value>,
"city":<String_value>,
"memory_count":<Integer_value>,
"ip_address":<String_value>,
"group_name":<String_value>,
"reference_key":<String_value>,
"memory_usage":<Double_value>,
"exporter_id":<Double_value>}}

<!--NeedCopy-->

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "agent_resource_threshold":[{
"name":<String_value>,
"region":<String_value>,
"cpu_usage_threshold":<Integer_value>,
"rule":<String_value>,
"stylebook_flag":<Boolean_value>,
"country":<String_value>,
"sms_profile":<String_value>,
"slack_profile":<String_value>,
"feature":<String_value>,
"ctnsappname":<String_value>,
"id":<String_value>,
"disk_usage_threshold":<Integer_value>,
"resource_type":<String_value>,
"mail_profile":<String_value>,
"is_enabled":<String_value>,
"pagerduty_profile":<String_value>,
"duration":<String_value>,
"memory_usage_threshold":<Integer_value>,
"servicenow_profile":<String_value>,
"city":<String_value>,
"ip_address":<String_value>,
"tenant_name":<String_value>,
"group_name":<String_value>,
"reference_key":<String_value>,
"exporter_id":<Double_value>,
"disk_usage":<Double_value>,
"disk_count":<Integer_value>,
"cpu_count":<Integer_value>,
"memory_count":<Integer_value>,
"memory_usage":<Double_value>,
"agent_ip_address":<String_value>,
"cpu_usage":<Double_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

agent_resource_threshold

June 20, 2023

Contributed by:

June 20, 2023

Contributed by:

agent_resource_threshold

Properties

Operations

get (all)

get

update

In this article