Skip to content

autoscalegroup

Configuration for Autoscale Group details resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
drain_connection_timeout <Integer> Read-write Drain Connection Timeout in minutes.

Minimum value = 1

Maximum value =
memory_max <Double> Read-write Maximum Memory Threshold Limit.

Minimum value = 1

Maximum value =
status <Boolean> Read-write Status of Auto-Scale Group (Enable/Disable).
mode <Integer> Read-write Mode (1.DNS/2.NLB/3.ALB/4.GLB).

Minimum value = 1

Maximum value =
auto_retry_count <Integer> Read-write Max auto retry count for retryable errors in an ASG..

Maximum value =
site_id <String> Read-write site.

Maximum length = 128
no_of_cold_nodes <Integer> Read-write No of cold node supported per AutoscaleGroup.

Minimum value = 1

Maximum value =
access_profile_id <String> Read-write The access profile id.

Maximum length = 128
provision_profile_map <autoscalegroup_profile_map[]> Read-write Provision profile map for Availability Zone.
memory_min <Double> Read-write Minimum Memory Threshold Limit.

Minimum value = 1

Maximum value =
min_node <Integer> Read-write Minimum number of nodes.

Minimum value = 1

Maximum value =
cool_down_period <Integer> Read-write Cool Down Period (Waiting time in minutes after triggering scale up/down before initiating next provisioning/de-provisioing.

Minimum value = 1

Maximum value =
id <String> Read-write Id is system generated key for all the auto-scale groups.
max_node <Integer> Read-write Maximum number of nodes.

Minimum value = 1

Maximum value =
ttl_timeout <Integer> Read-write TTL Timeout in seconds.

Minimum value = 1

Maximum value =
cloud_type <String> Read-write Type of cloud (AWS/Azure).

Maximum length = 64
activity_id <String> Read-write Most recent activity_id of this autoscalegroup.

Maximum length = 128
cpu_threshold_enabled <Boolean> Read-write Status of CPU Threshold Config.
throughput_min <Double> Read-write Minimum Throughput Threshold Limit.

Minimum value = 1

Maximum value =
name <String> Read-write Auto-Scale Group Name.

Minimum length = 1

Maximum length = 40
cpu_min <Double> Read-write Minimum CPU Threshold Limit.

Minimum value = 1

Maximum value =
mem_threshold_enabled <Boolean> Read-write Status of Memory Threshold Config.
auto_retry_interval <Integer> Read-write Delay between two auto retries in minutes..

Minimum value = 3

Maximum value =
enable_cold_node <Boolean> Read-write Enable/Disable Autoscale cold node support.
agent_id <String> Read-write The ID of Agent.

Maximum length = 128
throughput_max <Double> Read-write Maximum Throughput Threshold Limit.

Minimum value = 1

Maximum value =
cpu_max <Double> Read-write Maximum CPU Threshold Limit.

Minimum value = 1

Maximum value =
watch_time <Integer> Read-write Watch Time (No of intervels before triggering auto scale up/down).

Minimum value = 1

Maximum value =
throughput_threshold_enabled <Boolean> Read-write Status of Throughput Threshold Config.
tags <property_map[]> Read-write Array of tag_name and tag_value pair associated with the autoscalegroup.

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

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

add

URL: https://<MGMT-IP>/nitro/v2/config/autoscalegroup?onerror=<String_value>

HTTPS Method: POST

Request Headers:

Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:

{"autoscalegroup": {
<b>      "name":<String_value></b>,
      "drain_connection_timeout":<Integer_value>,
      "mode":<Integer_value>,
      "site_id":<String_value>,
      "auto_retry_count":<Integer_value>,
      "no_of_cold_nodes":<Integer_value>,
      "memory_min":<Double_value>,
      "provision_profile_map":[{
      "azure_resource_group_name":<String_value>,
      "cluster_id":<String_value>,
      "autoscalegroup_name":<String_value>,
      "parent_id":<String_value>,
      "provision_profile_id":<String_value>,
      "id":<String_value>,
      "parent_name":<String_value>,
      "activity_id":<String_value>,
      "provision_job_id":<String_value>,
      "availability_zone":<String_value>,
      "retry_err_type":<String_value>,
      "error_message":<String_value>,
      "node_id":<String_value>,
      "is_active_node_prov":<Boolean_value>,
      "is_availability_set":<Boolean_value>,
      "retry_count":<Integer_value>}],
      "id":<String_value>,
      "throughput_min":<Double_value>,
      "activity_id":<String_value>,
      "cpu_min":<Double_value>,
      "mem_threshold_enabled":<Boolean_value>,
      "auto_retry_interval":<Integer_value>,
      "watch_time":<Integer_value>,
      "cpu_max":<Double_value>,
      "memory_max":<Double_value>,
      "status":<Boolean_value>,
      "access_profile_id":<String_value>,
      "min_node":<Integer_value>,
      "cool_down_period":<Integer_value>,
      "max_node":<Integer_value>,
      "ttl_timeout":<Integer_value>,
      "cloud_type":<String_value>,
      "cpu_threshold_enabled":<Boolean_value>,
      "tags":[{
      "prop_value":<String_value>,
      "prop_key":<String_value>}],
      "enable_cold_node":<Boolean_value>,
      "throughput_max":<Double_value>,
      "agent_id":<String_value>,
      "throughput_threshold_enabled":<Boolean_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:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "autoscalegroup":[{
      "drain_connection_timeout":<Integer_value>,
      "memory_max":<Double_value>,
      "status":<Boolean_value>,
      "mode":<Integer_value>,
      "auto_retry_count":<Integer_value>,
      "site_id":<String_value>,
      "no_of_cold_nodes":<Integer_value>,
      "access_profile_id":<String_value>,
      "state":<String_value>,
      "provision_profile_map":[{
      "azure_resource_group_name":<String_value>,
      "cluster_id":<String_value>,
      "provision_state":<String_value>,
      "parent_id":<String_value>,
      "last_updated_time":<Double_value>,
      "node_id":<String_value>,
      "provision_profile_id":<String_value>,
      "is_active_node_prov":<Boolean_value>,
      "id":<String_value>,
      "cluster_ip_address":<String_value>,
      "is_drain_connection_timeout_period":<Boolean_value>,
      "parent_name":<String_value>,
      "activity_id":<String_value>,
      "provision_job_id":<String_value>,
      "retry_count":<Integer_value>,
      "availability_zone":<String_value>,
      "provision_failure_timeout":<Integer_value>,
      "is_availability_set":<Boolean_value>,
      "retry_err_type":<String_value>,
      "error_message":<String_value>,
      "is_cool_down_period":<Boolean_value>
      "bandwidth_limit":<Integer_value>
      "autoscalegroup_name":<String_value>
      "az_activity_id":<String_value>}],
      "memory_min":<Double_value>,
      "min_node":<Integer_value>,
      "last_updated_time":<Double_value>,
      "cool_down_period":<Integer_value>,
      "id":<String_value>,
      "max_node":<Integer_value>,
      "ttl_timeout":<Integer_value>,
      "cloud_type":<String_value>,
      "activity_id":<String_value>,
      "cpu_threshold_enabled":<Boolean_value>,
      "throughput_min":<Double_value>,
      "name":<String_value>,
      "cpu_min":<Double_value>,
      "mem_threshold_enabled":<Boolean_value>,
      "auto_retry_interval":<Integer_value>,
      "enable_cold_node":<Boolean_value>,
      "agent_id":<String_value>,
      "throughput_max":<Double_value>,
      "cpu_max":<Double_value>,
      "watch_time":<Integer_value>,
      "throughput_threshold_enabled":<Boolean_value>,
      "site_in_use":<Boolean_value>,
      "provision_profile_obj":<autoscalegroup_profile_map_value>,
      "tags":[{
      "prop_value":<String_value>,
      "prop_key":<String_value>}],
      "force_delete":<Boolean_value>,
      "agent_in_use":<Boolean_value>,
      "do_provision":<Boolean_value>,
      "autoscalegroup_config_obj":<autoscalegroup_config_value>,
      "no_of_cluster_instances":<Integer_value>}]}

delete

URL: https://<MGMT-IP>/nitro/v2/config/autoscalegroup/id_value<String>

HTTPS Method: DELETE

Request Headers:

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

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

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

get (all)

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

Query-parameters:

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

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

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

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

Use this query-parameter to get the count of autoscalegroup resources.

HTTPS Method: GET

Request Headers:

Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

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, "autoscalegroup":[{
      "drain_connection_timeout":<Integer_value>,
      "memory_max":<Double_value>,
      "status":<Boolean_value>,
      "mode":<Integer_value>,
      "auto_retry_count":<Integer_value>,
      "site_id":<String_value>,
      "no_of_cold_nodes":<Integer_value>,
      "access_profile_id":<String_value>,
      "state":<String_value>,
      "provision_profile_map":[{
      "azure_resource_group_name":<String_value>,
      "cluster_id":<String_value>,
      "provision_state":<String_value>,
      "parent_id":<String_value>,
      "last_updated_time":<Double_value>,
      "node_id":<String_value>,
      "provision_profile_id":<String_value>,
      "is_active_node_prov":<Boolean_value>,
      "id":<String_value>,
      "cluster_ip_address":<String_value>,
      "is_drain_connection_timeout_period":<Boolean_value>,
      "parent_name":<String_value>,
      "activity_id":<String_value>,
      "provision_job_id":<String_value>,
      "retry_count":<Integer_value>,
      "availability_zone":<String_value>,
      "provision_failure_timeout":<Integer_value>,
      "is_availability_set":<Boolean_value>,
      "retry_err_type":<String_value>,
      "error_message":<String_value>,
      "is_cool_down_period":<Boolean_value>
      "bandwidth_limit":<Integer_value>
      "autoscalegroup_name":<String_value>
      "az_activity_id":<String_value>}],
      "memory_min":<Double_value>,
      "min_node":<Integer_value>,
      "last_updated_time":<Double_value>,
      "cool_down_period":<Integer_value>,
      "id":<String_value>,
      "max_node":<Integer_value>,
      "ttl_timeout":<Integer_value>,
      "cloud_type":<String_value>,
      "activity_id":<String_value>,
      "cpu_threshold_enabled":<Boolean_value>,
      "throughput_min":<Double_value>,
      "name":<String_value>,
      "cpu_min":<Double_value>,
      "mem_threshold_enabled":<Boolean_value>,
      "auto_retry_interval":<Integer_value>,
      "enable_cold_node":<Boolean_value>,
      "agent_id":<String_value>,
      "throughput_max":<Double_value>,
      "cpu_max":<Double_value>,
      "watch_time":<Integer_value>,
      "throughput_threshold_enabled":<Boolean_value>,
      "site_in_use":<Boolean_value>,
      "provision_profile_obj":<autoscalegroup_profile_map_value>,
      "tags":[{
      "prop_value":<String_value>,
      "prop_key":<String_value>}],
      "force_delete":<Boolean_value>,
      "agent_in_use":<Boolean_value>,
      "do_provision":<Boolean_value>,
      "autoscalegroup_config_obj":<autoscalegroup_config_value>,
      "no_of_cluster_instances":<Integer_value>}]}

get

URL: https://<MGMT-IP>/nitro/v2/config/autoscalegroup/id_value<String>

HTTPS Method: GET

Request Headers:

Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

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, "autoscalegroup":[{
      "drain_connection_timeout":<Integer_value>,
      "memory_max":<Double_value>,
      "status":<Boolean_value>,
      "mode":<Integer_value>,
      "auto_retry_count":<Integer_value>,
      "site_id":<String_value>,
      "no_of_cold_nodes":<Integer_value>,
      "access_profile_id":<String_value>,
      "state":<String_value>,
      "provision_profile_map":[{
      "azure_resource_group_name":<String_value>,
      "cluster_id":<String_value>,
      "provision_state":<String_value>,
      "parent_id":<String_value>,
      "last_updated_time":<Double_value>,
      "node_id":<String_value>,
      "provision_profile_id":<String_value>,
      "is_active_node_prov":<Boolean_value>,
      "id":<String_value>,
      "cluster_ip_address":<String_value>,
      "is_drain_connection_timeout_period":<Boolean_value>,
      "parent_name":<String_value>,
      "activity_id":<String_value>,
      "provision_job_id":<String_value>,
      "retry_count":<Integer_value>,
      "availability_zone":<String_value>,
      "provision_failure_timeout":<Integer_value>,
      "is_availability_set":<Boolean_value>,
      "retry_err_type":<String_value>,
      "error_message":<String_value>,
      "is_cool_down_period":<Boolean_value>
      "bandwidth_limit":<Integer_value>
      "autoscalegroup_name":<String_value>
      "az_activity_id":<String_value>}],
      "memory_min":<Double_value>,
      "min_node":<Integer_value>,
      "last_updated_time":<Double_value>,
      "cool_down_period":<Integer_value>,
      "id":<String_value>,
      "max_node":<Integer_value>,
      "ttl_timeout":<Integer_value>,
      "cloud_type":<String_value>,
      "activity_id":<String_value>,
      "cpu_threshold_enabled":<Boolean_value>,
      "throughput_min":<Double_value>,
      "name":<String_value>,
      "cpu_min":<Double_value>,
      "mem_threshold_enabled":<Boolean_value>,
      "auto_retry_interval":<Integer_value>,
      "enable_cold_node":<Boolean_value>,
      "agent_id":<String_value>,
      "throughput_max":<Double_value>,
      "cpu_max":<Double_value>,
      "watch_time":<Integer_value>,
      "throughput_threshold_enabled":<Boolean_value>,
      "site_in_use":<Boolean_value>,
      "provision_profile_obj":<autoscalegroup_profile_map_value>,
      "tags":[{
      "prop_value":<String_value>,
      "prop_key":<String_value>}],
      "force_delete":<Boolean_value>,
      "agent_in_use":<Boolean_value>,
      "do_provision":<Boolean_value>,
      "autoscalegroup_config_obj":<autoscalegroup_config_value>,
      "no_of_cluster_instances":<Integer_value>}]}

update

URL: https://<MGMT-IP>/nitro/v2/config/autoscalegroup/id_value<String>

HTTPS Method: PUT

Request Headers:

Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:

{"autoscalegroup":{
<b>      "id":<String_value></b>,
      "drain_connection_timeout":<Integer_value>,
      "mode":<Integer_value>,
      "site_id":<String_value>,
      "auto_retry_count":<Integer_value>,
      "no_of_cold_nodes":<Integer_value>,
      "memory_min":<Double_value>,
      "provision_profile_map":[{
      "azure_resource_group_name":<String_value>,
      "cluster_id":<String_value>,
      "autoscalegroup_name":<String_value>,
      "parent_id":<String_value>,
      "provision_profile_id":<String_value>,
      "id":<String_value>,
      "parent_name":<String_value>,
      "activity_id":<String_value>,
      "provision_job_id":<String_value>,
      "availability_zone":<String_value>,
      "retry_err_type":<String_value>,
      "error_message":<String_value>,
      "node_id":<String_value>,
      "is_active_node_prov":<Boolean_value>,
      "is_availability_set":<Boolean_value>,
      "retry_count":<Integer_value>}],
      "throughput_min":<Double_value>,
      "activity_id":<String_value>,
      "name":<String_value>,
      "cpu_min":<Double_value>,
      "mem_threshold_enabled":<Boolean_value>,
      "auto_retry_interval":<Integer_value>,
      "watch_time":<Integer_value>,
      "cpu_max":<Double_value>,
      "memory_max":<Double_value>,
      "status":<Boolean_value>,
      "access_profile_id":<String_value>,
      "min_node":<Integer_value>,
      "cool_down_period":<Integer_value>,
      "max_node":<Integer_value>,
      "ttl_timeout":<Integer_value>,
      "cloud_type":<String_value>,
      "cpu_threshold_enabled":<Boolean_value>,
      "tags":[{
      "prop_value":<String_value>,
      "prop_key":<String_value>}],
      "enable_cold_node":<Boolean_value>,
      "throughput_max":<Double_value>,
      "agent_id":<String_value>,
      "throughput_threshold_enabled":<Boolean_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:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "autoscalegroup":[{
      "drain_connection_timeout":<Integer_value>,
      "memory_max":<Double_value>,
      "status":<Boolean_value>,
      "mode":<Integer_value>,
      "auto_retry_count":<Integer_value>,
      "site_id":<String_value>,
      "no_of_cold_nodes":<Integer_value>,
      "access_profile_id":<String_value>,
      "state":<String_value>,
      "provision_profile_map":[{
      "azure_resource_group_name":<String_value>,
      "cluster_id":<String_value>,
      "provision_state":<String_value>,
      "parent_id":<String_value>,
      "last_updated_time":<Double_value>,
      "node_id":<String_value>,
      "provision_profile_id":<String_value>,
      "is_active_node_prov":<Boolean_value>,
      "id":<String_value>,
      "cluster_ip_address":<String_value>,
      "is_drain_connection_timeout_period":<Boolean_value>,
      "parent_name":<String_value>,
      "activity_id":<String_value>,
      "provision_job_id":<String_value>,
      "retry_count":<Integer_value>,
      "availability_zone":<String_value>,
      "provision_failure_timeout":<Integer_value>,
      "is_availability_set":<Boolean_value>,
      "retry_err_type":<String_value>,
      "error_message":<String_value>,
      "is_cool_down_period":<Boolean_value>
      "bandwidth_limit":<Integer_value>
      "autoscalegroup_name":<String_value>
      "az_activity_id":<String_value>}],
      "memory_min":<Double_value>,
      "min_node":<Integer_value>,
      "last_updated_time":<Double_value>,
      "cool_down_period":<Integer_value>,
      "id":<String_value>,
      "max_node":<Integer_value>,
      "ttl_timeout":<Integer_value>,
      "cloud_type":<String_value>,
      "activity_id":<String_value>,
      "cpu_threshold_enabled":<Boolean_value>,
      "throughput_min":<Double_value>,
      "name":<String_value>,
      "cpu_min":<Double_value>,
      "mem_threshold_enabled":<Boolean_value>,
      "auto_retry_interval":<Integer_value>,
      "enable_cold_node":<Boolean_value>,
      "agent_id":<String_value>,
      "throughput_max":<Double_value>,
      "cpu_max":<Double_value>,
      "watch_time":<Integer_value>,
      "throughput_threshold_enabled":<Boolean_value>,
      "site_in_use":<Boolean_value>,
      "provision_profile_obj":<autoscalegroup_profile_map_value>,
      "tags":[{
      "prop_value":<String_value>,
      "prop_key":<String_value>}],
      "force_delete":<Boolean_value>,
      "agent_in_use":<Boolean_value>,
      "do_provision":<Boolean_value>,
      "autoscalegroup_config_obj":<autoscalegroup_config_value>,
      "no_of_cluster_instances":<Integer_value>}]}
Was this article helpful?