fortios_antivirus_quarantine – Configure quarantine options in Fortinet’s FortiOS and FortiGate.
New in version 2.0.0.
Synopsis
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
The below requirements are needed on the host that executes this module.
ansible>=2.15
Tips
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
Supported Version Ranges: v6.0.0 -> 7.4.3
Parameters
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- vdom - 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 default: root
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- antivirus_quarantine - Configure quarantine options. type: dict more...
- agelimit - Age limit for quarantined files (0 - 479 hours, 0 means forever). type: int more...
- destination - Choose whether to quarantine files to the FortiGate disk or to FortiAnalyzer or to delete them instead of quarantining them. type: str choices: NULL, disk, FortiAnalyzer more...
- drop_blocked - Do not quarantine dropped files found in sessions using the selected protocols. Dropped files are deleted instead of being quarantined. type: list choices: imap, smtp, pop3, http, ftp, nntp, imaps, smtps, pop3s, https, ftps, mapi, cifs, ssh, mm1, mm3, mm4, mm7 more...
- drop_heuristic - Do not quarantine files detected by heuristics found in sessions using the selected protocols. Dropped files are deleted instead of being quarantined. type: list choices: imap, smtp, pop3, http, ftp, nntp, imaps, smtps, pop3s, https, ftps, mapi, cifs, ssh, mm1, mm3, mm4, mm7 more...
- drop_infected - Do not quarantine infected files found in sessions using the selected protocols. Dropped files are deleted instead of being quarantined. type: list choices: imap, smtp, pop3, http, ftp, nntp, imaps, smtps, pop3s, https, ftps, mapi, cifs, ssh, mm1, mm3, mm4, mm7 more...
- drop_intercepted - drop intercepted from a protocol type: list choices: imap, smtp, pop3, http, ftp, imaps, smtps, pop3s, https, ftps, mapi, mm1, mm3, mm4, mm7 more...
- drop_machine_learning - Do not quarantine files detected by machine learning found in sessions using the selected protocols. Dropped files are deleted instead of being quarantined. type: list choices: imap, smtp, pop3, http, ftp, nntp, imaps, smtps, pop3s, https, ftps, mapi, cifs, ssh more...
- lowspace - Select the method for handling additional files when running low on disk space. type: str choices: drop-new, ovrw-old more...
- maxfilesize - Maximum file size to quarantine (0 - 500 Mbytes, 0 means unlimited). type: int more...
- quarantine_quota - The amount of disk space to reserve for quarantining files (0 - 4294967295 Mbytes, depends on disk space). type: int more...
- store_blocked - Quarantine blocked files found in sessions using the selected protocols. type: list choices: imap, smtp, pop3, http, ftp, nntp, imaps, smtps, pop3s, https, ftps, mapi, cifs, ssh, mm1, mm3, mm4, mm7 more...
- store_heuristic - Quarantine files detected by heuristics found in sessions using the selected protocols. type: list choices: imap, smtp, pop3, http, ftp, nntp, imaps, smtps, pop3s, https, ftps, mapi, cifs, ssh, mm1, mm3, mm4, mm7 more...
- store_infected - Quarantine infected files found in sessions using the selected protocols. type: list choices: imap, smtp, pop3, http, ftp, nntp, imaps, smtps, pop3s, https, ftps, mapi, cifs, ssh, mm1, mm3, mm4, mm7 more...
- store_intercepted - quarantine intercepted from a protocol type: list choices: imap, smtp, pop3, http, ftp, imaps, smtps, pop3s, https, ftps, mapi, mm1, mm3, mm4, mm7 more...
- store_machine_learning - Quarantine files detected by machine learning found in sessions using the selected protocols. type: list choices: imap, smtp, pop3, http, ftp, nntp, imaps, smtps, pop3s, https, ftps, mapi, cifs, ssh more...
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- 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"
Return Values
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3
Status
This module is not guaranteed to have a backwards compatible interface.