drmofu.fortimanager.fmgr_firewall_profileprotocoloptions_cifs (2.2.2) — module

Install collection

Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2

Add to requirements.yml

  collections:
    - name: drmofu.fortimanager
      version: 2.2.2

Description

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.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Inputs

    
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
    required: false
    type: list

enable_log:
    default: false
    description: Enable/Disable logging for task.
    required: false
    type: bool

access_token:
    description: The token to access FortiManager without using username and password.
    required: false
    type: str

rc_succeeded:
    description: The rc codes list with which the conditions to succeed will be overriden.
    elements: int
    required: false
    type: list

proposed_method:
    choices:
    - update
    - set
    - add
    description: The overridden method for the underlying Json RPC request.
    required: false
    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.
    required: false
    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.
    required: false
    type: str

forticloud_access_token:
    description: Authenticate Ansible client with forticloud API access token.
    required: false
    type: str

profile-protocol-options:
    description: the parameter (profile-protocol-options) in requested url
    required: true
    type: str

workspace_locking_timeout:
    default: 300
    description: The maximum time in seconds to wait for other user to release the workspace
      lock.
    required: false
    type: int

firewall_profileprotocoloptions_cifs:
    description: the top level parameters set
    required: false
    suboptions:
      domain-controller:
        description: Domain for which to decrypt CIFS traffic.
        type: str
      file-filter:
        description: no description
        required: false
        suboptions:
          entries:
            description: 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: description
                type: str
              filter:
                description: Add a file filter.
                type: str
              protocol:
                choices:
                - cifs
                description: 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: description
        elements: str
        type: list
      oversize-limit:
        description: Maximum in-memory file size that can be scanned
        type: int
      ports:
        description: description
        type: int
      scan-bzip2:
        choices:
        - disable
        - enable
        description: Enable/disable scanning of BZip2 compressed files.
        type: str
      server-credential-type:
        choices:
        - none
        - credential-replication
        - credential-keytab
        description: CIFS server credential type.
        type: str
      server-keytab:
        description: description
        elements: dict
        suboptions:
          keytab:
            description: Base64 encoded keytab file containing credential of the server.
            type: str
          password:
            description: description
            type: str
          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: Maximum dynamic TCP window size
        type: int
      tcp-window-minimum:
        description: Minimum dynamic TCP window size
        type: int
      tcp-window-size:
        description: Set TCP static window size
        type: int
      tcp-window-type:
        choices:
        - system
        - static
        - dynamic
        - auto-tuning
        description: Specify type of TCP window to use for this protocol.
        type: str
      uncompressed-nest-limit:
        description: Maximum nested levels of compression that can be uncompressed and
          scanned
        type: int
      uncompressed-oversize-limit:
        description: Maximum in-memory uncompressed file size that can be scanned
        type: int
    type: dict

Outputs

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