netapp.ontap.na_ontap_user – NetApp ONTAP пользовательская настройка и управление
Примечание
Этот плагин входит в состав коллекции netapp.ontap (версия 20.12.0).
Для его установки используйте: ansible-galaxy collection install netapp.ontap.
Для использования в книге задач укажите: netapp.ontap.na_ontap_user.
Добавлена в версии 2.6.0: of netapp.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;’
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| applications список / элементы=строка / обязательно |
| Список приложений, которым разрешен доступ. Создание входа с приложениями console, telnet, rsh и service-processor для виртуального сервера данных не поддерживается. Модуль поддерживает оба варианта service-processor и service_processor. ZAPI требует service-processor, а REST — service_processor, за исключением проблемы с ONTAP 9.6 и 9.7. snmp не поддерживается в REST. псевдонимы: application |
| authentication_method строка / обязательно |
| Метод аутентификации для приложения. Не все методы аутентификации допустимы для приложения. Допустимые методы аутентификации для каждого приложения указаны в authentication_choices_description. Пароль для приложения console. Пароль, домен, nsswitch, cert для приложения http. Пароль, домен, nsswitch, cert для приложения ontapi. Community для приложения snmp (при создании пользователей SNMPv1 и SNMPv2). usm и community для приложения snmp (при создании пользователей SNMPv3). Пароль для приложения sp. Пароль для приложения rsh. Пароль для приложения telnet. Пароль, publickey, домен, nsswitch для приложения ssh. |
| authentication_password строка добавлен в 20.6.0 от netapp.ontap | Пароль для протокола аутентификации. Он должен содержать не менее 8 символов. Требуется для протоколов аутентификации 'md5', 'sha' и 'sha2-256', и не требуется для 'none'. Доступен только для метода аутентификации 'usm' и не может быть изменён. | |
| authentication_protocol строка добавлен в 20.6.0 от netapp.ontap |
| Протокол аутентификации для пользователя snmp. При включенном режиме FIPS кластера, 'sha' и 'sha2-256' — единственно возможные и допустимые значения. При выключенном режиме FIPS кластера, значение по умолчанию — 'none'. При включенном режиме FIPS кластера, значение по умолчанию — 'sha'. Доступен только для метода аутентификации 'usm' и не может быть изменён. |
| cert_filepath строка добавлен в 20.6.0 от netapp.ontap | путь к файлу сертификата SSL клиента (.pem). не поддерживается с python 2.6. | |
| engine_id строка добавлен в 20.6.0 от netapp.ontap | Идентификатор EngineID авторитетного субъекта для пользователя SNMPv3. Это должно быть указано как шестнадцатеричная строка. Идентификатор Engine ID с первым битом, установленным в 1 в первом октете, должен иметь минимум 5 или максимум 32 октета. Идентификатор Engine ID с первым битом, установленным в 0 в первом октете, должен иметь длину 12 октетов. Идентификатор Engine ID не может содержать все нули в своём адресе. Доступен только для метода аутентификации 'usm' и не может быть изменён. | |
| feature_flags словарь добавлен в 20.5.0 от netapp.ontap | Включить или выключить новую функцию. Это может быть использовано для включения экспериментальной функции или выключения новой функции, которая нарушает обратную совместимость. Поддерживаемые ключи и значения могут быть изменены без предварительного уведомления. Неизвестные ключи игнорируются. | |
| hostname строка / обязательно | Имя хоста или IP-адрес экземпляра ONTAP. | |
| http_port целое число | Переопределить порт по умолчанию (80 или 443) этим портом | |
| https логическое значение |
| Включить и выключить https. Игнорируется при использовании REST, так как поддерживается только https. Игнорируется при использовании аутентификации с помощью SSL-сертификата, так как она требует SSL. |
| key_filepath строка добавлен в 20.6.0 от netapp.ontap | путь к файлу ключа SSL клиента. | |
| lock_user логическое значение |
| Разблокирован ли указанный учётный запрос пользователя. |
| name строка / обязательно | Имя пользователя для управления. | |
| ontapi целое число | Версия ontap api для использования | |
| password строка | Пароль для указанного пользователя. псевдонимы: pass | |
| privacy_password строка добавлен в 20.6.0 от netapp.ontap | Пароль для протокола конфиденциальности. Он должен содержать не менее 8 символов. Требуется для протоколов конфиденциальности 'des' и 'aes128', и не требуется для 'none'. Доступен только для метода аутентификации 'usm' и не может быть изменён. | |
| privacy_protocol строка добавлен в 20.6.0 от netapp.ontap |
| Протокол конфиденциальности для пользователя snmp. При включенном режиме FIPS кластера, 'aes128' — единственно возможный и допустимый параметр. При выключенном режиме FIPS кластера, значение по умолчанию — 'none'. При включенном режиме FIPS кластера, значение по умолчанию — 'aes128'. Доступен только для метода аутентификации 'usm' и не может быть изменён. |
| remote_switch_ipaddress строка добавлен в 20.6.0 от netapp.ontap | Этот параметр необязательно указывает IP-адрес удалённого коммутатора. Удаленный коммутатор может быть коммутатором кластера, контролируемым монитором состояния коммутатора кластера (CSHM), или коммутатором Fiber Channel (FC), контролируемым монитором состояния мегакластера (MCC-HM). Это применимо только для удаленного пользователя SNMPv3, т. е. только если пользователь является удалённым (не локальным) пользователем, приложение — snmp, и метод аутентификации — usm. | |
| role_name строка | Имя роли. Требуется, когда state=present.
| |
| set_password строка | Пароль для учётной записи пользователя. Игнорируется при создании пользователей snmp, но требуется для создания пользователей, не являющихся snmp. Для существующего пользователя это значение будет использоваться как новый пароль. | |
| state строка |
| Должен ли существовать указанный пользователь или нет. |
| 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. базовая аутентификация, используя имя пользователя и пароль, 2. аутентификация с помощью SSL-сертификата, используя файл SSL-сертификата клиента и, необязательно, файл закрытого ключа. Для использования сертификата он должен быть установлен в кластер ONTAP, и должна быть включена аутентификация с помощью сертификатов. псевдонимы: user | |
| validate_certs логическое значение |
| Если установлено no, SSL-сертификаты не будут проверены.Это следует устанавливать только False используемый на сайтах, контролируемых лично, с использованием самозаверенных сертификатов. |
| vserver строка / обязательно | Имя виртуального сервера для использования. псевдонимы: svm |
Примечания
Примечание
- Модули с префиксом na_ontap разработаны для поддержки платформы хранения ONTAP.
Примеры
- name: Create User
na_ontap_user:
state: present
name: SampleUser
applications: ssh,console
authentication_method: password
set_password: apn1242183u1298u41
lock_user: True
role_name: vsadmin
vserver: ansibleVServer
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
- name: Delete User
na_ontap_user:
state: absent
name: SampleUser
applications: ssh
authentication_method: password
vserver: ansibleVServer
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
- name: Create user with snmp application (ZAPI)
na_ontap_user:
state: present
name: test_cert_snmp
applications: snmp
authentication_method: usm
role_name: admin
authentication_protocol: md5
authentication_password: '12345678'
privacy_protocol: 'aes128'
privacy_password: '12345678'
engine_id: '7063514941000000000000'
remote_switch_ipaddress: 10.0.0.0
vserver: "{{ vserver }}"
hostname: "{{ hostname }}"
username: "{{ username }}"
password: "{{ password }}"
Авторы
- Команда 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_user_module.html