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 监控。

参数 

参数	注释
description 字符串	监控的描述。
interval 整数	指定此模板的监控实例运行频率的间隔。如果在创建新的监控时未提供此参数，则默认值为 5。此值必须小于`timeout`值。
ip 别名：alias_address 字符串	IP/端口定义的 IP 地址部分。如果在创建新的监控时未提供此参数，则默认值为 ''。如果此值为 IP 地址，并且`type`为`tcp`（默认值），则必须指定`port`号。在 BIG-IP 管理 UI 中，此字段为别名地址*。
name 字符串 / 必需	监控名称。
parent 字符串	此监控模板的父模板。设置此值后，将无法更改。默认情况下，此值为 `Common` 分区上的 `tcp` 父级。默认值： `"/Common/tcp"`
partition 字符串	用于管理资源的设备分区。默认值： `"Common"`
port 别名：alias_service_port 字符串	IP/端口定义的端口地址部分。如果在创建新的监控时未提供此参数，则默认值为 ''。如果指定 IP 地址，则必须指定 1 到 65535 之间的值。此参数不支持 TCP Echo 类型。在 BIG-IP 管理 UI 中，此字段为别名服务端口*。
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` ← (默认值)
receive 字符串	监控调用的接收字符串。
receive_disable 字符串	监控调用的接收禁用字符串。此设置的工作方式类似于 `receive`，不同之处在于，当节点的响应与 `receive_disable` 字符串匹配但不与 `receive` 匹配时，系统会将该节点或池成员标记为禁用。要使用此设置，必须同时指定 `receive_disable` 和 `receive`。
send 字符串	监控调用的发送字符串。
state 字符串	当为 `present` 时，确保监控存在。当为 `absent` 时，确保监控已删除。选项 `"present"` ← (默认值) `"absent"`
time_until_up 整数	指定第一次成功响应后节点被标记为启动之前的时间（秒）。值为 `0` 表示在从节点接收到有效响应后立即将节点标记为启动。如果在创建新的监控时未提供此参数，则默认值为 `0`。
timeout 整数	节点或服务必须在多长时间内响应监控请求（以秒为单位）。如果目标在设定的时间段内响应，则认为其处于运行状态；如果目标未在设定的时间段内响应，则认为其处于停止状态。您可以将此数值更改为您想要的任何数字，但是，它应为间隔秒数的 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

返回值 

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

键	描述
description 字符串	监控的描述。返回：changed 示例： `"Important Monitor"`
interval 整数	运行监控检查的新间隔。返回：changed 示例： `2`
IP 字符串	IP/端口定义的新 IP。返回：changed 示例： `"10.12.13.14"`
parent 字符串	监控器的新父模板。返回：changed 示例： `"tcp"`
端口字符串	IP/端口定义的新端口。返回：changed 示例： `"admin@root.local"`
receive 字符串	此监控器的新接收字符串。返回：changed 示例： `"tcp string to receive"`
receive_disable 字符串	此监控器的新禁用接收字符串。返回：changed 示例： `"tcp string to receive"`
send 字符串	此监控器的新发送字符串。返回：changed 示例： `"tcp string to send"`
time_until_up 整数	第一次成功响应后将系统标记为已启动的时间。返回：changed 示例： `2`
timeout 整数	远程系统必须响应监控器的超时时间。返回：changed 示例： `10`

作者

Tim Rupp (@caphrim007)
Wojciech Wypior (@wojtek0806)