Модуль netapp.ontap.na_ontap_user_role — настройка и управление ролями пользователей NetApp ONTAP

Примечание

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

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

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

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

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

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

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

Создание, изменение или удаление ролей пользователей.

Требования

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

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

Параметры

Параметр	Комментарии
access_level string	Уровень доступа роли. По умолчанию — ‘all’. Для вариантов доступа rest-role используйте `privileges`. Варианты: `"none"` `"readonly"` `"all"`
cert_filepath string добавлено в netapp.ontap 20.6.0	Путь к файлу сертификата SSL-клиента (.pem). Не поддерживается в Python 2.6.
command_directory_name string	Команда или каталог команд, к которым роль имеет доступ. Обязателен при использовании ZAPI. Для вариантов пути rest-role используйте `privileges`.
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, где каждый элемент — целое число. Если для `use_rest` задано значение auto, это может привести к переключению на ZAPI в зависимости от версии и возможностей платформы. Игнорируется при использовании ZAPI.
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-клиента.
name string / обязательный	Имя роли, которой нужно управлять.
ontapi integer	Используемая версия API ONTAP.
password псевдонимы: pass string	Пароль указанного пользователя.
privileges list / элементы=dictionary добавлено в netapp.ontap 21.23.0	Привилегии, назначаемые ролям пользователя. Только REST.
access string	Уровень доступа роли. Для пути команды или каталога команд поддерживаются только значения перечисления ‘none’, ‘readonly’ и ‘all’. Параметры ‘read_create’, ‘read_modify’ и ‘read_create_modify’ поддерживаются только в REST и требуют ONTAP 9.11.1 или более поздней версии. Варианты: `"none"` `"readonly"` `"all"` ← (по умолчанию) `"read_create"` `"read_modify"` `"read_create_modify"`
path string / обязательный	API или команда, к которым роль имеет доступ. Путь команды или каталога команд поддерживается начиная с ONTAP 9.11.1. В более ранних версиях поддерживаются только роли REST.
query string	Запрос для роли. Запрос должен применяться к указанной команде или имени каталога. Запросы поддерживаются только в версии 9.11.1 и более поздних.
query string добавлено в netapp.ontap 2.8.0	Запрос для роли. Запрос должен применяться к указанной команде или имени каталога. Чтобы изменить существующий запрос на none, используйте двойные кавычки “” . Для вариантов запроса rest-role используйте `privileges`.
state string	Должна ли указанная роль пользователя существовать. Варианты: `"present"` ← (по умолчанию) `"absent"`
use_lambda boolean добавлено в netapp.ontap 23.2.0	Определяет, следует ли использовать прокси-функциональность AWS Lambda для подключения к системе ONTAP. Поддерживается только с REST. Варианты: `false` ← (по умолчанию) `true`
use_rest string	Использовать REST или ZAPI. always — всегда использовать API REST, если модуль его поддерживает. Если модуль не поддерживает REST, выдается предупреждение. Если параметр модуля не поддерживается в REST, возникает ошибка. never — всегда использовать ZAPI, если модуль его поддерживает. Если параметр REST не поддерживается в ZAPI, может возникнуть ошибка. auto — пытаться использовать API REST, если модуль его поддерживает и поддерживаются параметры модуля. В противном случае использовать ZAPI. По умолчанию: `"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` ← (по умолчанию)
vserver string	Имя используемого vserver. Обязателен при использовании ZAPI.

Примечания

Примечание

Поддерживаются ZAPI и REST. Для REST требуется ONTAP 9.7 или более поздняя версия.
Поддерживается режим проверки.
При добавлении команды в роль ONTAP также затрагивает другие связанные команды.
Например, команда ‘volume modify’ затрагивает команды ‘volume create’ и ‘volume show’. Всегда указывайте все связанные команды.
REST поддерживает как role, так и rest-role в ONTAP 9.11.1 и более поздних версиях; в более ранних версиях поддерживается только rest-role.
Модули с префиксом na_ontap предназначены для поддержки платформы хранения ONTAP.
HTTPS включен по умолчанию и рекомендуется к использованию. Чтобы включить HTTP в кластере, выполните следующие команды: ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’

Примеры

- name: Create User Role Zapi
  netapp.ontap.na_ontap_user_role:
    state: present
    name: ansibleRole
    command_directory_name: volume
    access_level: none
    query: show
    vserver: ansibleVServer
    use_rest: never
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Modify User Role Zapi
  netapp.ontap.na_ontap_user_role:
    state: present
    name: ansibleRole
    command_directory_name: volume
    access_level: none
    query: ""
    vserver: ansibleVServer
    use_rest: never
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Create user role REST in ONTAP 9.11.1
  netapp.ontap.na_ontap_user_role:
    state: present
    privileges:
      - path: /api/cluster/jobs
    vserver: ansibleSVM
    name: carchi-test-role
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Modify user role REST in ONTAP 9.11.1
  netapp.ontap.na_ontap_user_role:
    state: present
    privileges:
      - path: /api/cluster/jobs
        access: readonly
      - path: /api/storage/volumes
        access: readonly
    vserver: ansibleSVM
    name: carchi-test-role
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Create user role REST in ONTAP 9.11.1+ with query
  netapp.ontap.na_ontap_user_role:
    state: present
    privileges:
      - path: job schedule interval
        access: all
        query: "-days <1 -hours >12"
    vserver: ansibleSVM
    name: carchi-test-role
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Modify user role REST in ONTAP 9.11.1+ with query
  netapp.ontap.na_ontap_user_role:
    state: present
    privileges:
      - path: job schedule interval
        access: readonly
        query: "-days <1 -hours >8"
    vserver: ansibleSVM
    name: carchi-test-role
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

Авторы

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