fortios_wanopt_profile – Configure WAN optimization profiles in Fortinet’s FortiOS and FortiGate — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# fortios_wanopt_profile – Configure WAN optimization profiles in Fortinet’s FortiOS and FortiGate

New in version 2.8.

- Synopsis
- Requirements
- Parameters
- Notes
- Examples
- Return Values
- Status

## Synopsis

- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wanopt feature and profile category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

## Requirements

The below requirements are needed on the host that executes this module.

- fortiosapi>=0.9.8

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
host string |  | FortiOS or FortiGate IP address.
https boolean | Choices: no yes ← | Indicates if the requests towards FortiGate must use HTTPS protocol.
password string | Default: "" | FortiOS or FortiGate password.
ssl_verify boolean added in 2.9 | Choices: no yes ← | Ensures FortiGate certificate must be verified by a proper CA.
state string added in 2.9 | Choices: present absent | Indicates whether to create or remove the object. This attribute was present already in previous version in a deeper level. It has been moved out to this outer level.
username string |  | FortiOS or FortiGate username.
vdom string | Default: "root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit.
wanopt_profile dictionary | Default: null | Configure WAN optimization profiles.
| auth_group string |  | Optionally add an authentication group to restrict access to the WAN Optimization tunnel to peers in the authentication group. Source wanopt.auth-group.name.
| cifs dictionary |  | Enable/disable CIFS (Windows sharing) WAN Optimization and configure CIFS WAN Optimization features.
|  | byte_caching string | Choices: enable disable | Enable/disable byte-caching for HTTP. Byte caching reduces the amount of traffic by caching file data sent across the WAN and in future serving if from the cache.
|  | log_traffic string | Choices: enable disable | Enable/disable logging.
|  | port integer |  | Single port number or port number range for CIFS. Only packets with a destination port number that matches this port number or range are accepted by this profile.
|  | prefer_chunking string | Choices: dynamic fix | Select dynamic or fixed-size data chunking for HTTP WAN Optimization.
|  | secure_tunnel string | Choices: enable disable | Enable/disable securing the WAN Opt tunnel using SSL. Secure and non-secure tunnels use the same TCP port (7810).
|  | status string | Choices: enable disable | Enable/disable HTTP WAN Optimization.
|  | tunnel_sharing string | Choices: private shared express-shared | Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols.
| comments string |  | Comment.
| ftp dictionary |  | Enable/disable FTP WAN Optimization and configure FTP WAN Optimization features.
|  | byte_caching string | Choices: enable disable | Enable/disable byte-caching for HTTP. Byte caching reduces the amount of traffic by caching file data sent across the WAN and in future serving if from the cache.
|  | log_traffic string | Choices: enable disable | Enable/disable logging.
|  | port integer |  | Single port number or port number range for FTP. Only packets with a destination port number that matches this port number or range are accepted by this profile.
|  | prefer_chunking string | Choices: dynamic fix | Select dynamic or fixed-size data chunking for HTTP WAN Optimization.
|  | secure_tunnel string | Choices: enable disable | Enable/disable securing the WAN Opt tunnel using SSL. Secure and non-secure tunnels use the same TCP port (7810).
|  | status string | Choices: enable disable | Enable/disable HTTP WAN Optimization.
|  | tunnel_sharing string | Choices: private shared express-shared | Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols.
| http dictionary |  | Enable/disable HTTP WAN Optimization and configure HTTP WAN Optimization features.
|  | byte_caching string | Choices: enable disable | Enable/disable byte-caching for HTTP. Byte caching reduces the amount of traffic by caching file data sent across the WAN and in future serving if from the cache.
|  | log_traffic string | Choices: enable disable | Enable/disable logging.
|  | port integer |  | Single port number or port number range for HTTP. Only packets with a destination port number that matches this port number or range are accepted by this profile.
|  | prefer_chunking string | Choices: dynamic fix | Select dynamic or fixed-size data chunking for HTTP WAN Optimization.
|  | secure_tunnel string | Choices: enable disable | Enable/disable securing the WAN Opt tunnel using SSL. Secure and non-secure tunnels use the same TCP port (7810).
|  | ssl string | Choices: enable disable | Enable/disable SSL/TLS offloading (hardware acceleration) for HTTPS traffic in this tunnel.
|  | ssl_port integer |  | Port on which to expect HTTPS traffic for SSL/TLS offloading.
|  | status string | Choices: enable disable | Enable/disable HTTP WAN Optimization.
|  | tunnel_non_http string | Choices: enable disable | Configure how to process non-HTTP traffic when a profile configured for HTTP traffic accepts a non-HTTP session. Can occur if an application sends non-HTTP traffic using an HTTP destination port.
|  | tunnel_sharing string | Choices: private shared express-shared | Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols.
|  | unknown_http_version string | Choices: reject tunnel best-effort | How to handle HTTP sessions that do not comply with HTTP 0.9, 1.0, or 1.1.
| mapi dictionary |  | Enable/disable MAPI email WAN Optimization and configure MAPI WAN Optimization features.
|  | byte_caching string | Choices: enable disable | Enable/disable byte-caching for HTTP. Byte caching reduces the amount of traffic by caching file data sent across the WAN and in future serving if from the cache.
|  | log_traffic string | Choices: enable disable | Enable/disable logging.
|  | port integer |  | Single port number or port number range for MAPI. Only packets with a destination port number that matches this port number or range are accepted by this profile.
|  | secure_tunnel string | Choices: enable disable | Enable/disable securing the WAN Opt tunnel using SSL. Secure and non-secure tunnels use the same TCP port (7810).
|  | status string | Choices: enable disable | Enable/disable HTTP WAN Optimization.
|  | tunnel_sharing string | Choices: private shared express-shared | Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols.
| name string / required |  | Profile name.
| state string | Choices: present absent | Deprecated Starting with Ansible 2.9 we recommend using the top-level 'state' parameter. Indicates whether to create or remove the object.
| tcp dictionary |  | Enable/disable TCP WAN Optimization and configure TCP WAN Optimization features.
|  | byte_caching string | Choices: enable disable | Enable/disable byte-caching for HTTP. Byte caching reduces the amount of traffic by caching file data sent across the WAN and in future serving if from the cache.
|  | byte_caching_opt string | Choices: mem-only mem-disk | Select whether TCP byte-caching uses system memory only or both memory and disk space.
|  | log_traffic string | Choices: enable disable | Enable/disable logging.
|  | port string |  | Single port number or port number range for TCP. Only packets with a destination port number that matches this port number or range are accepted by this profile.
|  | secure_tunnel string | Choices: enable disable | Enable/disable securing the WAN Opt tunnel using SSL. Secure and non-secure tunnels use the same TCP port (7810).
|  | ssl string | Choices: enable disable | Enable/disable SSL/TLS offloading.
|  | ssl_port integer |  | Port on which to expect HTTPS traffic for SSL/TLS offloading.
|  | status string | Choices: enable disable | Enable/disable HTTP WAN Optimization.
|  | tunnel_sharing string | Choices: private shared express-shared | Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols.
| transparent string | Choices: enable disable | Enable/disable transparent mode.

