autoscalegroup

Configuration for Autoscale Group details resource.

Read/write properties

memory_min<Double>

Minimum Memory Threshold Limit.
Minimum value = 1
Maximum value =

access_profile_id<String>

The access profile id.
Maximum length = 128

cpu_threshold_enabled<Boolean>

Status of CPU Threshold Config.

cloud_type<String>

Type of cloud (AWS/Azure).
Maximum length = 64

status<Boolean>

Status of Auto-Scale Group (Enable/Disable).

activity_id<String>

Most recent activity_id of this autoscalegroup.
Maximum length = 128

cool_down_period<Integer>

Cool Down Period (Waiting time in minutes after triggering scale up/down before initiating next provisioning/de-provisioing.
Minimum value = 1
Maximum value =

throughput_min<Double>

Minimum Throughput Threshold Limit.
Minimum value = 1
Maximum value =

site_id<String>

site.
Maximum length = 128

no_of_cold_nodes<Integer>

No of cold node supported per AutoscaleGroup.
Minimum value = 1
Maximum value =

min_node<Integer>

Minimum number of nodes.
Minimum value = 1
Maximum value =

watch_time<Integer>

Watch Time (No of intervels before triggering auto scale up/down).
Minimum value = 1
Maximum value =

drain_connection_timeout<Integer>

Drain Connection Timeout in minutes.
Minimum value = 1
Maximum value =

mode<Integer>

Mode (1.DNS/2.NLB/3.ALB/4.GLB).
Minimum value = 1
Maximum value =

memory_max<Double>

Maximum Memory Threshold Limit.
Minimum value = 1
Maximum value =

cpu_max<Double>

Maximum CPU Threshold Limit.
Minimum value = 1
Maximum value =

auto_retry_count<Integer>

Max auto retry count for retryable errors in an ASG..
Maximum value =

ttl_timeout<Integer>

TTL Timeout in seconds.
Minimum value = 1
Maximum value =

enable_cold_node<Boolean>

Enable/Disable Autoscale cold node support.

id<String>

Id is system generated key for all the auto-scale groups.

throughput_threshold_enabled<Boolean>

Status of Throughput Threshold Config.

cpu_min<Double>

Minimum CPU Threshold Limit.
Minimum value = 1
Maximum value =

throughput_max<Double>

Maximum Throughput Threshold Limit.
Minimum value = 1
Maximum value =

mem_threshold_enabled<Boolean>

Status of Memory Threshold Config.

is_autoupgrade_enabled<Boolean>

Enabled when autoupgrade for autoscalegroup is in progress..

agent_id<String>

The ID of Agent.
Maximum length = 128

provision_profile_map<autoscalegroup_profile_map[]>

Provision profile map for Availability Zone.

max_node<Integer>

Maximum number of nodes.
Minimum value = 1
Maximum value =

name<String>

Auto-Scale Group Name.
Minimum length = 1
Maximum length = 40

auto_retry_interval<Integer>

Delay between two auto retries in minutes..
Minimum value = 3
Maximum value =

tags<property_map[]>

Array of tag_name and tag_value pair associated with the autoscalegroup.

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

add delete update get (all)get

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>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:JSON

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

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "autoscalegroup":[{
      "memory_min":<Double_value>,
      "access_profile_id":<String_value>,
      "cpu_threshold_enabled":<Boolean_value>,
      "cloud_type":<String_value>,
      "status":<Boolean_value>,
      "activity_id":<String_value>,
      "cool_down_period":<Integer_value>,
      "throughput_min":<Double_value>,
      "site_id":<String_value>,
      "no_of_cold_nodes":<Integer_value>,
      "min_node":<Integer_value>,
      "dummy_ip":<String_value>,
      "watch_time":<Integer_value>,
      "drain_connection_timeout":<Integer_value>,
      "do_create_ipset":<Boolean_value>,
      "mode":<Integer_value>,
      "last_updated_time":<Double_value>,
      "memory_max":<Double_value>,
      "cpu_max":<Double_value>,
      "auto_retry_count":<Integer_value>,
      "ttl_timeout":<Integer_value>,
      "enable_cold_node":<Boolean_value>,
      "is_ipset_created":<Boolean_value>,
      "id":<String_value>,
      "throughput_threshold_enabled":<Boolean_value>,
      "cpu_min":<Double_value>,
      "throughput_max":<Double_value>,
      "customer_name":<String_value>,
      "mem_threshold_enabled":<Boolean_value>,
      "is_autoupgrade_enabled":<Boolean_value>,
      "agent_id":<String_value>,
      "state":<String_value>,
      "provision_profile_map":[{
      "node_count":<Integer_value>,
      "is_availability_set":<Boolean_value>,
      "is_active_node_prov":<Boolean_value>,
      "az_version":<String_value>,
      "az_type":<Integer_value>,
      "provision_state":<String_value>,
      "cluster_ip_address":<String_value>,
      "availability_zone":<String_value>,
      "bandwidth_limit":<Integer_value>,
      "id":<String_value>,
      "is_cool_down_period":<Boolean_value>,
      "provision_job_id":<String_value>,
      "retry_err_type":<String_value>,
      "provision_request_id":<String_value>,
      "error_message":<String_value>,
      "parent_name":<String_value>,
      "retry_count":<Integer_value>,
      "last_updated_time":<Double_value>,
      "parent_id":<String_value>,
      "node_id":<String_value>,
      "is_drain_connection_timeout_period":<Boolean_value>,
      "provision_failure_timeout":<Integer_value>,
      "activity_id":<String_value>,
      "provision_profile_id":<String_value>,
      "cluster_id":<String_value>,
      "azure_resource_group_name":<String_value>
      "delay":<Integer_value>
      "recreate_cluster":<Boolean_value>
      "autoscalegroup_name":<String_value>
      "az_activity_id":<String_value>
      "error_type":<Integer_value>
      "is_auto_upgrade":<Boolean_value>
      "is_graceful_delete":<Boolean_value>
      "force_delete":<Boolean_value>}],
      "max_node":<Integer_value>,
      "name":<String_value>,
      "auto_retry_interval":<Integer_value>,
      "site_in_use":<Boolean_value>,
      "tags":[{
      "prop_value":<String_value>,
      "prop_key":<String_value>}],
      "force_delete":<Boolean_value>,
      "do_provision":<Boolean_value>,
      "agent_in_use":<Boolean_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>

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

{ "errorcode": 0, "message": "Done", "severity": <String_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>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:JSON

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

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>

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

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>

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