ec2_vpc_vpn_facts – Gather facts about VPN Connections in AWS

From Get docs
Ansible/docs/2.8/modules/ec2 vpc vpn facts module


ec2_vpc_vpn_facts – Gather facts about VPN Connections in AWS

New in version 2.6.


Synopsis

  • Gather facts about VPN Connections in AWS.

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.


aliases: ec2_access_key, access_key

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.


aliases: ec2_secret_key, secret_key

debug_botocore_endpoint_logs

boolean

added in 2.8

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

filters

-

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.

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.


aliases: access_token

validate_certs

boolean

  • no
  • yes

When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.

vpn_connection_ids

-

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_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
  • 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 facts about all vpn connections
  ec2_vpc_vpn_facts:

- name: Gather facts about a filtered list of vpn connections, based on tags
  ec2_vpc_vpn_facts:
    filters:
      "tag:Name": test-connection
  register: vpn_conn_facts

- name: Gather facts about vpn connections by specifying connection IDs.
  ec2_vpc_vpn_facts:
    filters:
      vpn-gateway-id: vgw-cbe66beb
  register: vpn_conn_facts

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




Status

Authors

  • Madhura Naniwadekar (@Madhura-CSI)

Hint

If you notice any issues in this documentation you can edit this document to improve it.


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/ec2_vpc_vpn_facts_module.html