netapp.ontap.na_ontap_ssh_command – NetApp ONTAP Выполнение любых команд CLI по простому SSH с использованием paramiko.

Примечание

Этот плагин входит в коллекцию netapp.ontap (версия 20.12.0).

Для установки используйте: ansible-galaxy collection install netapp.ontap.

Для использования в книге задач укажите: netapp.ontap.na_ontap_ssh_command.

Введено в версии 20.8.0: of netapp.ontap

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Выполнение команд CLI на ONTAP по SSH с использованием paramiko.
Вывод возвращается в stdout и stderr, а также в виде stdout_lines, stdout_lines_filtered, stderr_lines.
Обратите внимание, что модуль может завершиться успешно, даже если команда завершилась неудачно. Вам необходимо проанализировать вывод stdout и проверить результаты.
Если открытый ключ хоста SSH неизвестен и принят, warnings обновляется.
Параметры, связанные с ZAPI или REST API, игнорируются.

Требования

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

Физическая или виртуальная кластерная система Data ONTAP. Модули поддерживают Data ONTAP 9.1 и более поздние версии.
Поддержка REST требует ONTAP 9.6 или более поздней версии.
Ansible 2.6
Ansible 2.9 или более поздние версии рекомендуются, так как они включают новую систему доставки коллекций.
Python2 netapp-lib (2017.10.30) или более поздняя версия. Установите, используя «pip install netapp-lib»
Python3 netapp-lib (2018.11.13) или более поздняя версия. Установите, используя «pip install netapp-lib»
netapp-lib 2020.3.12 настоятельно рекомендуется, так как он обеспечивает лучшую обработку ошибок при возникновении проблем с подключением.
Для включения http в кластере необходимо выполнить следующие команды: «set -privilege advanced;» «system services web modify -http-enabled true;»

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
accept_unknown_host_keys boolean	Варианты: нет ← да	При значении false подключение отклоняется, если открытый ключ хоста отсутствует в файле known_hosts. При значении true, если открытый ключ хоста неизвестен, он принимается, но выводится предупреждение. Обратите внимание, что ключ не добавляется в файл. Вы можете добавить ключ вручную, используя SSH.
cert_filepath string добавлено в 20.6.0 netapp.ontap		Путь к файлу SSL-сертификата клиента (.pem). Не поддерживается с Python 2.6.
command string / обязательно		Строка, содержащая команду и аргументы.
exclude_lines string	Значение по умолчанию: ""	возвращаются только строки, содержащие шаблон строки в `stdout_lines_filtered`.
feature_flags словарь добавлено в 20.5.0 netapp.ontap		Включение или выключение новой функции. Это может использоваться для включения экспериментальной функции или выключения новой функции, нарушающей обратную совместимость. Поддерживаемые ключи и значения могут быть изменены без предварительного уведомления. Неизвестные ключи игнорируются.
hostname string / обязательно		Имя хоста или IP-адрес экземпляра ONTAP.
http_port целое число		Переопределение порта по умолчанию (80 или 443) на указанный порт.
https boolean	Варианты: нет ← да	Включение и отключение https. Игнорируется при использовании REST, так как поддерживается только https. Игнорируется при использовании аутентификации по SSL-сертификату, так как требуется SSL.
include_lines string	Значение по умолчанию: ""	возвращаются только строки, содержащие шаблон строки в `stdout_lines_filtered`.
key_filepath string добавлено в 20.6.0 netapp.ontap		Путь к файлу закрытого ключа SSL-клиента.
ontapi целое число		Используемая версия API ontap.
password string		Пароль для указанного пользователя. псевдонимы: pass
privilege string		Уровень привилегий для выполнения команды, например, admin, advanced. Если задано, команда предваряется `set -privilege <privilege>;`.
service_processor boolean	Варианты: нет ← да	Указывает, является ли целевая система ONTAP или процессором сервисов (SP). Значимо только при заданном privilege. псевдонимы: sp
use_rest string	Значение по умолчанию: "auto"	REST API, если поддерживается целевой системой для всех ресурсов и атрибутов, необходимых модулю. В противном случае будет использоваться ZAPI. всегда -- всегда будет использоваться REST API никогда -- всегда будет использоваться ZAPI автоматически -- попытается использовать REST API
username string		Может быть именем учетной записи на уровне кластера или SVM, в зависимости от того, требуется ли API на уровне кластера или SVM. Для получения дополнительной информации см. документацию по https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/. Поддерживаются два метода аутентификации 1. базовая аутентификация с использованием имени пользователя и пароля, 2. аутентификация с помощью SSL-сертификата с использованием файла ssl-сертификата клиента и, необязательно, файла закрытого ключа. Для использования сертификата, он должен быть установлен в кластере ONTAP, и должна быть включена аутентификация по сертификату. псевдонимы: user
validate_certs boolean	Варианты: нет да ←	Если установлено значение `no`, SSL-сертификаты не будут проверены. Это должно быть установлено только на сайтах под собственным контролем с использованием самозаверяющих сертификатов.

Примечания

Примечание

Модули, начинающиеся с na_ontap, разработаны для поддержки платформы хранения ONTAP.

Примеры

- name: run ontap cli command using SSH
  na_ontap_ssh_command:
    hostname: "{{ hostname }}"
    username: "{{ admin_username }}"
    password: "{{ admin_password }}"
    command: version

# Same as above, with parameters
- name: run ontap cli command
  na_ontap_ssh_command:
    hostname: "{{ hostname }}"
    username: "{{ admin_username }}"
    password: "{{ admin_password }}"
    command: node show -fields node,health,uptime,model
    privilege: admin

# Same as above, but with lines filtering
- name: run ontap cli command
  na_ontap_ssh_command:
    hostname: "{{ hostname }}"
    username: "{{ admin_username }}"
    password: "{{ admin_password }}"
    command: node show -fields node,health,uptime,model
    exclude_lines: 'ode ' # Exclude lines with 'Node ' or 'node'
    # use with caution!
    accept_unknown_host_keys: true
    privilege: admin

- name: run ontap SSH command on SP
  na_ontap_ssh_command:
    # <<: *sp_login
    command: sp switch-version
    privilege: diag
    sp: true
  register: result
- debug: var=result

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

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

Ключ	Возвращаемое значение	Описание
stdout_lines_filtered список / элементы=строка	всегда	В дополнение к stdout и stdout_lines, список строк без пробелов, за исключением последней и информации о неудачном входе в систему. Список можно дополнительно уточнить с помощью фильтров include_lines и exclude_lines.

Авторы

Команда NetApp Ansible (@carchi8py) <nn-ansibleteam@netapp.com>

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/netapp/ontap/na_ontap_ssh_command_module.html