Spec-Zone.ru › Ansible

модуль dellemc.openmanage.redfish_firmware — обновление встроенного ПО компонента с помощью файла образа, доступного в локальной или удаленной системе

Примечание

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

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

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

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

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

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

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

  • Этот модуль позволяет обновлять встроенное ПО только одного компонента за раз. Если модуль запущен для нескольких компонентов, возвращается сообщение об ошибке.
  • В зависимости от компонента обновление встроенного ПО применяется после автоматической или ручной перезагрузки.

Требования

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

  • python >= 3.9.6
  • urllib3

Параметры

Параметр

Комментарии

baseuri

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

IP-адрес целевого контроллера внеполосного управления. Например: <ipaddress>:<port>.

ca_path

path

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

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

image_uri

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

URI расположения образа встроенного ПО или локальный путь к нему.

Например: http://<web_address>/components.exe или /home/firmware_repo/component.exe.

job_wait

boolean

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

Варианты:

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

job_wait_timeout

integer

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

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

Примечание. Если для обновления встроенного ПО требуется перезагрузка, задание будет запланировано и будет ожидать указанное в секундах значение job_wait_time. Чтобы сократить время ожидания, задайте минимальное значение job_wait_time или установите job_wait в значение false и запустите задачу повторно.

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

password

string

Пароль целевого контроллера внеполосного управления.

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

Пример: export IDRAC_PASSWORD=password

timeout

integer

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

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

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

transfer_protocol

string

Протокол, используемый для передачи файла образа встроенного ПО. Применяется при обновлении по URI.

Варианты:

  • "CIFS"
  • "FTP"
  • "HTTP" ← (по умолчанию)
  • "HTTPS"
  • "NSF"
  • "OEM"
  • "SCP"
  • "SFTP"
  • "TFTP"

username

string

Имя пользователя целевого контроллера внеполосного управления.

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

Пример: export IDRAC_USERNAME=username

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

Примечания

Примечание

  • Запускайте этот модуль в системе, имеющей прямой доступ к API Redfish.
  • Этот модуль поддерживает адреса IPv4 и IPv6.
  • Этот модуль поддерживает только iDRAC9 и более поздние версии.
  • Этот модуль не поддерживает check_mode.

Примеры

---
- name: Update the firmware from a single executable file available in a HTTP protocol
  dellemc.openmanage.redfish_firmware:
    baseuri: "192.168.0.1"
    username: "user_name"
    password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    image_uri: "http://192.168.0.2/firmware_repo/component.exe"
    transfer_protocol: "HTTP"

- name: Update the firmware from a single executable file available in a HTTP protocol with job_Wait
  dellemc.openmanage.redfish_firmware:
    baseuri: "192.168.0.1"
    username: "user_name"
    password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    image_uri: "http://192.168.0.2/firmware_repo/component.exe"
    transfer_protocol: "HTTP"
    job_wait: true
    job_wait_timeout: 600

- name: Update the firmware from a single executable file available in a local path
  dellemc.openmanage.redfish_firmware:
    baseuri: "192.168.0.1"
    username: "user_name"
    password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    image_uri: "/home/firmware_repo/component.exe"

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ

Описание

error_info

dictionary

Сведения об ошибке HTTP.

Возвращается: при ошибке HTTP

Пример: {"error": {"@Message.ExtendedInfo": [{"Message": "Unable to complete the operation because the JSON data format entered is invalid.", "Resolution": "Do the following and the retry the operation: 1) Enter the correct JSON data format and retry the operation. 2) Make sure that no syntax error is present in JSON data format. 3) Make sure that a duplicate key is not present in JSON data format.", "Severity": "Critical"}, {"Message": "The request body submitted was malformed JSON and could not be parsed by the receiving service.", "Resolution": "Ensure that the request body is valid JSON and resubmit the request.", "Severity": "Critical"}], "code": "Base.1.2.GeneralError", "message": "A general error has occurred. See ExtendedInfo for more information."}}

msg

string

Общий статус задачи обновления встроенного ПО.

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

Пример: "Successfully updated the firmware."

task

dictionary

Возвращает идентификатор и URI созданной задачи.

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

Пример: {"id": "JID_XXXXXXXXXXXX", "uri": "/redfish/v1/TaskService/Tasks/JID_XXXXXXXXXXXX"}

Авторы

  • Felix Stephen (@felixs88)
  • Husniya Hameed (@husniya_hameed)
  • Shivam Sharma (@Shivam-Sharma)
  • Kritika Bhateja (@Kritika_Bhateja)
  • Abhishek Sinha (@ABHISHEK-SINHA10)
  • Sakshi Makkar (@Sakshi-dell)

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

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

© 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/redfish_firmware_module.html

Spec-Zone.ru

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