Модуль netapp.ontap.na_ontap_wait_for_condition — NetApp ONTAP wait_for_condition. Повторение запроса get status до выполнения условия.

Примечание

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

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

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

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

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

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

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

Повторяет запрос get status в ONTAP, пока не будет выполнено условие.
Сообщает об ошибке тайм-аута, если во время ожидания условия превышено значение timeout.

Требования

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

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 или более поздняя версия.

Параметры

Параметр	Комментарии
attributes словарь	словарь пользовательских атрибутов условия. Для `sp_upgrade` и `sp_version` требуется `node`. Для `sp_version` требуется `expected_version`. Для `snapmirror_relationship` требуются `destination_path` и `expected_state` или `expected_transfer_state`, чтобы соответствовать условию (условиям).
cert_filepath строка добавлено в netapp.ontap 20.6.0	путь к файлу сертификата клиента SSL (.pem). Не поддерживается в Python 2.6.
conditions список / элементы=строка / обязательный	одно или несколько условий для сопоставления `state` и/или `transfer_state` для `snapmirror_relationship`, `is_in_progress` для `sp_upgrade`, `firmware_version` для `sp_version`.
feature_flags словарь добавлено в netapp.ontap 20.5.0	Включение или отключение новой функции. Этот параметр можно использовать для включения экспериментальной функции или отключения новой функции, нарушающей обратную совместимость. Поддерживаемые ключи и значения могут изменяться без предварительного уведомления. Неизвестные ключи игнорируются.
force_ontap_version строка добавлено в 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 строка / обязательный	Имя хоста или IP-адрес экземпляра ONTAP.
http_port целое число	Переопределяет порт по умолчанию (80 или 443).
https логический	Включение и отключение https. Игнорируется при использовании REST, так как поддерживается только https. Игнорируется при использовании аутентификации по сертификату SSL, так как для неё требуется SSL. Варианты: `false` ← (по умолчанию) `true`
key_filepath строка добавлено в netapp.ontap 20.6.0	путь к файлу ключа клиента SSL.
lambda_config словарь добавлено в netapp.ontap 23.5.0	Параметры конфигурации прокси-функции AWS Lambda. Этот параметр и его подпараметры поддерживаются только при использовании REST.
aws_profile строка	Имя профиля AWS, используемого для аутентификации.
aws_region строка / обязательный	Название региона AWS.
function_name строка / обязательный	Имя вызываемой функции AWS Lambda.
name строка / обязательный	Имя проверяемого события. snapmirror_relationship добавлен в версии 21.22.0. Варианты: `"snapmirror_relationship"` `"sp_upgrade"` `"sp_version"`
ontapi целое число	Версия API ONTAP, которую следует использовать.
password псевдонимы: pass строка	Пароль указанного пользователя.
polling_interval целое число	Периодичность проверки условий в секундах. По умолчанию: `5`
state строка	Определяет, должны ли условия присутствовать или отсутствовать. Если задано `present`, модуль завершает работу при обнаружении любого из условий. Если задано `absent`, модуль завершается успешно, если не обнаружено ни одно из условий. Варианты: `"present"` ← (по умолчанию) `"absent"`
timeout целое число	Время ожидания условий в секундах. По умолчанию: `180`
use_lambda логический добавлено в netapp.ontap 23.2.0	Указывает, следует ли использовать прокси-функцию AWS Lambda для подключения к системе ONTAP. Поддерживается только при использовании REST. Варианты: `false` ← (по умолчанию) `true`
use_rest строка	Определяет, использовать REST или ZAPI. always — всегда использовать REST API, если модуль поддерживает REST. Если модуль не поддерживает REST, выводится предупреждение. Если параметр модуля не поддерживается в REST, возникает ошибка. never — всегда использовать ZAPI, если модуль поддерживает ZAPI. Может возникнуть ошибка, если параметр REST не поддерживается в ZAPI. auto — пытаться использовать REST API, если модуль поддерживает REST и параметры модуля совместимы с ним. В противном случае использовать ZAPI. По умолчанию: `"always"`
username псевдонимы: user строка	Это может быть учетная запись уровня кластера или уровня SVM — в зависимости от того, какой API требуется: уровня кластера или уровня SVM. Дополнительные сведения см. в документации: https://docs.netapp.com/us-en/ontap/authentication/create-svm-user-accounts-task.html. Поддерживаются два способа аутентификации: Базовая аутентификация с использованием имени пользователя и пароля. Аутентификация по сертификату SSL с использованием файла сертификата клиента SSL и, при необходимости, файла закрытого ключа. Для использования сертификата он должен быть установлен в кластере ONTAP, а аутентификация по сертификату должна быть включена.
validate_certs логический	Если задано значение `no`, сертификаты SSL проверяться не будут. Устанавливайте это значение в `False` только на контролируемых вами сайтах, использующих самозаверяющие сертификаты. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Поддерживается прокси-функция AWS Lambda при использовании REST. Пример использования см. в файле README.
Модули с префиксом na_ontap предназначены для поддержки платформы хранения ONTAP.
По умолчанию https включен, и его рекомендуется использовать. Чтобы включить http в кластере, выполните следующие команды: ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’

Примеры

- name: Wait for sp_upgrade in progress
  netapp.ontap.na_ontap_wait_for_condition:
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    https: true
    validate_certs: false
    name: sp_upgrade
    conditions: is_in_progress
    attributes:
      node: "{{ node }}"
    polling_interval: 30
    timeout: 1800

- name: Wait for sp_upgrade not in progress
  netapp.ontap.na_ontap_wait_for_condition:
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    https: true
    validate_certs: false
    name: sp_upgrade
    conditions: is_in_progress
    state: absent
    attributes:
      node: "{{ ontap_admin_ip }}"
    polling_interval: 30
    timeout: 1800

- name: Wait for sp_version to match 3.9
  netapp.ontap.na_ontap_wait_for_condition:
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    https: true
    validate_certs: false
    name: sp_version
    conditions: firmware_version
    state: present
    attributes:
      node: "{{ ontap_admin_ip }}"
      expected_version: 3.9
    polling_interval: 30
    timeout: 1800

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

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

Ключ	Описание
last_state строка	последнее обнаруженное состояние события Возвращается: всегда
states строка	сводный список обнаруженных состояний во время ожидания завершения возвращается при успешном выполнении или ошибке тайм-аута Возвращается: всегда

Авторы

Команда 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_wait_for_condition_module.html