openstack.cloud.trunk 模块 – 从 OpenStack 云添加或删除 Trunk。

注意

此模块是 openstack.cloud 集合（版本 2.3.0）的一部分。

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

要安装它，请使用：ansible-galaxy collection install openstack.cloud。您需要进一步的要求才能使用此模块，请参阅要求以了解详细信息。

要在 playbook 中使用它，请指定：openstack.cloud.trunk。

概要 

从 OpenStack 云添加或删除 Trunk。

要求 

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

python >= 3.6
openstacksdk >= 1.0.0

参数 

参数	注释
api_timeout 整数	套接字层在 API 调用超时之前应等待多长时间。如果省略此项，则不会将任何内容传递给 requests 库。
auth 字典	包含云的身份验证插件策略所需的身份验证信息的字典。对于默认的 password 插件，这将包含 auth_url、username、password、project_name 以及有关域的任何信息（例如，如果云支持 user_domain_name 或 project_domain_name）。对于其他插件，此参数将需要包含该身份验证插件所需的任何参数。如果提供了命名的云或存在 OpenStack OS_* 环境变量，则不需要此参数。
auth_type 字符串	要使用的身份验证插件的名称。如果云使用密码身份验证以外的其他方式，则应在此处指示插件的名称，并相应地更新 auth 参数的内容。
ca_cert 别名：cacert 字符串	CA 证书捆绑包的路径，可用作验证 SSL API 请求的一部分。
client_cert 别名：cert 字符串	用作 SSL 事务一部分的客户端证书的路径。
client_key 别名：key 字符串	用作 SSL 事务一部分的客户端密钥的路径。
cloud 任何	要操作的命名云或云配置。如果 cloud 是一个字符串，则它引用 OpenStack clouds.yaml 文件中定义的命名云配置。提供 auth 和 auth_type 的默认值。如果提供了 auth 或存在 OpenStack OS_* 环境变量，则不需要此参数。如果 cloud 是一个字典，则它包含一个完整的云配置，就像在 clouds.yaml 的一个部分中一样。
interface 别名：endpoint_type 字符串	要从服务目录中获取的端点 URL 类型。选择 `"admin"` `"internal"` `"public"` ← (默认)
name 字符串 / 必需	必须为 Trunk 提供的名称。此端口属性无法更新。
port 字符串	Trunk 的端口的名称或 ID。
region_name 字符串	区域的名称。
sdk_log_level 字符串	OpenStackSDK 的日志级别选择 `"INFO"` ← (默认) `"DEBUG"`
sdk_log_path 字符串	OpenStackSDK 的日志文件的路径。如果为空，则不写入日志
state 字符串	资源应存在还是不存在。选择 `"present"` ← (默认) `"absent"`
sub_ports 列表 / 元素=字典	Trunk 上的子端口。
port 字符串	端口的 ID 或名称。
segmentation_id 整数	要使用的分段 ID。
segmentation_type 字符串	要使用的分段类型。
timeout 整数	ansible 应等待请求的资源多长时间。默认： `180`
validate_certs 别名：verify 布尔值	是否应验证 SSL API 请求。在 Ansible 2.3 之前，此项默认为 `true`。选择 `false` `true`
wait 布尔值	ansible 是否应等待直到请求的资源完成。选择 `false` `true` ← (默认)

注释 

注意

可以使用标准的 OpenStack 环境变量，例如 OS_USERNAME，而不是提供显式值。
身份验证信息由 openstacksdk 驱动，这意味着值可以来自 /etc/ansible/openstack.yaml、/etc/openstack/clouds.yaml 或 ~/.config/openstack/clouds.yaml 中的 yaml 配置文件，然后来自标准环境变量，最后来自 playbook 中的显式参数。更多信息请访问 https://docs.openstack.org/openstacksdk/

示例 

# Create a trunk
- openstack.cloud.trunk:
    state: present
    auth:
      auth_url: https://identity.example.com
      username: admin
      password: admin
      project_name: admin
    name: trunk1
    port: port1

# Create a trunk with a subport
- openstack.cloud.trunk:
    state: present
    cloud: my-cloud
    name: trunk1
    port: port1
    sub_ports:
      - name: subport1
        segmentation_type: vlan
        segmentation_id: 123

# Remove a trunk
- openstack.cloud.trunk:
    state: absent
    auth:
      auth_url: https://identity.example.com
      username: admin
      password: admin
      project_name: admin
    name: trunk1

返回值 

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

键	描述
trunk 字典	描述 trunk 的字典。返回：当 state 为 `present` 时成功返回。
created_at 字符串	trunk 创建的时间戳。返回：成功示例： `"2022-02-03T13:28:25Z"`
description 字符串	trunk 的描述。返回：成功
id 字符串	trunk 的 ID。返回：成功示例： `"3ec25c97-7052-4ab8-a8ba-92faf84148de"`
is_admin_state_up 布尔值	trunk 的管理状态，启用 `True` 或禁用 `False`。返回：成功示例： `true`
name 字符串	trunk 的名称。返回：成功示例： `"trunk_name"`
port_id 字符串	trunk 的端口 ID 返回：成功示例： `"5ec25c97-7052-4ab8-a8ba-92faf84148df"`
project_id 字符串	拥有 trunk 的项目的 ID。返回：成功示例： `"aa1ede4f-3952-4131-aab6-3b8902268c7d"`
revision_number 整数	资源的修订号。返回：成功示例： `0`
status 字符串	trunk 的状态。值为 `ACTIVE` 或 `DOWN`。返回：成功示例： `"ACTIVE"`
sub_ports list / elements=string	trunk 上的子端口列表。返回：成功示例： `[]`
tags list / elements=string	资源上的标签列表。返回：成功示例： `[]`
tenant_id 字符串	与 project_id 相同。已弃用。返回：成功示例： `"51fce036d7984ba6af4f6c849f65ef00"`
updated_at 字符串	trunk 最后更新的时间戳。返回：成功示例： `"2022-02-03T13:28:25Z"`

作者

OpenStack Ansible SIG