Try SpotterConfigure CIFS protocol options.
| "added in version" 2.1.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 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>
adom:
description: The parameter (adom) in requested url.
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
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
profile-protocol-options:
description: Deprecated, please use "profile_protocol_options"
type: str
profile_protocol_options:
description: The parameter (profile-protocol-options) in requested url.
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
firewall_profileprotocoloptions_cifs:
description: The top level parameters set.
required: false
suboptions:
domain-controller:
description: Deprecated, please rename it to domain_controller. Domain for which
to decrypt CIFS traffic.
type: str
file-filter:
description: Deprecated, please rename it to file_filter.
suboptions:
entries:
description: No description.
elements: dict
suboptions:
action:
choices:
- log
- block
description: Action taken for matched file.
type: str
comment:
description: Comment.
type: str
direction:
choices:
- any
- incoming
- outgoing
description: Match files transmitted in the sessions originating or reply
direction.
type: str
file-type:
description: (list) Deprecated, please rename it to file_type.
type: raw
filter:
description: Add a file filter.
type: str
protocol:
choices:
- cifs
description: No description.
elements: str
type: list
type: list
log:
choices:
- disable
- enable
description: Enable/disable file filter logging.
type: str
status:
choices:
- disable
- enable
description: Enable/disable file filter.
type: str
type: dict
options:
choices:
- oversize
description: No description.
elements: str
type: list
oversize-limit:
description: Deprecated, please rename it to oversize_limit. Maximum in-memory
file size that can be scanned
type: int
ports:
description: (list) No description.
type: raw
scan-bzip2:
choices:
- disable
- enable
description: Deprecated, please rename it to scan_bzip2. Enable/disable scanning
of BZip2 compressed files.
type: str
server-credential-type:
choices:
- none
- credential-replication
- credential-keytab
description: Deprecated, please rename it to server_credential_type. CIFS server
credential type.
type: str
server-keytab:
description: Deprecated, please rename it to server_keytab.
elements: dict
suboptions:
keytab:
description: Base64 encoded keytab file containing credential of the server.
type: str
password:
description: (list) No description.
type: raw
principal:
description: Service principal.
type: str
type: list
status:
choices:
- disable
- enable
description: Enable/disable the active status of scanning for this protocol.
type: str
tcp-window-maximum:
description: Deprecated, please rename it to tcp_window_maximum. Maximum dynamic
TCP window size
type: int
tcp-window-minimum:
description: Deprecated, please rename it to tcp_window_minimum. Minimum dynamic
TCP window size
type: int
tcp-window-size:
description: Deprecated, please rename it to tcp_window_size. Set TCP static window
size
type: int
tcp-window-type:
choices:
- system
- static
- dynamic
- auto-tuning
description: Deprecated, please rename it to tcp_window_type. Specify type of
TCP window to use for this protocol.
type: str
uncompressed-nest-limit:
description: Deprecated, please rename it to uncompressed_nest_limit. Maximum
nested levels of compression that can be uncompressed and...
type: int
uncompressed-oversize-limit:
description: Deprecated, please rename it to uncompressed_oversize_limit. Maximum
in-memory uncompressed file size that can be scanned
type: int
type: dict
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