a862ff2d43
* Allow to specify collection_name separately for deprecation. * Use new functionality in Ansible. * Use new functionality in tests. * Update tagging/untagging functions. * Update pylint deprecated sanity test. * Update validate-modules. Missing are basic checks for version_added (validate semantic version format for collections). * Improve version validation. Re-add version_added validation. * Make sure collection names are added to return docs before schema validation. * Extra checks to avoid crashes on bad data. * Make C# module utils code work, and update/extend tests. * Add changelog fragment. * Stop extracting collection name from potentially tagged versions/dates. * Simplify C# code. * Update Windows modules docs. * Forgot semicolons.
111 lines
3.5 KiB
Python
111 lines
3.5 KiB
Python
#!/usr/bin/python
|
|
# Copyright (c) 2017 Ansible Project
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
|
|
from __future__ import (absolute_import, division, print_function)
|
|
__metaclass__ = type
|
|
|
|
ANSIBLE_METADATA = {
|
|
'metadata_version': '1.1',
|
|
'supported_by': 'community',
|
|
'status': ['preview']
|
|
}
|
|
|
|
DOCUMENTATION = '''
|
|
module: aws_az_info
|
|
short_description: Gather information about availability zones in AWS.
|
|
description:
|
|
- Gather information about availability zones in AWS.
|
|
- This module was called C(aws_az_facts) before Ansible 2.9. The usage did not change.
|
|
version_added: '2.5'
|
|
author: 'Henrique Rodrigues (@Sodki)'
|
|
options:
|
|
filters:
|
|
description:
|
|
- A dict of filters to apply. Each dict item consists of a filter key and a filter value. See
|
|
U(https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAvailabilityZones.html) for
|
|
possible filters. Filter names and values are case sensitive. You can also use underscores
|
|
instead of dashes (-) in the filter keys, which will take precedence in case of conflict.
|
|
required: false
|
|
default: {}
|
|
type: dict
|
|
extends_documentation_fragment:
|
|
- aws
|
|
- ec2
|
|
requirements: [botocore, boto3]
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
# Note: These examples do not set authentication details, see the AWS Guide for details.
|
|
|
|
# Gather information about all availability zones
|
|
- aws_az_info:
|
|
|
|
# Gather information about a single availability zone
|
|
- aws_az_info:
|
|
filters:
|
|
zone-name: eu-west-1a
|
|
'''
|
|
|
|
RETURN = '''
|
|
availability_zones:
|
|
returned: on success
|
|
description: >
|
|
Availability zones that match the provided filters. Each element consists of a dict with all the information
|
|
related to that available zone.
|
|
type: list
|
|
sample: "[
|
|
{
|
|
'messages': [],
|
|
'region_name': 'us-west-1',
|
|
'state': 'available',
|
|
'zone_name': 'us-west-1b'
|
|
},
|
|
{
|
|
'messages': [],
|
|
'region_name': 'us-west-1',
|
|
'state': 'available',
|
|
'zone_name': 'us-west-1c'
|
|
}
|
|
]"
|
|
'''
|
|
|
|
from ansible.module_utils.aws.core import AnsibleAWSModule
|
|
from ansible.module_utils.ec2 import AWSRetry, ansible_dict_to_boto3_filter_list, camel_dict_to_snake_dict
|
|
|
|
try:
|
|
from botocore.exceptions import ClientError, BotoCoreError
|
|
except ImportError:
|
|
pass # Handled by AnsibleAWSModule
|
|
|
|
|
|
def main():
|
|
argument_spec = dict(
|
|
filters=dict(default={}, type='dict')
|
|
)
|
|
|
|
module = AnsibleAWSModule(argument_spec=argument_spec)
|
|
if module._name == 'aws_az_facts':
|
|
module.deprecate("The 'aws_az_facts' module has been renamed to 'aws_az_info'",
|
|
version='2.14', collection_name='ansible.builtin')
|
|
|
|
connection = module.client('ec2', retry_decorator=AWSRetry.jittered_backoff())
|
|
|
|
# Replace filter key underscores with dashes, for compatibility
|
|
sanitized_filters = dict((k.replace('_', '-'), v) for k, v in module.params.get('filters').items())
|
|
|
|
try:
|
|
availability_zones = connection.describe_availability_zones(
|
|
Filters=ansible_dict_to_boto3_filter_list(sanitized_filters)
|
|
)
|
|
except (BotoCoreError, ClientError) as e:
|
|
module.fail_json_aws(e, msg="Unable to describe availability zones.")
|
|
|
|
# Turn the boto3 result into ansible_friendly_snaked_names
|
|
snaked_availability_zones = [camel_dict_to_snake_dict(az) for az in availability_zones['AvailabilityZones']]
|
|
|
|
module.exit_json(availability_zones=snaked_availability_zones)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|