dellemc.openmanage.idrac_bios 模块 – 修改和清除 BIOS 属性，重置 BIOS 设置并配置启动源

注意

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

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

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

要在 playbook 中使用它，请指定：dellemc.openmanage.idrac_bios。

dellemc.openmanage 2.1.0 中的新增功能

概要 

此模块允许修改 BIOS 属性。还清除挂起的 BIOS 属性并将 BIOS 重置为默认设置。
可以启用或禁用启动源。可以配置启动顺序。

要求 

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

omsdk >= 1.2.490
python >= 3.9.6

参数 

参数	注释
apply_time 字符串	应用属性的时间。这仅适用于属性。 `Immediate` 允许用户立即重新启动主机并应用更改。job_wait 可用。 `OnReset` 允许用户在下次重新启动主机服务器时应用更改。 `AtMaintenanceWindowStart` 允许用户在维护窗口开始时应用，如maintenance_window中指定。将安排重新启动作业。 `InMaintenanceWindowOnReset` 允许在手动重置后但在maintenance_window中指定的维护窗口内应用。选项 `"Immediate"` ← (默认) `"OnReset"` `"AtMaintenanceWindowStart"` `"InMaintenanceWindowOnReset"`
attributes 字典	BIOS 属性和值对的字典。属性应属于 Redfish Dell BIOS 属性注册表的一部分。使用 https://I(idrac_ip/redfish/v1/Systems/System.Embedded.1/Bios) 查看 Redfish URI。这与boot_sources、clear_pending和reset_bios互斥。
boot_sources 列表 / 元素=任意	(已弃用)设置启动源设置的启动设备列表。 boot_sources与attributes、clear_pending和reset_bios互斥。 job_wait不可用。模块等待此任务完成。此功能已弃用，请使用 dellemc.openmanage.idrac_boot 配置启动源。
ca_path 路径 dellemc.openmanage 5.0.0 中新增	包含用于验证的 CA 证书的隐私增强邮件 (PEM) 文件。
clear_pending 布尔值	允许用户清除所有挂起的 BIOS 属性更改。 `true` 将丢弃对 bios 属性的任何挂起更改，或在已调度状态下删除作业。此操作不会创建任何作业。 `false` 将不执行任何操作。这与boot_sources、attributes和reset_bios互斥。 `注意`由于启动源配置而安排的任何 BIOS 作业都不会被清除。选项 `false` `true`
idrac_ip 字符串 / 必需	iDRAC IP 地址。
idrac_password 别名：idrac_pwd 字符串 / 必需	iDRAC 用户密码。如果未提供密码，则使用环境变量 `IDRAC_PASSWORD`。示例：export IDRAC_PASSWORD=password
idrac_port 整数	iDRAC 端口。默认值： `443`
idrac_user 字符串 / 必需	iDRAC 用户名。如果未提供用户名，则使用环境变量 `IDRAC_USERNAME`。示例：export IDRAC_USERNAME=username
job_wait 布尔值	提供等待作业完成的选项。当apply_time为`Immediate`时，这适用于attributes。选项 `false` `true` ← (默认)
job_wait_timeout 整数	job_wait 的最大等待时间（秒）。仅在此期间跟踪作业。当job_wait为`true`时，此选项适用。默认值： `1200`
maintenance_window 字典	安排维护窗口的选项。当apply_time为`AtMaintenanceWindowStart`或`InMaintenanceWindowOnReset`时，这是必需的。
duration 整数 / 必需	维护窗口的持续时间（秒）。
start_time 字符串 / 必需	要安排的维护窗口的开始时间。格式为 YYYY-MM-DDThh:mm:ss 是从 UTC 的时间偏移量，即 iDRAC 中当前设置的时区，格式为：IST 的 +05:30。
reset_bios 布尔值	将 BIOS 重置为默认设置并触发主机系统的重新启动。重新启动后，这将应用于主机。此操作不会创建任何作业。 `false` 将不执行任何操作。这与boot_sources、attributes和clear_pending互斥。当 `true` 时，此操作将始终报告为发现适用的更改。选项 `false` `true`
reset_type 字符串	`force_restart` 强制重新启动主机系统。 `graceful_restart` 良性重新启动主机系统。当apply_time为`Immediate`时，这适用于reset_bios和attributes。选项 `"graceful_restart"` ← (默认) `"force_restart"`
share_mnt 字符串	(已弃用)网络共享的本地挂载路径，ansible用户具有读写权限。此选项对于网络共享是必需的。
share_name 字符串	(已弃用)网络共享或本地路径。
share_password 别名: share_pwd 字符串	(已弃用)网络共享用户密码。此选项对于CIFS共享是必需的。
share_user 字符串	(已弃用)网络共享用户名。使用格式 ‘user@domain’ 或 domain//user（如果用户属于域的一部分）。此选项对于CIFS共享是必需的。
timeout 整数 dellemc.openmanage 5.0.0 中新增	套接字级别超时（秒）。默认值: `30`
validate_certs 布尔值 dellemc.openmanage 5.0.0 中新增	如果 `false`，则不会验证SSL证书。仅在使用自签名证书的个人控制站点上配置 `false`。在集合版本 `5.0.0` 之前，validate_certs 默认值为 `false`。选项 `false` `true` ← (默认)

