fmgr_wanopt_profile – Configure WAN optimization profiles.

Added in version 1.0.0.

Warning

Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).

  • Argument name before 3.0.0: var-name, var name, var.name

  • New argument name starting in 3.0.0: var_name

FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.

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.

  • Tested with FortiManager v6.x and v7.x.

Requirements

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

  • ansible>=2.15.0

FortiManager Version Compatibility

Supported Version Ranges: v6.0.0 -> latest

Parameters

  • access_token -The token to access FortiManager without using username and password. type: str required: false
  • 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
  • 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
  • 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
  • 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
  • adom - The parameter in requested url type: str required: true
  • wanopt_profile - Configure WAN optimization profiles. type: dict
    • auth_group (Alias name: 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 (Alias name: byte-caching) Enable/disable byte-caching. type: str choices: [disable, enable] more...
      • log_traffic (Alias name: log-traffic) Enable/disable logging. type: str choices: [disable, enable] more...
      • prefer_chunking (Alias name: prefer-chunking) Select dynamic or fixed-size data chunking for wan optimization. type: str choices: [dynamic, fix] more...
      • protocol_opt (Alias name: protocol-opt) Select protocol specific optimitation or generic tcp optimization. type: str choices: [protocol, tcp] more...
      • secure_tunnel (Alias name: 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 (Alias name: tunnel-sharing) Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols. type: str choices: [private, shared, express-shared] more...
      • port type: list more...
    • ftp type: dict
      • byte_caching (Alias name: byte-caching) Enable/disable byte-caching. type: str choices: [disable, enable] more...
      • log_traffic (Alias name: log-traffic) Enable/disable logging. type: str choices: [disable, enable] more...
      • prefer_chunking (Alias name: prefer-chunking) Select dynamic or fixed-size data chunking for wan optimization. type: str choices: [dynamic, fix] more...
      • protocol_opt (Alias name: protocol-opt) Select protocol specific optimitation or generic tcp optimization. type: str choices: [protocol, tcp] more...
      • secure_tunnel (Alias name: 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 (Alias name: tunnel-sharing) Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols. type: str choices: [private, shared, express-shared] more...
      • port type: list more...
    • http type: dict
      • byte_caching (Alias name: byte-caching) Enable/disable byte-caching. type: str choices: [disable, enable] more...
      • log_traffic (Alias name: log-traffic) Enable/disable logging. type: str choices: [disable, enable] more...
      • prefer_chunking (Alias name: prefer-chunking) Select dynamic or fixed-size data chunking for wan optimization. type: str choices: [dynamic, fix] more...
      • protocol_opt (Alias name: protocol-opt) Select protocol specific optimitation or generic tcp optimization. type: str choices: [protocol, tcp] more...
      • secure_tunnel (Alias name: 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 (Alias name: tunnel-sharing) Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols. type: str choices: [private, shared, express-shared] more...
      • tunnel_non_http (Alias name: tunnel-non-http) Configure how to process non-http traffic when a profile configured for http traffic accepts a non-http session. type: str choices: [disable, enable] more...
      • unknown_http_version (Alias name: unknown-http-version) How to handle http sessions that do not comply with http 0. type: str choices: [best-effort, reject, tunnel] more...
      • port type: list more...
      • ssl_port (Alias name: ssl-port) type: list more...
    • mapi type: dict
      • byte_caching (Alias name: byte-caching) Enable/disable byte-caching. type: str choices: [disable, enable] more...
      • log_traffic (Alias name: log-traffic) Enable/disable logging. type: str choices: [disable, enable] more...
      • secure_tunnel (Alias name: 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 (Alias name: tunnel-sharing) Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols. type: str choices: [private, shared, express-shared] more...
      • port type: list more...
    • tcp type: dict
      • byte_caching (Alias name: byte-caching) Enable/disable byte-caching. type: str choices: [disable, enable] more...
      • byte_caching_opt (Alias name: 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 (Alias name: 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 (Alias name: 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 (Alias name: ssl-port) Port numbers or port number ranges on which to expect https traffic for ssl/tls offloading. type: list more...
      • status Enable/disable wan optimization. type: str choices: [disable, enable] more...
      • tunnel_sharing (Alias name: 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

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

  • meta - The result of the request.returned: always type: dict
    • 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_data - The data body of the api response. returned: optional type: list or dict
    • response_message - The descriptive message of the api response. returned: always type: str sample: OK
    • system_information - The information of the target system. returned: always type: dict
  • rc - The status the request. returned: always type: int sample: 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list

Status

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

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)