ansible / ansible.builtin / v2.9.0 / module / ec2_vpc_subnet_info Gather information about ec2 VPC subnets in AWS | "added in version" 2.1 of ansible.builtin" Authors: Rob White (@wimnat) stableinterface | supported by coreansible.builtin.ec2_vpc_subnet_info (v2.9.0) — module
pip
Install with pip install ansible==2.9.0
Gather information about ec2 VPC subnets in AWS
This module was called C(ec2_vpc_subnet_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 VPC subnets - ec2_vpc_subnet_info:
# Gather information about a particular VPC subnet using ID - ec2_vpc_subnet_info: subnet_ids: subnet-00112233
# Gather information about any VPC subnet with a tag key Name and value Example - ec2_vpc_subnet_info: filters: "tag:Name": Example
# Gather information about any VPC subnet within VPC with ID vpc-abcdef00 - ec2_vpc_subnet_info: filters: vpc-id: vpc-abcdef00
# Gather information about a set of VPC subnets, publicA, publicB and publicC within a # VPC with ID vpc-abcdef00 and then use the jinja map function to return the # subnet_ids as a list. - ec2_vpc_subnet_info: filters: vpc-id: vpc-abcdef00 "tag:Name": "{{ item }}" loop: - publicA - publicB - publicC register: subnet_info
- set_fact: subnet_ids: "{{ subnet_info.subnets|map(attribute='id')|list }}"
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: 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_DescribeSubnets.html) for possible filters. 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 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 subnet_ids: aliases: - subnet_id description: - A list of subnet IDs to gather information for. version_added: '2.5' version_added_collection: ansible.builtin 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_session_token - session_token - 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. - Aliases I(aws_session_token) and I(session_token) have been added in version 3.2.0. 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
subnets: contains: assign_ipv6_address_on_creation: description: True/False depending on attribute setting for IPv6 address assignment. returned: always type: bool availability_zone: description: The availability zone where the subnet exists. returned: always type: str available_ip_address_count: description: Count of available IPs in subnet. returned: always type: str cidr_block: description: The IPv4 CIDR block assigned to the subnet. returned: always type: str default_for_az: description: True if this is the default subnet for AZ. returned: always type: bool id: description: The ID of the Subnet (for backwards compatibility). returned: always type: str ipv6_cidr_block_association_set: contains: association_id: description: The association ID returned: always type: str ipv6_cidr_block: description: The IPv6 CIDR block that is associated with the subnet. returned: always type: str ipv6_cidr_block_state: contains: state: description: The CIDR block association state. returned: always type: str description: A hash/dict that contains a single item. The state of the cidr block association. returned: always type: dict description: An array of IPv6 cidr block association set information. returned: always type: complex map_public_ip_on_launch: description: True/False depending on attribute setting for public IP mapping. returned: always type: bool state: description: The state of the subnet. returned: always type: str subnet_id: description: The ID of the Subnet. returned: always type: str tags: description: A dict of tags associated with the Subnet. returned: always type: dict vpc_id: description: The ID of the VPC . returned: always type: str description: Returns an array of complex objects as described below. returned: success type: complex