amazon.aws.ec2_vpc_vpn 模块 – 创建、修改和删除 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
。
community.aws 1.0.0 中的新功能
概要
此模块创建、修改和删除 VPN 连接。
通过使用
filters
选项或指定 VPN 连接标识符来实现幂等性。
要求
执行此模块的主机上需要满足以下要求。
python >= 3.6
boto3 >= 1.28.0
botocore >= 1.31.0
参数
参数 |
注释 |
---|---|
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 和 profile 选项是互斥的。 为了与 AWS botocore SDK 保持一致,在 5.1.0 版本中添加了 aws_access_key_id 别名。 ec2_access_key 别名已弃用,将在 2024-12-01 之后的版本中删除。 对 |
|
用于验证 SSL 证书的 CA 包的位置。 也可以使用 |
|
用于修改 botocore 配置的字典。 可以在 AWS 文档中找到参数 https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config。 |
|
VPN 连接的类型。 目前仅支持 默认值: |
|
客户网关的 ID。 |
|
使用 也可以使用 选项
|
|
再次检查操作之前等待的时间(以秒为单位)。 默认值: |
|
连接到的 URL,而不是默认的 AWS 端点。虽然这可以用于连接到其他与 AWS 兼容的服务,但 amazon.aws 和 community.aws 集合仅针对 AWS 进行测试。 也可以使用 ec2_url 和 s3_url 别名已弃用,将在 2024-12-01 之后的版本中删除。 对 |
|
作为使用 默认值: |
|
与 BGP 设备关联的 BGP ASN 号。仅当连接已附加时才有效。此筛选选项目前不起作用。 |
|
客户网关 ID,可以是字符串或字符串列表。 |
|
VPN 的客户网关配置,可以是字符串(返回值的格式)或字符串列表。 |
|
VPN 路由的目标 CIDR,可以是字符串或字符串列表。 |
|
路由类型; 选项
|
|
标签的键,可以是字符串或字符串列表。 |
|
标签的值,可以是字符串或字符串列表。 |
|
键值对的字典。 |
|
虚拟私有网关,可以是字符串或字符串列表。 |
|
VPN 连接 ID,可以是字符串或字符串列表。 |
|
VPN 连接的客户网关(本地)侧的 IPv4 CIDR。 默认值: |
|
用于身份验证的命名 AWS 配置文件。 有关命名配置文件的更多信息,请参阅 AWS 文档 https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html。 也可以使用 profile 选项与 aws_access_key、aws_secret_key 和 security_token 选项互斥。 |
|
是否删除任务中未指定的 VPN 连接路由。 选项
|
|
如果 如果未设置 以 选项
|
|
要使用的 AWS 区域。 对于诸如 IAM、Route53 和 CloudFront 等全局服务,将忽略 region。 也可以使用 有关更多信息,请参阅 Amazon AWS 文档 http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region。
对 |
|
要添加到连接的路由。 默认值: |
|
AWS 私有访问密钥。 有关访问令牌的更多信息,请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 也可以使用 secret_key 和 profile 选项互斥。 为了与 AWS botocore SDK 保持一致,在 5.1.0 版本中添加了 aws_secret_access_key 别名。 ec2_secret_key 别名已被弃用,将在 2024-12-01 之后的版本中删除。 对 |
|
用于临时凭证的 AWS STS 会话令牌。 有关访问令牌的更多信息,请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 也可以使用 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 之后的版本中删除。 对 |
|
VPN 连接的所需状态。 选项
|
|
指示 VPN 连接是否仅使用静态路由。对于不支持 BGP 的设备,必须使用静态路由。 选项
|
|
表示要应用于资源的标签的字典。 如果未设置 |
|
传输网关的 ID。 与 |
|
一个可选的列表对象,其中包含不超过两个字典成员,每个成员可以包含带有适当字符串值的 默认值: |
|
用于在虚拟私有网关和客户网关之间建立初始身份验证的预共享密钥 (PSK)。 |
|
隧道的内部 IPv4 地址范围。 |
|
隧道的内部 IPv6 地址范围。 |
|
设置为 强烈建议不要设置 validate_certs=false,作为替代方案,请考虑设置 aws_ca_bundle。 选项
|
|
VPN 连接的 ID。如果筛选选项没有提供唯一匹配项,则修改或删除连接时需要此项。 |
|
虚拟私有网关的 ID。 与 |
|
等待放弃前的秒数。 默认值: |
说明
注意
注意: 对于模块,环境变量和配置文件是从 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: Create a VPN connection with vpn_gateway_id
amazon.aws.ec2_vpc_vpn:
state: "present"
vpn_gateway_id: "vgw-XXXXXXXX"
customer_gateway_id: "cgw-XXXXXXXX"
- name: Attach a vpn connection to transit gateway
amazon.aws.ec2_vpc_vpn:
state: "present"
transit_gateway_id: "tgw-XXXXXXXX"
customer_gateway_id: "cgw-XXXXXXXX"
- name: Modify VPN connection tags
amazon.aws.ec2_vpc_vpn:
state: "present"
vpn_connection_id: "vpn-XXXXXXXX"
tags:
Name: "ansible-tag-1"
Other: "ansible-tag-2"
- name: Delete a connection
amazon.aws.ec2_vpc_vpn:
vpn_connection_id: "vpn-XXXXXXXX"
state: "absent"
- name: Modify VPN tags (identifying VPN by filters)
amazon.aws.ec2_vpc_vpn:
state: "present"
filters:
cidr: "194.168.1.0/24"
tag-keys:
- "Ansible"
- "Other"
tags:
New: "Tag"
purge_tags: true
static_only: true
- name: Set up VPN with tunnel options utilizing 'TunnelInsideCidr' only
amazon.aws.ec2_vpc_vpn:
state: "present"
filters:
vpn: "vpn-XXXXXXXX"
static_only: true
tunnel_options:
- TunnelInsideCidr: "169.254.100.1/30"
- TunnelInsideCidr: "169.254.100.5/30"
- name: Add routes and remove any preexisting ones
amazon.aws.ec2_vpc_vpn:
state: "present"
filters:
vpn: "vpn-XXXXXXXX"
routes:
- "195.168.2.0/24"
- "196.168.2.0/24"
purge_routes: true
- name: Remove all routes
amazon.aws.ec2_vpc_vpn:
state: "present"
vpn_connection_id: "vpn-XXXXXXXX"
routes: []
purge_routes: true
- name: Delete a VPN identified by filters
amazon.aws.ec2_vpc_vpn:
state: "absent"
filters:
tags:
Ansible: "Tag"
返回值
通用返回值已在此处记录 此处,以下是此模块特有的字段
键 |
描述 |
---|---|
如果 VPN 连接已更改。 返回: 总是 示例: |
|
VPN 连接的配置。 返回: |
|
VPN 连接选项。 返回: |
|
指示 VPN 隧道选项。 返回: 示例: |
|
用于记录 VPN 隧道活动的选项。 返回: |
|
用于将 VPN 隧道日志发送到 CloudWatch 的选项。 返回: |
|
VPN 隧道的外部 IP 地址。 返回: |
|
预共享密钥 (PSK) 用于在虚拟私有网关和客户网关之间建立初始身份验证。 返回: |
|
隧道的内部 IPv4 地址范围。 返回: |
|
VPN 连接的路由。 返回: 示例: |
|
与客户数据中心的本地子网关联的 CIDR 块。 返回: |
|
指示如何提供路由。 返回: |
|
静态路由的当前状态。 返回: |
|
VPN 隧道的遥测数据。 返回: 示例: |
|
已接受的路由数。 返回: |
|
虚拟私有网关隧道端点证书的 Amazon 资源名称。 返回: 当私有证书用于身份验证时 示例: |
|
上次状态更改的日期和时间。 返回: |
|
虚拟私有网关外部接口的 Internet 可路由 IP 地址。 返回: |
|
VPN 隧道的状态。 返回: |
|
如果发生错误,则显示错误描述。 返回: |
|