AutoScaling service (AS)¶

The AS client is the command-line interface (CLI) for the AutoScaling service (AS) API and its extensions.

For help on a specific as command, enter:

$ openstack as help SUBCOMMAND

Group operations¶

as group create¶

Creates AutoScalinig group

openstack as group create
    [--desire-instance-number <desire_instance_number>]
    [--min-instance-number <min_instance_number>]
    [--max-instance-number <max_instance_number>]
    [--cool-down-time <cool_down_time>]
    [--lb-listener-id <lb_listener_id>]
    [--lbaas-listener <lbaas_listener>]
    [--availability-zone <availability_zone>]
    --network-id <network_id>
    [--security-group <security_group>]
    --router-id <router_id>
    [--audit-method <audit_method>]
    [--audit-time <audit_time>]
    [--terminate-policy <terminate_policy>]
    [--notification <notification>]
    [--delete-public-ip]
    <name>

--desire-instance-number <desire_instance_number>¶: Desired number of instances

--min-instance-number <min_instance_number>¶: Minimal number of instances

--max-instance-number <max_instance_number>¶: Maximal number of instances

--cool-down-time <cool_down_time>¶: Specifies cooling duration in seconds

--lb-listener-id <lb_listener_id>¶: Specifies ELB Listener ID

--lbaas-listener <lbaas_listener>¶: Specifies ULB Listener Information in format: ID:PORT:Weight(optional) (Repeat multiple times, up to 3 times)

--availability-zone <availability_zone>¶: Specifies the availability zones information (Repeat multiple times)

--network-id <network_id>¶: Network ID of the subnet(Repeat multiple times, up to 5 times)

--security-group <security_group>¶: Security Group ID(Repeat multiple times)

--router-id <router_id>¶: Router (VPC) ID

--audit-method <audit_method>¶: Specifies the audit method [NOVA_AUDIT, ELB_AUDIT]

--audit-time <audit_time>¶: Specifies the audit time in minutes

--terminate-policy <terminate_policy>¶: Specifies the termination policy [OLD_CONFIG_OLD_INSTANCE (default), OLD_CONFIG_NEW_INSTANCE, OLD_INSTANCE, NEW_INSTANCE]

--notification <notification>¶: Specifies the notification method (EMAIL for Email) (Repeat multiple times)

--delete-public-ip¶: Specifies whether to delete EIP when deleting the ECS

name¶: Name of the new configuration group

This command is provided by the otcextensions plugin.

as group delete¶

Deletes AutoScalinig group

openstack as group delete <group>

group¶: ID or name of the configuration group to be deleted

This command is provided by the otcextensions plugin.

as group disable¶

Disable/pause AutoScalinig group

openstack as group disable <group>

group¶: ID or name of the configuration group

This command is provided by the otcextensions plugin.

as group enable¶

Enable/resume AutoScalinig group

openstack as group enable <group>

group¶: ID or name of the configuration group

This command is provided by the otcextensions plugin.

as group list¶

List AutoScaling Groups

openstack as group list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--name <name>]
    [--limit <limit>]
    [--marker <ID>]
    [--scaling-configuration-id <scaling_configuration_id>]
    [--status <status>]

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

--name <name>¶: Name or ID of the AS group

--limit <limit>¶: Limit the number of results displayed

--marker <ID>¶: Begin displaying the results for IDs greater than the specified marker. When used with –limit, set this to the last ID displayed in the previous run

--scaling-configuration-id <scaling_configuration_id>¶: ID of the AS configuration

--status <status>¶: Shows AS groups with specific status: <INSERVICE>: AS group is working <PAUSED>: AS group is paused <ERROR>: AS group has malfunctions <DELETING>: AS group is being deleted

This command is provided by the otcextensions plugin.

as group show¶

Shows details of a AutoScalinig group

openstack as group show <group>

group¶: ID or name of the configuration group

This command is provided by the otcextensions plugin.

as group update¶

Updates AutoScalinig group

