community.general.ldap_passwd 模块 – 在 LDAP 中设置密码

注意

此模块是 community.general 集合 (版本 10.1.0) 的一部分。

如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install community.general。您需要其他要求才能使用此模块，有关详细信息，请参阅要求。

要在 playbook 中使用它，请指定： community.general.ldap_passwd。

概要 

设置 LDAP 条目的密码。此模块仅断言给定密码对于给定条目有效。要断言条目的存在，请参阅 community.general.ldap_entry。

要求 

执行此模块的主机需要以下要求。

python-ldap

参数 

参数	注释
bind_dn 字符串	要绑定的 DN。如果省略此项，我们将尝试使用 EXTERNAL 机制进行 SASL 绑定作为默认值。如果为空，我们将使用匿名绑定。
bind_pw 字符串	与 `bind_dn` 一起使用的密码。默认值： `""`
ca_path 路径在 community.general 6.5.0 中添加	设置包含 CA 证书的 PEM 文件的路径。
client_cert 路径在 community.general 7.1.0 中添加	PEM 格式的证书链文件，用于 SSL 客户端身份验证。如果定义了 `client_key`，则需要此参数。
client_key 路径在 community.general 7.1.0 中添加	包含用于 SSL 客户端身份验证的私钥的 PEM 格式文件。如果定义了 `client_cert`，则需要此参数。
dn 字符串 / 必需	要添加或删除的条目的 DN。
passwd 字符串	要为 `dn` 设置的（明文）密码。
referrals_chasing 字符串在 community.general 2.0.0 中添加	设置转介追踪行为。 `anonymous` 匿名跟踪转介。这是默认行为。 `disabled` 禁用转介追踪。这会将 `OPT_REFERRALS` 设置为关闭。选项 `"disabled"` `"anonymous"` ← (默认)
sasl_class 字符串在 community.general 2.0.0 中添加	用于 SASL 身份验证的类。选项 `"external"` ← (默认) `"gssapi"`
server_uri 字符串	`server_uri` 参数可以是包含仅模式、主机和端口字段的 URI 的逗号或空格分隔列表。默认值允许底层的 LDAP 客户端库在其默认位置查找 UNIX 域套接字。请注意，当使用多个 URI 时，您无法确定客户端连接到哪个 URI。对于包含附加字段的 URI，尤其是在使用逗号时，行为未定义。默认值： `"ldapi:///"`
start_tls 布尔值	如果为 true，我们将使用 START_TLS LDAP 扩展。选项 `false` ← (默认) `true`
validate_certs 布尔值	如果设置为 `false`，则不会验证 SSL 证书。这仅应在使用自签名证书的站点上使用。选项 `false` `true` ← (默认)
xorder_discovery 字符串在 community.general 6.4.0 中添加	设置处理 Xordered DN 的方式。 `enable` 将在父 RDN 下执行 `ONELEVEL` 搜索以查找匹配的 DN。 `disable` 将始终使用未修改的 DN（由 `dn` 参数传递）。 `auto` 仅当第一个 RDN 不包含索引号 (`{x}`) 时才会执行搜索。选项 `"enable"` `"auto"` ← (默认) `"disable"`

属性 

属性	支持	描述
check_mode	支持：完全支持	可以在`check_mode`下运行，并在不修改目标的情况下返回更改状态预测。
diff_mode	支持：不支持	在差异模式下，将返回有关已更改内容（或可能需要在`check_mode`下更改的内容）的详细信息。

备注 

注意

默认身份验证设置将尝试通过UNIX域套接字使用SASL EXTERNAL绑定。例如，这在默认的Ubuntu安装中运行良好，其中包括cn=peercred,cn=external,cn=auth ACL规则，允许root用户修改服务器配置。如果您需要使用简单的绑定来访问您的服务器，请在bind_dn和bind_pw中传递凭据。

示例 

- 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 }}"

返回值 

常见的返回值已在此处记录，以下是此模块独有的字段

键	描述
modlist 列表 / 元素=字符串	已修改参数的列表返回：成功示例：`[[2, "olcRootDN", ["cn=root,dc=example,dc=com"]]]`

作者

Keller Fuchs (@KellerFuchs)