fortios_log_threat_weight – Configure threat weight settings in Fortinet’s FortiOS and FortiGate — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# fortios_log_threat_weight – Configure threat weight settings in Fortinet’s FortiOS and FortiGate

New in version 2.8.

- Synopsis
- Requirements
- Parameters
- Notes
- Examples
- Return Values
- Status

## Synopsis

- 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.5

## Requirements

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

- fortiosapi>=0.9.8

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
host string |  | FortiOS or FortiGate IP address.
https boolean | Choices: no yes ← | Indicates if the requests towards FortiGate must use HTTPS protocol.
log_threat_weight dictionary | Default: null | Configure threat weight settings.
| application list |  | Application-control threat weight settings.
|  | category integer |  | Application category.
|  | id integer / required |  | Entry ID.
|  | level string | Choices: disable low medium high critical | Threat weight score for Application events.
| blocked_connection string | Choices: disable low medium high critical | Threat weight score for blocked connections.
| failed_connection string | Choices: disable low medium high critical | Threat weight score for failed connections.
| geolocation list |  | Geolocation-based threat weight settings.
|  | country string |  | Country code.
|  | id integer / required |  | Entry ID.
|  | level string | Choices: disable low medium high critical | Threat weight score for Geolocation-based events.
| ips dictionary |  | IPS threat weight settings.
|  | critical_severity string | Choices: disable low medium high critical | Threat weight score for IPS critical severity events.
|  | high_severity string | Choices: disable low medium high critical | Threat weight score for IPS high severity events.
|  | info_severity string | Choices: disable low medium high critical | Threat weight score for IPS info severity events.
|  | low_severity string | Choices: disable low medium high critical | Threat weight score for IPS low severity events.
|  | medium_severity string | Choices: disable low medium high critical | Threat weight score for IPS medium severity events.
| level dictionary |  | Score mapping for threat weight levels.
|  | critical integer |  | Critical level score value (1 - 100).
|  | high integer |  | High level score value (1 - 100).
|  | low integer |  | Low level score value (1 - 100).
|  | medium integer |  | Medium level score value (1 - 100).
| malware dictionary |  | Anti-virus malware threat weight settings.
|  | botnet_connection string | Choices: disable low medium high critical | Threat weight score for detected botnet connections.
|  | command_blocked string | Choices: disable low medium high critical | Threat weight score for blocked command detected.
|  | content_disarm string | Choices: disable low medium high critical | Threat weight score for virus (content disarm) detected.
|  | mimefragmented string | Choices: disable low medium high critical | Threat weight score for mimefragmented detected.
|  | oversized string | Choices: disable low medium high critical | Threat weight score for oversized file detected.
|  | switch_proto string | Choices: disable low medium high critical | Threat weight score for switch proto detected.
|  | virus_blocked string | Choices: disable low medium high critical | Threat weight score for virus (blocked) detected.
|  | virus_file_type_executable string | Choices: disable low medium high critical | Threat weight score for virus (filetype executable) detected.
|  | virus_infected string | Choices: disable low medium high critical | Threat weight score for virus (infected) detected.
|  | virus_outbreak_prevention string | Choices: disable low medium high critical | Threat weight score for virus (outbreak prevention) event.
|  | virus_scan_error string | Choices: disable low medium high critical | Threat weight score for virus (scan error) detected.
| status string | Choices: enable disable | Enable/disable the threat weight feature.
| url_block_detected string | Choices: disable low medium high critical | Threat weight score for URL blocking.
| web list |  | Web filtering threat weight settings.
|  | category integer |  | Threat weight score for web category filtering matches.
|  | id integer / required |  | Entry ID.
|  | level string | Choices: disable low medium high critical | Threat weight score for web category filtering matches.
password string | Default: "" | FortiOS or FortiGate password.
ssl_verify boolean added in 2.9 | Choices: no yes ← | Ensures FortiGate certificate must be verified by a proper CA.
username string |  | FortiOS or FortiGate username.
vdom string | Default: "root" | 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.

## Notes

Note

- Requires fortiosapi library developed by Fortinet
- Run as a local_action in your playbook

## Examples

    - hosts: localhost
      vars:
       host: "192.168.122.40"
       username: "admin"
       password: ""
       vdom: "root"
       ssl_verify: "False"
      tasks:
      - name: Configure threat weight settings.
        fortios_log_threat_weight:
          host:  "{{ host }}"
          username: "{{ username }}"
          password: "{{ password }}"
          vdom:  "{{ vdom }}"
          https: "False"
          log_threat_weight:
            application:
             -
                category: "4"
                id:  "5"
                level: "disable"
            blocked_connection: "disable"
            failed_connection: "disable"
            geolocation:
             -
                country: "<your_own_value>"
                id:  "11"
                level: "disable"
            ips:
                critical_severity: "disable"
                high_severity: "disable"
                info_severity: "disable"
                low_severity: "disable"
                medium_severity: "disable"
            level:
                critical: "20"
                high: "21"
                low: "22"
                medium: "23"
            malware:
                botnet_connection: "disable"
                command_blocked: "disable"
                content_disarm: "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: "39"
                id:  "40"
                level: "disable"

## Return Values

Common return values are documented here, the following are the fields unique to this module:

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

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]

### Authors

- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.