community.general.ldap_passwd – Set passwords in LDAP.
Note
This plugin is part of the community.general collection (version 3.8.3).
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_passwd
.
Synopsis
Set a password for an LDAP entry. This module only asserts that a given password is valid for a given entry. To assert the existence of an entry, see community.general.ldap_entry.
Parameters
Parameter |
Comments |
---|---|
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. |
|
The password to use with bind_dn. |
|
The DN of the entry to add or remove. |
|
The (plaintext) password to be set for dn. |
|
Set the referrals chasing behavior.
Choices:
|
|
The class to use for SASL authentication. possible choices are Choices:
|
|
A URI to the LDAP server. The default value lets the underlying LDAP client library look for a UNIX domain socket in its default location. Default: “ldapi:///” |
|
If true, we’ll use the START_TLS LDAP extension. Choices:
|
|
If set to This should only be used on sites using self-signed certificates. Choices:
|
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: Set a password for the admin user
community.general.ldap_passwd:
dn: cn=admin,dc=example,dc=com
passwd: "{{ vault_secret }}"
- name: Setting passwords in bulk
community.general.ldap_passwd:
dn: "{{ item.key }}"
passwd: "{{ item.value }}"
with_dict:
alice: alice123123
bob: "|30b!"
admin: "{{ vault_secret }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
list of modified parameters Returned: success Sample: “[[2, \”olcRootDN\”, [\”cn=root,dc=example,dc=com\”]]]” |
Authors
Keller Fuchs (@KellerFuchs)