fortinet.fortimanager.fmgr_antivirus_profile_imap module – Configure IMAP AntiVirus options.

Note

This module is part of the fortinet.fortimanager collection (version 2.7.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_imap.

New in fortinet.fortimanager 2.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
access_token string	The token to access FortiManager without using username and password.
adom string / required	The parameter (adom) in requested url.
antivirus_profile_imap dictionary	The top level parameters set.
archive-block list / elements=string	Deprecated, please rename it to archive_block. Select the archive types to block. Choices: "encrypted" "corrupted" "multipart" "nested" "mailbomb" "unhandled" "partiallycorrupted" "fileslimit" "timeout"
archive-log list / elements=string	Deprecated, please rename it to archive_log. Select the archive types to log. Choices: "encrypted" "corrupted" "multipart" "nested" "mailbomb" "unhandled" "partiallycorrupted" "fileslimit" "timeout"
av-scan string	Deprecated, please rename it to av_scan. Enable AntiVirus scan service. Choices: "disable" "monitor" "block"
content-disarm string	Deprecated, please rename it to content_disarm. Enable Content Disarm and Reconstruction for this protocol. Choices: "disable" "enable"
emulator string	Enable/disable the virus emulator. Choices: "disable" "enable"
executables string	Treat Windows executable files as viruses for the purpose of blocking or monitoring. Choices: "default" "virus"
external-blocklist string	Deprecated, please rename it to external_blocklist. Enable external-blocklist. Choices: "disable" "monitor" "block"
fortiai string	Enable/disable scanning of files by FortiAI. Choices: "disable" "monitor" "block"
fortindr string	Enable scanning of files by FortiNDR. Choices: "disable" "block" "monitor"
fortisandbox string	Enable scanning of files by FortiSandbox. Choices: "disable" "block" "monitor"
options list / elements=string	Enable/disable IMAP AntiVirus scanning, monitoring, and quarantine. Choices: "scan" "file-filter" "quarantine" "avquery" "avmonitor"
outbreak-prevention string	Deprecated, please rename it to outbreak_prevention. Enable FortiGuard Virus Outbreak Prevention service. Choices: "disabled" "files" "full-archive" "disable" "block" "monitor"
quarantine string	Enable/disable quarantine for infected files. Choices: "disable" "enable"
bypass_validation boolean	Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices: false ← (default) true
enable_log boolean	Enable/Disable logging for task. Choices: false ← (default) true
forticloud_access_token string	Authenticate Ansible client with forticloud API access token.
profile string / required	The parameter (profile) in requested url.
proposed_method string	The overridden method for the underlying Json RPC request. Choices: "update" "set" "add"
rc_failed list / elements=integer	The rc codes list with which the conditions to fail will be overriden.
rc_succeeded list / elements=integer	The rc codes list with which the conditions to succeed will be overriden.
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	The maximum time in seconds to wait for other user to release the workspace lock. Default: 300

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.

• 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
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure IMAP AntiVirus options.
      fortinet.fortimanager.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, ...]>
          av_scan: <value in [disable, monitor, block]>
          external_blocklist: <value in [disable, monitor, block]>
          quarantine: <value in [disable, enable]>
          fortindr: <value in [disable, block, monitor]>
          fortisandbox: <value in [disable, block, monitor]>
          fortiai: <value in [disable, monitor, block]>

Return Values

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

Key	Description
meta dictionary	The result of the request. Returned: always
request_url string	The full url requested. Returned: always Sample: "/sys/login/user"
response_code integer	The status of api request. Returned: always Sample: 0
response_data list / elements=string	The api response. Returned: always
response_message string	The descriptive message of the api response. Returned: always Sample: "OK."
system_information dictionary	The information of the target system. Returned: always
rc integer	The status the request. Returned: always Sample: 0
version_check_warning list / elements=string	Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex

Authors

• Xinwei Du (@dux-fortinet)

• Xing Li (@lix-fortinet)

• Jie Xue (@JieX19)

• Link Zheng (@chillancezen)

• Frank Shen (@fshen01)

• Hongbin Lu (@fgtdev-hblu)

Collection links

• Issue Tracker
• Homepage
• Repository (Sources)