ansible / ansible.builtin / v2.9.17 / module / _ec2_vpc_vpn_facts Gather information about VPN Connections in AWS. | "added in version" 2.6 of ansible.builtin" Authors: Madhura Naniwadekar (@Madhura-CSI) preview | supported by communityansible.builtin._ec2_vpc_vpn_facts (v2.9.17) — module
pip
Install with pip install ansible==2.9.17
Gather information about VPN Connections in AWS.
This module was called C(ec2_vpc_vpn_facts) before Ansible 2.9. The usage did not change.
# # Note: These examples do not set authentication details, see the AWS Guide for details. - name: Gather information about all vpn connections ec2_vpc_vpn_info:
- name: Gather information about a filtered list of vpn connections, based on tags ec2_vpc_vpn_info: filters: "tag:Name": test-connection register: vpn_conn_info
- name: Gather information about vpn connections by specifying connection IDs. ec2_vpc_vpn_info: filters: vpn-gateway-id: vgw-cbe66beb register: vpn_conn_info
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 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: - A dict of filters to apply. Each dict item consists of a filter key and a filter value. See U(https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpnConnections.html) for possible filters. required: false 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 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 validate_certs: default: true description: - When set to "no", SSL certificates will not be validated for communication with the AWS APIs. type: bool vpn_connection_ids: description: - Get details of a specific VPN connections using vpn connection ID/IDs. This value should be provided as a list. required: false 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
vpn_connections: contains: category: description: The category of the VPN connection. returned: always sample: VPN type: str customer_gateway_id: description: The ID of the customer gateway at your end of the VPN connection. returned: always sample: cgw-17a53c37 type: str customer_gatway_configuration: description: The configuration information for the VPN connection's customer gateway (in the native XML format). returned: always type: str options: description: The VPN connection options. returned: always sample: static_routes_only: false type: dict routes: contains: destination_cidr_block: description: The CIDR block associated with the local subnet of the customer data center. returned: always sample: 10.0.0.0/16 type: str state: description: The current state of the static route. returned: always sample: available type: str description: List of static routes associated with the VPN connection. returned: always type: complex state: description: The current state of the VPN connection. returned: always sample: available type: str tags: description: Any tags assigned to the VPN connection. returned: always sample: Name: test-conn type: dict type: description: The type of VPN connection. returned: always sample: ipsec.1 type: str vgw_telemetry: contains: accepted_route_count: description: The number of accepted routes. returned: always sample: 0 type: int certificate_arn: description: The Amazon Resource Name of the virtual private gateway tunnel endpoint certificate. returned: when a private certificate is used for authentication sample: arn:aws:acm:us-east-1:123456789101:certificate/c544d8ce-20b8-4fff-98b0-example type: str last_status_change: description: The date and time of the last change in status. returned: always sample: '2018-02-09T14:35:27+00:00' type: str outside_ip_address: description: The Internet-routable IP address of the virtual private gateway's outside interface. returned: always sample: 13.127.79.191 type: str status: description: The status of the VPN tunnel. returned: always sample: DOWN type: str status_message: description: If an error occurs, a description of the error. returned: always sample: IPSEC IS DOWN type: str description: Information about the VPN tunnel. returned: always type: complex vpn_connection_id: description: The ID of the VPN connection. returned: always sample: vpn-f700d5c0 type: str vpn_gateway_id: description: The ID of the virtual private gateway at the AWS side of the VPN connection. returned: always sample: vgw-cbe56bfb type: str description: List of one or more VPN Connections. returned: always type: complex