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

注意

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

f5networks.f5_modules 1.0.0 中的新增功能

概要

• 通过 iControl REST API 管理 F5 BIG-IP LTM TCP 监控器。

参数

参数	注释
描述 字符串	监控器的描述。
间隔 整数	指定此模板的监控器实例运行频率的间隔。如果在创建新监控器时未提供此参数，则默认值为 5。此值**必须**小于 timeout 值。
ip 别名：alias_address 字符串	IP/端口定义中的 IP 地址部分。如果在创建新监控器时未提供此参数，则默认值为“*”。 如果此值为 IP 地址，并且 type 为 tcp（默认），则必须指定 port 号。 在 BIG IP 管理 UI 中，此字段为**别名地址**。
名称 字符串 / 必填	监控器名称。
父级 字符串	此监控器模板的父模板。设置此值后，无法更改。默认情况下，此值为 Common 分区上的 tcp 父级。 默认值： "/Common/tcp"
分区 字符串	设备分区以管理资源。 默认值： "Common"
端口 别名：alias_service_port 字符串	IP/端口定义中的端口地址部分。如果在创建新监控器时未提供此参数，则默认值为“*”。如果指定 IP 地址，则必须指定 1 到 65535 之间的值。 TCP Echo 类型不支持此参数。 在 BIG IP 管理 UI 中，此字段为**别名服务端口**。
提供程序 字典 在 f5networks.f5_modules 1.0.0 中添加	包含连接详细信息的字典对象。
auth_provider 字符串	配置身份验证提供程序以从远程设备获取身份验证令牌。 此选项主要用于处理 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 来省略此选项。
server_port 整数	BIG-IP 服务器端口。 您可以通过设置环境变量 F5_SERVER_PORT 来省略此选项。 默认值： 443
超时 整数	指定与网络设备通信的超时时间（以秒为单位），用于连接或发送命令。如果在操作完成之前超过超时时间，则模块将出错。
传输 字符串	配置连接到远程设备时使用的传输连接。 选项 "rest" ← (默认)
用户 字符串 / 必填	连接到 BIG-IP 或 BIG-IQ 的用户名。此用户必须在设备上具有管理权限。 您可以通过设置环境变量 F5_USER 来省略此选项。
validate_certs 布尔值	如果 no，则不会验证 SSL 证书。仅在您个人控制的使用自签名证书的站点上使用此选项。 您可以通过设置环境变量 F5_VALIDATE_CERTS 来省略此选项。 选项 false true ← (默认)
接收 字符串	监控器调用的接收字符串。
receive_disable 字符串	监视器调用的接收禁用字符串。此设置的工作方式类似于 receive，不同之处在于，当其响应与 receive_disable 字符串匹配但不与 receive 匹配时，系统会将节点或池成员标记为禁用。要使用此设置，您必须同时指定 receive_disable 和 receive。
发送 字符串	监视器调用的发送字符串。
状态 字符串	当为 present 时，确保监视器存在。 当为 absent 时，确保监视器被移除。 选项 "present" ← (默认) "absent"
time_until_up 整数	指定在首次成功响应后，将节点标记为“up”状态之前的时间（以秒为单位）。值为 0 会导致节点在收到来自节点的有效响应后立即被标记为“up”。如果在创建新监视器时未提供此参数，则默认值为 0。
超时 整数	节点或服务必须响应监视器请求的秒数。如果目标在设置的时间段内响应，则认为其处于“up”状态。如果目标在设置的时间段内未响应，则认为其处于“down”状态。您可以将此数字更改为您想要的任何数字，但是，它应该是间隔秒数的 3 倍加 1 秒。如果在创建新监视器时未提供此参数，则默认值为 16。

注释

注意

• 需要 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 TCP Monitor
  bigip_monitor_tcp:
    state: present
    name: my_tcp_monitor
    send: tcp string to send
    receive: tcp string to receive
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Remove TCP Monitor
  bigip_monitor_tcp:
    state: absent
    name: my_tcp_monitor
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

返回值

通用返回值记录在 这里，以下是此模块独有的字段

键	描述
描述 字符串	监控器的描述。 返回： changed 示例： "重要监视器"
间隔 整数	运行监视器检查的新间隔。 返回： changed 示例： 2
ip 字符串	IP/端口定义的新 IP。 返回： changed 示例： "10.12.13.14"
父级 字符串	监视器的新父模板。 返回： changed 示例： "tcp"
端口 字符串	IP/端口定义的新端口。 返回： changed 示例： "[email protected]"
接收 字符串	此监视器的新接收字符串。 返回： changed 示例： "要接收的 tcp 字符串"
receive_disable 字符串	此监视器的新接收禁用字符串。 返回： changed 示例： "要接收的 tcp 字符串"
发送 字符串	此监视器的新发送字符串。 返回： changed 示例： "要发送的 tcp 字符串"
time_until_up 整数	首次成功响应后将系统标记为“up”状态的新时间。 返回： changed 示例： 2
超时 整数	远程系统必须响应监视器的新超时时间。 返回： changed 示例： 10

作者

• Tim Rupp (@caphrim007)

• Wojciech Wypior (@wojtek0806)

集合链接

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