fortinet.fortimanager.fmgr_firewall_profileprotocoloptions_cifs module – Configure CIFS protocol options.
Note
This module is part of the fortinet.fortimanager collection (version 2.8.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_cifs.
New in fortinet.fortimanager 2.1.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. |
|
Domain for which to decrypt CIFS traffic. |
|
File filter. |
|
Entries. |
|
Action taken for matched file. Choices:
|
|
Comment. |
|
Match files transmitted in the sessions originating or reply direction. Choices:
|
|
(list) Select file type. |
|
Add a file filter. |
|
Protocols to apply with. Choices:
|
|
Enable/disable file filter logging. Choices:
|
|
Enable/disable file filter. Choices:
|
|
One or more options that can be applied to the session. Choices:
|
|
Maximum in-memory file size that can be scanned |
|
(list) Ports to scan for content |
|
Enable/disable scanning of BZip2 compressed files. Choices:
|
|
CIFS server credential type. Choices:
|
|
Server keytab. |
|
Base64 encoded keytab file containing credential of the server. |
|
(list) Password for keytab. |
|
Service principal. |
|
Enable/disable the active status of scanning for this protocol. Choices:
|
|
Maximum dynamic TCP window size |
|
Minimum dynamic TCP window size |
|
Set TCP static window size |
|
Specify type of TCP window to use for this protocol. Choices:
|
|
Maximum nested levels of compression that can be uncompressed and scanned |
|
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 CIFS protocol options.
fortinet.fortimanager.fmgr_firewall_profileprotocoloptions_cifs:
# 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_cifs:
ports: <list or integer>
status: <value in [disable, enable]>
options:
- "oversize"
oversize_limit: <integer>
scan_bzip2: <value in [disable, enable]>
tcp_window_maximum: <integer>
tcp_window_minimum: <integer>
tcp_window_size: <integer>
tcp_window_type: <value in [system, static, dynamic, ...]>
uncompressed_nest_limit: <integer>
uncompressed_oversize_limit: <integer>
domain_controller: <string>
file_filter:
entries:
-
action: <value in [log, block]>
comment: <string>
direction: <value in [any, incoming, outgoing]>
file_type: <list or string>
filter: <string>
protocol:
- "cifs"
log: <value in [disable, enable]>
status: <value in [disable, enable]>
server_credential_type: <value in [none, credential-replication, credential-keytab]>
server_keytab:
-
keytab: <string>
password: <list or string>
principal: <string>
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 |