## Notes

Note

- Requires fortiosapi library developed by Fortinet
- Run as a local_action in your playbook

## Examples

    - hosts: localhost
      vars:
       host: "192.168.122.40"
       username: "admin"
       password: ""
       vdom: "root"
       ssl_verify: "False"
      tasks:
      - name: Configure WAN optimization profiles.
        fortios_wanopt_profile:
          host:  "{{ host }}"
          username: "{{ username }}"
          password: "{{ password }}"
          vdom:  "{{ vdom }}"
          https: "False"
          state: "present"
          wanopt_profile:
            auth_group: "<your_own_value> (source wanopt.auth-group.name)"
            cifs:
                byte_caching: "enable"
                log_traffic: "enable"
                port: "7"
                prefer_chunking: "dynamic"
                secure_tunnel: "enable"
                status: "enable"
                tunnel_sharing: "private"
            comments: "<your_own_value>"
            ftp:
                byte_caching: "enable"
                log_traffic: "enable"
                port: "16"
                prefer_chunking: "dynamic"
                secure_tunnel: "enable"
                status: "enable"
                tunnel_sharing: "private"
            http:
                byte_caching: "enable"
                log_traffic: "enable"
                port: "24"
                prefer_chunking: "dynamic"
                secure_tunnel: "enable"
                ssl: "enable"
                ssl_port: "28"
                status: "enable"
                tunnel_non_http: "enable"
                tunnel_sharing: "private"
                unknown_http_version: "reject"
            mapi:
                byte_caching: "enable"
                log_traffic: "enable"
                port: "36"
                secure_tunnel: "enable"
                status: "enable"
                tunnel_sharing: "private"
            name: "default_name_40"
            tcp:
                byte_caching: "enable"
                byte_caching_opt: "mem-only"
                log_traffic: "enable"
                port: "<your_own_value>"
                secure_tunnel: "enable"
                ssl: "enable"
                ssl_port: "48"
                status: "enable"
                tunnel_sharing: "private"
            transparent: "enable"

## Return Values

Common return values are documented here, the following are the fields unique to this module:

Key | Returned | Description
--- | --- | ---
build string | always | Build number of the fortigate image Sample: 1547
http_method string | always | Last method used to provision the content into FortiGate Sample: PUT
http_status string | always | Last result given by FortiGate on last operation applied Sample: 200
mkey string | success | Master key (id) used in the last call to FortiGate Sample: id
name string | always | Name of the table used to fulfill the request Sample: urlfilter
path string | always | Path of the table used to fulfill the request Sample: webfilter
revision string | always | Internal revision number Sample: 17.0.2.10658
serial string | always | Serial number of the unit Sample: FGVMEVYYQT3AB5352
status string | always | Indication of the operation's result Sample: success
vdom string | always | Virtual domain used Sample: root
version string | always | Version of the FortiGate Sample: v5.6.3

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]

### Authors

- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.