community.general.wdc_redfish_command 模块 – 使用 Redfish API 管理 WDC UltraStar Data102 带外控制器

注意

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

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

要安装它，请使用：ansible-galaxy collection install community.general。

要在 playbook 中使用它，请指定：community.general.wdc_redfish_command。

community.general 5.4.0 中的新增功能

概要 

在本地构建 Redfish URI 并将其发送到远程 OOB 控制器以执行操作。
管理 OOB 控制器固件。例如，固件激活、更新和激活。

参数 

参数	注释
auth_token 字符串	用于与 OOB 控制器进行身份验证的安全令牌。
baseuri 字符串	OOB 控制器的基本 URI。必须包含此项或 `ioms`。
category 字符串 / 必需	在 OOB 控制器上执行的类别。
command 列表 / 元素=字符串 / 必需	要在 OOB 控制器上执行的命令列表。
ioms 列表 / 元素=字符串	机箱的 IOM FQDN 列表。必须包含此项或 `baseuri`。
password 字符串	用于与 OOB 控制器进行身份验证的密码。
resource_id 字符串 community.general 5.4.0 中添加	要修改的组件的 ID，例如 `Enclosure`、`IOModuleAFRU`、`PowerSupplyBFRU`、`FanExternalFRU3` 或 `FanInternalFRU`。
timeout 整数	对 OOB 控制器的 URL 请求的超时时间（以秒为单位）。默认值： `10`
update_creds 字典	用于检索更新映像的凭据。
password 字符串	用于检索更新映像的密码。
username 字符串	用于检索更新映像的用户名。
update_image_uri 字符串	更新映像的 URI。
username 字符串	用于与 OOB 控制器进行身份验证的用户。

属性 

属性	支持	描述
check_mode	支持：完全支持	可以在 `check_mode` 下运行，并在不修改目标的情况下返回更改状态预测。
diff_mode	支持：不支持	处于差异模式时，将返回有关已更改内容（或可能需要在 `check_mode` 中更改的内容）的详细信息。

备注 

注意

在清单中，您可以指定 baseuri 或 ioms。请参见示例部分。
ioms 是机箱 IOM 的 FQDN 列表。

示例 

- name: Firmware Activate (required after SimpleUpdate to apply the new firmware)
  community.general.wdc_redfish_command:
    category: Update
    command: FWActivate
    ioms: "{{ ioms }}"
    username: "{{ username }}"
    password: "{{ password }}"

- name: Firmware Activate with individual IOMs specified
  community.general.wdc_redfish_command:
    category: Update
    command: FWActivate
    ioms:
      - iom1.wdc.com
      - iom2.wdc.com
    username: "{{ username }}"
    password: "{{ password }}"

- name: Firmware Activate with baseuri specified
  community.general.wdc_redfish_command:
    category: Update
    command: FWActivate
    baseuri: "iom1.wdc.com"
    username: "{{ username }}"
    password: "{{ password }}"


- name: Update and Activate (orchestrates firmware update and activation with a single command)
  community.general.wdc_redfish_command:
    category: Update
    command: UpdateAndActivate
    ioms: "{{ ioms }}"
    username: "{{ username }}"
    password: "{{ password }}"
    update_image_uri: "{{ update_image_uri }}"
    update_creds:
      username: operator
      password: supersecretpwd

- name: Turn on enclosure indicator LED
  community.general.wdc_redfish_command:
    category: Chassis
    resource_id: Enclosure
    command: IndicatorLedOn
    username: "{{ username }}"
    password: "{{ password }}"

- name: Turn off IOM A indicator LED
  community.general.wdc_redfish_command:
    category: Chassis
    resource_id: IOModuleAFRU
    command: IndicatorLedOff
    username: "{{ username }}"
    password: "{{ password }}"

- name: Turn on Power Supply B indicator LED
  community.general.wdc_redfish_command:
    category: Chassis
    resource_id: PowerSupplyBFRU
    command: IndicatorLedOn
    username: "{{ username }}"
    password: "{{ password }}"

- name: Turn on External Fan 3 indicator LED
  community.general.wdc_redfish_command:
    category: Chassis
    resource_id: FanExternalFRU3
    command: IndicatorLedOn
    username: "{{ username }}"
    password: "{{ password }}"

- name: Turn on Internal Fan indicator LED
  community.general.wdc_redfish_command:
    category: Chassis
    resource_id: FanInternalFRU
    command: IndicatorLedOn
    username: "{{ username }}"
    password: "{{ password }}"

- name: Set chassis to Low Power Mode
  community.general.wdc_redfish_command:
    category: Chassis
    resource_id: Enclosure
    command: PowerModeLow

- name: Set chassis to Normal Power Mode
  community.general.wdc_redfish_command:
    category: Chassis
    resource_id: Enclosure
    command: PowerModeNormal

返回值 

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

键	描述
msg 字符串	包含操作结果或错误描述的消息返回：始终示例： `"Action was successful"`

作者

Mike Moerk (@mikemoerk)