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 组中用户的成员属性。 选项 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 中添加	包含连接详细信息的 dict 对象。
auth_provider 字符串	配置 auth 提供程序，以从远程设备获取身份验证令牌。 此选项在处理 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"
servers 列表 / 元素=字符串	指定系统必须用于获取身份验证信息的 LDAP 服务器。创建 LDAP 配置对象时，必须指定服务器。
source_type 字符串 在 f5networks.f5_modules 1.13.0 中添加	指定用户身份验证的身份验证源，应与 use_for_auth 一起使用。 选项 "ldap" ←（默认） "active-directory"
ssl 字符串	指定系统是否使用 SSL 端口与 LDAP 服务器通信。 选项 “是” “否” “start-tls”
状态 字符串	当 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 字符串	指定登录用户的专有名称。 您可以将模板指定为一个变量，系统会在登录尝试期间将其替换为用户特定信息。 例如，您可以指定一个用户模板，如 %s@siterequest.com 或 uxml:id=%s,ou=people,dc=siterequest,dc=com。 当用户尝试登录时，系统会将 %s 替换为用户在基本身份验证对话框中指定的名称，并将其作为绑定操作的专有名称传递。 系统会将关联的密码作为绑定操作的密码传递。 此字段只能包含一个 %s，不能包含任何其他格式说明符。
validate_certs 别名：ssl_check_peer 布尔值	指定系统是否检查 SSL 对等方，因此系统需要并验证服务器证书。 选项 false true

说明

注意

• 有关使用 Ansible 管理 F5 Networks 设备的更多信息，请参阅 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

返回值

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

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

作者

• Tim Rupp (@caphrim007)

• Wojciech Wypior (@wojtek0806)

集合链接

• 问题跟踪器
• 主页
• 存储库（来源）