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

Note

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

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 version 2.10: of fortinet.fortimanager

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

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:

  • no ← (default)

  • yes

enable_log

boolean

Enable/Disable logging for task

Choices:

  • no ← (default)

  • yes

proposed_method

string

The overridden method for the underlying Json RPC request

Choices:

  • update

  • set

  • add

rc_failed

list / elements=string

the rc codes list with which the conditions to fail will be overriden

rc_succeeded

list / elements=string

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

string

Optionally add an authentication group to restrict access to the WAN Optimization tunnel to peers in the authentication group.

cifs

dictionary

no description

byte-caching

string

Enable/disable byte-caching. Byte caching reduces the amount of traffic by caching file data sent across the WAN and i…

Choices:

  • disable

  • enable

log-traffic

string

Enable/disable logging.

Choices:

  • disable

  • enable

prefer-chunking

string

Select dynamic or fixed-size data chunking for WAN Optimization.

Choices:

  • dynamic

  • fix

protocol-opt

string

Select Protocol specific optimitation or generic TCP optimization.

Choices:

  • protocol

  • tcp

secure-tunnel

string

Enable/disable securing the WAN Opt tunnel using SSL. Secure and non-secure tunnels use the same TCP port (7810).

Choices:

  • disable

  • enable

status

string

Enable/disable WAN Optimization.

Choices:

  • disable

  • enable

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

no description

byte-caching

string

Enable/disable byte-caching. Byte caching reduces the amount of traffic by caching file data sent across the WAN and i…

Choices:

  • disable

  • enable

log-traffic

string

Enable/disable logging.

Choices:

  • disable

  • enable

prefer-chunking

string

Select dynamic or fixed-size data chunking for WAN Optimization.

Choices:

  • dynamic

  • fix

protocol-opt

string

Select Protocol specific optimitation or generic TCP optimization.

Choices:

  • protocol

  • tcp

secure-tunnel

string

Enable/disable securing the WAN Opt tunnel using SSL. Secure and non-secure tunnels use the same TCP port (7810).

Choices:

  • disable

  • enable

ssl

string

Enable/disable SSL/TLS offloading (hardware acceleration) for traffic in this tunnel.

Choices:

  • disable

  • enable

status

string

Enable/disable WAN Optimization.

Choices:

  • disable

  • enable

tunnel-sharing

string

Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols.

Choices:

  • private

  • shared

  • express-shared

http

dictionary

no description

byte-caching

string

Enable/disable byte-caching. Byte caching reduces the amount of traffic by caching file data sent across the WAN and i…

Choices:

  • disable

  • enable

log-traffic

string

Enable/disable logging.

Choices:

  • disable

  • enable

prefer-chunking

string

Select dynamic or fixed-size data chunking for WAN Optimization.

Choices:

  • dynamic

  • fix

protocol-opt

string

Select Protocol specific optimitation or generic TCP optimization.

Choices:

  • protocol

  • tcp

secure-tunnel

string

Enable/disable securing the WAN Opt tunnel using SSL. Secure and non-secure tunnels use the same TCP port (7810).

Choices:

  • disable

  • enable

ssl

string

Enable/disable SSL/TLS offloading (hardware acceleration) for traffic in this tunnel.

Choices:

  • disable

  • enable

status

string

Enable/disable WAN Optimization.

Choices:

  • disable

  • enable

tunnel-sharing

string

Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols.

Choices:

  • private

  • shared

  • express-shared

mapi

dictionary

no description

byte-caching

string

Enable/disable byte-caching. Byte caching reduces the amount of traffic by caching file data sent across the WAN and i…

Choices:

  • disable

  • enable

log-traffic

string

Enable/disable logging.

Choices:

  • disable

  • enable

secure-tunnel

string

Enable/disable securing the WAN Opt tunnel using SSL. Secure and non-secure tunnels use the same TCP port (7810).

Choices:

  • disable

  • enable

status

string

Enable/disable WAN Optimization.

Choices:

  • disable

  • enable

tunnel-sharing

string

Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols.

Choices:

  • private

  • shared

  • express-shared

name

string

Profile name.

tcp

dictionary

no description

byte-caching

string

Enable/disable byte-caching. Byte caching reduces the amount of traffic by caching file data sent across the WAN and i…

Choices:

  • disable

  • enable

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

string

Enable/disable logging.

Choices:

  • disable

  • enable

port

string

Port numbers or port number ranges for TCP. Only packets with a destination port number that matches this port number …

secure-tunnel

string

Enable/disable securing the WAN Opt tunnel using SSL. Secure and non-secure tunnels use the same TCP port (7810).

Choices:

  • disable

  • enable

ssl

string

Enable/disable SSL/TLS offloading (hardware acceleration) for traffic in this tunnel.

Choices:

  • disable

  • enable

ssl-port

integer

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

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

  • 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

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure WAN optimization profiles.
     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: <value in [present, absent]>
        wanopt_profile:
           auth-group: <value of string>
           comments: <value of string>
           name: <value of 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]>
           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]>
           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]>
           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]>
           tcp:
              byte-caching: <value in [disable, enable]>
              byte-caching-opt: <value in [mem-only, mem-disk]>
              log-traffic: <value in [disable, enable]>
              port: <value of string>
              secure-tunnel: <value in [disable, enable]>
              ssl: <value in [disable, enable]>
              ssl-port: <value of 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

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_message

string

The descriptive message of the api response

Returned: always

Sample: “OK.”

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)