community.fortios.fmgr_secprof_wanopt module – WAN optimization
Note
This module is part of the community.fortios collection (version 1.0.0).
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 community.fortios
.
To use it in a playbook, specify: community.fortios.fmgr_secprof_wanopt
.
Synopsis
Manage WanOpt security profiles in FortiManager via API
Parameters
Parameter |
Comments |
---|---|
The ADOM the configuration should belong to. Default: |
|
Optionally add an authentication group to restrict access to the WAN Optimization tunnel to peers in the authentication group. |
|
EXPERTS ONLY! KNOWLEDGE OF FMGR JSON API IS REQUIRED! List of multiple child objects to be added. Expects a list of dictionaries. Dictionaries must use FortiManager API parameters, not the ansible ones listed below. If submitted, all other prefixed sub-parameters ARE IGNORED. This object is MUTUALLY EXCLUSIVE with its options. We expect that you know what you are doing with these list parameters, and are leveraging the JSON API Guide. WHEN IN DOUBT, USE THE SUB OPTIONS BELOW INSTEAD TO CREATE OBJECTS WITH MULTIPLE TASKS |
|
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. 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 HTTP WAN 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 HTTP WAN Optimization. Choices:
|
|
Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols. Choices:
|
|
Comment. |
|
EXPERTS ONLY! KNOWLEDGE OF FMGR JSON API IS REQUIRED! List of multiple child objects to be added. Expects a list of dictionaries. Dictionaries must use FortiManager API parameters, not the ansible ones listed below. If submitted, all other prefixed sub-parameters ARE IGNORED. This object is MUTUALLY EXCLUSIVE with its options. We expect that you know what you are doing with these list parameters, and are leveraging the JSON API Guide. WHEN IN DOUBT, USE THE SUB OPTIONS BELOW INSTEAD TO CREATE OBJECTS WITH MULTIPLE TASKS |
|
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. 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 HTTP WAN 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 HTTP WAN Optimization. Choices:
|
|
Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols. Choices:
|
|
EXPERTS ONLY! KNOWLEDGE OF FMGR JSON API IS REQUIRED! List of multiple child objects to be added. Expects a list of dictionaries. Dictionaries must use FortiManager API parameters, not the ansible ones listed below. If submitted, all other prefixed sub-parameters ARE IGNORED. This object is MUTUALLY EXCLUSIVE with its options. We expect that you know what you are doing with these list parameters, and are leveraging the JSON API Guide. WHEN IN DOUBT, USE THE SUB OPTIONS BELOW INSTEAD TO CREATE OBJECTS WITH MULTIPLE TASKS |
|
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. 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 HTTP WAN 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 HTTPS traffic in this tunnel. Choices:
|
|
Port on which to expect HTTPS traffic for SSL/TLS offloading. |
|
Enable/disable HTTP 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:
|
|
EXPERTS ONLY! KNOWLEDGE OF FMGR JSON API IS REQUIRED! List of multiple child objects to be added. Expects a list of dictionaries. Dictionaries must use FortiManager API parameters, not the ansible ones listed below. If submitted, all other prefixed sub-parameters ARE IGNORED. This object is MUTUALLY EXCLUSIVE with its options. We expect that you know what you are doing with these list parameters, and are leveraging the JSON API Guide. WHEN IN DOUBT, USE THE SUB OPTIONS BELOW INSTEAD TO CREATE OBJECTS WITH MULTIPLE TASKS |
|
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. 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 HTTP WAN Optimization. Choices:
|
|
Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols. Choices:
|
|
Sets one of three modes for managing the object. Allows use of soft-adds instead of overwriting existing values Choices:
|
|
Profile name. |
|
EXPERTS ONLY! KNOWLEDGE OF FMGR JSON API IS REQUIRED! List of multiple child objects to be added. Expects a list of dictionaries. Dictionaries must use FortiManager API parameters, not the ansible ones listed below. If submitted, all other prefixed sub-parameters ARE IGNORED. This object is MUTUALLY EXCLUSIVE with its options. We expect that you know what you are doing with these list parameters, and are leveraging the JSON API Guide. WHEN IN DOUBT, USE THE SUB OPTIONS BELOW INSTEAD TO CREATE OBJECTS WITH MULTIPLE TASKS |
|
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. Choices:
|
|
Select whether TCP byte-caching uses system memory only or both memory and disk space. Choices:
|
|
Enable/disable logging. Choices:
|
|
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. |
|
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. Choices:
|
|
Port on which to expect HTTPS traffic for SSL/TLS offloading. |
|
Enable/disable HTTP WAN Optimization. Choices:
|
|
Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols. Choices:
|
|
Enable/disable transparent mode. Choices:
|
Notes
Note
Full Documentation at https://ftnt-ansible-docs.readthedocs.io/en/latest/.
Examples
- name: DELETE Profile
community.fortios.fmgr_secprof_wanopt:
name: "Ansible_WanOpt_Profile"
mode: "delete"
- name: Create FMGR_WANOPT_PROFILE
community.fortios.fmgr_secprof_wanopt:
mode: "set"
adom: "root"
transparent: "enable"
name: "Ansible_WanOpt_Profile"
comments: "Created by Ansible"
cifs: {byte-caching: "enable",
log-traffic: "enable",
port: 80,
prefer-chunking: "dynamic",
status: "enable",
tunnel-sharing: "private"}
ftp: {byte-caching: "enable",
log-traffic: "enable",
port: 80,
prefer-chunking: "dynamic",
secure-tunnel: "disable",
status: "enable",
tunnel-sharing: "private"}
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
full API response, includes status code and message Returned: always |