W3cubDocs

/Ansible 2.11

fortinet.fortimanager.fmgr_wanopt_profile_http – Enable/disable HTTP WAN Optimization and configure HTTP WAN Optimization features.

Note

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

To install it use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_wanopt_profile_http.

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
profile
string / required
the parameter (profile) in requested url
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_http
dictionary
the top level parameters set
byte-caching
string
    Choices:
  • disable
  • enable
Enable/disable byte-caching for HTTP. Byte caching reduces the amount of traffic by caching file data sent across the WAN and ...
log-traffic
string
    Choices:
  • disable
  • enable
Enable/disable logging.
port
integer
no description
prefer-chunking
string
    Choices:
  • dynamic
  • fix
Select dynamic or fixed-size data chunking for HTTP WAN 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 HTTPS traffic in this tunnel.
ssl-port
integer
no description
status
string
    Choices:
  • disable
  • enable
Enable/disable HTTP WAN Optimization.
tunnel-non-http
string
    Choices:
  • disable
  • enable
Configure how to process non-HTTP traffic when a profile configured for HTTP traffic accepts a non-HTTP session. Can occur if ...
tunnel-sharing
string
    Choices:
  • private
  • shared
  • express-shared
Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols.
unknown-http-version
string
    Choices:
  • best-effort
  • reject
  • tunnel
How to handle HTTP sessions that do not comply with HTTP 0.9, 1.0, or 1.1.
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: Enable/disable HTTP WAN Optimization and configure HTTP WAN Optimization features.
     fmgr_wanopt_profile_http:
        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>
        profile: <your own value>
        wanopt_profile_http:
           byte-caching: <value in [disable, enable]>
           log-traffic: <value in [disable, enable]>
           port: <value of integer>
           prefer-chunking: <value in [dynamic, fix]>
           secure-tunnel: <value in [disable, enable]>
           ssl: <value in [disable, enable]>
           ssl-port: <value of integer>
           status: <value in [disable, enable]>
           tunnel-non-http: <value in [disable, enable]>
           tunnel-sharing: <value in [private, shared, express-shared]>
           unknown-http-version: <value in [best-effort, reject, tunnel]>

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/2.11/collections/fortinet/fortimanager/fmgr_wanopt_profile_http_module.html