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 布尔值	指定系统是否在下次成功的监控检查时自动将资源的状态更改为 enabled。 如果将此选项设置为 true，则必须在系统将其用于负载平衡连接之前手动重新启用资源。 当 true 时，指定您必须在监控检查不成功后手动重新启用资源。 当 false 时，指定系统在下次成功的监控检查时自动将资源的状态更改为 enabled。 选项 false true
name 字符串 / 必需	监控器名称。
parent 字符串	此监控器模板的父模板。一旦设置此值，就无法更改。默认情况下，此值为 Common 分区上的 gateway_icmp 父级。 默认值: "/Common/gateway_icmp"
分区 字符串	用于管理资源的设备分区。 默认值: "Common"
端口 字符串	IP/端口定义中的端口地址部分。如果在创建新监视器时未提供此参数，则默认值为“*”。如果指定 IP 地址，则必须使用 1 到 65535 之间的值。
提供者 字典 在 f5networks.f5_modules 1.0.0 中添加	包含连接详细信息的字典对象。
身份验证提供者 字符串	配置用于从远程设备获取身份验证令牌的身份验证提供程序。 此选项通常在与 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 整数	用于自适应响应时间监控的发散类型的值。 根据 relative 或 absolute，可以是 percent 或 ms。 返回值: 已更改 示例: 25
description 字符串	监控器的描述。 返回值: 已更改 示例: "重要 监视器"
interval 整数	运行监视器检查的新间隔。 返回值: 已更改 示例: 2
ip 字符串	IP/端口定义的新 IP。 返回值: 已更改 示例: "10.12.13.14"
parent 字符串	监视器的新父模板。 返回值: 已更改 示例: "gateway-icmp"
端口 字符串	监视器要代表与其关联的池或池成员检查的别名端口或服务。 返回值: 已更改 示例: "80"
采样时间跨度 整数	监视器探测可能不会超过的绝对毫秒数。 返回值: 已更改 示例: 200
直到变为正常的时间 整数	在首次成功响应后将系统标记为正常的新时间。 返回值: 已更改 示例: 2
超时 整数	远程系统必须响应监视器的新超时时间。 返回值: 已更改 示例: 10
透明 布尔值	监视器是否以透明模式运行。 返回值: 已更改 示例: false
正常间隔 整数	当资源正常运行时，系统用于执行运行状况检查的间隔。 返回值: 已更改 示例: 0

作者

• Tim Rupp (@caphrim007)

集合链接

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