opentelekomcloud.cloud.as_policy_info module – Query AS policies based on search criteria.

Note

This module is part of the opentelekomcloud.cloud collection (version 0.11.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install opentelekomcloud.cloud.

To use it in a playbook, specify: opentelekomcloud.cloud.as_policy_info.

New in version 0.6.0: of opentelekomcloud.cloud

Synopsis

• This interface is used to query AS policies based on search criteria.

Requirements

The below requirements are needed on the host that executes this module.

• python >= 3.6

• openstacksdk >= 0.36.0

Parameters

Parameter	Comments
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 aliases: cacert string	A path to a CA Cert bundle that can be used as part of verifying SSL API requests.
client_cert aliases: cert string	A path to a client certificate to use as part of the SSL transaction.
client_key aliases: key string	A path to a client key to use as part of the SSL transaction.
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.
interface aliases: endpoint_type string	Endpoint URL type to fetch from the service catalog. Choices: admin internal public ← (default)
limit integer	Specifies the number of query records. Default: 20
region_name string	Name of the region.
scaling_group string / required	Specifies the AS group name or ID.
scaling_policy string	Specifies the AS policy name or ID.
scaling_policy_type string	Specifies the AS policy type. Choices: alarm scheduled recurrence
start_number integer	Specifies the start line number. Default: 0
timeout integer	How long should ansible wait for the requested resource. Default: 180
validate_certs aliases: verify boolean	Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to yes. Choices: no ← (default) yes
wait boolean	Should ansible wait until the requested resource is complete. Choices: no yes ← (default)

Notes

Note

• The standard OpenStack environment variables, such as OS_USERNAME may be used instead of providing explicit values.

• Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at https://docs.openstack.org/openstacksdk/

Examples

# 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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
as_policies complex	Query AS policies based on search criteria. Returned: success
limit integer	Specifies the maximum number of resources to be queried. Returned: success Sample: 20
scaling_policies complex	Specifies scaling policies. Returned: success
alarm_id string	Specifies the alarm ID. Returned: success Sample: “al16117680339426q5qYw5gZ”
cool_down_time integer	Specifies the cooldown period. Returned: success Sample: 300
create_time string	Specifies the time when an AS policy was created. Returned: success Sample: “2015-07-24T01:21Z”
policy_status string	Specifies the AS policy status. Returned: success Sample: “INSERVICE”
scaling_group_id string	Specifies the AS group ID. Returned: success Sample: “e5d27f5c-dd76-4a61-b4bc-a67c5686719a”
scaling_policy_action complex	Specifies the scaling action of the AS policy. Returned: success
instance_number integer	The number of instances to be operated. Returned: success Sample: 1
instance_percentage integer	The percentage of instances to be operated. Returned: success
operation string	Specifies the scaling action. Returned: success Sample: “ADD”
scaling_policy_id string	Specifies the AS policy ID. Returned: success Sample: “fd7d63ce-8f5c-443e-b9a0-bef9386b23b3”
scaling_policy_name string	Specifies the AS policy name. Returned: success Sample: “as-policy-test”
scaling_policy_type string	Specifies the AS policy type. Returned: success Sample: “SCHEDULED”
scheduled_policy complex	Specifies the periodic or scheduled AS policy. Returned: success
end_time string	The end time of the scaling action triggered. Returned: success Sample: “2015-07-24T01:21Z”
launch_time string	The time when the scaling action is triggered. Returned: success Sample: “2015-07-24T01:21Z”
recurrence_type string	The type of a periodically triggered scaling action. Returned: success Sample: “Daily”
recurrence_value string	The frequency at which scaling actions are triggered. Returned: success
start_time string	The start time of the scaling action triggered. Returned: success Sample: “2015-07-24T01:21Z”
start_number integer	Specifies the start line number. Returned: success Sample: 0
total_number integer	Specifies the total number of query records. Returned: success Sample: 1

Authors

• Irina Pereiaslavskaia (@irina-pereiaslavskaia)

Whats next

• opentelekomcloud.cloud.as_quota_info module – Get information about auto scaling quotas

last updated: 2022-02-25 12:26