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

注意

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

f5networks.f5_modules 1.0.0 中的新功能

概要

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

参数

参数	注释
description 字符串	监控器的描述。
interval 整数	指定此模板的监控器实例运行频率的间隔。如果创建新监控器时未提供此参数，则默认值为 5。此值**必须**小于 timeout 值。
ip 字符串	IP/端口定义中的 IP 地址部分。如果创建新监控器时未提供此参数，则默认值为“*”。
name 字符串 / 必需	监控器名称。
parent 字符串	此监控器模板的父模板。一旦设置此值，它就无法更改。默认情况下，此值是 Common 分区上的 udp 父级。 默认值: "/Common/udp"
partition 字符串	设备分区，用于管理资源。 默认值: "Common"
port 字符串	IP/端口定义中的端口地址部分。如果创建新监控器时未提供此参数，则默认值为“*”。如果指定 IP 地址，则必须指定介于 1 和 65535 之间的值。
provider 字典 在 f5networks.f5_modules 1.0.0 中添加	包含连接详细信息的 dict 对象。
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 字符串	用于监控调用的发送字符串。创建新监控时，如果未提供此值，则使用默认的 default send string。
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 UDP Monitor
  bigip_monitor_udp:
    state: present
    ip: 10.10.10.10
    name: my_udp_monitor
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Remove UDP Monitor
  bigip_monitor_udp:
    state: absent
    name: my_udp_monitor
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

返回值

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

键	描述
description 字符串	监控器的描述。 返回: changed 示例: "Important Monitor"
interval 整数	运行监控检查的新间隔。 返回: changed 示例: 2
ip 字符串	IP/端口定义的新 IP。 返回: changed 示例: "10.12.13.14"
parent 字符串	监控的新父模板。 返回: changed 示例: "http"
time_until_up 整数	首次成功响应后将系统标记为启动状态的新时间。 返回: changed 示例: 2
timeout 整数	远程系统必须响应监控的新超时时间。 返回: changed 示例: 10

作者

• Tim Rupp (@caphrim007)

• Wojciech Wypior (@wojtek0806)

集合链接

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