amazon.aws.ec2_vpc_vpn_info 模块 – 收集 AWS 中 EC2 VPN 连接信息

注意

此模块是 amazon.aws 集合 (版本 9.0.0) 的一部分。

如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install amazon.aws。您需要其他要求才能使用此模块，请参阅 要求 获取详细信息。

要在 playbook 中使用它，请指定：amazon.aws.ec2_vpc_vpn_info。

community.aws 1.0.0 中的新增功能

概要

• 收集 AWS 中 EC2 VPN 连接信息。

要求

执行此模块的主机需要以下要求。

• python >= 3.6

• boto3 >= 1.28.0

• botocore >= 1.31.0

参数

参数	注释
access_key 别名：aws_access_key_id、aws_access_key、ec2_access_key 字符串	AWS 访问密钥 ID。 有关访问令牌的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 也可以使用 AWS_ACCESS_KEY_ID、AWS_ACCESS_KEY 或 EC2_ACCESS_KEY 环境变量，优先级依次递减。 aws_access_key 和 profile 选项是互斥的。 为与 AWS botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_access_key_id 别名。 ec2_access_key 别名已弃用，将在 2024-12-01 之后的一个版本中移除。 EC2_ACCESS_KEY 环境变量的支持已弃用，将在 2024-12-01 之后的一个版本中移除。
aws_ca_bundle 路径	验证 SSL 证书时使用的 CA 证书包的位置。 也可以使用 AWS_CA_BUNDLE 环境变量。
aws_config 字典	用于修改 botocore 配置的字典。 参数可以在 AWS 文档中找到 https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config。
debug_botocore_endpoint_logs 布尔值	使用 botocore.endpoint 日志记录器来解析在任务期间进行的唯一（而不是全部）"resource:action" API 调用，将集合输出到任务结果中的 resource_actions 密钥。使用 aws_resource_action 回调将输出到 playbook 期间进行的全部列表。 也可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。 选项 false ← (默认) true
endpoint_url 别名：ec2_url、aws_endpoint_url、s3_url 字符串	连接到的 URL，而不是默认的 AWS 端点。虽然这可以用于连接到其他与 AWS 兼容的服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行了测试。 也可以使用 AWS_URL 或 EC2_URL 环境变量，优先级依次递减。 ec2_url 和 s3_url 别名已弃用，将在 2024-12-01 之后的一个版本中移除。 EC2_URL 环境变量的支持已弃用，将在 2024-12-01 之后的一个版本中移除。
filters 字典	要应用的过滤器字典。每个字典项包含一个过滤器键和一个过滤器值。有关可能的过滤器，请参阅 https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpnConnections.html。 默认值： {}
profile 别名：aws_profile 字符串	用于身份验证的命名 AWS 配置文件。 有关命名配置文件的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html。 也可以使用 AWS_PROFILE 环境变量。 profile 选项与 aws_access_key、aws_secret_key 和 security_token 选项互斥。
region 别名：aws_region, ec2_region 字符串	要使用的 AWS 区域。 对于 IAM、Route53 和 CloudFront 等全局服务，将忽略 region。 也可以使用 AWS_REGION 或 EC2_REGION 环境变量。 有关更多信息，请参阅 Amazon AWS 文档 http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region。 ec2_region 别名已弃用，将在 2024-12-01 之后的发行版中删除。 EC2_REGION 环境变量的支持已弃用，将在 2024-12-01 之后的发行版中删除。
secret_key 别名：aws_secret_access_key, aws_secret_key, ec2_secret_key 字符串	AWS 密钥访问密钥。 有关访问令牌的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 也可以按优先级递减的顺序使用 AWS_SECRET_ACCESS_KEY、AWS_SECRET_KEY 或 EC2_SECRET_KEY 环境变量。 secret_key 和 profile 选项互斥。 为与 AWS botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_secret_access_key 别名。 ec2_secret_key 别名已弃用，将在 2024-12-01 之后的发行版中删除。 EC2_SECRET_KEY 环境变量的支持已弃用，将在 2024-12-01 之后的发行版中删除。
session_token 别名：aws_session_token, security_token, aws_security_token, access_token 字符串	用于临时凭证的 AWS STS 会话令牌。 有关访问令牌的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 也可以按优先级递减的顺序使用 AWS_SESSION_TOKEN、AWS_SECURITY_TOKEN 或 EC2_SECURITY_TOKEN 环境变量。 security_token 和 profile 选项互斥。 在 3.2.0 版本中添加了 aws_session_token 和 session_token 别名，在 6.0.0 版本中将参数名称从 security_token 重命名为 session_token。 security_token、aws_security_token 和 access_token 别名已弃用，将在 2024-12-01 之后的发行版中删除。 EC2_SECRET_KEY 和 AWS_SECURITY_TOKEN 环境变量的支持已弃用，将在 2024-12-01 之后的发行版中删除。
validate_certs 布尔值	设置为 false 时，将不会验证与 AWS API 通信的 SSL 证书。 强烈建议不要设置 validate_certs=false，作为替代方案，请考虑改用 aws_ca_bundle。 选项 false true ← (默认)
vpn_connection_ids 列表 / 元素=字符串	使用 VPN 连接 ID/ID 获取特定 EC2 VPN 连接的详细信息。此值应作为列表提供。 默认值： []

备注

注意

