Try SpotterCreate, modify, and delete EC2 VPN connections
| "added in version" 1.0.0 of community.aws"
Authors: Sloane Hertel (@s-hertel)
Install with ansible-galaxy collection install community.aws:==5.1.0
collections:
- name: community.aws
version: 5.1.0This 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
community.aws.ec2_vpc_vpn:
state: present
vpn_gateway_id: vgw-XXXXXXXX
customer_gateway_id: cgw-XXXXXXXX
- name: modify VPN connection tags
community.aws.ec2_vpc_vpn:
state: present
vpn_connection_id: vpn-XXXXXXXX
tags:
Name: ansible-tag-1
Other: ansible-tag-2
- name: delete a connection
community.aws.ec2_vpc_vpn:
vpn_connection_id: vpn-XXXXXXXX
state: absent
- name: modify VPN tags (identifying VPN by filters)
community.aws.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
community.aws.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
community.aws.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
community.aws.ec2_vpc_vpn:
state: present
vpn_connection_id: vpn-XXXXXXXX
routes: []
purge_routes: true
- name: delete a VPN identified by filters
community.aws.ec2_vpc_vpn:
state: absent
filters:
tags:
Ansible: Tag
tags:
aliases:
- resource_tags
description:
- A dictionary representing the tags to be applied to the resource.
- If the I(tags) parameter is not set then tags will not be modified.
required: false
type: dict
delay:
default: 15
description:
- The time, in seconds, to wait before checking operation again.
required: false
type: int
state:
choices:
- present
- absent
default: present
description:
- The desired state of the VPN connection.
required: false
type: str
region:
aliases:
- aws_region
- ec2_region
description:
- The AWS region to use.
- For global services such as IAM, Route53 and CloudFront, I(region) is ignored.
- The C(AWS_REGION) or C(EC2_REGION) environment variables may also be used.
- See the Amazon AWS documentation for more information U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region).
- The C(ec2_region) alias has been deprecated and will be removed in a release after
2024-12-01
- Support for the C(EC2_REGION) environment variable has been deprecated and will
be removed in a release after 2024-12-01.
type: str
routes:
default: []
description:
- Routes to add to the connection.
elements: str
type: list
filters:
default: {}
description:
- An alternative to using I(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
I(cidr) is C(['194.168.2.0/24', '192.168.2.0/24']) and the VPN route only has the
destination cidr block of C(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 I(vpn)
is equal to C(['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; C(true) or C(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.
type: dict
profile:
aliases:
- aws_profile
description:
- A named AWS profile to use for authentication.
- See the AWS documentation for more information about named profiles U(https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html).
- The C(AWS_PROFILE) environment variable may also be used.
- The I(profile) option is mutually exclusive with the I(aws_access_key), I(aws_secret_key)
and I(security_token) options.
type: str
access_key:
aliases:
- aws_access_key_id
- aws_access_key
- ec2_access_key
description:
- AWS access key ID.
- See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
- The C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variables
may also be used in decreasing order of preference.
- The I(aws_access_key) and I(profile) options are mutually exclusive.
- The I(aws_access_key_id) alias was added in release 5.1.0 for consistency with the
AWS botocore SDK.
- The I(ec2_access_key) alias has been deprecated and will be removed in a release
after 2024-12-01.
- Support for the C(EC2_ACCESS_KEY) environment variable has been deprecated and will
be removed in a release after 2024-12-01.
type: str
aws_config:
description:
- A dictionary to modify the botocore configuration.
- Parameters can be found in the AWS documentation U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config).
type: dict
purge_tags:
default: true
description:
- If I(purge_tags=true) and I(tags) is set, existing tags will be purged from the
resource to match exactly what is defined by I(tags) parameter.
- If the I(tags) parameter is not set then tags will not be modified, even if I(purge_tags=True).
- Tag keys beginning with C(aws:) are reserved by Amazon and can not be modified. As
such they will be ignored for the purposes of the I(purge_tags) parameter. See
the Amazon documentation for more information U(https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions).
required: false
type: bool
secret_key:
aliases:
- aws_secret_access_key
- aws_secret_key
- ec2_secret_key
description:
- AWS secret access key.
- See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
- The C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment
variables may also be used in decreasing order of preference.
- The I(secret_key) and I(profile) options are mutually exclusive.
- The I(aws_secret_access_key) alias was added in release 5.1.0 for consistency with
the AWS botocore SDK.
- The I(ec2_secret_key) alias has been deprecated and will be removed in a release
after 2024-12-01.
- Support for the C(EC2_SECRET_KEY) environment variable has been deprecated and will
be removed in a release after 2024-12-01.
type: str
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
endpoint_url:
aliases:
- ec2_url
- aws_endpoint_url
- s3_url
description:
- URL to connect to instead of the default AWS endpoints. While this can be used
to connection to other AWS-compatible services the amazon.aws and community.aws
collections are only tested against AWS.
- The C(AWS_URL) or C(EC2_URL) environment variables may also be used, in decreasing
order of preference.
- The I(ec2_url) and I(s3_url) aliases have been deprecated and will be removed in
a release after 2024-12-01.
- Support for the C(EC2_URL) environment variable has been deprecated and will be
removed in a release after 2024-12-01.
type: str
purge_routes:
default: false
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, in seconds, before wait gives up.
required: false
type: int
aws_ca_bundle:
description:
- The location of a CA Bundle to use when validating SSL certificates.
- The C(AWS_CA_BUNDLE) environment variable may also be used.
type: path
session_token:
aliases:
- aws_session_token
- security_token
- aws_security_token
- access_token
description:
- AWS STS session token for use with temporary credentials.
- See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
- The C(AWS_SESSION_TOKEN), C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment
variables may also be used in decreasing order of preference.
- The I(security_token) and I(profile) options are mutually exclusive.
- Aliases I(aws_session_token) and I(session_token) were added in release 3.2.0, with
the parameter being renamed from I(security_token) to I(session_token) in release
6.0.0.
- The I(security_token), I(aws_security_token), and I(access_token) aliases have been
deprecated and will be removed in a release after 2024-12-01.
- Support for the C(EC2_SECRET_KEY) and C(AWS_SECURITY_TOKEN) environment variables
has been deprecated and will be removed in a release after 2024-12-01.
type: str
tunnel_options:
default: []
description:
- An optional list object containing no more than two dict members, each of which
may contain I(TunnelInsideCidr) and/or I(PreSharedKey) keys with appropriate string
values. AWS defaults will apply in absence of either of the aforementioned keys.
elements: dict
required: false
suboptions:
PreSharedKey:
description: The pre-shared key (PSK) to establish initial authentication between
the virtual private gateway and customer gateway.
type: str
TunnelInsideCidr:
description: The range of inside IP addresses for the tunnel.
type: str
type: list
validate_certs:
default: true
description:
- When set to C(false), SSL certificates will not be validated for communication with
the AWS APIs.
- Setting I(validate_certs=false) is strongly discouraged, as an alternative, consider
setting I(aws_ca_bundle) instead.
type: bool
vpn_gateway_id:
description:
- The ID of the virtual private gateway.
type: str
connection_type:
default: ipsec.1
description:
- The type of VPN connection.
- At this time only C(ipsec.1) is supported.
type: str
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.
type: str
customer_gateway_id:
description:
- The ID of the customer gateway.
type: str
debug_botocore_endpoint_logs:
default: false
description:
- Use a C(botocore.endpoint) logger to parse the unique (rather than total) C("resource:action")
API calls made during a task, outputing the set to the resource_actions key in the
task results. Use the C(aws_resource_action) callback to output to total list made
during a playbook.
- The C(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