fortinet.fortios.fortios_wanopt_profile 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置 WAN 优化配置文件。

注意

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

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

要安装它,请使用:ansible-galaxy collection install fortinet.fortios。您需要其他要求才能使用此模块,请参阅 要求 获取详细信息。

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

fortinet.fortios 2.0.0 中的新增功能

概要

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

要求

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

  • ansible>=2.15

参数

参数

注释

access_token

字符串

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

enable_log

布尔值

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

选项

  • false ← (默认)

  • true

member_path

字符串

要操作的成员属性路径。

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

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

member_state

字符串

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

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

选项

  • "present"

  • "absent"

state

字符串 / 必需

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

选项

  • "present"

  • "absent"

vdom

字符串

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

默认值: "root"

wanopt_profile

字典

配置 WAN 优化配置文件。

auth_group

字符串

可以选择添加身份验证组,以将对 WAN 优化隧道的访问权限限制为身份验证组中的对等体。来源 wanopt.auth-group.name。

cifs

字典

启用/禁用 CIFS(Windows 共享)WAN 优化并配置 CIFS WAN 优化功能。

byte_caching

字符串

启用/禁用字节缓存。字节缓存通过缓存通过 WAN 发送的文件数据并在将来从缓存中提供服务来减少流量量。

选项

  • "enable"

  • "disable"

log_traffic

字符串

启用/禁用日志记录。

选项

  • "enable"

  • "disable"

port

整数

CIFS 的单个端口号或端口号范围。只有目标端口号与该端口号或范围匹配的数据包才会被此配置文件接受。

prefer_chunking

字符串

为 WAN 优化选择动态或固定大小的数据分块。

选项

  • "dynamic"

  • "fix"

protocol_opt

字符串

选择协议特定优化或通用 TCP 优化。

选项

  • "protocol"

  • "tcp"

secure_tunnel

字符串

启用/禁用使用 SSL 保护 WAN Opt 隧道。安全和非安全隧道使用相同的 TCP 端口 (7810)。

选项

  • "enable"

  • "disable"

status

字符串

启用/禁用 WAN 优化。

选项

  • "enable"

  • "disable"

tunnel_sharing

字符串

针对积极/非积极和/或交互式/非交互式协议的隧道共享模式。

选项

  • "shared"

  • "express-shared"

  • "private"

comments

字符串

注释。

ftp

字典

启用/禁用 FTP WAN 优化并配置 FTP WAN 优化功能。

byte_caching

字符串

启用/禁用字节缓存。字节缓存通过缓存通过 WAN 发送的文件数据并在将来从缓存中提供服务来减少流量量。

选项

  • "enable"

  • "disable"

log_traffic

字符串

启用/禁用日志记录。

选项

  • "enable"

  • "disable"

port

整数

FTP 的单个端口号或端口号范围。只有目标端口号与该端口号或范围匹配的数据包才会被此配置文件接受。

prefer_chunking

字符串

为 WAN 优化选择动态或固定大小的数据分块。

选项

  • "dynamic"

  • "fix"

protocol_opt

字符串

选择协议特定优化或通用 TCP 优化。

选项

  • "protocol"

  • "tcp"

secure_tunnel

字符串

启用/禁用使用 SSL 保护 WAN Opt 隧道。安全和非安全隧道使用相同的 TCP 端口 (7810)。

选项

  • "enable"

  • "disable"

ssl

字符串

启用/禁用此隧道中流量的 SSL/TLS 卸载(硬件加速)。

选项

  • "enable"

  • "disable"

status

字符串

启用/禁用 WAN 优化。

选项

  • "enable"

  • "disable"

tunnel_sharing

字符串

针对积极/非积极和/或交互式/非交互式协议的隧道共享模式。

选项

  • "shared"

  • "express-shared"

  • "private"

http

字典

启用/禁用 HTTP WAN 优化并配置 HTTP WAN 优化功能。

byte_caching

字符串

启用/禁用字节缓存。字节缓存通过缓存通过 WAN 发送的文件数据并在将来从缓存中提供服务来减少流量量。

选项

  • "enable"

  • "disable"

log_traffic

字符串

启用/禁用日志记录。

选项

  • "enable"

  • "disable"

port

整数

HTTP 的单个端口号或端口号范围。只有目标端口号与该端口号或范围匹配的数据包才会被此配置文件接受。

prefer_chunking

字符串

为 WAN 优化选择动态或固定大小的数据分块。

选项

  • "dynamic"

  • "fix"

protocol_opt

字符串

选择协议特定优化或通用 TCP 优化。

选项

  • "protocol"

  • "tcp"

secure_tunnel

字符串

启用/禁用使用 SSL 保护 WAN Opt 隧道。安全和非安全隧道使用相同的 TCP 端口 (7810)。

选项

  • "enable"

  • "disable"

ssl

字符串

启用/禁用此隧道中流量的 SSL/TLS 卸载(硬件加速)。

选项

  • "enable"

  • "disable"

ssl_port

整数

用于预期 SSL/TLS 卸载的 HTTPS 流量的端口。

status

字符串

启用/禁用 WAN 优化。

选项

  • "enable"

  • "disable"

tunnel_non_http

字符串