• 注意：对于模块，环境变量和配置文件是从 Ansible 的“主机”上下文而不是“控制器”上下文读取的。因此，可能需要将文件显式复制到“主机”。对于查找和连接插件，环境变量和配置文件是从 Ansible 的“控制器”上下文而不是“主机”上下文读取的。

• Ansible 使用的 AWS SDK (boto3) 也可能从 Ansible“主机”上下文中的配置文件（通常为 ~/.aws/credentials）读取凭据和其他设置（例如区域）的默认值。有关更多信息，请参阅 https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html。

示例

# # Note: These examples do not set authentication details, see the AWS Guide for details.
- name: Gather information about all  EC2 VPN Connections
  amazon.aws.ec2_vpc_vpn_info:

- name: Gather information about a filtered list of  EC2 VPN Connections, based on tags
  amazon.aws.ec2_vpc_vpn_info:
    filters:
      "tag:Name": "test-connection"
  register: vpn_conn_info

- name: Gather information about EC2 VPN Connections by specifying connection IDs
  amazon.aws.ec2_vpc_vpn_info:
    filters:
      "vpn-gateway-id": "vgw-cbe66beb"
  register: vpn_conn_info

返回值

常见的返回值已在 此处 记录，以下是此模块特有的字段

键	描述
vpn_connections 列表 / 元素=字典	一个或多个 EC2 VPN 连接的列表。 返回：始终
category 字符串	VPN 连接的类别。 返回：始终 示例： "VPN"
customer_gateway_id 字符串	VPN 连接您一侧的客户网关的 ID。 返回：始终 示例： "cgw-17a53c37"
customer_gatway_configuration 字符串	VPN 连接的客户网关的配置信息（采用原生 XML 格式）。 返回：始终
gateway_association_state 字符串	网关关联的当前状态。 返回：成功 示例： "associated"
options 列表 / 元素=字典	VPN 连接选项。 返回：成功
enable_acceleration 布尔值	指示是否为 VPN 连接启用了加速。 返回：成功 示例： false
local_ipv4_network_cidr 字符串	VPN 连接客户网关（本地）侧的 IPv4 CIDR。 返回：成功 示例： "0.0.0.0/0"
outside_ip_address_type 字符串	VPN 隧道的外部 IP 地址。 返回：成功 示例： "PublicIpv4"
remote_ipv4_network_cidr 字符串	VPN 连接 Amazon Web Services 侧的 IPv4 CIDR。 返回：成功 示例： "0.0.0.0/0"
static_routes_only 布尔值	如果 VPN 连接仅允许静态路由。 返回：成功 示例： true
tunnel_inside_ip_version 字符串	指示 VPN 隧道处理 IPv4 或 IPv6 流量。 返回：成功 示例： "ipv4"
tunnel_options 列表 / 元素=字典	指示 VPN 隧道选项。 返回：成功 示例： [{"log_options": {"cloud_watch_log_options": {"log_enabled": false}}, "outside_ip_address": "34.225.101.10", "pre_shared_key": "8n7hnjNE8zhIt4VpMOIfcrw6XnUTHLW9", "tunnel_inside_cidr": "169.254.31.8/30"}]
log_options 字典	记录 VPN 隧道活动的选项。 返回：成功
cloud_watch_log_options 字典	将 VPN 隧道日志发送到 CloudWatch 的选项。 返回：成功
outside_ip_address 字符串	VPN 隧道的外部 IP 地址。 返回：成功
pre_shared_key 字符串	用于在虚拟专用网关和客户网关之间建立初始身份验证的预共享密钥 (PSK)。 返回：成功
tunnel_inside_cidr 字符串	隧道的内部 IPv4 地址范围。 返回：成功
routes 列表 / 元素=字典	与 VPN 连接关联的静态路由列表。 返回：始终
destination_cidr_block 字符串	与客户数据中心的本地子网关联的 CIDR 块。 返回：成功
source 字符串	指示路由的提供方式。 返回：成功
state 字符串	静态路由的当前状态。 返回：成功
state 字符串	VPN 连接的当前状态。 返回：始终 示例： "available"
tags 字典	分配给 VPN 连接的任何标签。 返回：始终 示例： {"Name": "test-conn"}
type 字符串	VPN 连接的类型。 返回：始终 示例： "ipsec.1"
vgw_telemetry 字典	有关 VPN 隧道的信息。 返回：始终
accepted_route_count 整数	已接受路由的数量。 返回：始终 示例： 0
certificate_arn 字符串	虚拟专用网关隧道端点证书的 Amazon 资源名称。 返回：使用私有证书进行身份验证时 示例： "arn:aws:acm:us-east-1:123456789012:certificate/c544d8ce-20b8-4fff-98b0-example"
last_status_change 字符串	状态最后更改的日期和时间。 返回：始终 示例： "2018-02-09T14:35:27+00:00"
outside_ip_address 字符串	虚拟专用网关外部接口的可路由互联网 IP 地址。 返回：始终 示例： "13.127.79.191"
状态 字符串	VPN 隧道的状态。 返回：始终 示例： "DOWN"
状态消息 字符串	如果发生错误，则为错误描述。 返回：始终 示例： "IPSEC" IS "DOWN"
vpn_connection_id 字符串	VPN 连接的 ID。 返回：始终 示例： "vpn-f700d5c0"
vpn_gateway_id 字符串	VPN 连接 AWS 端虚拟专用网关的 ID。 返回：始终 示例： "vgw-cbe56bfb"

作者

• Madhura Naniwadekar (@Madhura-CSI)

资源链接

• 问题追踪
• 代码仓库
• 通信