openstack as group update
    [--desire-instance-number <desire_instance_number>]
    [--min-instance-number <min_instance_number>]
    [--max-instance-number <max_instance_number>]
    [--cool-down-time <cool_down_time>]
    [--lb-listener-id <lb_listener_id>]
    [--lbaas-listener <lbaas_listener>]
    [--availability-zone <availability_zone>]
    [--network-id <network_id>]
    [--security-group <security_group>]
    [--router-id <router_id>]
    [--audit-method <audit_method>]
    [--audit-time <audit_time>]
    [--terminate-policy <terminate_policy>]
    [--notification <notification>]
    [--delete-public-ip]
    <group>

--desire-instance-number <desire_instance_number>¶: Desired number of instances

--min-instance-number <min_instance_number>¶: Minimal number of instances

--max-instance-number <max_instance_number>¶: Maximal number of instances

--cool-down-time <cool_down_time>¶: Specifies cooling duration in seconds

--lb-listener-id <lb_listener_id>¶: Specifies ELB Listener ID

--lbaas-listener <lbaas_listener>¶: Specifies ULB Listener Information in format: ID:PORT:Weight(optional) (Repeat multiple times, up to 3 times)

--availability-zone <availability_zone>¶: Specifies the availability zones information (Repeat multiple times)

--network-id <network_id>¶: Network ID of the subnet(Repeat multiple times, up to 5 times)

--security-group <security_group>¶: Security Group ID(Repeat multiple times)

--router-id <router_id>¶: Router (VPC) ID

--audit-method <audit_method>¶: Specifies the audit method [NOVA_AUDIT, ELB_AUDIT]

--audit-time <audit_time>¶: Specifies the audit time in minutes

--terminate-policy <terminate_policy>¶: Specifies the termination policy [OLD_CONFIG_OLD_INSTANCE (default), OLD_CONFIG_NEW_INSTANCE, OLD_INSTANCE, NEW_INSTANCE]

--notification <notification>¶: Specifies the notification method (EMAIL for Email) (Repeat multiple times)

--delete-public-ip¶: Specifies whether to delete EIP when deleting the ECS

group¶: AS Group name or ID

This command is provided by the otcextensions plugin.

Config operations¶

as config create¶

Creates AutoScalinig group

openstack as config create
    [--flavor <flavor>]
    [--image-id <image_id>]
    [--instance-id <instance_id>]
    [--disk <disk>]
    [--key <key>]
    [--public-ip-bandwith <public_ip_bandwith>]
    [--user-data <user_data>]
    [--metadata <metadata>]
    <name>

--flavor <flavor>¶: Flavor ID or Name for the ECS instance

--image-id <image_id>¶: Image ID for the ECS instance to be created

--instance-id <instance_id>¶: AS Configuration name Is mutually exclusive with ECS group

--disk <disk>¶: Disk information to attach to the instance. format = DISK_TYPE,`VOLUME_TYPE`,`SIZE` DISK_TYPE can be in [SYS, DATA] and identifies whether disk should be a system or data disk VOLUME_TYPE can be in: * SATA = Common I/O * SAS = High I/O * SSD = Ultra-High I/O SIZE is size in Gb (Repeat multiple times for multiple disks)

--key <key>¶: Key name for the new ECS instance

--public-ip-bandwith <public_ip_bandwith>¶: Defines EIP Bandwith (Mbit/s) to be attached to the new ECS instance

--user-data <user_data>¶: Path to the cloud-init user_data file

--metadata <metadata>¶: User defined key=value pair format KEY=VALUE Cannot contain dot (.) or start with $

name¶: AS Configuration name

This command is provided by the otcextensions plugin.

as config delete¶

Deletes AutoScalinig group

openstack as config delete <config> [<config> ...]

config¶: AS Configuration ID

This command is provided by the otcextensions plugin.

as config list¶

List AutoScaling Configurations

openstack as config list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--limit <limit>]
    [--marker <ID>]

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

--limit <limit>¶: Limit the number of results displayed

--marker <ID>¶: Begin displaying the results for IDs greater than the specified marker. When used with –limit, set this to the last ID displayed in the previous run

