f5networks.f5_modules.bigip_monitor_dns 模块 – 管理 BIG-IP 上的 DNS 监控器

注意

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

f5networks.f5_modules 1.0.0 中的新增功能

概要

• 管理 BIG-IP 上的 DNS 健康监控器。

参数

参数	注释
accept_rcode 字符串	指定响应中需要 RCODE 才能表示正常状态。 创建新监控器时，如果未指定此参数，则默认值为 no-error。 当为 no-error 时，指定如果收到的 DNS 消息没有错误，则节点的状态标记为正常。 当为 anything 时，指定无论收到的 DNS 消息中的 RCODE 如何，节点的状态都标记为正常。 如果此参数设置为 anything，它将忽略 receive 字符串，如果正在更新监控器，则将其置为空。 选项 "no-error" "anything"
adaptive 布尔值	指定是否为此监控器启用自适应响应时间监控。 当为 true 时，监控器根据服务监控探针允许与平均延迟偏离的程度来确定服务状态。此外，还会强制执行 allowed_divergence、adaptive_limit 和 sampling_timespan 的值。 当为 disabled 时，监控器根据 interval、up_interval、time_until_up 和 timeout 监控器设置来确定服务状态。 选项 false true
adaptive_limit 整数	指定监控探针允许超过的最大毫秒绝对值，无论 allowed_divergence 设置如何，都视为探针成功。 此值无论 allowed_divergence 设置的值如何都适用。 虽然可以在 adaptive 为 false 时配置此值，但在 adaptive 为 true 之前，它不会在系统上生效。
allowed_divergence_type 字符串	当指定新监控器时，如果 adaptive 为 true，则默认值为 relative。 当为 absolute 时，表示监控探针的延迟可以超过正在探测的服务的监控探针平均延迟的毫秒数。在典型情况下，如果监控器连续检测到三个探针未达到您设置的延迟值，则会将池成员或节点标记为关闭。 当为 relative 时，表示监控探针的延迟可以超过正在探测的服务的监控探针平均延迟的偏差百分比。 选项 "relative" "absolute"
allowed_divergence_value 整数	当指定新监控器时，如果 adaptive 为 true 且 type 为 relative，则默认值为 25%。
answer_section_contains 字符串	指定监控器发送的 DNS 查询类型。 创建新监控器时，如果未指定此值，则默认值为 query-type。 当为 query-type 时，指定响应应至少包含一个资源记录类型与查询类型匹配的答案。 当为 any-type 时，指定 DNS 消息应至少包含一个答案。 当为 anything 时，指定空答案足以将节点状态标记为正常。 选项 "any-type" "anything" "query-type"
description 字符串	监控器的描述。
interval 整数	指定此模板的监控实例运行频率的间隔。 此值必须小于 timeout 值。 创建新监控器时，如果未提供此参数，则使用默认值 5。
ip 字符串	IP/端口定义的 IP 地址部分。 如果在创建新监控器时未提供此参数，则默认值将为 *。
manual_resume 布尔值	指定系统是否在下一个成功的监控检查时自动将资源的状态更改为已启用。 如果为 true，则必须手动重新启用资源，系统才能将其用于负载均衡连接。 创建新监控器时，如果未指定此参数，则默认值为 false。 当为 true 时，指定您必须在监控检查失败后手动重新启用资源。 当为 false 时，指定系统在下一个成功的监控检查时自动将资源的状态更改为已启用。 选项 false true
name 字符串 / 必需	指定监控器的名称。
parent 字符串	此监控器模板的父模板。设置此值后，无法更改。默认情况下，此值为 Common 分区上的 dns 父项。 默认值： "/Common/dns"
partition 字符串	用于管理资源的设备分区。 默认值： "Common"
端口 字符串	IP/端口定义中的端口地址部分。 如果在创建新监控器时未提供此参数，则默认值将为 *。 请注意，如果指定 IP 地址，则必须使用 1 到 65535 之间的值。
提供程序 字典 在 f5networks.f5_modules 1.0.0 中添加	一个包含连接详细信息的字典对象。
auth_provider 字符串	配置用于从远程设备获取身份验证令牌的身份验证提供程序。 此选项主要用于与 BIG-IQ 设备一起工作时。
no_f5_teem 布尔值	如果为 yes，则不会将 TEEM 遥测数据发送到 F5。 您可以通过设置环境变量 F5_TELEMETRY_OFF 来省略此选项。 以前使用的变量 F5_TEEM 已弃用，因为它的名称令人困惑。 选项 false ← (默认) true
密码 别名：pass, pwd 字符串 / 必需	用于连接到 BIG-IP 或 BIG-IQ 的用户帐户的密码。 您可以通过设置环境变量 F5_PASSWORD 来省略此选项。
服务器 字符串 / 必需	BIG-IP 主机或 BIG-IQ 主机。 您可以通过设置环境变量 F5_SERVER 来省略此选项。
server_port 整数	BIG-IP 服务器端口。 您可以通过设置环境变量 F5_SERVER_PORT 来省略此选项。 默认值： 443
超时 整数	指定与网络设备通信（用于连接或发送命令）的超时时间（以秒为单位）。如果在操作完成之前超时，则模块将出错。
传输 字符串	配置连接到远程设备时要使用的传输连接。 选项 "rest" ← (默认)
用户 字符串 / 必需	用于连接到 BIG-IP 或 BIG-IQ 的用户名。此用户必须在设备上具有管理权限。 您可以通过设置环境变量 F5_USER 来省略此选项。
validate_certs 布尔值	如果为 no，则不验证 SSL 证书。仅在个人控制的使用自签名证书的站点上使用此选项。 您可以通过设置环境变量 F5_VALIDATE_CERTS 来省略此选项。 选项 false true ← (默认)
query_name 字符串	指定监视器在 DNS 查询中使用的查询名称。
query_type 字符串	指定监控器发送的 DNS 查询类型。 创建新监视器时，如果未指定此参数，则默认值为 a。 当为 a 时，指定监视器将发送类型为 A 的 DNS 查询。 当为 aaaa 时，指定监视器将发送类型为 AAAA 的 DNS 查询。 选项 "a" "aaaa"
接收 字符串	指定监视器从 DNS 响应的资源记录部分使用的 IP 地址。 IP 地址应以点分十进制表示法或 IPv6 表示法指定。
反向 布尔值	指定监视器是否以反向模式运行。 当监视器处于反向模式时，成功的接收字符串匹配将标记受监视的对象为关闭状态而不是开启状态。仅当配置了 receive 选项时，才能使用此模式。 此参数与 time_until_up 参数不兼容。如果指定了 time_until_up，则它必须为 0。或者，如果它已经存在，则它必须为 0。 选项 false true
sampling_timespan 整数	指定系统用于计算监视器探测的平均延迟和标准偏差的探测历史窗口的长度（以秒为单位）。 虽然可以在 adaptive 为 false 时配置此值，但在 adaptive 为 true 之前，它不会在系统上生效。
状态 字符串	当为 present 时，确保监视器存在。 当为 absent 时，确保删除监视器。 选项 "present" ← (默认) "absent"
time_until_up 整数	指定在第一次成功响应后，节点被标记为开启状态之前的时间（以秒为单位）。 值为 0 将导致节点在从节点收到有效响应后立即被标记为开启状态。 如果创建新监视器时未提供此参数，则默认值为 0。
超时 整数	节点或服务必须响应监视器请求的秒数。 如果目标在设置的时间段内响应，则认为它已开启。 如果目标未在设置的时间段内响应，则认为它已关闭。 您可以将其更改为任何数字，但是，它应该是间隔秒数的 3 倍加 1 秒。 如果创建新监视器时未提供此参数，则默认值为 16。
透明 布尔值	指定监视器是否以透明模式运行。 透明模式下的监视器可以通过防火墙监视池成员。 创建新监视器时，如果未提供此参数，则默认值为 false。 选项 false true
up_interval 整数	指定当资源处于开启状态时，系统用于执行运行状况检查的间隔。 当为 0 时，指定系统使用 interval 中指定的间隔来检查资源的运行状况。 当为任何其他数字时，您可以指定不同的间隔来用于检查处于开启状态的资源的运行状况。 创建新监视器时，如果未提供此参数，则使用默认值 0。

