lix_fortinet.fortios.fortios_antivirus_profile (102.2.120) — module

Configure AntiVirus profiles in Fortinet's FortiOS and FortiGate.

| "added in version" 2.0.0 of lix_fortinet.fortios"

Authors: Link Zheng (@chillancezen), Jie Xue (@JieX19), Hongbin Lu (@fgtdev-hblu), Frank Shen (@frankshen01), Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)

preview | supported by community

Install collection

Install with ansible-galaxy collection install lix_fortinet.fortios:==102.2.120


Add to requirements.yml

  collections:
    - name: lix_fortinet.fortios
      version: 102.2.120

Description

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

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure AntiVirus profiles.
    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"

Inputs

    
vdom:
    default: root
    description:
    - 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

state:
    choices:
    - present
    - absent
    description:
    - Indicates whether to create or remove the object.
    required: true
    type: str

enable_log:
    default: false
    description:
    - Enable/Disable logging for task.
    required: false
    type: bool

member_path:
    description:
    - Member attribute path to operate on.
    - Delimited by a slash character if there are more than one attribute.
    - Parameter marked with member_path is legitimate for doing member operation.
    type: str

access_token:
    description:
    - Token-based authentication. Generated from GUI of Fortigate.
    required: false
    type: str

member_state:
    choices:
    - present
    - absent
    description:
    - Add or delete a member under specified attribute path.
    - When member_state is specified, the state option is ignored.
    type: str

