f5networks.f5_modules.bigip_gtm_monitor_bigip 模块 – 管理 F5 BIG-IP GTM BIG-IP 监控

注意

此模块是 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_gtm_monitor_bigip

f5networks.f5_modules 1.0.0 中的新增功能

概要

  • 管理 F5 BIG-IP GTM(现在为 BIG-IP DNS)BIG-IP 监控。此监控器由 GTM 用于监控 BIG-IP 本身。

参数

参数

注释

aggregate_dynamic_ratios

字符串

指定系统如何组合模块值以创建负载平衡操作的比例(分数)。

分数表示模块处理流量的估计容量。

平均值适用于下游 Web 加速器或应用程序安全管理器 (ASM) 虚拟服务器。

创建新的监控器时,如果未指定此参数,则使用默认值 none,这意味着系统不使用负载平衡操作中的分数。

当为 none 时,指定监控器忽略节点和池成员分数。

当为 average-nodes 时,指定系统对与监控器目标虚拟服务器关联的节点上的动态比率取平均值,并将其平均值作为虚拟服务器的分数返回。

当为 sum-nodes 时,指定系统将与监控器目标虚拟服务器关联的节点的分数加在一起,并在负载平衡操作中使用该值。

当为 average-members 时,指定系统对与监控器目标虚拟服务器关联的池成员上的动态比率取平均值,并将其平均值作为虚拟服务器的分数返回。

当为 sum-members 时,指定系统将与监控器目标虚拟服务器关联的池成员的分数加在一起,并在负载平衡操作中使用该值。

选项

  • "none"

  • "average-nodes"

  • "sum-nodes"

  • "average-members"

  • "sum-members"

ignore_down_response

布尔值

指定监控器允许每个间隔进行多次探测尝试。

当为 true 时,指定监控器在监控器超时期间忽略下降响应。一旦监控器超时达到而系统未收到向上响应,系统就会将对象标记为下降。

当为 false 时,指定监控器在收到下降响应时立即将对象标记为下降。

创建新的监控器时,如果未提供此参数,则默认值为 false

选项

  • false

  • true

interval

整数

指定系统在资源处于关闭状态或资源状态未知时发出监控检查的频率(以秒为单位)。

创建新的监控器时,如果未提供此参数,则默认值为 30。此值**必须**小于 timeout 值。

ip

字符串

IP/端口定义的 IP 地址部分。如果在创建新的监控器时未提供此参数,则默认值为“*”。

name

字符串 / 必需

监控器的名称。

parent

字符串

此监控器模板的父模板。设置此值后,将无法更改。默认情况下,此值为 bigip 父项,位于 Common 分区。

默认值: "/Common/bigip"

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 ← (默认)

状态

字符串

当为present时,确保监视器存在。

当为absent时,确保监视器被移除。

选项

  • "present" ← (默认)

  • "absent"

超时

整数

指定目标必须在多长时间内响应监视器请求(秒)。

如果目标在设定的时间段内响应,则认为其处于活动状态。

如果目标在设定的时间段内没有响应,则认为其处于停机状态。

当此值设置为 0(零)时,系统将使用父监视器的间隔。

创建新的监视器时,如果未提供此参数,则默认值为90

注释

注意

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

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

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

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

示例

- name: Create BIG-IP Monitor
  bigip_gtm_monitor_bigip:
    state: present
    ip: 10.10.10.10
    name: my_monitor
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Remove BIG-IP Monitor
  bigip_gtm_monitor_bigip:
    state: absent
    name: my_monitor
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Add BIG-IP monitor for all addresses, port 514
  bigip_gtm_monitor_bigip:
    port: 514
    name: my_monitor
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

返回值

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

描述

aggregate_dynamic_ratios

字符串

监视器的新聚合。

返回:changed

示例: "sum-members"

ignore_down_response

布尔值

是否忽略停机响应。

返回:changed

示例: true

interval

整数

运行监视器检查的新间隔。

返回:changed

示例: 2

ip

字符串

IP/端口定义的新 IP。

返回:changed

示例: "10.12.13.14"

parent

字符串

监视器的新父模板。

返回:changed

示例: "bigip"

超时

整数

远程系统必须在多长时间内响应监视器(秒)。

返回:changed

示例: 10

作者

  • Tim Rupp (@caphrim007)

  • Wojciech Wypior (@wojtek0806)