Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

nstimer_autoscalepolicy_binding

May 23, 2024
Contributed by: 
C

Binding object showing the autoscalepolicy that can be bound to nstimer.

Properties

(click to see Operations )

Name Data Type Permissions Description
priority Read-write Specifies the priority of the timer policy.
gotopriorityexpression Read-write Expression specifying the priority of the next policy which will get evaluated if the current policy rule evaluates to TRUE.
policyname Read-write The timer policy associated with the timer.
name Read-write Timer name.

Minimum length = 1
threshold Read-write Denotes the threshold. If the rule of the policy in the binding relation evaluates ‘threshold size’ number of times in ‘sample size’ to true, then the corresponding action is taken. Its value needs to be less than or equal to the sample size value.

Default value: 3

Minimum value = 1

Maximum value = 32
samplesize Read-write Denotes the sample size. Sample size value of ‘x’ means that previous ‘(x - 1)’ policy’s rule evaluation results and the current evaluation result are present with the binding. For example, sample size of 10 means that there is a state of previous 9 policy evaluation results and also the current policy evaluation result.

Default value: 3

Minimum value = 1

Maximum value = 32
vserver Read-write Name of the vserver which provides the context for the rule in timer policy. When not specified it is treated as a Global Default context.
__count Read-write count parameter

Operations

(click to see Properties )

  • ADD
  • DELETE
  • GET
  • GET (ALL)
  • COUNT

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: http:// <netscaler-ip-address /nitro/v1/config/nstimer_autoscalepolicy_binding HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 

{
"nstimer_autoscalepolicy_binding":{
<b>"name":<String_value>,
</b><b>"policyname":<String_value>,
</b><b>"priority":<Double_value>,
</b>"gotopriorityexpression":<String_value>,
"vserver":<String_value>,
"samplesize":<Double_value>,
"threshold":<Double_value>
}}

<!--NeedCopy-->

Response: HTTP Status Code on Success: 201 Created

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

delete

URL: http:// <netscaler-ip-address> /nitro/v1/config/nstimer_autoscalepolicy_binding/ name_value<String> Query-parameters: args http:// <netscaler-ip-address> /nitro/v1/config/nstimer_autoscalepolicy_binding/ name_value<String> ? args= policyname:<String_value>

HTTP Method: DELETE

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Response: HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/nstimer_autoscalepolicy_binding/ name_value<String> Query-parameters: filter http:// <netscaler-ip-address> /nitro/v1/config/nstimer_autoscalepolicy_binding/ name_value<String> ? filter=property-name1:property-value1,property-name2:property-value2

Use this query-parameter to get the filtered set of nstimer_autoscalepolicy_binding resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

pagination http:// <netscaler-ip-address> /nitro/v1/config/nstimer_autoscalepolicy_binding/ name_value<String> ? pagesize=#no;pageno=#no

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

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response: HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload: 

{  "nstimer_autoscalepolicy_binding": [ {
"priority":<Double_value>,
"gotopriorityexpression":<String_value>,
"policyname":<String_value>,
"name":<String_value>,
"threshold":<Double_value>,
"samplesize":<Double_value>,
"vserver":<String_value>
}]}

<!--NeedCopy-->

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/nstimer_autoscalepolicy_binding HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Query-parameters: bulkbindings http:// <netscaler-ip-address> /nitro/v1/config/nstimer_autoscalepolicy_binding? bulkbindings=yes

NITRO allows you to fetch bindings in bulk.

Note: get (all) method can be used only in conjuction with bulkbindings query parameter.

Response: HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload: 

{  "nstimer_autoscalepolicy_binding": [ {
"priority":<Double_value>,
"gotopriorityexpression":<String_value>,
"policyname":<String_value>,
"name":<String_value>,
"threshold":<Double_value>,
"samplesize":<Double_value>,
"vserver":<String_value>
}]}

<!--NeedCopy-->

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/nstimer_autoscalepolicy_binding/ name_value<String> ? count=yes HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response: HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload: 

{"nstimer_autoscalepolicy_binding": [ { "__count": "#no"} ] }

<!--NeedCopy-->
nstimer_autoscalepolicy_binding
May 23, 2024
Contributed by: 
C
May 23, 2024
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.