Spec-Zone.ru › Ansible

модуль dellemc.openmanage.idrac_bios — изменение и очистка атрибутов BIOS, сброс настроек BIOS и настройка источников загрузки

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: dellemc.openmanage.idrac_bios.

Добавлено в dellemc.openmanage 2.1.0

  • Краткое описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Этот модуль позволяет изменять атрибуты BIOS. Также он очищает ожидающие применения атрибуты BIOS и сбрасывает настройки BIOS до значений по умолчанию.
  • Источники загрузки можно включать и отключать. Можно настроить последовательность загрузки.

Требования

На хосте, выполняющем этот модуль, необходимы следующие компоненты.

  • omsdk >= 1.2.490
  • python >= 3.9.6

Параметры

Параметр

Комментарии

apply_time

string

Время применения атрибутов.

Применимо только к атрибутам.

Immediate Позволяет пользователю немедленно перезагрузить хост и применить изменения. Применим параметр job_wait.

OnReset Позволяет пользователю применить изменения при следующей перезагрузке сервера хоста.

AtMaintenanceWindowStart Позволяет применить изменения в начале окна обслуживания, заданного в maintenance_window. Будет запланировано задание на перезагрузку.

InMaintenanceWindowOnReset Позволяет применить изменения после ручного сброса, но в пределах окна обслуживания, заданного в maintenance_window.

Варианты:

  • "Immediate" ← (по умолчанию)
  • "OnReset"
  • "AtMaintenanceWindowStart"
  • "InMaintenanceWindowOnReset"

attributes

dictionary

Словарь пар «атрибут BIOS — значение». Атрибуты должны присутствовать в реестре атрибутов Dell BIOS Redfish. URI Redfish можно просмотреть по адресу https://I(idrac_ip/redfish/v1/Systems/System.Embedded.1/Bios).

Несовместим с параметрами boot_sources, clear_pending и reset_bios.

boot_sources

list / elements=any

(устарело) Список загрузочных устройств для настройки источников загрузки.

boot_sources несовместим с параметрами attributes, clear_pending и reset_bios.

Параметр job_wait неприменим. Модуль ожидает завершения этой задачи.

Эта функция устарела. Для настройки источников загрузки используйте dellemc.openmanage.idrac_boot.

ca_path

path

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

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

clear_pending

boolean

Позволяет пользователю очистить все ожидающие применения изменения атрибутов BIOS.

true отменит все ожидающие применения изменения атрибутов BIOS или удалит задание, если оно запланировано.

Эта операция не создает заданий.

false не выполняет никаких операций.

Несовместим с параметрами boot_sources, attributes и reset_bios.

Note Запланированные задания BIOS, созданные при настройке источников загрузки, очищены не будут.

Варианты:

  • false
  • true

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

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

Применимо к attributes, если значение apply_time — Immediate.

Варианты:

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

job_wait_timeout

integer

Максимальное время ожидания для job_wait в секундах. Отслеживание задания выполняется только в течение этого времени.

Этот параметр применяется, если job_wait имеет значение true.

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

maintenance_window

dictionary

Параметры планирования окна обслуживания.

Этот параметр обязателен, если значение apply_time — AtMaintenanceWindowStart или InMaintenanceWindowOnReset.

duration

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

Продолжительность окна обслуживания в секундах.

start_time

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

Время начала планируемого окна обслуживания.

Формат: YYYY-MM-DDThh:mm:ss<offset>

<offset> — смещение часового пояса, установленного в iDRAC, относительно UTC в формате +05:30 для IST.

reset_bios

boolean

Сбрасывает настройки BIOS до значений по умолчанию и инициирует перезагрузку хост-системы.

Изменения применяются к хосту после перезагрузки.

Эта операция не создает заданий.

false не выполняет никаких операций.

Несовместим с параметрами boot_sources, attributes и clear_pending.

Если true, это действие всегда будет отмечено как содержащее применимые изменения.

Варианты:

  • false
  • true

reset_type

string

force_restart Принудительно перезагрузить хост-систему.

graceful_restart Корректно перезагрузить хост-систему.

Применимо к reset_bios и attributes, если значение apply_time — Immediate.

Варианты:

  • "graceful_restart" ← (по умолчанию)
  • "force_restart"

share_mnt

string

(устарело) Локальный путь подключения сетевой папки с разрешениями на чтение и запись для пользователя ansible. Этот параметр обязателен для сетевых папок.

share_name

string

(устарело) Сетевая папка или локальный путь.

share_password

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

string

(устарело) Пароль пользователя сетевой папки. Этот параметр обязателен для папки CIFS.

share_user

string

(устарело) Имя пользователя сетевой папки. Используйте формат ‘user@domain’ или domain//user, если пользователь входит в домен. Этот параметр обязателен для папки CIFS.

timeout

integer

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

Тайм-аут на уровне сокета в секундах.

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

validate_certs

boolean

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

Если false, SSL-сертификаты проверяться не будут.

Устанавливайте false только на контролируемых вами сайтах, где используются самоподписанные сертификаты.

В версиях коллекции до 5.0.0 параметр validate_certs по умолчанию имеет значение false.

Варианты:

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

Примечания

Примечание

  • Установить omsdk требуется только для операции boot_sources.
  • Для использования этого модуля пользователю idrac_user необходимы права «Администратор».
  • Запускайте этот модуль в системе, имеющей прямой доступ к Dell iDRAC.
  • Этот модуль поддерживает адреса IPv4 и IPv6 для параметра idrac_ip.
  • Этот модуль поддерживает 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

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."}}

invalid_attributes

dictionary

Словарь переданных недопустимых атрибутов.

Возвращается: при передаче недопустимых атрибутов или значений.

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

dictionary

Состояние задания для 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

string

Общий статус операции с BIOS.

Возвращается: при успешном выполнении

Пример: "Successfully cleared pending BIOS attributes."

Авторы

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

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

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

© 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_bios_module.html

Spec-Zone.ru

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