fortinet.fortios.fortios_icap_server 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置 ICAP 服务器。

注意

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

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

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

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

在 fortinet.fortios 2.0.0 中新增

概要

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

要求

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

  • ansible>=2.15

参数

参数

注释

access_token

字符串

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

enable_log

布尔值

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

选择

  • false ← (默认)

  • true

icap_server

字典

配置 ICAP 服务器。

addr_type

字符串

远程 ICAP 服务器的地址类型：IPv4、IPv6 或 FQDN。

选择

  • "ip4"

  • "ip6"

  • "fqdn"

fqdn

字符串

ICAP 远程服务器完全限定域名 (FQDN)。

healthcheck

字符串

启用/禁用 ICAP 远程服务器运行状况检查。尝试连接到远程 ICAP 服务器以验证服务器是否正常运行。

选择

  • "disable"

  • "enable"

healthcheck_service

字符串

用于运行状况检查的 ICAP 服务名称。

ip6_address

字符串

ICAP 服务器的 IPv6 地址。

ip_address

字符串

ICAP 服务器的 IPv4 地址。

ip_version

字符串

IP 版本。

选择

  • "4"

  • "6"

max_connections

整数

与 ICAP 服务器的最大并发连接数（无限制 = 0）。不得小于 wad-worker-count。

name

字符串 / 必需

服务器名称。

port

整数

ICAP 服务器端口。

secure

字符串

启用/禁用与 ICAP 服务器的安全连接。

选择

  • "disable"

  • "enable"

ssl_cert

字符串

CA 证书名称。源 certificate.ca.name。

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 ICAP servers.
  fortinet.fortios.fortios_icap_server:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      icap_server:
          addr_type: "ip4"
          fqdn: "<your_own_value>"
          healthcheck: "disable"
          healthcheck_service: "<your_own_value>"
          ip_address: "<your_own_value>"
          ip_version: "4"
          ip6_address: "<your_own_value>"
          max_connections: "100"
          name: "default_name_11"
          port: "1344"
          secure: "disable"
          ssl_cert: "<your_own_value> (source certificate.ca.name)"

返回值

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

键

描述

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)