ansible.builtin.fortios_antivirus_quarantine (v2.8.20) — module

Configure quarantine options in Fortinet's FortiOS and FortiGate.

| "added in version" 2.8 of ansible.builtin"

Authors: Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.8.20

Description

This module is able to configure a FortiGate or FortiOS by allowing the user to configure antivirus feature and quarantine category. Examples includes all options and need to be adjusted to datasources before usage. Tested with FOS v6.0.2


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
  tasks:
  - name: Configure quarantine options.
    fortios_antivirus_quarantine:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      antivirus_quarantine:
        agelimit: "3"
        destination: "NULL"
        drop-blocked: "imap"
        drop-heuristic: "imap"
        drop-infected: "imap"
        lowspace: "drop-new"
        maxfilesize: "9"
        quarantine-quota: "10"
        store-blocked: "imap"
        store-heuristic: "imap"
        store-infected: "imap"

Inputs

    
host:
    description:
    - FortiOS or FortiGate ip address.
    required: true

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.

https:
    default: false
    description:
    - Indicates if the requests towards FortiGate must use HTTPS protocol
    type: bool

password:
    default: ''
    description:
    - FortiOS or FortiGate password.

username:
    description:
    - FortiOS or FortiGate username.
    required: true

antivirus_quarantine:
    default: null
    description:
    - Configure quarantine options.
    suboptions:
      agelimit:
        description:
        - Age limit for quarantined files (0 - 479 hours, 0 means forever).
      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.
      drop-blocked:
        choices:
        - imap
        - smtp
        - pop3
        - http
        - ftp
        - nntp
        - imaps
        - smtps
        - pop3s
        - ftps
        - mapi
        - cifs
        - 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.
      drop-heuristic:
        choices:
        - imap
        - smtp
        - pop3
        - http
        - ftp
        - nntp
        - imaps
        - smtps
        - pop3s
        - https
        - ftps
        - mapi
        - cifs
        - 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.
      drop-infected:
        choices:
        - imap
        - smtp
        - pop3
        - http
        - ftp
        - nntp
        - imaps
        - smtps
        - pop3s
        - https
        - ftps
        - mapi
        - cifs
        - 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.
      lowspace:
        choices:
        - drop-new
        - ovrw-old
        description:
        - Select the method for handling additional files when running low on disk space.
      maxfilesize:
        description:
        - Maximum file size to quarantine (0 - 500 Mbytes, 0 means unlimited).
      quarantine-quota:
        description:
        - The amount of disk space to reserve for quarantining files (0 - 4294967295 Mbytes,
          depends on disk space).
      store-blocked:
        choices:
        - imap
        - smtp
        - pop3
        - http
        - ftp
        - nntp
        - imaps
        - smtps
        - pop3s
        - ftps
        - mapi
        - cifs
        - mm1
        - mm3
        - mm4
        - mm7
        description:
        - Quarantine blocked files found in sessions using the selected protocols.
      store-heuristic:
        choices:
        - imap
        - smtp
        - pop3
        - http
        - ftp
        - nntp
        - imaps
        - smtps
        - pop3s
        - https
        - ftps
        - mapi
        - cifs
        - mm1
        - mm3
        - mm4
        - mm7
        description:
        - Quarantine files detected by heuristics found in sessions using the selected
          protocols.
      store-infected:
        choices:
        - imap
        - smtp
        - pop3
        - http
        - ftp
        - nntp
        - imaps
        - smtps
        - pop3s
        - https
        - ftps
        - mapi
        - cifs
        - mm1
        - mm3
        - mm4
        - mm7
        description:
        - Quarantine infected files found in sessions using the selected protocols.

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