f5networks.f5_modules.bigip_monitor_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_monitor_ldap。

f5networks.f5_modules 1.0.0 中的新功能

概要

• 管理 BIG-IP LDAP 监控器。

参数

参数	注释
base 字符串	指定监控器开始运行状况检查的 LDAP 树中的位置。
chase_referrals 布尔值	收到 LDAP 引用条目后，指定目标是否遵循（或追逐）该引用。 选择 false true
debug 布尔值	指定监控器是否将错误消息和其他信息发送到专门为此监控器创建并标记的日志文件。 选择 false true
description 字符串	指定标识监控器的描述性文本。
filter 字符串	指定监控器搜索的 LDAP 键。
interval 整数	指定当资源关闭或资源状态未知时，系统发出监控检查的频率（以秒为单位）。
ip 字符串	IP/端口定义的 IP 地址部分。如果创建新监控器时未提供此参数，则默认值为“*”。
mandatory_attributes 布尔值	指定目标是否必须在其响应中包含属性才能被视为正常运行。 选择 false true
manual_resume 布尔值	指定系统是否在下次成功的监控检查时自动将资源的状态更改为已启用。 如果将此选项设置为 true，则必须手动重新启用资源，系统才能将其用于负载平衡连接。 当 true 时，指定在监控检查失败后必须手动重新启用资源。 当 false 时，指定系统在下次成功的监控检查时自动将资源的状态更改为 已启用。 选择 false true
name 字符串 / 必需	监控器名称。
parent 字符串	此监控器模板的父模板。设置此值后，无法更改。 默认情况下，此值是 Common 分区上的 ldap 父级。 默认值： "/Common/ldap"
partition 字符串	用于管理资源的设备分区。 默认值： "Common"
port 字符串	IP/端口定义的端口地址部分。如果创建新监控器时未提供此参数，则默认值为“*”。 请注意，如果指定 IP 地址，则必须指定介于 1 到 65535 之间的值。
provider 字典 在 f5networks.f5_modules 1.0.0 中添加	一个包含连接详细信息的字典对象。
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 ←（默认）
security 字符串	指定与目标通信的安全协议类型。 选择 "none" "ssl" "tls"
state 字符串	当为 present 时，确保监视器存在。 当为 absent 时，确保监视器被删除。 选择 "present" ←（默认） "absent"
target_password 字符串	如果被监控的目标需要身份验证，则指定密码。
target_username 字符串	如果被监控的目标需要身份验证，则指定用户名。
time_until_up 整数	指定在资源首次正确响应监视器后，等待多少秒才将资源设置为“up”。 在此间隔期间，资源的所有响应必须正确。 当间隔到期时，资源被标记为“up”。 值为 0 表示在收到第一个正确响应后立即将资源标记为 up。
timeout 整数	指定目标响应监视器请求的秒数。 如果目标在设定的时间段内响应，则认为其处于“up”状态。如果目标未在设定的时间段内响应，则认为其处于“down”状态。当此值设置为 0（零）时，系统将使用父监视器的间隔。 请注意，timeout 和 time_until_up 结合使用以控制何时将资源设置为 up。
up_interval 整数	指定当资源处于 up 状态时，系统用于执行健康检查的间隔。 当为 0 时，指定系统使用 interval 中指定的间隔来检查资源的健康状况。 当为任何其他数字时，您可以指定不同的间隔，以便在检查处于 up 状态的资源的健康状况时使用。
update_password 字符串	如果指定了 target_password，always 将更新密码。 on_create 将仅为新创建的监视器设置密码。 选择 "always" ←（默认） "on_create"

备注

注意

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

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

• F5 模块仅操作 F5 产品的运行配置。要确保 BIG-IP 特定配置持久化到磁盘，请务必至少包含一个使用 f5networks.f5_modules.bigip_config 模块保存运行配置的任务。有关正确使用模块以保存运行配置的信息，请参阅模块的文档。

示例

- name: Create a LDAP monitor
  bigip_monitor_ldap:
    name: foo
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

返回值

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

Key	描述
base 字符串	资源的新 LDAP 基准设置。 返回: changed 示例: "base"
chase_referrals 布尔值	资源的新 Chase Referrals 设置。 返回: changed 示例: true
debug 布尔值	资源的新 Debug 设置。 返回: changed 示例: true
description 字符串	监视器的描述。 返回: changed 示例: "Important_Monitor"
filter 字符串	资源的新 LDAP 过滤器设置。 返回: changed 示例: "filter1"
interval 整数	运行监视器检查的新间隔。 返回: changed 示例: 2
ip 字符串	IP/端口定义的新 IP。 返回: changed 示例: "10.12.13.14"
mandatory_attributes 布尔值	资源的新 Mandatory Attributes 设置。 返回: changed 示例: false
manual_resume 布尔值	资源的新 Manual Resume 设置。 返回: changed 示例: false
parent 字符串	监视器的新父模板。 返回: changed 示例: "ldap"
security 字符串	资源的新 Security 设置。 返回: changed 示例: "ssl"
time_until_up 整数	在第一次成功响应后将系统标记为 up 的新时间。 返回: changed 示例: 2
timeout 整数	远程系统必须响应监视器的新超时时间。 返回: changed 示例: 10

作者

• Tim Rupp (@caphrim007)

• Greg Crosby (@crosbygw)

集合链接

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