备注 

注意

仅当执行boot_sources操作时，才需要安装omsdk。
此模块需要idrac_user具有“管理员”权限。
从可以直接访问Dell iDRAC的系统运行此模块。
此模块支持idrac_ip的IPv4和IPv6地址。
此模块支持 check_mode。

示例 

---
- name: Configure generic attributes of the BIOS
  dellemc.openmanage.idrac_bios:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    attributes:
      BootMode: "Bios"
      OneTimeBootMode: "Enabled"
      BootSeqRetry: "Enabled"

- name: Configure PXE generic attributes
  dellemc.openmanage.idrac_bios:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    attributes:
      PxeDev1EnDis: "Enabled"
      PxeDev1Protocol: "IPV4"
      PxeDev1VlanEnDis: "Enabled"
      PxeDev1VlanId: 1
      PxeDev1Interface: "NIC.Embedded.1-1-1"
      PxeDev1VlanPriority: 2

- name: Configure BIOS attributes at Maintenance window
  dellemc.openmanage.idrac_bios:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    apply_time: AtMaintenanceWindowStart
    maintenance_window:
      start_time: "2022-09-30T05:15:40-05:00"
      duration: 600
    attributes:
      BootMode: "Bios"
      OneTimeBootMode: "Enabled"
      BootSeqRetry: "Enabled"

- name: Clear pending BIOS attributes
  dellemc.openmanage.idrac_bios:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    clear_pending: true

- name: Reset BIOS attributes to default settings.
  dellemc.openmanage.idrac_bios:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    validate_certs: false
    reset_bios: true

- name: Configure boot sources
  dellemc.openmanage.idrac_bios:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    boot_sources:
      - Name: "NIC.Integrated.1-2-3"
        Enabled: true
        Index: 0

- name: Configure multiple boot sources
  dellemc.openmanage.idrac_bios:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    boot_sources:
      - Name: "NIC.Integrated.1-1-1"
        Enabled: true
        Index: 0
      - Name: "NIC.Integrated.2-2-2"
        Enabled: true
        Index: 1
      - Name: "NIC.Integrated.3-3-3"
        Enabled: true
        Index: 2

- name: Configure boot sources - Enabling
  dellemc.openmanage.idrac_bios:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    boot_sources:
      - Name: "NIC.Integrated.1-1-1"
        Enabled: true

- name: Configure boot sources - Index
  dellemc.openmanage.idrac_bios:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    boot_sources:
      - Name: "NIC.Integrated.1-1-1"
        Index: 0

返回值 

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

键	描述
error_info 字典	HTTP错误的详细信息。返回: HTTP错误时示例: `{"error": {"@Message.ExtendedInfo": [{"Message": "Unable to process the request because an error occurred.", "MessageArgs": [], "MessageId": "GEN1234", "RelatedProperties": [], "Resolution": "Retry the operation. If the issue persists, contact your system administrator.", "Severity": "Critical"}], "code": "Base.1.0.GeneralError", "message": "A general error has occurred. See ExtendedInfo for more information."}}`
invalid_attributes 字典	提供的无效属性字典。返回: 属性或值无效时示例: `{"AcPwrRcvryUserDelay": "Integer out of valid range.", "AssetTag": "Attribute does not exist.", "BootSeqRetry": "Invalid value for Enumeration.", "Proc1Brand": "Read only Attribute cannot be modified.", "PxeDev1VlanId": "Not a valid integer."}`
msg 字典	boot_sources作业的状态或对bios执行的操作的状态。返回: 成功示例: `{"CompletionTime": "2020-04-20T18:50:20", "Description": "Job Instance", "EndTime": null, "Id": "JID_873888162305", "JobState": "Completed", "JobType": "ImportConfiguration", "Message": "Successfully imported and applied Server Configuration Profile.", "MessageArgs": [], "MessageId": "SYS053", "Name": "Import Configuration", "PercentComplete": 100, "StartTime": "TIME_NOW", "Status": "Success", "TargetSettingsURI": null, "retval": true}`
status_msg 字符串	BIOS操作的总体状态。返回: 成功示例: `"Successfully cleared pending BIOS attributes."`

作者

Felix Stephen (@felixs88)
Anooja Vardhineni (@anooja-vardhineni)
Jagadeesh N V (@jagadeeshnv)
Shivam Sharma (@shivam-sharma)