配置如何处理为 HTTP 流量配置的配置文件接受非 HTTP 会话时的非 HTTP 流量。如果应用程序使用 HTTP 目标端口发送非 HTTP 流量,则可能会发生这种情况。

选项

  • "enable"

  • "disable"

tunnel_sharing

字符串

针对积极/非积极和/或交互式/非交互式协议的隧道共享模式。

选项

  • "shared"

  • "express-shared"

  • "private"

unknown_http_version

字符串

如何处理不符合 HTTP 0.9、1.0 或 1.1 的 HTTP 会话。

选项

  • "reject"

  • "tunnel"

  • "best-effort"

mapi

字典

启用/禁用 MAPI 电子邮件 WAN 优化并配置 MAPI WAN 优化功能。

byte_caching

字符串

启用/禁用字节缓存。字节缓存通过缓存通过 WAN 发送的文件数据并在将来从缓存中提供服务来减少流量量。

选项

  • "enable"

  • "disable"

log_traffic

字符串

启用/禁用日志记录。

选项

  • "enable"

  • "disable"

port

整数

MAPI 的单个端口号或端口号范围。只有目标端口号与该端口号或范围匹配的数据包才会被此配置文件接受。

secure_tunnel

字符串

启用/禁用使用 SSL 保护 WAN Opt 隧道。安全和非安全隧道使用相同的 TCP 端口 (7810)。

选项

  • "enable"

  • "disable"

status

字符串

启用/禁用 WAN 优化。

选项

  • "enable"

  • "disable"

tunnel_sharing

字符串

针对积极/非积极和/或交互式/非交互式协议的隧道共享模式。

选项

  • "shared"

  • "express-shared"

  • "private"

name

字符串 / 必需

配置文件名称。

tcp

字典

启用/禁用 TCP WAN 优化并配置 TCP WAN 优化功能。

byte_caching

字符串

启用/禁用字节缓存。字节缓存通过缓存通过 WAN 发送的文件数据并在将来从缓存中提供服务来减少流量量。

选项

  • "enable"

  • "disable"

byte_caching_opt

字符串

选择 TCP 字节缓存是否仅使用系统内存或同时使用内存和磁盘空间。

选项

  • "mem-only"

  • "mem-disk"

log_traffic

字符串

启用/禁用日志记录。

选项

  • "enable"

  • "disable"

port

字符串

TCP 的端口号或端口号范围。只有目标端口号与该端口号或范围匹配的数据包才会被此配置文件接受。

secure_tunnel

字符串

启用/禁用使用 SSL 保护 WAN Opt 隧道。安全和非安全隧道使用相同的 TCP 端口 (7810)。

选项

  • "enable"

  • "disable"

ssl

字符串

启用/禁用此隧道中流量的 SSL/TLS 卸载(硬件加速)。

选项

  • "enable"

  • "disable"

ssl_port

字符串

预期用于 SSL/TLS 卸载的 HTTPS 流量的端口号或端口号范围。

status

字符串

启用/禁用 WAN 优化。

选项

  • "enable"

  • "disable"

tunnel_sharing

字符串

针对积极/非积极和/或交互式/非交互式协议的隧道共享模式。

选项

  • "shared"

  • "express-shared"

  • "private"

透明模式

字符串

启用/禁用透明模式。

选项

  • "enable"

  • "disable"

注释

注意

  • 旧版 fortiosapi 已弃用,httpapi 是运行 playbook 的首选方式。

  • 该模块支持 check_mode。

示例

- name: Configure WAN optimization profiles.
  fortinet.fortios.fortios_wanopt_profile:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      wanopt_profile:
          auth_group: "<your_own_value> (source wanopt.auth-group.name)"
          cifs:
              byte_caching: "enable"
              log_traffic: "enable"
              port: "32767"
              prefer_chunking: "dynamic"
              protocol_opt: "protocol"
              secure_tunnel: "enable"
              status: "enable"
              tunnel_sharing: "shared"
          comments: "<your_own_value>"
          ftp:
              byte_caching: "enable"
              log_traffic: "enable"
              port: "32767"
              prefer_chunking: "dynamic"
              protocol_opt: "protocol"
              secure_tunnel: "enable"
              ssl: "enable"
              status: "enable"
              tunnel_sharing: "shared"
          http:
              byte_caching: "enable"
              log_traffic: "enable"
              port: "32767"
              prefer_chunking: "dynamic"
              protocol_opt: "protocol"
              secure_tunnel: "enable"
              ssl: "enable"
              ssl_port: "32767"
              status: "enable"
              tunnel_non_http: "enable"
              tunnel_sharing: "shared"
              unknown_http_version: "reject"
          mapi:
              byte_caching: "enable"
              log_traffic: "enable"
              port: "32767"
              secure_tunnel: "enable"
              status: "enable"
              tunnel_sharing: "shared"
          name: "default_name_44"
          tcp:
              byte_caching: "enable"
              byte_caching_opt: "mem-only"
              log_traffic: "enable"
              port: "<your_own_value>"
              secure_tunnel: "enable"
              ssl: "enable"
              ssl_port: "<your_own_value>"
              status: "enable"
              tunnel_sharing: "shared"
          transparent: "enable"

返回值

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

描述

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)

  • 米格尔·安吉尔·穆诺斯 (@mamunozgonzalez)

  • 尼古拉斯·托马斯 (@thomnico)