community.general.ldap_entry модуль – Добавление или удаление записей LDAP

Примечание

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

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

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

Для использования в playbook укажите: community.general.ldap_entry.

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

Описание

Добавление или удаление записей LDAP. Этот модуль только проверяет существование или отсутствие записи LDAP, а не её атрибуты. Для проверки значений атрибутов записи см. community.general.ldap_attrs.

Требования

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

python-ldap

Параметры

Параметр	Комментарии
attributes dictionary	Если `state=present`, атрибуты, необходимые для создания записи. Существующие записи никогда не изменяются. Чтобы задать определенные значения атрибутов для существующей записи, используйте модуль community.general.ldap_attrs вместо этого. Каждое значение атрибута может быть строкой для однозначных атрибутов или списком строк для многозначных атрибутов. Если вы указываете значения для этого параметра в YAML, обратите внимание, что вы можете улучшить читаемость для длинных строковых значений, используя модификаторы YAML-блоков, как показано в примерах для этого модуля. Обратите внимание, что при использовании значений, которые YAML/ansible-core интерпретирует как другие типы, такие как `yes`, `no` (булевы) или `2.10` (с плавающей точкой), обязательно заключайте их в кавычки, если они должны быть строками. В противном случае в LDAP могут быть отправлены неправильные значения. Default: `{}`
bind_dn string	DN для привязки. Если это опущено, мы попробуем привязку SASL с механизмом EXTERNAL по умолчанию. Если это поле пустое, мы будем использовать анонимную привязку.
bind_pw string	Пароль для использования с `bind_dn`. Default: `""`
ca_path path added in community.general 6.5.0	Установите путь к PEM-файлу с сертификатами CA.
client_cert path added in community.general 7.1.0	Файл цепочки сертификатов в формате PEM, который будет использоваться для проверки подлинности клиента SSL. Требуется, если `client_key` определено.
client_key path added in community.general 7.1.0	Файл в формате PEM, содержащий ваш закрытый ключ, который будет использоваться для проверки подлинности клиента SSL. Требуется, если `client_cert` определено.
dn string / required	DN записи для добавления или удаления.
objectClass list / elements=string	Если `state=present`, значение или список значений для использования при создании записи. Это может быть строка или фактический список строк.
recursive boolean added in community.general 4.6.0	Если `state=delete`, флаг, указывающий, следует ли удалить одну запись или всю ветвь. Варианты: `false` ← (default) `true`
referrals_chasing string added in community.general 2.0.0	Задайте поведение отслеживания рефералов. `anonymous` следовать рефералам анонимно. Это поведение по умолчанию. `disabled` отключить отслеживание рефералов. Это устанавливает `OPT_REFERRALS` в off. Варианты: `"disabled"` `"anonymous"` ← (default)
sasl_class string added in community.general 2.0.0	Класс, используемый для аутентификации SASL. Варианты: `"external"` ← (default) `"gssapi"`
server_uri string	Параметр `server_uri` может быть разделенным запятыми или пробелами списком URI, содержащих только поля схемы, хоста и порта. Значение по умолчанию позволяет базовой библиотеке клиента LDAP искать сокет домена UNIX в его расположении по умолчанию. Обратите внимание, что при использовании нескольких URI вы не можете определить, к какому URI подключается ваш клиент. Для URI, содержащих дополнительные поля, особенно при использовании запятых, поведение не определено. Default: `"ldapi:///"`
start_tls boolean	Если true, мы будем использовать расширение LDAP START_TLS. Варианты: `false` ← (default) `true`
state string	Целевое состояние записи. Варианты: `"present"` ← (default) `"absent"`
validate_certs boolean	Если установлено значение `false`, SSL-сертификаты не будут проверены. Это следует использовать только на сайтах, использующих самозаверенные сертификаты. Варианты: `false` `true` ← (default)

xorder_discovery

string

added in community.general 6.4.0

Установите поведение обработки Xordered DNs.

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

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

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

Варианты:

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

Атрибуты

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

Примечания

Примечание

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

Примеры

- name: Make sure we have a parent entry for users
  community.general.ldap_entry:
    dn: ou=users,dc=example,dc=com
    objectClass: organizationalUnit

- name: Make sure we have an admin user
  community.general.ldap_entry:
    dn: cn=admin,dc=example,dc=com
    objectClass:
      - simpleSecurityObject
      - organizationalRole
    attributes:
      description: An LDAP administrator
      userPassword: "{SSHA}tabyipcHzhwESzRaGA7oQ/SDoBZQOGND"

- name: Set possible values for attributes elements
  community.general.ldap_entry:
    dn: cn=admin,dc=example,dc=com
    objectClass:
      - simpleSecurityObject
      - organizationalRole
    attributes:
      description: An LDAP Administrator
      roleOccupant:
      - cn=Chocs Puddington,ou=Information Technology,dc=example,dc=com
      - cn=Alice Stronginthebrain,ou=Information Technology,dc=example,dc=com
      olcAccess:
      - >-
        {0}to attrs=userPassword,shadowLastChange
        by self write
        by anonymous auth
        by dn="cn=admin,dc=example,dc=com" write
        by * none'
      - >-
        {1}to dn.base="dc=example,dc=com"
        by dn="cn=admin,dc=example,dc=com" write
        by * read

- name: Get rid of an old entry
  community.general.ldap_entry:
    dn: ou=stuff,dc=example,dc=com
    state: absent
    server_uri: ldap://localhost/
    bind_dn: cn=admin,dc=example,dc=com
    bind_pw: password

#
# The same as in the previous example but with the authentication details
# stored in the ldap_auth variable:
#
# ldap_auth:
#   server_uri: ldap://localhost/
#   bind_dn: cn=admin,dc=example,dc=com
#   bind_pw: password
#
# In the example below, 'args' is a task keyword, passed at the same level as the module
- name: Get rid of an old entry
  community.general.ldap_entry:
    dn: ou=stuff,dc=example,dc=com
    state: absent
  args: "{{ ldap_auth }}"

Авторы

Jiri Tyr (@jtyr)

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

© 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_entry_module.html