autoscalepolicy
Configuration for Autoscale policy resource.
Properties
(click to see Operations)
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| name | <String> | Read-write | The name of the autoscale policy.<br>Minimum length = 1 |
| rule | <String> | Read-write | The rule associated with the policy. |
| action | <String> | Read-write | The autoscale profile associated with the policy.<br>Minimum length = 1 |
| comment | <String> | Read-write | Comments associated with this autoscale policy. |
| logaction | <String> | Read-write | The log action associated with the autoscale policy. |
| newname | <String> | Read-write | The new name of the autoscale policy.<br>Minimum length = 1 |
| hits | <Double> | Read-only | Number of hits. |
| undefhits | <Double> | Read-only | Number of Undef hits. |
| priority | <Double> | Read-only | Specifies the priority of the policy. |
| activepolicy | <Integer> | Read-only | Indicates whether policy is bound or not. |
| __count | <Double> | Read-only | count parameter |
Operations
(click to see Properties)
ADD | DELETE | UPDATE | UNSET | RENAME | GET (ALL) | GET | 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/autoscalepolicy
HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json
Request Payload:
{"autoscalepolicy":{
"name":<String_value>,
"rule":<String_value>,
"action":<String_value>,
"comment":<String_value>,
"logaction":<String_value>
}}
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/autoscalepolicy/name_value<String>
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
update
URL: http://<netscaler-ip-address>/nitro/v1/config/autoscalepolicy
HTTP Method: PUT
Request Headers:
Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json
Request Payload:
{"autoscalepolicy":{
"name":<String_value>,
"rule":<String_value>,
"action":<String_value>,
"comment":<String_value>,
"logaction":<String_value>
}}
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
unset
URL: http://<netscaler-ip-address>/nitro/v1/config/autoscalepolicy?action=unset
HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json
Request Payload:
{"autoscalepolicy":{
"name":<String_value>,
"rule":true,
"action":true,
"comment":true,
"logaction":true
}}
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
rename
URL: http://<netscaler-ip-address>/nitro/v1/config/autoscalepolicy?action=rename
HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json
Request Payload:
{"autoscalepolicy":{
"name":<String_value>,
"newname":<String_value>
}}
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 (all)
URL: http://<netscaler-ip-address>/nitro/v1/config/autoscalepolicy
Query-parameters:
attrs
http://<netscaler-ip-address>/nitro/v1/config/autoscalepolicy?attrs=property-name1,property-name2
Use this query parameter to specify the resource details that you want to retrieve.
filter
http://<netscaler-ip-address>/nitro/v1/config/autoscalepolicy?filter=property-name1:property-val1,property-name2:property-val2
Use this query-parameter to get the filtered set of autoscalepolicy resources configured on NetScaler.Filtering can be done on any of the properties of the resource.
view
http://<netscaler-ip-address>/nitro/v1/config/autoscalepolicy?view=summary
Note: By default, the retrieved results are displayed in detail view (?view=detail).
pagination
http://<netscaler-ip-address>/nitro/v1/config/autoscalepolicy?pagesize=#no;pageno=#no
Use this query-parameter to get the autoscalepolicy 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 errorResponse Headers:
Content-Type:application/json
Response Payload:
{ "autoscalepolicy": [ {
"name":<String_value>,
"rule":<String_value>,
"action":<String_value>,
"comment":<String_value>,
"logaction":<String_value>,
"hits":<Double_value>,
"undefhits":<Double_value>,
"priority":<Double_value>,
"activepolicy":<Integer_value>
}]}
get
URL: http://<netscaler-ip-address>/nitro/v1/config/autoscalepolicy/name_value<String>
Query-parameters:
attrs
http://<netscaler-ip-address>/nitro/v1/config/autoscalepolicy/name_value<String>?attrs=property-name1,property-name2
Use this query parameter to specify the resource details that you want to retrieve.
view
http://<netscaler-ip-address>/nitro/v1/config/autoscalepolicy/name_value<String>?view=summary
Note: By default, the retrieved results are displayed in detail view (?view=detail).
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 errorResponse Headers:
Content-Type:application/json
Response Payload:
{ "autoscalepolicy": [ {
"name":<String_value>,
"rule":<String_value>,
"action":<String_value>,
"comment":<String_value>,
"logaction":<String_value>,
"hits":<Double_value>,
"undefhits":<Double_value>,
"priority":<Double_value>,
"activepolicy":<Integer_value>
}]}
count
URL: http://<netscaler-ip-address>/nitro/v1/config/autoscalepolicy?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 errorResponse Headers:
Content-Type:application/json
Response Payload:
{ "autoscalepolicy": [ { "__count": "#no"} ] }