f5networks.f5_modules.bigip_monitor_snmp_dca 模块 – 管理 BIG-IP SNMP 数据收集代理 (DCA) 监控器

注意

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

f5networks.f5_modules 1.0.0 中的新增功能

概要

• BIG-IP 具有一个 SNMP 数据收集代理 (DCA)，它可以查询各种类型的远程 SNMP 代理，包括 UC Davis 代理 (UCD) 和 Windows 2000 Server 代理 (WIN2000)。

参数

参数	注释
agent_type 字符串	指定在被监控服务器上运行的 SNMP 代理。创建新的监控器时，默认为 UCD (UC-Davis)。 选项 "UCD" "WIN2000" "GENERIC"
community 字符串	指定系统必须用于通过 SNMP 与主机服务器进行身份验证的社区名称。创建新的监控器时，默认值为 public。此值区分大小写。
cpu_coefficient 字符串	指定系统用于在动态比率负载平衡算法中计算 CPU 阈值权重的系数。创建新的监控器时，默认为 1.5。
cpu_threshold 整数	指定目标服务器上可接受的最大 CPU 使用率。创建新的监控器时，默认为 80%。
description 字符串	指定标识监控器的描述性文本。
disk_coefficient 字符串	指定系统用于在动态比率负载平衡算法中计算磁盘阈值权重的系数。创建新的监控器时，默认为 2.0。
disk_threshold 整数	指定目标服务器上可接受的最大磁盘使用率。创建新的监控器时，默认为 90%。
interval 整数	指定系统在资源关闭或资源状态未知时发出监控检查的频率（以秒为单位）。创建新的监控器时，默认为 10。
memory_coefficient 字符串	指定系统用于在动态比率负载平衡算法中计算内存阈值权重的系数。创建新的监控器时，默认为 1.0。
memory_threshold 整数	指定目标服务器上可接受的最大内存使用率。创建新的监控器时，默认为 70%。
name 字符串 / 必需	监控器名称。
parent 字符串	此监控器模板的父模板。设置此值后，无法更改。默认情况下，此值为 Common 分区上的 snmp_dca 父级。 默认值： "/Common/snmp_dca"
partition 字符串	用于管理资源的设备分区。 默认值： "Common"
provider 字典 f5networks.f5_modules 1.0.0 中新增	包含连接详细信息的字典对象。
auth_provider 字符串	配置 auth 提供程序，以从远程设备获取身份验证令牌。 此选项在使用 BIG-IQ 设备时才会真正用到。
no_f5_teem 布尔值	如果为 yes，则不会将 TEEM 遥测数据发送到 F5。 您可以通过设置环境变量 F5_TELEMETRY_OFF 来省略此选项。 先前使用的变量 F5_TEEM 已弃用，因为其名称令人困惑。 选项 false ← (默认) true
password 别名：pass、pwd 字符串 / 必需	用于连接到 BIG-IP 或 BIG-IQ 的用户帐户的密码。 可以通过设置环境变量F5_PASSWORD来省略此选项。
服务器 字符串 / 必需	BIG-IP 主机或 BIG-IQ 主机。 可以通过设置环境变量F5_SERVER来省略此选项。
服务器端口 整数	BIG-IP 服务器端口。 可以通过设置环境变量F5_SERVER_PORT来省略此选项。 默认值：443
超时 整数	指定与网络设备通信的超时时间（秒），用于连接或发送命令。如果在操作完成之前超时，模块将报错。
传输 字符串	配置连接到远程设备时使用的传输连接。 选项 "rest" ← (默认)
用户 字符串 / 必需	连接到 BIG-IP 或 BIG-IQ 的用户名。此用户必须具有设备上的管理员权限。 可以通过设置环境变量F5_USER来省略此选项。
验证证书 布尔值	如果为no，则不验证 SSL 证书。仅在使用自签名证书的个人控制站点上使用此选项。 可以通过设置环境变量F5_VALIDATE_CERTS来省略此选项。 选项 false true ← (默认)
状态 字符串	当为present时，确保监视器存在。 当为absent时，确保监视器被移除。 选项 "present" ← (默认) "absent"
就绪时间 整数	指定资源第一次正确响应监视器后等待的秒数，然后将资源设置为“正常”。在此期间，资源的所有响应都必须正确。当间隔时间到期时，资源将标记为“正常”。值为 0 表示在收到第一个正确响应后立即将资源标记为正常。创建新的监视器时，默认为0。
超时 整数	指定目标必须在多长时间内响应监视器请求。创建新的监视器时，默认为30秒。如果目标在设定的时间段内响应，则认为其为“正常”。如果目标在设定的时间段内未响应，则认为其为“异常”。当此值设置为 0（零）时，系统将使用父监视器的间隔。请注意，timeout和time_until_up共同控制何时将资源设置为正常。
版本 字符串	指定主机服务器使用的 SNMP 版本。创建新的监视器时，默认为v1。当为v1时，指定主机服务器使用 SNMP 版本 1。当为v2c时，指定主机服务器使用 SNMP 版本 2c。 选项 "v1" "v2c"

备注

注意

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

• 此模块不支持variables选项，因为该选项在 REST API 中已损坏，并且在tmsh中无法正常工作；例如，无法删除用户定义的参数。因此，无法自动配置它。

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

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

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

示例

- name: Create SNMP DCS monitor
  bigip_monitor_snmp_dca:
    name: my_monitor
    state: present
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

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

返回值

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

键	描述
agent_type 字符串	监视器将使用的新的代理类型。 返回：已更改 示例："UCD"
community 字符串	监视器的新的社区。 返回：已更改 示例："foobar"
cpu_coefficient 浮点数	新的 CPU 系数。 返回：已更改 示例：2.4
cpu_threshold 整数	新的 CPU 阈值。 返回：已更改 示例：85
description 字符串	监视器的描述。 返回：已更改 示例："Important Monitor"
disk_coefficient 浮点数	新的磁盘系数。 返回：已更改 示例：10.2
disk_threshold 整数	新的磁盘阈值。 返回：已更改 示例：34
interval 整数	运行监视器检查的新间隔。 返回：已更改 示例：2
memory_coefficient 浮点数	新的内存系数。 返回：已更改 示例：6.4
memory_threshold 整数	新的内存阈值。 返回：已更改 示例：50
parent 字符串	监视器的新的父模板。 返回：已更改 示例："snmp_dca"
就绪时间 整数	第一次成功响应后将系统标记为正常的新时间。 返回：已更改 示例：2
超时 整数	远程系统必须在多长时间内响应监视器的新超时。 返回：已更改 示例：10
版本 字符串	监视器将使用的新 SNMP 版本。 返回：已更改 示例："v2c"

作者

• Tim Rupp (@caphrim007)

• Wojciech Wypior (@wojtek0806)

集合链接

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