openstack.cloud.baremetal_inspect 模块 – 在 ironic 中显式触发裸金属节点自省。

注意

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

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

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

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

概要

• 请求 Ironic 将节点设置为检查状态，以便收集有关节点的元数据。此命令可能是带外或带内，具体取决于 ironic 驱动程序的配置。这仅适用于状态为“可管理”和“可用”的节点。

要求

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

• python >= 3.6

• openstacksdk >= 1.0.0

参数

参数	注释
api_timeout 整数	套接字层在 API 调用超时之前应等待多长时间。如果省略此参数，则不会将任何内容传递给 requests 库。
auth 字典	包含云的 auth 插件策略所需的 auth 信息的字典。对于默认的 *password* 插件，这将包含 *auth_url*、*username*、*password*、*project_name* 以及云支持的任何有关域的信息（例如，*user_domain_name* 或 *project_domain_name*）。对于其他插件，此参数需要包含该 auth 插件所需的任何参数。如果提供了命名云或存在 OpenStack OS_* 环境变量，则不需要此参数。
auth_type 字符串	要使用的 auth 插件的名称。如果云使用密码身份验证以外的其他方法，则应在此处指示插件的名称，并相应地更新 *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" ← (默认)
mac 字符串	用于尝试识别主机的唯一 MAC 地址。
name 别名：id, uuid 字符串	要检查的节点的名称或 ID。 与 *mac* 互斥
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/

示例

# Invoke node inspection
- openstack.cloud.baremetal_inspect:
    name: "testnode1"

返回值

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

