Spec-Zone.ru › Ansible

Модуль dellemc.openmanage.idrac_boot — настройка параметров порядка загрузки.

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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

list / elements=dictionary

Параметры включения или отключения загрузочных устройств.

Несовместим с параметрами boot_order, boot_source_override_mode, boot_source_override_enabled, boot_source_override_target и uefi_target_boot_source_override.

boot_option_reference

string

FQDD загрузочного устройства.

Несовместим с параметром display_name.

display_name

string

Отображаемое имя загрузочного устройства.

Несовместим с параметром boot_option_reference.

enabled

boolean / обязательный

Включение или отключение загрузочного устройства.

Варианты:

  • false
  • true

boot_order

list / elements=string

Этот параметр позволяет задать требуемую последовательность загрузочных устройств.

Несовместим с параметром boot_options.

boot_source_override_enabled

string

Состояние функции переопределения источника загрузки.

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

string

Режим загрузки BIOS (Legacy или UEFI), используемый при загрузке с источника boot_source_override_target.

legacy Система загружается с устройства boot_source_override_target в режиме загрузки без UEFI (Legacy).

uefi Система загружается с устройства boot_source_override_target в режиме UEFI.

Для iDRAC 17G и более поздних версий это свойство доступно только для чтения.

Несовместим с параметром boot_options.

Варианты:

  • "legacy"
  • "uefi"

boot_source_override_target

string

Целевое устройство для переопределения источника загрузки, используемое при следующей загрузке вместо обычного загрузочного устройства.

pxe выполняет загрузку PXE с основного NIC.

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, если параметр boot_source_override_enabled не указан.

Изменение этого параметра не влияет на постоянную конфигурацию порядка загрузки BIOS.

Для iDRAC 17G и более поздних версий этот параметр обязателен, если boot_source_override_enabled имеет значение once или continuous.

Для iDRAC 17G и более поздних версий этот параметр не является идемпотентным.

Несовместим с параметром boot_options.

Варианты:

  • "uefi_http"
  • "sd_card"
  • "uefi_target"
  • "utilities"
  • "bios_setup"
  • "hdd"
  • "cd"
  • "floppy"
  • "pxe"
  • "none"

ca_path

path

добавлен в dellemc.openmanage 5.0.0

Файл Privacy Enhanced Mail (PEM), содержащий сертификат центра сертификации, используемый для проверки.

idrac_ip

string / обязательный

IP-адрес iDRAC.

idrac_password

псевдонимы: idrac_pwd

string

Пароль пользователя iDRAC.

Если пароль не указан, используется переменная среды IDRAC_PASSWORD.

Пример: export IDRAC_PASSWORD=password

idrac_port

integer

Порт iDRAC.

По умолчанию: 443

idrac_user

string

Имя пользователя iDRAC.

Если имя пользователя не указано, используется переменная среды IDRAC_USERNAME.

Пример: export IDRAC_USERNAME=username

job_wait

boolean

Позволяет дождаться завершения задания.

Применяется, если reset_type имеет значение force_reset или graceful_reset.

Варианты:

  • false
  • true ← (по умолчанию)

job_wait_timeout

integer

Максимальное время ожидания 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(continuous), если для 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

dictionary

Сведения о настроенных параметрах загрузки.

Возвращается: при успехе

Пример: {"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

dictionary

Сведения об ошибке 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

dictionary

Сведения о настроенном задании.

Возвращается: при успехе

Пример: {"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

string

Параметры загрузки успешно обновлены.

Возвращается: при успехе

Пример: "Successfully updated the boot settings."

Авторы

  • Felix Stephen (@felixs88)
  • Abhishek Sinha (@ABHISHEK-SINHA10)

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

  • Отслеживание проблем
  • Главная страница
  • Репозиторий (исходный код)

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API