Модуль netapp.ontap.na_ontap_rest_cli — выполнение любых команд CLI NetApp ONTAP с помощью REST api/private/cli/

Примечание

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

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

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

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

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

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

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

Выполняет команды CLI в ONTAP через REST api/private/cli/.
Этот модуль может выполняться от имени администратора или vsdamin; для его работы требуется включенное HTTP-приложение.
Разрешения на доступ можно настроить с помощью роли ONTAP REST.

Требования

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

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

Параметры

Параметр	Комментарии
body dictionary	словарь для указания сведений
cert_filepath string добавлено в netapp.ontap 20.6.0	путь к файлу клиентского SSL-сертификата (.pem). Не поддерживается в Python 2.6.
command string / обязательный	Команда CLI.
feature_flags dictionary добавлено в netapp.ontap 20.5.0	Включает или отключает новую функцию. Этот параметр можно использовать для включения экспериментальной функции или отключения новой функции, нарушающей обратную совместимость. Поддерживаемые ключи и значения могут изменяться без предварительного уведомления. Неизвестные ключи игнорируются.
force_ontap_version string добавлено в netapp.ontap 21.23.0	Переопределяет версию ONTAP кластера при использовании REST. Если указанная версия не совпадает с версией целевого кластера, поведение не определено. Этот параметр служит обходным решением, если из-за проблем с разрешениями не удается прочитать версию кластера. См. https://github.com/ansible-collections/netapp.ontap/wiki/Known-issues. Укажите версию в формате 9.10 или 9.10.1, где каждый элемент является целым числом.
hostname string / обязательный	Имя узла или IP-адрес экземпляра ONTAP.
http_port integer	Переопределяет порт по умолчанию (80 или 443).
https boolean	Включает или отключает HTTPS. Игнорируется при использовании REST, поскольку поддерживается только HTTPS. Игнорируется при аутентификации с помощью SSL-сертификата, поскольку для нее требуется SSL. Варианты: `false` ← (по умолчанию) `true`
key_filepath string добавлено в netapp.ontap 20.6.0	Путь к файлу ключа клиентского SSL-сертификата.
params dictionary	словарь параметров, передаваемых в вызов API
password псевдонимы: pass string	Пароль указанного пользователя.
use_lambda boolean добавлено в netapp.ontap 23.4.0	Указывает, следует ли использовать прокси-функциональность AWS Lambda для подключения к системе ONTAP. Поддерживается только при использовании REST. Варианты: `false` ← (по умолчанию) `true`
use_rest string	Этот модуль поддерживает только REST. always — всегда использовать REST API. Если модуль не поддерживает REST, выдается предупреждение. По умолчанию: `"always"`
username псевдонимы: user string	Это может быть учетная запись уровня кластера или уровня SVM — в зависимости от того, требуется ли API уровня кластера или уровня SVM. Дополнительную информацию см. в документации: https://docs.netapp.com/us-en/ontap/authentication/create-svm-user-accounts-task.html. Поддерживаются два способа аутентификации: Базовая аутентификация с использованием имени пользователя и пароля. Аутентификация с помощью SSL-сертификата с использованием файла клиентского SSL-сертификата и, при необходимости, файла закрытого ключа. Для использования сертификата его необходимо установить в кластере ONTAP, а аутентификацию с помощью сертификата — включить.
validate_certs boolean	Если задано значение `no`, SSL-сертификаты не будут проверяться. Это следует устанавливать только в значение `False` на сайтах, находящихся под личным контролем и использующих самоподписанные сертификаты. Варианты: `false` `true` ← (по умолчанию)
verb string / обязательный	Определяет действие, выполняемое указанной командой. Значения соответствуют действиям show, create, modify и delete. OPTIONS позволяет узнать, какие глаголы поддерживаются REST API. Варианты: `"GET"` `"POST"` `"PATCH"` `"DELETE"` `"OPTIONS"`

Примечания

Примечание

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

Примеры

- name: Run ONTAP REST CLI command
  netapp.ontap.na_ontap_rest_cli:
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    command: version
    verb: GET

# The fields key allows returning a subset of parameters for a given object
- name: Run volume show command with a filter to only return volumes matching the provided vserver and policy values.
  netapp.ontap.na_ontap_rest_cli:
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    command: volume
    verb: GET
    params:
      vserver: vs0
      policy: default
      fields: vserver,volume,policy
  register: vs0_volumes

- name: Run security login motd modify command
  netapp.ontap.na_ontap_rest_cli:
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    command: security/login/motd
    verb: PATCH
    params:
      vserver: ansibleSVM
    body:
      message: test

- name: Set option
  netapp.ontap.na_ontap_rest_cli:
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    command: options
    verb: PATCH
    params:
      option_name: lldp.enable
    body:
      option_value: "on"

- name: Run security certificate delete command
  netapp.ontap.na_ontap_rest_cli:
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    command: security/certificate
    verb: DELETE
    body:
      vserver: vs1
      common-name: cluster01
      ca: cluster01
      type: server
      serial: 17EBE9D26GGE91B9

- name: Run volume create command
  netapp.ontap.na_ontap_rest_cli:
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    command: volume
    verb: POST
    body:
      vserver: vs1
      volume: my_test_volume
      size: 10g
      aggregate: aggr1_node1
      policy: default
      type: RW

Авторы

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