fortinet.fortios.fortios_log_threat_weight (2.3.6) — module

Configure threat weight settings in Fortinet's FortiOS and FortiGate.

| "added in version" 2.0.0 of 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 fortinet.fortios:==2.3.6


Add to requirements.yml

  collections:
    - name: fortinet.fortios
      version: 2.3.6

Description

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log feature and threat_weight 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.
- name: Configure threat weight settings.
  fortinet.fortios.fortios_log_threat_weight:
      vdom: "{{ vdom }}"
      log_threat_weight:
          application:
              -
                  category: "0"
                  id: "5"
                  level: "disable"
          blocked_connection: "disable"
          botnet_connection_detected: "disable"
          failed_connection: "disable"
          geolocation:
              -
                  country: "<your_own_value>"
                  id: "12"
                  level: "disable"
          ips:
              critical_severity: "disable"
              high_severity: "disable"
              info_severity: "disable"
              low_severity: "disable"
              medium_severity: "disable"
          level:
              critical: "50"
              high: "30"
              low: "5"
              medium: "10"
          malware:
              botnet_connection: "disable"
              command_blocked: "disable"
              content_disarm: "disable"
              ems_threat_feed: "disable"
              file_blocked: "disable"
              fortiai: "disable"
              fortindr: "disable"
              fortisandbox: "disable"
              fsa_high_risk: "disable"
              fsa_malicious: "disable"
              fsa_medium_risk: "disable"
              inline_block: "disable"
              malware_list: "disable"
              mimefragmented: "disable"
              oversized: "disable"
              switch_proto: "disable"
              virus_blocked: "disable"
              virus_file_type_executable: "disable"
              virus_infected: "disable"
              virus_outbreak_prevention: "disable"
              virus_scan_error: "disable"
          status: "enable"
          url_block_detected: "disable"
          web:
              -
                  category: "0"
                  id: "51"
                  level: "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

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

