fortinet.fortimanager.fmgr_firewall_profileprotocoloptions_cifs – Configure CIFS protocol options.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.1.3).

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 version 2.10: of fortinet.fortimanager

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 Choices/Defaults Comments
adom
string / required
the parameter (adom) in requested url
bypass_validation
boolean
    Choices:
  • no ←
  • yes
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
enable_log
boolean
    Choices:
  • no ←
  • yes
Enable/Disable logging for task
firewall_profileprotocoloptions_cifs
dictionary
the top level parameters set
domain-controller
string
Domain for which to decrypt CIFS traffic.
file-filter
dictionary
no description
entries
list / elements=string
no description
action
string
    Choices:
  • log
  • block
Action taken for matched file.
comment
string
Comment.
direction
string
    Choices:
  • any
  • incoming
  • outgoing
Match files transmitted in the sessions originating or reply direction.
file-type
string
no description
filter
string
Add a file filter.
protocol
list / elements=string
    Choices:
  • cifs
no description
log
string
    Choices:
  • disable
  • enable
Enable/disable file filter logging.
status
string
    Choices:
  • disable
  • enable
Enable/disable file filter.
options
list / elements=string
    Choices:
  • oversize
no description
oversize-limit
integer
Maximum in-memory file size that can be scanned (1 - 383 MB, default = 10).
ports
integer
no description
scan-bzip2
string
    Choices:
  • disable
  • enable
Enable/disable scanning of BZip2 compressed files.
server-credential-type
string
    Choices:
  • none
  • credential-replication
  • credential-keytab
CIFS server credential type.
server-keytab
list / elements=string
no description
keytab
string
Base64 encoded keytab file containing credential of the server.
password
string
no description
principal
string
Service principal. For example, "host/[email protected]".
status
string
    Choices:
  • disable
  • enable
Enable/disable the active status of scanning for this protocol.
tcp-window-maximum
integer
Maximum dynamic TCP window size (default = 8MB).
tcp-window-minimum
integer
Minimum dynamic TCP window size (default = 128KB).
tcp-window-size
integer
Set TCP static window size (default = 256KB).
tcp-window-type
string
    Choices:
  • system
  • static
  • dynamic
Specify type of TCP window to use for this protocol.
uncompressed-nest-limit
integer
Maximum nested levels of compression that can be uncompressed and scanned (2 - 100, default = 12).
uncompressed-oversize-limit
integer
Maximum in-memory uncompressed file size that can be scanned (0 - 383 MB, 0 = unlimited, default = 10).
profile-protocol-options
string / required
the parameter (profile-protocol-options) in requested url
proposed_method
string
    Choices:
  • update
  • set
  • add
The overridden method for the underlying Json RPC request
rc_failed
list / elements=string
the rc codes list with which the conditions to fail will be overriden
rc_succeeded
list / elements=string
the rc codes list with which the conditions to succeed will be overriden
state
string / required
    Choices:
  • present
  • absent
the directive to create, update or delete an object
workspace_locking_adom
string
the adom to lock for FortiManager running in workspace mode, the value can be global and others including root
workspace_locking_timeout
integer
Default:
300
the maximum time in seconds to wait for other user to release the workspace lock

Notes

Note

  • 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.

  • To create or update an object, use state present directive.

  • To delete an object, use state absent directive.

  • 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

- 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 CIFS protocol options.
     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: <value of integer>
           status: <value in [disable, enable]>
           options:
             - oversize
           oversize-limit: <value of integer>
           scan-bzip2: <value in [disable, enable]>
           tcp-window-maximum: <value of integer>
           tcp-window-minimum: <value of integer>
           tcp-window-size: <value of integer>
           tcp-window-type: <value in [system, static, dynamic]>
           uncompressed-nest-limit: <value of integer>
           uncompressed-oversize-limit: <value of integer>
           domain-controller: <value of string>
           file-filter:
              entries:
                -
                    action: <value in [log, block]>
                    comment: <value of string>
                    direction: <value in [any, incoming, outgoing]>
                    file-type: <value of string>
                    filter: <value of 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: <value of string>
                 password: <value of string>
                 principal: <value of string>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
request_url
string
always
The full url requested

Sample:
/sys/login/user
response_code
integer
always
The status of api request

response_message
string
always
The descriptive message of the api response

Sample:
OK.


Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)