fortinet.fortios.fortios_wanopt_profile module – Configure WAN optimization profiles in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.9).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install fortinet.fortios.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_wanopt_profile.
New in fortinet.fortios 2.0.0
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.0
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.15
Parameters
Parameter |
Comments |
|---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Indicates whether to create or remove the object. Choices:
|
|
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. Default: |
|
Configure WAN optimization profiles. |
|
Optionally add an authentication group to restrict access to the WAN Optimization tunnel to peers in the authentication group. Source wanopt.auth-group.name. |
|
Enable/disable CIFS (Windows sharing) WAN Optimization and configure CIFS WAN Optimization features. |
|
Enable/disable byte-caching. Byte caching reduces the amount of traffic by caching file data sent across the WAN and in future serving if from the cache. Choices:
|
|
Enable/disable logging. Choices:
|
|
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. |
|
Select dynamic or fixed-size data chunking for WAN Optimization. Choices:
|
|
Select protocol specific optimization or generic TCP optimization. Choices:
|
|
Enable/disable securing the WAN Opt tunnel using SSL. Secure and non-secure tunnels use the same TCP port (7810). Choices:
|
|
Enable/disable WAN Optimization. Choices:
|
|
Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols. Choices:
|
|
Comment. |
|
Enable/disable FTP WAN Optimization and configure FTP WAN Optimization features. |
|
Enable/disable byte-caching. Byte caching reduces the amount of traffic by caching file data sent across the WAN and in future serving if from the cache. Choices:
|
|
Enable/disable logging. Choices:
|
|
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. |
|
Select dynamic or fixed-size data chunking for WAN Optimization. Choices:
|
|
Select protocol specific optimization or generic TCP optimization. Choices:
|
|
Enable/disable securing the WAN Opt tunnel using SSL. Secure and non-secure tunnels use the same TCP port (7810). Choices:
|
|
Enable/disable SSL/TLS offloading (hardware acceleration) for traffic in this tunnel. Choices:
|
|
Enable/disable WAN Optimization. Choices:
|
|
Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols. Choices:
|
|
Enable/disable HTTP WAN Optimization and configure HTTP WAN Optimization features. |
|
Enable/disable byte-caching. Byte caching reduces the amount of traffic by caching file data sent across the WAN and in future serving if from the cache. Choices:
|
|
Enable/disable logging. Choices:
|
|
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. |
|
Select dynamic or fixed-size data chunking for WAN Optimization. Choices:
|
|
Select protocol specific optimization or generic TCP optimization. Choices:
|
|
Enable/disable securing the WAN Opt tunnel using SSL. Secure and non-secure tunnels use the same TCP port (7810). Choices:
|
|
Enable/disable SSL/TLS offloading (hardware acceleration) for traffic in this tunnel. Choices:
|
|
Port on which to expect HTTPS traffic for SSL/TLS offloading. |
|
Enable/disable WAN Optimization. Choices:
|
|
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. Choices:
|
|
Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols. Choices:
|
|
How to handle HTTP sessions that do not comply with HTTP 0.9, 1.0, or 1.1. Choices:
|
|
Enable/disable MAPI email WAN Optimization and configure MAPI WAN Optimization features. |
|
Enable/disable byte-caching. Byte caching reduces the amount of traffic by caching file data sent across the WAN and in future serving if from the cache. Choices:
|
|
Enable/disable logging. Choices:
|
|
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. |
|
Enable/disable securing the WAN Opt tunnel using SSL. Secure and non-secure tunnels use the same TCP port (7810). Choices:
|
|
Enable/disable WAN Optimization. Choices:
|
|
Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols. Choices:
|
|
Profile name. |
|
Enable/disable TCP WAN Optimization and configure TCP WAN Optimization features. |
|
Enable/disable byte-caching. Byte caching reduces the amount of traffic by caching file data sent across the WAN and in future serving if from the cache. Choices:
|
|
Select whether TCP byte-caching uses system memory only or both memory and disk space. Choices:
|
|
Enable/disable logging. Choices:
|
|
Port numbers or port number ranges for TCP. Only packets with a destination port number that matches this port number or range are accepted by this profile. |
|
Enable/disable securing the WAN Opt tunnel using SSL. Secure and non-secure tunnels use the same TCP port (7810). Choices:
|
|
Enable/disable SSL/TLS offloading (hardware acceleration) for traffic in this tunnel. Choices:
|
|
Port numbers or port number ranges on which to expect HTTPS traffic for SSL/TLS offloading. |
|
Enable/disable WAN Optimization. Choices:
|
|
Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols. Choices:
|
|
Enable/disable transparent mode. Choices:
|
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
The module supports check_mode.
Examples
- 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"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |