amazon.aws.ec2_vpc_net_info module – Gather information about ec2 VPCs in AWS

Note

This module is part of the amazon.aws collection (version 4.2.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install amazon.aws. You need further requirements to be able to use this module, see Requirements for details.

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

New in version amazon.aws: 1.0.0

Synopsis

  • Gather information about ec2 VPCs in AWS

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 3.6

  • boto3 >= 1.17.0

  • botocore >= 1.20.0

Parameters

Parameter

Comments

aws_access_key

aliases: ec2_access_key, 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.

The aws_access_key and profile options are mutually exclusive.

aws_ca_bundle

path

The location of a CA Bundle to use when validating SSL certificates.

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.

aws_secret_key

aliases: ec2_secret_key, 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.

The aws_secret_key and profile options are mutually exclusive.

debug_botocore_endpoint_logs

boolean

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.

Choices:

  • false ← (default)

  • true

ec2_url

aliases: aws_endpoint_url, endpoint_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.

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

aliases: aws_profile

string

The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.

region

aliases: aws_region, ec2_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

security_token

aliases: aws_session_token, session_token, aws_security_token, access_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.

The security_token and profile options are mutually exclusive.

Aliases aws_session_token and session_token have been added in version 3.2.0.

validate_certs

boolean

When set to “no”, SSL certificates will not be validated for communication with the AWS APIs.

Choices:

  • false

  • true ← (default)

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

  • When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ~/.aws/credentials). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.

  • AWS_REGION or EC2_REGION can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.

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

Description

vpcs

complex

Returns an array of complex objects as described below.

Returned: success

cidr_block

string

The IPv4 CIDR block assigned to the VPC.

Returned: always

cidr_block_association_set

complex

An array of IPv4 cidr block association set information.

Returned: always

association_id

string

The association ID.

Returned: always

cidr_block

string

The IPv4 CIDR block that is associated with the VPC.

Returned: always

cidr_block_state

dictionary

A hash/dict that contains a single item. The state of the cidr block association.

Returned: always

state

string

The CIDR block association state.

Returned: always

boolean

True/False depending on attribute setting for classic link DNS support.

Returned: always

boolean

True/False depending on if classic link support is enabled.

Returned: always

dhcp_options_id

string

The ID of the DHCP options associated with this VPC.

Returned: always

Sample: “dopt-12345678”

enable_dns_hostnames

boolean

True/False depending on attribute setting for DNS hostnames support.

Returned: always

enable_dns_support

boolean

True/False depending on attribute setting for DNS support.

Returned: always

id

string

The ID of the VPC (for backwards compatibility).

Returned: always

instance_tenancy

string

The instance tenancy setting for the VPC.

Returned: always

ipv6_cidr_block_association_set

complex

An array of IPv6 cidr block association set information.

Returned: always

association_id

string

The association ID.

Returned: always

ipv6_cidr_block

string

The IPv6 CIDR block that is associated with the VPC.

Returned: always

ipv6_cidr_block_state

dictionary

A hash/dict that contains a single item. The state of the cidr block association.

Returned: always

state

string

The CIDR block association state.

Returned: always

is_default

boolean

True if this is the default VPC for account.

Returned: always

owner_id

string

The AWS account which owns the VPC.

Returned: always

Sample: “123456789012”

state

string

The state of the VPC.

Returned: always

tags

dictionary

A dict of tags associated with the VPC.

Returned: always

vpc_id

string

The ID of the VPC.

Returned: always

Authors

  • Rob White (@wimnat)