Модуль netapp.ontap.na_ontap_command — NetApp ONTAP: выполнение любой команды CLI; указанная учётная запись должна иметь разрешение на вход в консоль.

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: netapp.ontap.na_ontap_command.

Добавлено в netapp.ontap 2.7.0

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

Краткое описание

Выполнение команд system-cli в ONTAP.
Нельзя использовать с учётными записями, использующими аутентификацию по сертификату или доменную аутентификацию.
Требуются разрешения ontapi и console. Консоль не поддерживается для SVM с ролью data vserver.
Требуются разрешения на запись, даже для команд show! Для пользователя только с правами чтения ONTAP сообщает «Недостаточно привилегий» и «пользователь ‘xxxxx’ не имеет доступа на запись к этому ресурсу».

Требования

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

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 строка добавлено в netapp.ontap 20.6.0	Путь к файлу сертификата клиента SSL (.pem). Не поддерживается в Python 2.6.
command список / элементы=строка / обязательный	Список, разделённый запятыми, содержащий команду и аргументы.
exclude_lines строка добавлено в netapp.ontap 19.10.0	Применяется, только если return_dict имеет значение true Возвращать только строки, содержащие шаблон строки в `stdout_lines_filter` По умолчанию: `""`
feature_flags словарь добавлено в netapp.ontap 20.5.0	Включение или отключение новой функции. Можно использовать для включения экспериментальной функции или отключения новой функции, нарушающей обратную совместимость. Поддерживаемые ключи и значения могут измениться без предварительного уведомления. Неизвестные ключи игнорируются.
hostname строка / обязательный	Имя хоста или IP-адрес экземпляра ONTAP.
http_port целое число	Переопределение порта по умолчанию (80 или 443) с помощью этого порта
https логическое значение	Включение и отключение https. Игнорируется при использовании REST, поскольку поддерживается только https. Игнорируется при использовании аутентификации по сертификату SSL, поскольку для неё требуется SSL. Варианты: `false` ← (по умолчанию) `true`
include_lines строка добавлено в netapp.ontap 19.10.0	Применяется, только если return_dict имеет значение true Возвращать только строки, содержащие шаблон строки в `stdout_lines_filter` По умолчанию: `""`
key_filepath строка добавлено в netapp.ontap 20.6.0	Путь к файлу ключа клиента SSL.
ontapi целое число	Версия API ONTAP, которую следует использовать
password псевдонимы: pass строка	Пароль указанного пользователя.
privilege строка добавлено в netapp.ontap 2.8.0	Уровень привилегий, с которым выполняется команда. Варианты: `"admin"` ← (по умолчанию) `"advanced"`
return_dict логическое значение добавлено в netapp.ontap 2.9.0	Возвращает разбираемый словарь вместо необработанного вывода XML `result_value` `status` > передано, завершилось с ошибкой. `stdout` > вывод команды в виде обычного текста. `stdout_lines` > список строк вывода команды. `stdout_lines_filter` > пустой список или список строк вывода команды, соответствующих параметрам include_lines или exclude_lines. `xml_dict` > представление в формате JSON того, что вернула CLI. Варианты: `false` ← (по умолчанию) `true`
use_rest строка	Этот модуль поддерживает только ZAPI и не может переключиться на REST. never — всегда использовать ZAPI, если модуль поддерживает ZAPI. Может быть выдана ошибка, если параметр REST не поддерживается в ZAPI. auto — всегда использовать ZAPI. По умолчанию: `"never"`
username псевдонимы: user строка	Это может быть учётная запись с областью действия кластера или SVM — в зависимости от того, требуется ли API уровня кластера или SVM. Дополнительные сведения см. в документации: https://docs.netapp.com/us-en/ontap/authentication/create-svm-user-accounts-task.html. Поддерживаются два метода аутентификации Базовая аутентификация с использованием имени пользователя и пароля. Аутентификация по сертификату SSL с использованием файла сертификата клиента SSL и, при необходимости, файла закрытого ключа. Для использования сертификата его необходимо установить в кластере ONTAP и включить аутентификацию по сертификату.
validate_certs логическое значение	Если задано значение `no`, сертификаты SSL не будут проверяться. Это следует задавать только для `False` на сайтах под личным контролем, использующих самоподписанные сертификаты. Варианты: `false` `true` ← (по умолчанию)
vserver строка добавлено в netapp.ontap 19.10.0	При запуске от имени администратора vserver необходимо указать vserver, иначе модуль завершится с ошибкой

Примечания

Примечание

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

Примеры

- name: Run ONTAP CLI command
  netapp.ontap.na_ontap_command:
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    hostname: "{{ netapp_hostname }}"
    command: ['version']

# Same as above, but returns parseable dictonary
- name: Run ONTAP CLI command
  netapp.ontap.na_ontap_command:
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    hostname: "{{ netapp_hostname }}"
    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
  netapp.ontap.na_ontap_command:
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    hostname: "{{ netapp_hostname }}"
    command: ['node', 'show', '-fields', 'node,health,uptime,model']
    exclude_lines: 'ode ' # Exclude lines with 'Node ' or 'node ', or anything else containing 'ode '.
    privilege: 'admin'
    return_dict: true

Авторы

Команда NetApp Ansible (@carchi8py)

Ссылки на коллекцию

© 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_command_module.html