fmgr_antivirus_profile – Configure AntiVirus profiles.

New in version 2.10.

Synopsis

  • This module is able to configure a FortiManager device.
  • Examples include all parameters and values need to be adjusted to data sources before usage.
  • Tested with FortiManager v6.0.0.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.9.0

FortiManager Version Compatibility


6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
antivirus_profile yes yes yes yes yes yes yes yes

Parameters

  • enable_log - Enable/Disable logging for task type: bool required: false default: False
  • proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
  • bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters type: bool required: false default: False
  • workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom adom including root
  • workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
  • rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
  • rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
  • state - The directive to create, update or delete an object type: str required: true choices: present, absent
  • adom - The parameter in requested url type: str required: true
  • antivirus_profile - Configure AntiVirus profiles. type: dict
    • analytics-bl-filetype - Only submit files matching this DLP file-pattern to FortiSandbox. type: str more...
    • analytics-db - Enable/disable using the FortiSandbox signature database to supplement the AV signature databases. type: str choices: [disable, enable] more...
    • analytics-max-upload - Maximum size of files that can be uploaded to FortiSandbox (1 - 395 MBytes, default = 10). type: int more...
    • analytics-wl-filetype - Do not submit files matching this DLP file-pattern to FortiSandbox. type: str more...
    • av-block-log - Enable/disable logging for AntiVirus file blocking. type: str choices: [disable, enable] more...
    • av-virus-log - Enable/disable AntiVirus logging. type: str choices: [disable, enable] more...
    • comment - Comment. type: str more...
    • extended-log - Enable/disable extended logging for antivirus. type: str choices: [disable, enable] more...
    • ftgd-analytics - Settings to control which files are uploaded to FortiSandbox. type: str choices: [disable, suspicious, everything] more...
    • inspection-mode - Inspection mode. type: str choices: [proxy, flow-based] more...
    • mobile-malware-db - Enable/disable using the mobile malware signature database. type: str choices: [disable, enable] more...
    • name - Profile name. type: str more...
    • replacemsg-group - Replacement message group customized for this profile. type: str more...
    • scan-mode - Choose between full scan mode and quick scan mode. type: str choices: [quick, full, legacy, default] more...
    • feature-set - Flow/proxy feature set. type: str choices: [proxy, flow] more...
    • cifs type: dict
      • archive-block - No description for the parameter type: array choices: [encrypted, corrupted, multipart, nested, mailbomb, unhandled, partiallycorrupted, fileslimit, timeout] more...
      • archive-log - No description for the parameter type: array choices: [encrypted, corrupted, multipart, nested, mailbomb, unhandled, partiallycorrupted, fileslimit, timeout] more...
      • emulator - Enable/disable the virus emulator. type: str choices: [disable, enable] more...
      • options - No description for the parameter type: array choices: [scan, quarantine, avmonitor] more...
      • outbreak-prevention - Enable Virus Outbreak Prevention service. type: str choices: [disabled, files, full-archive, disable, block, monitor] more...
      • av-scan - Enable AntiVirus scan service. type: str choices: [disable, monitor, block] more...
      • external-blocklist - Enable external-blocklist. type: str choices: [disable, monitor, block] more...
      • quarantine - Enable/disable quarantine for infected files. type: str choices: [disable, enable] more...
    • content-disarm type: dict
      • cover-page - Enable/disable inserting a cover page into the disarmed document. type: str choices: [disable, enable] more...
      • detect-only - Enable/disable only detect disarmable files, do not alter content. type: str choices: [disable, enable] more...
      • error-action - Action to be taken if CDR engine encounters an unrecoverable error. type: str choices: [block, log-only, ignore] more...
      • office-action - Enable/disable stripping of PowerPoint action events in Microsoft Office documents. type: str choices: [disable, enable] more...
      • office-dde - Enable/disable stripping of Dynamic Data Exchange events in Microsoft Office documents. type: str choices: [disable, enable] more...
      • office-embed - Enable/disable stripping of embedded objects in Microsoft Office documents. type: str choices: [disable, enable] more...
      • office-hylink - Enable/disable stripping of hyperlinks in Microsoft Office documents. type: str choices: [disable, enable] more...
      • office-linked - Enable/disable stripping of linked objects in Microsoft Office documents. type: str choices: [disable, enable] more...
      • office-macro - Enable/disable stripping of macros in Microsoft Office documents. type: str choices: [disable, enable] more...
      • original-file-destination - Destination to send original file if active content is removed. type: str choices: [fortisandbox, quarantine, discard] more...
      • pdf-act-form - Enable/disable stripping of PDF document actions that submit data to other targets. type: str choices: [disable, enable] more...
      • pdf-act-gotor - Enable/disable stripping of PDF document actions that access other PDF documents. type: str choices: [disable, enable] more...
      • pdf-act-java - Enable/disable stripping of PDF document actions that execute JavaScript code. type: str choices: [disable, enable] more...
      • pdf-act-launch - Enable/disable stripping of PDF document actions that launch other applications. type: str choices: [disable, enable] more...
      • pdf-act-movie - Enable/disable stripping of PDF document actions that play a movie. type: str choices: [disable, enable] more...
      • pdf-act-sound - Enable/disable stripping of PDF document actions that play a sound. type: str choices: [disable, enable] more...
      • pdf-embedfile - Enable/disable stripping of embedded files in PDF documents. type: str choices: [disable, enable] more...
      • pdf-hyperlink - Enable/disable stripping of hyperlinks from PDF documents. type: str choices: [disable, enable] more...
      • pdf-javacode - Enable/disable stripping of JavaScript code in PDF documents. type: str choices: [disable, enable] more...
    • ftp type: dict
      • archive-block - No description for the parameter type: array choices: [encrypted, corrupted, multipart, nested, mailbomb, unhandled, partiallycorrupted, fileslimit, timeout] more...
      • archive-log - No description for the parameter type: array choices: [encrypted, corrupted, multipart, nested, mailbomb, unhandled, partiallycorrupted, fileslimit, timeout] more...
      • emulator - Enable/disable the virus emulator. type: str choices: [disable, enable] more...
      • options - No description for the parameter type: array choices: [scan, file-filter, quarantine, avquery, avmonitor] more...
      • outbreak-prevention - Enable Virus Outbreak Prevention service. type: str choices: [disabled, files, full-archive, disable, block, monitor] more...
      • av-scan - Enable AntiVirus scan service. type: str choices: [disable, monitor, block] more...
      • external-blocklist - Enable external-blocklist. type: str choices: [disable, monitor, block] more...
      • quarantine - Enable/disable quarantine for infected files. type: str choices: [disable, enable] more...
    • http type: dict
      • archive-block - No description for the parameter type: array choices: [encrypted, corrupted, multipart, nested, mailbomb, unhandled, partiallycorrupted, fileslimit, timeout] more...
      • archive-log - No description for the parameter type: array choices: [encrypted, corrupted, multipart, nested, mailbomb, unhandled, partiallycorrupted, fileslimit, timeout] more...
      • content-disarm - Enable Content Disarm and Reconstruction for this protocol. type: str choices: [disable, enable] more...
      • emulator - Enable/disable the virus emulator. type: str choices: [disable, enable] more...
      • options - No description for the parameter type: array choices: [scan, file-filter, quarantine, avquery, avmonitor, strict-file] more...
      • outbreak-prevention - Enable Virus Outbreak Prevention service. type: str choices: [disabled, files, full-archive, disable, block, monitor] more...
      • av-scan - Enable AntiVirus scan service. type: str choices: [disable, monitor, block] more...
      • external-blocklist - Enable external-blocklist. type: str choices: [disable, monitor, block] more...
      • quarantine - Enable/disable quarantine for infected files. type: str choices: [disable, enable] more...
    • imap type: dict
      • archive-block - No description for the parameter type: array choices: [encrypted, corrupted, multipart, nested, mailbomb, unhandled, partiallycorrupted, fileslimit, timeout] more...
      • archive-log - No description for the parameter type: array choices: [encrypted, corrupted, multipart, nested, mailbomb, unhandled, partiallycorrupted, fileslimit, timeout] more...
      • content-disarm - Enable Content Disarm and Reconstruction for this protocol. type: str choices: [disable, enable] more...
      • emulator - Enable/disable the virus emulator. type: str choices: [disable, enable] more...
      • executables - Treat Windows executable files as viruses for the purpose of blocking or monitoring. type: str choices: [default, virus] more...
      • options - No description for the parameter type: array choices: [scan, file-filter, quarantine, avquery, avmonitor] more...
      • outbreak-prevention - Enable Virus Outbreak Prevention service. type: str choices: [disabled, files, full-archive, disable, block, monitor] more...
      • av-scan - Enable AntiVirus scan service. type: str choices: [disable, monitor, block] more...
      • external-blocklist - Enable external-blocklist. type: str choices: [disable, monitor, block] more...
      • quarantine - Enable/disable quarantine for infected files. type: str choices: [disable, enable] more...
    • mapi type: dict
      • archive-block - No description for the parameter type: array choices: [encrypted, corrupted, multipart, nested, mailbomb, unhandled, partiallycorrupted, fileslimit, timeout] more...
      • archive-log - No description for the parameter type: array choices: [encrypted, corrupted, multipart, nested, mailbomb, unhandled, partiallycorrupted, fileslimit, timeout] more...
      • emulator - Enable/disable the virus emulator. type: str choices: [disable, enable] more...
      • executables - Treat Windows executable files as viruses for the purpose of blocking or monitoring. type: str choices: [default, virus] more...
      • options - No description for the parameter type: array choices: [scan, quarantine, avquery, avmonitor] more...
      • outbreak-prevention - Enable Virus Outbreak Prevention service. type: str choices: [disabled, files, full-archive, disable, block, monitor] more...
      • av-scan - Enable AntiVirus scan service. type: str choices: [disable, monitor, block] more...
      • external-blocklist - Enable external-blocklist. type: str choices: [disable, monitor, block] more...
      • quarantine - Enable/disable quarantine for infected files. type: str choices: [disable, enable] more...
    • nac-quar type: dict
      • expiry - Duration of quarantine. type: str more...
      • infected - Enable/Disable quarantining infected hosts to the banned user list. type: str choices: [none, quar-src-ip, quar-interface] more...
      • log - Enable/disable AntiVirus quarantine logging. type: str choices: [disable, enable] more...
    • nntp type: dict
      • archive-block - No description for the parameter type: array choices: [encrypted, corrupted, multipart, nested, mailbomb, unhandled, partiallycorrupted, fileslimit, timeout] more...
      • archive-log - No description for the parameter type: array choices: [encrypted, corrupted, multipart, nested, mailbomb, unhandled, partiallycorrupted, fileslimit, timeout] more...
      • emulator - Enable/disable the virus emulator. type: str choices: [disable, enable] more...
      • options - No description for the parameter type: array choices: [scan, file-filter, quarantine, avquery, avmonitor] more...
      • outbreak-prevention - Enable Virus Outbreak Prevention service. type: str choices: [disabled, files, full-archive, disable, block, monitor] more...
      • av-scan - Enable AntiVirus scan service. type: str choices: [disable, monitor, block] more...
      • external-blocklist - Enable external-blocklist. type: str choices: [disable, monitor, block] more...
      • quarantine - Enable/disable quarantine for infected files. type: str choices: [disable, enable] more...
    • outbreak-prevention type: dict
      • external-blocklist - Enable/disable external malware blocklist. type: str choices: [disable, enable] more...
      • ftgd-service - Enable/disable FortiGuard Virus outbreak prevention service. type: str choices: [disable, enable] more...
    • pop3 type: dict
      • archive-block - No description for the parameter type: array choices: [encrypted, corrupted, multipart, nested, mailbomb, unhandled, partiallycorrupted, fileslimit, timeout] more...
      • archive-log - No description for the parameter type: array choices: [encrypted, corrupted, multipart, nested, mailbomb, unhandled, partiallycorrupted, fileslimit, timeout] more...
      • content-disarm - Enable Content Disarm and Reconstruction for this protocol. type: str choices: [disable, enable] more...
      • emulator - Enable/disable the virus emulator. type: str choices: [disable, enable] more...
      • executables - Treat Windows executable files as viruses for the purpose of blocking or monitoring. type: str choices: [default, virus] more...
      • options - No description for the parameter type: array choices: [scan, file-filter, quarantine, avquery, avmonitor] more...
      • outbreak-prevention - Enable Virus Outbreak Prevention service. type: str choices: [disabled, files, full-archive, disable, block, monitor] more...
      • av-scan - Enable AntiVirus scan service. type: str choices: [disable, monitor, block] more...
      • external-blocklist - Enable external-blocklist. type: str choices: [disable, monitor, block] more...
      • quarantine - Enable/disable quarantine for infected files. type: str choices: [disable, enable] more...
    • smtp type: dict
      • archive-block - No description for the parameter type: array choices: [encrypted, corrupted, multipart, nested, mailbomb, unhandled, partiallycorrupted, fileslimit, timeout] more...
      • archive-log - No description for the parameter type: array choices: [encrypted, corrupted, multipart, nested, mailbomb, unhandled, partiallycorrupted, fileslimit, timeout] more...
      • content-disarm - Enable Content Disarm and Reconstruction for this protocol. type: str choices: [disable, enable] more...
      • emulator - Enable/disable the virus emulator. type: str choices: [disable, enable] more...
      • executables - Treat Windows executable files as viruses for the purpose of blocking or monitoring. type: str choices: [default, virus] more...
      • options - No description for the parameter type: array choices: [scan, file-filter, quarantine, avquery, avmonitor] more...
      • outbreak-prevention - Enable Virus Outbreak Prevention service. type: str choices: [disabled, files, full-archive, disable, block, monitor] more...
      • av-scan - Enable AntiVirus scan service. type: str choices: [disable, monitor, block] more...
      • external-blocklist - Enable external-blocklist. type: str choices: [disable, monitor, block] more...
      • quarantine - Enable/disable quarantine for infected files. type: str choices: [disable, enable] more...
    • ssh type: dict
      • archive-block - No description for the parameter type: array choices: [encrypted, corrupted, multipart, nested, mailbomb, unhandled, partiallycorrupted, fileslimit, timeout] more...
      • archive-log - No description for the parameter type: array choices: [encrypted, corrupted, multipart, nested, mailbomb, unhandled, partiallycorrupted, fileslimit, timeout] more...
      • emulator - Enable/disable the virus emulator. type: str choices: [disable, enable] more...
      • options - No description for the parameter type: array choices: [avmonitor, quarantine, scan] more...
      • outbreak-prevention - Enable Virus Outbreak Prevention service. type: str choices: [disabled, files, full-archive, disable, block, monitor] more...
      • av-scan - Enable AntiVirus scan service. type: str choices: [disable, monitor, block] more...
      • external-blocklist - Enable external-blocklist. type: str choices: [disable, monitor, block] more...
      • quarantine - Enable/disable quarantine for infected files. type: str choices: [disable, enable] more...
    • analytics-accept-filetype - Only submit files matching this DLP file-pattern to FortiSandbox. type: str more...
    • analytics-ignore-filetype - Do not submit files matching this DLP file-pattern to FortiSandbox. type: str more...
    • ems-threat-feed - Enable/disable use of EMS threat feed when performing AntiVirus scan. type: str choices: [disable, enable] more...
    • external-blocklist - One or more external malware block lists. type: str more...
    • external-blocklist-archive-scan - Enable/disable external-blocklist archive scanning. type: str choices: [disable, enable] more...
    • external-blocklist-enable-all - Enable/disable all external blocklists. type: str choices: [disable, enable] more...
    • outbreak-prevention-archive-scan - Enable/disable outbreak-prevention archive scanning. type: str choices: [disable, enable] more...

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, legacy, ...]>
           feature-set: <value in [proxy, flow]>
           cifs:
              archive-block:
                - encrypted
                - corrupted
                - multipart
                - nested
                - mailbomb
                - unhandled
                - partiallycorrupted
                - fileslimit
                - timeout
              archive-log:
                - encrypted
                - corrupted
                - multipart
                - nested
                - mailbomb
                - unhandled
                - partiallycorrupted
                - fileslimit
                - timeout
              emulator: <value in [disable, enable]>
              options:
                - scan
                - quarantine
                - 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]>
           content-disarm:
              cover-page: <value in [disable, enable]>
              detect-only: <value in [disable, enable]>
              error-action: <value in [block, log-only, ignore]>
              office-action: <value in [disable, enable]>
              office-dde: <value in [disable, enable]>
              office-embed: <value in [disable, enable]>
              office-hylink: <value in [disable, enable]>
              office-linked: <value in [disable, enable]>
              office-macro: <value in [disable, enable]>
              original-file-destination: <value in [fortisandbox, quarantine, discard]>
              pdf-act-form: <value in [disable, enable]>
              pdf-act-gotor: <value in [disable, enable]>
              pdf-act-java: <value in [disable, enable]>
              pdf-act-launch: <value in [disable, enable]>
              pdf-act-movie: <value in [disable, enable]>
              pdf-act-sound: <value in [disable, enable]>
              pdf-embedfile: <value in [disable, enable]>
              pdf-hyperlink: <value in [disable, enable]>
              pdf-javacode: <value in [disable, enable]>
           ftp:
              archive-block:
                - encrypted
                - corrupted
                - multipart
                - nested
                - mailbomb
                - unhandled
                - partiallycorrupted
                - fileslimit
                - timeout
              archive-log:
                - encrypted
                - corrupted
                - multipart
                - nested
                - mailbomb
                - unhandled
                - partiallycorrupted
                - fileslimit
                - timeout
              emulator: <value in [disable, enable]>
              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]>
           http:
              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]>
              options:
                - scan
                - file-filter
                - quarantine
                - avquery
                - avmonitor
                - strict-file
              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]>
           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]>
           mapi:
              archive-block:
                - encrypted
                - corrupted
                - multipart
                - nested
                - mailbomb
                - unhandled
                - partiallycorrupted
                - fileslimit
                - timeout
              archive-log:
                - encrypted
                - corrupted
                - multipart
                - nested
                - mailbomb
                - unhandled
                - partiallycorrupted
                - fileslimit
                - timeout
              emulator: <value in [disable, enable]>
              executables: <value in [default, virus]>
              options:
                - scan
                - 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]>
           nac-quar:
              expiry: <value of string>
              infected: <value in [none, quar-src-ip, quar-interface]>
              log: <value in [disable, enable]>
           nntp:
              archive-block:
                - encrypted
                - corrupted
                - multipart
                - nested
                - mailbomb
                - unhandled
                - partiallycorrupted
                - fileslimit
                - timeout
              archive-log:
                - encrypted
                - corrupted
                - multipart
                - nested
                - mailbomb
                - unhandled
                - partiallycorrupted
                - fileslimit
                - timeout
              emulator: <value in [disable, enable]>
              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]>
           outbreak-prevention:
              external-blocklist: <value in [disable, enable]>
              ftgd-service: <value in [disable, enable]>
           pop3:
              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]>
           smtp:
              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]>
           ssh:
              archive-block:
                - encrypted
                - corrupted
                - multipart
                - nested
                - mailbomb
                - unhandled
                - partiallycorrupted
                - fileslimit
                - timeout
              archive-log:
                - encrypted
                - corrupted
                - multipart
                - nested
                - mailbomb
                - unhandled
                - partiallycorrupted
                - fileslimit
                - timeout
              emulator: <value in [disable, enable]>
              options:
                - avmonitor
                - quarantine
                - scan
              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]>
           analytics-accept-filetype: <value of string>
           analytics-ignore-filetype: <value of string>
           ems-threat-feed: <value in [disable, enable]>
           external-blocklist: <value of string>
           external-blocklist-archive-scan: <value in [disable, enable]>
           external-blocklist-enable-all: <value in [disable, enable]>
           outbreak-prevention-archive-scan: <value in [disable, enable]>

Return Values

Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

  • request_url - The full url requested returned: always type: str sample: /sys/login/user
  • response_code - The status of api request returned: always type: int sample: 0
  • response_message - The descriptive message of the api response returned: always type: str sample: OK
  • response_data - The data body of the api response returned: optional type: list or dict

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.