dellemc.openmanage.idrac_boot модуль – Настройка порядка загрузки.

Примечание

Этот модуль является частью коллекции dellemc.openmanage (версия 9.7.0).

У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install dellemc.openmanage. Для использования этого модуля требуются дополнительные условия, см. Требования для получения подробностей.

Чтобы использовать его в книге задач, укажите: 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 строка	Полное имя файла устройства загрузки. Этот параметр взаимоисключает 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, до тех пор, пока этот параметр не будет изменён на «Отключено». Состояние устанавливается в `once` для однократного переопределения загрузки и в `continuous` для сохранения переопределения до отмены. Если состояние установлено в `once` или `continuous`, значение сбрасывается до `disabled` после успешного выполнения действий boot_source_override_target. Изменения в этом параметре не изменяют постоянную конфигурацию порядка загрузки BIOS. Этот параметр взаимоисключает boot_options. Варианты: `"continuous"` `"disabled"` `"once"`
boot_source_override_mode строка	Режим загрузки BIOS (Legacy или UEFI), который используется при загрузке с источника boot_source_override_target. `legacy` Система загружается в режиме загрузки без UEFI (Legacy) с boot_source_override_target. `uefi` Система загружается в режиме загрузки UEFI с boot_source_override_target. Этот параметр взаимоисключает boot_options. Варианты: `"legacy"` `"uefi"`
boot_source_override_target строка	Целевое устройство переопределения источника загрузки, которое будет использоваться при следующей загрузке вместо обычного устройства загрузки. `pxe` выполняет PXE загрузку с основного сетевого адаптера. `floppy`, `cd`, `hdd`, `sd_card` выполняет загрузку с соответствующих устройств. `bios_setup` выполняет загрузку в стандартное BIOS-меню настроек. `utilities` выполняет загрузку с локальных утилити. `uefi_target` выполняет загрузку с устройства UEFI, путь к которому указан в uefi_target_boot_source_override. Если 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	Файл Privacy Enhanced Mail (PEM), содержащий сертификат CA, который будет использоваться для проверки.
idrac_ip строка / обязательно	IP-адрес iDRAC.
idrac_password псевдонимы: idrac_pwd строка	Пароль пользователя iDRAC. Если пароль не указан, используется переменная среды `IDRAC_PASSWORD`. Пример: export IDRAC_PASSWORD=пароль
idrac_port целое число	Порт iDRAC. По умолчанию: `443`
idrac_user строка	Имя пользователя iDRAC. Если имя пользователя не указано, используется переменная среды `IDRAC_USERNAME`. Пример: export IDRAC_USERNAME=имя_пользователя
job_wait булево	Предоставляет возможность ожидать завершения задачи. Применимо, когда reset_type равно `force_reset` или `graceful_reset`. Варианты: `false` `true` ← (по умолчанию)
job_wait_timeout целое число	Максимальное время ожидания job_wait в секундах. Задача отслеживается только в течение этого периода. Этот параметр применим, когда job_wait равно `true`. По умолчанию: `900`

reset_type string	`none` Система хоста не перезагружается, и job_wait не применяется. `force_restart` Принудительно перезагрузить систему хоста. `graceful_restart` Перезагрузить систему хоста в безопасном режиме. Варианты: `"graceful_restart"` ← (по умолчанию) `"force_restart"` `"none"`
resource_id string	Идентификатор Redfish ресурса.
timeout integer добавлено в dellemc.openmanage 5.0.0	Таймаут уровня сокета в секундах. По умолчанию: `30`
uefi_target_boot_source_override string	Путь к UEFI устройству, с которого следует загружаться, когда boot_source_override_target равен `uefi_target`. boot_source_override_enabled не может быть установлено в c(непрерывно), если boot_source_override_target установлено в `uefi_target` , так как эта настройка в UEFI определена как одноразовая настройка загрузки. Изменения в этой опции не изменят конфигурацию постоянного порядка загрузки BIOS. Это необходимо, если boot_source_override_target равен `uefi_target`. Это взаимоисключающее условие с boot_options.
validate_certs boolean добавлено в dellemc.openmanage 5.0.0	Если `false`, сертификаты SSL не будут проверены. Настройка `false` выполняется только на контролируемых вами сайтах, где используются самозаверяющие сертификаты. До версии коллекции `5.0.0`, validate_certs был `false` по умолчанию. Варианты: `false` `true` ← (по умолчанию)
x_auth_token string добавлено в 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": "Collection of BootOptions", "Members": [{"BootOptionEnabled": false, "BootOptionReference": "HardDisk.List.1-1", "Description": "Current settings of the Legacy Boot option", "DisplayName": "Hard drive C:", "Id": "HardDisk.List.1-1", "Name": "Legacy Boot option", "UefiDevicePath": "VenHw(D6C0639F-C705-4EB9-AA4F-5802D8823DE6)"}], "Name": "Boot Options Collection"}, "BootOrder": ["HardDisk.List.1-1"], "BootSourceOverrideEnabled": "Disabled", "BootSourceOverrideMode": "Legacy", "BootSourceOverrideTarget": "None", "UefiTargetBootSourceOverride": null}
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."}}`
job словарь	Подробности о настроенной задаче. Возвращается: успех Пример: `{"ActualRunningStartTime": "2019-06-19T00:57:24", "ActualRunningStopTime": "2019-06-19T01:00:27", "CompletionTime": "2019-06-19T01:00:27", "Description": "Job Instance", "EndTime": "TIME_NA", "Id": "JID_609237056489", "JobState": "Completed", "JobType": "BIOSConfiguration", "Message": "Job completed successfully.", "MessageArgs": [], "MessageId": "PR19", "Name": "Configure: BIOS.Setup.1-1", "PercentComplete": 100, "StartTime": "2019-06-19T00:55:05", "TargetSettingsURI": null}`
msg строка	Настройки загрузки успешно обновлены. Возвращается: успех Пример: `"Successfully updated the boot settings."`

Авторы

Felix Stephen (@felixs88)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/dellemc/openmanage/idrac_boot_module.html