модуль netapp.ontap.na_ontap_zapit — NetApp ONTAP: выполнение любой ZAPI в ONTAP
Примечание
Этот модуль входит в коллекцию netapp.ontap (версия 23.5.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install netapp.ontap. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.
Чтобы использовать его в плейбуке, укажите: netapp.ontap.na_ontap_zapit.
Добавлено в netapp.ontap 20.4.0
Краткое описание
- Вызов ZAPI в ONTAP.
- ZAPI кластера выполняются с использованием учетной записи администратора кластера.
- ZAPI SVM можно выполнять с использованием учетной записи vsadmin или через туннелирование SVM (администратор кластера с параметром vserver).
- В случае успеха словарь JSON возвращается как
response. - В случае ошибки ZAPI задаются
status,errno,reason, чтобы помочь диагностировать проблему, - а вызов отмечается как ошибка («failed»).
- О прочих ошибках (например, проблемах с подключением) сообщается как об ошибках Ansible.
Требования
На узле, выполняющем этот модуль, должны быть соблюдены следующие требования.
- 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. |
feature_flags dictionary добавлено в netapp.ontap 20.5.0 | Включение или отключение новой функции. Этот параметр можно использовать для включения экспериментальной функции или отключения новой функции, нарушающей обратную совместимость. Поддерживаемые ключи и значения могут измениться без предварительного уведомления. Неизвестные ключи игнорируются. |
hostname string / обязательный | Имя хоста или IP-адрес экземпляра ONTAP. |
http_port integer | Переопределить порт по умолчанию (80 или 443), указав этот порт. |
https boolean | Включение и отключение https. Игнорируется при использовании REST, так как поддерживается только https. Игнорируется при использовании аутентификации с сертификатом SSL, поскольку для нее требуется SSL. Варианты:
|
key_filepath string добавлено в netapp.ontap 20.6.0 | Путь к файлу ключа клиента SSL. |
ontapi integer | Версия API ONTAP, которую следует использовать. |
password псевдонимы: pass string | Пароль указанного пользователя. |
use_rest string | Этот модуль поддерживает только ZAPI; переключиться на REST нельзя. never — всегда использовать ZAPI, если модуль поддерживает ZAPI. Если параметр REST не поддерживается в ZAPI, может быть выдана ошибка. auto — всегда использовать ZAPI. По умолчанию: |
username псевдонимы: user string | Это может быть учетная запись уровня кластера или уровня SVM — в зависимости от того, требуется API уровня кластера или уровня SVM. Дополнительную информацию см. в документации: https://docs.netapp.com/us-en/ontap/authentication/create-svm-user-accounts-task.html. Поддерживаются два метода аутентификации
Чтобы использовать сертификат, его необходимо установить в кластере ONTAP и включить аутентификацию по сертификату. |
validate_certs boolean | Если задано значение Это следует задавать только как Варианты:
|
vserver string | Если указан, принудительно используется туннелирование SVM. username указывает учетную запись администратора кластера. |
zapi dictionary / обязательный | Словарь для ZAPI и ее аргументов. Тег XML <tag>value</tag> представляется словарем, в котором tag — ключ. Значением может быть другой словарь, список словарей, строка или пустое значение. Например, <tag/> представляется как tag: За один раз можно вызвать только одну ZAPI. Ansible выдает предупреждение при обнаружении повторяющихся ключей и использует только последнюю запись. |
Примечания
Примечание
- Модули с префиксом na_ontap предназначены для поддержки платформы хранения ONTAP.
- По умолчанию https включен, и его использование рекомендуется. Чтобы включить http в кластере, выполните следующие команды: «set -privilege advanced;» «system services web modify -http-enabled true;»
Примеры
-
name: Ontap ZAPI
hosts: localhost
gather_facts: false
vars:
login: &login
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
https: true
validate_certs: false
svm_login: &svm_login
hostname: "{{ svm_admin_ip }}"
username: "{{ svm_admin_username }}"
password: "{{ svm_admin_password }}"
https: true
validate_certs: false
tasks:
- name: Run ontap ZAPI command as cluster admin
netapp.ontap.na_ontap_zapit:
<<: *login
zapi:
system-get-version:
register: output
- name: Print info
ansible.builtin.debug:
var: output
- name: Run ontap ZAPI command as cluster admin
netapp.ontap.na_ontap_zapit:
<<: *login
zapi:
vserver-get-iter:
register: output
- name: Run ontap ZAPI command as cluster admin
netapp.ontap.na_ontap_zapit:
<<: *login
zapi:
vserver-get-iter:
desired-attributes:
vserver-info:
- aggr-list:
- aggr-name
- allowed-protocols:
- protocols
- vserver-aggr-info-list:
- vserser-aggr-info
- uuid
query:
vserver-info:
vserver-name: trident_svm
register: output
- name: Run ontap ZAPI command as vsadmin
netapp.ontap.na_ontap_zapit:
<<: *svm_login
zapi:
vserver-get-iter:
desired-attributes:
vserver-info:
- uuid
register: output
- name: Run ontap ZAPI command as vserver tunneling
netapp.ontap.na_ontap_zapit:
<<: *login
vserver: ansibleSVM
zapi:
vserver-get-iter:
desired-attributes:
vserver-info:
- uuid
register: output
- name: Run ontap active-directory ZAPI command
netapp.ontap.na_ontap_zapit:
<<: *login
vserver: ansibleSVM
zapi:
active-directory-account-create:
account-name: testaccount
admin-username: testuser
admin-password: testpass
domain: testdomain
organizational-unit: testou
register: output
ignore_errors: true
Возвращаемые значения
Общие возвращаемые значения описаны здесь. Ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
errno string | Если ZAPI была выполнена, но завершилась с ошибкой, здесь указывается код ошибки, заданный ZAPI. Отсутствует в случае успеха или если вызов ZAPI не может быть выполнен. Возвращается: при ошибке |
reason string | Если ZAPI была выполнена, но завершилась с ошибкой, здесь указывается причина ошибки, заданная ZAPI. Отсутствует в случае успеха или если вызов ZAPI не может быть выполнен. Возвращается: при ошибке |
response dictionary | В случае успеха — словарь JSON, содержащий данные, возвращенные ZAPI. Если ZAPI была выполнена, но завершилась с ошибкой, возвращается пустой словарь. Отсутствует, если вызов ZAPI не может быть выполнен. Возвращается: при успехе |
status string | Если ZAPI была выполнена, но завершилась с ошибкой, здесь указывается статус, заданный ZAPI. Отсутствует в случае успеха или если вызов ZAPI не может быть выполнен. Возвращается: при ошибке |
Ссылки на коллекцию
© 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_zapit_module.html