fortinet.fortimanager.fmgr_antivirus_profile – Configure AntiVirus profiles.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.0.1).

To install it use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_antivirus_profile.

New in version 2.10: of fortinet.fortimanager

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 Choices/Defaults Comments
adom
string / required
the parameter (adom) in requested url
antivirus_profile
dictionary
the top level parameters set
analytics-bl-filetype
string
Only submit files matching this DLP file-pattern to FortiSandbox.
analytics-db
string
    Choices:
  • disable
  • enable
Enable/disable using the FortiSandbox signature database to supplement the AV signature databases.
analytics-max-upload
integer
Maximum size of files that can be uploaded to FortiSandbox (1 - 395 MBytes, default = 10).
analytics-wl-filetype
string
Do not submit files matching this DLP file-pattern to FortiSandbox.
av-block-log
string
    Choices:
  • disable
  • enable
Enable/disable logging for AntiVirus file blocking.
av-virus-log
string
    Choices:
  • disable
  • enable
Enable/disable AntiVirus logging.
comment
string
Comment.
extended-log
string
    Choices:
  • disable
  • enable
Enable/disable extended logging for antivirus.
ftgd-analytics
string
    Choices:
  • disable
  • suspicious
  • everything
Settings to control which files are uploaded to FortiSandbox.
inspection-mode
string
    Choices:
  • proxy
  • flow-based
Inspection mode.
mobile-malware-db
string
    Choices:
  • disable
  • enable
Enable/disable using the mobile malware signature database.
name
string
Profile name.
replacemsg-group
string
Replacement message group customized for this profile.
scan-mode
string
    Choices:
  • quick
  • full
Choose between full scan mode and quick scan mode.
bypass_validation
boolean
    Choices:
  • no ←
  • yes
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
rc_failed
list / elements=string
the rc codes list with which the conditions to fail will be overriden
rc_succeeded
list / elements=string
the rc codes list with which the conditions to succeed will be overriden
state
string / required
    Choices:
  • present
  • absent
the directive to create, update or delete an object
workspace_locking_adom
string
the adom to lock for FortiManager running in workspace mode, the value can be global and others including root
workspace_locking_timeout
integer
Default:
300
the maximum time in seconds to wait for other user to release the workspace lock

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

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure AntiVirus profiles.
     fmgr_antivirus_profile:
        bypass_validation: False
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: <value in [present, absent]>
        antivirus_profile:
           analytics-bl-filetype: <value of string>
           analytics-db: <value in [disable, enable]>
           analytics-max-upload: <value of integer>
           analytics-wl-filetype: <value of string>
           av-block-log: <value in [disable, enable]>
           av-virus-log: <value in [disable, enable]>
           comment: <value of string>
           extended-log: <value in [disable, enable]>
           ftgd-analytics: <value in [disable, suspicious, everything]>
           inspection-mode: <value in [proxy, flow-based]>
           mobile-malware-db: <value in [disable, enable]>
           name: <value of string>
           replacemsg-group: <value of string>
           scan-mode: <value in [quick, full]>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
request_url
string
always
The full url requested

Sample:
/sys/login/user
response_code
integer
always
The status of api request

response_message
string
always
The descriptive message of the api response

Sample:
OK.


Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)