486 lines
14 KiB
Python
486 lines
14 KiB
Python
#!/usr/bin/python
|
|
# Copyright: 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
|
|
|
|
|
|
DOCUMENTATION = r'''
|
|
module: route53_info
|
|
short_description: Retrieves route53 details using AWS methods
|
|
version_added: 1.0.0
|
|
description:
|
|
- Gets various details related to Route53 zone, record set or health check details.
|
|
- This module was called C(route53_facts) before Ansible 2.9. The usage did not change.
|
|
options:
|
|
query:
|
|
description:
|
|
- Specifies the query action to take.
|
|
required: True
|
|
choices: [
|
|
'change',
|
|
'checker_ip_range',
|
|
'health_check',
|
|
'hosted_zone',
|
|
'record_sets',
|
|
'reusable_delegation_set',
|
|
]
|
|
type: str
|
|
change_id:
|
|
description:
|
|
- The ID of the change batch request.
|
|
- The value that you specify here is the value that
|
|
ChangeResourceRecordSets returned in the Id element
|
|
when you submitted the request.
|
|
- Required if I(query=change).
|
|
required: false
|
|
type: str
|
|
hosted_zone_id:
|
|
description:
|
|
- The Hosted Zone ID of the DNS zone.
|
|
- Required if I(query) is set to I(hosted_zone) and I(hosted_zone_method) is set to I(details).
|
|
- Required if I(query) is set to I(record_sets).
|
|
required: false
|
|
type: str
|
|
max_items:
|
|
description:
|
|
- Maximum number of items to return for various get/list requests.
|
|
required: false
|
|
type: str
|
|
next_marker:
|
|
description:
|
|
- "Some requests such as list_command: hosted_zones will return a maximum
|
|
number of entries - EG 100 or the number specified by I(max_items).
|
|
If the number of entries exceeds this maximum another request can be sent
|
|
using the NextMarker entry from the first response to get the next page
|
|
of results."
|
|
required: false
|
|
type: str
|
|
delegation_set_id:
|
|
description:
|
|
- The DNS Zone delegation set ID.
|
|
required: false
|
|
type: str
|
|
start_record_name:
|
|
description:
|
|
- "The first name in the lexicographic ordering of domain names that you want
|
|
the list_command: record_sets to start listing from."
|
|
required: false
|
|
type: str
|
|
type:
|
|
description:
|
|
- The type of DNS record.
|
|
required: false
|
|
choices: [ 'A', 'CNAME', 'MX', 'AAAA', 'TXT', 'PTR', 'SRV', 'SPF', 'CAA', 'NS' ]
|
|
type: str
|
|
dns_name:
|
|
description:
|
|
- The first name in the lexicographic ordering of domain names that you want
|
|
the list_command to start listing from.
|
|
required: false
|
|
type: str
|
|
resource_id:
|
|
description:
|
|
- The ID/s of the specified resource/s.
|
|
- Required if I(query=health_check) and I(health_check_method=tags).
|
|
- Required if I(query=hosted_zone) and I(hosted_zone_method=tags).
|
|
required: false
|
|
aliases: ['resource_ids']
|
|
type: list
|
|
elements: str
|
|
health_check_id:
|
|
description:
|
|
- The ID of the health check.
|
|
- Required if C(query) is set to C(health_check) and
|
|
C(health_check_method) is set to C(details) or C(status) or C(failure_reason).
|
|
required: false
|
|
type: str
|
|
hosted_zone_method:
|
|
description:
|
|
- "This is used in conjunction with query: hosted_zone.
|
|
It allows for listing details, counts or tags of various
|
|
hosted zone details."
|
|
required: false
|
|
choices: [
|
|
'details',
|
|
'list',
|
|
'list_by_name',
|
|
'count',
|
|
'tags',
|
|
]
|
|
default: 'list'
|
|
type: str
|
|
health_check_method:
|
|
description:
|
|
- "This is used in conjunction with query: health_check.
|
|
It allows for listing details, counts or tags of various
|
|
health check details."
|
|
required: false
|
|
choices: [
|
|
'list',
|
|
'details',
|
|
'status',
|
|
'failure_reason',
|
|
'count',
|
|
'tags',
|
|
]
|
|
default: 'list'
|
|
type: str
|
|
author: Karen Cheng (@Etherdaemon)
|
|
extends_documentation_fragment:
|
|
- amazon.aws.aws
|
|
- amazon.aws.ec2
|
|
|
|
'''
|
|
|
|
EXAMPLES = r'''
|
|
# Simple example of listing all hosted zones
|
|
- name: List all hosted zones
|
|
community.aws.route53_info:
|
|
query: hosted_zone
|
|
register: hosted_zones
|
|
|
|
# Getting a count of hosted zones
|
|
- name: Return a count of all hosted zones
|
|
community.aws.route53_info:
|
|
query: hosted_zone
|
|
hosted_zone_method: count
|
|
register: hosted_zone_count
|
|
|
|
- name: List the first 20 resource record sets in a given hosted zone
|
|
community.aws.route53_info:
|
|
profile: account_name
|
|
query: record_sets
|
|
hosted_zone_id: ZZZ1111112222
|
|
max_items: 20
|
|
register: record_sets
|
|
|
|
- name: List first 20 health checks
|
|
community.aws.route53_info:
|
|
query: health_check
|
|
health_check_method: list
|
|
max_items: 20
|
|
register: health_checks
|
|
|
|
- name: Get health check last failure_reason
|
|
community.aws.route53_info:
|
|
query: health_check
|
|
health_check_method: failure_reason
|
|
health_check_id: 00000000-1111-2222-3333-12345678abcd
|
|
register: health_check_failure_reason
|
|
|
|
- name: Retrieve reusable delegation set details
|
|
community.aws.route53_info:
|
|
query: reusable_delegation_set
|
|
delegation_set_id: delegation id
|
|
register: delegation_sets
|
|
|
|
- name: setup of example for using next_marker
|
|
community.aws.route53_info:
|
|
query: hosted_zone
|
|
max_items: 1
|
|
register: first_info
|
|
|
|
- name: example for using next_marker
|
|
community.aws.route53_info:
|
|
query: hosted_zone
|
|
next_marker: "{{ first_info.NextMarker }}"
|
|
max_items: 1
|
|
when: "{{ 'NextMarker' in first_info }}"
|
|
|
|
- name: retrieve host entries starting with host1.workshop.test.io
|
|
block:
|
|
- name: grab zone id
|
|
community.aws.route53_zone:
|
|
zone: "test.io"
|
|
register: AWSINFO
|
|
|
|
- name: grab Route53 record information
|
|
community.aws.route53_info:
|
|
type: A
|
|
query: record_sets
|
|
hosted_zone_id: "{{ AWSINFO.zone_id }}"
|
|
start_record_name: "host1.workshop.test.io"
|
|
register: RECORDS
|
|
'''
|
|
|
|
try:
|
|
import botocore
|
|
except ImportError:
|
|
pass # Handled by AnsibleAWSModule
|
|
|
|
from ansible.module_utils._text import to_native
|
|
|
|
from ansible_collections.amazon.aws.plugins.module_utils.core import AnsibleAWSModule
|
|
|
|
|
|
def get_hosted_zone(client, module):
|
|
params = dict()
|
|
|
|
if module.params.get('hosted_zone_id'):
|
|
params['Id'] = module.params.get('hosted_zone_id')
|
|
else:
|
|
module.fail_json(msg="Hosted Zone Id is required")
|
|
|
|
return client.get_hosted_zone(**params)
|
|
|
|
|
|
def reusable_delegation_set_details(client, module):
|
|
params = dict()
|
|
if not module.params.get('delegation_set_id'):
|
|
if module.params.get('max_items'):
|
|
params['MaxItems'] = module.params.get('max_items')
|
|
|
|
if module.params.get('next_marker'):
|
|
params['Marker'] = module.params.get('next_marker')
|
|
|
|
results = client.list_reusable_delegation_sets(**params)
|
|
else:
|
|
params['DelegationSetId'] = module.params.get('delegation_set_id')
|
|
results = client.get_reusable_delegation_set(**params)
|
|
|
|
return results
|
|
|
|
|
|
def list_hosted_zones(client, module):
|
|
params = dict()
|
|
|
|
if module.params.get('max_items'):
|
|
params['MaxItems'] = module.params.get('max_items')
|
|
|
|
if module.params.get('next_marker'):
|
|
params['Marker'] = module.params.get('next_marker')
|
|
|
|
if module.params.get('delegation_set_id'):
|
|
params['DelegationSetId'] = module.params.get('delegation_set_id')
|
|
|
|
paginator = client.get_paginator('list_hosted_zones')
|
|
zones = paginator.paginate(**params).build_full_result()['HostedZones']
|
|
return {
|
|
"HostedZones": zones,
|
|
"list": zones,
|
|
}
|
|
|
|
|
|
def list_hosted_zones_by_name(client, module):
|
|
params = dict()
|
|
|
|
if module.params.get('hosted_zone_id'):
|
|
params['HostedZoneId'] = module.params.get('hosted_zone_id')
|
|
|
|
if module.params.get('dns_name'):
|
|
params['DNSName'] = module.params.get('dns_name')
|
|
|
|
if module.params.get('max_items'):
|
|
params['MaxItems'] = module.params.get('max_items')
|
|
|
|
return client.list_hosted_zones_by_name(**params)
|
|
|
|
|
|
def change_details(client, module):
|
|
params = dict()
|
|
|
|
if module.params.get('change_id'):
|
|
params['Id'] = module.params.get('change_id')
|
|
else:
|
|
module.fail_json(msg="change_id is required")
|
|
|
|
results = client.get_change(**params)
|
|
return results
|
|
|
|
|
|
def checker_ip_range_details(client, module):
|
|
return client.get_checker_ip_ranges()
|
|
|
|
|
|
def get_count(client, module):
|
|
if module.params.get('query') == 'health_check':
|
|
results = client.get_health_check_count()
|
|
else:
|
|
results = client.get_hosted_zone_count()
|
|
|
|
return results
|
|
|
|
|
|
def get_health_check(client, module):
|
|
params = dict()
|
|
|
|
if not module.params.get('health_check_id'):
|
|
module.fail_json(msg="health_check_id is required")
|
|
else:
|
|
params['HealthCheckId'] = module.params.get('health_check_id')
|
|
|
|
if module.params.get('health_check_method') == 'details':
|
|
results = client.get_health_check(**params)
|
|
elif module.params.get('health_check_method') == 'failure_reason':
|
|
results = client.get_health_check_last_failure_reason(**params)
|
|
elif module.params.get('health_check_method') == 'status':
|
|
results = client.get_health_check_status(**params)
|
|
|
|
return results
|
|
|
|
|
|
def get_resource_tags(client, module):
|
|
params = dict()
|
|
|
|
if module.params.get('resource_id'):
|
|
params['ResourceIds'] = module.params.get('resource_id')
|
|
else:
|
|
module.fail_json(msg="resource_id or resource_ids is required")
|
|
|
|
if module.params.get('query') == 'health_check':
|
|
params['ResourceType'] = 'healthcheck'
|
|
else:
|
|
params['ResourceType'] = 'hostedzone'
|
|
|
|
return client.list_tags_for_resources(**params)
|
|
|
|
|
|
def list_health_checks(client, module):
|
|
params = dict()
|
|
|
|
if module.params.get('max_items'):
|
|
params['MaxItems'] = module.params.get('max_items')
|
|
|
|
if module.params.get('next_marker'):
|
|
params['Marker'] = module.params.get('next_marker')
|
|
|
|
paginator = client.get_paginator('list_health_checks')
|
|
health_checks = paginator.paginate(**params).build_full_result()['HealthChecks']
|
|
return {
|
|
"HealthChecks": health_checks,
|
|
"list": health_checks,
|
|
}
|
|
|
|
|
|
def record_sets_details(client, module):
|
|
params = dict()
|
|
|
|
if module.params.get('hosted_zone_id'):
|
|
params['HostedZoneId'] = module.params.get('hosted_zone_id')
|
|
else:
|
|
module.fail_json(msg="Hosted Zone Id is required")
|
|
|
|
if module.params.get('max_items'):
|
|
params['MaxItems'] = module.params.get('max_items')
|
|
|
|
if module.params.get('start_record_name'):
|
|
params['StartRecordName'] = module.params.get('start_record_name')
|
|
|
|
if module.params.get('type') and not module.params.get('start_record_name'):
|
|
module.fail_json(msg="start_record_name must be specified if type is set")
|
|
elif module.params.get('type'):
|
|
params['StartRecordType'] = module.params.get('type')
|
|
|
|
paginator = client.get_paginator('list_resource_record_sets')
|
|
record_sets = paginator.paginate(**params).build_full_result()['ResourceRecordSets']
|
|
return {
|
|
"ResourceRecordSets": record_sets,
|
|
"list": record_sets,
|
|
}
|
|
|
|
|
|
def health_check_details(client, module):
|
|
health_check_invocations = {
|
|
'list': list_health_checks,
|
|
'details': get_health_check,
|
|
'status': get_health_check,
|
|
'failure_reason': get_health_check,
|
|
'count': get_count,
|
|
'tags': get_resource_tags,
|
|
}
|
|
|
|
results = health_check_invocations[module.params.get('health_check_method')](client, module)
|
|
return results
|
|
|
|
|
|
def hosted_zone_details(client, module):
|
|
hosted_zone_invocations = {
|
|
'details': get_hosted_zone,
|
|
'list': list_hosted_zones,
|
|
'list_by_name': list_hosted_zones_by_name,
|
|
'count': get_count,
|
|
'tags': get_resource_tags,
|
|
}
|
|
|
|
results = hosted_zone_invocations[module.params.get('hosted_zone_method')](client, module)
|
|
return results
|
|
|
|
|
|
def main():
|
|
argument_spec = dict(
|
|
query=dict(choices=[
|
|
'change',
|
|
'checker_ip_range',
|
|
'health_check',
|
|
'hosted_zone',
|
|
'record_sets',
|
|
'reusable_delegation_set',
|
|
], required=True),
|
|
change_id=dict(),
|
|
hosted_zone_id=dict(),
|
|
max_items=dict(),
|
|
next_marker=dict(),
|
|
delegation_set_id=dict(),
|
|
start_record_name=dict(),
|
|
type=dict(choices=[
|
|
'A', 'CNAME', 'MX', 'AAAA', 'TXT', 'PTR', 'SRV', 'SPF', 'CAA', 'NS'
|
|
]),
|
|
dns_name=dict(),
|
|
resource_id=dict(type='list', aliases=['resource_ids'], elements='str'),
|
|
health_check_id=dict(),
|
|
hosted_zone_method=dict(choices=[
|
|
'details',
|
|
'list',
|
|
'list_by_name',
|
|
'count',
|
|
'tags'
|
|
], default='list'),
|
|
health_check_method=dict(choices=[
|
|
'list',
|
|
'details',
|
|
'status',
|
|
'failure_reason',
|
|
'count',
|
|
'tags',
|
|
], default='list'),
|
|
)
|
|
|
|
module = AnsibleAWSModule(
|
|
argument_spec=argument_spec,
|
|
supports_check_mode=True,
|
|
mutually_exclusive=[
|
|
['hosted_zone_method', 'health_check_method'],
|
|
],
|
|
check_boto3=False,
|
|
)
|
|
if module._name == 'route53_facts':
|
|
module.deprecate("The 'route53_facts' module has been renamed to 'route53_info'", date='2021-12-01', collection_name='community.aws')
|
|
|
|
try:
|
|
route53 = module.client('route53')
|
|
except (botocore.exceptions.ClientError, botocore.exceptions.BotoCoreError) as e:
|
|
module.fail_json_aws(e, msg='Failed to connect to AWS')
|
|
|
|
invocations = {
|
|
'change': change_details,
|
|
'checker_ip_range': checker_ip_range_details,
|
|
'health_check': health_check_details,
|
|
'hosted_zone': hosted_zone_details,
|
|
'record_sets': record_sets_details,
|
|
'reusable_delegation_set': reusable_delegation_set_details,
|
|
}
|
|
|
|
results = dict(changed=False)
|
|
try:
|
|
results = invocations[module.params.get('query')](route53, module)
|
|
except (botocore.exceptions.ClientError, botocore.exceptions.BotoCoreError) as e:
|
|
module.fail_json(msg=to_native(e))
|
|
|
|
module.exit_json(**results)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|