fortinet.fortimanager.fmgr_antivirus_profile module – Configure AntiVirus profiles.
Note
This module is part of the fortinet.fortimanager collection (version 2.8.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install fortinet.fortimanager
.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_antivirus_profile
.
New in fortinet.fortimanager 1.0.0
Synopsis
This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
Parameter |
Comments |
---|---|
The token to access FortiManager without using username and password. |
|
The parameter (adom) in requested url. |
|
The top level parameters set. |
|
Only submit files matching this DLP file-pattern to FortiSandbox. |
|
Only submit files matching this DLP file-pattern to FortiSandbox. |
|
Enable/disable using the FortiSandbox signature database to supplement the AV signature databases. Choices:
|
|
Do not submit files matching this DLP file-pattern to FortiSandbox. |
|
Maximum size of files that can be uploaded to FortiSandbox |
|
Do not submit files matching this DLP file-pattern to FortiSandbox. |
|
Enable/disable logging for AntiVirus file blocking. Choices:
|
|
Enable/disable AntiVirus logging. Choices:
|
|
Cifs. |
|
Select the archive types to block. Choices:
|
|
Select the archive types to log. Choices:
|
|
Enable AntiVirus scan service. Choices:
|
|
Enable/disable the virus emulator. Choices:
|
|
Enable external-blocklist. Choices:
|
|
Enable/disable scanning of files by FortiAI. Choices:
|
|
Enable scanning of files by FortiNDR. Choices:
|
|
Enable scanning of files by FortiSandbox. Choices:
|
|
Enable/disable CIFS AntiVirus scanning, monitoring, and quarantine. Choices:
|
|
Enable Virus Outbreak Prevention service. Choices:
|
|
Enable/disable quarantine for infected files. Choices:
|
|
Comment. |
|
Content disarm. |
|
Enable/disable using CDR as a secondary method for determining suspicous files for analytics. Choices:
|
|
Enable/disable inserting a cover page into the disarmed document. Choices:
|
|
Enable/disable only detect disarmable files, do not alter content. Choices:
|
|
Action to be taken if CDR engine encounters an unrecoverable error. Choices:
|
|
Enable/disable stripping of PowerPoint action events in Microsoft Office documents. Choices:
|
|
Enable/disable stripping of Dynamic Data Exchange events in Microsoft Office documents. Choices:
|
|
Enable/disable stripping of embedded objects in Microsoft Office documents. Choices:
|
|
Enable/disable stripping of hyperlinks in Microsoft Office documents. Choices:
|
|
Enable/disable stripping of linked objects in Microsoft Office documents. Choices:
|
|
Enable/disable stripping of macros in Microsoft Office documents. Choices:
|
|
Destination to send original file if active content is removed. Choices:
|
|
Enable/disable stripping of PDF document actions that submit data to other targets. Choices:
|
|
Enable/disable stripping of PDF document actions that access other PDF documents. Choices:
|
|
Enable/disable stripping of PDF document actions that execute JavaScript code. Choices:
|
|
Enable/disable stripping of PDF document actions that launch other applications. Choices:
|
|
Enable/disable stripping of PDF document actions that play a movie. Choices:
|
|
Enable/disable stripping of PDF document actions that play a sound. Choices:
|
|
Enable/disable stripping of embedded files in PDF documents. Choices:
|
|
Enable/disable stripping of hyperlinks from PDF documents. Choices:
|
|
Enable/disable stripping of JavaScript code in PDF documents. Choices:
|
|
Enable/disable use of EMS threat feed when performing AntiVirus scan. Choices:
|
|
Enable/disable extended logging for antivirus. Choices:
|
|
(list or str) One or more external malware block lists. |
|
Enable/disable external-blocklist archive scanning. Choices:
|
|
Enable/disable all external blocklists. Choices:
|
|
Flow/proxy feature set. Choices:
|
|
Action to take if FortiAI encounters an error. Choices:
|
|
Action to take if FortiAI encounters a scan timeout. Choices:
|
|
Action to take if FortiNDR encounters an error. Choices:
|
|
Action to take if FortiNDR encounters a scan timeout. Choices:
|
|
Action to take if FortiSandbox inline scan encounters an error. Choices:
|
|
Maximum size of files that can be uploaded to FortiSandbox. |
|
FortiSandbox scan modes. Choices:
|
|
Action to take if FortiSandbox inline scan encounters a scan timeout. Choices:
|
|
Settings to control which files are uploaded to FortiSandbox. Choices:
|
|
Ftp. |
|
Select the archive types to block. Choices:
|
|
Select the archive types to log. Choices:
|
|
Enable AntiVirus scan service. Choices:
|
|
Enable/disable the virus emulator. Choices:
|
|
Enable external-blocklist. Choices:
|
|
Enable/disable scanning of files by FortiAI. Choices:
|
|
Enable scanning of files by FortiNDR. Choices:
|
|
Enable scanning of files by FortiSandbox. Choices:
|
|
Enable/disable FTP AntiVirus scanning, monitoring, and quarantine. Choices:
|
|
Enable Virus Outbreak Prevention service. Choices:
|
|
Enable/disable quarantine for infected files. Choices:
|
|
Http. |
|
Select the archive types to block. Choices:
|
|
Select the archive types to log. Choices:
|
|
Av optimize. Choices:
|
|
Enable AntiVirus scan service. Choices:
|
|
Enable Content Disarm and Reconstruction for this protocol. Choices:
|
|
Enable/disable the virus emulator. Choices:
|
|
Enable external-blocklist. Choices:
|
|
Enable/disable scanning of files by FortiAI. Choices:
|
|
Enable scanning of files by FortiNDR. Choices:
|
|
Enable scanning of files by FortiSandbox. Choices:
|
|
Enable/disable HTTP AntiVirus scanning, monitoring, and quarantine. Choices:
|
|
Enable Virus Outbreak Prevention service. Choices:
|
|
Enable/disable quarantine for infected files. Choices:
|
|
Configure the action the FortiGate unit will take on unknown content-encoding. Choices:
|
|
Imap. |
|
Select the archive types to block. Choices:
|
|
Select the archive types to log. Choices:
|
|
Enable AntiVirus scan service. Choices:
|
|
Enable Content Disarm and Reconstruction for this protocol. Choices:
|
|
Enable/disable the virus emulator. Choices:
|
|
Treat Windows executable files as viruses for the purpose of blocking or monitoring. Choices:
|
|
Enable external-blocklist. Choices:
|
|
Enable/disable scanning of files by FortiAI. Choices:
|
|
Enable scanning of files by FortiNDR. Choices:
|
|
Enable scanning of files by FortiSandbox. Choices:
|
|
Enable/disable IMAP AntiVirus scanning, monitoring, and quarantine. Choices:
|
|
Enable Virus Outbreak Prevention service. Choices:
|
|
Enable/disable quarantine for infected files. Choices:
|
|
Inspection mode. Choices:
|
|
Mapi. |
|
Select the archive types to block. Choices:
|
|
Select the archive types to log. Choices:
|
|
Enable AntiVirus scan service. Choices:
|
|
Enable/disable the virus emulator. Choices:
|
|
Treat Windows executable files as viruses for the purpose of blocking or monitoring. Choices:
|
|
Enable external-blocklist. Choices:
|
|
Enable/disable scanning of files by FortiAI. Choices:
|
|
Enable scanning of files by FortiNDR. Choices:
|
|
Enable scanning of files by FortiSandbox. Choices:
|
|
Enable/disable MAPI AntiVirus scanning, monitoring, and quarantine. Choices:
|
|
Enable Virus Outbreak Prevention service. Choices:
|
|
Enable/disable quarantine for infected files. Choices:
|
|
Enable/disable using the mobile malware signature database. Choices:
|
|
Nac quar. |
|
Duration of quarantine. |
|
Enable/Disable quarantining infected hosts to the banned user list. Choices:
|
|
Enable/disable AntiVirus quarantine logging. Choices:
|
|
Profile name. |
|
Nntp. |
|
Select the archive types to block. Choices:
|
|
Select the archive types to log. Choices:
|
|
Enable AntiVirus scan service. Choices:
|
|
Enable/disable the virus emulator. Choices:
|
|
Enable external-blocklist. Choices:
|
|
Enable/disable scanning of files by FortiAI. Choices:
|
|
Enable scanning of files by FortiNDR. Choices:
|
|
Enable scanning of files by FortiSandbox. Choices:
|
|
Enable/disable NNTP AntiVirus scanning, monitoring, and quarantine. Choices:
|
|
Enable Virus Outbreak Prevention service. Choices:
|
|
Enable/disable quarantine for infected files. Choices:
|
|
Outbreak prevention. |
|
Enable/disable external malware blocklist. Choices:
|
|
Enable/disable FortiGuard Virus outbreak prevention service. Choices:
|
|
Enable/disable outbreak-prevention archive scanning. Choices:
|
|
Pop3. |
|
Select the archive types to block. Choices:
|
|
Select the archive types to log. Choices:
|
|
Enable AntiVirus scan service. Choices:
|
|
Enable Content Disarm and Reconstruction for this protocol. Choices:
|
|
Enable/disable the virus emulator. Choices:
|
|
Treat Windows executable files as viruses for the purpose of blocking or monitoring. Choices:
|
|
Enable external-blocklist. Choices:
|
|
Enable/disable scanning of files by FortiAI. Choices:
|
|
Enable scanning of files by FortiNDR. Choices:
|
|
Enable scanning of files by FortiSandbox. Choices:
|
|
Enable/disable POP3 AntiVirus scanning, monitoring, and quarantine. Choices:
|
|
Enable Virus Outbreak Prevention service. Choices:
|
|
Enable/disable quarantine for infected files. Choices:
|
|
Replacement message group customized for this profile. |
|
Choose between full scan mode and quick scan mode. Choices:
|
|
Smb. |
|
Select the archive types to block. Choices:
|
|
Select the archive types to log. Choices:
|
|
Enable/disable the virus emulator. Choices:
|
|
Enable/disable SMB AntiVirus scanning, monitoring, and quarantine. Choices:
|
|
Enable FortiGuard Virus Outbreak Prevention service. Choices:
|
|
Smtp. |
|
Select the archive types to block. Choices:
|
|
Select the archive types to log. Choices:
|
|
Enable AntiVirus scan service. Choices:
|
|
Enable Content Disarm and Reconstruction for this protocol. Choices:
|
|
Enable/disable the virus emulator. Choices:
|
|
Treat Windows executable files as viruses for the purpose of blocking or monitoring. Choices:
|
|
Enable external-blocklist. Choices:
|
|
Enable/disable scanning of files by FortiAI. Choices:
|
|
Enable scanning of files by FortiNDR. Choices:
|
|
Enable scanning of files by FortiSandbox. Choices:
|
|
Enable/disable SMTP AntiVirus scanning, monitoring, and quarantine. Choices:
|
|
Enable Virus Outbreak Prevention service. Choices:
|
|
Enable/disable quarantine for infected files. Choices:
|
|
Ssh. |
|
Select the archive types to block. Choices:
|
|
Select the archive types to log. Choices:
|
|
Enable AntiVirus scan service. Choices:
|
|
Enable/disable the virus emulator. Choices:
|
|
Enable external-blocklist. Choices:
|
|
Enable/disable scanning of files by FortiAI. Choices:
|
|
Enable scanning of files by FortiNDR. Choices:
|
|
Enable scanning of files by FortiSandbox. Choices:
|
|
Enable/disable SFTP and SCP AntiVirus scanning, monitoring, and quarantine. Choices:
|
|
Enable Virus Outbreak Prevention service. Choices:
|
|
Enable/disable quarantine for infected files. Choices:
|
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The directive to create, update or delete an object. Choices:
|
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
Notes
Note
Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
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
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure AntiVirus profiles.
fortinet.fortimanager.fmgr_antivirus_profile:
adom: ansible
state: present
antivirus_profile:
analytics-db: disable
analytics-max-upload: 20
av-block-log: disable
av-virus-log: disable
comment: "test comment"
extended-log: disable
ftgd-analytics: disable
inspection-mode: proxy
mobile-malware-db: disable
name: "antivirus-profile"
scan-mode: quick
- name: Gathering fortimanager facts
hosts: fortimanagers
gather_facts: false
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Retrieve all the antivirus profiles
fortinet.fortimanager.fmgr_fact:
facts:
selector: "antivirus_profile"
params:
adom: "ansible"
profile: "your_value"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |