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

Примечание

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

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

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

Для использования в playbook, укажите: netapp.ontap.na_ontap_wait_for_condition.

Новое в netapp.ontap 20.8.0

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

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

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

Требования

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

Ansible 2.9 или более поздней версии - рекомендуется 2.12 или более поздней версии.
Python3 - рекомендуется 3.9 или более поздней версии.
При использовании ZAPI, netapp-lib 2018.11.13 или более поздней версии (установка с помощью «pip install netapp-lib»), netapp-lib 2020.3.12 настоятельно рекомендуется, поскольку она обеспечивает лучшее отображение ошибок для проблем с подключением
физическая или виртуальная кластерная система Data ONTAP, модули поддерживают Data ONTAP 9.1 и выше, поддержка REST требует ONTAP 9.6 или выше

Параметры

Параметр	Комментарии
attributes dictionary	словарь пользовательских атрибутов для условия. `sp_upgrade`, `sp_version` require `node`. `sp_version` requires `expected_version`. `snapmirror_relationship` requires `destination_path` and `expected_state` or `expected_transfer_state` to match the condition(s).
cert_filepath string added in netapp.ontap 20.6.0	путь к файлу сертификата клиента SSL (.pem). не поддерживается с python 2.6.
conditions list / elements=string / required	одно или несколько условий для соответствия `state` and/or `transfer_state` for `snapmirror_relationship`, `is_in_progress` for `sp_upgrade`, `firmware_version` for `sp_version`.
feature_flags dictionary added in netapp.ontap 20.5.0	Включить или отключить новую функцию. Это может быть использовано для включения экспериментальной функции или отключения новой функции, которая нарушает обратную совместимость. Поддерживаемые ключи и значения могут быть изменены без предварительного уведомления. Неизвестные ключи игнорируются.
force_ontap_version string added in netapp.ontap 21.23.0	Переопределить версию ONTAP кластера при использовании REST. Поведение не определено, если версия не соответствует целевому кластеру. Это предоставляется как обходной путь, когда версию кластера невозможно прочитать из-за проблем с разрешениями. Смотрите https://github.com/ansible-collections/netapp.ontap/wiki/Known-issues. Это должно быть в формате 9.10 или 9.10.1, где каждый элемент является целым числом. Когда `use_rest` is set to auto, this may force a switch to ZAPI based on the version and platform capabilities. Игнорируется с ZAPI.
hostname string / required	Имя хоста или IP-адрес экземпляра ONTAP.
http_port integer	Переопределить порт по умолчанию (80 или 443) этим портом
https boolean	Включить и отключить https. Игнорируется при использовании REST, так как поддерживается только https. Игнорируется при использовании аутентификации сертификата SSL, так как она требует SSL. Варианты: `false` ← (default) `true`
key_filepath string added in netapp.ontap 20.6.0	путь к файлу ключа клиента SSL.
name string / required	Имя события, которое нужно проверить. snapmirror_relationship was added in 21.22.0. Варианты: `"snapmirror_relationship"` `"sp_upgrade"` `"sp_version"`
ontapi integer	Версия API ontap, которую нужно использовать
password aliases: pass string	Пароль для указанного пользователя.
polling_interval integer	как часто проверять условия, в секундах. По умолчанию: `5`
state string	должны ли условия присутствовать или отсутствовать. if `present`, the module exits when any of the conditions is observed. if `absent`, the module exits with success when None of the conditions is observed. Варианты: `"present"` ← (default) `"absent"`
timeout integer	как долго ждать выполнения условий, в секундах. По умолчанию: `180`
use_rest string	Использовать REST или ZAPI. always – всегда будет использовать REST API, если модуль поддерживает REST. Предупреждение выдается, если модуль не поддерживает REST. Ошибка выдается, если параметр модуля не поддерживается в REST. never – всегда будет использовать ZAPI, если модуль поддерживает ZAPI. Ошибка может быть выдана, если параметр REST не поддерживается в ZAPI. auto – будет пытаться использовать REST API, если модуль поддерживает REST и параметры модулей поддерживаются. Возвращается к ZAPI в противном случае. По умолчанию: `"auto"`

username

aliases: user

string

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

Для получения дополнительной информации, пожалуйста, ознакомьтесь с документацией https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/.

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

базовая аутентификация, использующая имя пользователя и пароль,
аутентификация 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: wait for sp_upgrade in progress
  netapp.ontap.na_ontap_wait_for_condition:
    hostname: "{{ ontap_admin_ip }}"
    username: "{{ ontap_admin_username }}"
    password: "{{ ontap_admin_password }}"
    https: true
    validate_certs: no
    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: "{{ ontap_admin_ip }}"
    username: "{{ ontap_admin_username }}"
    password: "{{ ontap_admin_password }}"
    https: true
    validate_certs: no
    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: "{{ ontap_admin_ip }}"
    username: "{{ ontap_admin_username }}"
    password: "{{ ontap_admin_password }}"
    https: true
    validate_certs: no
    name: sp_version
    conditions: firmware_version
    state: present
    attributes:
      node: "{{ ontap_admin_ip }}"
      expected_version: 3.9
    polling_interval: 30
    timeout: 1800

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

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

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

Авторы

NetApp Ansible Team (@carchi8py)

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

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