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 string	此网络端口的物理硬件地址，通常是硬件 MAC 地址。
api_timeout integer	套接字层在 API 调用超时之前应等待多长时间。如果省略此项，则不会将任何内容传递到 requests 库。
auth dictionary	包含云的身份验证插件策略所需的身份验证信息的字典。对于默认的password插件，这将包含 auth_url、username、password、project_name 和有关域的任何信息（例如，如果云支持它们，则为 user_domain_name 或 project_domain_name）。对于其他插件，此参数将需要包含该身份验证插件所需的任何参数。如果提供了命名云或存在 OpenStack OS_* 环境变量，则不需要此参数。
auth_type string	要使用的身份验证插件的名称。如果云使用密码身份验证以外的其他身份验证，则应在此处指示插件的名称，并且应相应地更新auth参数的内容。
ca_cert 别名: cacert string	可以用作验证 SSL API 请求的一部分的 CA 证书包的路径。
client_cert 别名: cert string	用作 SSL 事务一部分的客户端证书的路径。
client_key 别名: key string	用作 SSL 事务一部分的客户端密钥的路径。
cloud any	要操作的命名云或云配置。如果cloud是一个字符串，它会引用 OpenStack clouds.yaml 文件中定义的命名云配置。为auth和auth_type提供默认值。如果提供了auth或存在 OpenStack OS_* 环境变量，则不需要此参数。如果cloud是一个字典，则它包含完整的云配置，就像在 clouds.yaml 的一部分中一样。
interface 别名: endpoint_type string	要从服务目录中提取的端点 URL 类型。 选择 "admin" "internal" "public" ←（默认）
name 别名: uuid string	裸机端口的名称或 ID。
node string	裸机节点的名称或 ID。
region_name string	区域的名称。
sdk_log_level string	OpenStackSDK 的日志级别 选择 "INFO" ←（默认） "DEBUG"
sdk_log_path string	OpenStackSDK 的日志文件的路径。如果为空，则不写入日志
timeout integer	Ansible 应该等待请求的资源多长时间。 默认值: 180
validate_certs 别名: verify boolean	是否应该验证 SSL API 请求。 在 Ansible 2.3 之前，此值默认为 true。 选择 false true
wait boolean	Ansible 是否应该等待，直到请求的资源完成。 选择 false true ←（默认）

说明

注意

• 可以使用标准的 OpenStack 环境变量，例如 OS_USERNAME，而不是提供显式值。

• 身份验证信息由 openstacksdk 驱动，这意味着值可以来自 /etc/ansible/openstack.yaml、/etc/openstack/clouds.yaml 或 ~/.config/openstack/clouds.yaml 中的 yaml 配置文件，然后来自标准环境变量，最后来自剧本中的显式参数。 更多信息请访问 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

返回值

常见的返回值在这里文档中记录，以下是此模块特有的字段

键	描述
端口 列表 / 元素=字典	裸机端口列表。 返回值：总是
address string	此网络端口的物理硬件地址，通常是硬件 MAC 地址。 返回值：成功
created_at string	裸机端口创建的时间戳。 返回值：成功
额外 dictionary	一组或多组任意的元数据键值对。 返回值：成功
id string	裸机端口资源的 UUID。 返回值：成功
internal_info dictionary	由端口设置和存储的内部元数据。 此字段是只读的。 返回值：成功
is_pxe_enabled boolean	端口上是否启用或禁用 PXE。 返回值：成功
链接 列表 / 元素=字符串	相对链接的列表，包括 self 和 bookmark 链接。 返回值：成功
local_link_connection dictionary	端口绑定配置文件。 返回值：成功
port_id string	交换机上物理端口的标识符，节点的端口连接到该物理端口。 返回值：成功
switch_id string	交换机的 MAC 地址或基于 OpenFlow 的 datapath_id。 返回值：成功
switch_info string	一个可选的字符串字段，用于存储任何特定于供应商的信息。 返回值：成功
位置 dictionary	此资源的云位置（云、项目、区域、可用区） 返回值：成功
名称 string	裸机端口名称。 返回值：成功
node_id string	此资源所属的裸机节点的 UUID。 返回值：成功
physical_network string	端口连接到的物理网络的名称。 返回值：成功
port_group_id string	此资源所属的端口组的 UUID。 返回值：成功
updated_at string	裸机端口更新的时间戳。 返回值：成功

作者

• OpenStack Ansible SIG

集合链接

• 问题跟踪器
• 存储库（源代码）