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

参数

参数

注释

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_IDAWS_ACCESS_KEYEC2_ACCESS_KEY 环境变量,优先级递减。

aws_access_keyprofile 选项是互斥的。

为了与 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

connection_type

字符串

VPN 连接的类型。

目前仅支持 ipsec.1

默认值: "ipsec.1"

customer_gateway_id

字符串

客户网关的 ID。

debug_botocore_endpoint_logs

布尔值

使用 botocore.endpoint 记录器来解析任务期间发出的唯一(而不是总共)"resource:action" API 调用,并将集合输出到任务结果中的 resource_actions 键。使用 aws_resource_action 回调输出到 playbook 期间生成的总列表。

也可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。

选项

  • false ← (默认)

  • true

delay

整数

再次检查操作之前等待的时间(以秒为单位)。

默认值: 15

endpoint_url

别名:ec2_url, aws_endpoint_url, s3_url

字符串

连接到的 URL,而不是默认的 AWS 端点。虽然这可以用于连接到其他与 AWS 兼容的服务,但 amazon.aws 和 community.aws 集合仅针对 AWS 进行测试。

也可以使用 AWS_URLEC2_URL 环境变量,优先级递减。

ec2_urls3_url 别名已弃用,将在 2024-12-01 之后的版本中删除。

EC2_URL 环境变量的支持已弃用,将在 2024-12-01 之后的版本中删除。

filters

字典

作为使用 vpn_connection_id 的替代方案。如果找到多个匹配项,则需要 vpn_connection_id。如果以下子选项之一是要筛选的项目列表,则只需要匹配一个项目即可找到相关的 VPN。例如,如果筛选条件 filters.cidr["194.168.2.0/24", "192.168.2.0/24"],并且 VPN 路由仅具有目标 CIDR 块 192.168.2.0/24,则将使用此筛选条件找到它(假设没有多个匹配的 VPN)。另一个例子,如果筛选条件 filters.vpn 等于 ["vpn-ccf7e7ad", "vpn-cb0ae2a2"],并且其中一个 VPN 的状态已删除(存在但不可修改),而另一个 VPN 存在且未删除,则将通过此筛选条件找到它。

默认值: {}

bgp

字符串

与 BGP 设备关联的 BGP ASN 号。仅当连接已附加时才有效。此筛选选项目前不起作用。

cgw

字符串

客户网关 ID,可以是字符串或字符串列表。

cgw-config

字符串

VPN 的客户网关配置,可以是字符串(返回值的格式)或字符串列表。

cidr

字符串

VPN 路由的目标 CIDR,可以是字符串或字符串列表。

static-routes-only

布尔值

路由类型;truefalse

选项

  • false

  • true

tag-keys

字符串

标签的键,可以是字符串或字符串列表。

tag-values

字符串

标签的值,可以是字符串或字符串列表。

tags

字典

键值对的字典。

vgw

字符串

虚拟私有网关,可以是字符串或字符串列表。

vpn

字符串

VPN 连接 ID,可以是字符串或字符串列表。

local_ipv4_network_cidr

字符串

在 amazon.aws 9.0.0 中添加

VPN 连接的客户网关(本地)侧的 IPv4 CIDR。

默认值: "0.0.0.0/0"

profile

别名:aws_profile

字符串

用于身份验证的命名 AWS 配置文件。

有关命名配置文件的更多信息,请参阅 AWS 文档 https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html

也可以使用 AWS_PROFILE 环境变量。

profile 选项与 aws_access_keyaws_secret_keysecurity_token 选项互斥。

purge_routes

布尔值

是否删除任务中未指定的 VPN 连接路由。

选项

  • false ← (默认)

  • true

purge_tags

布尔值

如果 purge_tags=true 并且设置了 tags,则将从资源中清除现有标签,以精确匹配 tags 参数定义的标签。

如果未设置 tags 参数,则不会修改标签,即使 purge_tags=True

aws: 开头的标签键由 Amazon 保留,无法修改。因此,出于 purge_tags 参数的目的,将忽略它们。有关更多信息,请参阅 Amazon 文档 https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions

选项

  • false

  • true ← (默认)

region

别名:aws_region, ec2_region

字符串

要使用的 AWS 区域。

对于诸如 IAM、Route53 和 CloudFront 等全局服务,将忽略 region

也可以使用 AWS_REGIONEC2_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 之后的版本中删除。

routes

列表 / 元素=字符串

要添加到连接的路由。

默认值: []

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_KEYAWS_SECRET_KEYEC2_SECRET_KEY 环境变量,优先级依次降低。

secret_keyprofile 选项互斥。

为了与 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_TOKENAWS_SECURITY_TOKENEC2_SECURITY_TOKEN 环境变量,优先级依次降低。

security_tokenprofile 选项互斥。

在 3.2.0 版本中添加了别名 aws_session_tokensession_token,在 6.0.0 版本中将参数从 security_token 重命名为 session_token

security_tokenaws_security_tokenaccess_token 别名已被弃用,将在 2024-12-01 之后的版本中删除。

EC2_SECRET_KEYAWS_SECURITY_TOKEN 环境变量的支持已被弃用,将在 2024-12-01 之后的版本中删除。

state

字符串

VPN 连接的所需状态。

选项

  • "present" ← (默认)

  • "absent"

static_only

布尔值

指示 VPN 连接是否仅使用静态路由。对于不支持 BGP 的设备,必须使用静态路由。

选项

  • false ← (默认)

  • true

tags

别名:resource_tags

字典

表示要应用于资源的标签的字典。

如果未设置 tags 参数,则不会修改标签。

transit_gateway_id

字符串

在 amazon.aws 6.2.0 中添加

