f5networks.f5_modules.bigip_monitor_icmp 模块 – 管理 F5 BIG-IP LTM ICMP 监控

注意

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

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

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

要在剧本中使用它，请指定： f5networks.f5_modules.bigip_monitor_icmp。

f5networks.f5_modules 1.1.0 中的新增功能

概要

• 管理 BIG-IP 上的 ICMP 监控。

参数

参数	注释
adaptive 布尔值	指定是否为此监控启用自适应响应时间监控。 当 true 时，监控根据允许该服务的监控探测与平均延迟的偏差程度来确定服务的状。此外，还将强制执行 allowed_divergence、adaptive_limit 和 sampling_timespan 的值。 当 disabled 时，监控根据 interval、up_interval、time_until_up 和 timeout 监控设置来确定服务的狀態。 选项 false true
adaptive_limit 整数	指定监控探测可能无法超过的绝对毫秒数，而不管 allowed_divergence 设置如何，探测都被认为是成功的。 此值适用于 allowed_divergence 设置的值。 虽然可以在 adaptive 为 false 时配置此值，但在 adaptive 为 true 之前，它不会对系统生效。
allowed_divergence_type 字符串	在指定新的监控时，如果 adaptive 为 true，则默认值为 relative。 当 absolute 时，监控探测的延迟可以超过被探测服务的监控探测的平均延迟的毫秒数。在典型情况下，如果监控连续检测到三个探测都未达到您设置的延迟值，则池成员或节点将被标记为关闭。 当 relative 时，监控探测的延迟可以超过被探测服务的监控探测的平均延迟的偏差百分比。 选项 "relative" "absolute"
allowed_divergence_value 整数	在指定新的监控时，如果 adaptive 为 true，并且 type 为 relative，则默认值为 25%。
app_service 字符串	要与此配置文件关联的 iApp 服务。当未指定服务时，默认为 None。
description 字符串	监控的描述。
interval 整数	指定系统在资源关闭或资源状态未知时发出监控检查的频率（以秒为单位）。
ip 字符串	指定此监控目标的资源的 IP 地址。 设置为 **\*** 时，设备会对节点的 IP 地址执行运行状况检查。 设置为 **<IP>** 时，设备会对该 IP 地址执行运行状况检查，并根据响应标记关联的节点为启动或关闭。此选项在创建监控时未定义时，默认情况下由设备设置。 设置为 **<IP>** 且 transparent 为 true 时，设备会对该 IP 地址执行运行状况检查，通过关联的节点 IP 地址路由检查，并相应地标记关联的节点 IP 地址为启动或关闭。
manual_resume 布尔值	指定系统是否在下次成功的监控检查时自动将资源的状态更改为 **已启用**。 如果将此选项设置为 true，则必须在系统可以使用它进行负载均衡连接之前手动重新启用资源。 当 true 时，指定在监控检查失败后必须手动重新启用资源。 当 false 时，指定系统在下次成功的监控检查时自动将资源的状态更改为 **已启用**。 选项 false true
name 字符串 / 必需	指定监控的名称。
parent 字符串	此监控模板的父模板。设置此值后，便无法更改。 创建新监控时，如果未指定此参数，则默认为系统提供的 icmp 监控。
partition 字符串	用于管理资源的设备分区。 默认值： "Common"
provider 字典 f5networks.f5_modules 1.0.0 中新增	包含连接详细信息的字典对象。
auth_provider 字符串	配置身份验证提供程序，以从远程设备获取身份验证令牌。 此选项主要用于与 BIG-IQ 设备配合使用。
no_f5_teem 布尔值	如果为 yes，则不会将 TEEM 遥测数据发送到 F5。 您可以通过设置环境变量 F5_TELEMETRY_OFF 来省略此选项。 先前使用的变量 F5_TEEM 已弃用，因为其名称令人困惑。 选项 false ← (默认) true
密码 别名：pass、pwd 字符串 / 必需	用于连接到 BIG-IP 或 BIG-IQ 的用户帐户的密码。 您可以通过设置环境变量 F5_PASSWORD 来省略此选项。
服务器 字符串 / 必需	BIG-IP 主机或 BIG-IQ 主机。 您可以通过设置环境变量 F5_SERVER 来省略此选项。
服务器端口 整数	BIG-IP 服务器端口。 您可以通过设置环境变量 F5_SERVER_PORT 来省略此选项。 默认值： 443
超时 整数	指定与网络设备通信的超时时间（以秒为单位），用于连接或发送命令。如果在操作完成之前超时，模块将出错。
传输 字符串	配置连接到远程设备时使用的传输连接。 选项 "rest" ← (默认)
用户 字符串 / 必需	连接到 BIG-IP 或 BIG-IQ 的用户名。此用户必须具有设备上的管理员权限。 您可以通过设置环境变量 F5_USER 来省略此选项。
validate_certs 布尔值	如果为 no，则不会验证 SSL 证书。仅在使用自签名证书的个人控制站点上使用此选项。 您可以通过设置环境变量 F5_VALIDATE_CERTS 来省略此选项。 选项 false true ← (默认)
采样时间跨度 整数	指定系统用于计算监视器探测的平均延迟和标准偏差的探测历史窗口的长度（以秒为单位）。 虽然可以在 adaptive 为 false 时配置此值，但在 adaptive 为 true 之前，它不会对系统生效。
状态 字符串	当为 present 时，确保监视器存在。 当为 absent 时，确保监视器被移除。 选项 "present" ← (默认) "absent"
time_until_up 整数	指定在资源首次正确响应监视器后等待的秒数，然后再将资源设置为“正常”。 在此期间，资源的所有响应都必须正确。 当时间间隔过期时，资源将标记为“正常”。 值为 0 表示在收到第一个正确响应后立即将资源标记为正常。
超时 整数	指定目标响应监视器请求的时间（以秒为单位）。 如果目标在设定的时间段内响应，则认为其为“正常”。如果目标未在设定的时间段内响应，则认为其为“异常”。当此值设置为 0（零）时，系统将使用父监视器的间隔。 请注意，timeout 和 time_until_up 结合使用来控制何时将资源设置为正常。
透明 布尔值	指定监视器是否以透明模式运行。 处于透明模式的监视器会将流量通过关联的池成员或节点（通常是路由器或防火墙）定向到别名目标（即，它探测监视器中指定的 ip-port 组合）。 如果监视器无法成功访问别名目标，则将发送监视器流量的池成员或节点标记为异常。 创建新的监视器时，如果未提供此参数，则默认值将是 parent 提供的值。 选项 false true
up_interval 整数	指定系统在资源正常时用于执行运行状况检查的间隔。 当为 0 时，指定系统使用 interval 中指定的间隔来检查资源的运行状况。 当为任何其他数字时，您可以指定不同的间隔，用于检查处于正常状态的资源的运行状况。

