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"`
描述字符串	监控器的描述。
间隔整数	指定此模板的监控器实例运行频率的间隔。此值必须小于 `timeout` 值。创建新监控器时，如果未提供此参数，则使用默认值 `5`。
ip 字符串	IP/端口定义中的 IP 地址部分。如果创建新监控器时未提供此参数，则默认值将为 `*`。
manual_resume 布尔值	指定系统是否在下次成功的监控检查时自动将资源状态更改为已启用。如果为 `true`，则必须手动重新启用资源，系统才能将其用于负载平衡连接。创建新监控器时，如果未指定此参数，则默认值为 `false`。当为 `true` 时，指定在监控检查失败后必须手动重新启用资源。当为 `false` 时，指定系统在下次成功的监控检查时自动将资源状态更改为已启用。选项 `false` `true`
名称字符串 / 必需	指定监控器的名称。
父级字符串	此监控器模板的父模板。设置此值后，将无法更改。默认情况下，此值是 `Common` 分区上的 `dns` 父级。默认值: `"/Common/dns"`
分区字符串	要在其上管理资源的设备分区。默认值: `"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 Networks 设备的更多信息，请参见 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"`
描述字符串	监控器的描述。已返回: changed 示例： `"重要监视器"`
间隔整数	运行监视器检查的新间隔。已返回: changed 示例： `2`
ip 字符串	IP/端口定义的新 IP。已返回: changed 示例： `"10.12.13.14"`
manual_resume 字符串	系统是否在下一次成功监视器检查时自动将资源状态更改为启用。已返回: changed 示例： `"query-type"`
父级字符串	监视器的新父模板。已返回: 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)

参数	注释
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"`
描述字符串	监控器的描述。
间隔整数	指定此模板的监控器实例运行频率的间隔。此值必须小于 `timeout` 值。创建新监控器时，如果未提供此参数，则使用默认值 `5`。
ip 字符串	IP/端口定义中的 IP 地址部分。如果创建新监控器时未提供此参数，则默认值将为 `*`。
manual_resume 布尔值	指定系统是否在下次成功的监控检查时自动将资源状态更改为已启用。如果为 `true`，则必须手动重新启用资源，系统才能将其用于负载平衡连接。创建新监控器时，如果未指定此参数，则默认值为 `false`。当为 `true` 时，指定在监控检查失败后必须手动重新启用资源。当为 `false` 时，指定系统在下次成功的监控检查时自动将资源状态更改为已启用。选项 `false` `true`
名称字符串 / 必需	指定监控器的名称。
父级字符串	此监控器模板的父模板。设置此值后，将无法更改。默认情况下，此值是 `Common` 分区上的 `dns` 父级。默认值: `"/Common/dns"`
分区字符串	要在其上管理资源的设备分区。默认值: `"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`。