f5networks.f5_modules.bigip_monitor_tcp_echo 模块 – 管理 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。

要在剧本中使用它，请指定： f5networks.f5_modules.bigip_monitor_tcp_echo。

f5networks.f5_modules 1.0.0 中的新功能

概要 

管理 F5 BIG-IP LTM TCP 回显监视器。

参数 

参数	注释
description 字符串	监视器的描述。
interval 整数	指定此模板的监视器实例运行频率的间隔。如果在创建新监视器时未提供此参数，则默认值为 5。此值必须小于 `timeout` 值。
ip 字符串	IP/端口定义中的 IP 地址部分。如果在创建新监视器时未提供此参数，则默认值为“*”。
name 字符串 / 必需	监视器名称。
parent 字符串	此监视器模板的父模板。一旦设置了此值，就无法更改。默认情况下，此值是 `Common` 分区上的 `tcp_echo` 父项。默认值: `"/Common/tcp_echo"`
partition 字符串	用于管理资源的设备分区。默认值: `"Common"`
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"`
time_until_up 整数	指定在首次成功响应后，节点被标记为“up”之前的等待时间（秒）。值为 `0` 将导致节点在收到来自节点的有效响应后立即被标记为“up”。如果在创建新监视器时未提供此参数，则默认值为 `0`。
timeout 整数	节点或服务必须响应监视器请求的秒数。如果目标在设定的时间段内响应，则认为其处于“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 Echo Monitor
  bigip_monitor_tcp_echo:
    state: present
    ip: 10.10.10.10
    name: my_tcp_monitor
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Remove TCP Echo Monitor
  bigip_monitor_tcp_echo:
    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"`
time_until_up 整数	在首次成功响应后，将系统标记为“up”的新时间。返回: changed 示例: `2`
timeout 整数	远程系统必须响应监视器的新的超时时间。返回: changed 示例: `10`

作者

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