community.fortios.fmgr_secprof_av – Manage security profile
Note
This plugin is part of the community.fortios collection (version 1.0.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 community.fortios
.
To use it in a playbook, specify: community.fortios.fmgr_secprof_av
.
Parameters
Parameter |
Comments |
---|---|
The ADOM the configuration should belong to. Default: “root” |
|
Only submit files matching this DLP file-pattern to FortiSandbox. |
|
Enable/disable using the FortiSandbox signature database to supplement the AV signature databases. Choices:
|
|
Maximum size of files that can be uploaded to FortiSandbox (1 - 395 MBytes, default = 10). |
|
Do not submit files matching this DLP file-pattern to FortiSandbox. |
|
Enable/disable logging for AntiVirus file blocking. Choices:
|
|
Enable/disable AntiVirus logging. Choices:
|
|
Comment. |
|
EXPERTS ONLY! KNOWLEDGE OF FMGR JSON API IS REQUIRED! List of multiple child objects to be added. Expects a list of dictionaries. Dictionaries must use FortiManager API parameters, not the ansible ones listed below. If submitted, all other prefixed sub-parameters ARE IGNORED. This object is MUTUALLY EXCLUSIVE with its options. We expect that you know what you are doing with these list parameters, and are leveraging the JSON API Guide. WHEN IN DOUBT, USE THE SUB OPTIONS BELOW INSTEAD TO CREATE OBJECTS WITH MULTIPLE TASKS |
|
Enable/disable inserting a cover page into the disarmed document. Choices:
|
|
Enable/disable only detect disarmable files, do not alter content. 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 actions that submit data to other targets in PDF documents. Choices:
|
|
Enable/disable stripping of links to other PDFs in PDF documents. Choices:
|
|
Enable/disable stripping of actions that execute JavaScript code in PDF documents. Choices:
|
|
Enable/disable stripping of links to external applications in PDF documents. Choices:
|
|
Enable/disable stripping of embedded movies in PDF documents. Choices:
|
|
Enable/disable stripping of embedded sound files in PDF documents. 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 extended logging for antivirus. Choices:
|
|
Settings to control which files are uploaded to FortiSandbox. Choices:
|
|
EXPERTS ONLY! KNOWLEDGE OF FMGR JSON API IS REQUIRED! List of multiple child objects to be added. Expects a list of dictionaries. Dictionaries must use FortiManager API parameters, not the ansible ones listed below. If submitted, all other prefixed sub-parameters ARE IGNORED. This object is MUTUALLY EXCLUSIVE with its options. We expect that you know what you are doing with these list parameters, and are leveraging the JSON API Guide. WHEN IN DOUBT, USE THE SUB OPTIONS BELOW INSTEAD TO CREATE OBJECTS WITH MULTIPLE TASKS |
|
Select the archive types to block. FLAG Based Options. Specify multiple in list form. Choices:
|
|
Select the archive types to log. FLAG Based Options. Specify multiple in list form. Choices:
|
|
Enable/disable the virus emulator. Choices:
|
|
Enable/disable FTP AntiVirus scanning, monitoring, and quarantine. FLAG Based Options. Specify multiple in list form. Choices:
|
|
Enable FortiGuard Virus Outbreak Prevention service. Choices:
|
|
EXPERTS ONLY! KNOWLEDGE OF FMGR JSON API IS REQUIRED! List of multiple child objects to be added. Expects a list of dictionaries. Dictionaries must use FortiManager API parameters, not the ansible ones listed below. If submitted, all other prefixed sub-parameters ARE IGNORED. This object is MUTUALLY EXCLUSIVE with its options. We expect that you know what you are doing with these list parameters, and are leveraging the JSON API Guide. WHEN IN DOUBT, USE THE SUB OPTIONS BELOW INSTEAD TO CREATE OBJECTS WITH MULTIPLE TASKS |
|
Select the archive types to block. FLAG Based Options. Specify multiple in list form. Choices:
|
|
Select the archive types to log. FLAG Based Options. Specify multiple in list form. Choices:
|
|
Enable Content Disarm and Reconstruction for this protocol. Choices:
|
|
Enable/disable the virus emulator. Choices:
|
|
Enable/disable HTTP AntiVirus scanning, monitoring, and quarantine. FLAG Based Options. Specify multiple in list form. Choices:
|
|
Enable FortiGuard Virus Outbreak Prevention service. Choices:
|
|
EXPERTS ONLY! KNOWLEDGE OF FMGR JSON API IS REQUIRED! List of multiple child objects to be added. Expects a list of dictionaries. Dictionaries must use FortiManager API parameters, not the ansible ones listed below. If submitted, all other prefixed sub-parameters ARE IGNORED. This object is MUTUALLY EXCLUSIVE with its options. We expect that you know what you are doing with these list parameters, and are leveraging the JSON API Guide. WHEN IN DOUBT, USE THE SUB OPTIONS BELOW INSTEAD TO CREATE OBJECTS WITH MULTIPLE TASKS |
|
Select the archive types to block. FLAG Based Options. Specify multiple in list form. Choices:
|
|
Select the archive types to log. FLAG Based Options. Specify multiple in list form. 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/disable IMAP AntiVirus scanning, monitoring, and quarantine. FLAG Based Options. Specify multiple in list form. Choices:
|
|
Enable FortiGuard Virus Outbreak Prevention service. Choices:
|
|
Inspection mode. Choices:
|
|
EXPERTS ONLY! KNOWLEDGE OF FMGR JSON API IS REQUIRED! List of multiple child objects to be added. Expects a list of dictionaries. Dictionaries must use FortiManager API parameters, not the ansible ones listed below. If submitted, all other prefixed sub-parameters ARE IGNORED. This object is MUTUALLY EXCLUSIVE with its options. We expect that you know what you are doing with these list parameters, and are leveraging the JSON API Guide. WHEN IN DOUBT, USE THE SUB OPTIONS BELOW INSTEAD TO CREATE OBJECTS WITH MULTIPLE TASKS |
|
Select the archive types to block. FLAG Based Options. Specify multiple in list form. Choices:
|
|
Select the archive types to log. FLAG Based Options. Specify multiple in list form. Choices:
|
|
Enable/disable the virus emulator. Choices:
|
|
Treat Windows executable files as viruses for the purpose of blocking or monitoring. Choices:
|
|
Enable/disable MAPI AntiVirus scanning, monitoring, and quarantine. FLAG Based Options. Specify multiple in list form. Choices:
|
|
Enable FortiGuard Virus Outbreak Prevention service. Choices:
|
|
Enable/disable using the mobile malware signature database. Choices:
|
|
Sets one of three modes for managing the object. Allows use of soft-adds instead of overwriting existing values Choices:
|
|
EXPERTS ONLY! KNOWLEDGE OF FMGR JSON API IS REQUIRED! List of multiple child objects to be added. Expects a list of dictionaries. Dictionaries must use FortiManager API parameters, not the ansible ones listed below. If submitted, all other prefixed sub-parameters ARE IGNORED. This object is MUTUALLY EXCLUSIVE with its options. We expect that you know what you are doing with these list parameters, and are leveraging the JSON API Guide. WHEN IN DOUBT, USE THE SUB OPTIONS BELOW INSTEAD TO CREATE OBJECTS WITH MULTIPLE TASKS |
|
Duration of quarantine. |
|
Enable/Disable quarantining infected hosts to the banned user list. Choices:
|
|
Enable/disable AntiVirus quarantine logging. Choices:
|
|
Profile name. |
|
EXPERTS ONLY! KNOWLEDGE OF FMGR JSON API IS REQUIRED! List of multiple child objects to be added. Expects a list of dictionaries. Dictionaries must use FortiManager API parameters, not the ansible ones listed below. If submitted, all other prefixed sub-parameters ARE IGNORED. This object is MUTUALLY EXCLUSIVE with its options. We expect that you know what you are doing with these list parameters, and are leveraging the JSON API Guide. WHEN IN DOUBT, USE THE SUB OPTIONS BELOW INSTEAD TO CREATE OBJECTS WITH MULTIPLE TASKS |
|
Select the archive types to block. FLAG Based Options. Specify multiple in list form. Choices:
|
|
Select the archive types to log. FLAG Based Options. Specify multiple in list form. Choices:
|
|
Enable/disable the virus emulator. Choices:
|
|
Enable/disable NNTP AntiVirus scanning, monitoring, and quarantine. FLAG Based Options. Specify multiple in list form. Choices:
|
|
Enable FortiGuard Virus Outbreak Prevention service. Choices:
|
|
EXPERTS ONLY! KNOWLEDGE OF FMGR JSON API IS REQUIRED! List of multiple child objects to be added. Expects a list of dictionaries. Dictionaries must use FortiManager API parameters, not the ansible ones listed below. If submitted, all other prefixed sub-parameters ARE IGNORED. This object is MUTUALLY EXCLUSIVE with its options. We expect that you know what you are doing with these list parameters, and are leveraging the JSON API Guide. WHEN IN DOUBT, USE THE SUB OPTIONS BELOW INSTEAD TO CREATE OBJECTS WITH MULTIPLE TASKS |
|
Select the archive types to block. FLAG Based Options. Specify multiple in list form. Choices:
|
|
Select the archive types to log. FLAG Based Options. Specify multiple in list form. 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/disable POP3 AntiVirus scanning, monitoring, and quarantine. FLAG Based Options. Specify multiple in list form. Choices:
|
|
Enable FortiGuard Virus Outbreak Prevention service. Choices:
|
|
Replacement message group customized for this profile. |
|
Choose between full scan mode and quick scan mode. Choices:
|
|
EXPERTS ONLY! KNOWLEDGE OF FMGR JSON API IS REQUIRED! List of multiple child objects to be added. Expects a list of dictionaries. Dictionaries must use FortiManager API parameters, not the ansible ones listed below. If submitted, all other prefixed sub-parameters ARE IGNORED. This object is MUTUALLY EXCLUSIVE with its options. We expect that you know what you are doing with these list parameters, and are leveraging the JSON API Guide. WHEN IN DOUBT, USE THE SUB OPTIONS BELOW INSTEAD TO CREATE OBJECTS WITH MULTIPLE TASKS |
|
Select the archive types to block. FLAG Based Options. Specify multiple in list form. Choices:
|
|
Select the archive types to log. FLAG Based Options. Specify multiple in list form. Choices:
|
|
Enable/disable the virus emulator. Choices:
|
|
Enable/disable SMB AntiVirus scanning, monitoring, and quarantine. FLAG Based Options. Specify multiple in list form. Choices:
|
|
Enable FortiGuard Virus Outbreak Prevention service. Choices:
|
|
EXPERTS ONLY! KNOWLEDGE OF FMGR JSON API IS REQUIRED! List of multiple child objects to be added. Expects a list of dictionaries. Dictionaries must use FortiManager API parameters, not the ansible ones listed below. If submitted, all other prefixed sub-parameters ARE IGNORED. This object is MUTUALLY EXCLUSIVE with its options. We expect that you know what you are doing with these list parameters, and are leveraging the JSON API Guide. WHEN IN DOUBT, USE THE SUB OPTIONS BELOW INSTEAD TO CREATE OBJECTS WITH MULTIPLE TASKS |
|
Select the archive types to block. FLAG Based Options. Specify multiple in list form. Choices:
|
|
Select the archive types to log. FLAG Based Options. Specify multiple in list form. 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/disable SMTP AntiVirus scanning, monitoring, and quarantine. FLAG Based Options. Specify multiple in list form. Choices:
|
|
Enable FortiGuard Virus Outbreak Prevention service. Choices:
|
Notes
Note
Full Documentation at https://ftnt-ansible-docs.readthedocs.io/en/latest/.
Examples
- name: DELETE Profile
community.fortios.fmgr_secprof_av:
name: "Ansible_AV_Profile"
mode: "delete"
- name: CREATE Profile
community.fortios.fmgr_secprof_av:
name: "Ansible_AV_Profile"
comment: "Created by Ansible Module TEST"
mode: "set"
inspection_mode: "proxy"
ftgd_analytics: "everything"
av_block_log: "enable"
av_virus_log: "enable"
scan_mode: "full"
mobile_malware_db: "enable"
ftp_archive_block: "encrypted"
ftp_outbreak_prevention: "files"
ftp_archive_log: "timeout"
ftp_emulator: "disable"
ftp_options: "scan"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
full API response, includes status code and message Returned: always |
Authors
Luke Weighall (@lweighall)
Andrew Welsh (@Ghilli3)
Jim Huber (@p4r4n0y1ng)