mirror of https://github.com/ansible/ansible.git
Merge pull request #2209 from brandond/new-module-ec2_vpc_nacl_facts
New module ec2_vpc_nacl_factsreviewable/pr18780/r1
Ryan Brown
9 years ago
committed by
GitHub
commit
00b8b96906
@ -0,0 +1,201 @@
|
||||
#!/usr/bin/python
|
||||
# This file is part of Ansible
|
||||
#
|
||||
# Ansible is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# Ansible is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: ec2_vpc_nacl_facts
|
||||
short_description: Gather facts about Network ACLs in an AWS VPC
|
||||
description:
|
||||
- Gather facts about Network ACLs in an AWS VPC
|
||||
version_added: "2.2"
|
||||
author: "Brad Davidson (@brandond)"
|
||||
requires: [ boto3 ]
|
||||
options:
|
||||
nacl_ids:
|
||||
description:
|
||||
- A list of Network ACL IDs to retrieve facts about.
|
||||
required: false
|
||||
default: []
|
||||
filters:
|
||||
description:
|
||||
- A dict of filters to apply. Each dict item consists of a filter key and a filter value. See \
|
||||
U(http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkAcls.html) for possible filters. Filter \
|
||||
names and values are case sensitive.
|
||||
required: false
|
||||
default: {}
|
||||
notes:
|
||||
- By default, the module will return all Network ACLs.
|
||||
|
||||
extends_documentation_fragment:
|
||||
- aws
|
||||
- ec2
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
# Note: These examples do not set authentication details, see the AWS Guide for details.
|
||||
|
||||
# Gather facts about all Network ACLs:
|
||||
- name: Get All NACLs
|
||||
register: all_nacls
|
||||
ec2_vpc_nacl_facts:
|
||||
region: us-west-2
|
||||
|
||||
# Retrieve default Network ACLs:
|
||||
- name: Get Default NACLs
|
||||
register: default_nacls
|
||||
ec2_vpc_nacl_facts:
|
||||
region: us-west-2
|
||||
filters:
|
||||
'default': 'true'
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
nacl:
|
||||
description: Returns an array of complex objects as described below.
|
||||
returned: success
|
||||
type: list of complex
|
||||
contains:
|
||||
nacl_id:
|
||||
description: The ID of the Network Access Control List.
|
||||
returned: always
|
||||
type: string
|
||||
vpc_id:
|
||||
description: The ID of the VPC that the NACL is attached to.
|
||||
returned: always
|
||||
type: string
|
||||
is_default:
|
||||
description: True if the NACL is the default for its VPC.
|
||||
returned: always
|
||||
type: boolean
|
||||
tags:
|
||||
description: A dict of tags associated with the NACL.
|
||||
returned: always
|
||||
type: dict
|
||||
subnets:
|
||||
description: A list of subnet IDs that are associated with the NACL.
|
||||
returned: always
|
||||
type: list of string
|
||||
ingress:
|
||||
description: A list of NACL ingress rules.
|
||||
returned: always
|
||||
type: list of list
|
||||
egress:
|
||||
description: A list of NACL egress rules.
|
||||
returned: always
|
||||
type: list of list
|
||||
'''
|
||||
|
||||
try:
|
||||
import boto3
|
||||
from botocore.exceptions import ClientError, NoCredentialsError
|
||||
HAS_BOTO3 = True
|
||||
except ImportError:
|
||||
HAS_BOTO3 = False
|
||||
|
||||
# VPC-supported IANA protocol numbers
|
||||
# http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml
|
||||
PROTOCOL_NAMES = {'-1': 'all', '1': 'icmp', '6': 'tcp', '17': 'udp'}
|
||||
|
||||
def list_ec2_vpc_nacls(connection, module):
|
||||
|
||||
nacl_ids = module.params.get("nacl_ids")
|
||||
filters = ansible_dict_to_boto3_filter_list(module.params.get("filters"))
|
||||
|
||||
try:
|
||||
nacls = connection.describe_network_acls(NetworkAclIds=nacl_ids, Filters=filters)
|
||||
except (ClientError, NoCredentialsError) as e:
|
||||
module.fail_json(msg=e.message, **camel_dict_to_snake_dict(e.response))
|
||||
|
||||
# Turn the boto3 result in to ansible_friendly_snaked_names
|
||||
snaked_nacls = []
|
||||
for nacl in nacls['NetworkAcls']:
|
||||
snaked_nacls.append(camel_dict_to_snake_dict(nacl))
|
||||
|
||||
# Turn the boto3 result in to ansible friendly tag dictionary
|
||||
for nacl in snaked_nacls:
|
||||
if 'tags' in nacl:
|
||||
nacl['tags'] = boto3_tag_list_to_ansible_dict(nacl['tags'])
|
||||
if 'entries' in nacl:
|
||||
nacl['egress'] = [nacl_entry_to_list(e) for e in nacl['entries']
|
||||
if e['rule_number'] != 32767 and e['egress']]
|
||||
nacl['ingress'] = [nacl_entry_to_list(e) for e in nacl['entries']
|
||||
if e['rule_number'] != 32767 and not e['egress']]
|
||||
del nacl['entries']
|
||||
if 'associations' in nacl:
|
||||
nacl['subnets'] = [a['subnet_id'] for a in nacl['associations']]
|
||||
del nacl['associations']
|
||||
if 'network_acl_id' in nacl:
|
||||
nacl['nacl_id'] = nacl['network_acl_id']
|
||||
del nacl['network_acl_id']
|
||||
|
||||
module.exit_json(nacls=snaked_nacls)
|
||||
|
||||
def nacl_entry_to_list(entry):
|
||||
|
||||
elist = [entry['rule_number'],
|
||||
PROTOCOL_NAMES[entry['protocol']],
|
||||
entry['rule_action'],
|
||||
entry['cidr_block']
|
||||
]
|
||||
if entry['protocol'] == '1':
|
||||
elist = elist + [-1, -1]
|
||||
else:
|
||||
elist = elist + [None, None, None, None]
|
||||
|
||||
if 'icmp_type_code' in entry:
|
||||
elist[4] = entry['icmp_type_code']['type']
|
||||
elist[5] = entry['icmp_type_code']['code']
|
||||
|
||||
if 'port_range' in entry:
|
||||
elist[6] = entry['port_range']['from']
|
||||
elist[7] = entry['port_range']['to']
|
||||
|
||||
return elist
|
||||
|
||||
def main():
|
||||
|
||||
argument_spec = ec2_argument_spec()
|
||||
argument_spec.update(
|
||||
dict(
|
||||
nacl_ids=dict(default=[], type='list'),
|
||||
filters=dict(default={}, type='dict')
|
||||
)
|
||||
)
|
||||
|
||||
module = AnsibleModule(argument_spec=argument_spec,
|
||||
mutually_exclusive=[
|
||||
['nacl_ids', 'filters']
|
||||
]
|
||||
)
|
||||
|
||||
if not HAS_BOTO3:
|
||||
module.fail_json(msg='boto3 required for this module')
|
||||
|
||||
region, ec2_url, aws_connect_params = get_aws_connection_info(module, boto3=True)
|
||||
|
||||
if region:
|
||||
connection = boto3_conn(module, conn_type='client', resource='ec2',
|
||||
region=region, endpoint=ec2_url, **aws_connect_params)
|
||||
else:
|
||||
module.fail_json(msg="region must be specified")
|
||||
|
||||
list_ec2_vpc_nacls(connection, module)
|
||||
|
||||
from ansible.module_utils.basic import *
|
||||
from ansible.module_utils.ec2 import *
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
Loading…
Reference in New Issue