Модуль netapp.ontap.na_ontap_command – NetApp ONTAP Выполнить любую команду cli, пользователю необходимо разрешение на подключение к консоли.

Примечание

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

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

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

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

Новое в netapp.ontap 2.7.0

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

Описание

Выполнение команд system-cli на ONTAP.
Не может использоваться с учетными записями с подтверждением сертификата и доменной аутентификацией.
Требует разрешения ontapi и консоли. Консоль не поддерживается для vсерверов данных.
Требует прав на запись, даже для команд show! ONTAP сообщает «Недостаточно прав» и «пользователь 'xxxxx' не имеет прав на запись к этому ресурсу» для пользователя с правами только на чтение.

Требования

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

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

Параметры

Параметр	Комментарии
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-представление того, что вернула командная строка. Варианты: `false` ← (по умолчанию) `true`
use_rest строка	Этот модуль поддерживает только ZAPI и не может быть переключен на REST никогда – всегда будет использовать ZAPI, если модуль поддерживает ZAPI. Может быть выдано сообщение об ошибке, если опция REST не поддерживается в ZAPI. авто – всегда будет использовать ZAPI. По умолчанию: `"never"`
username псевдонимы: user строка	Это может быть учетная запись на уровне кластера или SVM, в зависимости от того, требуется ли API на уровне кластера или SVM. Дополнительную информацию можно найти в документации https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/. Поддерживаются два метода аутентификации базовая аутентификация с использованием имени пользователя и пароля, аутентификация по 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:
    hostname: "{{ hostname }}"
    username: "{{ admin username }}"
    password: "{{ admin password }}"
    command: ['version']

# Same as above, but returns parseable dictonary
- name: run ontap cli command
  netapp.ontap.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
  netapp.ontap.na_ontap_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 ', or anything else containing 'ode '.
    privilege: 'admin'
    return_dict: true

Авторы

Команда 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_command_module.html