dellemc.openmanage.redfish_firmware_rollback 模块 – 使用组件名称执行组件固件回滚

注意

此模块是 dellemc.openmanage 集合 (版本 9.9.0) 的一部分。

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

要安装它，请使用：ansible-galaxy collection install dellemc.openmanage。您需要其他要求才能使用此模块，请参阅要求以了解详细信息。

要在剧本中使用它，请指定：dellemc.openmanage.redfish_firmware_rollback。

dellemc.openmanage 8.2.0 中的新增功能

概要 

此模块允许回滚不同服务器组件的固件。
根据组件的不同，固件更新将在自动或手动重启后应用。

要求 

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

python >= 3.9.6

参数 

参数	注释
baseuri 字符串 / 必需	目标带外控制器的 IP 地址。例如 - <ipaddress>:<port>。
ca_path 路径在 dellemc.openmanage 5.0.0 中添加	包含用于验证的 CA 证书的隐私增强邮件 (PEM) 文件。
name 字符串 / 必需	要匹配的组件名称或正则表达式，区分大小写。
password 字符串	目标带外控制器的密码。如果未提供密码，则使用环境变量 `IDRAC_PASSWORD`。示例：export IDRAC_PASSWORD=password
reboot 布尔值	重启服务器以应用先前版本的固件。 `true` 重启服务器以将固件回滚到可用版本。 `false` 将固件回滚计划到下次重启。当 reboot 为 `false` 时，某些组件会立即更新，服务器可能会重启。因此，模块必须等到服务器可访问。选项 `false` `true` ← (默认)
reboot_timeout 整数	等待时间（秒）。模块将等待此持续时间直到服务器重启。默认值： `900`
timeout 整数在 dellemc.openmanage 5.0.0 中添加	以秒为单位的套接字级别超时。默认值： `30`
username 字符串	目标带外控制器的用户名。如果未提供用户名，则使用环境变量 `IDRAC_USERNAME`。示例：export IDRAC_USERNAME=username
validate_certs 布尔值在 dellemc.openmanage 5.0.0 中添加	如果 `false`，则不会验证 SSL 证书。仅在使用自签名证书的个人控制站点上配置 `false`。在集合版本 `5.0.0` 之前，validate_certs 默认值为 `false`。选项 `false` `true` ← (默认)
x_auth_token 字符串在 dellemc.openmanage 9.3.0 中添加	身份验证令牌。如果未提供 x_auth_token，则使用环境变量 `IDRAC_X_AUTH_TOKEN`。示例：export IDRAC_X_AUTH_TOKEN=x_auth_token

备注 

注意

从此模块可以直接访问 Redfish API 的系统运行此模块。
对于不需要重启的组件，无论 reboot 为 true 还是 false，固件回滚都会继续进行。
此模块支持 IPv4 和 IPv6 地址。
此模块支持 check_mode。

示例 

---
- name: Rollback a BIOS component firmware
  dellemc.openmanage.redfish_firmware_rollback:
    baseuri: "192.168.0.1"
    username: "user_name"
    password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    name: "BIOS"

- name: Rollback all NIC cards with a name starting from 'Broadcom Gigabit'.
  dellemc.openmanage.redfish_firmware_rollback:
    baseuri: "192.168.0.1:443"
    username: "user_name"
    password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    name: "Broadcom Gigabit Ethernet.*"

- name: Rollback all the component firmware except BIOS component.
  dellemc.openmanage.redfish_firmware_rollback:
    baseuri: "192.168.0.1:443"
    username: "user_name"
    password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    name: "(?!BIOS).*"

- name: Rollback all the available firmware component.
  dellemc.openmanage.redfish_firmware_rollback:
    baseuri: "192.168.0.1:443"
    username: "user_name"
    password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    name: ".*"

返回值 

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

键	描述
error_info 字典	HTTP 错误的详细信息。返回：HTTP 错误时示例： `{"error": {"@Message.ExtendedInfo": [{"Message": "InstanceID 值在更新操作中无效", "MessageArgs": [], "[email protected]": 0, "MessageId": "IDRAC.2.8.SUP024", "RelatedProperties": [], "[email protected]": 0, "Resolution": "枚举清单，复制 InstanceID 值，并在更新操作中提供该值。", "Severity": "警告"}], "code": "Base.1.12.GeneralError", "message": "发生一般错误。请参阅 ExtendedInfo 获取更多信息"}}`
消息字符串	固件整体回滚状态。返回值：始终示例： `"固件回滚作业已成功完成"`
状态列表 / 元素=字符串	来自 iDRAC 的固件回滚作业和进度详情。返回值：成功示例： `[{"ActualRunningStartTime": "2023-08-04T12:26:55", "ActualRunningStopTime": "2023-08-04T12:32:35", "CompletionTime": "2023-08-04T12:32:35", "Description": "作业实例", "EndTime": "TIME_NA", "Id": "JID_911698303631", "JobState": "已完成", "JobType": "FirmwareUpdate", "Message": "作业已成功完成。", "MessageArgs": [], "MessageId": "PR19", "Name": "固件回滚：固件", "PercentComplete": 100, "StartTime": "2023-08-04T12:23:50", "TargetSettingsURI": null}]`

作者

Felix Stephen (@felixs88)