license_threshold

Configuration for License Threshold configuration resource.

Read/write properties

resource_type<String>

Resource Type.

region<String>

Region Code.
Maximum length = 256

reference_key<String>

Reference Key.

pool_limit<Integer>

Pool limit configuration.
Minimum value = -1
Maximum value =

name<String>

name.

ip_address<String>

Field to store the ip address as it is along with any extension.
Maximum length = 512

group_name<String>

Group Name.

pagerduty_profile<String>

PagerDuty Profile.

expiry_threshold<Integer>

Expiry Threshold configuration.
Minimum value = 1

servicenow_profile<String>

Servicenow Profile.

rule<String>

Rule.

mail_profile<String>

Mail Profile.

exporter_id<Double>

Exporter Id.

city<String>

City.
Maximum length = 256

id<String>

Id is system generated key for all the Thresholds configuration .
Maximum length = 256

feature<String>

feature.

duration<String>

duration of metric to be checked against threshold.

stylebook_flag<Boolean>

Stylebook threshold configuration true or false.

slack_profile<String>

Slack Profile.

ctnsappname<String>

AppName.

is_enabled<String>

true or false.

sms_profile<String>

SMS Profile.

country<String>

Country Code.
Maximum length = 256

Read only properties

tenant_name<String>

Tenant Name.

Operations

NOTE: In request payload, Mandatory parameters are marked red and bold.

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)get update

get (all)

URL:https://<MGMT-IP>/nitro/v2/config/license_threshold

Query-parameters:

filter

https://<MGMT-IP>/nitro/v2/config/license_threshold?filter=property-name1:property-value1,property-name2:property-value2

Use this query-parameter to get the filtered set of license_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/license_threshold?pagesize=#no&pageno=#no

Use this query-parameter to get the license_threshold resources in chunks.

count

https://<MGMT-IP>/nitro/v2/config/license_threshold?count=yes

Use this query-parameter to get the count of license_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:JSON

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "license_threshold":[{
      "resource_type":<String_value>,
      "tenant_name":<String_value>,
      "region":<String_value>,
      "reference_key":<String_value>,
      "pool_limit":<Integer_value>,
      "name":<String_value>,
      "ip_address":<String_value>,
      "group_name":<String_value>,
      "pagerduty_profile":<String_value>,
      "expiry_threshold":<Integer_value>,
      "servicenow_profile":<String_value>,
      "rule":<String_value>,
      "mail_profile":<String_value>,
      "exporter_id":<Double_value>,
      "city":<String_value>,
      "id":<String_value>,
      "feature":<String_value>,
      "duration":<String_value>,
      "stylebook_flag":<Boolean_value>,
      "slack_profile":<String_value>,
      "ctnsappname":<String_value>,
      "is_enabled":<String_value>,
      "sms_profile":<String_value>,
      "country":<String_value>}]}

get

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

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:JSON

update

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

{"license_threshold":{
      "id":<String_value>,
      "ctnsappname":<String_value>,
      "slack_profile":<String_value>,
      "pagerduty_profile":<String_value>,
      "group_name":<String_value>,
      "ip_address":<String_value>,
      "stylebook_flag":<Boolean_value>,
      "name":<String_value>,
      "duration":<String_value>,
      "feature":<String_value>,
      "pool_limit":<Integer_value>,
      "reference_key":<String_value>,
      "region":<String_value>,
      "resource_type":<String_value>,
      "city":<String_value>,
      "country":<String_value>,
      "exporter_id":<Double_value>,
      "mail_profile":<String_value>,
      "sms_profile":<String_value>,
      "rule":<String_value>,
      "servicenow_profile":<String_value>,
      "expiry_threshold":<Integer_value>,
      "is_enabled":<String_value>}}

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:JSON