community.network.avi_healthmonitor 模块 – 用于设置 HealthMonitor Avi RESTful 对象的模块

注意

此模块是 community.network 集合 (版本 5.1.0) 的一部分。

如果您正在使用 ansible 软件包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.network。您需要其他要求才能使用此模块，请参阅 要求 了解更多详情。

要在 playbook 中使用它，请指定：community.network.avi_healthmonitor。

注意

community.network 集合已弃用，并将从 Ansible 12 中删除。请参阅 讨论主题 以了解更多信息。

已弃用

在以下版本中移除：

6.0.0 版本

原因：

此集合及其中的所有内容均未维护且已弃用。

替代方案：

未知。

概要

别名：network.avi.avi_healthmonitor

要求

执行此模块的主机需要以下要求。

  • avisdk

参数

参数

注释

api_context

字典

包含当前会话 ID 和 CSRF 令牌的 Avi API 上下文。

这允许用户执行单点登录并重用会话。

api_version

字符串

用于 Avi API 和对象的 Avi API 版本。

默认值： "16.4.4"

avi_api_patch_op

字符串

当将 avi_api_update_method 设置为 patch 时使用的修补操作。

选项

  • "add"

  • "replace"

  • "delete"

avi_api_update_method

字符串

对象更新的默认方法是 HTTP PUT。

设置为 patch 将覆盖该行为以使用 HTTP PATCH。

选项

  • "put" ← (默认)

  • "patch"

avi_credentials

字典

Avi 凭据字典，可用于代替枚举 Avi 控制器登录详细信息。

api_version

字符串

Avi 控制器版本

默认值： "16.4.4"

controller

字符串

Avi 控制器 IP 或 SQDN

csrftoken

字符串

Avi 控制器 API csrftoken，用于与 session id 一起重用现有会话

默认值： ""

password

字符串

Avi 控制器密码

port

字符串

Avi 控制器端口

session_id

字符串

Avi 控制器 API session id，用于与 csrftoken 一起重用现有会话

默认值： ""

tenant

字符串

Avi 控制器租户

默认值： "admin"

tenant_uuid

字符串

Avi 控制器租户 UUID

默认值： ""

timeout

字符串

Avi 控制器请求超时

默认值： 300

token

字符串

Avi 控制器 API 令牌

默认值： ""

username

字符串

Avi 控制器用户名

avi_disable_session_cache_as_fact

布尔值

它禁用将 avi 会话信息缓存在事实中。

选项

  • false ← (默认)

  • true

controller

字符串

控制器的 IP 地址或主机名。默认值为环境变量 AVI_CONTROLLER。

description

字符串

用户为对象定义的描述。

dns_monitor

字符串

healthmonitor 的 Healthmonitordns 设置。

external_monitor

字符串

healthmonitor 的 Healthmonitorexternal 设置。

failed_checks

字符串

服务器被标记为停机之前的连续失败健康检查次数。

允许的值为 1-50。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 2。

http_monitor

字符串

healthmonitor 的 Healthmonitorhttp 设置。

https_monitor

字符串

healthmonitor 的 Healthmonitorhttp 设置。

is_federated

布尔值

此字段描述对象的复制范围。

如果该字段设置为 false，则该对象在控制器集群及其关联的服务引擎中可见。

如果该字段设置为 true，则该对象将在联邦中复制。

在 17.1.3 版本中引入的字段。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 False。

选项

  • false

  • true

monitor_port

字符串

使用此端口代替池中为服务器定义的端口。

如果监视器对此端口成功，则负载均衡流量仍将发送到池中定义的服务器端口。

允许的值为 1-65535。

特殊值为 0 - “使用服务器端口”。

name

字符串 / 必需

此健康监视器的用户友好名称。

password

字符串

Avi 控制器中 Avi 用户的密码。默认值为环境变量 AVI_PASSWORD。

radius_monitor

字符串

用于 radius 的健康监视器。

在 18.2.3 版本中引入的字段。

receive_timeout

字符串

在接收超时窗口内应收到来自服务器的有效响应。

此超时必须小于发送间隔。

如果服务器状态定期反复波动，请考虑增加此值。

允许的值为 1-2400。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 4。

send_interval

字符串

以秒为单位的频率，将监视器发送到服务器。

允许的值为 1-3600。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 10。

sip_monitor

字符串

用于 sip 的健康监视器。

在 17.2.8、18.1.3 和 18.2.1 版本中引入的字段。

state

字符串

应应用于实体的状态。

选项

  • "absent"

  • "present" ← (默认)

successful_checks

字符串

服务器标记为正常运行前连续成功的健康检查次数。

允许的值为 1-50。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 2。

tcp_monitor

字符串

healthmonitor 的 Healthmonitortcp 设置。

tenant

字符串

用于所有 Avi API 调用和对象上下文的租户名称。

默认值： "admin"

tenant_ref

字符串

它是对 tenant 类型对象的引用。

tenant_uuid

字符串

用于所有 Avi API 调用和对象上下文的租户 UUID。

默认值： ""

type

字符串 / 必需

健康监控器的类型。

枚举选项 - HEALTH_MONITOR_PING、HEALTH_MONITOR_TCP、HEALTH_MONITOR_HTTP、HEALTH_MONITOR_HTTPS、HEALTH_MONITOR_EXTERNAL、HEALTH_MONITOR_UDP、

HEALTH_MONITOR_DNS、HEALTH_MONITOR_GSLB、HEALTH_MONITOR_SIP、HEALTH_MONITOR_RADIUS。

udp_monitor

字符串

healthmonitor 的 Healthmonitorudp 设置。

url

字符串

对象的 Avi 控制器 URL。

username

字符串

用于访问 Avi 控制器的用户名。默认值为环境变量 AVI_USERNAME。

uuid

字符串

健康监控器的 UUID。

备注

注意

示例

- name: Create a HTTPS health monitor
  community.network.avi_healthmonitor:
    controller: 10.10.27.90
    username: admin
    password: AviNetworks123!
    https_monitor:
      http_request: HEAD / HTTP/1.0
      http_response_code:
        - HTTP_2XX
        - HTTP_3XX
    receive_timeout: 4
    failed_checks: 3
    send_interval: 10
    successful_checks: 3
    type: HEALTH_MONITOR_HTTPS
    name: MyWebsite-HTTPS

返回值

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

键

描述

obj

字典

HealthMonitor (api/healthmonitor) 对象

返回：success, changed

状态

  • 此模块将在 6.0.0 版中移除。 *[已弃用]*

  • 更多信息请参见 已弃用。

作者

  • Gaurav Rastogi (@grastogi23)