Try SpotterQuery AS policies based on search criteria.
| "added in version" 0.6.0 of opentelekomcloud.cloud"
Authors: Irina Pereiaslavskaia (@irina-pereiaslavskaia)
Install with ansible-galaxy collection install opentelekomcloud.cloud:==0.14.2
collections:
- name: opentelekomcloud.cloud
version: 0.14.2This interface is used to query AS policies based on search criteria.
# Get Auto Scaling Policies
- opentelekomcloud.cloud.as_policy_info:
scaling_group: "89af599d-a8ab-4c29-a063-0b719ed77e8e"
register: as_policies
# Get Auto Scaling Policies
- opentelekomcloud.cloud.as_policy_info:
scaling_group: "test_group"
scaling_policy: "test_name"
scaling_policy_type: "alarm"
start_number: 2
limit: 20
register: as_policies
# Get Auto Scaling Policies
- opentelekomcloud.cloud.as_policy_info:
scaling_group: "89af599d-a8ab-4c29-a063-0b719ed77e8e"
scaling_policy: "c3e1c13e-a5e5-428e-a8bc-6c5fc0f4b3f5"
scaling_policy_type: "alarm"
start_number: 2
limit: 20
register: as_policies
auth:
description:
- Dictionary containing auth information as needed by the cloud's auth plugin strategy.
For the default I(password) plugin, this would contain I(auth_url), I(username),
I(password), I(project_name) and any information about domains (for example, I(os_user_domain_name)
or I(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.
type: dict
wait:
default: true
description:
- Should ansible wait until the requested resource is complete.
type: bool
cloud:
description:
- Named cloud or cloud config to operate against. If I(cloud) is a string, it references
a named cloud config as defined in an OpenStack clouds.yaml file. Provides default
values for I(auth) and I(auth_type). This parameter is not needed if I(auth) is
provided or if OpenStack OS_* environment variables are present. If I(cloud) is
a dict, it contains a complete cloud configuration like would be in a section of
clouds.yaml.
type: raw
limit:
default: 20
description: Specifies the number of query records.
type: int
ca_cert:
aliases:
- cacert
description:
- A path to a CA Cert bundle that can be used as part of verifying SSL API requests.
type: str
timeout:
default: 180
description:
- How long should ansible wait for the requested resource.
type: int
auth_type:
description:
- 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 I(auth) parameter should be updated accordingly.
type: str
interface:
aliases:
- endpoint_type
choices:
- admin
- internal
- public
default: public
description:
- Endpoint URL type to fetch from the service catalog.
type: str
client_key:
aliases:
- key
description:
- A path to a client key to use as part of the SSL transaction.
type: str
api_timeout:
description:
- 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.
type: int
client_cert:
aliases:
- cert
description:
- A path to a client certificate to use as part of the SSL transaction.
type: str
region_name:
description:
- Name of the region.
type: str
sdk_log_path:
description:
- Path to the logfile of the OpenStackSDK. If empty no log is written
type: str
start_number:
default: 0
description: Specifies the start line number.
type: int
scaling_group:
description: Specifies the AS group name or ID.
required: true
type: str
sdk_log_level:
choices:
- ERROR
- WARN
- INFO
- DEBUG
default: WARN
description: Log level of the OpenStackSDK
type: str
scaling_policy:
description: Specifies the AS policy name or ID.
type: str
validate_certs:
aliases:
- verify
description:
- Whether or not SSL API requests should be verified.
- Before Ansible 2.3 this defaulted to C(yes).
type: bool
scaling_policy_type:
choices:
- alarm
- scheduled
- recurrence
description: Specifies the AS policy type.
type: str
as_policies:
contains:
limit:
description: Specifies the maximum number of resources to be queried.
sample: 20
type: int
scaling_policies:
contains:
alarm_id:
description: Specifies the alarm ID.
sample: al16117680339426q5qYw5gZ
type: str
cool_down_time:
description: Specifies the cooldown period.
sample: 300
type: int
create_time:
description: Specifies the time when an AS policy was created.
sample: 2015-07-24T01:21Z
type: str
policy_status:
description: Specifies the AS policy status.
sample: INSERVICE
type: str
scaling_group_id:
description: Specifies the AS group ID.
sample: e5d27f5c-dd76-4a61-b4bc-a67c5686719a
type: str
scaling_policy_action:
contains:
instance_number:
description: The number of instances to be operated.
sample: 1
type: int
instance_percentage:
description: The percentage of instances to be operated.
type: int
operation:
description: Specifies the scaling action.
sample: ADD
type: str
description: Specifies the scaling action of the AS policy.
returned: success
type: complex
scaling_policy_id:
description: Specifies the AS policy ID.
sample: fd7d63ce-8f5c-443e-b9a0-bef9386b23b3
type: str
scaling_policy_name:
description: Specifies the AS policy name.
sample: as-policy-test
type: str
scaling_policy_type:
description: Specifies the AS policy type.
sample: SCHEDULED
type: str
scheduled_policy:
contains:
end_time:
description: The end time of the scaling action triggered.
sample: 2015-07-24T01:21Z
type: str
launch_time:
description: The time when the scaling action is triggered.
sample: 2015-07-24T01:21Z
type: str
recurrence_type:
description: The type of a periodically triggered scaling action.
sample: Daily
type: str
recurrence_value:
description: The frequency at which scaling actions are triggered.
type: str
start_time:
description: The start time of the scaling action triggered.
sample: 2015-07-24T01:21Z
type: str
description: Specifies the periodic or scheduled AS policy.
returned: success
type: complex
description: Specifies scaling policies.
returned: success
type: complex
start_number:
description: Specifies the start line number.
sample: 0
type: int
total_number:
description: Specifies the total number of query records.
sample: 1
type: int
description: Query AS policies based on search criteria.
returned: success
type: complex