fortinet.fortimanager.fmgr_wanopt_profile module – Configure WAN optimization profiles.

Note

This module is part of the fortinet.fortimanager collection (version 2.8.2).

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
access_token string	The token to access FortiManager without using username and password.
adom string / required	The parameter (adom) in requested url.
bypass_validation boolean	Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices: `false` ← (default) `true`
enable_log boolean	Enable/Disable logging for task. Choices: `false` ← (default) `true`
forticloud_access_token string	Authenticate Ansible client with forticloud API access token.
proposed_method string	The overridden method for the underlying Json RPC request. Choices: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	The rc codes list with which the conditions to fail will be overriden.
rc_succeeded list / elements=integer	The rc codes list with which the conditions to succeed will be overriden.
state string / required	The directive to create, update or delete an object. Choices: `"present"` `"absent"`
wanopt_profile dictionary	The top level parameters set.
auth_group aliases: auth-group string	Optionally add an authentication group to restrict access to the WAN Optimization tunnel to peers in the authentication group.
cifs dictionary	Cifs.
byte_caching aliases: byte-caching string	Enable/disable byte-caching. Choices: `"disable"` `"enable"`
log_traffic aliases: log-traffic string	Enable/disable logging. Choices: `"disable"` `"enable"`
port any	(list) Single port number or port number range for CIFS.
prefer_chunking aliases: prefer-chunking string	Select dynamic or fixed-size data chunking for WAN Optimization. Choices: `"dynamic"` `"fix"`
protocol_opt aliases: protocol-opt string	Select Protocol specific optimitation or generic TCP optimization. Choices: `"protocol"` `"tcp"`
secure_tunnel aliases: secure-tunnel string	Enable/disable securing the WAN Opt tunnel using SSL. Choices: `"disable"` `"enable"`
status string	Enable/disable WAN Optimization. Choices: `"disable"` `"enable"`
tunnel_sharing aliases: tunnel-sharing string	Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols. Choices: `"private"` `"shared"` `"express-shared"`
comments string	Comment.
ftp dictionary	Ftp.
byte_caching aliases: byte-caching string	Enable/disable byte-caching. Choices: `"disable"` `"enable"`
log_traffic aliases: log-traffic string	Enable/disable logging. Choices: `"disable"` `"enable"`
port any	(list) Single port number or port number range for FTP.
prefer_chunking aliases: prefer-chunking string	Select dynamic or fixed-size data chunking for WAN Optimization. Choices: `"dynamic"` `"fix"`
protocol_opt aliases: protocol-opt string	Select Protocol specific optimitation or generic TCP optimization. Choices: `"protocol"` `"tcp"`
secure_tunnel aliases: secure-tunnel string	Enable/disable securing the WAN Opt tunnel using SSL. Choices: `"disable"` `"enable"`
ssl string	Enable/disable SSL/TLS offloading Choices: `"disable"` `"enable"`
status string	Enable/disable WAN Optimization. Choices: `"disable"` `"enable"`
tunnel_sharing aliases: tunnel-sharing string	Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols. Choices: `"private"` `"shared"` `"express-shared"`
http dictionary	Http.
byte_caching aliases: byte-caching string	Enable/disable byte-caching. Choices: `"disable"` `"enable"`
log_traffic aliases: log-traffic string	Enable/disable logging. Choices: `"disable"` `"enable"`
port any	(list) Single port number or port number range for HTTP.
prefer_chunking aliases: prefer-chunking string	Select dynamic or fixed-size data chunking for WAN Optimization. Choices: `"dynamic"` `"fix"`
protocol_opt aliases: protocol-opt string	Select Protocol specific optimitation or generic TCP optimization. Choices: `"protocol"` `"tcp"`
secure_tunnel aliases: secure-tunnel string	Enable/disable securing the WAN Opt tunnel using SSL. Choices: `"disable"` `"enable"`
ssl string	Enable/disable SSL/TLS offloading Choices: `"disable"` `"enable"`
ssl_port aliases: ssl-port any	(list) Port on which to expect HTTPS traffic for SSL/TLS offloading.
status string	Enable/disable WAN Optimization. Choices: `"disable"` `"enable"`
tunnel_non_http aliases: tunnel-non-http string	Configure how to process non-HTTP traffic when a profile configured for HTTP traffic accepts a non-HTTP session. Choices: `"disable"` `"enable"`
tunnel_sharing aliases: tunnel-sharing string	Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols. Choices: `"private"` `"shared"` `"express-shared"`
unknown_http_version aliases: unknown-http-version string	How to handle HTTP sessions that do not comply with HTTP 0. Choices: `"best-effort"` `"reject"` `"tunnel"`
mapi dictionary	Mapi.
byte_caching aliases: byte-caching string	Enable/disable byte-caching. Choices: `"disable"` `"enable"`
log_traffic aliases: log-traffic string	Enable/disable logging. Choices: `"disable"` `"enable"`
port any	(list) Single port number or port number range for MAPI.
secure_tunnel aliases: secure-tunnel string	Enable/disable securing the WAN Opt tunnel using SSL. Choices: `"disable"` `"enable"`
status string	Enable/disable WAN Optimization. Choices: `"disable"` `"enable"`
tunnel_sharing aliases: tunnel-sharing string	Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols. Choices: `"private"` `"shared"` `"express-shared"`
name string / required	Profile name.
tcp dictionary	Tcp.
byte_caching aliases: byte-caching string	Enable/disable byte-caching. Choices: `"disable"` `"enable"`
byte_caching_opt aliases: byte-caching-opt string	Select whether TCP byte-caching uses system memory only or both memory and disk space. Choices: `"mem-only"` `"mem-disk"`
log_traffic aliases: log-traffic string	Enable/disable logging. Choices: `"disable"` `"enable"`
port string	Port numbers or port number ranges for TCP.
secure_tunnel aliases: secure-tunnel string	Enable/disable securing the WAN Opt tunnel using SSL. Choices: `"disable"` `"enable"`
ssl string	Enable/disable SSL/TLS offloading Choices: `"disable"` `"enable"`
ssl_port aliases: ssl-port any	(list) Port numbers or port number ranges on which to expect HTTPS traffic for SSL/TLS offloading.
status string	Enable/disable WAN Optimization. Choices: `"disable"` `"enable"`
tunnel_sharing aliases: tunnel-sharing string	Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols. Choices: `"private"` `"shared"` `"express-shared"`
transparent string	Enable/disable transparent mode. Choices: `"disable"` `"enable"`
workspace_locking_adom string	The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.
workspace_locking_timeout integer	The maximum time in seconds to wait for other user to release the workspace lock. Default: `300`

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
meta dictionary	The result of the request. Returned: always
request_url string	The full url requested. Returned: always Sample: `"/sys/login/user"`
response_code integer	The status of api request. Returned: always Sample: `0`
response_data list / elements=string	The api response. Returned: always
response_message string	The descriptive message of the api response. Returned: always Sample: `"OK."`
system_information dictionary	The information of the target system. Returned: always
rc integer	The status the request. Returned: always Sample: `0`
version_check_warning list / elements=string	Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex

Authors

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

fortinet.fortimanager.fmgr_wanopt_profile module – Configure WAN optimization profiles.

Synopsis

Parameters

Notes

Examples

Return Values