community.general.idrac_redfish_command 模块 – 使用 iDRAC OEM Redfish API 管理带外控制器

注意

此模块是 community.general 集合 (版本 10.1.0) 的一部分。

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

要安装它,请使用: ansible-galaxy collection install community.general

要在剧本中使用它,请指定: community.general.idrac_redfish_command

概要

  • 在本地构建 Redfish URI 并将其发送到远程带外控制器以执行操作。

  • 用于需要 Redfish OEM 扩展的 Dell iDRAC 操作。

参数

参数

注释

auth_token

字符串

在 community.general 2.3.0 中添加

用于向 iDRAC 进行身份验证的安全令牌。

baseuri

字符串 / 必需

iDRAC 的基本 URI。

category

字符串 / 必需

在 iDRAC 上执行的类别。

command

列表 / 元素=字符串 / 必需

要在 iDRAC 上执行的命令列表。

password

字符串

用于向 iDRAC 进行身份验证的密码。

resource_id

字符串

在 community.general 0.2.0 中添加

要修改的系统、管理器或机箱的 ID。

timeout

整数

对 iDRAC 的 HTTP 请求的超时时间(秒)。

默认值: 10

username

字符串

用于向 iDRAC 进行身份验证的用户名。

属性

属性

支持

描述

check_mode

支持:不支持

可以在 check_mode 下运行并返回更改状态预测,而无需修改目标。

diff_mode

支持:不支持

在差异模式下,将返回有关已更改内容(或可能需要在 check_mode 中更改)的详细信息。

示例

- name: Create BIOS configuration job (schedule BIOS setting update)
  community.general.idrac_redfish_command:
    category: Systems
    command: CreateBiosConfigJob
    resource_id: System.Embedded.1
    baseuri: "{{ baseuri }}"
    username: "{{ username }}"
    password: "{{ password }}"

返回值

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

描述

msg

字符串

包含操作结果或错误描述的消息

返回:始终返回

示例: "Action was successful"

return_values

字典

在 community.general 6.6.0 中添加

包含来自操作的特定于命令的响应数据的字典。

返回:成功时返回

示例: {"job_id": "/redfish/v1/Managers/iDRAC.Embedded.1/Jobs/JID_471269252011"}

作者

  • Jose Delarosa (@jose-delarosa)