community.aws.ec2_vpc_vpn_info – Gather information about VPN Connections 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_vpn_info.

New in version 1.0.0: of community.aws

Synopsis

  • Gather information about VPN Connections in AWS.

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

Requirements

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

  • boto

  • boto3

  • python >= 2.6

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_DescribeVpnConnections.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.
vpn_connection_ids
list / elements=string
Get details of a specific VPN connections using vpn connection ID/IDs. This value should be provided as a list.

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 vpn connections
  community.aws.ec2_vpc_vpn_info:

- name: Gather information about a filtered list of vpn connections, based on tags
  community.aws.ec2_vpc_vpn_info:
    filters:
      "tag:Name": test-connection
  register: vpn_conn_info

- name: Gather information about vpn connections by specifying connection IDs.
  community.aws.ec2_vpc_vpn_info:
    filters:
      vpn-gateway-id: vgw-cbe66beb
  register: vpn_conn_info

Return Values

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

Key Returned Description
vpn_connections
complex
always
List of one or more VPN Connections.

 
category
string
always
The category of the VPN connection.

Sample:
VPN
 
customer_gateway_id
string
always
The ID of the customer gateway at your end of the VPN connection.

Sample:
cgw-17a53c37
 
customer_gatway_configuration
string
always
The configuration information for the VPN connection's customer gateway (in the native XML format).

 
options
dictionary
always
The VPN connection options.

Sample:
{'static_routes_only': False}
 
routes
complex
always
List of static routes associated with the VPN connection.

   
destination_cidr_block
string
always
The CIDR block associated with the local subnet of the customer data center.

Sample:
10.0.0.0/16
   
state
string
always
The current state of the static route.

Sample:
available
 
state
string
always
The current state of the VPN connection.

Sample:
available
 
tags
dictionary
always
Any tags assigned to the VPN connection.

Sample:
{'Name': 'test-conn'}
 
type
string
always
The type of VPN connection.

Sample:
ipsec.1
 
vgw_telemetry
complex
always
Information about the VPN tunnel.

   
accepted_route_count
integer
always
The number of accepted routes.

   
certificate_arn
string
when a private certificate is used for authentication
The Amazon Resource Name of the virtual private gateway tunnel endpoint certificate.

Sample:
arn:aws:acm:us-east-1:123456789101:certificate/c544d8ce-20b8-4fff-98b0-example
   
last_status_change
string
always
The date and time of the last change in status.

Sample:
2018-02-09T14:35:27+00:00
   
outside_ip_address
string
always
The Internet-routable IP address of the virtual private gateway's outside interface.

Sample:
13.127.79.191
   
status
string
always
The status of the VPN tunnel.

Sample:
DOWN
   
status_message
string
always
If an error occurs, a description of the error.

Sample:
IPSEC IS DOWN
 
vpn_connection_id
string
always
The ID of the VPN connection.

Sample:
vpn-f700d5c0
 
vpn_gateway_id
string
always
The ID of the virtual private gateway at the AWS side of the VPN connection.

Sample:
vgw-cbe56bfb


Authors

  • Madhura Naniwadekar (@Madhura-CSI)