netapp.ontap.na_ontap_command – NetApp ONTAP Выполнение любой команды cli, пользователю необходимо разрешение на вход в консоль.
Примечание
Этот плагин входит в состав коллекции netapp.ontap (версия 20.12.0).
Для его установки используйте: ansible-galaxy collection install netapp.ontap.
Чтобы использовать его в playbook, укажите: netapp.ontap.na_ontap_command.
Новое в версии 2.7.0: коллекции netapp.ontap
Описание
- Выполнение системных команд cli на ONTAP
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- Физическая или виртуальная кластеризованная система 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;’
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| 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. аутентификация по протоколу basic, используя имя пользователя и пароль, 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–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_command_module.html
