| Parameter |
Choices/Defaults |
Comments |
|
alarm
string
|
|
Specifies the periodic or scheduled AS policy.
This parameter is mandatory when scaling_policy_type is set to ALARM.
|
|
api_timeout
integer
|
|
How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library.
|
|
auth
dictionary
|
|
Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth_url, username, password, project_name and any information about domains (for example, os_user_domain_name or os_project_domain_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS_* environment variables are present.
|
|
auth_type
string
|
|
Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly.
|
|
ca_cert
string
|
|
A path to a CA Cert bundle that can be used as part of verifying SSL API requests.
aliases: cacert
|
|
client_cert
string
|
|
A path to a client certificate to use as part of the SSL transaction.
aliases: cert
|
|
client_key
string
|
|
A path to a client key to use as part of the SSL transaction.
aliases: key
|
|
cloud
raw
|
|
Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth_type. This parameter is not needed if auth is provided or if OpenStack OS_* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml.
|
|
cool_down_time
integer
|
Default:
300
|
Specifies the cooldown period (in seconds).
The value ranges from 0 to 86400
|
|
interface
string
|
Choices:
- admin
- internal
public ←
|
Endpoint URL type to fetch from the service catalog.
aliases: endpoint_type
|
|
region_name
string
|
|
Name of the region.
|
|
scaling_group
string
|
|
Name or ID of the AS group.
|
|
scaling_policy
string
/ required
|
|
Specifies the AS policy name or ID.
Max name length is 64 characters.
Name can contains only letters, digits, underscores, hyphens
|
|
scaling_policy_action
dictionary
|
|
Specifies the scaling action of the AS policy.
|
|
instance_number
integer
|
Default:
1
|
Specifies the number of instances to be operated.
The default number is 1.
Either instance_number or instance_percentage is required.
If operation is set to SET, the value range is 0 to 200.
If operation is set to ADD, REMOVE or REDUCE, the value range is 1 to 200.
|
|
instance_percentage
integer
|
|
Specifies the percentage of instances to be operated.
If operation is set to ADD, REMOVE or REDUCE, the value of this parameter is an integer from 1 to 20000.
If operation is set to SET, the value is an integer from 0 to 20000.
Either instance_number or instance_percentage is required.
If neither instance_number nor instance_percentage is specified, the number of instances to be operated is 1.
|
|
operation
string
|
Choices:
add ← - remove
- reduce
- set
|
Specifies the operation to be performed.
The default operation is ADD.
|
|
scaling_policy_type
string
|
Choices:
- alarm
- scheduled
- recurrence
|
Specifies the AS policy type
|
|
scheduled_policy
dictionary
|
|
Specifies the periodic or scheduled AS policy.
This parameter is mandatory when scaling_policy_type is set to SCHEDULED or RECURRENCE.
|
|
end_time
string
|
|
Specifies the end time of the scaling action triggered periodically.
The end time cannot be earlier than the current and start time.
The time format complies with UTC.
The time format is YYYY-MM-DDThh:mmZ.
|
|
launch_time
string
|
|
Specifies the time when the scaling action is triggered.
The time format complies with UTC.
If scaling_policy_type is set to SCHEDULED, the time format is YYYY-MM-DDThh:mmZ.
If scaling_policy_type is set to RECURRENCE, the time format is hh:mm.
|
|
recurrence_type
string
|
Choices:
- daily
- weekly
- monthly
|
Specifies the periodic triggering type.
This parameter is mandatory when scaling_policy_type is set to RECURRENCE.
|
|
recurrence_value
string
|
|
Specifies the day when a periodic scaling action is triggered.
This parameter is mandatory when scaling_policy_type is set to RECURRENCE.
If recurrence_type is set to "Daily", the value is null, indicating that the scaling action is triggered once a day.
If recurrence_type is set to Weekly, the value ranges from 1 (Sunday) to 7 (Saturday). The digits refer to dates in each week and separated by a comma, such as 1,3,5.
If recurrence_type is set to Monthly, the value ranges from 1 to 31. The digits refer to the dates in each month and separated by a comma, such as 1,10,13,28.
|
|
start_time
string
|
|
Specifies the start time of the scaling action triggered periodically.
The time format complies with UTC.
The default value is the local time.
The time format is YYYY-MM-DDThh:mmZ.
|
|
state
string
|
Choices:
present ← - absent
|
Whether resource should be present or absent.
|
|
timeout
integer
|
Default:
180
|
How long should ansible wait for the requested resource.
|
|
validate_certs
boolean
|
|
Whether or not SSL API requests should be verified.
Before Ansible 2.3 this defaulted to yes.
aliases: verify
|
|
wait
boolean
|
|
Should ansible wait until the requested resource is complete.
|