fortinet.fortios.fortios_antivirus_quarantine (1.1.7) — module

Install collection

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

Add to requirements.yml

  collections:
    - name: fortinet.fortios
      version: 1.1.7

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

Requirements

• ansible>=2.9.0

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 quarantine options.
    fortios_antivirus_quarantine:
      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

    
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

access_token:
    description:
    - Token-based authentication. Generated from GUI of Fortigate.
    required: false
    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
        - ftps
        - mapi
        - cifs
        - ssh
        description:
        - Do not quarantine dropped files found in sessions using the selected protocols.
          Dropped files are deleted instead of being quarantined.
        type: str
      drop_heuristic:
        choices:
        - imap
        - smtp
        - pop3
        - http
        - ftp
        - nntp
        - imaps
        - smtps
        - pop3s
        - https
        - ftps
        - mapi
        - cifs
        - ssh
        description:
        - Do not quarantine files detected by heuristics found in sessions using the selected
          protocols. Dropped files are deleted instead of being quarantined.
        type: str
      drop_infected:
        choices:
        - imap
        - smtp
        - pop3
        - http
        - ftp
        - nntp
        - imaps
        - smtps
        - pop3s
        - https
        - ftps
        - mapi
        - cifs
        - ssh
        description:
        - Do not quarantine infected files found in sessions using the selected protocols.
          Dropped files are deleted instead of being quarantined.
        type: str
      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
        - ftps
        - mapi
        - cifs
        - ssh
        description:
        - Quarantine blocked files found in sessions using the selected protocols.
        type: str
      store_heuristic:
        choices:
        - imap
        - smtp
        - pop3
        - http
        - ftp
        - nntp
        - imaps
        - smtps
        - pop3s
        - https
        - ftps
        - mapi
        - cifs
        - ssh
        description:
        - Quarantine files detected by heuristics found in sessions using the selected
          protocols.
        type: str
      store_infected:
        choices:
        - imap
        - smtp
        - pop3
        - http
        - ftp
        - nntp
        - imaps
        - smtps
        - pop3s
        - https
        - ftps
        - mapi
        - cifs
        - ssh
        description:
        - Quarantine infected files found in sessions using the selected protocols.
        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