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

Примечание

Этот модуль входит в коллекцию community.general (версия 9.5.0).

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

Чтобы установить её, используйте: ansible-galaxy collection install community.general. Для использования этого модуля потребуются дополнительные зависимости, см. Требования для подробностей.

Чтобы использовать его в книге задач, укажите: community.general.ldap_search.

Добавлен в community.general 0.2.0

Описание
Требования
Параметры
Атрибуты
Примечания
Примеры

Описание

Возвращает результаты поиска LDAP.

Требования

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

python-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 / required	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. `children` эквивалентно области «поддерево». Варианты: `"base"` ← (по умолчанию) `"onelevel"` `"subordinate"` `"children"`
server_uri string	Параметр `server_uri` может представлять собой список URI, разделенных запятыми или пробелами, содержащий только поля схемы, хоста и порта. Значение по умолчанию позволяет базовой библиотеке клиента LDAP искать сокет домена UNIX в его расположении по умолчанию. Обратите внимание, что при использовании нескольких URI вы не можете определить, к какому URI подключился ваш клиент. Для URI, содержащих дополнительные поля, особенно при использовании запятых, поведение не определено. По умолчанию: `"ldapi:///"`
start_tls boolean	Если true, мы будем использовать расширение LDAP START_TLS. Варианты: `false` ← (по умолчанию) `true`
validate_certs boolean	Если установлено в `false`, SSL-сертификаты проверяться не будут. Это следует использовать только на сайтах, использующих самозаверяющие сертификаты. Варианты: `false` `true` ← (по умолчанию)

xorder_discovery

string

added in community.general 6.4.0

Установите поведение при обработке Xупорядоченных DN.

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

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

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

Варианты:

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

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может работать в режиме `check_mode` и возвращать прогноз о состоянии изменения без модификации целевого объекта.
diff_mode	Поддержка: нет	Вернёт детали изменений (или, возможно, изменений, необходимых в `check_mode`), когда режим diff включён.

Примечания

Примечание

Настройки аутентификации по умолчанию будут пытаться использовать привязку SASL EXTERNAL через сокет доменной системы UNIX. Это хорошо работает с установкой Ubuntu по умолчанию, например, которая включает правило ACL cn=peercred,cn=external,cn=auth, разрешающее root изменять конфигурацию сервера. Если вам нужно использовать простую привязку для доступа к вашему серверу, передайте учётные данные в bind_dn и bind_pw.

Примеры

- name: Return all entries within the 'groups' organizational unit.
  community.general.ldap_search:
    dn: "ou=groups,dc=example,dc=com"
  register: ldap_groups

- name: Return GIDs for all groups
  community.general.ldap_search:
    dn: "ou=groups,dc=example,dc=com"
    scope: "onelevel"
    attrs:
      - "gidNumber"
  register: ldap_group_gids

Авторы

Sebastian Pfahl (@eryx12o45)

Ссылки на сборку

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/ldap_search_module.html