Try SpotterConfigure WAN optimization profiles.
| "added in version" 1.0.0 of fortinet.fortimanager"
Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)
preview | supported by community
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections:
- name: fortinet.fortimanager
version: 2.4.0This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- 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]>
adom:
description: The parameter (adom) in requested url.
required: true
type: str
state:
choices:
- present
- absent
description: The directive to create, update or delete an object.
required: true
type: str
rc_failed:
description: The rc codes list with which the conditions to fail will be overriden.
elements: int
type: list
enable_log:
default: false
description: Enable/Disable logging for task.
type: bool
access_token:
description: The token to access FortiManager without using username and password.
type: str
rc_succeeded:
description: The rc codes list with which the conditions to succeed will be overriden.
elements: int
type: list
wanopt_profile:
description: The top level parameters set.
required: false
suboptions:
auth-group:
description: Deprecated, please rename it to auth_group. Optionally add an authentication
group to restrict access to the WAN Optimizat...
type: str
cifs:
description: No description.
suboptions:
byte-caching:
choices:
- disable
- enable
description: Deprecated, please rename it to byte_caching. Enable/disable
byte-caching.
type: str
log-traffic:
choices:
- disable
- enable
description: Deprecated, please rename it to log_traffic. Enable/disable logging.
type: str
port:
description: (list) No description.
type: raw
prefer-chunking:
choices:
- dynamic
- fix
description: Deprecated, please rename it to prefer_chunking. Select dynamic
or fixed-size data chunking for WAN Optimization.
type: str
protocol-opt:
choices:
- protocol
- tcp
description: Deprecated, please rename it to protocol_opt. Select Protocol
specific optimitation or generic TCP optimization.
type: str
secure-tunnel:
choices:
- disable
- enable
description: Deprecated, please rename it to secure_tunnel. Enable/disable
securing the WAN Opt tunnel using SSL.
type: str
status:
choices:
- disable
- enable
description: Enable/disable WAN Optimization.
type: str
tunnel-sharing:
choices:
- private
- shared
- express-shared
description: Deprecated, please rename it to tunnel_sharing. Tunnel sharing
mode for aggressive/non-aggressive and/or interacti...
type: str
type: dict
comments:
description: Comment.
type: str
ftp:
description: No description.
suboptions:
byte-caching:
choices:
- disable
- enable
description: Deprecated, please rename it to byte_caching. Enable/disable
byte-caching.
type: str
log-traffic:
choices:
- disable
- enable
description: Deprecated, please rename it to log_traffic. Enable/disable logging.
type: str
port:
description: (list) No description.
type: raw
prefer-chunking:
choices:
- dynamic
- fix
description: Deprecated, please rename it to prefer_chunking. Select dynamic
or fixed-size data chunking for WAN Optimization.
type: str
protocol-opt:
choices:
- protocol
- tcp
description: Deprecated, please rename it to protocol_opt. Select Protocol
specific optimitation or generic TCP optimization.
type: str
secure-tunnel:
choices:
- disable
- enable
description: Deprecated, please rename it to secure_tunnel. Enable/disable
securing the WAN Opt tunnel using SSL.
type: str
ssl:
choices:
- disable
- enable
description: Enable/disable SSL/TLS offloading
type: str
status:
choices:
- disable
- enable
description: Enable/disable WAN Optimization.
type: str
tunnel-sharing:
choices:
- private
- shared
- express-shared
description: Deprecated, please rename it to tunnel_sharing. Tunnel sharing
mode for aggressive/non-aggressive and/or interacti...
type: str
type: dict
http:
description: No description.
suboptions:
byte-caching:
choices:
- disable
- enable
description: Deprecated, please rename it to byte_caching. Enable/disable
byte-caching.
type: str
log-traffic:
choices:
- disable
- enable
description: Deprecated, please rename it to log_traffic. Enable/disable logging.
type: str
port:
description: (list) No description.
type: raw
prefer-chunking:
choices:
- dynamic
- fix
description: Deprecated, please rename it to prefer_chunking. Select dynamic
or fixed-size data chunking for WAN Optimization.
type: str
protocol-opt:
choices:
- protocol
- tcp
description: Deprecated, please rename it to protocol_opt. Select Protocol
specific optimitation or generic TCP optimization.
type: str
secure-tunnel:
choices:
- disable
- enable
description: Deprecated, please rename it to secure_tunnel. Enable/disable
securing the WAN Opt tunnel using SSL.
type: str
ssl:
choices:
- disable
- enable
description: Enable/disable SSL/TLS offloading
type: str
ssl-port:
description: (list) Deprecated, please rename it to ssl_port.
type: raw
status:
choices:
- disable
- enable
description: Enable/disable WAN Optimization.
type: str
tunnel-non-http:
choices:
- disable
- enable
description: Deprecated, please rename it to tunnel_non_http. Configure how
to process non-HTTP traffic when a profile configur...
type: str
tunnel-sharing:
choices:
- private
- shared
- express-shared
description: Deprecated, please rename it to tunnel_sharing. Tunnel sharing
mode for aggressive/non-aggressive and/or interacti...
type: str
unknown-http-version:
choices:
- best-effort
- reject
- tunnel
description: Deprecated, please rename it to unknown_http_version. How to
handle HTTP sessions that do not comply with HTTP 0.
type: str
type: dict
mapi:
description: No description.
suboptions:
byte-caching:
choices:
- disable
- enable
description: Deprecated, please rename it to byte_caching. Enable/disable
byte-caching.
type: str
log-traffic:
choices:
- disable
- enable
description: Deprecated, please rename it to log_traffic. Enable/disable logging.
type: str
port:
description: (list) No description.
type: raw
secure-tunnel:
choices:
- disable
- enable
description: Deprecated, please rename it to secure_tunnel. Enable/disable
securing the WAN Opt tunnel using SSL.
type: str
status:
choices:
- disable
- enable
description: Enable/disable WAN Optimization.
type: str
tunnel-sharing:
choices:
- private
- shared
- express-shared
description: Deprecated, please rename it to tunnel_sharing. Tunnel sharing
mode for aggressive/non-aggressive and/or interacti...
type: str
type: dict
name:
description: Profile name.
required: true
type: str
tcp:
description: No description.
suboptions:
byte-caching:
choices:
- disable
- enable
description: Deprecated, please rename it to byte_caching. Enable/disable
byte-caching.
type: str
byte-caching-opt:
choices:
- mem-only
- mem-disk
description: Deprecated, please rename it to byte_caching_opt. Select whether
TCP byte-caching uses system memory only or both ...
type: str
log-traffic:
choices:
- disable
- enable
description: Deprecated, please rename it to log_traffic. Enable/disable logging.
type: str
port:
description: Port numbers or port number ranges for TCP.
type: str
secure-tunnel:
choices:
- disable
- enable
description: Deprecated, please rename it to secure_tunnel. Enable/disable
securing the WAN Opt tunnel using SSL.
type: str
ssl:
choices:
- disable
- enable
description: Enable/disable SSL/TLS offloading
type: str
ssl-port:
description: (list) Deprecated, please rename it to ssl_port. Port numbers
or port number ranges on which to expect HTTPS traff...
type: raw
status:
choices:
- disable
- enable
description: Enable/disable WAN Optimization.
type: str
tunnel-sharing:
choices:
- private
- shared
- express-shared
description: Deprecated, please rename it to tunnel_sharing. Tunnel sharing
mode for aggressive/non-aggressive and/or interacti...
type: str
type: dict
transparent:
choices:
- disable
- enable
description: Enable/disable transparent mode.
type: str
type: dict
proposed_method:
choices:
- update
- set
- add
description: The overridden method for the underlying Json RPC request.
type: str
bypass_validation:
default: false
description: Only set to True when module schema diffs with FortiManager API structure,
module continues to execute without validating parameters.
type: bool
workspace_locking_adom:
description: The adom to lock for FortiManager running in workspace mode, the value
can be global and others including root.
type: str
forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
type: str
workspace_locking_timeout:
default: 300
description: The maximum time in seconds to wait for other user to release the workspace
lock.
type: int
meta:
contains:
request_url:
description: The full url requested.
returned: always
sample: /sys/login/user
type: str
response_code:
description: The status of api request.
returned: always
sample: 0
type: int
response_data:
description: The api response.
returned: always
type: list
response_message:
description: The descriptive message of the api response.
returned: always
sample: OK.
type: str
system_information:
description: The information of the target system.
returned: always
type: dict
description: The result of the request.
returned: always
type: dict
rc:
description: The status the request.
returned: always
sample: 0
type: int
version_check_warning:
description: Warning if the parameters used in the playbook are not supported by
the current FortiManager version.
returned: complex
type: list