f5networks.f5_modules.bigip_device_auth_ldap 模块 – 在 BIG-IP 上管理 LDAP 设备身份验证设置

注意

此模块是 f5networks.f5_modules 集合（版本 1.32.1）的一部分。

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

要安装它，请使用：ansible-galaxy collection install f5networks.f5_modules。

要在 playbook 中使用它，请指定：f5networks.f5_modules.bigip_device_auth_ldap。

f5networks.f5_modules 1.0.0 中的新增功能

概要

• 在 BIG-IP 上管理 LDAP 设备身份验证设置。

参数

参数	注释
bind_dn 字符串	指定 Active Directory 或 LDAP 服务器用户 ID 的可分辨名称。 BIG-IP 客户端身份验证模块不支持在验证转发的帐户时不执行绑定引用的 Active Directory 或 LDAP 服务器。 因此，如果您计划使用 Active Directory 或 LDAP 作为身份验证源并希望使用转发的帐户，请确保您的服务器执行绑定引用。
bind_password 字符串	指定 Active Directory 或 LDAP 服务器用户 ID 的密码。
ca_cert 别名：ssl_ca_cert 字符串	指定来自证书颁发机构 (CA) 的 SSL 证书的名称。 要删除此值，请使用保留值 none。
check_member_attr 布尔值	检查远程 LDAP 或 AD 组中用户的 member 属性。 选项 false true
client_cert 别名：ssl_client_cert 字符串	指定 SSL 客户端证书的名称。 要删除此值，请使用保留值 none。
client_key 别名：ssl_client_key 字符串	指定 SSL 客户端密钥的名称。 要删除此值，请使用保留值 none。
fallback_to_local 布尔值	指定如果远程身份验证方法不可用，则系统使用本地身份验证方法。 仅在 TMOS 13.0.0 及更高版本上可用。 选项 false true
login_ldap_attr 字符串	指定包含与所选目录条目关联的本地用户名 LDAP 目录属性。 如果未指定此参数，则首次配置 LDAP 设备身份验证时，默认端口为 samaccountname。
port 整数	指定系统用于访问远程主机服务器的端口。 如果未指定此参数，则首次配置 LDAP 设备身份验证时，默认端口为 389。
provider 字典 f5networks.f5_modules 1.0.0 中新增	包含连接详细信息的字典对象。
auth_provider 字符串	配置 auth provider 以从远程设备获取身份验证令牌。 此选项在使用 BIG-IQ 设备时才会真正使用。
no_f5_teem 布尔值	如果为 yes，则不会将 TEEM 遥测数据发送到 F5。 您可以通过设置环境变量 F5_TELEMETRY_OFF 来省略此选项。 以前使用的变量 F5_TEEM 已弃用，因为其名称令人困惑。 选项 false ← (默认) true
password 别名：pass, pwd 字符串 / 必需	用于连接到 BIG-IP 或 BIG-IQ 的用户帐户的密码。 您可以通过设置环境变量 F5_PASSWORD 来省略此选项。
server 字符串 / 必需	BIG-IP 主机或 BIG-IQ 主机。 您可以通过设置环境变量 F5_SERVER 来省略此选项。
server_port 整数	BIG-IP 服务器端口。 您可以通过设置环境变量 F5_SERVER_PORT 来省略此选项。 默认值： 443
timeout 整数	指定与网络设备通信的超时时间（以秒为单位），用于连接或发送命令。如果在操作完成之前超时，则模块将出错。
transport 字符串	配置连接到远程设备时要使用的传输连接。 选项 "rest" ← (默认)
user 字符串 / 必需	连接到 BIG-IP 或 BIG-IQ 的用户名。此用户必须具有设备上的管理员权限。 您可以通过设置环境变量 F5_USER 来省略此选项。
validate_certs 布尔值	如果为 no，则不验证 SSL 证书。仅在使用自签名证书的个人控制站点上使用此选项。 您可以通过设置环境变量 F5_VALIDATE_CERTS 来省略此选项。 选项 false true ← (默认)
referrals 布尔值 f5networks.f5_modules 1.22.0 中新增	指定是否应启用自动引用跟踪。 仅在 TMOS 15.1.0 及更高版本上可用。 选项 false true
remote_directory_tree 字符串	指定服务器上用户身份验证数据库的文件位置（树）。
scope 字符串	指定系统应搜索用户身份验证的远程 Active Directory 或 LDAP 目录的级别。 选项 “sub” “one” “base”
服务器 列表 / 元素=字符串	指定系统必须用来获取身份验证信息的 LDAP 服务器。创建 LDAP 配置对象时，必须指定一个服务器。
source_type 字符串 f5networks.f5_modules 1.13.0 版本中添加	指定用户身份验证的认证源，应与 use_for_auth 一起使用。 选项 "ldap" ← (默认) “active-directory”
ssl 字符串	指定系统是否使用 SSL 端口与 LDAP 服务器通信。 选项 “yes” “no” “start-tls”
state 字符串	当 present 时，确保设备身份验证方法存在。 当 absent 时，确保设备身份验证方法不存在。 当 state 等于 (absent) 时，在删除 LDAP 配置之前，系统必须将身份验证设置为其他方式。系统自带名为 local 的系统身份验证，因此在删除 LDAP 配置后，系统的身份验证类型将设置为该值。 选项 "present" ← (默认) “absent”
update_password 字符串	always 始终更新 bind_password。 on_create 只为新创建的身份验证机制设置 bind_password。 选项 "always" ← (默认) “on_create”
use_for_auth 布尔值	指定是否在系统上使用此身份验证源。 如果 true，模块会将当前系统身份验证类型设置为 ldap 的值。 如果 false，模块会将身份验证类型设置为 local，类似于 state 为 absent 时的行为，但不会删除已配置的 LDAP 资源。 选项 false true
user_template 字符串	指定正在登录用户的可分辨名称。 您可以将模板指定为一个变量，系统在登录尝试期间会用用户特定的信息替换该变量。 例如，您可以指定一个用户模板，例如 %[email protected] 或 uxml:id=%s,ou=people,dc=siterequest,dc=com。 当用户尝试登录时，系统会将 %s 替换为用户在基本身份验证对话框中指定的名称，并将其作为绑定操作的可分辨名称传递。 系统将关联的密码作为绑定操作的密码传递。 此字段只能包含一个 %s，并且不能包含任何其他格式说明符。
validate_certs 别名：ssl_check_peer 布尔值	指定系统是否检查 SSL 对等体，因此系统需要并验证服务器证书。 选项 false true

备注

注意

• 有关使用 Ansible 管理 F5 网络设备的更多信息，请参见 https://ansible.org.cn/integrations/networks/f5。

• 需要 BIG-IP 软件版本 >= 12。

• F5 模块仅操作 F5 产品的运行配置。为确保 BIG-IP 特定的配置持久保存到磁盘，请务必包含至少一项使用 f5networks.f5_modules.bigip_config 模块保存运行配置的任务。请参阅模块的文档，了解保存运行配置的模块的正确用法。

示例

- name: Create an LDAP authentication object
  bigip_device_auth_ldap:
    name: foo
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

返回值

公共返回值已在 此处 记录，以下是此模块特有的字段

Key	描述
bind_dn 字符串	Active Directory 或 LDAP 服务器用户 ID 的可分辨名称。 返回：changed 示例： "[email protected]"
ca_cert 字符串	来自证书颁发机构的 SSL 证书的名称。 返回：changed 示例： "My-Trusted-CA-Bundle.crt"
check_member_attr 布尔值	用户在远程 LDAP 或 AD 组中的成员属性。 返回：changed 示例： true
client_cert 字符串	SSL 客户端证书的名称。 返回：changed 示例： "MyCert.crt"
client_key 字符串	SSL 客户端密钥的名称。 返回：changed 示例： "MyKey.key"
fallback_to_local 布尔值	指定系统使用本地身份验证方法作为后备。 返回：changed 示例： true
login_ldap_attr 字符串	包含与所选目录条目关联的本地用户名，LDAP 目录属性。 返回：changed 示例： "samaccountname"
port 整数	系统用于访问远程 LDAP 服务器的端口。 返回：changed 示例： 389
referrals 布尔值	指定是否应启用自动引用追溯。 返回：changed 示例： true
remote_directory_tree 字符串	服务器上用户身份验证数据库的文件位置（树）。 返回：changed 示例： "CN=Users,DC=FOOBAR,DC=LOCAL"
scope 字符串	搜索用于用户身份验证的远程 Active Directory 或 LDAP 目录的级别。 返回：changed 示例： "base"
服务器 列表 / 元素=字符串	系统用于获取身份验证信息的 LDAP 服务器。 返回：changed 示例： ["192.168.1.1", "192.168.1.2"]
ssl 字符串	指定系统是否使用 SSL 端口与 LDAP 服务器通信。 返回：changed 示例： "start-tls"
user_template 字符串	正在登录用户的可分辨名称。 返回：changed 示例： "uid=%s,ou=people,dc=foobar,dc=local"
validate_certs 布尔值	指示系统是否检查 SSL 对等体。 返回：changed 示例： true

作者

• Tim Rupp (@caphrim007)

• Wojciech Wypior (@wojtek0806)

收藏链接

• 问题追踪器
• 主页
• 代码库（源代码）