键	描述
node 字典	描述节点检查后信息的字典 返回：changed
allocation_id 字符串	与节点关联的分配的UUID。 返回：success
bios_interface 字符串	此节点要使用的BIOS接口。 返回：success
boot_interface 字符串	节点的启动接口，例如“pxe”。 返回：success
boot_mode 字符串	当前的启动模式状态（uefi/bios）。 返回：success
chassis_id 字符串	与该节点关联的底盘的UUID。 返回：success
clean_step 字符串	当前的清理步骤。随清理功能引入。 返回：success
conductor 字符串	当前为节点提供服务的conductor。 返回：success
conductor_group 字符串	节点的conductor组。 返回：success
console_interface 字符串	使用串口控制台时要使用的控制台接口。 返回：success 示例："no-console"
created_at 字符串	上次更新节点的时间戳。 返回：success
deploy_interface 字符串	节点的部署接口 返回：success 示例："iscsi"
deploy_step 字符串	当前的部署步骤。 返回：success
driver 字符串	驱动程序的名称。 返回：success
driver_info 字典	驱动程序管理此节点所需的所有元数据。字段列表因驱动程序而异。 返回：success
driver_internal_info 字典	由节点的驱动程序设置和存储的内部元数据。 返回：success
extra 字典	一组或多组任意元数据键值对。 返回：success
fault 字符串	故障指示ironic检测到的活动故障，通常节点处于“维护模式”。None表示ironic未检测到故障。“power failure”表示ironic未能从此节点检索电源状态。还有其他可能的类型，例如“clean failure”和“rescue abort failure”。 返回：success
id 字符串	资源的UUID。 返回：success
inspect_interface 字符串	用于节点检查的接口。 返回：success 示例："no-inspect"
instance_id 字符串	与该节点关联的Nova实例的UUID。 返回：success
instance_info 字典	用于定制已部署映像的信息。可能包括根分区大小、base 64编码的配置驱动器和其他元数据。请注意，当实例被删除时，此字段会自动清除（这是通过请求将节点配置状态更改为DELETED来完成的）。 返回：success
is_automated_clean_enabled 布尔值	覆盖自动清理的启用。 返回：success
is_console_enabled 布尔值	指示在此节点上是否启用或禁用控制台访问。 返回：success
is_maintenance 布尔值	此节点当前是否处于“维护模式”。将节点设置为维护模式会将其从可用资源池中移除并停止某些内部自动化。这可以手动进行（例如，通过API请求），也可以在Ironic检测到阻止与机器通信的硬件故障时自动进行。 返回：success
is_protected 布尔值	节点是否受保护，防止取消部署、重建和删除。 返回：success
is_retired 布尔值	节点是否标记为已停用。 返回：success
is_secure_boot 布尔值	节点当前是否启用安全启动启动。 返回：success
last_error 字符串	最近（最后）一个已启动但未能完成的事务的任何错误。 返回：success
links 列表 / 元素=字符串	相对链接列表。包括自身和书签链接。 返回：success
maintenance_reason 字符串	用户可设置的描述，说明此节点被置于维护模式的原因。 返回：success
management_interface 字符串	用于带外节点管理的接口。 返回：success 示例："ipmitool"
name 字符串	节点资源的人类可读标识符。某些单词是保留的。 返回：success
network_interface 字符串	为此节点连接网络连接时要使用的网络接口提供程序。 返回：success
owner 字符串	拥有该对象的租户的字符串或UUID。 返回：success
port_groups 列表 / 元素=字符串	指向此节点上端口组集合的链接。 返回：success
ports 列表 / 元素=字符串	指向此节点上端口集合的链接 返回：success
power_interface 字符串	用于对节点执行电源操作的接口。 返回：success 示例："ipmitool"
power_state 字符串	此节点的当前电源状态。通常为“power on”或“power off”，但如果Ironic无法确定电源状态（例如，由于硬件故障），则可能为“None”。 返回：success
properties 字典	检查发现的节点属性 返回：success
cpu_arch 字符串	检测到的CPU架构类型 返回：success 示例："x86_64"
cpus 字符串	在更新的节点属性中定义的CPU内核数。 返回：success 示例："1"
local_gb 字符串	在节点属性中更新的本地磁盘存储的总大小。 返回：success 示例："10"
memory_mb 字符串	节点内存量，在节点属性中更新 返回：success 示例："1024"
protected_reason 字符串	节点被标记为受保护的原因。 返回：success
provision_state 字符串	此节点的当前配置状态。 返回：success
raid_config 字典	表示节点的当前RAID配置。随清理功能引入。 返回：success
raid_interface 字符串	用于在此节点上配置RAID的接口。 返回：success 示例："no-raid"
rescue_interface 字符串	用于节点救援的接口。 返回：success 示例："no-rescue"
reservation 字符串	如果持有锁，则持有此节点锁的Ironic Conductor主机名称。通常为“null”，但此字段可用于调试。 返回：success
resource_class 字符串	外部调度程序可用于将此节点标识为特定类型资源单元的字符串。 返回：success
retired_reason 字符串	待办 返回：success
states 列表 / 元素=字符串	指向状态集合的链接。请注意，此资源也用于请求状态转换。 返回：success
storage_interface 字符串	用于在此节点上附加和分离卷的接口，例如“cinder”。 返回：success
target_power_state 字符串	如果已请求电源状态转换，则此字段表示请求的（即“目标”）状态，“power on”或“power off”。 返回：success
target_provision_state 字符串	如果已请求配置操作，则此字段表示请求的（即“目标”）状态。请注意，节点在其转换为此目标状态的过程中可能会经历多个状态。例如，当请求将实例部署到可用的节点时，节点可能会经历以下状态更改过程：AVAILABLE -> DEPLOYING -> DEPLOYWAIT -> DEPLOYING -> ACTIVE。 返回：success
target_raid_config 字典	表示请求的节点RAID配置，该配置将在节点下次转换到CLEANING状态时应用。随清理功能引入。 返回：success
traits 列表 / 元素=字符串	此节点的特征列表。 返回：success
updated_at 字符串	待办 返回：success
vendor_interface 字符串	用于此节点上特定于供应商的功能的接口，例如“no-vendor”。 返回：success

作者

• OpenStack Ansible SIG

集合链接

• 问题追踪器
• 代码库（源代码）