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

Note

This plugin is part of the community.aws collection (version 1.5.0).

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

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

New in version 1.0.0: of community.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 >= 2.6

  • boto

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

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.

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

- name: Gather information about a particular VPC route table using route table ID
  community.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
  community.aws.ec2_vpc_route_table_info:
    filters:
      "tag:Name": Example

- name: Gather information about any VPC route table within VPC with ID vpc-abcdef00
  community.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 Returned Description
route_tables
complex
always
A list of dictionarys describing route tables

 
associations
complex
always
List of subnets associated with the route table

   
association_state
complex
always
The state of the association

     
state
string
always
The state of the association

Sample:
associated
     
state_message
string
when available
Additional information about the state of the association

Sample:
Creating association
   
id
string
always
ID of association between route table and subnet

Sample:
rtbassoc-ab47cfc3
   
main
boolean
always
Whether this is the main route table

   
route_table_association_id
string
always
ID of association between route table and subnet

Sample:
rtbassoc-ab47cfc3
   
route_table_id
string
always
ID of the route table

Sample:
rtb-bf779ed7
   
subnet_id
string
always
ID of the subnet

Sample:
subnet-82055af9
 
id
string
always
ID of the route table (same as route_table_id for backwards compatibility)

Sample:
rtb-bf779ed7
 
owner_id
string
always
ID of the account which owns the route table

Sample:
012345678912
 
propagating_vgws
list / elements=string
always
List of Virtual Private Gateways propagating routes

 
route_table_id
string
always
ID of the route table

Sample:
rtb-bf779ed7
 
routes
complex
always
List of routes in the route table

   
destination_cidr_block
string
always
CIDR block of destination

Sample:
10.228.228.0/22
   
gateway_id
string
when gateway is local or internet gateway
ID of the gateway

Sample:
local
   
instance_id
string
always
ID of a NAT instance.
Empty unless the route is via an EC2 instance

Sample:
i-abcd123456789
   
instance_owner_id
string
always
AWS account owning the NAT instance
Empty unless the route is via an EC2 instance

Sample:
123456789012
   
nat_gateway_id
string
when the route is via a NAT gateway
ID of the NAT gateway

Sample:
local
   
network_interface_id
string
always
The ID of the network interface
Empty unless the route is via an EC2 instance

Sample:
123456789012
   
origin
string
always
mechanism through which the route is in the table

Sample:
CreateRouteTable
   
state
string
always
state of the route

Sample:
active
 
tags
dictionary
always
Tags applied to the route table

Sample:
{'Name': 'Public route table', 'Public': 'true'}
 
vpc_id
string
always
ID for the VPC in which the route lives

Sample:
vpc-6e2d2407


Authors

  • Rob White (@wimnat)

  • Mark Chappell (@tremble)