fortinet.fortimanager.fmgr_firewall_profileprotocoloptions_ftp module – Configure FTP protocol options.
Note
This module is part of the fortinet.fortimanager collection (version 2.7.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install fortinet.fortimanager.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_firewall_profileprotocoloptions_ftp.
New in fortinet.fortimanager 2.0.0
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 |
Comments |
|---|---|
The token to access FortiManager without using username and password. |
|
The parameter (adom) in requested url. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
The top level parameters set. |
|
Deprecated, please rename it to comfort_amount. Amount of data to send in a transmission for client comforting |
|
Deprecated, please rename it to comfort_interval. Period of time between start, or last transmission, and the next client … |
|
Deprecated, please rename it to explicit_ftp_tls. Enable/disable FTP redirection for explicit FTPS. Choices:
|
|
Deprecated, please rename it to inspect_all. Enable/disable the inspection of all ports for the protocol. Choices:
|
|
One or more options that can be applied to the session. Choices:
|
|
Deprecated, please rename it to oversize_limit. Maximum in-memory file size that can be scanned |
|
(list) Ports to scan for content |
|
Deprecated, please rename it to scan_bzip2. Enable/disable scanning of BZip2 compressed files. Choices:
|
|
Deprecated, please rename it to ssl_offloaded. SSL decryption and encryption performed by an external device. Choices:
|
|
Enable/disable the active status of scanning for this protocol. Choices:
|
|
Deprecated, please rename it to stream_based_uncompressed_limit. Maximum stream-based uncompressed data size that will be … |
|
Deprecated, please rename it to tcp_window_maximum. Maximum dynamic TCP window size. |
|
Deprecated, please rename it to tcp_window_minimum. Minimum dynamic TCP window size. |
|
Deprecated, please rename it to tcp_window_size. Set TCP static window size. |
|
Deprecated, please rename it to tcp_window_type. TCP window type to use for this protocol. Choices:
|
|
Deprecated, please rename it to uncompressed_nest_limit. Maximum nested levels of compression that can be uncompressed and… |
|
Deprecated, please rename it to uncompressed_oversize_limit. Maximum in-memory uncompressed file size that can be scanned |
|
Authenticate Ansible client with forticloud API access token. |
|
Deprecated, please use “profile_protocol_options” |
|
The parameter (profile-protocol-options) in requested url. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
Notes
Note
Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
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.
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 FTP protocol options.
fortinet.fortimanager.fmgr_firewall_profileprotocoloptions_ftp:
# 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_protocol_options: <your own value>
firewall_profileprotocoloptions_ftp:
comfort_amount: <integer>
comfort_interval: <integer>
inspect_all: <value in [disable, enable]>
options:
- clientcomfort
- no-content-summary
- oversize
- splice
- bypass-rest-command
- bypass-mode-command
oversize_limit: <integer>
ports: <list or integer>
scan_bzip2: <value in [disable, enable]>
status: <value in [disable, enable]>
uncompressed_nest_limit: <integer>
uncompressed_oversize_limit: <integer>
ssl_offloaded: <value in [no, yes]>
stream_based_uncompressed_limit: <integer>
tcp_window_maximum: <integer>
tcp_window_minimum: <integer>
tcp_window_size: <integer>
tcp_window_type: <value in [system, static, dynamic, ...]>
explicit_ftp_tls: <value in [disable, enable]>
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |