fmgr_firewall_profileprotocoloptions_cifs – Configure CIFS protocol options.

New in version 2.10.

Synopsis

  • This module is able to configure a FortiManager device.
  • Examples include all parameters and values need to be adjusted to data sources before usage.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.9.0

FortiManager Version Compatibility


6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
firewall_profileprotocoloptions_cifs yes yes yes yes yes yes yes yes

Parameters

  • enable_log - Enable/Disable logging for task type: bool required: false default: False
  • forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0 type: str required: false
  • proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
  • bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters type: bool required: false default: False
  • workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom adom including root
  • workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
  • rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
  • rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
  • adom - The parameter in requested url type: str required: true
  • profile-protocol-options - The parameter in requested url type: str required: true
  • firewall_profileprotocoloptions_cifs - no description type: dict
    • ports - No description for the parameter type: int more...
    • status - Enable/disable the active status of scanning for this protocol. type: str choices: [disable, enable] more...
    • options - No description for the parameter type: array choices: [oversize] more...
    • oversize-limit - Maximum in-memory file size that can be scanned (1 - 383 MB, default = 10). type: int more...
    • scan-bzip2 - Enable/disable scanning of BZip2 compressed files. type: str choices: [disable, enable] more...
    • tcp-window-maximum - Maximum dynamic TCP window size (default = 8MB). type: int more...
    • tcp-window-minimum - Minimum dynamic TCP window size (default = 128KB). type: int more...
    • tcp-window-size - Set TCP static window size (default = 256KB). type: int more...
    • tcp-window-type - Specify type of TCP window to use for this protocol. type: str choices: [system, static, dynamic, auto-tuning] more...
    • uncompressed-nest-limit - Maximum nested levels of compression that can be uncompressed and scanned (2 - 100, default = 12). type: int more...
    • uncompressed-oversize-limit - Maximum in-memory uncompressed file size that can be scanned (0 - 383 MB, 0 = unlimited, default = 10). type: int more...
    • domain-controller - Domain for which to decrypt CIFS traffic. type: str more...
    • file-filter type: dict
      • entries - No description for the parameter type: array more...
        • action - Action taken for matched file. type: str choices: [log, block] more...
        • comment - Comment. type: str more...
        • direction - Match files transmitted in the sessions originating or reply direction. type: str choices: [any, incoming, outgoing] more...
        • file-type - No description for the parameter type: str more...
        • filter - Add a file filter. type: str more...
        • protocol - No description for the parameter type: array choices: [cifs] more...
      • log - Enable/disable file filter logging. type: str choices: [disable, enable] more...
      • status - Enable/disable file filter. type: str choices: [disable, enable] more...
    • server-credential-type - CIFS server credential type. type: str choices: [none, credential-replication, credential-keytab] more...
    • server-keytab - No description for the parameter type: array more...
      • keytab - Base64 encoded keytab file containing credential of the server. type: str more...
      • password - No description for the parameter type: str more...
      • principal - Service principal. type: str more...

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: no description
     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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

  • request_url - The full url requested returned: always type: str sample: /sys/login/user
  • response_code - The status of api request returned: always type: int sample: 0
  • response_message - The descriptive message of the api response returned: always type: str sample: OK
  • response_data - The data body of the api response returned: optional type: list or dict

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.