fortinet.fortimanager.fmgr_filefilter_profile (2.4.0) — module

Install collection

Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0

Add to requirements.yml

  collections:
    - name: fortinet.fortimanager
      version: 2.4.0

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.

- 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 file-filter profiles.
      fortinet.fortimanager.fmgr_filefilter_profile:
        # 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>
        state: present # <value in [present, absent]>
        filefilter_profile:
          comment: <string>
          extended_log: <value in [disable, enable]>
          feature_set: <value in [proxy, flow]>
          log: <value in [disable, enable]>
          name: <string>
          replacemsg_group: <string>
          rules:
            -
              action: <value in [log-only, block]>
              comment: <string>
              direction: <value in [any, incoming, outgoing]>
              file_type: <list or string>
              name: <string>
              password_protected: <value in [any, yes]>
              protocol:
                - imap
                - smtp
                - pop3
                - http
                - ftp
                - mapi
                - cifs
                - ssh
          scan_archive_contents: <value in [disable, enable]>

Inputs

    
adom:
    description: The parameter (adom) in requested url.
    required: true
    type: str

state:
    choices:
    - present
    - absent
    description: The directive to create, update or delete an object.
    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

filefilter_profile:
    description: The top level parameters set.
    required: false
    suboptions:
      comment:
        description: Comment.
        type: str
      extended-log:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to extended_log. Enable/disable file-filter
          extended logging.
        type: str
      feature-set:
        choices:
        - proxy
        - flow
        description: Deprecated, please rename it to feature_set. Flow/proxy feature set.
        type: str
      log:
        choices:
        - disable
        - enable
        description: Enable/disable file-filter logging.
        type: str
      name:
        description: Profile name.
        required: true
        type: str
      replacemsg-group:
        description: Deprecated, please rename it to replacemsg_group. Replacement message
          group
        type: str
      rules:
        description: Rules.
        elements: dict
        suboptions:
          action:
            choices:
            - log-only
            - block
            description: Action taken for matched file.
            type: str
          comment:
            description: Comment.
            type: str
          direction:
            choices:
            - any
            - incoming
            - outgoing
            description: Traffic direction.
            type: str
          file-type:
            description: (list) Deprecated, please rename it to file_type. Select file
              type.
            type: raw
          name:
            description: File-filter rule name.
            type: str
          password-protected:
            choices:
            - any
            - 'yes'
            description: Deprecated, please rename it to password_protected. Match password-protected
              files.
            type: str
          protocol:
            choices:
            - imap
            - smtp
            - pop3
            - http
            - ftp
            - mapi
            - cifs
            - ssh
            description: Protocols to apply rule to.
            elements: str
            type: list
        type: list
      scan-archive-contents:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to scan_archive_contents. Enable/disable
          archive contents scan.
        type: str
    type: dict

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

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

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