log_threat_weight:
    default: null
    description:
    - Configure threat weight settings.
    suboptions:
      application:
        description:
        - Application-control threat weight settings.
        elements: dict
        suboptions:
          category:
            description:
            - Application category.
            type: int
          id:
            description:
            - Entry ID. see <a href='#notes'>Notes</a>.
            required: true
            type: int
          level:
            choices:
            - disable
            - low
            - medium
            - high
            - critical
            description:
            - Threat weight score for Application events.
            type: str
        type: list
      blocked_connection:
        choices:
        - disable
        - low
        - medium
        - high
        - critical
        description:
        - Threat weight score for blocked connections.
        type: str
      botnet_connection_detected:
        choices:
        - disable
        - low
        - medium
        - high
        - critical
        description:
        - Threat weight score for detected botnet connections.
        type: str
      failed_connection:
        choices:
        - disable
        - low
        - medium
        - high
        - critical
        description:
        - Threat weight score for failed connections.
        type: str
      geolocation:
        description:
        - Geolocation-based threat weight settings.
        elements: dict
        suboptions:
          country:
            description:
            - Country code.
            type: str
          id:
            description:
            - Entry ID. see <a href='#notes'>Notes</a>.
            required: true
            type: int
          level:
            choices:
            - disable
            - low
            - medium
            - high
            - critical
            description:
            - Threat weight score for Geolocation-based events.
            type: str
        type: list
      ips:
        description:
        - IPS threat weight settings.
        suboptions:
          critical_severity:
            choices:
            - disable
            - low
            - medium
            - high
            - critical
            description:
            - Threat weight score for IPS critical severity events.
            type: str
          high_severity:
            choices:
            - disable
            - low
            - medium
            - high
            - critical
            description:
            - Threat weight score for IPS high severity events.
            type: str
          info_severity:
            choices:
            - disable
            - low
            - medium
            - high
            - critical
            description:
            - Threat weight score for IPS info severity events.
            type: str
          low_severity:
            choices:
            - disable
            - low
            - medium
            - high
            - critical
            description:
            - Threat weight score for IPS low severity events.
            type: str
          medium_severity:
            choices:
            - disable
            - low
            - medium
            - high
            - critical
            description:
            - Threat weight score for IPS medium severity events.
            type: str
        type: dict
      level:
        description:
        - Score mapping for threat weight levels.
        suboptions:
          critical:
            description:
            - Critical level score value (1 - 100).
            type: int
          high:
            description:
            - High level score value (1 - 100).
            type: int
          low:
            description:
            - Low level score value (1 - 100).
            type: int
          medium:
            description:
            - Medium level score value (1 - 100).
            type: int
        type: dict
      malware:
        description:
        - Anti-virus malware threat weight settings.
        suboptions:
          botnet_connection:
            choices:
            - disable
            - low
            - medium
            - high
            - critical
            description:
            - Threat weight score for detected botnet connections.
            type: str
          command_blocked:
            choices:
            - disable
            - low
            - medium
            - high
            - critical
            description:
            - Threat weight score for blocked command detected.
            type: str
          content_disarm:
            choices:
            - disable
            - low
            - medium
            - high
            - critical
            description:
            - Threat weight score for virus (content disarm) detected.
            type: str
          ems_threat_feed:
            choices:
            - disable
            - low
            - medium
            - high
            - critical
            description:
            - Threat weight score for virus (EMS threat feed) detected.
            type: str
          file_blocked:
            choices:
            - disable
            - low
            - medium
            - high
            - critical
            description:
            - Threat weight score for blocked file detected.
            type: str
          fortiai:
            choices:
            - disable
            - low
            - medium
            - high
            - critical
            description:
            - Threat weight score for FortiAI-detected virus.
            type: str
          fortindr:
            choices:
            - disable
            - low
            - medium
            - high
            - critical
            description:
            - Threat weight score for FortiNDR-detected virus.
            type: str
          fortisandbox:
            choices:
            - disable
            - low
            - medium
            - high
            - critical
            description:
            - Threat weight score for FortiSandbox-detected virus.
            type: str
          fsa_high_risk:
            choices:
            - disable
            - low
            - medium
            - high
            - critical
            description:
            - Threat weight score for FortiSandbox high risk malware detected.
            type: str
          fsa_malicious:
            choices:
            - disable
            - low
            - medium
            - high
            - critical
            description:
            - Threat weight score for FortiSandbox malicious malware detected.
            type: str
          fsa_medium_risk:
            choices:
            - disable
            - low
            - medium
            - high
            - critical
            description:
            - Threat weight score for FortiSandbox medium risk malware detected.
            type: str
          inline_block:
            choices:
            - disable
            - low
            - medium
            - high
            - critical
            description:
            - Threat weight score for malware detected by inline block.
            type: str
          malware_list:
            choices:
            - disable
            - low
            - medium
            - high
            - critical
            description:
            - Threat weight score for virus (malware list) detected.
            type: str
          mimefragmented:
            choices:
            - disable
            - low
            - medium
            - high
            - critical
            description:
            - Threat weight score for mimefragmented detected.
            type: str
          oversized:
            choices:
            - disable
            - low
            - medium
            - high
            - critical
            description:
            - Threat weight score for oversized file detected.
            type: str
          switch_proto:
            choices:
            - disable
            - low
            - medium
            - high
            - critical
            description:
            - Threat weight score for switch proto detected.
            type: str
          virus_blocked:
            choices:
            - disable
            - low
            - medium
            - high
            - critical
            description:
            - Threat weight score for virus (blocked) detected.
            type: str
          virus_file_type_executable:
            choices:
            - disable
            - low
            - medium
            - high
            - critical
            description:
            - Threat weight score for virus (file type executable) detected.
            type: str
          virus_infected:
            choices:
            - disable
            - low
            - medium
            - high
            - critical
            description:
            - Threat weight score for virus (infected) detected.
            type: str
          virus_outbreak_prevention:
            choices:
            - disable
            - low
            - medium
            - high
            - critical
            description:
            - Threat weight score for virus (outbreak prevention) event.
            type: str
          virus_scan_error:
            choices:
            - disable
            - low
            - medium
            - high
            - critical
            description:
            - Threat weight score for virus (scan error) detected.
            type: str
        type: dict
      status:
        choices:
        - enable
        - disable
        description:
        - Enable/disable the threat weight feature.
        type: str
      url_block_detected:
        choices:
        - disable
        - low
        - medium
        - high
        - critical
        description:
        - Threat weight score for URL blocking.
        type: str
      web:
        description:
        - Web filtering threat weight settings.
        elements: dict
        suboptions:
          category:
            description:
            - Threat weight score for web category filtering matches.
            type: int
          id:
            description:
            - Entry ID. see <a href='#notes'>Notes</a>.
            required: true
            type: int
          level:
            choices:
            - disable
            - low
            - medium
            - high
            - critical
            description:
            - Threat weight score for web category filtering matches.
            type: str
        type: list
    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