f5networks.f5_modules.bigip_monitor_http 模块 – 管理 F5 BIG-IP LTM HTTP 监控器

注意

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

f5networks.f5_modules 1.0.0 中的新增功能

概要

• 管理 F5 BIG-IP LTM HTTP 监控器。

参数

参数	注释
description string	监控器的描述。
interval integer	指定此模板的监控器实例运行频率的间隔。如果创建新监控器时未提供此参数，则默认值为 5。此值 必须 小于 timeout 值。
ip string	IP/端口定义中的 IP 地址部分。如果创建新监控器时未提供此参数，则默认值为“*”。
name string / 必需	监控器名称。
parent string	此监控器模板的父模板。一旦设置此值，就无法更改。默认情况下，此值是 Common 分区上的 http 父级。 默认值: "/Common/http"
partition string	用于管理资源的设备分区。 默认值: "Common"
port string	IP/端口定义中的端口地址部分。如果创建新监控器时未提供此参数，则默认值为“*”。如果指定 IP 地址，则必须指定 1 到 65535 之间的值。
provider dictionary 在 f5networks.f5_modules 1.0.0 中添加	包含连接详细信息的 dict 对象。
auth_provider string	配置身份验证提供程序，以便从远程设备获取身份验证令牌。 此选项在处理 BIG-IQ 设备时非常有用。
no_f5_teem boolean	如果为 yes，则不会将 TEEM 遥测数据发送到 F5。 您可以通过设置环境变量 F5_TELEMETRY_OFF 来省略此选项。 先前使用的变量 F5_TEEM 已弃用，因为其名称令人困惑。 选项 false ← (默认) true
password 别名: pass, pwd string / 必需	用于连接到 BIG-IP 或 BIG-IQ 的用户帐户的密码。 您可以通过设置环境变量 F5_PASSWORD 来省略此选项。
server string / 必需	BIG-IP 主机或 BIG-IQ 主机。 您可以通过设置环境变量 F5_SERVER 来省略此选项。
server_port integer	BIG-IP 服务器端口。 您可以通过设置环境变量 F5_SERVER_PORT 来省略此选项。 默认值: 443
timeout integer	指定与网络设备通信（用于连接或发送命令）的超时时间（以秒为单位）。如果在操作完成之前超时，则模块将出错。
transport string	配置连接到远程设备时要使用的传输连接。 选项 "rest" ← (默认)
user string / 必需	连接到 BIG-IP 或 BIG-IQ 的用户名。此用户必须在设备上具有管理权限。 您可以通过设置环境变量 F5_USER 来省略此选项。
validate_certs boolean	如果为 no，则不验证 SSL 证书。仅在个人控制的站点上使用自签名证书时才使用此选项。 您可以通过设置环境变量 F5_VALIDATE_CERTS 来省略此选项。 选项 false true ← (默认)
receive string	监控器调用的接收字符串。
receive_disable string	此设置的工作方式类似于 receive，不同之处在于，当其响应与 receive_disable 字符串匹配但不与 receive 匹配时，系统会标记节点或池成员为禁用状态。要使用此设置，必须同时指定 receive_disable 和 receive。
reverse boolean	指定监控器是否以反向模式运行。 当监控器处于反向模式时，成功的接收字符串匹配会将受监控对象标记为关闭而不是开启。只有在配置 receive 选项时才能使用此模式。 此参数与 time_until_up 参数不兼容。如果指定了 time_until_up，则它必须为 0。或者，如果它已存在，则它必须为 0。 选项 false true
send string	监控器调用的发送字符串。创建新监控器时，如果未提供此值，则使用默认的 GET /\r\n。
state string	当为 present 时，确保监控器存在。 当为 absent 时，确保监控器被删除。 选项 "present" ← (默认) "absent"
target_password string	指定密码，如果被监控的目标需要身份验证。
target_username string	指定用户名，如果被监控的目标需要身份验证。
time_until_up integer	指定在首次成功响应后，将节点标记为“正常”状态之前等待的时间（以秒为单位）。值为 0 表示在收到来自节点的有效响应后立即将节点标记为“正常”。 如果在创建新监视器时未提供此参数，则默认值为 0。
timeout integer	节点或服务必须响应监视器请求的秒数。如果目标在设定的时间内响应，则认为其处于“正常”状态。如果目标在设定的时间内未响应，则认为其处于“故障”状态。您可以将其更改为任何数字，但是，它应为间隔秒数的 3 倍加 1 秒。如果在创建新监视器时未提供此参数，则默认值为 16。
up_interval integer 在 f5networks.f5_modules 1.22.0 中添加	指定当资源处于“正常”状态时，系统用于执行健康检查的间隔。 当 0 时，指定系统使用在 interval 中指定的间隔来检查资源的健康状况。 当为任何其他数字时，您可以指定在检查处于“正常”状态的资源的健康状况时使用不同的间隔。

说明

注意

• 需要 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 HTTP Monitor
  bigip_monitor_http:
    state: present
    ip: 10.10.10.10
    name: my_http_monitor
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Remove HTTP Monitor
  bigip_monitor_http:
    state: absent
    name: my_http_monitor
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Include a username and password in the HTTP monitor
  bigip_monitor_http:
    state: absent
    name: my_http_monitor
    target_username: monitor_user
    target_password: monitor_pass
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

返回值

通用返回值记录在此处，以下是此模块特有的字段

键	描述
description string	监控器的描述。 已返回: changed 示例: "Important_Monitor"
interval integer	运行监视器检查的新间隔。 已返回: changed 示例: 2
ip string	IP/端口定义的新 IP。 已返回: changed 示例: "10.12.13.14"
parent string	监视器的新父模板。 已返回: changed 示例: "http"
reverse boolean	监视器是否在反向模式下运行。 已返回: changed 示例: true
time_until_up integer	在首次成功响应后，将系统标记为“正常”的新时间。 已返回: changed 示例: 2
timeout integer	远程系统必须响应监视器的新超时时间。 已返回: changed 示例: 10
up_interval integer	当资源处于“正常”状态时，系统用于执行健康检查的间隔。 已返回: changed 示例: 0

作者

• Tim Rupp (@caphrim007)

• Wojciech Wypior (@wojtek0806)

集合链接

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