Spec-Zone.ru › Ansible

Модуль dellemc.openmanage.redfish_firmware – Выполнение обновления встроенного ПО компонента с использованием файла образа, доступного в локальной или удаленной системе

Примечание

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

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

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

Для использования в playbook, укажите: dellemc.openmanage.redfish_firmware.

Новое в dellemc.openmanage 2.1.0

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

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

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

Требования

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

  • python >= 3.9.6
  • urllib3

Параметры

Параметр

Комментарии

baseuri

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

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

ca_path

путь

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

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

image_uri

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

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

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

job_wait

логическое

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

Варианты:

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

job_wait_timeout

целое число

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

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

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

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

password

строка

Пароль целевого внешнего контроллера.

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

Пример: export IDRAC_PASSWORD=password

timeout

целое число

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

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

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

transfer_protocol

строка

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

Варианты:

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

username

строка

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

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

Пример: export IDRAC_USERNAME=username

validate_certs

логическое

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

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

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

До версии коллекции 5.0.0, validate_certs по умолчанию имеет значение false.

Варианты:

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

x_auth_token

строка

добавлено в 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

словарь

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

строка

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

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

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

task

словарь

Возвращает ID и 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)

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

  • Система отслеживания ошибок
  • Главная страница
  • Репозиторий (источники)

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

Spec-Zone.ru

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