antivirus_profile:
    default: null
    description:
    - Configure AntiVirus profiles.
    suboptions:
      analytics_accept_filetype:
        description:
        - Only submit files matching this DLP file-pattern to FortiSandbox (post-transfer
          scan only). Source dlp.filepattern.id.
        type: int
      analytics_bl_filetype:
        description:
        - Only submit files matching this DLP file-pattern to FortiSandbox. Source dlp.filepattern.id.
        type: int
      analytics_db:
        choices:
        - disable
        - enable
        description:
        - Enable/disable using the FortiSandbox signature database to supplement the AV
          signature databases.
        type: str
      analytics_ignore_filetype:
        description:
        - Do not submit files matching this DLP file-pattern to FortiSandbox (post-transfer
          scan only). Source dlp.filepattern.id.
        type: int
      analytics_max_upload:
        description:
        - Maximum size of files that can be uploaded to FortiSandbox.
        type: int
      analytics_wl_filetype:
        description:
        - Do not submit files matching this DLP file-pattern to FortiSandbox. Source dlp.filepattern.id.
        type: int
      av_block_log:
        choices:
        - enable
        - disable
        description:
        - Enable/disable logging for AntiVirus file blocking.
        type: str
      av_virus_log:
        choices:
        - enable
        - disable
        description:
        - Enable/disable AntiVirus logging.
        type: str
      cifs:
        description:
        - Configure CIFS AntiVirus options.
        suboptions:
          archive_block:
            choices:
            - encrypted
            - corrupted
            - partiallycorrupted
            - multipart
            - nested
            - mailbomb
            - timeout
            - unhandled
            - fileslimit
            description:
            - Select the archive types to block.
            elements: str
            type: list
          archive_log:
            choices:
            - encrypted
            - corrupted
            - partiallycorrupted
            - multipart
            - nested
            - mailbomb
            - timeout
            - unhandled
            - fileslimit
            description:
            - Select the archive types to log.
            elements: str
            type: list
          av_scan:
            choices:
            - disable
            - block
            - monitor
            description:
            - Enable AntiVirus scan service.
            type: str
          emulator:
            choices:
            - enable
            - disable
            description:
            - Enable/disable the virus emulator.
            type: str
          external_blocklist:
            choices:
            - disable
            - block
            - monitor
            description:
            - Enable external-blocklist. Analyzes files including the content of archives.
            type: str
          fortiai:
            choices:
            - disable
            - block
            - monitor
            description:
            - Enable/disable scanning of files by FortiAI.
            type: str
          fortindr:
            choices:
            - disable
            - block
            - monitor
            description:
            - Enable scanning of files by FortiNDR.
            type: str
          fortisandbox:
            choices:
            - disable
            - block
            - monitor
            description:
            - Enable scanning of files by FortiSandbox.
            type: str
          options:
            choices:
            - scan
            - avmonitor
            - quarantine
            description:
            - Enable/disable CIFS AntiVirus scanning, monitoring, and quarantine.
            elements: str
            type: list
          outbreak_prevention:
            choices:
            - disable
            - block
            - monitor
            - disabled
            - files
            - full-archive
            description:
            - Enable virus outbreak prevention service.
            type: str
          quarantine:
            choices:
            - disable
            - enable
            description:
            - Enable/disable quarantine for infected files.
            type: str
        type: dict
      comment:
        description:
        - Comment.
        type: str
      content_disarm:
        description:
        - AV Content Disarm and Reconstruction settings.
        suboptions:
          cover_page:
            choices:
            - disable
            - enable
            description:
            - Enable/disable inserting a cover page into the disarmed document.
            type: str
          detect_only:
            choices:
            - disable
            - enable
            description:
            - Enable/disable only detect disarmable files, do not alter content.
            type: str
          error_action:
            choices:
            - block
            - log-only
            - ignore
            description:
            - Action to be taken if CDR engine encounters an unrecoverable error.
            type: str
          office_action:
            choices:
            - disable
            - enable
            description:
            - Enable/disable stripping of PowerPoint action events in Microsoft Office
              documents.
            type: str
          office_dde:
            choices:
            - disable
            - enable
            description:
            - Enable/disable stripping of Dynamic Data Exchange events in Microsoft Office
              documents.
            type: str
          office_embed:
            choices:
            - disable
            - enable
            description:
            - Enable/disable stripping of embedded objects in Microsoft Office documents.
            type: str
          office_hylink:
            choices:
            - disable
            - enable
            description:
            - Enable/disable stripping of hyperlinks in Microsoft Office documents.
            type: str
          office_linked:
            choices:
            - disable
            - enable
            description:
            - Enable/disable stripping of linked objects in Microsoft Office documents.
            type: str
          office_macro:
            choices:
            - disable
            - enable
            description:
            - Enable/disable stripping of macros in Microsoft Office documents.
            type: str
          original_file_destination:
            choices:
            - fortisandbox
            - quarantine
            - discard
            description:
            - Destination to send original file if active content is removed.
            type: str
          pdf_act_form:
            choices:
            - disable
            - enable
            description:
            - Enable/disable stripping of PDF document actions that submit data to other
              targets.
            type: str
          pdf_act_gotor:
            choices:
            - disable
            - enable
            description:
            - Enable/disable stripping of PDF document actions that access other PDF documents.
            type: str
          pdf_act_java:
            choices:
            - disable
            - enable
            description:
            - Enable/disable stripping of PDF document actions that execute JavaScript
              code.
            type: str
          pdf_act_launch:
            choices:
            - disable
            - enable
            description:
            - Enable/disable stripping of PDF document actions that launch other applications.
            type: str
          pdf_act_movie:
            choices:
            - disable
            - enable
            description:
            - Enable/disable stripping of PDF document actions that play a movie.
            type: str
          pdf_act_sound:
            choices:
            - disable
            - enable
            description:
            - Enable/disable stripping of PDF document actions that play a sound.
            type: str
          pdf_embedfile:
            choices:
            - disable
            - enable
            description:
            - Enable/disable stripping of embedded files in PDF documents.
            type: str
          pdf_hyperlink:
            choices:
            - disable
            - enable
            description:
            - Enable/disable stripping of hyperlinks from PDF documents.
            type: str
          pdf_javacode:
            choices:
            - disable
            - enable
            description:
            - Enable/disable stripping of JavaScript code in PDF documents.
            type: str
        type: dict
      ems_threat_feed:
        choices:
        - disable
        - enable
        description:
        - Enable/disable use of EMS threat feed when performing AntiVirus scan. Analyzes
          files including the content of archives.
        type: str
      extended_log:
        choices:
        - enable
        - disable
        description:
        - Enable/disable extended logging for antivirus.
        type: str
      external_blocklist:
        description:
        - One or more external malware block lists.
        elements: dict
        suboptions:
          name:
            description:
            - External blocklist. Source system.external-resource.name.
            type: str
        type: list
      external_blocklist_archive_scan:
        choices:
        - disable
        - enable
        description:
        - Enable/disable external-blocklist archive scanning.
        type: str
      external_blocklist_enable_all:
        choices:
        - disable
        - enable
        description:
        - Enable/disable all external blocklists.
        type: str
      feature_set:
        choices:
        - flow
        - proxy
        description:
        - Flow/proxy feature set.
        type: str
      fortiai_error_action:
        choices:
        - log-only
        - block
        - ignore
        description:
        - Action to take if FortiAI encounters an error.
        type: str
      fortiai_timeout_action:
        choices:
        - log-only
        - block
        - ignore
        description:
        - Action to take if FortiAI encounters a scan timeout.
        type: str
      fortindr_error_action:
        choices:
        - log-only
        - block
        - ignore
        description:
        - Action to take if FortiNDR encounters an error.
        type: str
      fortindr_timeout_action:
        choices:
        - log-only
        - block
        - ignore
        description:
        - Action to take if FortiNDR encounters a scan timeout.
        type: str
      fortisandbox_error_action:
        choices:
        - log-only
        - block
        - ignore
        description:
        - Action to take if FortiSandbox inline scan encounters an error.
        type: str
      fortisandbox_max_upload:
        description:
        - Maximum size of files that can be uploaded to FortiSandbox.
        type: int
      fortisandbox_mode:
        choices:
        - inline
        - analytics-suspicious
        - analytics-everything
        description:
        - FortiSandbox scan modes.
        type: str
      fortisandbox_timeout_action:
        choices:
        - log-only
        - block
        - ignore
        description:
        - Action to take if FortiSandbox inline scan encounters a scan timeout.
        type: str
      ftgd_analytics:
        choices:
        - disable
        - suspicious
        - everything
        description:
        - Settings to control which files are uploaded to FortiSandbox.
        type: str
      ftp:
        description:
        - Configure FTP AntiVirus options.
        suboptions:
          archive_block:
            choices:
            - encrypted
            - corrupted
            - partiallycorrupted
            - multipart
            - nested
            - mailbomb
            - timeout
            - unhandled
            - fileslimit
            description:
            - Select the archive types to block.
            elements: str
            type: list
          archive_log:
            choices:
            - encrypted
            - corrupted
            - partiallycorrupted
            - multipart
            - nested
            - mailbomb
            - timeout
            - unhandled
            - fileslimit
            description:
            - Select the archive types to log.
            elements: str
            type: list
          av_scan:
            choices:
            - disable
            - block
            - monitor
            description:
            - Enable AntiVirus scan service.
            type: str
          emulator:
            choices:
            - enable
            - disable
            description:
            - Enable/disable the virus emulator.
            type: str
          external_blocklist:
            choices:
            - disable
            - block
            - monitor
            description:
            - Enable external-blocklist. Analyzes files including the content of archives.
            type: str
          fortiai:
            choices:
            - disable
            - block
            - monitor
            description:
            - Enable/disable scanning of files by FortiAI.
            type: str
          fortindr:
            choices:
            - disable
            - block
            - monitor
            description:
            - Enable scanning of files by FortiNDR.
            type: str
          fortisandbox:
            choices:
            - disable
            - block
            - monitor
            description:
            - Enable scanning of files by FortiSandbox.
            type: str
          options:
            choices:
            - scan
            - avmonitor
            - quarantine
            description:
            - Enable/disable FTP AntiVirus scanning, monitoring, and quarantine.
            elements: str
            type: list
          outbreak_prevention:
            choices:
            - disable
            - block
            - monitor
            - disabled
            - files
            - full-archive
            description:
            - Enable virus outbreak prevention service.
            type: str
          quarantine:
            choices:
            - disable
            - enable
            description:
            - Enable/disable quarantine for infected files.
            type: str
        type: dict
      http:
        description:
        - Configure HTTP AntiVirus options.
        suboptions:
          archive_block:
            choices:
            - encrypted
            - corrupted
            - partiallycorrupted
            - multipart
            - nested
            - mailbomb
            - timeout
            - unhandled
            - fileslimit
            description:
            - Select the archive types to block.
            elements: str
            type: list
          archive_log:
            choices:
            - encrypted
            - corrupted
            - partiallycorrupted
            - multipart
            - nested
            - mailbomb
            - timeout
            - unhandled
            - fileslimit
            description:
            - Select the archive types to log.
            elements: str
            type: list
          av_scan:
            choices:
            - disable
            - block
            - monitor
            description:
            - Enable AntiVirus scan service.
            type: str
          content_disarm:
            choices:
            - disable
            - enable
            description:
            - Enable/disable Content Disarm and Reconstruction when performing AntiVirus
              scan.
            type: str
          emulator:
            choices:
            - enable
            - disable
            description:
            - Enable/disable the virus emulator.
            type: str
          external_blocklist:
            choices:
            - disable
            - block
            - monitor
            description:
            - Enable external-blocklist. Analyzes files including the content of archives.
            type: str
          fortiai:
            choices:
            - disable
            - block
            - monitor
            description:
            - Enable/disable scanning of files by FortiAI.
            type: str
          fortindr:
            choices:
            - disable
            - block
            - monitor
            description:
            - Enable scanning of files by FortiNDR.
            type: str
          fortisandbox:
            choices:
            - disable
            - block
            - monitor
            description:
            - Enable scanning of files by FortiSandbox.
            type: str
          options:
            choices:
            - scan
            - avmonitor
            - quarantine
            description:
            - Enable/disable HTTP AntiVirus scanning, monitoring, and quarantine.
            elements: str
            type: list
          outbreak_prevention:
            choices:
            - disable
            - block
            - monitor
            - disabled
            - files
            - full-archive
            description:
            - Enable virus outbreak prevention service.
            type: str
          quarantine:
            choices:
            - disable
            - enable
            description:
            - Enable/disable quarantine for infected files.
            type: str
          unknown_content_encoding:
            choices:
            - block
            - inspect
            - bypass
            description:
            - Configure the action the FortiGate unit will take on unknown content-encoding.
            type: str
        type: dict
      imap:
        description:
        - Configure IMAP AntiVirus options.
        suboptions:
          archive_block:
            choices:
            - encrypted
            - corrupted
            - partiallycorrupted
            - multipart
            - nested
            - mailbomb
            - timeout
            - unhandled
            - fileslimit
            description:
            - Select the archive types to block.
            elements: str
            type: list
          archive_log:
            choices:
            - encrypted
            - corrupted
            - partiallycorrupted
            - multipart
            - nested
            - mailbomb
            - timeout
            - unhandled
            - fileslimit
            description:
            - Select the archive types to log.
            elements: str
            type: list
          av_scan:
            choices:
            - disable
            - block
            - monitor
            description:
            - Enable AntiVirus scan service.
            type: str
          content_disarm:
            choices:
            - disable
            - enable
            description:
            - Enable/disable Content Disarm and Reconstruction when performing AntiVirus
              scan.
            type: str
          emulator:
            choices:
            - enable
            - disable
            description:
            - Enable/disable the virus emulator.
            type: str
          executables:
            choices:
            - default
            - virus
            description:
            - Treat Windows executable files as viruses for the purpose of blocking or
              monitoring.
            type: str
          external_blocklist:
            choices:
            - disable
            - block
            - monitor
            description:
            - Enable external-blocklist. Analyzes files including the content of archives.
            type: str
          fortiai:
            choices:
            - disable
            - block
            - monitor
            description:
            - Enable/disable scanning of files by FortiAI.
            type: str
          fortindr:
            choices:
            - disable
            - block
            - monitor
            description:
            - Enable scanning of files by FortiNDR.
            type: str
          fortisandbox:
            choices:
            - disable
            - block
            - monitor
            description:
            - Enable scanning of files by FortiSandbox.
            type: str
          options:
            choices:
            - scan
            - avmonitor
            - quarantine
            description:
            - Enable/disable IMAP AntiVirus scanning, monitoring, and quarantine.
            elements: str
            type: list
          outbreak_prevention:
            choices:
            - disable
            - block
            - monitor
            - disabled
            - files
            - full-archive
            description:
            - Enable virus outbreak prevention service.
            type: str
          quarantine:
            choices:
            - disable
            - enable
            description:
            - Enable/disable quarantine for infected files.
            type: str
        type: dict
      inspection_mode:
        choices:
        - proxy
        - flow-based
        description:
        - Inspection mode.
        type: str
      mapi:
        description:
        - Configure MAPI AntiVirus options.
        suboptions:
          archive_block:
            choices:
            - encrypted
            - corrupted
            - partiallycorrupted
            - multipart
            - nested
            - mailbomb
            - timeout
            - unhandled
            - fileslimit
            description:
            - Select the archive types to block.
            elements: str
            type: list
          archive_log:
            choices:
            - encrypted
            - corrupted
            - partiallycorrupted
            - multipart
            - nested
            - mailbomb
            - timeout
            - unhandled
            - fileslimit
            description:
            - Select the archive types to log.
            elements: str
            type: list
          av_scan:
            choices:
            - disable
            - block
            - monitor
            description:
            - Enable AntiVirus scan service.
            type: str
          emulator:
            choices:
            - enable
            - disable
            description:
            - Enable/disable the virus emulator.
            type: str
          executables:
            choices:
            - default
            - virus
            description:
            - Treat Windows executable files as viruses for the purpose of blocking or
              monitoring.
            type: str
          external_blocklist:
            choices:
            - disable
            - block
            - monitor
            description:
            - Enable external-blocklist. Analyzes files including the content of archives.
            type: str
          fortiai:
            choices:
            - disable
            - block
            - monitor
            description:
            - Enable/disable scanning of files by FortiAI.
            type: str
          fortindr:
            choices:
            - disable
            - block
            - monitor
            description:
            - Enable scanning of files by FortiNDR.
            type: str
          fortisandbox:
            choices:
            - disable
            - block
            - monitor
            description:
            - Enable scanning of files by FortiSandbox.
            type: str
          options:
            choices:
            - scan
            - avmonitor
            - quarantine
            description:
            - Enable/disable MAPI AntiVirus scanning, monitoring, and quarantine.
            elements: str
            type: list
          outbreak_prevention:
            choices:
            - disable
            - block
            - monitor
            - disabled
            - files
            - full-archive
            description:
            - Enable virus outbreak prevention service.
            type: str
          quarantine:
            choices:
            - disable
            - enable
            description:
            - Enable/disable quarantine for infected files.
            type: str
        type: dict
      mobile_malware_db:
        choices:
        - disable
        - enable
        description:
        - Enable/disable using the mobile malware signature database.
        type: str
      nac_quar:
        description:
        - Configure AntiVirus quarantine settings.
        suboptions:
          expiry:
            description:
            - Duration of quarantine.
            type: str
          infected:
            choices:
            - none
            - quar-src-ip
            description:
            - Enable/Disable quarantining infected hosts to the banned user list.
            type: str
          log:
            choices:
            - enable
            - disable
            description:
            - Enable/disable AntiVirus quarantine logging.
            type: str
        type: dict
      name:
        description:
        - Profile name.
        required: true
        type: str
      nntp:
        description:
        - Configure NNTP AntiVirus options.
        suboptions:
          archive_block:
            choices:
            - encrypted
            - corrupted
            - partiallycorrupted
            - multipart
            - nested
            - mailbomb
            - timeout
            - unhandled
            - fileslimit
            description:
            - Select the archive types to block.
            elements: str
            type: list
          archive_log:
            choices:
            - encrypted
            - corrupted
            - partiallycorrupted
            - multipart
            - nested
            - mailbomb
            - timeout
            - unhandled
            - fileslimit
            description:
            - Select the archive types to log.
            elements: str
            type: list
          av_scan:
            choices:
            - disable
            - block
            - monitor
            description:
            - Enable AntiVirus scan service.
            type: str
          emulator:
            choices:
            - enable
            - disable
            description:
            - Enable/disable the virus emulator.
            type: str
          external_blocklist:
            choices:
            - disable
            - block
            - monitor
            description:
            - Enable external-blocklist. Analyzes files including the content of archives.
            type: str
          fortiai:
            choices:
            - disable
            - block
            - monitor
            description:
            - Enable/disable scanning of files by FortiAI.
            type: str
          fortindr:
            choices:
            - disable
            - block
            - monitor
            description:
            - Enable scanning of files by FortiNDR.
            type: str
          fortisandbox:
            choices:
            - disable
            - block
            - monitor
            description:
            - Enable scanning of files by FortiSandbox.
            type: str
          options:
            choices:
            - scan
            - avmonitor
            - quarantine
            description:
            - Enable/disable NNTP AntiVirus scanning, monitoring, and quarantine.
            elements: str
            type: list
          outbreak_prevention:
            choices:
            - disable
            - block
            - monitor
            - disabled
            - files
            - full-archive
            description:
            - Enable virus outbreak prevention service.
            type: str
          quarantine:
            choices:
            - disable
            - enable
            description:
            - Enable/disable quarantine for infected files.
            type: str
        type: dict
      outbreak_prevention:
        description:
        - Configure Virus Outbreak Prevention settings.
        suboptions:
          external_blocklist:
            choices:
            - disable
            - enable
            description:
            - Enable/disable external malware blocklist.
            type: str
          ftgd_service:
            choices:
            - disable
            - enable
            description:
            - Enable/disable FortiGuard Virus outbreak prevention service.
            type: str
        type: dict
      outbreak_prevention_archive_scan:
        choices:
        - disable
        - enable
        description:
        - Enable/disable outbreak-prevention archive scanning.
        type: str
      pop3:
        description:
        - Configure POP3 AntiVirus options.
        suboptions:
          archive_block:
            choices:
            - encrypted
            - corrupted
            - partiallycorrupted
            - multipart
            - nested
            - mailbomb
            - timeout
            - unhandled
            - fileslimit
            description:
            - Select the archive types to block.
            elements: str
            type: list
          archive_log:
            choices:
            - encrypted
            - corrupted
            - partiallycorrupted
            - multipart
            - nested
            - mailbomb
            - timeout
            - unhandled
            - fileslimit
            description:
            - Select the archive types to log.
            elements: str
            type: list
          av_scan:
            choices:
            - disable
            - block
            - monitor
            description:
            - Enable AntiVirus scan service.
            type: str
          content_disarm:
            choices:
            - disable
            - enable
            description:
            - Enable/disable Content Disarm and Reconstruction when performing AntiVirus
              scan.
            type: str
          emulator:
            choices:
            - enable
            - disable
            description:
            - Enable/disable the virus emulator.
            type: str
          executables:
            choices:
            - default
            - virus
            description:
            - Treat Windows executable files as viruses for the purpose of blocking or
              monitoring.
            type: str
          external_blocklist:
            choices:
            - disable
            - block
            - monitor
            description:
            - Enable external-blocklist. Analyzes files including the content of archives.
            type: str
          fortiai:
            choices:
            - disable
            - block
            - monitor
            description:
            - Enable/disable scanning of files by FortiAI.
            type: str
          fortindr:
            choices:
            - disable
            - block
            - monitor
            description:
            - Enable scanning of files by FortiNDR.
            type: str
          fortisandbox:
            choices:
            - disable
            - block
            - monitor
            description:
            - Enable scanning of files by FortiSandbox.
            type: str
          options:
            choices:
            - scan
            - avmonitor
            - quarantine
            description:
            - Enable/disable POP3 AntiVirus scanning, monitoring, and quarantine.
            elements: str
            type: list
          outbreak_prevention:
            choices:
            - disable
            - block
            - monitor
            - disabled
            - files
            - full-archive
            description:
            - Enable virus outbreak prevention service.
            type: str
          quarantine:
            choices:
            - disable
            - enable
            description:
            - Enable/disable quarantine for infected files.
            type: str
        type: dict
      replacemsg_group:
        description:
        - Replacement message group customized for this profile. Source system.replacemsg-group.name.
        type: str
      scan_mode:
        choices:
        - default
        - legacy
        - quick
        - full
        description:
        - Configure scan mode .
        type: str
      smb:
        description:
        - Configure SMB AntiVirus options.
        suboptions:
          archive_block:
            choices:
            - encrypted
            - corrupted
            - partiallycorrupted
            - multipart
            - nested
            - mailbomb
            - fileslimit
            - timeout
            - unhandled
            description:
            - Select the archive types to block.
            type: str
          archive_log:
            choices:
            - encrypted
            - corrupted
            - partiallycorrupted
            - multipart
            - nested
            - mailbomb
            - fileslimit
            - timeout
            - unhandled
            description:
            - Select the archive types to log.
            type: str
          emulator:
            choices:
            - enable
            - disable
            description:
            - Enable/disable the virus emulator.
            type: str
          options:
            choices:
            - scan
            - avmonitor
            - quarantine
            description:
            - Enable/disable SMB AntiVirus scanning, monitoring, and quarantine.
            type: str
          outbreak_prevention:
            choices:
            - disabled
            - files
            - full-archive
            description:
            - Enable FortiGuard Virus Outbreak Prevention service.
            type: str
        type: dict
      smtp:
        description:
        - Configure SMTP AntiVirus options.
        suboptions:
          archive_block:
            choices:
            - encrypted
            - corrupted
            - partiallycorrupted
            - multipart
            - nested
            - mailbomb
            - timeout
            - unhandled
            - fileslimit
            description:
            - Select the archive types to block.
            elements: str
            type: list
          archive_log:
            choices:
            - encrypted
            - corrupted
            - partiallycorrupted
            - multipart
            - nested
            - mailbomb
            - timeout
            - unhandled
            - fileslimit
            description:
            - Select the archive types to log.
            elements: str
            type: list
          av_scan:
            choices:
            - disable
            - block
            - monitor
            description:
            - Enable AntiVirus scan service.
            type: str
          content_disarm:
            choices:
            - disable
            - enable
            description:
            - Enable/disable Content Disarm and Reconstruction when performing AntiVirus
              scan.
            type: str
          emulator:
            choices:
            - enable
            - disable
            description:
            - Enable/disable the virus emulator.
            type: str
          executables:
            choices:
            - default
            - virus
            description:
            - Treat Windows executable files as viruses for the purpose of blocking or
              monitoring.
            type: str
          external_blocklist:
            choices:
            - disable
            - block
            - monitor
            description:
            - Enable external-blocklist. Analyzes files including the content of archives.
            type: str
          fortiai:
            choices:
            - disable
            - block
            - monitor
            description:
            - Enable/disable scanning of files by FortiAI.
            type: str
          fortindr:
            choices:
            - disable
            - block
            - monitor
            description:
            - Enable scanning of files by FortiNDR.
            type: str
          fortisandbox:
            choices:
            - disable
            - block
            - monitor
            description:
            - Enable scanning of files by FortiSandbox.
            type: str
          options:
            choices:
            - scan
            - avmonitor
            - quarantine
            description:
            - Enable/disable SMTP AntiVirus scanning, monitoring, and quarantine.
            elements: str
            type: list
          outbreak_prevention:
            choices:
            - disable
            - block
            - monitor
            - disabled
            - files
            - full-archive
            description:
            - Enable virus outbreak prevention service.
            type: str
          quarantine:
            choices:
            - disable
            - enable
            description:
            - Enable/disable quarantine for infected files.
            type: str
        type: dict
      ssh:
        description:
        - Configure SFTP and SCP AntiVirus options.
        suboptions:
          archive_block:
            choices:
            - encrypted
            - corrupted
            - partiallycorrupted
            - multipart
            - nested
            - mailbomb
            - timeout
            - unhandled
            - fileslimit
            description:
            - Select the archive types to block.
            elements: str
            type: list
          archive_log:
            choices:
            - encrypted
            - corrupted
            - partiallycorrupted
            - multipart
            - nested
            - mailbomb
            - timeout
            - unhandled
            - fileslimit
            description:
            - Select the archive types to log.
            elements: str
            type: list
          av_scan:
            choices:
            - disable
            - block
            - monitor
            description:
            - Enable AntiVirus scan service.
            type: str
          emulator:
            choices:
            - enable
            - disable
            description:
            - Enable/disable the virus emulator.
            type: str
          external_blocklist:
            choices:
            - disable
            - block
            - monitor
            description:
            - Enable external-blocklist. Analyzes files including the content of archives.
            type: str
          fortiai:
            choices:
            - disable
            - block
            - monitor
            description:
            - Enable/disable scanning of files by FortiAI.
            type: str
          fortindr:
            choices:
            - disable
            - block
            - monitor
            description:
            - Enable scanning of files by FortiNDR.
            type: str
          fortisandbox:
            choices:
            - disable
            - block
            - monitor
            description:
            - Enable scanning of files by FortiSandbox.
            type: str
          options:
            choices:
            - scan
            - avmonitor
            - quarantine
            description:
            - Enable/disable SFTP and SCP AntiVirus scanning, monitoring, and quarantine.
            elements: str
            type: list
          outbreak_prevention:
            choices:
            - disable
            - block
            - monitor
            - disabled
            - files
            - full-archive
            description:
            - Enable virus outbreak prevention service.
            type: str
          quarantine:
            choices:
            - disable
            - enable
            description:
            - Enable/disable quarantine for infected files.
            type: str
        type: dict
    type: dict

Outputs

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