fortinet.fortios.fortios_icap_server_group 模块 – 配置由多个转发服务器组成的 ICAP 服务器组。支持 Fortinet 的 FortiOS 和 FortiGate 中的故障转移和负载均衡。

注意

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

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

要安装它,请使用:ansible-galaxy collection install fortinet.fortios。您需要其他要求才能使用此模块,请参阅 要求 了解详情。

要在剧本中使用它,请指定:fortinet.fortios.fortios_icap_server_group

fortinet.fortios 2.0.0 中的新增功能

概要

  • 此模块能够通过允许用户设置和修改 icap 功能和 server_group 类别来配置 FortiGate 或 FortiOS (FOS) 设备。示例包括所有参数,在使用前需要将值调整为数据源。已在 FOS v6.0.0 上测试。

要求

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

  • ansible>=2.15

参数

参数

注释

access_token

字符串

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

enable_log

布尔值

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

选项

  • false ← (默认)

  • true

icap_server_group

字典

配置由多个转发服务器组成的 ICAP 服务器组。支持故障转移和负载均衡。

ldb_method

字符串

负载均衡方法。

选项

  • "weighted"

  • "least-session"

  • "active-passive"

name

字符串 / 必需

配置由一个或多个转发服务器组成的 ICAP 服务器组。支持故障转移和负载均衡。

server_list

列表 / 元素=字典

将 ICAP 服务器添加到列表中以形成服务器组。可以选择为每个服务器分配权重。

name

字符串 / 必需

ICAP 服务器名称。来源 icap.server.name。

weight

整数

可以选择为转发服务器分配加权负载均衡的权重 (1 - 100)。

member_path

字符串

要操作的成员属性路径。

如果有多个属性,则用斜杠字符分隔。

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

member_state

字符串

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

指定 member_state 时,将忽略 state 选项。

选项

  • "present"

  • "absent"

state

字符串 / 必需

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

选项

  • "present"

  • "absent"

vdom

字符串

虚拟域,在先前定义的那些虚拟域中。vdom 是 FortiGate 的虚拟实例,可以将其配置并用作不同的单元。

默认值: "root"

注释

注意

  • 旧版 fortiosapi 已弃用,httpapi 是运行剧本的首选方法。

示例

- name: Configure an ICAP server group consisting of multiple forward servers. Supports failover and load balancing.
  fortinet.fortios.fortios_icap_server_group:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      icap_server_group:
          ldb_method: "weighted"
          name: "default_name_4"
          server_list:
              -
                  name: "default_name_6 (source icap.server.name)"
                  weight: "10"

返回值

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

描述

build

字符串

FortiGate 映像的版本号

返回: 始终

示例: "1547"

http_method

字符串

上次用于将内容置备到 FortiGate 的方法

返回: 始终

示例: "PUT"

http_status

字符串

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

返回: 始终

示例: "200"

mkey

字符串

上次调用 FortiGate 时使用的主密钥 (id)

返回: 成功

示例: "id"

name

字符串

用于完成请求的表名称

返回: 始终

示例: "urlfilter"

path

字符串

用于完成请求的表的路径

返回: 始终

示例: "webfilter"

revision

字符串

内部修订号

返回: 始终

示例: "17.0.2.10658"

serial

字符串

设备序列号

返回: 始终

示例: "FGVMEVYYQT3AB5352"

status

字符串

操作结果指示

返回: 始终

示例: "success"

vdom

字符串

使用的虚拟域

返回: 始终

示例: "root"

version

字符串

FortiGate 版本

返回: 始终

示例: "v5.6.3"

作者

  • 郑链 (@chillancezen)

  • 薛杰 (@JieX19)

  • 卢洪滨 (@fgtdev-hblu)

  • 沈方 (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)