W3cubDocs

/Ansible 2.10

amazon.aws.ec2_vpc_net_facts – Gather information about ec2 VPCs in AWS

Note

This plugin is part of the amazon.aws collection.

To install it use: ansible-galaxy collection install amazon.aws.

To use it in a playbook, specify: amazon.aws.ec2_vpc_net_facts.

New in version 1.0.0: of amazon.aws

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis

Gather information about ec2 VPCs in AWS
This module was called ec2_vpc_net_facts before Ansible 2.9. The usage did not change.

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 string		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. If profile is set this parameter is ignored. Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. aliases: ec2_access_key, access_key
aws_ca_bundle path		The location of a CA Bundle to use when validating SSL certificates. Only used for boto3 based modules. Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
aws_config dictionary		A dictionary to modify the botocore configuration. Parameters can be found at 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 http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration.
aws_secret_key string		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. If profile is set this parameter is ignored. Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. aliases: ec2_secret_key, secret_key
debug_botocore_endpoint_logs boolean	Choices: no ← yes	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.
ec2_url string		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. aliases: aws_endpoint_url, endpoint_url
filters dictionary		A dict of filters to apply. Each dict item consists of a filter key and a filter value. See https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpcs.html for possible filters.
profile string		Uses a boto profile. Only works with boto >= 2.24.0. Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated. aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01. aliases: aws_profile
region string		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 string		AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. If profile is set this parameter is ignored. Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. aliases: aws_security_token, access_token
validate_certs boolean	Choices: no yes ←	When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
vpc_ids list / elements=string		A list of VPC IDs that exist in your account.

Notes

Note

If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence AWS_URL or EC2_URL, AWS_PROFILE or AWS_DEFAULT_PROFILE, AWS_ACCESS_KEY_ID or AWS_ACCESS_KEY or EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY or AWS_SECRET_KEY or EC2_SECRET_KEY, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN, AWS_REGION or EC2_REGION, AWS_CA_BUNDLE
Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html
AWS_REGION or EC2_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 information about all VPCs
- amazon.aws.ec2_vpc_net_info:

# Gather information about a particular VPC using VPC ID
- amazon.aws.ec2_vpc_net_info:
    vpc_ids: vpc-00112233

# Gather information about any VPC with a tag key Name and value Example
- amazon.aws.ec2_vpc_net_info:
    filters:
      "tag:Name": Example

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key				Returned	Description
vpcs complex				success	Returns an array of complex objects as described below.
	cidr_block string			always	The IPv4 CIDR block assigned to the VPC.
	cidr_block_association_set complex			always	An array of IPv4 cidr block association set information.
		association_id string		always	The association ID
		cidr_block string		always	The IPv4 CIDR block that is associated with the VPC.
		cidr_block_state dictionary		always	A hash/dict that contains a single item. The state of the cidr block association.
			state string	always	The CIDR block association state.
	classic_link_dns_supported boolean			always	True/False depending on attribute setting for classic link DNS support.
	classic_link_enabled boolean			always	True/False depending on if classic link support is enabled.
	enable_dns_hostnames boolean			always	True/False depending on attribute setting for DNS hostnames support.
	enable_dns_support boolean			always	True/False depending on attribute setting for DNS support.
	id string			always	The ID of the VPC (for backwards compatibility).
	instance_tenancy string			always	The instance tenancy setting for the VPC.
	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 VPC.
		ipv6_cidr_block_state dictionary		always	A hash/dict that contains a single item. The state of the cidr block association.
			state string	always	The CIDR block association state.
	is_default boolean			always	True if this is the default VPC for account.
	state string			always	The state of the VPC.
	tags dictionary			always	A dict of tags associated with the VPC.
	vpc_id string			always	The ID of the VPC .

Authors

Rob White (@wimnat)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/amazon/aws/ec2_vpc_net_facts_module.html