fmgd_antivirus_profile – Configure AntiVirus profiles.

Added in version 1.1.0.

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 v7.x.

Requirements

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

  • ansible-core>=2.16.0

FortiManager Version Compatibility

Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest

Parameters

  • access_token -The token to access FortiManager without using username and password. type: str required: false
  • 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
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
  • proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
  • 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
  • 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
  • device - The parameter in requested url type: str required: true
  • vdom - The parameter in requested url type: str required: true
  • antivirus_profile - Configure AntiVirus profiles. type: dict
    • analytics_accept_filetype (Alias name: analytics-accept-filetype) Only submit files matching this dlp file-pattern to fortisandbox (post-transfer scan only). type: list more...
    • analytics_db (Alias name: analytics-db) Enable/disable using the fortisandbox signature database to supplement the av signature databases. type: str choices: [disable, enable] more...
    • analytics_ignore_filetype (Alias name: analytics-ignore-filetype) Do not submit files matching this dlp file-pattern to fortisandbox (post-transfer scan only). type: list more...
    • av_block_log (Alias name: av-block-log) Enable/disable logging for antivirus file blocking. type: str choices: [disable, enable] more...
    • av_virus_log (Alias name: av-virus-log) Enable/disable antivirus logging. type: str choices: [disable, enable] more...
    • cifs Cifs. type: dict more...
      • archive_block (Alias name: archive-block) Select the archive types to block. type: list choices: [encrypted, corrupted, multipart, nested, mailbomb, unhandled, partiallycorrupted, timeout, fileslimit] more...
      • archive_log (Alias name: archive-log) Select the archive types to log. type: list choices: [encrypted, corrupted, multipart, nested, mailbomb, unhandled, partiallycorrupted, timeout, fileslimit] more...
      • av_scan (Alias name: av-scan) Enable antivirus scan service. type: str choices: [disable, monitor, block] more...
      • emulator Enable/disable the virus emulator. type: str choices: [disable, enable] more...
      • external_blocklist (Alias name: external-blocklist) Enable external-blocklist. type: str choices: [disable, monitor, block] more...
      • fortindr Enable scanning of files by fortindr. type: str choices: [disable, block, monitor] more...
      • fortisandbox Enable scanning of files by fortisandbox. type: str choices: [disable, block, monitor] more...
      • outbreak_prevention (Alias name: outbreak-prevention) Enable virus outbreak prevention service. type: str choices: [disable, block, monitor, files, disabled, full-archive] more...
      • quarantine Enable/disable quarantine for infected files. type: str choices: [disable, enable] more...
      • fortiai Enable/disable scanning of files by fortiai server. type: str choices: [disable, monitor, block] more...
      • options Enable/disable cifs antivirus scanning, monitoring, and quarantine. type: list choices: [scan, quarantine, avmonitor] more...
      • malware_stream (Alias name: malware-stream) Enable 0-day malware-stream scanning. type: str choices: [disable, monitor, block] more...
    • comment Comment. type: str more...
    • content_disarm (Alias name: content-disarm) Content disarm. type: dict more...
      • cover_page (Alias name: cover-page) Enable/disable inserting a cover page into the disarmed document. type: str choices: [disable, enable] more...
      • detect_only (Alias name: detect-only) Enable/disable only detect disarmable files, do not alter content. type: str choices: [disable, enable] more...
      • error_action (Alias name: error-action) Action to be taken if cdr engine encounters an unrecoverable error. type: str choices: [block, log-only, ignore] more...
      • office_action (Alias name: office-action) Enable/disable stripping of powerpoint action events in microsoft office documents. type: str choices: [disable, enable] more...
      • office_dde (Alias name: office-dde) Enable/disable stripping of dynamic data exchange events in microsoft office documents. type: str choices: [disable, enable] more...
      • office_embed (Alias name: office-embed) Enable/disable stripping of embedded objects in microsoft office documents. type: str choices: [disable, enable] more...
      • office_hylink (Alias name: office-hylink) Enable/disable stripping of hyperlinks in microsoft office documents. type: str choices: [disable, enable] more...
      • office_linked (Alias name: office-linked) Enable/disable stripping of linked objects in microsoft office documents. type: str choices: [disable, enable] more...
      • office_macro (Alias name: office-macro) Enable/disable stripping of macros in microsoft office documents. type: str choices: [disable, enable] more...
      • original_file_destination (Alias name: original-file-destination) Destination to send original file if active content is removed. type: str choices: [fortisandbox, quarantine, discard] more...
      • pdf_act_form (Alias name: 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 (Alias name: pdf-act-gotor) Enable/disable stripping of pdf document actions that access other pdf documents. type: str choices: [disable, enable] more...
      • pdf_act_java (Alias name: pdf-act-java) Enable/disable stripping of pdf document actions that execute javascript code. type: str choices: [disable, enable] more...
      • pdf_act_launch (Alias name: pdf-act-launch) Enable/disable stripping of pdf document actions that launch other applications. type: str choices: [disable, enable] more...
      • pdf_act_movie (Alias name: pdf-act-movie) Enable/disable stripping of pdf document actions that play a movie. type: str choices: [disable, enable] more...
      • pdf_act_sound (Alias name: pdf-act-sound) Enable/disable stripping of pdf document actions that play a sound. type: str choices: [disable, enable] more...
      • pdf_embedfile (Alias name: pdf-embedfile) Enable/disable stripping of embedded files in pdf documents. type: str choices: [disable, enable] more...
      • pdf_hyperlink (Alias name: pdf-hyperlink) Enable/disable stripping of hyperlinks from pdf documents. type: str choices: [disable, enable] more...
      • pdf_javacode (Alias name: pdf-javacode) Enable/disable stripping of javascript code in pdf documents. type: str choices: [disable, enable] more...
      • analytics_suspicious (Alias name: analytics-suspicious) Enable/disable using cdr as a secondary method for determining suspicous files for analytics. type: str choices: [disable, enable] more...
    • ems_threat_feed (Alias name: ems-threat-feed) Enable/disable use of ems threat feed when performing antivirus scan. type: str choices: [disable, enable] more...
    • external_blocklist (Alias name: external-blocklist) One or more external malware block lists. type: list more...
    • external_blocklist_enable_all (Alias name: external-blocklist-enable-all) Enable/disable all external blocklists. type: str choices: [disable, enable] more...
    • fortindr_error_action (Alias name: fortindr-error-action) Action to take if fortindr encounters an error. type: str choices: [log-only, block, ignore] more...
    • fortindr_timeout_action (Alias name: fortindr-timeout-action) Action to take if fortindr encounters a scan timeout. type: str choices: [log-only, block, ignore] more...
    • fortisandbox_error_action (Alias name: fortisandbox-error-action) Action to take if fortisandbox inline scan encounters an error. type: str choices: [log-only, block, ignore] more...
    • fortisandbox_max_upload (Alias name: fortisandbox-max-upload) Maximum size of files that can be uploaded to fortisandbox in mbytes. type: int more...
    • fortisandbox_mode (Alias name: fortisandbox-mode) Fortisandbox scan modes. type: str choices: [inline, analytics-suspicious, analytics-everything] more...
    • fortisandbox_timeout_action (Alias name: fortisandbox-timeout-action) Action to take if fortisandbox inline scan encounters a scan timeout. type: str choices: [log-only, block, ignore] more...
    • ftp Ftp. type: dict more...
      • archive_block (Alias name: archive-block) Select the archive types to block. type: list choices: [encrypted, corrupted, multipart, nested, mailbomb, unhandled, partiallycorrupted, timeout, fileslimit] more...
      • archive_log (Alias name: archive-log) Select the archive types to log. type: list choices: [encrypted, corrupted, multipart, nested, mailbomb, unhandled, partiallycorrupted, timeout, fileslimit] more...
      • av_scan (Alias name: av-scan) Enable antivirus scan service. type: str choices: [disable, monitor, block] more...
      • emulator Enable/disable the virus emulator. type: str choices: [disable, enable] more...
      • external_blocklist (Alias name: external-blocklist) Enable external-blocklist. type: str choices: [disable, monitor, block] more...
      • fortindr Enable scanning of files by fortindr. type: str choices: [disable, block, monitor] more...
      • fortisandbox Enable scanning of files by fortisandbox. type: str choices: [disable, block, monitor] more...
      • outbreak_prevention (Alias name: outbreak-prevention) Enable virus outbreak prevention service. type: str choices: [disable, block, monitor, files, disabled, full-archive] more...
      • quarantine Enable/disable quarantine for infected files. type: str choices: [disable, enable] more...
      • fortiai Enable/disable scanning of files by fortiai server. type: str choices: [disable, monitor, block] more...
      • options Enable/disable ftp antivirus scanning, monitoring, and quarantine. type: list choices: [scan, quarantine, avmonitor] more...
      • malware_stream (Alias name: malware-stream) Enable 0-day malware-stream scanning. type: str choices: [disable, monitor, block] more...
    • http Http. type: dict more...
      • archive_block (Alias name: archive-block) Select the archive types to block. type: list choices: [encrypted, corrupted, multipart, nested, mailbomb, unhandled, partiallycorrupted, timeout, fileslimit] more...
      • archive_log (Alias name: archive-log) Select the archive types to log. type: list choices: [encrypted, corrupted, multipart, nested, mailbomb, unhandled, partiallycorrupted, timeout, fileslimit] more...
      • av_scan (Alias name: av-scan) Enable antivirus scan service. type: str choices: [disable, monitor, block] more...
      • content_disarm (Alias name: content-disarm) Enable/disable content disarm and reconstruction when performing antivirus scan. type: str choices: [disable, enable] more...
      • emulator Enable/disable the virus emulator. type: str choices: [disable, enable] more...
      • external_blocklist (Alias name: external-blocklist) Enable external-blocklist. type: str choices: [disable, monitor, block] more...
      • fortindr Enable scanning of files by fortindr. type: str choices: [disable, block, monitor] more...
      • fortisandbox Enable scanning of files by fortisandbox. type: str choices: [disable, block, monitor] more...
      • outbreak_prevention (Alias name: outbreak-prevention) Enable virus outbreak prevention service. type: str choices: [disable, block, monitor, files, disabled, full-archive] more...
      • quarantine Enable/disable quarantine for infected files. type: str choices: [disable, enable] more...
      • unknown_content_encoding (Alias name: unknown-content-encoding) Configure the action the fortigate unit will take on unknown content-encoding. type: str choices: [block, inspect, bypass] more...
      • fortiai Enable/disable scanning of files by fortiai server. type: str choices: [disable, monitor, block] more...
      • options Enable/disable http antivirus scanning, monitoring, and quarantine. type: list choices: [scan, quarantine, avmonitor] more...
      • av_optimize (Alias name: av-optimize) Av optimize. type: str choices: [disable, enable] more...
      • malware_stream (Alias name: malware-stream) Enable 0-day malware-stream scanning. type: str choices: [disable, monitor, block] more...
    • imap Imap. type: dict more...
      • archive_block (Alias name: archive-block) Select the archive types to block. type: list choices: [encrypted, corrupted, multipart, nested, mailbomb, unhandled, partiallycorrupted, timeout, fileslimit] more...
      • archive_log (Alias name: archive-log) Select the archive types to log. type: list choices: [encrypted, corrupted, multipart, nested, mailbomb, unhandled, partiallycorrupted, timeout, fileslimit] more...
      • av_scan (Alias name: av-scan) Enable antivirus scan service. type: str choices: [disable, monitor, block] more...
      • content_disarm (Alias name: content-disarm) Enable/disable content disarm and reconstruction when performing antivirus scan. 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...
      • external_blocklist (Alias name: external-blocklist) Enable external-blocklist. type: str choices: [disable, monitor, block] more...
      • fortindr Enable scanning of files by fortindr. type: str choices: [disable, block, monitor] more...
      • fortisandbox Enable scanning of files by fortisandbox. type: str choices: [disable, block, monitor] more...
      • outbreak_prevention (Alias name: outbreak-prevention) Enable virus outbreak prevention service. type: str choices: [disable, block, monitor, files, disabled, full-archive] more...
      • quarantine Enable/disable quarantine for infected files. type: str choices: [disable, enable] more...
      • fortiai Enable/disable scanning of files by fortiai server. type: str choices: [disable, monitor, block] more...
      • options Enable/disable imap antivirus scanning, monitoring, and quarantine. type: list choices: [scan, quarantine, avmonitor] more...
      • malware_stream (Alias name: malware-stream) Enable 0-day malware-stream scanning. type: str choices: [disable, monitor, block] more...
    • mapi Mapi. type: dict more...
      • archive_block (Alias name: archive-block) Select the archive types to block. type: list choices: [encrypted, corrupted, multipart, nested, mailbomb, unhandled, partiallycorrupted, timeout, fileslimit] more...
      • archive_log (Alias name: archive-log) Select the archive types to log. type: list choices: [encrypted, corrupted, multipart, nested, mailbomb, unhandled, partiallycorrupted, timeout, fileslimit] more...
      • av_scan (Alias name: av-scan) Enable antivirus scan service. type: str choices: [disable, monitor, block] 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...
      • external_blocklist (Alias name: external-blocklist) Enable external-blocklist. type: str choices: [disable, monitor, block] more...
      • fortindr Enable scanning of files by fortindr. type: str choices: [disable, block, monitor] more...
      • fortisandbox Enable scanning of files by fortisandbox. type: str choices: [disable, block, monitor] more...
      • outbreak_prevention (Alias name: outbreak-prevention) Enable virus outbreak prevention service. type: str choices: [disable, block, monitor, files, disabled, full-archive] more...
      • quarantine Enable/disable quarantine for infected files. type: str choices: [disable, enable] more...
      • fortiai Enable/disable scanning of files by fortiai server. type: str choices: [disable, monitor, block] more...
      • options Enable/disable mapi antivirus scanning, monitoring, and quarantine. type: list choices: [scan, quarantine, avmonitor] more...
      • malware_stream (Alias name: malware-stream) Enable 0-day malware-stream scanning. type: str choices: [disable, monitor, block] more...
    • mobile_malware_db (Alias name: mobile-malware-db) Enable/disable using the mobile malware signature database. type: str choices: [disable, enable] more...
    • nac_quar (Alias name: nac-quar) Nac quar. type: dict more...
      • 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] more...
      • log Enable/disable antivirus quarantine logging. type: str choices: [disable, enable] more...
    • name Profile name. type: str more...
    • nntp Nntp. type: dict more...
      • archive_block (Alias name: archive-block) Select the archive types to block. type: list choices: [encrypted, corrupted, multipart, nested, mailbomb, unhandled, partiallycorrupted, timeout, fileslimit] more...
      • archive_log (Alias name: archive-log) Select the archive types to log. type: list choices: [encrypted, corrupted, multipart, nested, mailbomb, unhandled, partiallycorrupted, timeout, fileslimit] more...
      • av_scan (Alias name: av-scan) Enable antivirus scan service. type: str choices: [disable, monitor, block] more...
      • emulator Enable/disable the virus emulator. type: str choices: [disable, enable] more...
      • external_blocklist (Alias name: external-blocklist) Enable external-blocklist. type: str choices: [disable, monitor, block] more...
      • fortindr Enable scanning of files by fortindr. type: str choices: [disable, block, monitor] more...
      • fortisandbox Enable scanning of files by fortisandbox. type: str choices: [disable, block, monitor] more...
      • outbreak_prevention (Alias name: outbreak-prevention) Enable virus outbreak prevention service. type: str choices: [disable, block, monitor, files, disabled, full-archive] more...
      • quarantine Enable/disable quarantine for infected files. type: str choices: [disable, enable] more...
      • fortiai Enable/disable scanning of files by fortiai server. type: str choices: [disable, monitor, block] more...
      • options Enable/disable nntp antivirus scanning, monitoring, and quarantine. type: list choices: [scan, quarantine, avmonitor] more...
      • malware_stream (Alias name: malware-stream) Enable 0-day malware-stream scanning. type: str choices: [disable, monitor, block] more...
    • outbreak_prevention_archive_scan (Alias name: outbreak-prevention-archive-scan) Enable/disable outbreak-prevention archive scanning. type: str choices: [disable, enable] more...
    • pop3 Pop3. type: dict more...
      • archive_block (Alias name: archive-block) Select the archive types to block. type: list choices: [encrypted, corrupted, multipart, nested, mailbomb, unhandled, partiallycorrupted, timeout, fileslimit] more...
      • archive_log (Alias name: archive-log) Select the archive types to log. type: list choices: [encrypted, corrupted, multipart, nested, mailbomb, unhandled, partiallycorrupted, timeout, fileslimit] more...
      • av_scan (Alias name: av-scan) Enable antivirus scan service. type: str choices: [disable, monitor, block] more...
      • content_disarm (Alias name: content-disarm) Enable/disable content disarm and reconstruction when performing antivirus scan. 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...
      • external_blocklist (Alias name: external-blocklist) Enable external-blocklist. type: str choices: [disable, monitor, block] more...
      • fortindr Enable scanning of files by fortindr. type: str choices: [disable, block, monitor] more...
      • fortisandbox Enable scanning of files by fortisandbox. type: str choices: [disable, block, monitor] more...
      • outbreak_prevention (Alias name: outbreak-prevention) Enable virus outbreak prevention service. type: str choices: [disable, block, monitor, files, disabled, full-archive] more...
      • quarantine Enable/disable quarantine for infected files. type: str choices: [disable, enable] more...
      • fortiai Enable/disable scanning of files by fortiai server. type: str choices: [disable, monitor, block] more...
      • options Enable/disable pop3 antivirus scanning, monitoring, and quarantine. type: list choices: [scan, quarantine, avmonitor] more...
      • malware_stream (Alias name: malware-stream) Enable 0-day malware-stream scanning. type: str choices: [disable, monitor, block] more...
    • replacemsg_group (Alias name: replacemsg-group) Replacement message group customized for this profile. type: list more...
    • scan_mode (Alias name: scan-mode) Configure scan mode (default or legacy). type: str choices: [legacy, default, full, quick] more...
    • smtp Smtp. type: dict more...
      • archive_block (Alias name: archive-block) Select the archive types to block. type: list choices: [encrypted, corrupted, multipart, nested, mailbomb, unhandled, partiallycorrupted, timeout, fileslimit] more...
      • archive_log (Alias name: archive-log) Select the archive types to log. type: list choices: [encrypted, corrupted, multipart, nested, mailbomb, unhandled, partiallycorrupted, timeout, fileslimit] more...
      • av_scan (Alias name: av-scan) Enable antivirus scan service. type: str choices: [disable, monitor, block] more...
      • content_disarm (Alias name: content-disarm) Enable/disable content disarm and reconstruction when performing antivirus scan. 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...
      • external_blocklist (Alias name: external-blocklist) Enable external-blocklist. type: str choices: [disable, monitor, block] more...
      • fortindr Enable scanning of files by fortindr. type: str choices: [disable, block, monitor] more...
      • fortisandbox Enable scanning of files by fortisandbox. type: str choices: [disable, block, monitor] more...
      • outbreak_prevention (Alias name: outbreak-prevention) Enable virus outbreak prevention service. type: str choices: [disable, block, monitor, files, disabled, full-archive] more...
      • quarantine Enable/disable quarantine for infected files. type: str choices: [disable, enable] more...
      • fortiai Enable/disable scanning of files by fortiai server. type: str choices: [disable, monitor, block] more...
      • options Enable/disable smtp antivirus scanning, monitoring, and quarantine. type: list choices: [scan, quarantine, avmonitor] more...
      • malware_stream (Alias name: malware-stream) Enable 0-day malware-stream scanning. type: str choices: [disable, monitor, block] more...
    • ssh Ssh. type: dict more...
      • archive_block (Alias name: archive-block) Select the archive types to block. type: list choices: [encrypted, corrupted, multipart, nested, mailbomb, unhandled, partiallycorrupted, timeout, fileslimit] more...
      • archive_log (Alias name: archive-log) Select the archive types to log. type: list choices: [encrypted, corrupted, multipart, nested, mailbomb, unhandled, partiallycorrupted, timeout, fileslimit] more...
      • av_scan (Alias name: av-scan) Enable antivirus scan service. type: str choices: [disable, monitor, block] more...
      • emulator Enable/disable the virus emulator. type: str choices: [disable, enable] more...
      • external_blocklist (Alias name: external-blocklist) Enable external-blocklist. type: str choices: [disable, monitor, block] more...
      • fortindr Enable scanning of files by fortindr. type: str choices: [disable, block, monitor] more...
      • fortisandbox Enable scanning of files by fortisandbox. type: str choices: [disable, block, monitor] more...
      • outbreak_prevention (Alias name: outbreak-prevention) Enable virus outbreak prevention service. type: str choices: [disable, block, monitor, files, disabled, full-archive] more...
      • quarantine Enable/disable quarantine for infected files. type: str choices: [disable, enable] more...
      • fortiai Enable/disable scanning of files by fortiai server. type: str choices: [disable, monitor, block] more...
      • options Enable/disable sftp and scp antivirus scanning, monitoring, and quarantine. type: list choices: [avmonitor, quarantine, scan] more...
      • malware_stream (Alias name: malware-stream) Enable 0-day malware-stream scanning. type: str choices: [disable, monitor, block] more...
    • feature_set (Alias name: feature-set) Flow/proxy feature set. type: str choices: [proxy, flow] more...
    • extended_log (Alias name: extended-log) Enable/disable extended logging for antivirus. type: str choices: [disable, enable] more...
    • ftgd_analytics (Alias name: ftgd-analytics) Settings to control which files are uploaded to fortisandbox. type: str choices: [disable, suspicious, everything] more...
    • analytics_max_upload (Alias name: analytics-max-upload) Maximum size of files that can be uploaded to fortisandbox. type: int more...
    • fortiai_error_action (Alias name: fortiai-error-action) Action to take if fortiai encounters an error. type: str choices: [block, log-only, ignore] more...
    • fortiai_timeout_action (Alias name: fortiai-timeout-action) Fortiai timeout action. type: str choices: [block, log-only, ignore] more...
    • external_blocklist_archive_scan (Alias name: external-blocklist-archive-scan) External blocklist archive scan. type: str choices: [disable, enable] more...
    • outbreak_prevention (Alias name: outbreak-prevention) Outbreak prevention. type: dict more...
      • external_blocklist (Alias name: external-blocklist) Enable/disable external malware blocklist. type: str choices: [disable, enable] more...
      • ftgd_service (Alias name: ftgd-service) Enable/disable fortiguard virus outbreak prevention service. type: str choices: [disable, enable] more...
    • analytics_bl_filetype (Alias name: analytics-bl-filetype) Only submit files matching this dlp file-pattern to fortisandbox. type: list more...
    • analytics_wl_filetype (Alias name: analytics-wl-filetype) Do not submit files matching this dlp file-pattern to fortisandbox. type: list more...
    • fortisandbox_scan_timeout (Alias name: fortisandbox-scan-timeout) Fortisandbox inline scan timeout in seconds (30 - 180, default = 60). type: int 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

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure AntiVirus profiles.
      fortinet.fmgdevice.fmgd_antivirus_profile:
        # bypass_validation: false
        # workspace_locking_adom: <global or your adom name>
        # workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        device: <your own value>
        vdom: <your own value>
        state: present # <value in [present, absent]>
        antivirus_profile:
          name: "your value" # Required variable, string
          # analytics_accept_filetype: <list or string>
          # analytics_db: <value in [disable, enable]>
          # analytics_ignore_filetype: <list or string>
          # av_block_log: <value in [disable, enable]>
          # av_virus_log: <value in [disable, enable]>
          # cifs:
          #   archive_block:
          #     - "encrypted"
          #     - "corrupted"
          #     - "multipart"
          #     - "nested"
          #     - "mailbomb"
          #     - "unhandled"
          #     - "partiallycorrupted"
          #     - "timeout"
          #     - "fileslimit"
          #   archive_log:
          #     - "encrypted"
          #     - "corrupted"
          #     - "multipart"
          #     - "nested"
          #     - "mailbomb"
          #     - "unhandled"
          #     - "partiallycorrupted"
          #     - "timeout"
          #     - "fileslimit"
          #   av_scan: <value in [disable, monitor, block]>
          #   emulator: <value in [disable, enable]>
          #   external_blocklist: <value in [disable, monitor, block]>
          #   fortindr: <value in [disable, block, monitor]>
          #   fortisandbox: <value in [disable, block, monitor]>
          #   outbreak_prevention: <value in [disable, block, monitor, ...]>
          #   quarantine: <value in [disable, enable]>
          #   fortiai: <value in [disable, monitor, block]>
          #   options:
          #     - "scan"
          #     - "quarantine"
          #     - "avmonitor"
          #   malware_stream: <value in [disable, monitor, block]>
          # comment: <string>
          # 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]>
          #   analytics_suspicious: <value in [disable, enable]>
          # ems_threat_feed: <value in [disable, enable]>
          # external_blocklist: <list or string>
          # external_blocklist_enable_all: <value in [disable, enable]>
          # fortindr_error_action: <value in [log-only, block, ignore]>
          # fortindr_timeout_action: <value in [log-only, block, ignore]>
          # fortisandbox_error_action: <value in [log-only, block, ignore]>
          # fortisandbox_max_upload: <integer>
          # fortisandbox_mode: <value in [inline, analytics-suspicious, analytics-everything]>
          # fortisandbox_timeout_action: <value in [log-only, block, ignore]>
          # ftp:
          #   archive_block:
          #     - "encrypted"
          #     - "corrupted"
          #     - "multipart"
          #     - "nested"
          #     - "mailbomb"
          #     - "unhandled"
          #     - "partiallycorrupted"
          #     - "timeout"
          #     - "fileslimit"
          #   archive_log:
          #     - "encrypted"
          #     - "corrupted"
          #     - "multipart"
          #     - "nested"
          #     - "mailbomb"
          #     - "unhandled"
          #     - "partiallycorrupted"
          #     - "timeout"
          #     - "fileslimit"
          #   av_scan: <value in [disable, monitor, block]>
          #   emulator: <value in [disable, enable]>
          #   external_blocklist: <value in [disable, monitor, block]>
          #   fortindr: <value in [disable, block, monitor]>
          #   fortisandbox: <value in [disable, block, monitor]>
          #   outbreak_prevention: <value in [disable, block, monitor, ...]>
          #   quarantine: <value in [disable, enable]>
          #   fortiai: <value in [disable, monitor, block]>
          #   options:
          #     - "scan"
          #     - "quarantine"
          #     - "avmonitor"
          #   malware_stream: <value in [disable, monitor, block]>
          # http:
          #   archive_block:
          #     - "encrypted"
          #     - "corrupted"
          #     - "multipart"
          #     - "nested"
          #     - "mailbomb"
          #     - "unhandled"
          #     - "partiallycorrupted"
          #     - "timeout"
          #     - "fileslimit"
          #   archive_log:
          #     - "encrypted"
          #     - "corrupted"
          #     - "multipart"
          #     - "nested"
          #     - "mailbomb"
          #     - "unhandled"
          #     - "partiallycorrupted"
          #     - "timeout"
          #     - "fileslimit"
          #   av_scan: <value in [disable, monitor, block]>
          #   content_disarm: <value in [disable, enable]>
          #   emulator: <value in [disable, enable]>
          #   external_blocklist: <value in [disable, monitor, block]>
          #   fortindr: <value in [disable, block, monitor]>
          #   fortisandbox: <value in [disable, block, monitor]>
          #   outbreak_prevention: <value in [disable, block, monitor, ...]>
          #   quarantine: <value in [disable, enable]>
          #   unknown_content_encoding: <value in [block, inspect, bypass]>
          #   fortiai: <value in [disable, monitor, block]>
          #   options:
          #     - "scan"
          #     - "quarantine"
          #     - "avmonitor"
          #   av_optimize: <value in [disable, enable]>
          #   malware_stream: <value in [disable, monitor, block]>
          # imap:
          #   archive_block:
          #     - "encrypted"
          #     - "corrupted"
          #     - "multipart"
          #     - "nested"
          #     - "mailbomb"
          #     - "unhandled"
          #     - "partiallycorrupted"
          #     - "timeout"
          #     - "fileslimit"
          #   archive_log:
          #     - "encrypted"
          #     - "corrupted"
          #     - "multipart"
          #     - "nested"
          #     - "mailbomb"
          #     - "unhandled"
          #     - "partiallycorrupted"
          #     - "timeout"
          #     - "fileslimit"
          #   av_scan: <value in [disable, monitor, block]>
          #   content_disarm: <value in [disable, enable]>
          #   emulator: <value in [disable, enable]>
          #   executables: <value in [default, virus]>
          #   external_blocklist: <value in [disable, monitor, block]>
          #   fortindr: <value in [disable, block, monitor]>
          #   fortisandbox: <value in [disable, block, monitor]>
          #   outbreak_prevention: <value in [disable, block, monitor, ...]>
          #   quarantine: <value in [disable, enable]>
          #   fortiai: <value in [disable, monitor, block]>
          #   options:
          #     - "scan"
          #     - "quarantine"
          #     - "avmonitor"
          #   malware_stream: <value in [disable, monitor, block]>
          # mapi:
          #   archive_block:
          #     - "encrypted"
          #     - "corrupted"
          #     - "multipart"
          #     - "nested"
          #     - "mailbomb"
          #     - "unhandled"
          #     - "partiallycorrupted"
          #     - "timeout"
          #     - "fileslimit"
          #   archive_log:
          #     - "encrypted"
          #     - "corrupted"
          #     - "multipart"
          #     - "nested"
          #     - "mailbomb"
          #     - "unhandled"
          #     - "partiallycorrupted"
          #     - "timeout"
          #     - "fileslimit"
          #   av_scan: <value in [disable, monitor, block]>
          #   emulator: <value in [disable, enable]>
          #   executables: <value in [default, virus]>
          #   external_blocklist: <value in [disable, monitor, block]>
          #   fortindr: <value in [disable, block, monitor]>
          #   fortisandbox: <value in [disable, block, monitor]>
          #   outbreak_prevention: <value in [disable, block, monitor, ...]>
          #   quarantine: <value in [disable, enable]>
          #   fortiai: <value in [disable, monitor, block]>
          #   options:
          #     - "scan"
          #     - "quarantine"
          #     - "avmonitor"
          #   malware_stream: <value in [disable, monitor, block]>
          # mobile_malware_db: <value in [disable, enable]>
          # nac_quar:
          #   expiry: <string>
          #   infected: <value in [none, quar-src-ip]>
          #   log: <value in [disable, enable]>
          # nntp:
          #   archive_block:
          #     - "encrypted"
          #     - "corrupted"
          #     - "multipart"
          #     - "nested"
          #     - "mailbomb"
          #     - "unhandled"
          #     - "partiallycorrupted"
          #     - "timeout"
          #     - "fileslimit"
          #   archive_log:
          #     - "encrypted"
          #     - "corrupted"
          #     - "multipart"
          #     - "nested"
          #     - "mailbomb"
          #     - "unhandled"
          #     - "partiallycorrupted"
          #     - "timeout"
          #     - "fileslimit"
          #   av_scan: <value in [disable, monitor, block]>
          #   emulator: <value in [disable, enable]>
          #   external_blocklist: <value in [disable, monitor, block]>
          #   fortindr: <value in [disable, block, monitor]>
          #   fortisandbox: <value in [disable, block, monitor]>
          #   outbreak_prevention: <value in [disable, block, monitor, ...]>
          #   quarantine: <value in [disable, enable]>
          #   fortiai: <value in [disable, monitor, block]>
          #   options:
          #     - "scan"
          #     - "quarantine"
          #     - "avmonitor"
          #   malware_stream: <value in [disable, monitor, block]>
          # outbreak_prevention_archive_scan: <value in [disable, enable]>
          # pop3:
          #   archive_block:
          #     - "encrypted"
          #     - "corrupted"
          #     - "multipart"
          #     - "nested"
          #     - "mailbomb"
          #     - "unhandled"
          #     - "partiallycorrupted"
          #     - "timeout"
          #     - "fileslimit"
          #   archive_log:
          #     - "encrypted"
          #     - "corrupted"
          #     - "multipart"
          #     - "nested"
          #     - "mailbomb"
          #     - "unhandled"
          #     - "partiallycorrupted"
          #     - "timeout"
          #     - "fileslimit"
          #   av_scan: <value in [disable, monitor, block]>
          #   content_disarm: <value in [disable, enable]>
          #   emulator: <value in [disable, enable]>
          #   executables: <value in [default, virus]>
          #   external_blocklist: <value in [disable, monitor, block]>
          #   fortindr: <value in [disable, block, monitor]>
          #   fortisandbox: <value in [disable, block, monitor]>
          #   outbreak_prevention: <value in [disable, block, monitor, ...]>
          #   quarantine: <value in [disable, enable]>
          #   fortiai: <value in [disable, monitor, block]>
          #   options:
          #     - "scan"
          #     - "quarantine"
          #     - "avmonitor"
          #   malware_stream: <value in [disable, monitor, block]>
          # replacemsg_group: <list or string>
          # scan_mode: <value in [legacy, default, full, ...]>
          # smtp:
          #   archive_block:
          #     - "encrypted"
          #     - "corrupted"
          #     - "multipart"
          #     - "nested"
          #     - "mailbomb"
          #     - "unhandled"
          #     - "partiallycorrupted"
          #     - "timeout"
          #     - "fileslimit"
          #   archive_log:
          #     - "encrypted"
          #     - "corrupted"
          #     - "multipart"
          #     - "nested"
          #     - "mailbomb"
          #     - "unhandled"
          #     - "partiallycorrupted"
          #     - "timeout"
          #     - "fileslimit"
          #   av_scan: <value in [disable, monitor, block]>
          #   content_disarm: <value in [disable, enable]>
          #   emulator: <value in [disable, enable]>
          #   executables: <value in [default, virus]>
          #   external_blocklist: <value in [disable, monitor, block]>
          #   fortindr: <value in [disable, block, monitor]>
          #   fortisandbox: <value in [disable, block, monitor]>
          #   outbreak_prevention: <value in [disable, block, monitor, ...]>
          #   quarantine: <value in [disable, enable]>
          #   fortiai: <value in [disable, monitor, block]>
          #   options:
          #     - "scan"
          #     - "quarantine"
          #     - "avmonitor"
          #   malware_stream: <value in [disable, monitor, block]>
          # ssh:
          #   archive_block:
          #     - "encrypted"
          #     - "corrupted"
          #     - "multipart"
          #     - "nested"
          #     - "mailbomb"
          #     - "unhandled"
          #     - "partiallycorrupted"
          #     - "timeout"
          #     - "fileslimit"
          #   archive_log:
          #     - "encrypted"
          #     - "corrupted"
          #     - "multipart"
          #     - "nested"
          #     - "mailbomb"
          #     - "unhandled"
          #     - "partiallycorrupted"
          #     - "timeout"
          #     - "fileslimit"
          #   av_scan: <value in [disable, monitor, block]>
          #   emulator: <value in [disable, enable]>
          #   external_blocklist: <value in [disable, monitor, block]>
          #   fortindr: <value in [disable, block, monitor]>
          #   fortisandbox: <value in [disable, block, monitor]>
          #   outbreak_prevention: <value in [disable, block, monitor, ...]>
          #   quarantine: <value in [disable, enable]>
          #   fortiai: <value in [disable, monitor, block]>
          #   options:
          #     - "avmonitor"
          #     - "quarantine"
          #     - "scan"
          #   malware_stream: <value in [disable, monitor, block]>
          # feature_set: <value in [proxy, flow]>
          # extended_log: <value in [disable, enable]>
          # ftgd_analytics: <value in [disable, suspicious, everything]>
          # analytics_max_upload: <integer>
          # fortiai_error_action: <value in [block, log-only, ignore]>
          # fortiai_timeout_action: <value in [block, log-only, ignore]>
          # external_blocklist_archive_scan: <value in [disable, enable]>
          # outbreak_prevention:
          #   external_blocklist: <value in [disable, enable]>
          #   ftgd_service: <value in [disable, enable]>
          # analytics_bl_filetype: <list or string>
          # analytics_wl_filetype: <list or string>
          # fortisandbox_scan_timeout: <integer>

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:

  • meta - The result of the request.returned: always type: dict
    • 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_data - The data body of the api response. returned: optional type: list or dict
    • response_message - The descriptive message of the api response. returned: always type: str sample: OK
    • system_information - The information of the target system. returned: always type: dict
  • rc - The status the request. returned: always type: int sample: 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list

Status

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

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)