W3cubDocs

/Ansible

fortinet.fortimanager.fmgr_wanopt_profile – Configure WAN optimization profiles.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.1.3).

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 Choices/Defaults Comments
adom
string / required
the parameter (adom) in requested url
bypass_validation
boolean
    Choices:
  • no ←
  • yes
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
enable_log
boolean
    Choices:
  • no ←
  • yes
Enable/Disable logging for task
proposed_method
string
    Choices:
  • update
  • set
  • add
The overridden method for the underlying Json RPC request
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
    Choices:
  • present
  • absent
the directive to create, update or delete an object
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
    Choices:
  • disable
  • enable
Enable/disable byte-caching. Byte caching reduces the amount of traffic by caching file data sent across the WAN and i...
log-traffic
string
    Choices:
  • disable
  • enable
Enable/disable logging.
prefer-chunking
string
    Choices:
  • dynamic
  • fix
Select dynamic or fixed-size data chunking for WAN Optimization.
protocol-opt
string
    Choices:
  • protocol
  • tcp
Select Protocol specific optimitation or generic TCP optimization.
secure-tunnel
string
    Choices:
  • disable
  • enable
Enable/disable securing the WAN Opt tunnel using SSL. Secure and non-secure tunnels use the same TCP port (7810).
status
string
    Choices:
  • disable
  • enable
Enable/disable WAN Optimization.
tunnel-sharing
string
    Choices:
  • private
  • shared
  • express-shared
Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols.
comments
string
Comment.
ftp
dictionary
no description
byte-caching
string
    Choices:
  • disable
  • enable
Enable/disable byte-caching. Byte caching reduces the amount of traffic by caching file data sent across the WAN and i...
log-traffic
string
    Choices:
  • disable
  • enable
Enable/disable logging.
prefer-chunking
string
    Choices:
  • dynamic
  • fix
Select dynamic or fixed-size data chunking for WAN Optimization.
protocol-opt
string
    Choices:
  • protocol
  • tcp
Select Protocol specific optimitation or generic TCP optimization.
secure-tunnel
string
    Choices:
  • disable
  • enable
Enable/disable securing the WAN Opt tunnel using SSL. Secure and non-secure tunnels use the same TCP port (7810).
ssl
string
    Choices:
  • disable
  • enable
Enable/disable SSL/TLS offloading (hardware acceleration) for traffic in this tunnel.
status
string
    Choices:
  • disable
  • enable
Enable/disable WAN Optimization.
tunnel-sharing
string
    Choices:
  • private
  • shared
  • express-shared
Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols.
http
dictionary
no description
byte-caching
string
    Choices:
  • disable
  • enable
Enable/disable byte-caching. Byte caching reduces the amount of traffic by caching file data sent across the WAN and i...
log-traffic
string
    Choices:
  • disable
  • enable
Enable/disable logging.
prefer-chunking
string
    Choices:
  • dynamic
  • fix
Select dynamic or fixed-size data chunking for WAN Optimization.
protocol-opt
string
    Choices:
  • protocol
  • tcp
Select Protocol specific optimitation or generic TCP optimization.
secure-tunnel
string
    Choices:
  • disable
  • enable
Enable/disable securing the WAN Opt tunnel using SSL. Secure and non-secure tunnels use the same TCP port (7810).
ssl
string
    Choices:
  • disable
  • enable
Enable/disable SSL/TLS offloading (hardware acceleration) for traffic in this tunnel.
status
string
    Choices:
  • disable
  • enable
Enable/disable WAN Optimization.
tunnel-sharing
string
    Choices:
  • private
  • shared
  • express-shared
Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols.
mapi
dictionary
no description
byte-caching
string
    Choices:
  • disable
  • enable
Enable/disable byte-caching. Byte caching reduces the amount of traffic by caching file data sent across the WAN and i...
log-traffic
string
    Choices:
  • disable
  • enable
Enable/disable logging.
secure-tunnel
string
    Choices:
  • disable
  • enable
Enable/disable securing the WAN Opt tunnel using SSL. Secure and non-secure tunnels use the same TCP port (7810).
status
string
    Choices:
  • disable
  • enable
Enable/disable WAN Optimization.
tunnel-sharing
string
    Choices:
  • private
  • shared
  • express-shared
Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols.
name
string
Profile name.
tcp
dictionary
no description
byte-caching
string
    Choices:
  • disable
  • enable
Enable/disable byte-caching. Byte caching reduces the amount of traffic by caching file data sent across the WAN and i...
byte-caching-opt
string
    Choices:
  • mem-only
  • mem-disk
Select whether TCP byte-caching uses system memory only or both memory and disk space.
log-traffic
string
    Choices:
  • disable
  • enable
Enable/disable logging.
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
    Choices:
  • disable
  • enable
Enable/disable securing the WAN Opt tunnel using SSL. Secure and non-secure tunnels use the same TCP port (7810).
ssl
string
    Choices:
  • disable
  • enable
Enable/disable SSL/TLS offloading (hardware acceleration) for traffic in this tunnel.
ssl-port
integer
no description
status
string
    Choices:
  • disable
  • enable
Enable/disable WAN Optimization.
tunnel-sharing
string
    Choices:
  • private
  • shared
  • express-shared
Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols.
transparent
string
    Choices:
  • disable
  • enable
Enable/disable transparent mode.
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
Default:
300
the maximum time in seconds to wait for other user to release the workspace lock

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 Returned Description
request_url
string
always
The full url requested

Sample:
/sys/login/user
response_code
integer
always
The status of api request
response_message
string
always
The descriptive message of the api response

Sample:
OK.


Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_wanopt_profile_module.html