fortinet.fortimanager.fmgr_wanopt_profile module – Configure WAN optimization profiles.
Note
This module is part of the fortinet.fortimanager collection (version 2.7.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 fortinet.fortimanager
.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_wanopt_profile
.
New in fortinet.fortimanager 1.0.0
Synopsis
This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
Parameter |
Comments |
---|---|
The token to access FortiManager without using username and password. |
|
The parameter (adom) in requested url. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The directive to create, update or delete an object. Choices:
|
|
The top level parameters set. |
|
Deprecated, please rename it to auth_group. Optionally add an authentication group to restrict access to the WAN Optimizat… |
|
Cifs. |
|
Deprecated, please rename it to byte_caching. Enable/disable byte-caching. Choices:
|
|
Deprecated, please rename it to log_traffic. Enable/disable logging. Choices:
|
|
(list) Single port number or port number range for CIFS. |
|
Deprecated, please rename it to prefer_chunking. Select dynamic or fixed-size data chunking for WAN Optimization. Choices:
|
|
Deprecated, please rename it to protocol_opt. Select Protocol specific optimitation or generic TCP optimization. Choices:
|
|
Deprecated, please rename it to secure_tunnel. Enable/disable securing the WAN Opt tunnel using SSL. Choices:
|
|
Enable/disable WAN Optimization. Choices:
|
|
Deprecated, please rename it to tunnel_sharing. Tunnel sharing mode for aggressive/non-aggressive and/or interacti… Choices:
|
|
Comment. |
|
Ftp. |
|
Deprecated, please rename it to byte_caching. Enable/disable byte-caching. Choices:
|
|
Deprecated, please rename it to log_traffic. Enable/disable logging. Choices:
|
|
(list) Single port number or port number range for FTP. |
|
Deprecated, please rename it to prefer_chunking. Select dynamic or fixed-size data chunking for WAN Optimization. Choices:
|
|
Deprecated, please rename it to protocol_opt. Select Protocol specific optimitation or generic TCP optimization. Choices:
|
|
Deprecated, please rename it to secure_tunnel. Enable/disable securing the WAN Opt tunnel using SSL. Choices:
|
|
Enable/disable SSL/TLS offloading Choices:
|
|
Enable/disable WAN Optimization. Choices:
|
|
Deprecated, please rename it to tunnel_sharing. Tunnel sharing mode for aggressive/non-aggressive and/or interacti… Choices:
|
|
Http. |
|
Deprecated, please rename it to byte_caching. Enable/disable byte-caching. Choices:
|
|
Deprecated, please rename it to log_traffic. Enable/disable logging. Choices:
|
|
(list) Single port number or port number range for HTTP. |
|
Deprecated, please rename it to prefer_chunking. Select dynamic or fixed-size data chunking for WAN Optimization. Choices:
|
|
Deprecated, please rename it to protocol_opt. Select Protocol specific optimitation or generic TCP optimization. Choices:
|
|
Deprecated, please rename it to secure_tunnel. Enable/disable securing the WAN Opt tunnel using SSL. Choices:
|
|
Enable/disable SSL/TLS offloading Choices:
|
|
(list) Deprecated, please rename it to ssl_port. Port on which to expect HTTPS traffic for SSL/TLS offloading. |
|
Enable/disable WAN Optimization. Choices:
|
|
Deprecated, please rename it to tunnel_non_http. Configure how to process non-HTTP traffic when a profile configur… Choices:
|
|
Deprecated, please rename it to tunnel_sharing. Tunnel sharing mode for aggressive/non-aggressive and/or interacti… Choices:
|
|
Deprecated, please rename it to unknown_http_version. How to handle HTTP sessions that do not comply with HTTP 0. Choices:
|
|
Mapi. |
|
Deprecated, please rename it to byte_caching. Enable/disable byte-caching. Choices:
|
|
Deprecated, please rename it to log_traffic. Enable/disable logging. Choices:
|
|
(list) Single port number or port number range for MAPI. |
|
Deprecated, please rename it to secure_tunnel. Enable/disable securing the WAN Opt tunnel using SSL. Choices:
|
|
Enable/disable WAN Optimization. Choices:
|
|
Deprecated, please rename it to tunnel_sharing. Tunnel sharing mode for aggressive/non-aggressive and/or interacti… Choices:
|
|
Profile name. |
|
Tcp. |
|
Deprecated, please rename it to byte_caching. Enable/disable byte-caching. Choices:
|
|
Deprecated, please rename it to byte_caching_opt. Select whether TCP byte-caching uses system memory only or both … Choices:
|
|
Deprecated, please rename it to log_traffic. Enable/disable logging. Choices:
|
|
Port numbers or port number ranges for TCP. |
|
Deprecated, please rename it to secure_tunnel. Enable/disable securing the WAN Opt tunnel using SSL. Choices:
|
|
Enable/disable SSL/TLS offloading Choices:
|
|
(list) Deprecated, please rename it to ssl_port. Port numbers or port number ranges on which to expect HTTPS traff… |
|
Enable/disable WAN Optimization. Choices:
|
|
Deprecated, please rename it to tunnel_sharing. Tunnel sharing mode for aggressive/non-aggressive and/or interacti… Choices:
|
|
Enable/disable transparent mode. Choices:
|
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
Notes
Note
Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
To create or update an object, use state present directive.
To delete an object, use state absent directive.
Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded
Examples
- 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: Configure WAN optimization profiles.
fortinet.fortimanager.fmgr_wanopt_profile:
# 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>
state: present # <value in [present, absent]>
wanopt_profile:
auth_group: <string>
comments: <string>
name: <string>
transparent: <value in [disable, enable]>
cifs:
byte_caching: <value in [disable, enable]>
log_traffic: <value in [disable, enable]>
prefer_chunking: <value in [dynamic, fix]>
protocol_opt: <value in [protocol, tcp]>
secure_tunnel: <value in [disable, enable]>
status: <value in [disable, enable]>
tunnel_sharing: <value in [private, shared, express-shared]>
port: <list or integer>
ftp:
byte_caching: <value in [disable, enable]>
log_traffic: <value in [disable, enable]>
prefer_chunking: <value in [dynamic, fix]>
protocol_opt: <value in [protocol, tcp]>
secure_tunnel: <value in [disable, enable]>
ssl: <value in [disable, enable]>
status: <value in [disable, enable]>
tunnel_sharing: <value in [private, shared, express-shared]>
port: <list or integer>
http:
byte_caching: <value in [disable, enable]>
log_traffic: <value in [disable, enable]>
prefer_chunking: <value in [dynamic, fix]>
protocol_opt: <value in [protocol, tcp]>
secure_tunnel: <value in [disable, enable]>
ssl: <value in [disable, enable]>
status: <value in [disable, enable]>
tunnel_sharing: <value in [private, shared, express-shared]>
tunnel_non_http: <value in [disable, enable]>
unknown_http_version: <value in [best-effort, reject, tunnel]>
port: <list or integer>
ssl_port: <list or integer>
mapi:
byte_caching: <value in [disable, enable]>
log_traffic: <value in [disable, enable]>
secure_tunnel: <value in [disable, enable]>
status: <value in [disable, enable]>
tunnel_sharing: <value in [private, shared, express-shared]>
port: <list or integer>
tcp:
byte_caching: <value in [disable, enable]>
byte_caching_opt: <value in [mem-only, mem-disk]>
log_traffic: <value in [disable, enable]>
port: <string>
secure_tunnel: <value in [disable, enable]>
ssl: <value in [disable, enable]>
ssl_port: <list or integer>
status: <value in [disable, enable]>
tunnel_sharing: <value in [private, shared, express-shared]>
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |