autoscaling-groups¶
autoscaling-groups config list¶
Usage
usage: -c autoscaling-groups config list [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
Description
List all autoscaling groups configuration values.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
autoscaling-groups group create¶
Usage
usage: -c autoscaling-groups group create [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
[--desired-capacity DESIRED_CAPACITY]
[--default-cooldown DEFAULT_COOLDOWN]
[--target-group-ids [TARGET_GROUP_IDS [TARGET_GROUP_IDS ...]]]
[--description DESCRIPTION]
[--health-check-grace-period HEALTH_CHECK_GRACE_PERIOD]
[--health-check-type HEALTH_CHECK_TYPE]
[--new-instances-protected-from-scale-in]
[--termination-policies [TERMINATION_POLICIES [TERMINATION_POLICIES ...]]]
[--placement-policy PLACEMENT_POLICY]
[--subnets [SUBNETS [SUBNETS ...]]]
[--service-linked-role SERVICE_LINKED_ROLE]
[--tags [TAGS [TAGS ...]]]
[--propagated-tags [PROPAGATED_TAGS [PROPAGATED_TAGS ...]]]
name launch_configuration_id
min_size max_size
Description
Creates a new autoscaling group.
Return
Returns dict: Details of the autoscaling group
Optional
optional arguments:
-h, --help show this help message and exit
--desired-capacity DESIRED_CAPACITY
Desired capacity of the autoscaling group; if autoscaling is defined, this is the initial size of the autoscaling group
--default-cooldown DEFAULT_COOLDOWN
Minimum cooldown (interval) for scaling operations in the autoscaling group
--target-group-ids [TARGET_GROUP_IDS [TARGET_GROUP_IDS ...]]
The IDs of the target groups for your load balancer
--description DESCRIPTION
Description of the autoscaling group
--health-check-grace-period HEALTH_CHECK_GRACE_PERIOD
The amount of time, in seconds, before the service starts before checking the health status of an instance that has come into service
--health-check-type HEALTH_CHECK_TYPE
The service to use for the health checks. The valid values are load_balancer or vm_monitor (the default)
--new-instances-protected-from-scale-in
Indicates whether newly launched instances are protected from termination by auto-scaling when scaling in
--termination-policies [TERMINATION_POLICIES [TERMINATION_POLICIES ...]]
The termination policies for the group
--placement-policy PLACEMENT_POLICY
The ID of a policy that controls the instance placement on physical servers
--subnets [SUBNETS [SUBNETS ...]]
One or more subnet IDs
--service-linked-role SERVICE_LINKED_ROLE
The identifier of the service-linked role that the autoscaling group uses to call other Symphony services on your behalf
--tags [TAGS [TAGS ...]]
Tags to be associated with the group, supports JSON format per tag - '{"key": "key1", "value": "value1"}'
--propagated-tags [PROPAGATED_TAGS [PROPAGATED_TAGS ...]]
Tags to be associated with the group, supports JSON format per tag - '{"key": "key1", "value": "value1"}'. These tags are also propagated to the instances created by the group
autoscaling-groups group delete¶
Usage
usage: -c autoscaling-groups group delete [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--force]
group_id
Description
Deletes a single autoscaling group based on the ID supplied.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--force Force the deletion of all related instances if set to true
autoscaling-groups group get¶
Usage
usage: -c autoscaling-groups group get [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
group_id
Description
Returns an autoscaling group based on the ID supplied.
Return
Returns dict: Autoscaling group
Optional
optional arguments:
-h, --help show this help message and exit
autoscaling-groups group list¶
Usage
usage: -c autoscaling-groups group list [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--names [NAMES [NAMES ...]]]
[--describe-instances]
[--tags [TAGS [TAGS ...]]]
[--tag-keys [TAG_KEYS [TAG_KEYS ...]]]
[--tag-values [TAG_VALUES [TAG_VALUES ...]]]
Description
Returns all autoscaling groups.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--names [NAMES [NAMES ...]]
A list of autoscaling group names to return
--describe-instances If true, list instances in each group rather than just their number
--tags [TAGS [TAGS ...]]
Filter by the group tags, JSON format '{"key": "key1", "value": ["value1", "value2"]}'
--tag-keys [TAG_KEYS [TAG_KEYS ...]]
Filter by the tag keys of the group, format ["key1", "key2, key3", "key4"]
--tag-values [TAG_VALUES [TAG_VALUES ...]]
Filter by the tag values of the group, format ["value1, value2", "value3", "value4"]
autoscaling-groups group update¶
Usage
usage: -c autoscaling-groups group update [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--name NAME]
[--desired-capacity DESIRED_CAPACITY]
[--launch-configuration-id LAUNCH_CONFIGURATION_ID]
[--min-size MIN_SIZE]
[--max-size MAX_SIZE]
[--default-cooldown DEFAULT_COOLDOWN]
[--target-group-ids [TARGET_GROUP_IDS [TARGET_GROUP_IDS ...]]]
[--description DESCRIPTION]
[--health-check-grace-period HEALTH_CHECK_GRACE_PERIOD]
[--health-check-type HEALTH_CHECK_TYPE]
[--new-instances-protected-from-scale-in NEW_INSTANCES_PROTECTED_FROM_SCALE_IN]
[--termination-policies [TERMINATION_POLICIES [TERMINATION_POLICIES ...]]]
[--placement-policy PLACEMENT_POLICY]
[--subnets [SUBNETS [SUBNETS ...]]]
[--service-linked-role SERVICE_LINKED_ROLE]
group_id
Description
Updates an autoscaling group.
Return
Returns dict: Details of the autoscaling group
Optional
optional arguments:
-h, --help show this help message and exit
--name NAME Name of the autoscaling group
--desired-capacity DESIRED_CAPACITY
Desired capacity of the autoscaling group
--launch-configuration-id LAUNCH_CONFIGURATION_ID
Launch configuration to use when starting new VMs
--min-size MIN_SIZE Minimal size of the autoscaling group
--max-size MAX_SIZE Maximal size of the autoscaling group
--default-cooldown DEFAULT_COOLDOWN
Minimum cooldown (interval) for scaling operations in the autoscaling group
--target-group-ids [TARGET_GROUP_IDS [TARGET_GROUP_IDS ...]]
The IDs of the target groups for your load balancer
--description DESCRIPTION
Description of the autoscaling group
--health-check-grace-period HEALTH_CHECK_GRACE_PERIOD
The amount of time, in seconds, before the service starts before checking the health status of an instance that has come into service
--health-check-type HEALTH_CHECK_TYPE
The service to use for the health checks. The valid values are vm_monitor or load_balancer
--new-instances-protected-from-scale-in NEW_INSTANCES_PROTECTED_FROM_SCALE_IN
Indicates whether newly launched instances are protected from termination by auto-scaling when scaling in
--termination-policies [TERMINATION_POLICIES [TERMINATION_POLICIES ...]]
The termination policies for the group
--placement-policy PLACEMENT_POLICY
The ID of a policy that controls the instance placement on physical servers
--subnets [SUBNETS [SUBNETS ...]]
One or more subnet IDs
--service-linked-role SERVICE_LINKED_ROLE
The identifier of the service-linked role that the autoscaling group uses to call other Symphony services on your behalf
autoscaling-groups health get¶
Usage
usage: -c autoscaling-groups health get [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
Description
Returns the health status.
Return
Returns dict: Health status
Optional
optional arguments:
-h, --help show this help message and exit
autoscaling-groups instance attach¶
Usage
usage: -c autoscaling-groups instance attach [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
group_id --instance_ids
[--instance_ids ...]
Description
Attaches one or more instances to the specified auto-scaling group. When you attach instances, the desired capacity of the group is increased by the number of instances being attached.
Return
Returns dict: A list of instance IDs that were successfully attached and a list of instance IDs that were unsuccessfully attached
Optional
optional arguments:
-h, --help show this help message and exit
autoscaling-groups instance detach¶
Usage
usage: -c autoscaling-groups instance detach [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--decrement-desired-capacity]
group_id --instance_ids
[--instance_ids ...]
Description
Detaches one or more instances from the specified auto-scaling group. After the instances are detached, you can manage them independently of the auto-scaling group.
Return
Returns dict: A list of instance IDs that were successfully detached and a list of instance IDs that were unsuccessfully detached
Optional
optional arguments:
-h, --help show this help message and exit
--decrement-desired-capacity
If true, the auto-scaling group decrements the desired capacity value by the number of instances detached
autoscaling-groups instance enter-standby¶
Usage
usage: -c autoscaling-groups instance enter-standby [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
[--decrement-desired-capacity]
group_id --instance_ids
[--instance_ids ...]
Description
Moves the specified instances into the standby state.
Return
Returns dict: A list of instance IDs that were successfully entered into the standby state and a list of instance IDs that were unsuccessfully entered into the standby state
Optional
optional arguments:
-h, --help show this help message and exit
--decrement-desired-capacity
If true, the auto-scaling group decrements the desired capacity value by the number of instances moved into the standby state
autoscaling-groups instance exit-standby¶
Usage
usage: -c autoscaling-groups instance exit-standby [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
group_id --instance_ids
[--instance_ids ...]
Description
Moves the specified instances out of the standby state. Auto-scaling increments the desired capacity when you put an instance that was on standby back in service. If you did not decrement the capacity when you put the instance on standby, auto-scaling detects that you have more instances than you need, and applies the termination policy in effect to reduce the size of your auto-scaling group.
Return
Returns dict: A list of instance IDs that were successfully detached and a list of instance IDs that were unsuccessfully detached
Optional
optional arguments:
-h, --help show this help message and exit
autoscaling-groups launch-configuration create¶
Usage
usage: -c autoscaling-groups launch-configuration create [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
[--image-id IMAGE_ID]
[--instance-type INSTANCE_TYPE]
[--key-pair KEY_PAIR]
[--user-data USER_DATA]
[--description DESCRIPTION]
[--security-groups [SECURITY_GROUPS [SECURITY_GROUPS ...]]]
[--bdm BDM]
name
Description
Creates a new launch configuration object.
Return
Returns dict: Details of the launch configuration
Optional
optional arguments:
-h, --help show this help message and exit
--image-id IMAGE_ID ID of an image to launch new VMs with
--instance-type INSTANCE_TYPE
Instance type of VMs in the autoscaling group
--key-pair KEY_PAIR Name of key pair to attach to new VMs in the autoscaling group
--user-data USER_DATA
Path to file that includes cloud-init script to be used upon launch of new VMs in the autoscaling group
--description DESCRIPTION
A description for the launch configuration
--security-groups [SECURITY_GROUPS [SECURITY_GROUPS ...]]
The security groups to associate with the instances
--bdm BDM A list of block device mappings for the VM.
Each of the items in the list is a dictionary with optional keys 'snapshot_id',
'boot_index', 'volume_size_gib', 'storage_pool', 'disk_type' and 'bus_type'.
If 'boot_index' is specified, then 'disk_type' and 'bus_type' must be specified as well.
The values of 'boot_index' in the BDM, if specified, must be sequential and start with 0
(although they do not need to be ordered this way in the input). 'disk_type', if specified,
must be either 'disk' or 'cdrom'. 'bus_type', if specified, must be either
'ide' or 'virtio'. If not specified, the defaults are 'disk' and 'virtio'.
Example:
[{"snapshot_id":"ca166313-7050-42d6-87da-7e3e70f611e6","boot_index":0,"disk_type":"disk","bus_type":"ide"},
{"snapshot_id":"9a7fed24-b69a-43dc-85ab-21b318c685ac"}]
autoscaling-groups launch-configuration delete¶
Usage
usage: -c autoscaling-groups launch-configuration delete [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
launch_configuration_id
Description
Deletes a single launch configuration object based on the ID supplied.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
autoscaling-groups launch-configuration get¶
Usage
usage: -c autoscaling-groups launch-configuration get [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
launch_configuration_id
Description
Returns a launch configuration based on the ID supplied.
Return
Returns dict: Launch Configuration
Optional
optional arguments:
-h, --help show this help message and exit
autoscaling-groups launch-configuration list¶
Usage
usage: -c autoscaling-groups launch-configuration list [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--names [NAMES [NAMES ...]]]
Description
Returns all launch configurations.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--names [NAMES [NAMES ...]]
A list of launch configuration names to return
autoscaling-groups launch-configuration update¶
Usage
usage: -c autoscaling-groups launch-configuration update [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
[--name NAME]
[--description DESCRIPTION]
launch_configuration_id
Description
Updates launch configuration object.
Return
Returns dict: Details of the launch configuration
Optional
optional arguments:
-h, --help show this help message and exit
--name NAME A new name for the launch configuration
--description DESCRIPTION
A new description for the launch configuration
autoscaling-groups scaling-policy create¶
Usage
usage: -c autoscaling-groups scaling-policy create [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
[--estimated-warmup ESTIMATED_WARMUP]
[--disable-scale-in DISABLE_SCALE_IN]
name group_id metric_type
target_value
Description
Creates a new scaling policy or updates an existing one.
Return
Returns dict: Details of the scaling policy
Optional
optional arguments:
-h, --help show this help message and exit
--estimated-warmup ESTIMATED_WARMUP
The estimated time, in seconds, until a newly launched instance can contribute to meter alarms
--disable-scale-in DISABLE_SCALE_IN
Indicates whether scale in by the target tracking policy is disabled
autoscaling-groups scaling-policy delete¶
Usage
usage: -c autoscaling-groups scaling-policy delete [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
policy_id
Description
Deletes a scaling policy.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
autoscaling-groups scaling-policy list¶
Usage
usage: -c autoscaling-groups scaling-policy list [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--group-id GROUP_ID]
[--policy-names [POLICY_NAMES [POLICY_NAMES ...]]]
[--policy-types [POLICY_TYPES [POLICY_TYPES ...]]]
Description
List the auto-scaling policies.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--group-id GROUP_ID ID of the autoscaling group for the scaling policy
--policy-names [POLICY_NAMES [POLICY_NAMES ...]]
The names of the policies that should be returned
--policy-types [POLICY_TYPES [POLICY_TYPES ...]]
The types of the policies that should be returned
autoscaling-groups scaling-policy update¶
Usage
usage: -c autoscaling-groups scaling-policy update [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
[--estimated-warmup ESTIMATED_WARMUP]
[--disable-scale-in DISABLE_SCALE_IN]
[--metric-type METRIC_TYPE]
[--target-value TARGET_VALUE]
policy_id
Description
Updates an existing scaling policy.
Return
Returns dict: Details of the scaling policy
Optional
optional arguments:
-h, --help show this help message and exit
--estimated-warmup ESTIMATED_WARMUP
The estimated time, in seconds, until a newly launched instance can contribute to meter alarms
--disable-scale-in DISABLE_SCALE_IN
Indicates whether scale in by the target tracking policy is disabled
--metric-type METRIC_TYPE
A predefined metric type
--target-value TARGET_VALUE
The target value for the metric
autoscaling-groups scheduled-actions delete¶
Usage
usage: -c autoscaling-groups scheduled-actions delete [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
group_id name
Description
Deletes a scheduled action from an auto-scaling group.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
autoscaling-groups scheduled-actions list¶
Usage
usage: -c autoscaling-groups scheduled-actions list [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--group-id GROUP_ID]
[--names [NAMES [NAMES ...]]]
[--start-time START_TIME]
[--end-time END_TIME]
Description
List scheduled actions for an autoscaling group.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--group-id GROUP_ID ID of the autoscaling group to list scheduled actions of
--names [NAMES [NAMES ...]]
Names of scheduled action to list
--start-time START_TIME
The earliest scheduled start time to return. If scheduled action names are provided, this parameter is ignored. Format: YYYY-MM-DDThh:mm:ssZ" in UTC/GMT only
--end-time END_TIME The latest scheduled start time to return. If scheduled action names are provided, this parameter is ignored. Format: YYYY-MM-DDThh:mm:ssZ" in UTC/GMT only
autoscaling-groups scheduled-actions put¶
Usage
usage: -c autoscaling-groups scheduled-actions put [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
[--start-time START_TIME]
[--end-time END_TIME]
[--recurrence RECURRENCE]
[--desired-capacity DESIRED_CAPACITY]
[--min-size MIN_SIZE]
[--max-size MAX_SIZE]
group_id name
Description
Creates or updates a scheduled action for an autoscaling group.
Return
Returns dict: Details of new scheduled action
Optional
optional arguments:
-h, --help show this help message and exit
--start-time START_TIME
The time for action to start, in the format YYYY-MM-DDThh:mm:ssZ" in UTC/GMT only
--end-time END_TIME The time for action to end in the format YYYY-MM-DDThh:mm:ssZ" in UTC/GMT only
--recurrence RECURRENCE
The recurring schedule for this action, in Unix cron syntax format
--desired-capacity DESIRED_CAPACITY
The new desired capacity of the autoscaling group
--min-size MIN_SIZE The new minimum size of the autoscaling group
--max-size MAX_SIZE The new maximum size of the autoscaling group
autoscaling-groups target-group attach¶
Usage
usage: -c autoscaling-groups target-group attach [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
group_id --target_group_ids
[--target_group_ids ...]
Description
Attaches one or more target group to the specified auto-scaling group.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
autoscaling-groups target-group detach¶
Usage
usage: -c autoscaling-groups target-group detach [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
group_id --target_group_ids
[--target_group_ids ...]
Description
Detaches one or more target group from the specified auto-scaling group.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
autoscaling-groups termination-policy-type list¶
Usage
usage: -c autoscaling-groups termination-policy-type list [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
Description
Describes the termination policies supported for scale-in of a group.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit