Try SpotterGather information about VPN Connections in AWS.
| "added in version" 1.0.0 of community.aws"
Authors: Madhura Naniwadekar (@Madhura-CSI)
Install with ansible-galaxy collection install community.aws:==5.1.0
collections:
- name: community.aws
version: 5.1.0Gather information about VPN Connections in AWS.
# # 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
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
filters:
default: {}
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
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
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
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
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
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_connection_ids:
default: []
description:
- Get details of a specific VPN connections using vpn connection ID/IDs. This value
should be provided as a list.
elements: str
required: false
type: list
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
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:123456789012: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