Модуль netapp.ontap.na_ontap_ldap_client — LDAP-клиент NetApp ONTAP
Примечание
Этот модуль входит в коллекцию netapp.ontap (версия 23.5.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install netapp.ontap. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: netapp.ontap.na_ontap_ldap_client.
Добавлено в netapp.ontap 2.9.0
Краткое описание
- Создание, изменение или удаление LDAP-клиента в NetApp ONTAP.
Требования
Следующие требования должны быть выполнены на хосте, на котором выполняется этот модуль.
- 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 или более поздняя версия.
Параметры
Параметр | Комментарии |
|---|---|
ad_domain string | Имя домена Active Directory. Если state=present, требуется указать servers или ad_domain. Взаимоисключающий параметр с servers. |
base_dn string | Базовое DN LDAP. |
base_scope string | Область поиска LDAP. Варианты:
|
bind_as_cifs_server boolean | Кластер использует учётные данные CIFS-сервера для привязки к LDAP-серверу. Варианты:
|
bind_dn string | DN пользователя для привязки LDAP. |
bind_password string | Пароль пользователя для привязки LDAP. |
cert_filepath string добавлено в netapp.ontap 20.6.0 | Путь к файлу сертификата SSL-клиента (.pem). Не поддерживается в Python 2.6. |
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, причём каждый элемент должен быть целым числом. Если для Игнорируется при использовании ZAPI. |
group_dn string добавлено в netapp.ontap 23.4.0 | Задаёт различающееся имя (DN) группы, используемое в качестве начальной точки в дереве каталога LDAP для поиска групп. |
hostname string / обязательный | Имя хоста или IP-адрес экземпляра ONTAP. |
http_port integer | Использовать указанный порт вместо порта по умолчанию (80 или 443). |
https boolean | Включение и отключение HTTPS. Игнорируется при использовании REST, так как поддерживается только HTTPS. Игнорируется при использовании аутентификации с помощью сертификата SSL, поскольку для неё требуется SSL. Варианты:
|
key_filepath string добавлено в netapp.ontap 20.6.0 | Путь к файлу ключа SSL-клиента. |
lambda_config dictionary добавлено в netapp.ontap 23.5.0 | Параметры конфигурации функции прокси-сервера AWS Lambda. Этот параметр и его подпараметры поддерживаются только при использовании REST. |
|
aws_profile string |
Имя профиля AWS, используемого для аутентификации. |
|
aws_region string / обязательный |
Название региона AWS. |
|
function_name string / обязательный |
Имя вызываемой функции AWS Lambda. |
ldaps_enabled boolean добавлено в netapp.ontap 21.22.0 | Указывает, включён ли LDAPS. Варианты:
|
min_bind_level string | Минимальный уровень привязки LDAP-сервера. Варианты:
|
name string | Имя конфигурации LDAP-клиента. Поддерживается только в ZAPI. Обязательно при использовании ZAPI. |
ontapi integer | Версия API ONTAP, которую следует использовать. |
password псевдонимы: pass string | Пароль указанного пользователя. |
port псевдонимы: tcp_port integer добавлено в netapp.ontap 21.3.0 | TCP-порт LDAP-сервера. |
preferred_ad_servers list / элементы=string | Предпочтительные контроллеры домена Active Directory (AD). Взаимоисключающий параметр с servers. |
query_timeout integer | Тайм-аут запроса к LDAP-серверу. |
referral_enabled boolean | Следование перенаправлениям LDAP. Варианты:
|
schema string | Схема LDAP. Обязательно, если state=present. Схемы по умолчанию: «AD-IDMU», «AD-SFU», «MS-AD-BIS», «RFC-2307». Также можно использовать пользовательские схемы. |
servers псевдонимы: ldap_servers list / элементы=string | Список LDAP-серверов, разделённых запятыми. Полные доменные имена или IP-адреса. Если state=present, требуется указать servers или ad_domain. Взаимоисключающий параметр с preferred_ad_servers и ad_domain. |
session_security string | Безопасность сеанса клиента. Варианты:
|
skip_config_validation boolean добавлено в netapp.ontap 22.0.0 | Указывает, отключена ли проверка указанной конфигурации LDAP. По умолчанию при использовании REST сообщается об ошибках, например если не удаётся разрешить имена серверов. Требуется ONTAP 9.9 или более поздняя версия. Игнорируется при использовании ZAPI. Варианты:
|
state string | Определяет, должна ли существовать указанная конфигурация LDAP-клиента. Варианты:
|
use_lambda boolean добавлено в netapp.ontap 23.2.0 | Указывает, следует ли использовать функцию прокси-сервера AWS Lambda для подключения к системе ONTAP. Поддерживается только при использовании REST. Варианты:
|
use_rest string | Определяет, использовать REST или ZAPI. always — всегда использовать REST API, если модуль поддерживает REST. Если модуль не поддерживает REST, будет выдано предупреждение. Если параметр модуля не поддерживается в REST, будет выдана ошибка. never — всегда использовать ZAPI, если модуль поддерживает ZAPI. Если параметр REST не поддерживается в ZAPI, может быть выдана ошибка. auto — пытаться использовать REST API, если модуль поддерживает REST и поддерживаются параметры модуля. В противном случае использовать ZAPI. По умолчанию: |
use_start_tls boolean | Использовать Start TLS для подключения LDAP. Варианты:
|
user_dn string добавлено в netapp.ontap 23.4.0 | Задаёт различающееся имя (DN) пользователя, используемое в качестве начальной точки в дереве каталога LDAP для поиска пользователей. |
username псевдонимы: user string | Это может быть учётная запись уровня кластера или уровня SVM, в зависимости от того, требуется ли API уровня кластера или уровня SVM. Дополнительные сведения см. в документации: https://docs.netapp.com/us-en/ontap/authentication/create-svm-user-accounts-task.html. Поддерживаются два метода аутентификации.
Для использования сертификата он должен быть установлен в кластере ONTAP, а аутентификация по сертификату должна быть включена. |
validate_certs boolean | Если установлено значение Устанавливайте это значение в Варианты:
|
vserver string / обязательный | Vserver/SVM, в котором хранится конфигурация LDAP-клиента. |
Примечания
Примечание
- LDAP-клиент, созданный с помощью ZAPI, следует удалять с помощью ZAPI.
- LDAP-клиент, созданный с помощью REST, следует удалять с помощью REST.
- REST поддерживает только создание, изменение и удаление конфигурации LDAP-клиента SVM данных.
- При использовании REST поддерживается функция прокси-сервера AWS Lambda. Примеры см. в файле README.
- Модули с префиксом na_ontap предназначены для поддержки платформы хранения ONTAP.
- HTTPS включён по умолчанию и рекомендуется к использованию. Чтобы включить HTTP в кластере, выполните следующие команды: ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’
Примеры
- name: Create LDAP client
# assuming credentials are set using module_defaults
netapp.ontap.na_ontap_ldap_client:
state: present
vserver: 'vserver1'
servers: 'ldap1.example.company.com,ldap2.example.company.com'
base_dn: 'dc=example,dc=company,dc=com'
group_dn: 'ou=group,dc=ds,dc=eng,dc=netapp,dc=com'
user_dn: 'ou=people,dc=ds,dc=eng,dc=netapp,dc=com'
- name: Modify LDAP client
# assuming credentials are set using module_defaults
netapp.ontap.na_ontap_ldap_client:
state: present
vserver: 'vserver1'
servers: 'ldap1.example.company.com'
base_dn: 'dc=example,dc=company,dc=com'
skip_config_validation: true
- name: Delete LDAP client
# assuming credentials are set using module_defaults
netapp.ontap.na_ontap_ldap_client:
state: absent
vserver: 'vserver1'
Ссылки на коллекцию
© 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_ldap_client_module.html