amazon.aws.ec2_vpc_route_table_info module – Gather information about ec2 VPC route tables in AWS

Note

This module is part of the amazon.aws collection (version 2.3.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.

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

New in version 1.0.0: of amazon.aws

Synopsis

  • Gather information about ec2 VPC route tables in AWS

  • This module was called ec2_vpc_route_table_facts before Ansible 2.9. The usage did not change.

Requirements

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

  • python >= 3.6

  • boto3 >= 1.15.0

  • botocore >= 1.18.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.

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.

aws_ca_bundle

path

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.

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

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.

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.

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:

  • no ← (default)

  • yes

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_DescribeRouteTables.html for possible filters.

profile

aliases: aws_profile

string

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.

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_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.

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.

validate_certs

boolean

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

Choices:

  • no

  • yes ← (default)

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.

  • Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.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.

- name: Gather information about all VPC route tables
  amazon.aws.ec2_vpc_route_table_info:

- name: Gather information about a particular VPC route table using route table ID
  amazon.aws.ec2_vpc_route_table_info:
    filters:
      route-table-id: rtb-00112233

- name: Gather information about any VPC route table with a tag key Name and value Example
  amazon.aws.ec2_vpc_route_table_info:
    filters:
      "tag:Name": Example

- name: Gather information about any VPC route table within VPC with ID vpc-abcdef00
  amazon.aws.ec2_vpc_route_table_info:
    filters:
      vpc-id: vpc-abcdef00

Return Values

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

Key

Description

route_tables

complex

A list of dictionarys describing route tables

See also https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ec2.html#EC2.Client.describe_route_tables

Returned: always

associations

complex

List of subnets associated with the route table

Returned: always

association_state

complex

The state of the association

Returned: always

state

string

The state of the association

Returned: always

Sample: “associated”

state_message

string

Additional information about the state of the association

Returned: when available

Sample: “Creating association”

id

string

ID of association between route table and subnet

Returned: always

Sample: “rtbassoc-ab47cfc3”

main

boolean

Whether this is the main route table

Returned: always

Sample: false

route_table_association_id

string

ID of association between route table and subnet

Returned: always

Sample: “rtbassoc-ab47cfc3”

route_table_id

string

ID of the route table

Returned: always

Sample: “rtb-bf779ed7”

subnet_id

string

ID of the subnet

Returned: always

Sample: “subnet-82055af9”

id

string

ID of the route table (same as route_table_id for backwards compatibility)

Returned: always

Sample: “rtb-bf779ed7”

owner_id

string

ID of the account which owns the route table

Returned: always

Sample: “012345678912”

propagating_vgws

list / elements=string

List of Virtual Private Gateways propagating routes

Returned: always

Sample: []

route_table_id

string

ID of the route table

Returned: always

Sample: “rtb-bf779ed7”

routes

complex

List of routes in the route table

Returned: always

destination_cidr_block

string

CIDR block of destination

Returned: always

Sample: “10.228.228.0/22”

gateway_id

string

ID of the gateway

Returned: when gateway is local or internet gateway

Sample: “local”

instance_id

string

ID of a NAT instance.

Empty unless the route is via an EC2 instance

Returned: always

Sample: “i-abcd123456789”

instance_owner_id

string

AWS account owning the NAT instance

Empty unless the route is via an EC2 instance

Returned: always

Sample: 123456789012

nat_gateway_id

string

ID of the NAT gateway

Returned: when the route is via a NAT gateway

Sample: “local”

network_interface_id

string

The ID of the network interface

Empty unless the route is via an EC2 instance

Returned: always

Sample: 123456789012

origin

string

mechanism through which the route is in the table

Returned: always

Sample: “CreateRouteTable”

state

string

state of the route

Returned: always

Sample: “active”

tags

dictionary

Tags applied to the route table

Returned: always

Sample: {“Name”: “Public route table”, “Public”: “true”}

vpc_id

string

ID for the VPC in which the route lives

Returned: always

Sample: “vpc-6e2d2407”

Authors

  • Rob White (@wimnat)

  • Mark Chappell (@tremble)