Модуль community.general.ldap_inc — использование функции Modify-Increment LDAP V3 для увеличения значения атрибута

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: community.general.ldap_inc.

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

Краткое описание
Требования
Параметры
Атрибуты
Примечания
Примеры
Возвращаемые значения

Краткое описание

Атомарно увеличивает значение атрибута и возвращает его новое значение.

Требования

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

python-ldap

Параметры

Параметр	Комментарии
attribute string / обязательный	Атрибут, значение которого нужно увеличить.
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 / обязательный	Запись DN, содержащая атрибут, значение которого нужно увеличить.
increment integer	Величина увеличения. По умолчанию: `1`
method string	Если задано `auto`, модуль автоматически определяет используемый метод. Значения `rfc4525` или `legacy` принудительно выбирают соответствующий метод. Допустимые значения: `"auto"` ← (по умолчанию) `"rfc4525"` `"legacy"`
referrals_chasing string добавлен в community.general 2.0.0	Задаёт поведение при обработке перенаправлений. `anonymous` — переходить по перенаправлениям анонимно. Это поведение используется по умолчанию. `disabled` — отключить переход по перенаправлениям. При этом `OPT_REFERRALS` выключается. Допустимые значения: `"disabled"` `"anonymous"` ← (по умолчанию)
sasl_class string добавлен в community.general 2.0.0	Класс для аутентификации SASL. Допустимые значения: `"external"` ← (по умолчанию) `"gssapi"`
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`).

Примечания

Примечание

Если сервер каталогов поддерживает эту функцию, модуль использует расширение ModifyIncrement, определённое в RFC4525, и элемент управления PostRead. Это расширение и элемент управления реализованы в OpenLdap, но поддерживаются не всеми серверами каталогов. В таком случае модуль автоматически использует более традиционный двухэтапный метод: сначала считывается текущее значение, затем операция изменения удаляет старое значение и добавляет новое в одном запросе. Если значение изменилось в результате параллельного вызова, операция удаления завершится ошибкой. После этого последовательность повторяется 3 раза, прежде чем плейбуку будет возвращена ошибка. В условиях интенсивного изменения данных модуль не гарантирует стабильного успеха.
Модуль работает только с целочисленными атрибутами существующих записей. Чтобы изменить атрибуты записи, см. community.general.ldap_attrs, а чтобы добавить или удалить записи целиком, см. community.general.ldap_entry.
По умолчанию для аутентификации предпринимается попытка использовать привязку SASL EXTERNAL через сокет домена UNIX. Например, это хорошо работает при стандартной установке Ubuntu, которая включает правило ACL cn=peercred,cn=external,cn=auth, разрешающее пользователю root изменять конфигурацию сервера. Если для доступа к серверу требуется простая привязка, передайте учётные данные в bind_dn и bind_pw.

Примеры

- name: Increments uidNumber 1 Number for example.com
  community.general.ldap_inc:
    dn: "cn=uidNext,ou=unix-management,dc=example,dc=com"
    attribute: "uidNumber"
    increment: "1"
  register: ldap_uidNumber_sequence

- name: Modifies the user to define its identification number (uidNumber) when incrementation is successful
  community.general.ldap_attrs:
    dn: "cn=john,ou=posix-users,dc=example,dc=com"
    state: present
    attributes:
      - uidNumber: "{{ ldap_uidNumber_sequence.value }}"
  when: ldap_uidNumber_sequence.incremented

Возвращаемые значения

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

Ключ	Описание
attribute string	Имя атрибута, значение которого было увеличено. Возвращается: success Пример: `"uidNumber"`
incremented boolean	Значение равно `true`, если значение атрибута изменилось. Возвращается: success Пример: `true`
rfc4525 boolean	Равно `true`, если для увеличения использовался метод на основе RFC4525, и `false` — если использовался устаревший метод. Возвращается: success Пример: `true`
value string	Новое значение после увеличения. Возвращается: success Пример: `"2"`

Авторы

Philippe Duveau (@pduveau)

Ссылки на коллекцию

© 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/community/general/ldap_inc_module.html