community.aws.directconnect_connection 模块 – 创建、删除、修改 DirectConnect 连接

注意

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

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

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

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

community.aws 1.0.0 中的新增功能

概要

• 创建、更新或删除网络与特定 AWS Direct Connect 位置之间的 Direct Connect 连接。

• 创建时，可以将连接添加到链路聚合组或建立为独立连接。

• 稍后可以将连接与链路聚合组关联或取消关联。

• 在 5.0.0 版本之前，此模块名为 community.aws.aws_direct_connect_connection。用法没有改变。

别名：aws_direct_connect_connection

要求

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

• 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。
bandwidth 字符串	Direct Connect 连接的带宽。 当 state=present 时是必需的。 选择 "1Gbps" "10Gbps"
connection_id 字符串	Direct Connect 连接的 ID。 使用 forced_update 修改连接的属性将导致新的 Direct Connect 连接 ID。 必须指定 connection_id 或 name 之一。
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 之后的版本中删除。
forced_update 布尔值	要修改 bandwidth 或 location，需要删除并重新创建连接。 默认情况下，这不会发生。必须显式地将此选项设置为 true 才能更改 bandwith 或 location。 选择 false ← (默认) true
link_aggregation_group 字符串	要与连接关联的链路聚合组的 ID。 当需要独立连接时，这是可选的。
location 字符串	Direct Connect 连接所在的位置。 当 state=present 时是必需的。
name 字符串	Direct Connect 连接的名称。这是创建新连接所必需的。 必须指定 connection_id 或 name 之一。
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 secret access key。 有关访问令牌的更多信息，请参阅 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 之后的版本中删除。
state string / 必需	Direct Connect 连接的状态。 选择 "present" "absent"
validate_certs 布尔值	设置为 false 时，与 AWS API 通信时将不会验证 SSL 证书。 强烈建议不要设置 validate_certs=false，作为替代方法，请考虑设置 aws_ca_bundle。 选择 false true ← (默认)

备注

注意

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

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

示例

# create a Direct Connect connection
- community.aws.directconnect_connection:
    name: ansible-test-connection
    state: present
    location: EqDC2
    link_aggregation_group: dxlag-xxxxxxxx
    bandwidth: 1Gbps
  register: dc

# disassociate the LAG from the connection
- community.aws.directconnect_connection:
    state: present
    connection_id: dc.connection.connection_id
    location: EqDC2
    bandwidth: 1Gbps

# replace the connection with one with more bandwidth
- community.aws.directconnect_connection:
    state: present
    name: ansible-test-connection
    location: EqDC2
    bandwidth: 10Gbps
    forced_update: true

# delete the connection
- community.aws.directconnect_connection:
    state: absent
    name: ansible-test-connection

返回值

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

键	描述
connection 复杂	直接连接的属性。 返回： state=present
aws_device 字符串	物理连接终止的端点。 返回： 当请求的状态不再是 “requested” 时 示例： "EqDC2-12pmo7hemtz1z"
bandwidth 字符串	连接的带宽。 返回： 始终 示例： "1Gbps"
connection_id 字符串	连接的 ID。 返回： 始终 示例： "dxcon-ffy9ywed"
connection_name 字符串	连接的名称。 返回： 始终 示例： "ansible-test-connection"
connection_state 字符串	连接的状态。 返回： 始终 示例： "pending"
loa_issue_time 字符串	连接的授权书 - 连接设施分配的签发时间。 返回： 当 LOA-CFA 已签发时（连接状态将不再是 “requested”） 示例： "2018-03-20T17:36:26-04:00"
location 字符串	连接的位置。 返回： 始终 示例： "EqDC2"
owner_account 字符串	拥有直接连接的账户。 返回： 始终 示例： "123456789012"
region 字符串	连接所在的区域。 返回： 始终 示例： "us-east-1"

作者

• Sloane Hertel (@s-hertel)

集合链接

• 问题跟踪器
• 存储库 (源代码)
• 交流