ec2_vpc_route_table – Manage route tables for AWS virtual private clouds¶
New in version 2.0.
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
-
|
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
-
|
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
-
|
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.
|
|
lookup
-
|
|
Look up route table by either tags or by route table ID. Non-unique tag lookup will fail. If no tags are specified then no lookup for an existing route table is performed and a new route table will be created. To change tags of a route table you must look up by id.
|
profile
-
added in 1.6 |
Uses a boto profile. Only works with boto >= 2.24.0.
|
|
propagating_vgw_ids
-
|
Enable route propagation from virtual gateways specified by ID.
|
|
purge_routes
boolean
added in 2.3 |
|
Purge existing routes that are not found in routes.
|
purge_subnets
-
added in 2.3 |
Default: "true"
|
Purge existing subnets that are not found in subnets. Ignored unless the subnets option is supplied.
|
purge_tags
boolean
added in 2.5 |
|
Purge existing tags that are not found in route table
|
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 |
|
route_table_id
-
|
The ID of the route table to update or delete.
|
|
routes
-
|
List of routes in the route table. Routes are specified as dicts containing the keys 'dest' and one of 'gateway_id', 'instance_id', 'network_interface_id', or 'vpc_peering_connection_id'. If 'gateway_id' is specified, you can refer to the VPC's IGW by using the value 'igw'. Routes are required for present states.
|
|
security_token
-
added in 1.6 |
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 |
|
state
-
|
|
Create or destroy the VPC route table
|
subnets
-
|
An array of subnets to add to this route table. Subnets may be specified by either subnet ID, Name tag, or by a CIDR such as '10.0.0.0/24'.
|
|
tags
-
|
A dictionary of resource tags of the form: { tag1: value1, tag2: value2 }. Tags are used to uniquely identify route tables within a VPC when the route_table_id is not supplied.
aliases: resource_tags |
|
validate_certs
boolean
added in 1.5 |
|
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
|
vpc_id
-
/ required
|
VPC ID of the VPC in which to create the route table.
|
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 https://boto.readthedocs.io/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.
# Basic creation example:
- name: Set up public subnet route table
ec2_vpc_route_table:
vpc_id: vpc-1245678
region: us-west-1
tags:
Name: Public
subnets:
- "{{ jumpbox_subnet.subnet.id }}"
- "{{ frontend_subnet.subnet.id }}"
- "{{ vpn_subnet.subnet_id }}"
routes:
- dest: 0.0.0.0/0
gateway_id: "{{ igw.gateway_id }}"
register: public_route_table
- name: Set up NAT-protected route table
ec2_vpc_route_table:
vpc_id: vpc-1245678
region: us-west-1
tags:
Name: Internal
subnets:
- "{{ application_subnet.subnet.id }}"
- 'Database Subnet'
- '10.0.0.0/8'
routes:
- dest: 0.0.0.0/0
instance_id: "{{ nat.instance_id }}"
register: nat_route_table
- name: delete route table
ec2_vpc_route_table:
vpc_id: vpc-1245678
region: us-west-1
route_table_id: "{{ route_table.id }}"
lookup: id
state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | ||
---|---|---|---|---|
route_table
complex
|
always |
Route Table result
|
||
associations
complex
|
always |
List of subnets associated with the route table
|
||
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
|
||
propagating_vgws
list
|
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
|
when the route is via an EC2 instance |
ID of a NAT instance
Sample:
i-abcd123456789
|
||
instance_owner_id
string
|
when the route is via an EC2 instance |
AWS account owning the NAT instance
Sample:
123456789012
|
||
nat_gateway_id
string
|
when the route is via a NAT gateway |
ID of the NAT gateway
Sample:
local
|
||
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
|
Status¶
- This module is guaranteed to have no backward incompatible interface changes going forward. [stableinterface]
- This module is maintained by an Ansible Partner. [certified]
Authors¶
- Robert Estelle (@erydo)
- Rob White (@wimnat)
- Will Thames (@willthames)
Hint
If you notice any issues in this documentation you can edit this document to improve it.