Try SpotterGather information about Network ACLs in an AWS VPC
| "added in version" 1.0.0 of community.aws"
Authors: Brad Davidson (@brandond)
Install with ansible-galaxy collection install community.aws:==0.1.2
collections:
- name: community.aws
version: 0.1.2Gather information about Network ACLs in an AWS VPC
This module was called C(ec2_vpc_nacl_facts) before Ansible 2.9. The usage did not change.
# Note: These examples do not set authentication details, see the AWS Guide for details.
# Gather information about all Network ACLs:
- name: Get All NACLs
community.aws.ec2_vpc_nacl_info:
region: us-west-2
register: all_nacls
# Retrieve default Network ACLs:
- name: Get Default NACLs
community.aws.ec2_vpc_nacl_info:
region: us-west-2
filters:
'default': 'true'
register: default_nacls
region:
aliases:
- aws_region
- ec2_region
description:
- The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION
environment variable, if any, is used. See U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region)
type: str
ec2_url:
aliases:
- aws_endpoint_url
- endpoint_url
description:
- URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will
use EC2 endpoints). Ignored for modules where region is required. Must be specified
for all other modules if region is not used. If not set then the value of the EC2_URL
environment variable, if any, is used.
type: str
filters:
default: {}
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_DescribeNetworkAcls.html)
for possible filters. Filter names and values are case sensitive.
required: false
type: dict
profile:
aliases:
- aws_profile
description:
- Using I(profile) will override I(aws_access_key), I(aws_secret_key) and I(security_token)
and support for passing them at the same time as I(profile) has been deprecated.
- I(aws_access_key), I(aws_secret_key) and I(security_token) will be made mutually
exclusive with I(profile) after 2022-06-01.
type: str
nacl_ids:
aliases:
- nacl_id
default: []
description:
- A list of Network ACL IDs to retrieve information about.
required: false
type: list
aws_config:
description:
- A dictionary to modify the botocore configuration.
- Parameters can be found at U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config).
- Only the 'user_agent' key is used for boto modules. See U(http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto)
for more boto configuration.
type: dict
aws_ca_bundle:
description:
- The location of a CA Bundle to use when validating SSL certificates.
- Not used by boto 2 based modules.
- 'Note: The CA Bundle is read ''module'' side and may need to be explicitly copied
from the controller if not run locally.'
type: path
aws_access_key:
aliases:
- ec2_access_key
- access_key
description:
- C(AWS access key). If not set then the value of the C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY)
or C(EC2_ACCESS_KEY) environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
aws_secret_key:
aliases:
- ec2_secret_key
- secret_key
description:
- C(AWS secret key). If not set then the value of the C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY),
or C(EC2_SECRET_KEY) environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
security_token:
aliases:
- aws_security_token
- access_token
description:
- C(AWS STS security token). If not set then the value of the C(AWS_SECURITY_TOKEN)
or C(EC2_SECURITY_TOKEN) environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(security_token) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
validate_certs:
default: true
description:
- When set to "no", SSL certificates will not be validated for communication with
the AWS APIs.
type: bool
debug_botocore_endpoint_logs:
default: 'no'
description:
- Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action"
API calls made during a task, outputing the set to the resource_actions key in the
task results. Use the aws_resource_action callback to output to total list made
during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also
be used.
type: bool
nacls:
contains:
egress:
description:
- A list of NACL egress rules with the following format.
- C([rule no, protocol, allow/deny, v4 or v6 cidr, icmp_type, icmp_code, port
from, port to])
elements: list
returned: always
sample:
- - 100
- all
- allow
- 0.0.0.0/0
- null
- null
- null
- null
type: list
ingress:
description:
- A list of NACL ingress rules with the following format.
- C([rule no, protocol, allow/deny, v4 or v6 cidr, icmp_type, icmp_code, port
from, port to])
elements: list
returned: always
sample:
- - 100
- tcp
- allow
- 0.0.0.0/0
- null
- null
- 22
- 22
type: list
is_default:
description: True if the NACL is the default for its VPC.
returned: always
type: bool
nacl_id:
description: The ID of the Network Access Control List.
returned: always
type: str
subnets:
description: A list of subnet IDs that are associated with the NACL.
elements: str
returned: always
type: list
tags:
description: A dict of tags associated with the NACL.
returned: always
type: dict
vpc_id:
description: The ID of the VPC that the NACL is attached to.
returned: always
type: str
description: Returns an array of complex objects as described below.
returned: success
type: complex