community.general.ldap_search module – Search for entries in a LDAP server

Note

This module is part of the community.general collection (version 5.4.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.ldap_search.

New in version 0.2.0: of community.general

Synopsis

  • Return the results of an LDAP search.

Requirements

The below requirements are needed on the host that executes this module.

  • python-ldap

Parameters

Parameter

Comments

attrs

list / elements=string

A list of attributes for limiting the result. Use an actual list or a comma-separated string.

bind_dn

string

A DN to bind with. If this is omitted, we’ll try a SASL bind with the EXTERNAL mechanism as default.

If this is blank, we’ll use an anonymous bind.

bind_pw

string

The password to use with bind_dn.

dn

string / required

The LDAP DN to search in.

filter

string

Used for filtering the LDAP search result.

Default: “(objectClass=*)”

referrals_chasing

string

added in 2.0.0 of community.general

Set the referrals chasing behavior.

anonymous follow referrals anonymously. This is the default behavior.

disabled disable referrals chasing. This sets OPT_REFERRALS to off.

Choices:

  • disabled

  • anonymous ← (default)

sasl_class

string

added in 2.0.0 of community.general

The class to use for SASL authentication.

possible choices are external, gssapi.

Choices:

  • external ← (default)

  • gssapi

schema

boolean

Set to true to return the full attribute schema of entries, not their attribute values. Overrides attrs when provided.

Choices:

  • no ← (default)

  • yes

scope

string

The LDAP scope to use.

Choices:

  • base ← (default)

  • onelevel

  • subordinate

  • children

server_uri

string

The server_uri parameter may be a comma- or whitespace-separated list of URIs containing only the schema, the host, and the port fields.

The default value lets the underlying LDAP client library look for a UNIX domain socket in its default location.

Note that when using multiple URIs you cannot determine to which URI your client gets connected.

For URIs containing additional fields, particularly when using commas, behavior is undefined.

Default: “ldapi:///”

start_tls

boolean

If true, we’ll use the START_TLS LDAP extension.

Choices:

  • no ← (default)

  • yes

validate_certs

boolean

If set to no, SSL certificates will not be validated.

This should only be used on sites using self-signed certificates.

Choices:

  • no

  • yes ← (default)

Notes

Note

  • The default authentication settings will attempt to use a SASL EXTERNAL bind over a UNIX domain socket. This works well with the default Ubuntu install for example, which includes a cn=peercred,cn=external,cn=auth ACL rule allowing root to modify the server configuration. If you need to use a simple bind to access your server, pass the credentials in bind_dn and bind_pw.

Examples

- 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

Authors

  • Sebastian Pfahl (@eryx12o45)