dellemc.openmanage.idrac_boot 模块 – 配置启动顺序设置。

注意

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

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

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

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

dellemc.openmanage 6.1.0 中的新增功能

概要

• 此模块允许配置启动顺序设置。

需求

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

• python >= 3.9.6

参数

参数	注释
boot_options 列表 / 元素=字典	启用或禁用启动设备的选项。 这与boot_order、boot_source_override_mode、boot_source_override_enabled、boot_source_override_target 和 uefi_target_boot_source_override 互斥。
boot_option_reference 字符串	启动设备的 FQDD。 这与display_name 互斥。
display_name 字符串	启动源设备的显示名称。 这与boot_option_reference 互斥。
enabled 布尔值 / 必需	启用或禁用启动设备。 选项 false true
boot_order 列表 / 元素=字符串	此选项允许按所需的启动顺序设置启动设备。 这与boot_options 互斥。
boot_source_override_enabled 字符串	启动源覆盖功能的状态。 disabled 系统正常启动。 once 系统启动（一次）到 boot_source_override_target。 continuous 系统启动到 boot_source_override_target 中指定的目标，直到此属性设置为 Disabled。 对于一次性启动覆盖，状态设置为 once，对于保持活动状态直到取消的覆盖，状态设置为 continuous。如果状态设置为 once 或 continuous，则在 boot_source_override_target 操作成功完成之后，该值将重置为 disabled。 此选项的更改不会改变 BIOS 持久启动顺序配置。 这与boot_options 互斥。 选项 "continuous" "disabled" "once"
boot_source_override_mode 字符串	从 boot_source_override_target 启动源启动时要使用的 BIOS 启动模式（Legacy 或 UEFI）。 legacy 系统以非 UEFI（Legacy）启动模式启动到 boot_source_override_target。 uefi 系统以 UEFI 启动模式启动到 boot_source_override_target。 这与boot_options 互斥。 选项 "legacy" "uefi"
boot_source_override_target 字符串	在下次启动时使用的启动源覆盖目标设备，而不是正常的启动设备。 pxe 从主 NIC 执行 PXE 启动。 floppy、cd、hdd、sd_card 分别从其设备执行启动。 bios_setup 执行启动到本地 BIOS 设置。 utilities 从本地实用程序执行启动。 uefi_target 从 uefi_target_boot_source_override 中找到的 UEFI 设备路径执行启动。 如果 boot_source_override_target 设置为除 none 之外的值，则 boot_source_override_enabled 将自动设置为 once。 此选项的更改不会改变 BIOS 持久启动顺序配置。 这与boot_options 互斥。 选项 "uefi_http" "sd_card" "uefi_target" "utilities" "bios_setup" "hdd" "cd" "floppy" "pxe" "none"
ca_path 路径 在 dellemc.openmanage 5.0.0 中添加	包含用于验证的 CA 证书的隐私增强邮件 (PEM) 文件。
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 布尔值	提供等待作业完成的选项。 这适用于 reset_type 为 force_reset 或 graceful_reset 的情况。 选项 false true ← (默认)
job_wait_timeout 整数	job_wait 的最大等待时间（秒）。仅在此持续时间内跟踪作业。 此选项适用于 job_wait 为 true 的情况。 默认： 900
reset_type 字符串	none 主机系统不会重新启动，并且 job_wait 不适用。 force_restart 强制重新启动主机系统。 graceful_restart 正常重新启动主机系统。 选项 "graceful_restart" ← (默认) "force_restart" "none"
resource_id 字符串	资源的 Redfish ID。
timeout 整数 在 dellemc.openmanage 5.0.0 中添加	以秒为单位的套接字级别超时。 默认值： 30
uefi_target_boot_source_override 字符串	当boot_source_override_target 为 uefi_target 时，用于引导的设备的 UEFI 设备路径。 如果boot_source_override_target 设置为 uefi_target，则boot_source_override_enabled 无法设置为 c（连续），因为此设置在 UEFI 中定义为一次性引导设置。 此选项的更改不会改变 BIOS 持久启动顺序配置。 如果boot_source_override_target 为 uefi_target，则需要此参数。 这与boot_options 互斥。
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

备注

注意

• 从具有 Dell iDRAC 直接访问权限的系统运行此模块。

• 此模块支持 check_mode。

示例

---
- name: Configure the system boot options settings.
  dellemc.openmanage.idrac_boot:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    boot_options:
      - display_name: Hard drive C
        enabled: true
      - boot_option_reference: NIC.PxeDevice.2-1
        enabled: true

- name: Configure the boot order settings.
  dellemc.openmanage.idrac_boot:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    boot_order:
      - Boot0001
      - Boot0002
      - Boot0004
      - Boot0003

- name: Configure the boot source override mode.
  dellemc.openmanage.idrac_boot:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    boot_source_override_mode: legacy
    boot_source_override_target: cd
    boot_source_override_enabled: once

- name: Configure the UEFI target settings.
  dellemc.openmanage.idrac_boot:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    boot_source_override_mode: uefi
    boot_source_override_target: uefi_target
    uefi_target_boot_source_override: "VenHw(3A191845-5F86-4E78-8FCE-C4CFF59F9DAA)"

- name: Configure the boot source override mode as pxe.
  dellemc.openmanage.idrac_boot:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    boot_source_override_mode: legacy
    boot_source_override_target: pxe
    boot_source_override_enabled: continuous

返回值

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

键	描述
boot 字典	已配置的引导设置详细信息。 返回：成功 示例： {"BootOptions": {"Description": "BootOptions 集合", "Members": [{"BootOptionEnabled": false, "BootOptionReference": "HardDisk.List.1-1", "Description": "Legacy Boot 选项的当前设置", "DisplayName": "硬盘 C:", "Id": "HardDisk.List.1-1", "Name": "Legacy Boot 选项", "UefiDevicePath": "VenHw(D6C0639F-C705-4EB9-AA4F-5802D8823DE6)"}], "Name": "Boot Options 集合"}, "BootOrder": ["HardDisk.List.1-1"], "BootSourceOverrideEnabled": "Disabled", "BootSourceOverrideMode": "Legacy", "BootSourceOverrideTarget": "None", "UefiTargetBootSourceOverride": null}
error_info 字典	HTTP 错误的详细信息。 返回：HTTP 错误时 示例： {"error": {"@Message.ExtendedInfo": [{"Message": "由于发生错误，无法处理请求。", "MessageArgs": [], "MessageId": "GEN1234", "RelatedProperties": [], "Resolution": "重试操作。如果问题仍然存在，请联系您的系统管理员。", "Severity": "Critical"}], "code": "Base.1.0.GeneralError", "message": "发生一般错误。请参阅 ExtendedInfo 获取更多信息。"}
job 字典	已配置的作业详细信息。 返回：成功 示例： {"ActualRunningStartTime": "2019-06-19T00:57:24", "ActualRunningStopTime": "2019-06-19T01:00:27", "CompletionTime": "2019-06-19T01:00:27", "Description": "作业实例", "EndTime": "TIME_NA", "Id": "JID_609237056489", "JobState": "Completed", "JobType": "BIOSConfiguration", "Message": "作业已成功完成。", "MessageArgs": [], "MessageId": "PR19", "Name": "配置： BIOS.Setup.1-1", "PercentComplete": 100, "StartTime": "2019-06-19T00:55:05", "TargetSettingsURI": null}
msg 字符串	已成功更新引导设置。 返回：成功 示例： "已成功更新引导设置。"

作者

• Felix Stephen (@felixs88)

集合链接

• 问题跟踪器
• 主页
• 代码库（源代码）