fortinet.fortimanager.fmgr_wanopt_profile_http 模块 – 启用/禁用 HTTP WAN 优化并配置 HTTP WAN 优化功能。

注意

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

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

要安装它，请使用： ansible-galaxy collection install fortinet.fortimanager。

要在 playbook 中使用它，请指定： fortinet.fortimanager.fmgr_wanopt_profile_http。

fortinet.fortimanager 2.0.0 中的新增功能

概要

  • 此模块能够配置 FortiManager 设备。

  • 示例包含所有需要在使用前调整为数据源的参数和值。

参数

参数

注释

access_token

字符串

无需用户名和密码即可访问 FortiManager 的令牌。

adom

字符串 / 必需

请求 URL 中的参数 (adom)。

bypass_validation

布尔值

仅当模块模式与 FortiManager API 结构不同时设置为 True，模块将继续执行而无需验证参数。

选项

  • false ← (默认)

  • true

enable_log

布尔值

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

选项

  • false ← (默认)

  • true

forticloud_access_token

字符串

使用 forticloud API 访问令牌对 Ansible 客户端进行身份验证。

profile

字符串 / 必需

请求 URL 中的参数 (profile)。

proposed_method

字符串

底层 Json RPC 请求的覆盖方法。

选项

  • "update"

  • "set"

  • "add"

rc_failed

列表 / 元素=整数

将覆盖失败条件的 rc 代码列表。

rc_succeeded

列表 / 元素=整数

将覆盖成功条件的 rc 代码列表。

wanopt_profile_http

字典

设置的顶级参数。

byte_caching

别名：byte-caching

字符串

启用/禁用 HTTP 的字节缓存。

选项

  • "disable"

  • "enable"

log_traffic

别名：log-traffic

字符串

启用/禁用日志记录。

选项

  • "disable"

  • "enable"

port

任意

(列表) HTTP 的单个端口号或端口号范围。

prefer_chunking

别名：prefer-chunking

字符串

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

选项

  • "dynamic"

  • "fix"

protocol_opt

别名：protocol-opt

字符串

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

选项

  • "protocol"

  • "tcp"

secure_tunnel

别名：secure-tunnel

字符串

启用/禁用使用 SSL 保护 WAN Opt 隧道。

选项

  • "disable"

  • "enable"

ssl

字符串

启用/禁用 SSL/TLS 卸载

选项

  • "disable"

  • "enable"

ssl_port

别名：ssl-port

任意

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

status

字符串

启用/禁用 HTTP WAN 优化。

选项

  • "disable"

  • "enable"

tunnel_non_http

别名：tunnel-non-http

字符串

配置当为 HTTP 流量配置的配置文件接受非 HTTP 会话时如何处理非 HTTP 流量。

选项

  • "disable"

  • "enable"

tunnel_sharing

别名：tunnel-sharing

字符串

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

选项

  • "private"

  • "shared"

  • "express-shared"

unknown_http_version

别名：unknown-http-version

字符串

如何处理不符合 HTTP 0 的 HTTP 会话。

选项

  • "best-effort"

  • "reject"

  • "tunnel"

workspace_locking_adom

字符串

在工作区模式下运行 FortiManager 的 adom 锁定，值可以是全局和其他值，包括 root。

workspace_locking_timeout

整数

等待其他用户释放工作区锁的最大时间（秒）。

默认值： 300

备注

注意

  • 从 2.4.0 版本开始，所有输入参数都使用下划线命名约定 (snake_case) 命名。请将诸如“var-name”之类的参数更改为“var_name”。旧的参数名称仍然可用，但您会收到弃用警告。您可以通过在 ansible.cfg 中设置 deprecation_warnings=False 来忽略此警告。

  • 此 FortiManager 模块支持在工作区锁定模式下运行，顶级参数 workspace_locking_adom 和 workspace_locking_timeout 有助于完成这项工作。

  • 通常，当返回非零 rc 时，运行一个模块可能会失败。您还可以使用参数 rc_failed 和 rc_succeeded 覆盖失败或成功的条件。

示例

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Enable/disable HTTP WAN Optimization and configure HTTP WAN Optimization features.
      fortinet.fortimanager.fmgr_wanopt_profile_http:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        profile: <your own value>
        wanopt_profile_http:
          byte_caching: <value in [disable, enable]>
          log_traffic: <value in [disable, enable]>
          port: <list or integer>
          prefer_chunking: <value in [dynamic, fix]>
          secure_tunnel: <value in [disable, enable]>
          ssl: <value in [disable, enable]>
          ssl_port: <list or integer>
          status: <value in [disable, enable]>
          tunnel_non_http: <value in [disable, enable]>
          tunnel_sharing: <value in [private, shared, express-shared]>
          unknown_http_version: <value in [best-effort, reject, tunnel]>
          protocol_opt: <value in [protocol, tcp]>

返回值

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

键

描述

meta

字典

请求的结果。

返回： 始终

request_url

字符串

请求的完整 URL。

返回： 始终

示例： "/sys/login/user"

response_code

整数

API 请求的状态。

返回： 始终

示例： 0

response_data

列表 / 元素=字符串

API 响应。

返回： 始终

response_message

字符串

API 响应的描述性消息。

返回： 始终

示例： "OK."

system_information

字典

目标系统的信息。

返回： 始终

rc

整数

请求的状态。

返回： 始终

示例： 0

version_check_warning

列表 / 元素=字符串

如果 playbook 中使用的参数不受当前 FortiManager 版本支持，则会发出警告。

返回： 复杂类型

作者

  • 杜欣伟 (@dux-fortinet)

  • 李星 (@lix-fortinet)

  • 解雪 (@JieX19)

  • 郑链 (@chillancezen)

  • 沈峰 (@fshen01)

  • 卢洪斌 (@fgtdev-hblu)