openstack.cloud.baremetal_node_info 模块 – 从 OpenStack 检索裸机节点信息

注意

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

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

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

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

概要 

从 OpenStack 检索有关裸机节点的信息。

要求 

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

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 字符串	可用于验证 SSL API 请求的 CA 证书捆绑包的路径。
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"` ← (默认)
mac 字符串	用于尝试识别主机的 MAC 地址。
name 别名：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 配置文件，然后来自标准环境变量，最后来自 play 中的显式参数。有关更多信息，请访问 https://docs.openstack.org/openstacksdk/

示例 

- name: Gather information about all baremeal nodes
  openstack.cloud.baremetal_node_info:
    cloud: "devstack"
  register: nodes

- debug: var=nodes

- name: Gather information about a baremeal node
  openstack.cloud.baremetal_node_info:
    cloud: "devstack"
    name: "00000000-0000-0000-0000-000000000002"
  register: nodes

- debug: var=nodes

返回值 

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

键	描述
baremetal_nodes list / 元素=字典	与 `nodes` 相同，保留以实现向后兼容。返回：始终
nodes list / 元素=字典	裸机节点列表。根据您的云提供商，可能会返回下面列出的字典键的子集。返回：始终
allocation_id 字符串	与节点关联的分配的 UUID。如果非空，则将与 instance_id 相同（反之则不一定成立）。与 instance_id 不同，此字段是只读的。请使用 Allocation API 来删除分配。返回：成功
bios_interface 字符串	将用于此节点的 bios 接口。返回：成功
boot_interface 字符串	节点的引导接口，例如“pxe”。返回：成功
boot_mode 字符串	节点的引导模式，可以是“uefi”或“bios” 返回：成功
chassis_id 字符串	与此节点关联的机箱的 UUID。可能为空或 None。返回：成功
clean_step 字符串	当前的清除步骤。返回：成功
conductor 字符串	当前正在为节点提供服务的 conductor。返回：成功
conductor_group 字符串	节点的 conductor 组。返回：成功
console_interface 字符串	节点的控制台接口，例如“no-console”。返回：成功
created_at 字符串	裸机节点创建时间戳。返回：成功
deploy_interface 字符串	节点的部署接口，例如“direct”。返回：成功
deploy_step 字符串	当前部署步骤。返回：成功
driver 字符串	驱动程序的名称。返回：成功
driver_info 字典	驱动程序管理此节点所需的所有元数据。字段列表因驱动程序而异，可以从 /v1/drivers/<DRIVER_NAME>/properties 资源中检索。返回：成功
driver_internal_info 字典	由节点的驱动程序设置和存储的内部元数据。返回：成功
extra 字典	一组或多个任意的元数据键值对。返回：成功
fault 字符串	fault 指示 ironic 检测到的活动故障，通常节点处于“维护模式”。None 表示 ironic 未检测到任何故障。“power failure” 表示 ironic 未能从此节点检索电源状态。还有其他可能的类型，例如“clean failure”和“rescue abort failure”。返回：成功
id 字符串	资源的 UUID。返回：成功
inspect_interface 字符串	用于节点检查的接口。返回：成功
instance_id 字符串	与此节点关联的 Nova 实例的 UUID。返回：成功
instance_info 字典	用于自定义已部署映像的信息。可能包括根分区大小、base64 编码的配置驱动器和其他元数据。请注意，当实例被删除时，此字段会自动擦除（这是通过请求将节点配置状态更改为 DELETED 来完成的）。返回：成功
is_automated_clean_enabled 布尔值	指示节点是否将执行自动清理。返回：成功
is_console_enabled 布尔值	指示此节点上的控制台访问是否启用或禁用。返回：成功
is_maintenance 布尔值	此节点当前是否处于“维护模式”。将节点置于维护模式会将其从可用资源池中删除，并停止一些内部自动化。这可以手动发生（例如，通过 API 请求）或在 Ironic 检测到阻止与机器通信的硬件故障时自动发生。返回：成功
is_protected 布尔值	节点是否受保护，免于取消部署、重建和删除。返回：成功
is_retired 布尔值	节点是否已退役，因此不再提供，即从可管理状态移动到可用状态，并且在清理后最终会处于可管理状态（而不是可用状态）。返回：成功
is_secure_boot 布尔值	指示节点当前是否在启用安全启动的情况下启动。返回：成功
last_error 字符串	来自最近（最后）开始但未能完成的事务的任何错误。返回：成功
links list / elements=string	相对链接列表，包括自身链接和书签链接。返回：成功
maintenance_reason 字符串	用户可设置的关于此节点为何被置于维护模式的原因描述。返回：成功
management_interface 字符串	用于带外节点管理的接口。返回：成功
name 字符串	节点资源的人类可读标识符。可能未定义。某些词是保留的。返回：成功
network_interface 字符串	在为该节点连接网络时要使用的网络接口提供程序。返回：成功
owner 字符串	拥有该对象的租户的字符串或 UUID。返回：成功
port_groups list / elements=string	此节点上的 ironic 端口组列表。返回：成功
ports list / elements=string	此节点上的 ironic 端口列表。返回：成功
power_interface 字符串	用于在此节点上执行电源操作的接口，例如“ipmitool”。返回：成功
power_state 字符串	此节点当前的电源状态。通常为“power on”或“power off”，但如果 Ironic 无法确定电源状态（例如，由于硬件故障），则可能为“None”。返回：成功
properties 字典	此节点的物理特性。由 ironic-inspector 在检查期间填充。可以随时通过 REST API 编辑。返回：成功
protected_reason 字符串	节点被标记为受保护的原因。返回：成功
provision_state 字符串	此节点当前的配置状态。返回：成功
raid_config 字典	表示节点当前的 RAID 配置。随着清理功能的引入而引入。返回：成功
raid_interface 字符串	用于在此节点上配置 RAID 的接口。返回：成功
rescue_interface 字符串	用于节点救援的接口，例如“no-rescue”。返回：成功
reservation 字符串	如果持有锁，则持有此节点锁定的 Ironic Conductor 主机的名称。通常为“null”，但此字段对于调试很有用。返回：成功
resource_class 字符串	外部调度程序可以使用此字符串将此节点标识为特定类型资源的单元。有关更多详细信息，请参阅 https://docs.openstack.org/ironic/latest/install/configure-nova-flavors.html 返回：成功
retired_reason 字符串	节点被标记为退役的原因。返回：成功
states list / elements=string	指向状态集合的链接。返回：成功
storage_interface 字符串	用于在此节点上附加和分离卷的接口，例如“cinder”。返回：成功
target_power_state 字符串	如果已请求电源状态转换，则此字段表示请求的（即“目标”）状态，即“power on”或“power off”。返回：成功
target_provision_state 字符串	如果已请求配置操作，则此字段表示请求的（即“目标”）状态。请注意，节点在其转换到此目标状态的过程中可能会经历多个状态。例如，当请求将实例部署到 AVAILABLE 节点时，节点可能会经历以下状态更改过程：AVAILABLE -> DEPLOYING -> DEPLOYWAIT -> DEPLOYING -> ACTIVE 返回：成功
target_raid_config 字典	表示请求的节点 RAID 配置，该配置将在节点下次通过 CLEANING 状态时应用。随着清理功能的引入而引入。返回：成功
traits list / elements=string	此节点的特征列表。返回：成功
updated_at 字符串	裸机节点更新时间戳。返回：成功
vendor_interface 字符串	用于此节点上特定于供应商的功能的接口，例如“no-vendor”。返回：成功

作者

OpenStack Ansible SIG