fortios_antivirus_profile – Configure AntiVirus profiles in Fortinet’s FortiOS and FortiGate.

New in version 2.0.0.

Synopsis

  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify antivirus feature and profile category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements

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

  • ansible>=2.15

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility

Supported Version Ranges: v6.0.0 -> 7.4.3

Parameters

  • access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • vdom - Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. type: str default: root
  • member_path - Member attribute path to operate on. type: str
  • member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
  • state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
  • antivirus_profile - Configure AntiVirus profiles. type: dict more...
    • analytics_accept_filetype - Only submit files matching this DLP file-pattern to FortiSandbox (post-transfer scan only). Source dlp.filepattern.id. type: int more...
    • analytics_bl_filetype - Only submit files matching this DLP file-pattern to FortiSandbox. Source dlp.filepattern.id. type: int more...
    • analytics_db - Enable/disable using the FortiSandbox signature database to supplement the AV signature databases. type: str choices: disable, enable more...
    • analytics_ignore_filetype - Do not submit files matching this DLP file-pattern to FortiSandbox (post-transfer scan only). Source dlp.filepattern.id. type: int more...
    • analytics_max_upload - Maximum size of files that can be uploaded to FortiSandbox. type: int more...
    • analytics_wl_filetype - Do not submit files matching this DLP file-pattern to FortiSandbox. Source dlp.filepattern.id. type: int more...
    • av_block_log - Enable/disable logging for AntiVirus file blocking. type: str choices: enable, disable more...
    • av_virus_log - Enable/disable AntiVirus logging. type: str choices: enable, disable more...
    • cifs - Configure CIFS AntiVirus options. type: dict more...
      • archive_block - Select the archive types to block. type: list choices: encrypted, corrupted, partiallycorrupted, multipart, nested, mailbomb, timeout, unhandled, fileslimit more...
      • archive_log - Select the archive types to log. type: list choices: encrypted, corrupted, partiallycorrupted, multipart, nested, mailbomb, timeout, unhandled, fileslimit more...
      • av_scan - Enable AntiVirus scan service. type: str choices: disable, block, monitor more...
      • emulator - Enable/disable the virus emulator. type: str choices: enable, disable more...
      • external_blocklist - Enable external-blocklist. Analyzes files including the content of archives. type: str choices: disable, block, monitor more...
      • fortiai - Enable/disable scanning of files by FortiAI. type: str choices: disable, block, monitor 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...
      • options - Enable/disable CIFS AntiVirus scanning, monitoring, and quarantine. type: list choices: scan, avmonitor, quarantine more...
      • outbreak_prevention - Enable virus outbreak prevention service. type: str choices: disable, block, monitor, disabled, files, full-archive more...
      • quarantine - Enable/disable quarantine for infected files. type: str choices: disable, enable more...
    • comment - Comment. type: str more...
    • content_disarm - AV Content Disarm and Reconstruction settings. type: dict more...
      • 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...
    • ems_threat_feed - Enable/disable use of EMS threat feed when performing AntiVirus scan. Analyzes files including the content of archives. type: str choices: disable, enable more...
    • extended_log - Enable/disable extended logging for antivirus. type: str choices: enable, disable more...
    • external_blocklist - One or more external malware block lists. type: list member_path: external_blocklist:name more...
      • name - External blocklist. Source system.external-resource.name. type: str required: true 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...
    • feature_set - Flow/proxy feature set. type: str choices: flow, proxy more...
    • fortiai_error_action - Action to take if FortiAI encounters an error. type: str choices: log-only, block, ignore more...
    • fortiai_timeout_action - Action to take if FortiAI encounters a scan timeout. type: str choices: log-only, block, ignore more...
    • fortindr_error_action - Action to take if FortiNDR encounters an error. type: str choices: log-only, block, ignore more...
    • fortindr_timeout_action - Action to take if FortiNDR encounters a scan timeout. type: str choices: log-only, block, ignore more...
    • fortisandbox_error_action - Action to take if FortiSandbox inline scan encounters an error. type: str choices: log-only, block, ignore more...
    • fortisandbox_max_upload - Maximum size of files that can be uploaded to FortiSandbox in Mbytes. type: int more...
    • fortisandbox_mode - FortiSandbox scan modes. type: str choices: inline, analytics-suspicious, analytics-everything more...
    • fortisandbox_timeout_action - Action to take if FortiSandbox inline scan encounters a scan timeout. type: str choices: log-only, block, ignore more...
    • ftgd_analytics - Settings to control which files are uploaded to FortiSandbox. type: str choices: disable, suspicious, everything more...
    • ftp - Configure FTP AntiVirus options. type: dict more...
      • archive_block - Select the archive types to block. type: list choices: encrypted, corrupted, partiallycorrupted, multipart, nested, mailbomb, timeout, unhandled, fileslimit more...
      • archive_log - Select the archive types to log. type: list choices: encrypted, corrupted, partiallycorrupted, multipart, nested, mailbomb, timeout, unhandled, fileslimit more...
      • av_scan - Enable AntiVirus scan service. type: str choices: disable, block, monitor more...
      • emulator - Enable/disable the virus emulator. type: str choices: enable, disable more...
      • external_blocklist - Enable external-blocklist. Analyzes files including the content of archives. type: str choices: disable, block, monitor more...
      • fortiai - Enable/disable scanning of files by FortiAI. type: str choices: disable, block, monitor 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...
      • options - Enable/disable FTP AntiVirus scanning, monitoring, and quarantine. type: list choices: scan, avmonitor, quarantine more...
      • outbreak_prevention - Enable virus outbreak prevention service. type: str choices: disable, block, monitor, disabled, files, full-archive more...
      • quarantine - Enable/disable quarantine for infected files. type: str choices: disable, enable more...
    • http - Configure HTTP AntiVirus options. type: dict more...
      • archive_block - Select the archive types to block. type: list choices: encrypted, corrupted, partiallycorrupted, multipart, nested, mailbomb, timeout, unhandled, fileslimit more...
      • archive_log - Select the archive types to log. type: list choices: encrypted, corrupted, partiallycorrupted, multipart, nested, mailbomb, timeout, unhandled, fileslimit more...
      • av_scan - Enable AntiVirus scan service. type: str choices: disable, block, monitor more...
      • 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: enable, disable more...
      • external_blocklist - Enable external-blocklist. Analyzes files including the content of archives. type: str choices: disable, block, monitor more...
      • fortiai - Enable/disable scanning of files by FortiAI. type: str choices: disable, block, monitor 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...
      • options - Enable/disable HTTP AntiVirus scanning, monitoring, and quarantine. type: list choices: scan, avmonitor, quarantine more...
      • outbreak_prevention - Enable virus outbreak prevention service. type: str choices: disable, block, monitor, disabled, files, full-archive more...
      • quarantine - Enable/disable quarantine for infected files. type: str choices: disable, enable more...
      • unknown_content_encoding - Configure the action the FortiGate unit will take on unknown content-encoding. type: str choices: block, inspect, bypass more...
    • imap - Configure IMAP AntiVirus options. type: dict more...
      • archive_block - Select the archive types to block. type: list choices: encrypted, corrupted, partiallycorrupted, multipart, nested, mailbomb, timeout, unhandled, fileslimit more...
      • archive_log - Select the archive types to log. type: list choices: encrypted, corrupted, partiallycorrupted, multipart, nested, mailbomb, timeout, unhandled, fileslimit more...
      • av_scan - Enable AntiVirus scan service. type: str choices: disable, block, monitor more...
      • 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: enable, disable more...
      • executables - Treat Windows executable files as viruses for the purpose of blocking or monitoring. type: str choices: default, virus more...
      • external_blocklist - Enable external-blocklist. Analyzes files including the content of archives. type: str choices: disable, block, monitor more...
      • fortiai - Enable/disable scanning of files by FortiAI. type: str choices: disable, block, monitor 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...
      • options - Enable/disable IMAP AntiVirus scanning, monitoring, and quarantine. type: list choices: scan, avmonitor, quarantine more...
      • outbreak_prevention - Enable virus outbreak prevention service. type: str choices: disable, block, monitor, disabled, files, full-archive more...
      • quarantine - Enable/disable quarantine for infected files. type: str choices: disable, enable more...
    • inspection_mode - Inspection mode. type: str choices: proxy, flow-based more...
    • mapi - Configure MAPI AntiVirus options. type: dict more...
      • archive_block - Select the archive types to block. type: list choices: encrypted, corrupted, partiallycorrupted, multipart, nested, mailbomb, timeout, unhandled, fileslimit more...
      • archive_log - Select the archive types to log. type: list choices: encrypted, corrupted, partiallycorrupted, multipart, nested, mailbomb, timeout, unhandled, fileslimit more...
      • av_scan - Enable AntiVirus scan service. type: str choices: disable, block, monitor more...
      • emulator - Enable/disable the virus emulator. type: str choices: enable, disable more...
      • executables - Treat Windows executable files as viruses for the purpose of blocking or monitoring. type: str choices: default, virus more...
      • external_blocklist - Enable external-blocklist. Analyzes files including the content of archives. type: str choices: disable, block, monitor more...
      • fortiai - Enable/disable scanning of files by FortiAI. type: str choices: disable, block, monitor 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...
      • options - Enable/disable MAPI AntiVirus scanning, monitoring, and quarantine. type: list choices: scan, avmonitor, quarantine more...
      • outbreak_prevention - Enable virus outbreak prevention service. type: str choices: disable, block, monitor, disabled, files, full-archive more...
      • quarantine - Enable/disable quarantine for infected files. type: str choices: disable, enable more...
    • mobile_malware_db - Enable/disable using the mobile malware signature database. type: str choices: disable, enable more...
    • nac_quar - Configure AntiVirus quarantine settings. 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: enable, disable more...
    • name - Profile name. type: str required: true more...
    • nntp - Configure NNTP AntiVirus options. type: dict more...
      • archive_block - Select the archive types to block. type: list choices: encrypted, corrupted, partiallycorrupted, multipart, nested, mailbomb, timeout, unhandled, fileslimit more...
      • archive_log - Select the archive types to log. type: list choices: encrypted, corrupted, partiallycorrupted, multipart, nested, mailbomb, timeout, unhandled, fileslimit more...
      • av_scan - Enable AntiVirus scan service. type: str choices: disable, block, monitor more...
      • emulator - Enable/disable the virus emulator. type: str choices: enable, disable more...
      • external_blocklist - Enable external-blocklist. Analyzes files including the content of archives. type: str choices: disable, block, monitor more...
      • fortiai - Enable/disable scanning of files by FortiAI. type: str choices: disable, block, monitor 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...
      • options - Enable/disable NNTP AntiVirus scanning, monitoring, and quarantine. type: list choices: scan, avmonitor, quarantine more...
      • outbreak_prevention - Enable virus outbreak prevention service. type: str choices: disable, block, monitor, disabled, files, full-archive more...
      • quarantine - Enable/disable quarantine for infected files. type: str choices: disable, enable more...
    • outbreak_prevention - Configure Virus Outbreak Prevention settings. type: dict more...
      • 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...
    • outbreak_prevention_archive_scan - Enable/disable outbreak-prevention archive scanning. type: str choices: disable, enable more...
    • pop3 - Configure POP3 AntiVirus options. type: dict more...
      • archive_block - Select the archive types to block. type: list choices: encrypted, corrupted, partiallycorrupted, multipart, nested, mailbomb, timeout, unhandled, fileslimit more...
      • archive_log - Select the archive types to log. type: list choices: encrypted, corrupted, partiallycorrupted, multipart, nested, mailbomb, timeout, unhandled, fileslimit more...
      • av_scan - Enable AntiVirus scan service. type: str choices: disable, block, monitor more...
      • 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: enable, disable more...
      • executables - Treat Windows executable files as viruses for the purpose of blocking or monitoring. type: str choices: default, virus more...
      • external_blocklist - Enable external-blocklist. Analyzes files including the content of archives. type: str choices: disable, block, monitor more...
      • fortiai - Enable/disable scanning of files by FortiAI. type: str choices: disable, block, monitor 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...
      • options - Enable/disable POP3 AntiVirus scanning, monitoring, and quarantine. type: list choices: scan, avmonitor, quarantine more...
      • outbreak_prevention - Enable virus outbreak prevention service. type: str choices: disable, block, monitor, disabled, files, full-archive more...
      • quarantine - Enable/disable quarantine for infected files. type: str choices: disable, enable more...
    • replacemsg_group - Replacement message group customized for this profile. Source system.replacemsg-group.name. type: str more...
    • scan_mode - Configure scan mode . type: str choices: default, legacy, quick, full more...
    • smb - Configure SMB AntiVirus options. type: dict more...
      • archive_block - Select the archive types to block. type: str choices: encrypted, corrupted, partiallycorrupted, multipart, nested, mailbomb, fileslimit, timeout, unhandled more...
      • archive_log - Select the archive types to log. type: str choices: encrypted, corrupted, partiallycorrupted, multipart, nested, mailbomb, fileslimit, timeout, unhandled more...
      • emulator - Enable/disable the virus emulator. type: str choices: enable, disable more...
      • options - Enable/disable SMB AntiVirus scanning, monitoring, and quarantine. type: str choices: scan, avmonitor, quarantine more...
      • outbreak_prevention - Enable FortiGuard Virus Outbreak Prevention service. type: str choices: disabled, files, full-archive more...
    • smtp - Configure SMTP AntiVirus options. type: dict more...
      • archive_block - Select the archive types to block. type: list choices: encrypted, corrupted, partiallycorrupted, multipart, nested, mailbomb, timeout, unhandled, fileslimit more...
      • archive_log - Select the archive types to log. type: list choices: encrypted, corrupted, partiallycorrupted, multipart, nested, mailbomb, timeout, unhandled, fileslimit more...
      • av_scan - Enable AntiVirus scan service. type: str choices: disable, block, monitor more...
      • 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: enable, disable more...
      • executables - Treat Windows executable files as viruses for the purpose of blocking or monitoring. type: str choices: default, virus more...
      • external_blocklist - Enable external-blocklist. Analyzes files including the content of archives. type: str choices: disable, block, monitor more...
      • fortiai - Enable/disable scanning of files by FortiAI. type: str choices: disable, block, monitor 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...
      • options - Enable/disable SMTP AntiVirus scanning, monitoring, and quarantine. type: list choices: scan, avmonitor, quarantine more...
      • outbreak_prevention - Enable virus outbreak prevention service. type: str choices: disable, block, monitor, disabled, files, full-archive more...
      • quarantine - Enable/disable quarantine for infected files. type: str choices: disable, enable more...
    • ssh - Configure SFTP and SCP AntiVirus options. type: dict more...
      • archive_block - Select the archive types to block. type: list choices: encrypted, corrupted, partiallycorrupted, multipart, nested, mailbomb, timeout, unhandled, fileslimit more...
      • archive_log - Select the archive types to log. type: list choices: encrypted, corrupted, partiallycorrupted, multipart, nested, mailbomb, timeout, unhandled, fileslimit more...
      • av_scan - Enable AntiVirus scan service. type: str choices: disable, block, monitor more...
      • emulator - Enable/disable the virus emulator. type: str choices: enable, disable more...
      • external_blocklist - Enable external-blocklist. Analyzes files including the content of archives. type: str choices: disable, block, monitor more...
      • fortiai - Enable/disable scanning of files by FortiAI. type: str choices: disable, block, monitor 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...
      • options - Enable/disable SFTP and SCP AntiVirus scanning, monitoring, and quarantine. type: list choices: scan, avmonitor, quarantine more...
      • outbreak_prevention - Enable virus outbreak prevention service. type: str choices: disable, block, monitor, disabled, files, full-archive more...
      • quarantine - Enable/disable quarantine for infected files. type: str choices: disable, enable more...

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- name: Configure AntiVirus profiles.
  fortinet.fortios.fortios_antivirus_profile:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      antivirus_profile:
          analytics_accept_filetype: "0"
          analytics_bl_filetype: "2147483647"
          analytics_db: "disable"
          analytics_ignore_filetype: "0"
          analytics_max_upload: "10"
          analytics_wl_filetype: "2147483647"
          av_block_log: "enable"
          av_virus_log: "enable"
          cifs:
              archive_block: "encrypted"
              archive_log: "encrypted"
              av_scan: "disable"
              emulator: "enable"
              external_blocklist: "disable"
              fortiai: "disable"
              fortindr: "disable"
              fortisandbox: "disable"
              options: "scan"
              outbreak_prevention: "disable"
              quarantine: "disable"
          comment: "Comment."
          content_disarm:
              cover_page: "disable"
              detect_only: "disable"
              error_action: "block"
              office_action: "disable"
              office_dde: "disable"
              office_embed: "disable"
              office_hylink: "disable"
              office_linked: "disable"
              office_macro: "disable"
              original_file_destination: "fortisandbox"
              pdf_act_form: "disable"
              pdf_act_gotor: "disable"
              pdf_act_java: "disable"
              pdf_act_launch: "disable"
              pdf_act_movie: "disable"
              pdf_act_sound: "disable"
              pdf_embedfile: "disable"
              pdf_hyperlink: "disable"
              pdf_javacode: "disable"
          ems_threat_feed: "disable"
          extended_log: "enable"
          external_blocklist:
              -
                  name: "default_name_47 (source system.external-resource.name)"
          external_blocklist_archive_scan: "disable"
          external_blocklist_enable_all: "disable"
          feature_set: "flow"
          fortiai_error_action: "log-only"
          fortiai_timeout_action: "log-only"
          fortindr_error_action: "log-only"
          fortindr_timeout_action: "log-only"
          fortisandbox_error_action: "log-only"
          fortisandbox_max_upload: "10"
          fortisandbox_mode: "inline"
          fortisandbox_timeout_action: "log-only"
          ftgd_analytics: "disable"
          ftp:
              archive_block: "encrypted"
              archive_log: "encrypted"
              av_scan: "disable"
              emulator: "enable"
              external_blocklist: "disable"
              fortiai: "disable"
              fortindr: "disable"
              fortisandbox: "disable"
              options: "scan"
              outbreak_prevention: "disable"
              quarantine: "disable"
          http:
              archive_block: "encrypted"
              archive_log: "encrypted"
              av_scan: "disable"
              content_disarm: "disable"
              emulator: "enable"
              external_blocklist: "disable"
              fortiai: "disable"
              fortindr: "disable"
              fortisandbox: "disable"
              options: "scan"
              outbreak_prevention: "disable"
              quarantine: "disable"
              unknown_content_encoding: "block"
          imap:
              archive_block: "encrypted"
              archive_log: "encrypted"
              av_scan: "disable"
              content_disarm: "disable"
              emulator: "enable"
              executables: "default"
              external_blocklist: "disable"
              fortiai: "disable"
              fortindr: "disable"
              fortisandbox: "disable"
              options: "scan"
              outbreak_prevention: "disable"
              quarantine: "disable"
          inspection_mode: "proxy"
          mapi:
              archive_block: "encrypted"
              archive_log: "encrypted"
              av_scan: "disable"
              emulator: "enable"
              executables: "default"
              external_blocklist: "disable"
              fortiai: "disable"
              fortindr: "disable"
              fortisandbox: "disable"
              options: "scan"
              outbreak_prevention: "disable"
              quarantine: "disable"
          mobile_malware_db: "disable"
          nac_quar:
              expiry: "<your_own_value>"
              infected: "none"
              log: "enable"
          name: "default_name_119"
          nntp:
              archive_block: "encrypted"
              archive_log: "encrypted"
              av_scan: "disable"
              emulator: "enable"
              external_blocklist: "disable"
              fortiai: "disable"
              fortindr: "disable"
              fortisandbox: "disable"
              options: "scan"
              outbreak_prevention: "disable"
              quarantine: "disable"
          outbreak_prevention:
              external_blocklist: "disable"
              ftgd_service: "disable"
          outbreak_prevention_archive_scan: "disable"
          pop3:
              archive_block: "encrypted"
              archive_log: "encrypted"
              av_scan: "disable"
              content_disarm: "disable"
              emulator: "enable"
              executables: "default"
              external_blocklist: "disable"
              fortiai: "disable"
              fortindr: "disable"
              fortisandbox: "disable"
              options: "scan"
              outbreak_prevention: "disable"
              quarantine: "disable"
          replacemsg_group: "<your_own_value> (source system.replacemsg-group.name)"
          scan_mode: "default"
          smb:
              archive_block: "encrypted"
              archive_log: "encrypted"
              emulator: "enable"
              options: "scan"
              outbreak_prevention: "disabled"
          smtp:
              archive_block: "encrypted"
              archive_log: "encrypted"
              av_scan: "disable"
              content_disarm: "disable"
              emulator: "enable"
              executables: "default"
              external_blocklist: "disable"
              fortiai: "disable"
              fortindr: "disable"
              fortisandbox: "disable"
              options: "scan"
              outbreak_prevention: "disable"
              quarantine: "disable"
          ssh:
              archive_block: "encrypted"
              archive_log: "encrypted"
              av_scan: "disable"
              emulator: "enable"
              external_blocklist: "disable"
              fortiai: "disable"
              fortindr: "disable"
              fortisandbox: "disable"
              options: "scan"
              outbreak_prevention: "disable"
              quarantine: "disable"

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:

  • build - Build number of the fortigate image returned: always type: str sample: 1547
  • http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
  • http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
  • mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
  • name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
  • path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
  • revision - Internal revision number returned: always type: str sample: 17.0.2.10658
  • serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
  • status - Indication of the operation's result returned: always type: str sample: success
  • vdom - Virtual domain used returned: always type: str sample: root
  • version - Version of the FortiGate returned: always type: str sample: v5.6.3

Status

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

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)

Hint

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