fortinet.fortios.fortios_antivirus_quarantine (2.3.6) — module

Configure quarantine options in Fortinet's FortiOS and FortiGate.

| "added in version" 2.0.0 of fortinet.fortios"

Authors: Link Zheng (@chillancezen), Jie Xue (@JieX19), Hongbin Lu (@fgtdev-hblu), Frank Shen (@frankshen01), Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)

preview | supported by community

Install collection

Install with ansible-galaxy collection install fortinet.fortios:==2.3.6


Add to requirements.yml

  collections:
    - name: fortinet.fortios
      version: 2.3.6

Description

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


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Configure quarantine options.
  fortinet.fortios.fortios_antivirus_quarantine:
      vdom: "{{ vdom }}"
      antivirus_quarantine:
          agelimit: "0"
          destination: "NULL"
          drop_blocked: "imap"
          drop_heuristic: "imap"
          drop_infected: "imap"
          drop_intercepted: "imap"
          drop_machine_learning: "imap"
          lowspace: "drop-new"
          maxfilesize: "0"
          quarantine_quota: "0"
          store_blocked: "imap"
          store_heuristic: "imap"
          store_infected: "imap"
          store_intercepted: "imap"
          store_machine_learning: "imap"

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

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

antivirus_quarantine:
    default: null
    description:
    - Configure quarantine options.
    suboptions:
      agelimit:
        description:
        - Age limit for quarantined files (0 - 479 hours, 0 means forever).
        type: int
      destination:
        choices:
        - 'NULL'
        - disk
        - FortiAnalyzer
        description:
        - Choose whether to quarantine files to the FortiGate disk or to FortiAnalyzer
          or to delete them instead of quarantining them.
        type: str
      drop_blocked:
        choices:
        - imap
        - smtp
        - pop3
        - http
        - ftp
        - nntp
        - imaps
        - smtps
        - pop3s
        - https
        - ftps
        - mapi
        - cifs
        - ssh
        - mm1
        - mm3
        - mm4
        - mm7
        description:
        - Do not quarantine dropped files found in sessions using the selected protocols.
          Dropped files are deleted instead of being quarantined.
        elements: str
        type: list
      drop_heuristic:
        choices:
        - imap
        - smtp
        - pop3
        - http
        - ftp
        - nntp
        - imaps
        - smtps
        - pop3s
        - https
        - ftps
        - mapi
        - cifs
        - ssh
        - mm1
        - mm3
        - mm4
        - mm7
        description:
        - Do not quarantine files detected by heuristics found in sessions using the selected
          protocols. Dropped files are deleted instead of being quarantined.
        elements: str
        type: list
      drop_infected:
        choices:
        - imap
        - smtp
        - pop3
        - http
        - ftp
        - nntp
        - imaps
        - smtps
        - pop3s
        - https
        - ftps
        - mapi
        - cifs
        - ssh
        - mm1
        - mm3
        - mm4
        - mm7
        description:
        - Do not quarantine infected files found in sessions using the selected protocols.
          Dropped files are deleted instead of being quarantined.
        elements: str
        type: list
      drop_intercepted:
        choices:
        - imap
        - smtp
        - pop3
        - http
        - ftp
        - imaps
        - smtps
        - pop3s
        - https
        - ftps
        - mapi
        - mm1
        - mm3
        - mm4
        - mm7
        description:
        - drop intercepted from a protocol
        elements: str
        type: list
      drop_machine_learning:
        choices:
        - imap
        - smtp
        - pop3
        - http
        - ftp
        - nntp
        - imaps
        - smtps
        - pop3s
        - https
        - ftps
        - mapi
        - cifs
        - ssh
        description:
        - Do not quarantine files detected by machine learning found in sessions using
          the selected protocols. Dropped files are deleted instead of being quarantined.
        elements: str
        type: list
      lowspace:
        choices:
        - drop-new
        - ovrw-old
        description:
        - Select the method for handling additional files when running low on disk space.
        type: str
      maxfilesize:
        description:
        - Maximum file size to quarantine (0 - 500 Mbytes, 0 means unlimited).
        type: int
      quarantine_quota:
        description:
        - The amount of disk space to reserve for quarantining files (0 - 4294967295 Mbytes,
          depends on disk space).
        type: int
      store_blocked:
        choices:
        - imap
        - smtp
        - pop3
        - http
        - ftp
        - nntp
        - imaps
        - smtps
        - pop3s
        - https
        - ftps
        - mapi
        - cifs
        - ssh
        - mm1
        - mm3
        - mm4
        - mm7
        description:
        - Quarantine blocked files found in sessions using the selected protocols.
        elements: str
        type: list
      store_heuristic:
        choices:
        - imap
        - smtp
        - pop3
        - http
        - ftp
        - nntp
        - imaps
        - smtps
        - pop3s
        - https
        - ftps
        - mapi
        - cifs
        - ssh
        - mm1
        - mm3
        - mm4
        - mm7
        description:
        - Quarantine files detected by heuristics found in sessions using the selected
          protocols.
        elements: str
        type: list
      store_infected:
        choices:
        - imap
        - smtp
        - pop3
        - http
        - ftp
        - nntp
        - imaps
        - smtps
        - pop3s
        - https
        - ftps
        - mapi
        - cifs
        - ssh
        - mm1
        - mm3
        - mm4
        - mm7
        description:
        - Quarantine infected files found in sessions using the selected protocols.
        elements: str
        type: list
      store_intercepted:
        choices:
        - imap
        - smtp
        - pop3
        - http
        - ftp
        - imaps
        - smtps
        - pop3s
        - https
        - ftps
        - mapi
        - mm1
        - mm3
        - mm4
        - mm7
        description:
        - quarantine intercepted from a protocol
        elements: str
        type: list
      store_machine_learning:
        choices:
        - imap
        - smtp
        - pop3
        - http
        - ftp
        - nntp
        - imaps
        - smtps
        - pop3s
        - https
        - ftps
        - mapi
        - cifs
        - ssh
        description:
        - Quarantine files detected by machine learning found in sessions using the selected
          protocols.
        elements: str
        type: list
    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