注意

注意

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

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

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

示例

- name: Create a DNS monitor
  bigip_monitor_dns:
    name: DNS-UDP-V6
    interval: 2
    query_name: localhost
    query_type: aaaa
    up_interval: 5
    adaptive: false
    state: present
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

返回值

通用返回值记录在这里，以下是此模块特有的字段

键	描述
accept_rcode 字符串	响应中需要 RCODE 才能获得开启状态。 返回： changed 示例： "no-error"
adaptive 布尔值	是否启用了自适应。 返回： changed 示例： true
adaptive_limit 整数	监视器探测可能不超过的绝对毫秒数。 返回： changed 示例： 200
allowed_divergence_type 字符串	用于自适应响应时间监视的发散类型。 返回： changed 示例： "absolute"
allowed_divergence_value 整数	用于自适应响应时间监视的发散类型的值。 可以是 percent 或 ms，具体取决于 relative 或 absolute。 返回： changed 示例： 25
answer_section_contains 字符串	监视器发送的 DNS 查询的类型。 返回： changed 示例： "query-type"
description 字符串	监控器的描述。 返回： changed 示例： "Important Monitor"
interval 整数	运行监视器检查的新间隔。 返回： changed 示例： 2
ip 字符串	IP/端口定义的新 IP。 返回： changed 示例： "10.12.13.14"
manual_resume 字符串	系统是否在下一次成功的监视器检查时自动将资源的状态更改为已启用。 返回： changed 示例： "query-type"
parent 字符串	监视器的新父模板。 返回： changed 示例： "http"
端口 字符串	监视器要检查的别名端口或服务，代表与监视器关联的池或池成员。 返回： changed 示例： "80"
query_name 字符串	监视器在 DNS 查询中使用的查询名称。 返回： changed 示例： "foo"
query_type 字符串	监视器发送的 DNS 查询类型。可以是 a 或 aaaa。 返回： changed 示例: "aaaa"
接收 字符串	监视器从 DNS 响应的资源记录部分使用的 IP 地址。 返回： changed 示例: "2.3.2.4"
反向 布尔值	监视器是否以反向模式运行。 返回： changed 示例： true
sampling_timespan 整数	监视器探测可能不超过的绝对毫秒数。 返回： changed 示例： 200
time_until_up 整数	在首次成功响应后将系统标记为“正常”的新时间。 返回： changed 示例： 2
超时 整数	远程系统必须响应监视器的新超时时间。 返回： changed 示例: 10
透明 布尔值	监视器是否以透明模式运行。 返回： changed 示例: false
up_interval 整数	当资源处于“正常”状态时，系统用于执行运行状况检查的间隔。 返回： changed 示例: 0

作者

• Tim Rupp (@caphrim007)

• Wojciech Wypior (@wojtek0806)

集合链接

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