openstack.cloud.baremetal_port_info 模块 – 从 OpenStack 获取裸金属端口信息

注意

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

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

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

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

概要

  • 从 OpenStack 获取裸金属端口信息。

要求

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

  • python >= 3.6

  • openstacksdk >= 1.0.0

参数

参数

注释

address

字符串

此网络端口的物理硬件地址，通常是硬件 MAC 地址。

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

别名：uuid

字符串

裸金属端口的名称或 ID。

node

字符串

裸金属节点的名称或 ID。

region_name

字符串

区域的名称。

sdk_log_level

字符串

OpenStackSDK 的日志级别

选项

  • "INFO" ← (默认)

  • "DEBUG"

sdk_log_path

字符串

OpenStackSDK 日志文件的路径。如果为空，则不写入日志

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/ 找到

示例

- name: Gather information about all baremetal ports
  openstack.cloud.baremetal_port_info:
    cloud: devstack

- name: Gather information about a baremetal port by address
  openstack.cloud.baremetal_port_info:
    cloud: devstack
    address: fa:16:3e:aa:aa:aa

- name: Gather information about a baremetal port by address
  openstack.cloud.baremetal_port_info:
    cloud: devstack
    name: a2b6bd99-77b9-43f0-9ddc-826568e68dec

- name: Gather information about a baremetal ports associated with a node
  openstack.cloud.baremetal_port_info:
    cloud: devstack
    node: bm-0

返回值

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

键

描述

ports

列表 / 元素=字典

裸金属端口列表。

返回：始终

address

字符串

此网络端口的物理硬件地址，通常是硬件 MAC 地址。

返回：成功

created_at

字符串

裸金属端口创建时间戳。

返回：成功

extra

字典

一组或多组任意元数据键值对。

返回：成功

id

字符串

裸金属端口资源的 UUID。

返回：成功

internal_info

字典

端口设置并存储的内部元数据。此字段为只读。

返回：成功

is_pxe_enabled

布尔值

端口上是否启用PXE。

返回：成功

列表 / 元素=字符串

包含自身和书签链接的相对链接列表。

返回：成功

字典

端口绑定配置文件。

返回：成功

字符串

节点端口连接到的交换机上物理端口的标识符。

返回：成功

字符串

交换机的MAC地址或基于OpenFlow的datapath_id。

返回：成功

字符串

可选字符串字段，用于存储任何厂商特定的信息。

返回：成功

location

字典

此资源的云位置（云、项目、区域、可用区）。

返回：成功

name

字符串

裸金属端口名称。

返回：成功

node_id

字符串

此资源所属的裸金属节点的UUID。

返回：成功

physical_network

字符串

端口连接到的物理网络的名称。

返回：成功

port_group_id

字符串

此资源所属的端口组的UUID。

返回：成功

updated_at

字符串

裸金属端口更新时间戳。

返回：成功

作者

  • OpenStack Ansible SIG