Spec-Zone.ru › Ansible

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

Примечание

Этот модуль является частью коллекции dellemc.openmanage (версия 9.7.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

Параметры

Параметр

Комментарии

apply_time

строка

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

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

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

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

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

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

Варианты:

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

attributes

словарь

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

Взаимоисключительно с boot_sources, clear_pending и reset_bios.

boot_sources

список / элементы=любой

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

boot_sources взаимоисключительно с attributes, clear_pending и reset_bios.

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

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

ca_path

путь

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

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

clear_pending

булево

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

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

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

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

Взаимоисключительно с boot_sources, attributes и reset_bios.

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

Варианты:

  • false
  • true

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

булево

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

Применимо к attributes, когда apply_time равно Immediate.

Варианты:

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

job_wait_timeout

целое число

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

Этот параметр применим, когда job_wait равно true.

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

maintenance_window

словарь

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

Требуется, когда apply_time равно AtMaintenanceWindowStart или InMaintenanceWindowOnReset.

duration

целое число / обязательно

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

start_time

строка / обязательно

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

Формат: ГГГГ-ММ-ДДThч:мм:сс<смещение>

<смещение> — смещение от UTC текущей часовой зоны, установленной в iDRAC, в формате: +05:30 для IST.

reset_bios

булево

Сбрасывает 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

aliases: 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

словарь

Подробности 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

словарь

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

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

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

словарь

Статус задачи для boot_sources или статус выполненного действия над BIOS.

Возвращается: success

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

строка

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

Возвращается: success

Пример: "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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/dellemc/openmanage/idrac_bios_module.html

Spec-Zone.ru

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