netapp.ontap.na_ontap_rest_cli модуль — NetApp ONTAP выполнить любую команду CLI с помощью REST api/private/cli/

Примечание

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

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

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

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

Новое в netapp.ontap 2.9.0

Описание
Требования
Параметры
Примечания
Примеры

Описание

Выполнение команд CLI на ONTAP через REST api/private/cli/.
Этот модуль может работать как администратор или vsdamin и требует включения HTTP-приложения.
Права доступа можно настроить с помощью ONTAP rest-role.

Требования

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

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

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
body словарь	словарь для задания информации
cert_filepath строка добавлен в netapp.ontap 20.6.0	путь к файлу сертификата клиента SSL (.pem). не поддерживается в python 2.6.
command строка / обязательно	строка команды.
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.
ontapi целое число	Версия ontap api, которую использовать
params словарь	словарь параметров для передачи в вызов API
password псевдонимы: pass строка	Пароль для указанного пользователя.
use_rest строка	Использовать REST или ZAPI. always — всегда использовать REST API, если модуль его поддерживает. Выводится предупреждение, если модуль не поддерживает REST. Выдается ошибка, если опция модуля не поддерживается в REST. never — всегда использовать ZAPI, если модуль его поддерживает. Может быть выдана ошибка, если опция REST не поддерживается в ZAPI. auto — попытаться использовать REST API, если модуль его поддерживает и опции модулей поддерживаются. В противном случае переходит к ZAPI. По умолчанию: `"auto"`
username псевдонимы: user строка	Это может быть учётная запись уровня кластера или SVM, в зависимости от того, требуется API уровня кластера или API уровня SVM. Для получения дополнительной информации обратитесь к документации https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/. Поддерживаются два метода аутентификации аутентификация по имени пользователя и паролю, аутентификация по сертификату SSL, используя файл ssl-сертификата клиента и, необязательно, файл закрытого ключа. Для использования сертификата он должен быть установлен в кластере ONTAP, и должна быть включена аутентификация по сертификатам.
validate_certs логическое значение	Если установлено в `no`, сертификаты SSL не будут проверены. Это следует устанавливать только в `False` на сайтах с собственным контролем, использующих самозаверяющие сертификаты. Варианты: `false` `true` ← (по умолчанию)
verb строка / обязательно	строка, указывающая, какой вызов API выполнить OPTIONS полезен для того, чтобы узнать, какие глаголы поддерживаются REST API Варианты: `"GET"` `"POST"` `"PATCH"` `"DELETE"` `"OPTIONS"`

Примечания

Примечание

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

Примеры

- name: run ontap rest cli command
  netapp.ontap.na_ontap_rest_cli:
    hostname: "{{ hostname }}"
    username: "{{ admin username }}"
    password: "{{ admin password }}"
    command: 'version'
    verb: 'GET'

- name: run ontap rest cli command
  netapp.ontap.na_ontap_rest_cli:
    hostname: "{{ hostname }}"
    username: "{{ admin username }}"
    password: "{{ admin password }}"
    command: 'security/login/motd'
    verb: 'PATCH'
    params: {'vserver': 'ansibleSVM'}
    body: {'message': 'test'}

- name: set option
  netapp.ontap.na_ontap_rest_cli:
    command: options
    verb: PATCH
    params:
      option_name: lldp.enable
    body:
      option_value: "on"

Авторы

Команда NetApp Ansible (@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_rest_cli_module.html