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
参数
参数 |
注释 |
|---|---|
attributes 的应用时间。 这仅适用于 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 与 attributes、clear_pending 和 reset_bios 互斥。 job_wait 不适用。模块将等待直到此任务完成。 此功能已弃用，请使用 dellemc.openmanage.idrac_boot 来配置启动源。 |
|
包含用于验证的 CA 证书的隐私增强邮件 (PEM) 文件。 |
|
允许用户清除所有挂起的 BIOS 属性更改。
此操作不会创建任何作业。
这与 boot_sources、attributes 和 reset_bios 互斥。
选项
|
|
iDRAC IP 地址。 |
|
iDRAC 用户密码。 如果未提供密码，则使用环境变量 示例：export IDRAC_PASSWORD=password |
|
iDRAC 端口。 默认值： |
|
iDRAC 用户名。 如果未提供用户名，则使用环境变量 示例：export IDRAC_USERNAME=username |
|
提供等待作业完成的选项。 当 apply_time 为 选项
|
|
job_wait 的最大等待时间（以秒为单位）。作业仅在此持续时间内被跟踪。 当 job_wait 为 默认值： |
|
安排维护窗口的选项。 当 apply_time 为 |
|
维护窗口的持续时间（以秒为单位）。 |
|
要计划的维护窗口的开始时间。 格式为 YYYY-MM-DDThh:mm:ss<offset> <offset> 是 iDRAC 中当前时区设置的 UTC 时间偏移量，格式为：IST 的 +05:30。 |
|
将 BIOS 重置为默认设置，并触发主机系统重启。 这将在重启后应用于主机。 此操作不会创建任何作业。
此操作与 boot_sources、attributes 和 clear_pending 互斥。 当为 选项
|
|
当 apply_time 为 选项
|
|
（已弃用）具有 Ansible 用户读写权限的网络共享的本地挂载路径。 对于网络共享，此选项是必需的。 |
|
（已弃用）网络共享或本地路径。 |
|
（已弃用）网络共享用户密码。 对于 CIFS 共享，此选项是必需的。 |
|
（已弃用）网络共享用户名。如果用户是域的一部分，请使用 ‘user@domain’ 或 domain//user 格式。 对于 CIFS 共享，此选项是必需的。 |
|
套接字级别的超时时间（以秒为单位）。 默认值： |
|
如果为 仅在个人控制的使用自签名证书的站点上配置 在集合版本 选项
|
注释
注意
仅当执行 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
返回值
常用返回值已在此处记录 这里，以下是此模块特有的字段
键 |
描述 |
|---|---|
HTTP 错误的详细信息。 返回： 出现 HTTP 错误时 示例： |
|
提供的无效属性的字典。 返回：当属性或值无效时。 示例： |
|
boot_sources 的作业状态，或对 BIOS 执行的操作的状态。 返回：成功 示例： |
|
BIOS 操作的整体状态。 返回：成功 示例： |