community.aws.directconnect_virtual_interface 模块 – 管理 Direct Connect 虚拟接口

注意

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

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

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

要在 playbook 中使用它，请指定： community.aws.directconnect_virtual_interface。

community.aws 1.0.0 中的新增功能

概要

  • 创建、删除或修改 Direct Connect 公共或私有虚拟接口。

  • 在 5.0.0 版本之前，此模块称为 community.aws.aws_direct_connect_virtual_interface。使用方法没有改变。

别名：aws_direct_connect_virtual_interface

要求

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

  • 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 之后的一个版本中删除。

address_type

字符串

BGP 对等体的 IP 地址类型。

amazon_address

字符串

用于创建虚拟接口的 Amazon 地址 CIDR。

authentication_key

字符串

BGP 配置的身份验证密钥。

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。

bgp_asn

整数

用于边界网关协议 (BGP) 配置的自治系统 (AS) 编号。

默认值： 65000

cidr

列表 / 元素=字符串

用于创建公共虚拟接口的路由过滤器前缀 CIDR 列表。

customer_address

字符串

用于创建虚拟接口的客户地址 CIDR。

debug_botocore_endpoint_logs

布尔值

使用 botocore.endpoint 记录器来解析在任务期间进行的唯一（而不是总数）"resource:action" API 调用，并将集合输出到任务结果中的 resource_actions 密钥。使用 aws_resource_action 回调将输出到 playbook 期间进行的总数列表。

还可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。

选项

  • false ← (默认值)

  • true

direct_connect_gateway_id

字符串

用于创建私有虚拟接口的 Direct Connect 网关 ID。

创建私有虚拟接口需要virtual_gateway_id 或 direct_connect_gateway_id。这两个选项互斥。

endpoint_url

别名：ec2_url, aws_endpoint_url, s3_url

字符串

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

也可以使用AWS_URL或EC2_URL环境变量，优先级依次递减。

ec2_url 和 s3_url 别名已弃用，将在2024-12-01之后的发行版本中移除。

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

别名：link_aggregation_group_id, connection_id

字符串 / 必需

要与虚拟接口关联的链路聚合组或连接的ID。

名称

字符串

虚拟接口的名称。

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选项互斥。

公共

布尔值

虚拟接口的类型。

选项

  • false

  • true

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之后的发行版本中移除。

状态

字符串 / 必需

Direct Connect虚拟接口的所需状态。

选项

  • "存在"

  • "不存在"

validate_certs

布尔值

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

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

选项

  • false

  • true ← (默认)

virtual_gateway_id

字符串

创建私有虚拟接口所需的虚拟网关ID。

创建私有虚拟接口需要virtual_gateway_id 或 direct_connect_gateway_id。这两个选项互斥。

virtual_interface_id

字符串

虚拟接口ID。

VLAN

整数

VLAN ID。

默认值： 100

注释

注意

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

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

示例

---
- name: create an association between a LAG and connection
  community.aws.directconnect_virtual_interface:
    state: present
    name: "{{ name }}"
    link_aggregation_group_id: LAG-XXXXXXXX
    connection_id: dxcon-XXXXXXXX

- name: remove an association between a connection and virtual interface
  community.aws.directconnect_virtual_interface:
    state: absent
    connection_id: dxcon-XXXXXXXX
    virtual_interface_id: dxv-XXXXXXXX

返回值

此处记录了常见的返回值 此处，以下是此模块独有的字段

键

描述

address_family

字符串

BGP对等体的地址族。

返回：始终

示例： "ipv4"

amazon_address

字符串

分配给Amazon接口的IP地址。

返回：始终

示例： "169.254.255.1/30"

ASN

整数

用于边界网关协议 (BGP) 配置的自治系统 (AS) 编号。

返回：始终

示例： 65000

auth_key

字符串

BGP 配置的身份验证密钥。

返回：始终

示例： "0xZ59Y1JZ2oDOSh6YriIlyRE"

bgp_peers

复杂

在此虚拟接口上配置的BGP对等体的列表。

返回：始终

address_family

字符串

BGP对等体的地址族。

返回：始终

示例： "ipv4"

amazon_address

字符串

分配给Amazon接口的IP地址。

返回：始终

示例： "169.254.255.1/30"

ASN

整数

用于边界网关协议 (BGP) 配置的自治系统 (AS) 编号。

返回：始终

示例： 65000

auth_key

字符串

BGP 配置的身份验证密钥。

返回：始终

示例： "0xZ59Y1JZ2oDOSh6YriIlyRE"

bgp_peer_state

字符串

BGP对等体的状态（验证中、待处理、可用）

返回：始终

示例： "available"

bgp_status

字符串

BGP对等体的上下状态。

返回：始终

示例： "up"

customer_address

字符串

分配给客户接口的IP地址。

返回：始终

示例： "169.254.255.2/30"

changed

布尔值

指示虚拟接口是否已创建/修改/删除

返回：始终

示例： false

connection_id

字符串

连接的ID。此字段也用作使用多种连接类型（LAG、互连和/或连接）的操作的ID类型。

返回：始终

示例： "dxcon-fgb175av"

customer_address

字符串

分配给客户接口的IP地址。

返回：始终

示例： "169.254.255.2/30"

customer_router_config

字符串

生成客户路由器配置的信息。

返回：始终

direct_connect_gateway_id

字符串

Direct Connect网关的ID。这仅适用于私有虚拟接口。

返回：当public=False时

示例： "f7593767-eded-44e8-926d-a2234175835d"

位置

字符串

连接所在的位置。

返回：始终

示例： "EqDC2"

owner_account

字符串

将拥有新虚拟接口的AWS账户。

返回：始终

示例： "123456789012"

route_filter_prefixes

复杂

要在此区域中宣传到AWS网络的路由列表（公共虚拟接口）。

返回：始终

cidr

字符串

要在此区域中宣传到AWS网络的路由。

返回：始终

示例： "54.227.92.216/30"

virtual_gateway_id

字符串

到VPC的虚拟私有网关的ID。这仅适用于私有虚拟接口。

返回：当public=False时

示例： "vgw-f3ce259a"

virtual_interface_id

字符串

虚拟接口的ID。

返回：始终

示例： "dxvif-fh0w7cex"

virtual_interface_name

字符串

客户分配的虚拟接口名称。

返回：始终

示例： "test_virtual_interface"

virtual_interface_state

字符串

虚拟接口的状态（确认中、验证中、待处理、可用、已关闭、已拒绝）。

返回：始终

示例： "available"

virtual_interface_type

字符串

虚拟接口的类型（私有、公共）。

返回：始终

示例： "private"

VLAN

整数

VLAN ID。

返回：始终

示例： 100

作者

  • Sloane Hertel (@s-hertel)