This command is provided by the otcextensions plugin.

as config show¶

Shows details of a AutoScalinig group

openstack as config show <config>

config¶: ID or name of the configuration group

This command is provided by the otcextensions plugin.

Policy operations¶

as policy create¶

Creates AutoScalinig Policy

openstack as policy create
    --group <group>
    --type <type>
    [--cool-down-time <cool_down_time>]
    [--alarm-id <alarm_id>]
    [--action-operation <action_operation>]
    [--action-instance-number <action_instance_number>]
    [--launch-time <launch_time>]
    [--recurrence-type <recurrence_type>]
    [--recurrence-value <recurrence_value>]
    [--start-time <start_time>]
    [--end-time <end_time>]
    <name>

--group <group>¶: AS Group ID or Name for the AS Policy

--type <type>¶: AS Policy type [ALARM, SCHEDULED, RECURRENCE]

--cool-down-time <cool_down_time>¶: Specifies the cooling time in seconds for the policy

--alarm-id <alarm_id>¶: Specifies the alarm_id for the policy

--action-operation <action_operation>¶: Specifies the policy operation Can be [ADD, REMOVE, SET]

--action-instance-number <action_instance_number>¶: Specifies number of instances to be operated

--launch-time <launch_time>¶: Specifies the time when the scaling action is triggered. The time format must comply with UTC. * when type=`SCHEDULED`, then YYYY-MM-DDThh:mmZ * when type=`RECURRENCE`, then hh:mm

--recurrence-type <recurrence_type>¶: Specifies the periodic triggering type This parameter is mandatory when type=`RECURRENCE` Can be [Daily, Weekly, Monthly]

--recurrence-value <recurrence_value>¶: Specifies the frequency, at which actions are triggered When recurrente_type=`Daily` it is Null When recurrente_type=`Weekly` it’s a week day number [1..7], where 1 is for Sunday When recurrente_type=`Monthly` it’s a day number [1..31]

--start-time <start_time>¶: Specifies the start time in of the action in the YYYY-MM-DDThh:mmZ format

--end-time <end_time>¶: Specifies the end time in of the action in the YYYY-MM-DDThh:mmZ format Mandatory when type=`RECURRENCE`

name¶: AS Policy name

This command is provided by the otcextensions plugin.

as policy delete¶

Deletes AutoScalinig policy

openstack as policy delete <policy> [<policy> ...]

policy¶: AS Policy ID

This command is provided by the otcextensions plugin.

as policy disable¶

Disables (pause) AutoScalinig policy

openstack as policy disable <policy>

policy¶: AS Policy ID

This command is provided by the otcextensions plugin.

as policy enable¶

Enables (resume) AutoScalinig policy

openstack as policy enable <policy>

policy¶: AS Policy ID

This command is provided by the otcextensions plugin.

as policy execute¶

Executes AutoScalinig policy

openstack as policy execute <policy>

policy¶: AS Policy ID or name

This command is provided by the otcextensions plugin.

as policy list¶

List AutoScaling Policies

openstack as policy list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--limit <limit>]
    [--marker <ID>]
    --group <group>

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

--limit <limit>¶: Limit the number of results displayed

--marker <ID>¶: Begin displaying the results for IDs greater than the specified marker. When used with –limit, set this to the last ID displayed in the previous run

--group <group>¶: ScalingGroup ID or Name

This command is provided by the otcextensions plugin.

as policy show¶

Shows details of a AutoScalinig policy

openstack as policy show [--group <group>] <policy>

--group <group>¶: ScalingGroup ID or Name if Name searched is used

policy¶: ID of the configuration policy For Policy Name search –group param is needed

This command is provided by the otcextensions plugin.

as policy update¶

Updates AutoScalinig Policy

openstack as policy update
    --group <group>
    [--type <type>]
    [--cool-down-time <cool_down_time>]
    [--alarm-id <alarm_id>]
    [--action-operation <action_operation>]
    [--action-instance-number <action_instance_number>]
    [--launch-time <launch_time>]
    [--recurrence-type <recurrence_type>]
    [--recurrence-value <recurrence_value>]
    [--start-time <start_time>]
    [--end-time <end_time>]
    <policy>

