fortinet.fortios.fortios_firewall_ldb_monitor 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置服务器负载均衡健康监控。

注意

此模块是 fortinet.fortios 集合（版本 2.3.8）的一部分。

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

要安装它，请使用：ansible-galaxy collection install fortinet.fortios。您需要满足进一步的要求才能使用此模块，有关详细信息，请参阅 要求。

要在 playbook 中使用它，请指定：fortinet.fortios.fortios_firewall_ldb_monitor。

fortinet.fortios 2.0.0 中的新增功能

概要

  • 此模块能够通过允许用户设置和修改防火墙功能和 ldb_monitor 类别来配置 FortiGate 或 FortiOS (FOS) 设备。示例包括在使用前需要调整为数据源的所有参数和值。使用 FOS v6.0.0 进行了测试

要求

在执行此模块的主机上需要满足以下要求。

  • ansible>=2.15

参数

参数

注释

access_token

字符串

基于令牌的身份验证。从 Fortigate 的 GUI 生成。

enable_log

布尔值

启用/禁用任务日志记录。

选择

  • false ← (默认)

  • true

firewall_ldb_monitor

字典

配置服务器负载均衡健康监控。

dns_match_ip

字符串

从 DNS 服务器返回的预期响应 IP。

dns_protocol

字符串

选择 DNS 健康检查监视器用于检查服务器健康状况的协议 (UDP | TCP)。

选择

  • "udp"

  • "tcp"

dns_request_domain

字符串

要为 DNS 探测解析的完全限定域名。

http_get

字符串

用于发送 GET 请求以检查 HTTP 服务器健康状况的 URL。

http_match

字符串

在响应 HTTP-GET 请求中要匹配的预期值字符串。

http_max_redirects

整数

允许的最大 HTTP 重定向次数 (0 - 5)。

interval

整数

健康检查之间的时间间隔 (5 - 65535 秒)。

name

字符串 / 必需

监视器名称。

port

整数

用于执行健康检查的服务端口。如果为 0，则健康检查监视器会继承为服务器配置的端口 (0 - 65535)。

retry

整数

服务器被视为关闭之前的健康检查尝试次数 (1 - 255)。

src_ip

字符串

ldb-monitor 的源 IP。

timeout

整数

等待接收来自服务器的健康检查响应的时间。达到超时时间表示健康检查失败 (1 - 255 秒)。

type

字符串

选择健康检查监视器用于检查服务器健康状况的监视器类型 (PING | TCP | HTTP | HTTPS | DNS)。

选择

  • "ping"

  • "tcp"

  • "http"

  • "https"

  • "dns"

  • "passive-sip"

member_path

字符串

要操作的成员属性路径。

如果存在多个属性，则用斜杠字符分隔。

标有 member_path 的参数对于执行成员操作是合法的。

member_state

字符串

在指定的属性路径下添加或删除成员。

当指定 member_state 时，将忽略 state 选项。

选择

  • "present"

  • "absent"

state

字符串 / 必需

指示是创建还是删除对象。

选择

  • "present"

  • "absent"

vdom

字符串

虚拟域，在先前定义的域中。vdom 是 FortiGate 的一个虚拟实例，可以配置并用作不同的单元。

默认值： "root"

注释

注意

  • 旧版 fortiosapi 已弃用，httpapi 是运行 playbook 的首选方法

  • 该模块支持 check_mode。

示例

- name: Configure server load balancing health monitors.
  fortinet.fortios.fortios_firewall_ldb_monitor:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      firewall_ldb_monitor:
          dns_match_ip: "<your_own_value>"
          dns_protocol: "udp"
          dns_request_domain: "<your_own_value>"
          http_get: "<your_own_value>"
          http_match: "<your_own_value>"
          http_max_redirects: "0"
          interval: "10"
          name: "default_name_10"
          port: "0"
          retry: "3"
          src_ip: "<your_own_value>"
          timeout: "2"
          type: "ping"

返回值

通用返回值记录在 此处，以下是此模块独有的字段

键

描述

build

字符串

Fortigate 映像的内部版本号

返回： 始终

示例： "1547"

http_method

字符串

最后一次用于将内容配置到 FortiGate 的方法

返回： 始终

示例： "PUT"

http_status

字符串

FortiGate 在最后一次应用操作时给出的最后结果

返回： 始终

示例： "200"

mkey

字符串

在最后一次调用 FortiGate 时使用的主键 (id)

返回： 成功

示例： "id"

name

字符串

用于完成请求的表名称

返回： 始终

示例： "urlfilter"

路径

字符串

用于满足请求的表的路径

返回： 始终

示例： "webfilter"

修订版本

字符串

内部修订号

返回： 始终

示例： "17.0.2.10658"

序列号

字符串

设备的序列号

返回： 始终

示例： "FGVMEVYYQT3AB5352"

状态

字符串

指示操作结果

返回： 始终

示例： "success"

vdom

字符串

使用的虚拟域

返回： 始终

示例： "root"

版本

字符串

FortiGate 的版本

返回： 始终

示例： "v5.6.3"

作者

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)