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 整数	指定资源首次正确响应监视器后，等待多长时间才能将资源设置为“正常”。在此期间，资源的所有响应都必须正确。当时间间隔到期时，资源标记为“正常”。值为 0 表示在收到第一个正确响应后立即将资源标记为正常。
timeout 整数	指定目标必须在多长时间内响应监视器请求。如果目标在设定的时间段内响应，则认为其处于“正常”状态。如果目标在设定的时间段内没有响应，则认为其处于“异常”状态。当此值设置为 0（零）时，系统使用父监视器的间隔。请注意，`timeout` 和 `time_until_up` 结合使用来控制何时将资源设置为正常。
up_interval 整数	指定系统在资源处于正常状态时执行健康检查的间隔。当 `0` 时，表示系统使用 `interval` 中指定的间隔来检查资源的健康状况。当为任何其他数字时，允许您指定在检查正常资源的健康状况时要使用的不同间隔。
update_password 字符串	`always` 将在指定 `target_password` 时更新密码。 `on_create` 仅为新创建的监视器设置密码。选项 `"always"` ← (默认) `"on_create"`

备注 

注意

有关使用 Ansible 管理 F5 网络设备的更多信息，请参见 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 布尔值	资源的新追踪引用设置。返回：changed 示例： `true`
debug 布尔值	资源的新调试设置。返回：changed 示例： `true`
description 字符串	监视器的描述。返回：changed 示例： `"Important_Monitor"`
filter 字符串	资源的新 LDAP 过滤器设置。返回：changed 示例： `"filter1"`
interval 整数	运行监视器检查的新间隔。返回：changed 示例： `2`
ip 字符串	IP/端口定义的新 IP。返回：changed 示例： `"10.12.13.14"`
mandatory_attributes 布尔值	资源的新强制属性设置。返回：changed 示例： `false`
manual_resume 布尔值	资源的新手动恢复设置。返回：changed 示例： `false`
parent 字符串	监视器的新父模板。返回：changed 示例： `"ldap"`
security 字符串	资源的新安全设置。返回：changed 示例： `"ssl"`
time_until_up 整数	第一次成功响应后将系统标记为正常的新时间。返回：changed 示例： `2`
timeout 整数	远程系统必须在多长时间内响应监视器。返回：changed 示例： `10`

作者

Tim Rupp (@caphrim007)
Greg Crosby (@crosbygw)