备注

注意

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

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

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

示例

- name: Create an ICMP monitor
  bigip_monitor_icmp:
    name: icmp1
    adaptive: false
    interval: 1
    time_until_up: 0
    timeout: 3
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Update an ICMP monitor
  bigip_monitor_icmp:
    name: icmp1
    manual_resume: true
    interval: 5
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Remove an ICMP monitor
  bigip_monitor_icmp:
    name: icmp1
    state: absent
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

返回值

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

键	描述
adaptive 布尔值	自适应功能是否启用。 已返回：changed 示例： true
adaptive_limit 整数	监视器探测可能超过的毫秒绝对数。 已返回：changed 示例： 200
allowed_divergence_type 字符串	用于自适应响应时间监视的差异类型。 已返回：changed 示例： "absolute"
allowed_divergence_value 整数	用于自适应响应时间监视的差异类型的数值。 可以是 percent 或 ms，具体取决于 relative 或 absolute。 已返回：changed 示例： 25
app_service 字符串	与此监视器关联的 iApp 服务。 已返回：changed 示例： "/Common/good_service.app/good_service"
description 字符串	监控的描述。 已返回：changed 示例： "重要 监视器"
interval 整数	运行监视器检查的新间隔。 已返回：changed 示例： 2
ip 字符串	IP/端口定义的新 IP。 已返回：changed 示例： "10.12.13.14"
parent 字符串	监视器的新父模板。 已返回：changed 示例： "gateway-icmp"
端口 字符串	监视器代表与其关联的池或池成员检查的别名端口或服务。 已返回：changed 示例： "80"
采样时间跨度 整数	监视器探测可能超过的毫秒绝对数。 已返回：changed 示例： 200
time_until_up 整数	首次成功响应后将系统标记为正常的新时间。 已返回：changed 示例： 2
超时 整数	远程系统必须响应监视器的新超时时间。 已返回：changed 示例： 10
透明 布尔值	监视器是否以透明模式运行。 已返回：changed 示例： false
up_interval 整数	系统在资源正常时用于执行运行状况检查的间隔。 已返回：changed 示例： 0

作者

• Wojciech Wypior (@wojtek0806)

资源链接

• 问题追踪器
• 主页
• 代码仓库