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。

要在 playbook 中使用它，请指定：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 布尔值	指定系统是否在下一次成功的监控器检查时自动将资源的状态更改为 enabled。 如果将此选项设置为 true，则必须手动重新启用资源，系统才能将其用于负载均衡连接。 当 true 时，指定在监控器检查不成功后，必须手动重新启用资源。 当 false 时，指定系统在下一次成功的监控器检查时自动将资源的状态更改为 enabled。 选项 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
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 ← (默认)
sampling_timespan 整数	指定系统用于计算监视器探测的平均延迟和标准偏差的探测历史窗口的长度（以秒为单位）。 虽然可以在 adaptive 为 false 时配置此值，但在 adaptive 为 true 之前，它不会在系统上生效。
state 字符串	当为 present 时，确保监视器存在。 当为 absent 时，确保删除监视器。 选项 "present" ← (默认) "absent"
time_until_up 整数	指定在资源首次正确响应监视器后，等待多少秒才能将资源设置为“up”。 在此间隔期间，来自资源的所有响应都必须正确。 当间隔过期时，资源将被标记为“up”。 值为 0 表示在收到第一个正确响应后，立即将资源标记为 up。
timeout 整数	指定目标必须在多长时间内响应监视器请求。 如果目标在设定的时间段内响应，则视为“up”。如果目标在设定的时间段内未响应，则视为“down”。当此值设置为 0（零）时，系统使用来自父监视器的间隔。 请注意，timeout 和 time_until_up 结合使用来控制何时将资源设置为 up。
transparent 布尔值	指定监视器是否在透明模式下运行。 处于透明模式的监视器将流量定向到关联的池成员或节点（通常是路由器或防火墙），到达别名目标（即，它探测监视器中指定的 ip-port 组合）。 如果监视器无法成功到达别名目标，则将发送监视器流量的池成员或节点标记为 down。 创建新监视器时，如果未提供此参数，则默认值将为 parent 提供的任何值。 选项 false true
up_interval 整数	指定当资源处于 up 状态时，系统用于执行运行状况检查的间隔。 当为 0 时，指定系统使用 interval 中指定的间隔来检查资源的运行状况。 当为任何其他数字时，可以指定不同的间隔，用于检查处于 up 状态的资源的运行状况。

说明

注意

• 有关使用 Ansible 管理 F5 Networks 设备的更多信息，请参阅 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

返回值

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

Key	描述
adaptive 布尔值	是否启用了自适应。 返回值: changed 示例: true
adaptive_limit 整数	监视器探测可能不会超过的绝对毫秒数。 返回值: changed 示例: 200
allowed_divergence_type 字符串	用于自适应响应时间监视的发散类型。 返回值: changed 示例: "absolute"
allowed_divergence_value 整数	用于自适应响应时间监视的发散类型的值。 根据 relative 或 absolute，可能是 percent 或 ms。 返回值: changed 示例: 25
app_service 字符串	与此监视器关联的 iApp 服务。 返回值: changed 示例: "/Common/good_service.app/good_service"
description 字符串	监控器的描述。 返回值: changed 示例: "Important Monitor"
interval 整数	运行监视器检查的新间隔。 返回值: changed 示例: 2
ip 字符串	IP/端口定义的新 IP。 返回值: changed 示例: "10.12.13.14"
parent 字符串	监视器的新父模板。 返回值: changed 示例: "gateway-icmp"
port 字符串	监视器代表与其关联的池或池成员检查的别名端口或服务。 返回值: changed 示例: "80"
sampling_timespan 整数	监视器探测可能不会超过的绝对毫秒数。 返回值: changed 示例: 200
time_until_up 整数	在首次成功响应后，将系统标记为 up 的新时间。 返回值: changed 示例: 2
timeout 整数	远程系统必须响应监视器的新超时时间。 返回值: changed 示例: 10
transparent 布尔值	监视器是否在透明模式下运行。 返回值: changed 示例: false
up_interval 整数	当资源处于 up 状态时，系统用于执行运行状况检查的间隔。 返回值: changed 示例: 0

作者

• Wojciech Wypior (@wojtek0806)

集合链接

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