netapp.ontap.na_ontap_command – NetApp ONTAP Выполнение любой команды командной строки, пользователю необходимо разрешение на вход в консоль.
Примечание
Этот плагин входит в состав коллекции netapp.ontap (версия 21.1.1).
Для его установки используйте: ansible-galaxy collection install netapp.ontap.
Для использования в книге задач укажите: netapp.ontap.na_ontap_command.
Новое в версии 2.7.0: коллекции netapp.ontap
Обзор
- Выполнение системных команд CLI на ONTAP
- Не может использоваться с аутентификацией по сертификатам и учетными записями доменной аутентификации.
- Требуются разрешения на ontapi и консоль. Консоль не поддерживается для виртуальных серверов данных.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- Ansible 2.9
- Python3 netapp-lib (2018.11.13) или более поздняя версия. Установка с помощью «pip install netapp-lib»
- netapp-lib 2020.3.12 настоятельно рекомендуется, так как он обеспечивает более подробное сообщение об ошибках при проблемах с подключением.
- Физическая или виртуальная кластеризованная система Data ONTAP. Модули поддерживают Data ONTAP 9.1 и более поздние версии.
- Поддержка REST требует ONTAP 9.6 или более поздней версии.
- Для включения http в кластере необходимо выполнить следующие команды: «set -privilege advanced;» «system services web modify -http-enabled true;»
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| cert_filepath строка добавлен в 20.6.0 netapp.ontap | путь к файлу SSL-сертификата клиента (.pem). не поддерживается с Python 2.6. | |
| command список / элементы=строка / обязательный | список команд и аргументов, разделенных запятыми. | |
| exclude_lines строка добавлен в 19.10.0 netapp.ontap | Значение по умолчанию: "" | применяется только при return_dict = true возвращает только строки, содержащие шаблон строки в stdout_lines_filter |
| feature_flags словарь добавлен в 20.5.0 netapp.ontap | Включение или отключение новой функции. Это можно использовать для включения экспериментальной функции или отключения новой функции, нарушающей обратную совместимость. Поддерживаемые ключи и значения могут быть изменены без предварительного уведомления. Неизвестные ключи игнорируются. | |
| hostname строка / обязательный | Имя хоста или IP-адрес экземпляра ONTAP. | |
| http_port целое число | Переопределение порта по умолчанию (80 или 443) на этот порт | |
| https логическое значение |
| Включение и выключение https. Игнорируется при использовании REST, так как поддерживается только https. Игнорируется при использовании аутентификации по сертификату SSL, так как она требует SSL. |
| include_lines строка добавлен в 19.10.0 netapp.ontap | Значение по умолчанию: "" | применяется только при return_dict = true возвращает только строки, содержащие шаблон строки в stdout_lines_filter |
| key_filepath строка добавлен в 20.6.0 netapp.ontap | путь к файлу ключа SSL-клиента. | |
| ontapi целое число | Используемая версия API ontap. | |
| password строка | Пароль для указанного пользователя. псевдонимы: pass | |
| privilege строка добавлен в 2.8.0 netapp.ontap |
| Уровень привилегий для выполнения команды. |
| return_dict логическое значение добавлен в 2.9.0 netapp.ontap |
| Возвращает структурированный словарь вместо простого XML-вывода. result_valuestatus > успешное, неудачное выполнение.stdout > вывод команды в текстовом формате.stdout_lines > список строк вывода команды.stdout_lines_filter > пустой список или список строк вывода команды, соответствующих параметрам include_lines или exclude_lines. |
| use_rest строка | Значение по умолчанию: "auto" | REST API, если поддерживается целевой системой для всех ресурсов и атрибутов, необходимых модулю. В противном случае вернется к ZAPI. всегда -- всегда использовать REST API никогда -- всегда использовать ZAPI авто -- попробовать использовать REST API |
| username строка | Это может быть учетная запись уровня кластера или SVM, в зависимости от того, требуется ли API на уровне кластера или SVM. Для получения дополнительной информации ознакомьтесь с документацией https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/. Поддерживаются два метода аутентификации 1. Основная аутентификация с использованием имени пользователя и пароля, 2. Аутентификация по сертификату SSL с использованием файла SSL-сертификата клиента и, необязательно, файла закрытого ключа. Для использования сертификата он должен быть установлен в кластере ONTAP, и должна быть включена аутентификация по сертификатам. псевдонимы: user | |
| validate_certs логическое значение |
| Если установлено в no, сертификаты SSL не будут проверены.Это следует устанавливать только в False при использовании на сайтах с самоподписанными сертификатами. |
| vserver строка добавлен в 19.10.0 netapp.ontap | Если выполняется как администратор vserver, необходимо указать vserver, в противном случае модуль завершится ошибкой |
Примечания
Примечание
- Модули с префиксом na\_ontap разработаны для поддержки платформы хранения ONTAP.
Примеры
- name: run ontap cli command
na_ontap_command:
hostname: "{{ hostname }}"
username: "{{ admin username }}"
password: "{{ admin password }}"
command: ['version']
# Same as above, but returns parseable dictonary
- name: run ontap cli command
na_ontap_command:
hostname: "{{ hostname }}"
username: "{{ admin username }}"
password: "{{ admin password }}"
command: ['node', 'show', '-fields', 'node,health,uptime,model']
privilege: 'admin'
return_dict: true
# Same as above, but with lines filtering
- name: run ontap cli command
na_ontap_command:
hostname: "{{ hostname }}"
username: "{{ admin username }}"
password: "{{ admin password }}"
command: ['node', 'show', '-fields', 'node,health,uptime,model']
exlude_lines: 'ode ' # Exclude lines with 'Node ' or 'node'
privilege: 'admin'
return_dict: true
Авторы
- Команда NetApp Ansible (@carchi8py) <ng-ansibleteam@netapp.com>
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/netapp/ontap/na_ontap_command_module.html
