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

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

f5networks.f5_modules 1.0.0 中的新增功能

概要

• 管理 BIG-IP LTM 上的网关 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%。
description 字符串	监控器的描述。
interval 整数	指定系统在资源关闭或资源状态未知时发出监控检查的频率（以秒为单位）。
ip 字符串	IP/端口定义的 IP 地址部分。如果在创建新的监控器时未提供此参数，则默认值为 '*'。
manual_resume 布尔值	指定系统是否在下次成功的监控检查时自动将资源的状态更改为**启用**。 如果将此选项设置为 true，则必须手动重新启用资源，然后系统才能将其用于负载平衡连接。 当 true 时，指定在监控检查失败后必须手动重新启用资源。 当 false 时，指定系统在下次成功的监控检查时自动将资源的状态更改为**启用**。 选项 false true
name 字符串 / 必需	监控器名称。
parent 字符串	此监控器模板的父模板。设置此值后，无法更改。默认情况下，此值为 Common 分区上的 gateway_icmp 父级。 默认值： "/Common/gateway_icmp"
partition 字符串	要在其上管理资源的设备分区。 默认值： "Common"
port 字符串	IP/端口定义的端口地址部分。如果在创建新的监控器时未提供此参数，则默认值为 '*'。如果指定 IP 地址，则必须使用 1 到 65535 之间的数值。
provider 字典 f5networks.f5_modules 1.0.0 中新增	包含连接详细信息的字典对象。
auth_provider 字符串	配置 auth 提供程序，以从远程设备获取身份验证令牌。 此选项在使用 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来省略此选项。
验证证书 布尔值	如果为no，则不会验证 SSL 证书。仅在使用自签名证书的个人控制站点上使用此选项。 可以通过设置环境变量F5_VALIDATE_CERTS来省略此选项。 选项 false true ← (默认)
采样时间跨度 整数	指定系统用于计算监控探测的平均延迟和标准偏差的探测历史窗口的长度（以秒为单位）。 虽然可以在 adaptive 为 false 时配置此值，但它在 adaptive 为 true 之前不会生效。
状态 字符串	当present时，确保监控器存在。 当absent时，确保监控器被移除。 选项 "present" ← (默认) "absent"
启动时间 整数	指定资源第一次正确响应监控器后等待的秒数，然后将资源设置为“启动”。 在此期间，资源的所有响应必须正确。 当间隔时间到期时，资源将被标记为“启动”。 值为0表示在收到第一个正确响应后立即将资源标记为启动。
超时 整数	指定目标响应监控器请求的时间（以秒为单位）。 如果目标在设定的时间段内响应，则认为它处于“启动”状态。如果目标在设定的时间段内没有响应，则认为它处于“关闭”状态。当此值设置为 0（零）时，系统使用父监控器的间隔。 请注意，timeout和time_until_up组合控制何时将资源设置为启动。
透明 布尔值	指定监控器是否在透明模式下运行。 透明模式下的监控器将流量定向通过关联的池成员或节点（通常是路由器或防火墙）到别名目标（即，它探测监控器中指定的ip-port组合）。 如果监控器无法成功到达别名目标，则将发送监控器流量的池成员或节点标记为关闭。 创建新的监控器时，如果没有提供此参数，则默认值将是parent提供的任何值。 选项 false true
启动间隔 整数	指定系统在资源启动时执行健康检查的间隔。 当0时，表示系统使用interval中指定的间隔来检查资源的健康状况。 当为任何其他数字时，您可以指定在检查处于启动状态的资源的健康状况时要使用的不同间隔。

注释

注意

• 有关使用 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 monitor
  bigip_monitor_gateway_icmp:
    name: gw1
    adaptive: false
    interval: 1
    time_until_up: 0
    timeout: 3
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

返回值

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

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

作者

• Tim Rupp (@caphrim007)

收藏链接

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