fmgr_wanopt_profile – Configure WAN optimization profiles.

New in version 2.10.

Synopsis

  • This module is able to configure a FortiManager device.
  • Examples include all parameters and values need to be adjusted to data sources before usage.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.9.0

FortiManager Version Compatibility


6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
wanopt_profile yes yes yes yes yes yes yes yes yes

Parameters

  • enable_log - Enable/Disable logging for task type: bool required: false default: False
  • forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0 type: str required: false
  • proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
  • bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters type: bool required: false default: False
  • workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom adom including root
  • workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
  • rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
  • rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
  • state - The directive to create, update or delete an object type: str required: true choices: present, absent
  • adom - The parameter in requested url type: str required: true
  • wanopt_profile - no description type: dict
    • auth-group - Optionally add an authentication group to restrict access to the WAN Optimization tunnel to peers in the authentication group. type: str more...
    • comments - Comment. type: str more...
    • name - Profile name. type: str more...
    • transparent - Enable/disable transparent mode. type: str choices: [disable, enable] more...
    • cifs type: dict
      • byte-caching - Enable/disable byte-caching. type: str choices: [disable, enable] more...
      • log-traffic - Enable/disable logging. type: str choices: [disable, enable] more...
      • prefer-chunking - Select dynamic or fixed-size data chunking for WAN Optimization. type: str choices: [dynamic, fix] more...
      • protocol-opt - Select Protocol specific optimitation or generic TCP optimization. type: str choices: [protocol, tcp] more...
      • secure-tunnel - Enable/disable securing the WAN Opt tunnel using SSL. type: str choices: [disable, enable] more...
      • status - Enable/disable WAN Optimization. type: str choices: [disable, enable] more...
      • tunnel-sharing - Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols. type: str choices: [private, shared, express-shared] more...
    • ftp type: dict
      • byte-caching - Enable/disable byte-caching. type: str choices: [disable, enable] more...
      • log-traffic - Enable/disable logging. type: str choices: [disable, enable] more...
      • prefer-chunking - Select dynamic or fixed-size data chunking for WAN Optimization. type: str choices: [dynamic, fix] more...
      • protocol-opt - Select Protocol specific optimitation or generic TCP optimization. type: str choices: [protocol, tcp] more...
      • secure-tunnel - Enable/disable securing the WAN Opt tunnel using SSL. type: str choices: [disable, enable] more...
      • ssl - Enable/disable SSL/TLS offloading (hardware acceleration) for traffic in this tunnel. type: str choices: [disable, enable] more...
      • status - Enable/disable WAN Optimization. type: str choices: [disable, enable] more...
      • tunnel-sharing - Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols. type: str choices: [private, shared, express-shared] more...
    • http type: dict
      • byte-caching - Enable/disable byte-caching. type: str choices: [disable, enable] more...
      • log-traffic - Enable/disable logging. type: str choices: [disable, enable] more...
      • prefer-chunking - Select dynamic or fixed-size data chunking for WAN Optimization. type: str choices: [dynamic, fix] more...
      • protocol-opt - Select Protocol specific optimitation or generic TCP optimization. type: str choices: [protocol, tcp] more...
      • secure-tunnel - Enable/disable securing the WAN Opt tunnel using SSL. type: str choices: [disable, enable] more...
      • ssl - Enable/disable SSL/TLS offloading (hardware acceleration) for traffic in this tunnel. type: str choices: [disable, enable] more...
      • status - Enable/disable WAN Optimization. type: str choices: [disable, enable] more...
      • tunnel-sharing - Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols. type: str choices: [private, shared, express-shared] more...
    • mapi type: dict
      • byte-caching - Enable/disable byte-caching. type: str choices: [disable, enable] more...
      • log-traffic - Enable/disable logging. type: str choices: [disable, enable] more...
      • secure-tunnel - Enable/disable securing the WAN Opt tunnel using SSL. type: str choices: [disable, enable] more...
      • status - Enable/disable WAN Optimization. type: str choices: [disable, enable] more...
      • tunnel-sharing - Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols. type: str choices: [private, shared, express-shared] more...
    • tcp type: dict
      • byte-caching - Enable/disable byte-caching. type: str choices: [disable, enable] more...
      • byte-caching-opt - Select whether TCP byte-caching uses system memory only or both memory and disk space. type: str choices: [mem-only, mem-disk] more...
      • log-traffic - Enable/disable logging. type: str choices: [disable, enable] more...
      • port - Port numbers or port number ranges for TCP. type: str more...
      • secure-tunnel - Enable/disable securing the WAN Opt tunnel using SSL. type: str choices: [disable, enable] more...
      • ssl - Enable/disable SSL/TLS offloading (hardware acceleration) for traffic in this tunnel. type: str choices: [disable, enable] more...
      • ssl-port - Port numbers or port number ranges on which to expect HTTPS traffic for SSL/TLS offloading. type: int more...
      • status - Enable/disable WAN Optimization. type: str choices: [disable, enable] more...
      • tunnel-sharing - Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols. type: str choices: [private, shared, express-shared] more...

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: no description
     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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

  • request_url - The full url requested returned: always type: str sample: /sys/login/user
  • response_code - The status of api request returned: always type: int sample: 0
  • response_message - The descriptive message of the api response returned: always type: str sample: OK
  • response_data - The data body of the api response returned: optional type: list or dict

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

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

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.