Skip to content

perf_threshold

Configuration for PerfThreshold resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
sms_profile<String>Read-writeSMS Profile.
clear_message<String>Read-writeClear Message.
threshold_type<String>Read-writeThreshold Type.
id<String>Read-writeId is system generated key for all the perf thresholds configuration .
Maximum length = 256
report_name<String>Read-writeReport Name for which the threshold is configured.
Minimum length = 1
Maximum length = 100
severity<String>Read-writeSeverity.
mail_profile<String>Read-writeMail Profile.
tenant_name<String>Read-writeTenant Name.
is_enabled<Boolean>Read-writeenabled or disabled.
device_family<String>Read-writeDevice Family of which this threshold belongs to.
instances<String>Read-writecounter instances.
Minimum length = 1
Maximum length = 100
threshold_value<Double>Read-writeThreshold Value.
name<String>Read-writename.
Minimum length = 1
Maximum length = 128
duration<String>Read-writeduration of metric to be checked against threshold.
counter_name<String>Read-writeCounter Name for which the threshold is configured.
Minimum length = 1
Maximum length = 100
devices<String>Read-writeOn which devices the threshold is enabled.
message<String>Read-writeMessage.
clear_value<Double>Read-writeClear Value.
devices_array<String[]>Read-writeDevices list.
instances_array<String[]>Read-writeInstances list.
clear_event<Boolean>Read-onlyset to true if the event needs to be cleared.

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>.

add

URL: https://<MGMT-IP>/nitro/v1/config/perf_threshold?onerror=<String_value>

HTTP Method: null

Request Payload:

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

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "perf_threshold":[{
"sms_profile":<String_value>,
"clear_message":<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>,
"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>,
"devices_array":<String_value>,
"instances_array":<String_value>}]}

delete

URL: https://<MGMT-IP>/nitro/v1/config/perf_threshold/id_value<String>

HTTP Method: null

Response Payload:

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

get (all)

URL: https://<MGMT-IP>/nitro/v1/config/perf_threshold

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "perf_threshold":[{
"sms_profile":<String_value>,
"clear_message":<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>,
"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>,
"devices_array":<String_value>,
"instances_array":<String_value>}]}

get

URL: https://<MGMT-IP>/nitro/v1/config/perf_threshold/id_value<String>

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "perf_threshold":[{
"sms_profile":<String_value>,
"clear_message":<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>,
"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>,
"devices_array":<String_value>,
"instances_array":<String_value>}]}

update

URL: https://<MGMT-IP>/nitro/v1/config/perf_threshold/id_value<String>

HTTP Method: null

Request Payload:

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

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "perf_threshold":[{
"sms_profile":<String_value>,
"clear_message":<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>,
"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>,
"devices_array":<String_value>,
"instances_array":<String_value>}]}