drmofu / drmofu.fortimanager / 2.2.2 / module / fmgr_wanopt_profile Configure WAN optimization profiles. | "added in version" 1.0.0 of drmofu.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 communitydrmofu.fortimanager.fmgr_wanopt_profile (2.2.2) — module
Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2
collections: - name: drmofu.fortimanager version: 2.2.2
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.
- 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]> port: <value of 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: <value of 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: <value of integer> ssl-port: <value of 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: <value of integer> 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]>
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 required: false type: list enable_log: default: false description: Enable/Disable logging for task. required: false type: bool access_token: description: The token to access FortiManager without using username and password. required: false type: str rc_succeeded: description: The rc codes list with which the conditions to succeed will be overriden. elements: int required: false type: list wanopt_profile: description: the top level parameters set required: false suboptions: auth-group: description: Optionally add an authentication group to restrict access to the WAN Optimization tunnel to peers in the authentication group. type: str cifs: description: no description required: false suboptions: byte-caching: choices: - disable - enable description: Enable/disable byte-caching. type: str log-traffic: choices: - disable - enable description: Enable/disable logging. type: str port: description: description type: int prefer-chunking: choices: - dynamic - fix description: Select dynamic or fixed-size data chunking for WAN Optimization. type: str protocol-opt: choices: - protocol - tcp description: Select Protocol specific optimitation or generic TCP optimization. type: str secure-tunnel: choices: - disable - enable description: 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: Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols. type: str type: dict comments: description: Comment. type: str ftp: description: no description required: false suboptions: byte-caching: choices: - disable - enable description: Enable/disable byte-caching. type: str log-traffic: choices: - disable - enable description: Enable/disable logging. type: str port: description: description type: int prefer-chunking: choices: - dynamic - fix description: Select dynamic or fixed-size data chunking for WAN Optimization. type: str protocol-opt: choices: - protocol - tcp description: Select Protocol specific optimitation or generic TCP optimization. type: str secure-tunnel: choices: - disable - enable description: 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: Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols. type: str type: dict http: description: no description required: false suboptions: byte-caching: choices: - disable - enable description: Enable/disable byte-caching. type: str log-traffic: choices: - disable - enable description: Enable/disable logging. type: str port: description: description type: int prefer-chunking: choices: - dynamic - fix description: Select dynamic or fixed-size data chunking for WAN Optimization. type: str protocol-opt: choices: - protocol - tcp description: Select Protocol specific optimitation or generic TCP optimization. type: str secure-tunnel: choices: - disable - enable description: 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: description type: int status: choices: - disable - enable description: Enable/disable WAN Optimization. type: str tunnel-non-http: choices: - disable - enable description: Configure how to process non-HTTP traffic when a profile configured for HTTP traffic accepts a non-HTTP session. type: str tunnel-sharing: choices: - private - shared - express-shared description: Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols. type: str unknown-http-version: choices: - best-effort - reject - tunnel description: How to handle HTTP sessions that do not comply with HTTP 0. type: str type: dict mapi: description: no description required: false suboptions: byte-caching: choices: - disable - enable description: Enable/disable byte-caching. type: str log-traffic: choices: - disable - enable description: Enable/disable logging. type: str port: description: description type: int secure-tunnel: choices: - disable - enable description: 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: Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols. type: str type: dict name: description: Profile name. type: str tcp: description: no description required: false suboptions: byte-caching: choices: - disable - enable description: Enable/disable byte-caching. type: str byte-caching-opt: choices: - mem-only - mem-disk description: Select whether TCP byte-caching uses system memory only or both memory and disk space. type: str log-traffic: choices: - disable - enable description: Enable/disable logging. type: str port: description: Port numbers or port number ranges for TCP. type: str secure-tunnel: choices: - disable - enable description: 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: Port numbers or port number ranges on which to expect HTTPS traffic for SSL/TLS offloading. type: int status: choices: - disable - enable description: Enable/disable WAN Optimization. type: str tunnel-sharing: choices: - private - shared - express-shared description: Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols. 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. required: false 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. required: false 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. required: false type: str forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. required: false type: str workspace_locking_timeout: default: 300 description: The maximum time in seconds to wait for other user to release the workspace lock. required: false 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