as_policy_info

updated: None

as_policy_info

Note

This plugin is part of the opentelekomcloud.cloud collection (version 0.0.1).

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 Choices/Defaults 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
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.
interface
string
    Choices:
  • admin
  • internal
  • public ←
Endpoint URL type to fetch from the service catalog.

aliases: endpoint_type
limit
integer
Default:
20
Specifies the number of query records.
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
    Choices:
  • alarm
  • scheduled
  • recurrence
Specifies the AS policy type.
start_number
integer
Default:
0
Specifies the start line number.
timeout
integer
Default:
180
How long should ansible wait for the requested resource.
validate_certs
boolean
    Choices:
  • no ←
  • yes
Whether or not SSL API requests should be verified.
Before Ansible 2.3 this defaulted to yes.

aliases: verify
wait
boolean
    Choices:
  • no
  • yes ←
Should ansible wait until the requested resource is complete.

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 Returned Description
as_policies
complex
success
Query AS policies based on search criteria.
 
limit
integer
success
Specifies the maximum number of resources to be queried.

Sample:
20
 
scaling_policies
complex
success
Specifies scaling policies.
   
alarm_id
string
success
Specifies the alarm ID.

Sample:
al16117680339426q5qYw5gZ
   
cool_down_time
integer
success
Specifies the cooldown period.

Sample:
300
   
create_time
string
success
Specifies the time when an AS policy was created.

Sample:
2015-07-24T01:21Z
   
policy_status
string
success
Specifies the AS policy status.

Sample:
INSERVICE
   
scaling_group_id
string
success
Specifies the AS group ID.

Sample:
e5d27f5c-dd76-4a61-b4bc-a67c5686719a
   
scaling_policy_action
complex
success
Specifies the scaling action of the AS policy.
     
instance_number
integer
success
The number of instances to be operated.

Sample:
1
     
instance_percentage
integer
success
The percentage of instances to be operated.
     
operation
string
success
Specifies the scaling action.

Sample:
ADD
   
scaling_policy_id
string
success
Specifies the AS policy ID.

Sample:
fd7d63ce-8f5c-443e-b9a0-bef9386b23b3
   
scaling_policy_name
string
success
Specifies the AS policy name.

Sample:
as-policy-test
   
scaling_policy_type
string
success
Specifies the AS policy type.

Sample:
SCHEDULED
   
scheduled_policy
complex
success
Specifies the periodic or scheduled AS policy.
     
end_time
string
success
The end time of the scaling action triggered.

Sample:
2015-07-24T01:21Z
     
launch_time
string
success
The time when the scaling action is triggered.

Sample:
2015-07-24T01:21Z
     
recurrence_type
string
success
The type of a periodically triggered scaling action.

Sample:
Daily
     
recurrence_value
string
success
The frequency at which scaling actions are triggered.
     
start_time
string
success
The start time of the scaling action triggered.

Sample:
2015-07-24T01:21Z
 
start_number
integer
success
Specifies the start line number.
 
total_number
integer
success
Specifies the total number of query records.

Sample:
1


Authors

  • Irina Pereiaslavskaia (@irina-pereiaslavskaia)

updated: None