W3cubDocs

/Ansible 2.11

fortinet.fortimanager.fmgr_antivirus_profile_imap – Configure IMAP AntiVirus options.

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_imap.

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_imap
dictionary
the top level parameters set
archive-block
list / elements=string
    Choices:
  • encrypted
  • corrupted
  • multipart
  • nested
  • mailbomb
  • unhandled
  • partiallycorrupted
  • fileslimit
  • timeout
no description
archive-log
list / elements=string
    Choices:
  • encrypted
  • corrupted
  • multipart
  • nested
  • mailbomb
  • unhandled
  • partiallycorrupted
  • fileslimit
  • timeout
no description
content-disarm
string
    Choices:
  • disable
  • enable
Enable Content Disarm and Reconstruction for this protocol.
emulator
string
    Choices:
  • disable
  • enable
Enable/disable the virus emulator.
executables
string
    Choices:
  • default
  • virus
Treat Windows executable files as viruses for the purpose of blocking or monitoring.
options
list / elements=string
    Choices:
  • scan
  • file-filter
  • quarantine
  • avquery
  • avmonitor
no description
outbreak-prevention
string
    Choices:
  • disabled
  • files
  • full-archive
Enable FortiGuard Virus Outbreak Prevention service.
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
profile
string / required
the parameter (profile) in requested url
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 IMAP AntiVirus options.
     fmgr_antivirus_profile_imap:
        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>
        profile: <your own value>
        antivirus_profile_imap:
           archive-block:
             - encrypted
             - corrupted
             - multipart
             - nested
             - mailbomb
             - unhandled
             - partiallycorrupted
             - fileslimit
             - timeout
           archive-log:
             - encrypted
             - corrupted
             - multipart
             - nested
             - mailbomb
             - unhandled
             - partiallycorrupted
             - fileslimit
             - timeout
           content-disarm: <value in [disable, enable]>
           emulator: <value in [disable, enable]>
           executables: <value in [default, virus]>
           options:
             - scan
             - file-filter
             - quarantine
             - avquery
             - avmonitor
           outbreak-prevention: <value in [disabled, files, full-archive]>

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)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_antivirus_profile_imap_module.html