Spec-Zone.ru › Ansible

Модуль netapp.ontap.na_ontap_firmware_upgrade — обновление микропрограммы NetApp ONTAP для SP, полок, ACP и дисков.

Примечание

Этот модуль входит в коллекцию netapp.ontap (версия 23.5.0).

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

Чтобы установить её, используйте: ansible-galaxy collection install netapp.ontap. Для работы с этим модулем необходимы дополнительные требования. Подробнее см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: netapp.ontap.na_ontap_firmware_upgrade.

Добавлено в netapp.ontap 2.9.0

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

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

  • Обновление микропрограммы сервисного процессора ONTAP
  • Рекомендуемая процедура: 1. скачать пакет микропрограммы с сайта поддержки NetApp; 2. скопировать пакет на веб-сервер; 3. скачать пакет с веб-сервера с помощью этого модуля.
  • После загрузки пакета микропрограммы для квалификации дисков, дисков, полок или ACP ONTAP автоматически обновит соответствующие ресурсы в фоновом режиме.
  • Выполнение может занять некоторое время.
  • Для применения обновления сервисного процессора требуется перезагрузить узел.

Требования

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

  • Ansible 2.9 или более поздней версии; рекомендуется версия 2.12 или более поздняя.
  • Python3; рекомендуется версия 3.9 или более поздняя.
  • netapp-lib — только при использовании ZAPI (установите с помощью ‘pip install netapp-lib’). Обратите внимание, что netapp-lib объявлена устаревшей и больше не поддерживается. Используйте её на свой страх и риск.
  • Физическая или виртуальная кластерная система Data ONTAP. Модули поддерживают Data ONTAP 9.1 и более поздние версии, а для поддержки REST требуется ONTAP 9.6 или более поздняя версия.

Параметры

Параметр

Комментарии

cert_filepath

string

добавлено в netapp.ontap 20.6.0

Путь к файлу сертификата SSL-клиента (.pem).

Не поддерживается в Python 2.6.

clear_logs

boolean

Очистить журналы устройства после обновления. Значение по умолчанию — true.

Не используется, если force_disruptive_update имеет значение False.

Не поддерживается с REST, если задано значение false.

Варианты:

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

disk_fw

string

Версия микропрограммы диска, на которую нужно выполнить обновление.

Не используется, если force_disruptive_update имеет значение False (ONTAP автоматически выберет микропрограмму).

Не поддерживается с REST.

fail_on_502_error

boolean

добавлено в netapp.ontap 20.6.0

Загрузка микропрограммы может занять время, если веб-сервер работает медленно и в кластере много узлов.

Через 5 минут ONTAP прерывает соединение ZAPI и возвращает ошибку 502 Bad Gateway, даже если загрузка ещё выполняется.

По умолчанию модуль игнорирует эту ошибку и предполагает, что загрузка продолжается, поскольку ONTAP не предоставляет способ проверить её состояние.

Если задать для этого параметра значение true, модуль сообщит об ошибке 502.

Не поддерживается с REST, если задано значение true.

Варианты:

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

feature_flags

dictionary

добавлено в netapp.ontap 20.5.0

Включение или отключение новой функции.

Этот параметр можно использовать для включения экспериментальной функции или отключения новой функции, нарушающей обратную совместимость.

Поддерживаемые ключи и значения могут изменяться без предварительного уведомления. Неизвестные ключи игнорируются.

firmware_type

string

Тип микропрограммы для обновления. Возможные варианты: полка, ACP, сервисный процессор и диск.

Операция обновления микропрограммы полки выполняется асинхронно, поэтому ошибки, которые могут возникнуть в процессе загрузки, не возвращаются.

Обновление микропрограммы полки идемпотентно, если задан параметр shelf_module_fw.

Обновление микропрограммы диска идемпотентно, если задан параметр disk_fw.

В режиме проверки обновление микропрограммы SP, ACP, диска и полки не является идемпотентным.

Эта операция обновляет микропрограмму только на полках и дисках, где установлена не последняя версия микропрограммы.

Для обычных операций выберите storage или service-processor.

Тип storage включает ACP, полки и диски; ONTAP автоматически определит необходимые действия.

При использовании REST модуль не проверяет, соответствует ли пакет типу микропрограммы. Тип автоматически определяет ONTAP.

При использовании REST параметр storage загружает микропрограмму любого типа, включая микропрограмму сервисного процессора.

При использовании REST параметр service-processor открывает доступ к параметрам перезагрузки SP.

Варианты:

  • "storage" ← (по умолчанию)
  • "service-processor"
  • "shelf"
  • "acp"
  • "disk"

force_disruptive_update

boolean

добавлено в netapp.ontap 20.5.0

Если задано значение False и указан URL, обновление выполняется без прерывания работы. Если URL не указан, никаких действий не выполняется.

Не задавайте значение True, если это не рекомендовано службой технической поддержки NetApp.

Параметр принудительно запускает обновление, даже если ресурс к нему не готов, что может привести к нарушению работы.

Не поддерживается с REST, если задано значение true.

Варианты:

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

force_ontap_version

string

добавлено в netapp.ontap 21.23.0

Переопределение версии ONTAP кластера при использовании REST.

Поведение не определено, если указанная версия не соответствует целевому кластеру.

Этот параметр предлагается в качестве обходного решения, если версию кластера невозможно прочитать из-за проблем с разрешениями. См. https://github.com/ansible-collections/netapp.ontap/wiki/Known-issues.

Версия должна быть указана в формате 9.10 или 9.10.1, причём каждый компонент должен быть целым числом.

Если для use_rest задано значение auto, этот параметр может принудительно переключить модуль на ZAPI в зависимости от версии и возможностей платформы.

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

hostname

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

Имя хоста или IP-адрес экземпляра ONTAP.

http_port

integer

Переопределение порта по умолчанию (80 или 443) этим портом.

https

boolean

Включение и отключение HTTPS.

Игнорируется при использовании REST, поскольку поддерживается только HTTPS.

Игнорируется при использовании аутентификации по сертификату SSL, поскольку для неё требуется SSL.

Варианты:

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

install_baseline_image

boolean

Если для этого параметра задано значение true, устанавливается версия, входящая в комплект ONTAP. В противном случае для указания устанавливаемого пакета необходимо использовать параметр package.

Не используется, если force_disruptive_update имеет значение False (ONTAP автоматически выберет микропрограмму).

Не поддерживается с REST, если задано значение true.

Варианты:

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

key_filepath

string

добавлено в netapp.ontap 20.6.0

Путь к файлу ключа SSL-клиента.

node

string

Узел, на котором находится устройство.

При использовании REST этот параметр игнорируется, если задан package_url, но используется с ZAPI. Не требуется, если задан package_url и force_disruptive_update имеет значение False.

При использовании REST, если этот параметр не задан, микропрограмма будет загружена на все узлы кластера, а ресурсы на всех узлах, кроме сервисного процессора, будут обновлены в фоновом режиме.

При использовании ZAPI этот параметр задаёт целевой узел для загрузки микропрограммы.

При использовании ZAPI, если узел не задан, микропрограмма будет загружена на все узлы кластера (с использованием ‘*’).

Для сервисного процессора обновление будет выполнено автоматически при перезагрузке каждого узла.

ontapi

integer

Версия API ONTAP, которую следует использовать.

package

string

Имя файла пакета с устанавливаемой микропрограммой. Не требуется, если параметр -baseline имеет значение true.

Не используется, если force_disruptive_update имеет значение False.

Не поддерживается с REST.

package_url

string

добавлено в netapp.ontap 20.5.0

URL файла пакета с загружаемой микропрограммой.

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

Для SP обновление автоматически выполняется при перезагрузке узла.

Для SP обновление автоматически выполняется, если включена функция autoupdate (это рекомендуемая настройка).

password

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

string

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

reboot_sp

boolean

добавлено в netapp.ontap 20.7.0

Перезагрузить сервисный процессор перед загрузкой пакета.

Доступно только, если значение ‘firmware_type’ — ‘service-processor’.

Если параметр не задан, по умолчанию используется значение True, когда значение ‘firmware_type’ — ‘service-processor’.

Явно задайте значение true, чтобы избежать предупреждения, или false, чтобы не перезагружать SP.

Настоятельно рекомендуется перезагрузить SP перед загрузкой.

Варианты:

  • false
  • true

reboot_sp_after_download

boolean

добавлено в netapp.ontap 21.15.0

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

Доступно только, если значение ‘firmware_type’ — ‘service-processor’.

Варианты:

  • false
  • true

rename_package

string

добавлено в netapp.ontap 20.7.0

Переименовать пакет.

Доступно только, если значение ‘firmware_type’ — ‘service-processor’.

Не поддерживается с REST.

replace_package

boolean

добавлено в netapp.ontap 20.7.0

Заменить локальный пакет.

Доступно только, если значение ‘firmware_type’ — ‘service-processor’.

Не поддерживается с REST, если задано значение false.

Варианты:

  • false
  • true

server_password

string

добавлено в netapp.ontap 21.15.0

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

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

server_username

string

добавлено в netapp.ontap 21.15.0

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

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

shelf_module_fw

string

Версия микропрограммы модуля полки, на которую нужно выполнить обновление.

Не используется, если force_disruptive_update имеет значение False (ONTAP автоматически выберет микропрограмму).

Не поддерживается с REST.

state

string

Нужно ли обновить указанную микропрограмму ONTAP.