传输网关的 ID。

vpn_gateway_id 互斥。

tunnel_options

列表 / 元素=字典

一个可选的列表对象,其中包含不超过两个字典成员,每个成员可以包含带有适当字符串值的 tunnel_options.TunnelInsideCidr 和/或 tunnel_options.PreSharedKey 键。如果缺少上述任一键,则将应用 AWS 默认值。

默认值: []

PreSharedKey

字符串

用于在虚拟私有网关和客户网关之间建立初始身份验证的预共享密钥 (PSK)。

TunnelInsideCidr

字符串

隧道的内部 IPv4 地址范围。

TunnelInsideIpv6Cidr

字符串

在 amazon.aws 9.0.0 中添加

隧道的内部 IPv6 地址范围。

validate_certs

布尔值

设置为 false 时,与 AWS API 通信时将不验证 SSL 证书。

强烈建议不要设置 validate_certs=false,作为替代方案,请考虑设置 aws_ca_bundle

选项

  • false

  • true ← (默认)

vpn_connection_id

字符串

VPN 连接的 ID。如果筛选选项没有提供唯一匹配项,则修改或删除连接时需要此项。

vpn_gateway_id

字符串

虚拟私有网关的 ID。

transit_gateway_id 互斥。

wait_timeout

整数

等待放弃前的秒数。

默认值: 600

说明

注意

  • 注意: 对于模块,环境变量和配置文件是从 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"

返回值

通用返回值已在此处记录 此处,以下是此模块特有的字段

描述

changed

布尔值

如果 VPN 连接已更改。

返回: 总是

示例: true

customer_gateway_configuration

字符串

VPN 连接的配置。

返回: state=present

customer_gateway_id

字符串

通过连接连接的客户网关。

返回: state=present

示例: "cgw-1220c87b"

gateway_association_state

字符串

网关关联的当前状态。

返回: state=present

示例: "associated"

options

列表 / 元素=字典

VPN 连接选项。

返回: state=present

enable_acceleration

布尔值

指示是否为 VPN 连接启用了加速。

返回: state=present

示例: false

local_ipv4_network_cidr

字符串

VPN 连接的客户网关(本地)侧的 IPv4 CIDR。

返回: state=present

示例: "0.0.0.0/0"

outside_ip_address_type

字符串

VPN 隧道的外部 IP 地址。

返回: state=present

示例: "PublicIpv4"

remote_ipv4_network_cidr

字符串

VPN 连接的 Amazon Web Services 端的 IPv4 CIDR。

返回: state=present

示例: "0.0.0.0/0"

static_routes_only

布尔值

如果 VPN 连接仅允许静态路由。

返回: state=present

示例: true

tunnel_inside_ip_version

字符串

指示 VPN 隧道是否处理 IPv4 或 IPv6 流量。

返回: state=present

示例: "ipv4"

tunnel_options

列表 / 元素=字典

指示 VPN 隧道选项。

返回: state=present

示例: [{"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 隧道活动的选项。

返回: state=present

cloud_watch_log_options

字典

用于将 VPN 隧道日志发送到 CloudWatch 的选项。

返回: state=present

outside_ip_address

字符串

VPN 隧道的外部 IP 地址。

返回: state=present

pre_shared_key

字符串

预共享密钥 (PSK) 用于在虚拟私有网关和客户网关之间建立初始身份验证。

返回: state=present

tunnel_inside_cidr

字符串

隧道的内部 IPv4 地址范围。

返回: state=present

routes

列表 / 元素=字符串

VPN 连接的路由。

返回: state=present

示例: [{"destination_cidr_block": "192.168.1.0/24", "state": "available"}]

destination_cidr_block

字符串

与客户数据中心的本地子网关联的 CIDR 块。

返回: state=present

source

字符串

指示如何提供路由。

返回: state=present

state

字符串

静态路由的当前状态。

返回: state=present

state

字符串

VPN 连接的状态。

返回: state=present

示例: "available"

tags

字典

与连接关联的标签。

返回: state=present

示例: {"name": "ansible-test", "other": "tag"}

transit_gateway_id

字符串

可附加 VPN 连接的传输网关 ID。

返回: state=present

示例: "tgw-cb0ae2a2"

type

字符串

VPN 连接的类型(当前仅 ipsec.1 可用)。

返回: state=present

示例: "ipsec.1"

vgw_telemetry

列表 / 元素=字符串

VPN 隧道的遥测数据。

返回: state=present

示例: [{"accepted_route_count": 0, "last_status_change": "2024-09-30T13:12:33+00:00", "outside_ip_address": "34.225.101.10", "status": "DOWN", "status_message": "IPSEC IS DOWN"}]

accepted_route_count

整数

已接受的路由数。

返回: state=present

certificate_arn

字符串

虚拟私有网关隧道端点证书的 Amazon 资源名称。

返回: 当私有证书用于身份验证时

示例: "arn:aws:acm:us-east-1:123456789012:certificate/c544d8ce-20b8-4fff-98b0-example"

last_status_change

字符串

上次状态更改的日期和时间。

返回: state=present

outside_ip_address

字符串

虚拟私有网关外部接口的 Internet 可路由 IP 地址。

返回: state=present

status

字符串

VPN 隧道的状态。

返回: state=present

status_message

字符串

如果发生错误,则显示错误描述。

返回: state=present

vpn_connection_id

字符串

VPN 连接的标识符。

返回: state=present

示例: "vpn-781e0e19"

vpn_gateway_id

字符串

通过连接连接的虚拟私有网关。

返回: state=present

示例: "vgw-cb0ae2a2"

作者

  • Sloane Hertel (@s-hertel)