f5networks.f5_modules.bigip_gtm_monitor_tcp 模块 – 管理 F5 BIG-IP GTM 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_gtm_monitor_tcp。

f5networks.f5_modules 1.0.0 中的新增功能

概要

• 管理 F5 BIG-IP GTM（现在是 BIG-IP DNS）TCP 监控器。

参数

参数	注释
ignore_down_response 布尔值	指定监控器允许每个间隔多次探测尝试。 当 true 时，指定监控器在监控器超时期间忽略向下响应。一旦监控器超时且系统未收到向上响应，系统会将对象标记为向下。 当 false 时，指定监控器在收到向下响应时立即将对象标记为向下。 创建新监控器时，如果未提供此参数，则默认值为 false。 选项 false true
interval 整数	指定此模板的监控器实例运行频率的间隔。 如果创建新监控器时未提供此参数，则默认值为 30。 此值**必须**小于 timeout 值。
ip 字符串	IP/端口定义中的 IP 地址部分。如果创建新监控器时未提供此参数，则默认值为“*”。 如果此值为 IP 地址，则必须指定 port 号。
name 字符串 / 必需	监控器名称。
parent 字符串	此监控器模板的父模板。一旦设置此值，就无法更改。默认情况下，此值是 Common 分区上的 tcp 父模板。 默认值： "/Common/tcp"
partition 字符串	用于管理资源的设备分区。 默认值： "Common"
port 字符串	IP/端口定义中的端口地址部分。如果创建新监控器时未提供此参数，则默认值为“*”。请注意，如果使用 IP 地址，则必须指定介于 1 和 65535 之间的值。
probe_timeout 整数	指定系统在多少秒后超时对系统的探测请求。 创建新监控器时，如果未提供此参数，则默认值为 5。
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 字符串	监控调用接收的字符串。
reverse 布尔值	指示系统在测试成功时将目标资源标记为“宕机”。例如，如果您的网站主页上的内容是动态且经常变化的，您可能希望设置一个反向ECV服务检查，查找字符串“Error”。 匹配此字符串意味着 Web 服务器已宕机。 要使用此选项，您必须为 send 和 receive 指定值。 选项 false true
send 字符串	监控调用发送的字符串。
state 字符串	当为 present 时，确保监控器存在。 当为 absent 时，确保监控器被移除。 选项 "present" ← (默认) "absent"
timeout 整数	节点或服务必须响应监控请求的秒数。如果目标在设定的时间段内响应，则认为其正常运行。如果目标在设定的时间段内未响应，则认为其已宕机。您可以将此数字更改为任意数字，但是，它应为间隔秒数的 3 倍加 1 秒。 如果在创建新监控器时未提供此参数，则默认值为 120。
transparent 布尔值	指定监控器是否在透明模式下运行。 透明模式下的监控器会将流量通过关联的池成员或节点（通常是路由器或防火墙）定向到别名目标（即，它会探测监控器中指定的 ip-port 组合）。 如果监控器无法成功到达别名目标，则发送监控流量的池成员或节点将被标记为“宕机”。 创建新监控器时，如果未提供此参数，则默认值为 false。 选项 false true

备注

注意

• 有关使用 Ansible 管理 F5 Networks 设备的更多信息，请参阅 https://ansible.org.cn/integrations/networks/f5。

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

• F5 模块仅操作 F5 产品的运行配置。为确保 BIG-IP 的特定配置持久保存到磁盘，请务必至少包含一个使用 f5networks.f5_modules.bigip_config 模块来保存运行配置的任务。请参阅该模块的文档，了解如何正确使用该模块来保存您的运行配置。

示例

- name: Create a GTM TCP monitor
  bigip_gtm_monitor_tcp:
    name: my_monitor
    ip: 1.1.1.1
    port: 80
    send: my send string
    receive: my receive string
    state: present
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

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

- name: Add TCP monitor for all addresses, port 514
  bigip_gtm_monitor_tcp:
    name: my_monitor
    port: 514
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

返回值

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

Key	描述
ignore_down_response 布尔值	是否忽略“宕机”响应。 返回: changed 示例: true
interval 整数	运行监控检查的新间隔时间。 返回: changed 示例: 2
ip 字符串	IP/端口定义的新 IP。 返回: changed 示例: "10.12.13.14"
parent 字符串	监控器的新父模板。 返回: changed 示例: "tcp"
port 字符串	监控器检查资源的新端口。 返回: changed 示例: "8080"
probe_timeout 整数	系统超时监控探测的新超时时间。 返回: changed 示例: 10
receive 字符串	此监控器的新接收字符串。 返回: changed 示例: "tcp string to receive"
reverse 布尔值	监控器是否在反向模式下运行的新值。 返回: changed 示例: false
send 字符串	此监控器的新发送字符串。 返回: changed 示例: "tcp string to send"
timeout 整数	远程系统必须响应监控的超时时间。 返回: changed 示例: 10
transparent 布尔值	监控器是否在透明模式下运行的新值。 返回: changed 示例: false

作者

• Tim Rupp (@caphrim007)

• Wojciech Wypior (@wojtek0806)

集合链接

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