По умолчанию: "present"

update_type

string

Тип выполняемого обновления микропрограммы. Возможные варианты: serial_full, serial_differential, network_full.

Не используется, если force_disruptive_update имеет значение False (ONTAP автоматически выберет микропрограмму).

Не поддерживается с REST.

use_lambda

boolean

добавлено в netapp.ontap 23.2.0

Указывает, следует ли использовать прокси-функцию AWS Lambda для подключения к системе ONTAP.

Поддерживается только с REST.

Варианты:

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

use_rest

string

Использовать REST или ZAPI.

always — всегда использовать REST API, если модуль его поддерживает. Если модуль не поддерживает REST, выдаётся предупреждение. Если параметр модуля не поддерживается в REST, выдаётся ошибка.

never — всегда использовать ZAPI, если модуль его поддерживает. Если параметр REST не поддерживается в ZAPI, может быть выдана ошибка.

auto — пытаться использовать REST API, если модуль поддерживает REST и поддерживаются параметры модуля. В противном случае использовать ZAPI.

По умолчанию: "always"

username

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

string

Это может быть учётная запись уровня кластера или уровня SVM — в зависимости от того, требуется ли API уровня кластера или уровня SVM.

Подробнее см. в документации https://docs.netapp.com/us-en/ontap/authentication/create-svm-user-accounts-task.html.

Поддерживаются два способа аутентификации:

  1. Базовая аутентификация с использованием имени пользователя и пароля.
  2. Аутентификация по сертификату SSL с использованием файла сертификата SSL-клиента и, при необходимости, файла закрытого ключа.

Для использования сертификата он должен быть установлен в кластере ONTAP, а аутентификация по сертификату должна быть включена.

validate_certs

boolean

Если задано значение no, сертификаты SSL не проверяются.

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

Варианты:

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

Примечания

Примечание

  • Модули с префиксом na_ontap предназначены для поддержки платформы хранения ONTAP.
  • HTTPS включён по умолчанию и рекомендуется к использованию. Чтобы включить HTTP в кластере, выполните следующие команды: ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’

Примеры

- name: Firmware upgrade using REST - node parameter ignored when using REST with package_url
  netapp.ontap.na_ontap_firmware_upgrade:
    state: present
    package_url: "{{ web_link }}"
    node: node1  # This will be ignored when using REST with package_url
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Firmware upgrade using ZAPI - node parameter is used to target specific node
  netapp.ontap.na_ontap_firmware_upgrade:
    state: present
    package_url: "{{ web_link }}"
    node: node1  # This will be used to target specific node with ZAPI
    use_rest: never
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Firmware upgrade, confirm successful download
  netapp.ontap.na_ontap_firmware_upgrade:
    state: present
    package_url: "{{ web_link }}"
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    fail_on_502_error: true

- name: SP firmware upgrade
  netapp.ontap.na_ontap_firmware_upgrade:
    state: present
    node: vsim1
    package: "{{ file name }}"
    package_url: "{{ web_link }}"
    clear_logs: true
    install_baseline_image: false
    update_type: serial_full
    force_disruptive_update: false
    firmware_type: service-processor
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: SP firmware download replace package
  netapp.ontap.na_ontap_firmware_upgrade:
    state: present
    node: vsim1
    package_url: "{{ web_link }}"
    firmware_type: service-processor
    replace_package: true
    reboot_sp: true
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    https: true
    validate_certs: false

- name: SP firmware download rename package
  netapp.ontap.na_ontap_firmware_upgrade:
    state: present
    node: vsim1
    package_url: "{{ web_link }}"
    firmware_type: service-processor
    rename_package: SP_FW.zip
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    https: true
    validate_certs: false

- name: ACP firmware download and upgrade
  netapp.ontap.na_ontap_firmware_upgrade:
    state: present
    node: vsim1
    firmware_type: acp
    package_url: "{{ web_link }}"
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Shelf firmware upgrade
  netapp.ontap.na_ontap_firmware_upgrade:
    state: present
    firmware_type: shelf
    package_url: "{{ web_link }}"
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Disk firmware upgrade
  netapp.ontap.na_ontap_firmware_upgrade:
    state: present
    firmware_type: disk
    package_url: "{{ web_link }}"
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: SP firmware upgrade with reboots (REST)
  netapp.ontap.na_ontap_firmware_upgrade:
    state: present
    package_url: "{{ web_link }}"
    firmware_type: service-processor
    reboot_sp: true
    reboot_sp_after_download: true
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

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

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

Ключ

Описание

msg

string

В случае успеха возвращает дополнительную информацию.

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

Авторы

  • Команда NetApp Ansible (@carchi8py)

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

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

© 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/netapp/ontap/na_ontap_firmware_upgrade_module.html

Spec-Zone.ru

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