New in version 2.6.
The below requirements are needed on the host that executes this module.
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. | |
filters | A dict of filters to apply. Each dict item consists of a filter key and a filter value. See http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpnConnections.html for possible filters. | |
profile (added in 1.6) | Uses a boto profile. Only works with boto >= 2.24.0. | |
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 | |
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 | |
validate_certs bool (added in 1.5) |
| 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. |
Note
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
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# # 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
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 | ||
tags dict | always | Any tags assigned to the VPN connection. Sample: {'Name': 'test-conn'} | ||
options dict | always | The VPN connection options. Sample: {'static_routes_only': False} | ||
customer_gatway_configuration string | always | The configuration information for the VPN connection's customer gateway (in the native XML format). | ||
state string | always | The current state of the VPN connection. Sample: available | ||
vpn_connection_id string | always | The ID of the VPN connection. Sample: vpn-f700d5c0 | ||
customer_gateway_id string | always | The ID of the customer gateway at your end of the VPN connection. Sample: cgw-17a53c37 | ||
routes complex | always | List of static routes associated with the VPN connection. | ||
state string | always | The current state of the static route. Sample: available | ||
destination_cidr_block string | always | The CIDR block associated with the local subnet of the customer data center. Sample: 10.0.0.0/16 | ||
vpn_gateway_id string | always | The ID of the virtual private gateway at the AWS side of the VPN connection. Sample: vgw-cbe56bfb | ||
type string | always | The type of VPN connection. Sample: ipsec.1 | ||
vgw_telemetry complex | always | Information about the VPN tunnel. | ||
accepted_route_count int | always | The number of accepted routes. |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/ec2_vpc_vpn_facts_module.html