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 字符串	此监控器模板的父模板。设置此值后，无法更改。默认情况下，此值是 Common 分区上的 bigip 父项。 默认值: "/Common/bigip"
partition 字符串	用于管理资源的设备分区。 默认值: "Common"
port 字符串	IP/端口定义中的端口地址部分。如果创建新监控器时未提供此参数，则默认值将为“*”。请注意，如果指定 IP 地址，则必须使用 1 到 65535 之间的值。
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 ← (默认)
state 字符串	当为 present 时，确保监视器存在。 当为 absent 时，确保监视器被移除。 选择 "present" ← (默认) "absent"
timeout 整数	指定目标响应监视器请求的秒数。 如果目标在设定的时间段内响应，则认为其已启动。 如果目标未在设定的时间段内响应，则认为其已关闭。 当此值设置为 0（零）时，系统使用父监视器的间隔。 创建新监视器时，如果未提供此参数，则默认值为 90。

注释

注意

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

• 有关使用 Ansible 管理 F5 Networks 设备的更多信息，请参阅 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"
timeout 整数	远程系统必须响应监视器的新超时时间。 返回值: changed 示例: 10

作者

• Tim Rupp (@caphrim007)

• Wojciech Wypior (@wojtek0806)

集合链接

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