--group <group>¶: AS Group ID or Name for the AS Policy

--type <type>¶: AS Policy type [ALARM, SCHEDULED, RECURRENCE]

--cool-down-time <cool_down_time>¶: Specifies the cooling time in seconds for the policy

--alarm-id <alarm_id>¶: Specifies the alarm_id for the policy

--action-operation <action_operation>¶: Specifies the policy operation Can be [ADD, REMOVE, SET]

--action-instance-number <action_instance_number>¶: Specifies number of instances to be operated

--launch-time <launch_time>¶: Specifies the time when the scaling action is triggered. The time format must comply with UTC. * when type=`SCHEDULED`, then YYYY-MM-DDThh:mmZ * when type=`RECURRENCE`, then hh:mm

--recurrence-type <recurrence_type>¶: Specifies the periodic triggering type This parameter is mandatory when type=`RECURRENCE` Can be [Daily, Weekly, Monthly]

--recurrence-value <recurrence_value>¶: Specifies the frequency, at which actions are triggered When recurrente_type=`Daily` it is Null When recurrente_type=`Weekly` it is a week day number [1..7], where 1 is for Sunday When recurrente_type=`Monthly` it is a day number [1..31]

--start-time <start_time>¶: Specifies the start time in of the action in the YYYY-MM-DDThh:mmZ format

--end-time <end_time>¶: Specifies the end time in of the action in the YYYY-MM-DDThh:mmZ format Mandatory when type=`RECURRENCE`

policy¶: AS Policy ID

This command is provided by the otcextensions plugin.

Instance operations¶

as instance batch¶

Executes Action on AutoScalinig Instances

openstack as instance batch
    --group <group>
    [--delete-instance]
    <action>
    <instance>
    [<instance> ...]

--group <group>¶: AS Group ID or Name

--delete-instance¶: Specifies, whether instance should be completely deleted when action is REMOVE

action¶: Action to be performed One of [ADD, REMOVE, PROTECT, UNPROTECT]

instance¶: AS Instance ID to be deleted

This command is provided by the otcextensions plugin.

as instance list¶

List AutoScaling Instances

openstack as instance list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    --group <group>
    [--life-cycle-state <life_cycle_state>]
    [--health-status <health_status>]
    [--limit <limit>]

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

--group <group>¶: AS Group ID or Name for the instances query

--life-cycle-state <life_cycle_state>¶: Life cycle state of the instances to query Could be in [INSERVICE, PENDING, REMOVING]

--health-status <health_status>¶: Health status of the instances to query Could be in [INITIALIZING, NORMAL, ERROR]

--limit <limit>¶: Limit the number of results displayed

This command is provided by the otcextensions plugin.

as instance remove¶

Removes AutoScalinig Instances

openstack as instance remove [--delete-instance] <instance>

--delete-instance¶: Specifies, whether instance should be completely deleted

instance¶: AS Instance ID to be deleted

This command is provided by the otcextensions plugin.

Activity Logs operations¶

as activity list¶

List AutoScaling Activity Logs

openstack as activity list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    --group <group>
    [--start-time <start_time>]
    [--end-time <end_time>]
    [--limit <limit>]

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

--group <group>¶: AS Group ID or name

--start-time <start_time>¶: Specifies the start time for querying scaling action logs. Format: YYYY-MM-DDThh:mm:ssZ

--end-time <end_time>¶: Specifies the end time for querying scaling action logs. Format: YYYY-MM-DDThh:mm:ssZ

--limit <limit>¶: Specifies the batch size of the records for pagination

This command is provided by the otcextensions plugin.

Quota operations¶

as quota list¶

List AutoScaling Instances

openstack as quota list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--group <group>]

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

--group <group>¶: AS Group ID or Name for the Quota query

This command is provided by the otcextensions plugin.

last updated: 2023-06-12 09:35