ec2_vpc_subnet_facts - Gather facts about ec2 VPC subnets in AWS
New in version 2.1.
Synopsis
- Gather facts about ec2 VPC subnets in AWS
Requirements
The below requirements are needed on the host that executes this module.
- boto
- boto3
- botocore
- python >= 2.6
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
aws_access_key | Default: None | AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used. aliases: ec2_access_key, access_key |
aws_secret_key | Default: None | AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used. aliases: ec2_secret_key, secret_key |
ec2_url | Default: None | 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. |
filters | A dict of filters to apply. Each dict item consists of a filter key and a filter value. See http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSubnets.html for possible filters. | |
profile (added in 1.6) | Default: None | Uses a boto profile. Only works with boto >= 2.24.0. |
region | 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 http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
aliases: aws_region, ec2_region | |
security_token (added in 1.6) | Default: None | AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. aliases: access_token |
subnet_ids (added in 2.5) | A list of subnet IDs to gather facts for. aliases: subnet_id | |
validate_certs (added in 1.5) |
| When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0. |
Notes
Note
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence
AWS_URL
orEC2_URL
,AWS_ACCESS_KEY_ID
orAWS_ACCESS_KEY
orEC2_ACCESS_KEY
,AWS_SECRET_ACCESS_KEY
orAWS_SECRET_KEY
orEC2_SECRET_KEY
,AWS_SECURITY_TOKEN
orEC2_SECURITY_TOKEN
,AWS_REGION
orEC2_REGION
- Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See http://boto.readthedocs.org/en/latest/boto_config_tut.html
-
AWS_REGION
orEC2_REGION
can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file
Examples
# Note: These examples do not set authentication details, see the AWS Guide for details. # Gather facts about all VPC subnets - ec2_vpc_subnet_facts: # Gather facts about a particular VPC subnet using ID - ec2_vpc_subnet_facts: subnet_ids: subnet-00112233 # Gather facts about any VPC subnet with a tag key Name and value Example - ec2_vpc_subnet_facts: filters: "tag:Name": Example # Gather facts about any VPC subnet within VPC with ID vpc-abcdef00 - ec2_vpc_subnet_facts: filters: vpc-id: vpc-abcdef00 # Gather facts 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_facts: filters: vpc-id: vpc-abcdef00 "tag:Name": "{{ item }}" with_items: - publicA - publicB - publicC register: subnet_facts - set_fact: subnet_ids: "{{ subnet_facts.subnets|map(attribute='id')|list }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |||
---|---|---|---|---|---|
subnets complex | success | Returns an array of complex objects as described below. | |||
tags dict | always | A dict of tags associated with the Subnet. | |||
subnet_id string | always | The ID of the Subnet. | |||
assign_ipv6_address_on_creation boolean | always | True/False depending on attribute setting for IPv6 address assignment. | |||
default_for_az boolean | always | True if this is the default subnet for AZ. | |||
state string | always | The state of the subnet. | |||
ipv6_cidr_block_association_set complex | always | An array of IPv6 cidr block association set information. | |||
association_id string | always | The association ID | |||
ipv6_cidr_block string | always | The IPv6 CIDR block that is associated with the subnet. | |||
ipv6_cidr_block_state dict | always | A hash/dict that contains a single item. The state of the cidr block association. | |||
state string | always | The CIDR block association state. | |||
availability_zone string | always | The availability zone where the subnet exists. | |||
vpc_id string | always | The ID of the VPC . | |||
cidr_block string | always | The IPv4 CIDR block assigned to the subnet. | |||
available_ip_address_count string | always | Count of available IPs in subnet. | |||
id string | always | The ID of the Subnet (for backwards compatibility). | |||
map_public_ip_on_launch boolean | always | True/False depending on attribute setting for public IP mapping. |
Status
This module is flagged as stableinterface which means that the maintainers for this module guarantee that no backward incompatible interface changes will be made.
Support
For more information about Red Hat’s support of this module, please refer to this Knowledge Base article
Author
- Rob White (@wimnat)
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/ec2_vpc_subnet_facts_module.html