lix_fortinet.fortios.fortios_file_filter_profile (102.2.120) — module

Install collection

Install with ansible-galaxy collection install lix_fortinet.fortios:==102.2.120

Add to requirements.yml

  collections:
    - name: lix_fortinet.fortios
      version: 102.2.120

Description

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify file_filter feature and profile category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements

• ansible>=2.9

Usage examples

Scanned by Steampunk Spotter

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

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure file-filter profiles.
    fortios_file_filter_profile:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      file_filter_profile:
        comment: "Comment."
        extended_log: "disable"
        feature_set: "flow"
        log: "disable"
        name: "default_name_7"
        replacemsg_group: "<your_own_value> (source system.replacemsg-group.name)"
        rules:
         -
            action: "log-only"
            comment: "Comment."
            direction: "incoming"
            file_type:
             -
                name: "default_name_14 (source antivirus.filetype.name)"
            name: "default_name_15"
            password_protected: "yes"
            protocol: "http"
        scan_archive_contents: "disable"

Inputs

    
vdom:
    default: root
    description:
    - Virtual domain, among those defined previously. A vdom is a virtual instance of
      the FortiGate that can be configured and used as a different unit.
    type: str

state:
    choices:
    - present
    - absent
    description:
    - Indicates whether to create or remove the object.
    required: true
    type: str

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

member_path:
    description:
    - Member attribute path to operate on.
    - Delimited by a slash character if there are more than one attribute.
    - Parameter marked with member_path is legitimate for doing member operation.
    type: str

access_token:
    description:
    - Token-based authentication. Generated from GUI of Fortigate.
    required: false
    type: str

member_state:
    choices:
    - present
    - absent
    description:
    - Add or delete a member under specified attribute path.
    - When member_state is specified, the state option is ignored.
    type: str

file_filter_profile:
    default: null
    description:
    - Configure file-filter profiles.
    suboptions:
      comment:
        description:
        - Comment.
        type: str
      extended_log:
        choices:
        - disable
        - enable
        description:
        - Enable/disable file-filter extended logging.
        type: str
      feature_set:
        choices:
        - flow
        - proxy
        description:
        - 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:
        - Replacement message group. Source system.replacemsg-group.name.
        type: str
      rules:
        description:
        - File filter rules.
        elements: dict
        suboptions:
          action:
            choices:
            - log-only
            - block
            description:
            - Action taken for matched file.
            type: str
          comment:
            description:
            - Comment.
            type: str
          direction:
            choices:
            - incoming
            - outgoing
            - any
            description:
            - Traffic direction (HTTP, FTP, SSH, CIFS only).
            type: str
          file_type:
            description:
            - Select file type.
            elements: dict
            suboptions:
              name:
                description:
                - File type name. Source antivirus.filetype.name.
                type: str
            type: list
          name:
            description:
            - File-filter rule name.
            type: str
          password_protected:
            choices:
            - 'yes'
            - any
            description:
            - Match password-protected files.
            type: str
          protocol:
            choices:
            - http
            - ftp
            - smtp
            - imap
            - pop3
            - mapi
            - cifs
            - ssh
            description:
            - Protocols to apply rule to.
            elements: str
            type: list
        type: list
      scan_archive_contents:
        choices:
        - disable
        - enable
        description:
        - Enable/disable archive contents scan.
        type: str
    type: dict

Outputs

build:
  description: Build number of the fortigate image
  returned: always
  sample: '1547'
  type: str
http_method:
  description: Last method used to provision the content into FortiGate
  returned: always
  sample: PUT
  type: str
http_status:
  description: Last result given by FortiGate on last operation applied
  returned: always
  sample: '200'
  type: str
mkey:
  description: Master key (id) used in the last call to FortiGate
  returned: success
  sample: id
  type: str
name:
  description: Name of the table used to fulfill the request
  returned: always
  sample: urlfilter
  type: str
path:
  description: Path of the table used to fulfill the request
  returned: always
  sample: webfilter
  type: str
revision:
  description: Internal revision number
  returned: always
  sample: 17.0.2.10658
  type: str
serial:
  description: Serial number of the unit
  returned: always
  sample: FGVMEVYYQT3AB5352
  type: str
status:
  description: Indication of the operation's result
  returned: always
  sample: success
  type: str
vdom:
  description: Virtual domain used
  returned: always
  sample: root
  type: str
version:
  description: Version of the FortiGate
  returned: always
  sample: v5.6.3
  type: str