fmgd_antivirus_quarantine – Configure quarantine options.
Added in version 1.0.0.
Synopsis
This module is able to configure a FortiManager device.
Examples include all parameters and values need to be adjusted to data sources before usage.
Tested with FortiManager v7.x.
Requirements
The below requirements are needed on the host that executes this module.
ansible-core>=2.16.0
FortiManager Version Compatibility
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
Parameters
- access_token -The token to access FortiManager without using username and password. type: str required: false
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
- device - The parameter in requested url type: str required: true
- vdom - The parameter in requested url type: str required: true
- antivirus_quarantine - Configure quarantine options. type: dict
- 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_infected (Alias name: drop-infected) Do not quarantine infected files found in sessions using the selected protocols. type: list choices: [imap, smtp, pop3, http, ftp, im, nntp, imaps, smtps, pop3s, https, mm1, mm3, mm4, mm7, ftps, mapi, cifs, ssh] more...
- drop_machine_learning (Alias name: drop-machine-learning) Do not 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...
- lowspace Select the method for handling additional files when running low on disk space. type: str choices: [ovrw-old, drop-new] more...
- maxfilesize Maximum file size to quarantine (0 - 500 mbytes, 0 means unlimited). type: int more...
- quarantine_quota (Alias name: quarantine-quota) The amount of disk space to reserve for quarantining files (0 - 4294967295 mbytes, depends on disk space). type: int more...
- store_infected (Alias name: store-infected) Quarantine infected files found in sessions using the selected protocols. type: list choices: [imap, smtp, pop3, http, ftp, im, nntp, imaps, smtps, pop3s, https, mm1, mm3, mm4, mm7, ftps, mapi, cifs, ssh] more...
- store_machine_learning (Alias name: 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...
- drop_blocked (Alias name: drop-blocked) Do not quarantine dropped files found in sessions using the selected protocols. type: list choices: [imap, smtp, pop3, http, ftp, nntp, imaps, smtps, pop3s, https, mm1, mm3, mm4, mm7, ftps, mapi, cifs, ssh] more...
- store_blocked (Alias name: 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, mm1, mm3, mm4, mm7, ftps, mapi, cifs, ssh] more...
- drop_heuristic (Alias name: drop-heuristic) Do not quarantine files detected by heuristics found in sessions using the selected protocols. type: list choices: [imap, smtp, pop3, http, ftp, im, nntp, imaps, smtps, pop3s, https, mm1, mm3, mm4, mm7, ftps, mapi, cifs, ssh] more...
- store_heuristic (Alias name: store-heuristic) Quarantine files detected by heuristics found in sessions using the selected protocols. type: list choices: [imap, smtp, pop3, http, ftp, im, nntp, imaps, smtps, pop3s, https, mm1, mm3, mm4, mm7, ftps, mapi, cifs, ssh] more...
- drop_intercepted (Alias name: drop-intercepted) Drop intercepted from a protocol type: list choices: [imap, smtp, pop3, http, ftp, imaps, smtps, pop3s, https, mm1, mm3, mm4, mm7, ftps, mapi] more...
- store_intercepted (Alias name: store-intercepted) Quarantine intercepted from a protocol type: list choices: [imap, smtp, pop3, http, ftp, imaps, smtps, pop3s, https, mm1, mm3, mm4, mm7, ftps, mapi] more...
Notes
Note
Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
To create or update an object, use state: present directive.
To delete an object, use state: absent directive
Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded
Examples
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure quarantine options.
fortinet.fmgdevice.fmgd_antivirus_quarantine:
# bypass_validation: false
# workspace_locking_adom: <global or your adom name>
# workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
device: <your own value>
vdom: <your own value>
antivirus_quarantine:
# agelimit: <integer>
# destination: <value in [NULL, disk, FortiAnalyzer]>
# drop_infected:
# - "imap"
# - "smtp"
# - "pop3"
# - "http"
# - "ftp"
# - "im"
# - "nntp"
# - "imaps"
# - "smtps"
# - "pop3s"
# - "https"
# - "mm1"
# - "mm3"
# - "mm4"
# - "mm7"
# - "ftps"
# - "mapi"
# - "cifs"
# - "ssh"
# drop_machine_learning:
# - "imap"
# - "smtp"
# - "pop3"
# - "http"
# - "ftp"
# - "nntp"
# - "imaps"
# - "smtps"
# - "pop3s"
# - "https"
# - "ftps"
# - "mapi"
# - "cifs"
# - "ssh"
# lowspace: <value in [ovrw-old, drop-new]>
# maxfilesize: <integer>
# quarantine_quota: <integer>
# store_infected:
# - "imap"
# - "smtp"
# - "pop3"
# - "http"
# - "ftp"
# - "im"
# - "nntp"
# - "imaps"
# - "smtps"
# - "pop3s"
# - "https"
# - "mm1"
# - "mm3"
# - "mm4"
# - "mm7"
# - "ftps"
# - "mapi"
# - "cifs"
# - "ssh"
# store_machine_learning:
# - "imap"
# - "smtp"
# - "pop3"
# - "http"
# - "ftp"
# - "nntp"
# - "imaps"
# - "smtps"
# - "pop3s"
# - "https"
# - "ftps"
# - "mapi"
# - "cifs"
# - "ssh"
# drop_blocked:
# - "imap"
# - "smtp"
# - "pop3"
# - "http"
# - "ftp"
# - "nntp"
# - "imaps"
# - "smtps"
# - "pop3s"
# - "https"
# - "mm1"
# - "mm3"
# - "mm4"
# - "mm7"
# - "ftps"
# - "mapi"
# - "cifs"
# - "ssh"
# store_blocked:
# - "imap"
# - "smtp"
# - "pop3"
# - "http"
# - "ftp"
# - "nntp"
# - "imaps"
# - "smtps"
# - "pop3s"
# - "https"
# - "mm1"
# - "mm3"
# - "mm4"
# - "mm7"
# - "ftps"
# - "mapi"
# - "cifs"
# - "ssh"
# drop_heuristic:
# - "imap"
# - "smtp"
# - "pop3"
# - "http"
# - "ftp"
# - "im"
# - "nntp"
# - "imaps"
# - "smtps"
# - "pop3s"
# - "https"
# - "mm1"
# - "mm3"
# - "mm4"
# - "mm7"
# - "ftps"
# - "mapi"
# - "cifs"
# - "ssh"
# store_heuristic:
# - "imap"
# - "smtp"
# - "pop3"
# - "http"
# - "ftp"
# - "im"
# - "nntp"
# - "imaps"
# - "smtps"
# - "pop3s"
# - "https"
# - "mm1"
# - "mm3"
# - "mm4"
# - "mm7"
# - "ftps"
# - "mapi"
# - "cifs"
# - "ssh"
# drop_intercepted:
# - "imap"
# - "smtp"
# - "pop3"
# - "http"
# - "ftp"
# - "imaps"
# - "smtps"
# - "pop3s"
# - "https"
# - "mm1"
# - "mm3"
# - "mm4"
# - "mm7"
# - "ftps"
# - "mapi"
# store_intercepted:
# - "imap"
# - "smtp"
# - "pop3"
# - "http"
# - "ftp"
# - "imaps"
# - "smtps"
# - "pop3s"
# - "https"
# - "mm1"
# - "mm3"
# - "mm4"
# - "mm7"
# - "ftps"
# - "mapi"
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:
- meta - The result of the request.returned: always type: dict
- request_url - The full url requested. returned: always type: str sample: /sys/login/user
- response_code - The status of api request. returned: always type: int sample: 0
- response_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
Status
This module is not guaranteed to have a backwards compatible interface.