Модуль community.general.ldap_search — поиск записей на LDAP-сервере

attrs

list / elements=string

Список атрибутов для ограничения результата. Используйте список или строку с элементами, разделёнными запятыми.

base64_attributes

list / elements=string

добавлено в community.general 7.0.0

Если задано, все возвращённые значения атрибутов, перечисленных в этом параметре, кодируются в Base64.

Если в этом списке указано специальное значение *, кодируются в Base64 все атрибуты.

Все остальные значения атрибутов преобразуются в строки UTF-8. Обратите внимание: если они содержат двоичные данные, некорректные байты UTF-8 пропускаются.

bind_dn

string

DN для привязки. Если этот параметр не задан, по умолчанию используется привязка SASL с механизмом EXTERNAL.

Если параметр пуст, используется анонимная привязка.

bind_pw

string

Пароль для использования с bind_dn.

По умолчанию: ""

ca_path

path

добавлено в community.general 6.5.0

Путь к файлу PEM с сертификатами CA.

client_cert

path

добавлено в community.general 7.1.0

Файл цепочки сертификатов в формате PEM для аутентификации SSL-клиента.

Требуется, если задан client_key.

client_key

path

добавлено в community.general 7.1.0

Файл в формате PEM с закрытым ключом для аутентификации SSL-клиента.

Требуется, если задан client_cert.

dn

string / обязательный

LDAP DN, в котором выполняется поиск.

filter

string

Используется для фильтрации результатов поиска в LDAP.

По умолчанию: "(objectClass=*)"

page_size

integer

добавлено в community.general 7.1.0

Размер страницы при поиске с простым постраничным выводом результатов (RFC 2696). Этот параметр можно настроить, чтобы уменьшить вероятность проблем с тайм-аутами и ограничениями сервера.

Если задать размер страницы 0 (значение по умолчанию), постраничный поиск будет отключён.

По умолчанию: 0

referrals_chasing

string

добавлено в community.general 2.0.0

Задаёт поведение при обработке ссылок-перенаправлений.

anonymous переходить по ссылкам-перенаправлениям анонимно. Это поведение используется по умолчанию.

disabled отключить обработку ссылок-перенаправлений. При этом параметр OPT_REFERRALS устанавливается в off.

Варианты:

• "disabled"
• "anonymous" ← (по умолчанию)

sasl_class

string

добавлено в community.general 2.0.0

Класс для аутентификации SASL.

Варианты:

• "external" ← (по умолчанию)
• "gssapi"

schema

boolean

Задайте значение true, чтобы возвращать полную схему атрибутов записей, а не значения их атрибутов. Если задан, переопределяет attrs.

Варианты:

• false ← (по умолчанию)
• true

scope

string

Область поиска LDAP.

Для subordinate требуется расширение LDAPv3 subordinate.

children эквивалентно области «subtree».

Варианты:

• "base" ← (по умолчанию)
• "onelevel"
• "subordinate"
• "children"

server_uri

string

Параметр server_uri может содержать список URI, разделённых запятыми или пробелами, в которых указаны только схема, хост и порт.

Значение по умолчанию позволяет базовой клиентской библиотеке LDAP искать UNIX-сокет в расположении по умолчанию.

Обратите внимание: при использовании нескольких URI невозможно определить, к какому из них подключится клиент.

Поведение для URI с дополнительными полями, особенно разделёнными запятыми, не определено.

По умолчанию: "ldapi:///"

start_tls

boolean

Если задано значение true, используется расширение LDAP START_TLS.

Варианты:

• false ← (по умолчанию)
• true

validate_certs

boolean

Если задано значение false, SSL-сертификаты не проверяются.

Используйте этот параметр только на сайтах с самоподписанными сертификатами.

Варианты:

• false
• true ← (по умолчанию)

xorder_discovery

string

добавлено в community.general 6.4.0

Задаёт способ обработки упорядоченных DN (Xordered DN).

enable выполняет поиск ONELEVEL ниже родительского RDN, чтобы найти соответствующий DN.

disable всегда использует DN без изменений (переданный параметром dn).

auto выполняет поиск только в том случае, если первый RDN не содержит индексный номер ({x}).

Варианты:

• "enable"
• "auto" ← (по умолчанию)
• "disable"

check_mode

Поддержка: полная

Может работать в режиме check_mode и возвращать прогноз статуса изменений без изменения целевого узла.

diff_mode

Поддержка: отсутствует

В режиме diff возвращает сведения об изменениях (или о том, что, возможно, необходимо изменить в check_mode).