Try SpotterCreate, modify, and delete EC2 VPN connections.
| "added in version" 2.4 of ansible.builtin"
Authors: Sloane Hertel (@s-hertel)
preview | supported by community
pipInstall with pip install ansible==2.9.17
This module creates, modifies, and deletes VPN connections. Idempotence is achieved by using the filters option or specifying the VPN connection identifier.
# Note: None of these examples set aws_access_key, aws_secret_key, or region.
# It is assumed that their matching environment variables are set.
- name: create a VPN connection
ec2_vpc_vpn:
state: present
vpn_gateway_id: vgw-XXXXXXXX
customer_gateway_id: cgw-XXXXXXXX
- name: modify VPN connection tags
ec2_vpc_vpn:
state: present
vpn_connection_id: vpn-XXXXXXXX
tags:
Name: ansible-tag-1
Other: ansible-tag-2
- name: delete a connection
ec2_vpc_vpn:
vpn_connection_id: vpn-XXXXXXXX
state: absent
- name: modify VPN tags (identifying VPN by filters)
ec2_vpc_vpn:
state: present
filters:
cidr: 194.168.1.0/24
tag-keys:
- Ansible
- Other
tags:
New: Tag
purge_tags: true
static_only: true
- name: set up VPN with tunnel options utilizing 'TunnelInsideCidr' only
ec2_vpc_vpn:
state: present
filters:
vpn: vpn-XXXXXXXX
static_only: true
tunnel_options:
-
TunnelInsideCidr: '169.254.100.1/30'
-
TunnelInsideCidr: '169.254.100.5/30'
- name: add routes and remove any preexisting ones
ec2_vpc_vpn:
state: present
filters:
vpn: vpn-XXXXXXXX
routes:
- 195.168.2.0/24
- 196.168.2.0/24
purge_routes: true
- name: remove all routes
ec2_vpc_vpn:
state: present
vpn_connection_id: vpn-XXXXXXXX
routes: []
purge_routes: true
- name: delete a VPN identified by filters
ec2_vpc_vpn:
state: absent
filters:
tags:
Ansible: Tag
tags:
description:
- Tags to attach to the VPN connection.
delay:
default: 15
description:
- The time to wait before checking operation again. in seconds.
required: false
type: int
version_added: '2.8'
version_added_collection: ansible.builtin
state:
choices:
- present
- absent
default: present
description:
- The desired state of the VPN connection.
required: false
region:
aliases:
- aws_region
- ec2_region
description:
- 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 U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region)
type: str
routes:
description:
- Routes to add to the connection.
ec2_url:
aliases:
- aws_endpoint_url
- endpoint_url
description:
- 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.
type: str
filters:
description:
- An alternative to using vpn_connection_id. If multiple matches are found, vpn_connection_id
is required. If one of the following suboptions is a list of items to filter by,
only one item needs to match to find the VPN that correlates. e.g. if the filter
'cidr' is ['194.168.2.0/24', '192.168.2.0/24'] and the VPN route only has the destination
cidr block of '192.168.2.0/24' it will be found with this filter (assuming there
are not multiple VPNs that are matched). Another example, if the filter 'vpn' is
equal to ['vpn-ccf7e7ad', 'vpn-cb0ae2a2'] and one of of the VPNs has the state deleted
(exists but is unmodifiable) and the other exists and is not deleted, it will be
found via this filter. See examples.
suboptions:
bgp:
description:
- The BGP ASN number associated with a BGP device. Only works if the connection
is attached. This filtering option is currently not working.
cgw:
description:
- The customer gateway id as a string or a list of those strings.
cgw-config:
description:
- The customer gateway configuration of the VPN as a string (in the format of
the return value) or a list of those strings.
cidr:
description:
- The destination cidr of the VPN's route as a string or a list of those strings.
static-routes-only:
description:
- The type of routing; true or false.
tag-keys:
description:
- The key of a tag as a string or a list of those strings.
tag-values:
description:
- The value of a tag as a string or a list of those strings.
tags:
description:
- A dict of key value pairs.
vgw:
description:
- The virtual private gateway as a string or a list of those strings.
vpn:
description:
- The VPN connection id as a string or a list of those strings.
profile:
aliases:
- aws_profile
description:
- Using I(profile) will override I(aws_access_key), I(aws_secret_key) and I(security_token)
and support for passing them at the same time as I(profile) has been deprecated.
- I(aws_access_key), I(aws_secret_key) and I(security_token) will be made mutually
exclusive with I(profile) after 2022-06-01.
type: str
aws_config:
description:
- A dictionary to modify the botocore configuration.
- Parameters can be found at U(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 U(http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto)
for more boto configuration.
type: dict
purge_tags:
default: false
description:
- Whether or not to delete VPN connections tags that are associated with the connection
but not specified in the task.
type: bool
static_only:
default: false
description:
- Indicates whether the VPN connection uses static routes only. Static routes must
be used for devices that don't support BGP.
required: false
type: bool
purge_routes:
description:
- Whether or not to delete VPN connections routes that are not specified in the task.
type: bool
wait_timeout:
default: 600
description:
- How long before wait gives up, in seconds.
required: false
type: int
version_added: '2.8'
version_added_collection: ansible.builtin
aws_ca_bundle:
description:
- 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.'
type: path
aws_access_key:
aliases:
- ec2_access_key
- access_key
description:
- C(AWS access key). If not set then the value of the C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY)
or C(EC2_ACCESS_KEY) environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
aws_secret_key:
aliases:
- ec2_secret_key
- secret_key
description:
- C(AWS secret key). If not set then the value of the C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY),
or C(EC2_SECRET_KEY) environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
security_token:
aliases:
- aws_security_token
- access_token
description:
- C(AWS STS security token). If not set then the value of the C(AWS_SECURITY_TOKEN)
or C(EC2_SECURITY_TOKEN) environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(security_token) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
tunnel_options:
description:
- An optional list object containing no more than two dict members, each of which
may contain 'TunnelInsideCidr' and/or 'PreSharedKey' keys with appropriate string
values. AWS defaults will apply in absence of either of the aforementioned keys.
required: false
version_added: '2.5'
version_added_collection: ansible.builtin
validate_certs:
default: true
description:
- When set to "no", SSL certificates will not be validated for communication with
the AWS APIs.
type: bool
vpn_gateway_id:
description:
- The ID of the virtual private gateway.
connection_type:
choices:
- ipsec.1
default: ipsec.1
description:
- The type of VPN connection.
vpn_connection_id:
description:
- The ID of the VPN connection. Required to modify or delete a connection if the filters
option does not provide a unique match.
customer_gateway_id:
description:
- The ID of the customer gateway.
debug_botocore_endpoint_logs:
default: 'no'
description:
- 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.
type: bool
changed:
description: If the VPN connection has changed.
returned: always
sample:
changed: true
type: bool
customer_gateway_configuration:
description: The configuration of the VPN connection.
returned: I(state=present)
type: str
customer_gateway_id:
description: The customer gateway connected via the connection.
returned: I(state=present)
sample:
customer_gateway_id: cgw-1220c87b
type: str
options:
contains:
static_routes_only:
description: If the VPN connection only allows static routes.
returned: I(state=present)
sample:
static_routes_only: true
type: str
description: The VPN connection options (currently only containing static_routes_only).
returned: I(state=present)
type: complex
routes:
description: The routes of the VPN connection.
returned: I(state=present)
sample:
routes:
- destination_cidr_block: 192.168.1.0/24
state: available
type: list
state:
description: The status of the VPN connection.
returned: I(state=present)
sample:
state: available
type: str
tags:
description: The tags associated with the connection.
returned: I(state=present)
sample:
tags:
name: ansible-test
other: tag
type: dict
type:
description: The type of VPN connection (currently only ipsec.1 is available).
returned: I(state=present)
sample:
type: ipsec.1
type: str
vgw_telemetry:
description: The telemetry for the VPN tunnel.
returned: I(state=present)
sample:
vgw_telemetry:
- accepted_route_count: 123
last_status_change: datetime(2015, 1, 1)
outside_ip_address: string
status: up
status_message: string
type: list
vpn_connection_id:
description: The identifier for the VPN connection.
returned: I(state=present)
sample:
vpn_connection_id: vpn-781e0e19
type: str
vpn_gateway_id:
description: The virtual private gateway connected via the connection.
returned: I(state=present)
sample:
vpn_gateway_id: vgw-cb0ae2a2
type: str