:source: fortios_log_threat_weight.py
:orphan:
.. fortios_log_threat_weight:
fortios_log_threat_weight -- Configure threat weight settings in Fortinet's FortiOS and FortiGate.
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. versionadded:: 2.0.0
.. contents::
:local:
:depth: 1
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.0
Requirements
------------
The below requirements are needed on the host that executes this module.
- ansible>=2.16
Tips
----
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
-----------------------------
Supported Version Ranges: v6.0.0 -> v7.6.6
Parameters
----------
.. raw:: html
- 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
- log_threat_weight - Configure threat weight settings. type: dict
more...
| Supported Version Ranges |
| log_threat_weight |
v6.0.0 -> 7.6.6 |
- application - Application-control threat weight settings. type: list member_path: application:id
more...
| Supported Version Ranges |
| application |
v6.0.0 -> 7.6.6 |
- category - Application category. type: int
more...
|
Supported Version Ranges |
| category |
v6.0.0 -> 7.6.6 |
- id - Entry ID. see Notes. type: int required: true
more...
|
Supported Version Ranges |
| id |
v6.0.0 -> 7.6.6 |
- level - Threat weight score for Application events. type: str choices: disable, low, medium, high, critical
more...
|
Supported Version Ranges |
| level |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
| [low] |
v6.0.0 -> 7.6.6 |
| [medium] |
v6.0.0 -> 7.6.6 |
| [high] |
v6.0.0 -> 7.6.6 |
| [critical] |
v6.0.0 -> 7.6.6 |
- blocked_connection - Threat weight score for blocked connections. type: str choices: disable, low, medium, high, critical
more...
|
Supported Version Ranges |
| blocked_connection |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
| [low] |
v6.0.0 -> 7.6.6 |
| [medium] |
v6.0.0 -> 7.6.6 |
| [high] |
v6.0.0 -> 7.6.6 |
| [critical] |
v6.0.0 -> 7.6.6 |
- botnet_connection_detected - Threat weight score for detected botnet connections. type: str choices: disable, low, medium, high, critical
more...
|
Supported Version Ranges |
| botnet_connection_detected |
v6.2.0 -> 7.6.6 |
| [disable] |
v6.2.0 -> 7.6.6 |
| [low] |
v6.2.0 -> 7.6.6 |
| [medium] |
v6.2.0 -> 7.6.6 |
| [high] |
v6.2.0 -> 7.6.6 |
| [critical] |
v6.2.0 -> 7.6.6 |
- failed_connection - Threat weight score for failed connections. type: str choices: disable, low, medium, high, critical
more...
|
Supported Version Ranges |
| failed_connection |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
| [low] |
v6.0.0 -> 7.6.6 |
| [medium] |
v6.0.0 -> 7.6.6 |
| [high] |
v6.0.0 -> 7.6.6 |
| [critical] |
v6.0.0 -> 7.6.6 |
- geolocation - Geolocation-based threat weight settings. type: list member_path: geolocation:id
more...
| Supported Version Ranges |
| geolocation |
v6.0.0 -> 7.6.6 |
- country - Country code. type: str
more...
|
Supported Version Ranges |
| country |
v6.0.0 -> 7.6.6 |
- id - Entry ID. see Notes. type: int required: true
more...
|
Supported Version Ranges |
| id |
v6.0.0 -> 7.6.6 |
- level - Threat weight score for Geolocation-based events. type: str choices: disable, low, medium, high, critical
more...
|
Supported Version Ranges |
| level |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
| [low] |
v6.0.0 -> 7.6.6 |
| [medium] |
v6.0.0 -> 7.6.6 |
| [high] |
v6.0.0 -> 7.6.6 |
| [critical] |
v6.0.0 -> 7.6.6 |
- ips - IPS threat weight settings. type: dict
more...
| Supported Version Ranges |
| ips |
v6.0.0 -> 7.6.6 |
- critical_severity - Threat weight score for IPS critical severity events. type: str choices: disable, low, medium, high, critical
more...
|
Supported Version Ranges |
| critical_severity |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
| [low] |
v6.0.0 -> 7.6.6 |
| [medium] |
v6.0.0 -> 7.6.6 |
| [high] |
v6.0.0 -> 7.6.6 |
| [critical] |
v6.0.0 -> 7.6.6 |
- high_severity - Threat weight score for IPS high severity events. type: str choices: disable, low, medium, high, critical
more...
|
Supported Version Ranges |
| high_severity |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
| [low] |
v6.0.0 -> 7.6.6 |
| [medium] |
v6.0.0 -> 7.6.6 |
| [high] |
v6.0.0 -> 7.6.6 |
| [critical] |
v6.0.0 -> 7.6.6 |
- info_severity - Threat weight score for IPS info severity events. type: str choices: disable, low, medium, high, critical
more...
|
Supported Version Ranges |
| info_severity |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
| [low] |
v6.0.0 -> 7.6.6 |
| [medium] |
v6.0.0 -> 7.6.6 |
| [high] |
v6.0.0 -> 7.6.6 |
| [critical] |
v6.0.0 -> 7.6.6 |
- low_severity - Threat weight score for IPS low severity events. type: str choices: disable, low, medium, high, critical
more...
|
Supported Version Ranges |
| low_severity |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
| [low] |
v6.0.0 -> 7.6.6 |
| [medium] |
v6.0.0 -> 7.6.6 |
| [high] |
v6.0.0 -> 7.6.6 |
| [critical] |
v6.0.0 -> 7.6.6 |
- medium_severity - Threat weight score for IPS medium severity events. type: str choices: disable, low, medium, high, critical
more...
|
Supported Version Ranges |
| medium_severity |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
| [low] |
v6.0.0 -> 7.6.6 |
| [medium] |
v6.0.0 -> 7.6.6 |
| [high] |
v6.0.0 -> 7.6.6 |
| [critical] |
v6.0.0 -> 7.6.6 |
- level - Score mapping for threat weight levels. type: dict
more...
| Supported Version Ranges |
| level |
v6.0.0 -> 7.6.6 |
- critical - Critical level score value (1 - 100). type: int
more...
|
Supported Version Ranges |
| critical |
v6.0.0 -> 7.6.6 |
- high - High level score value (1 - 100). type: int
more...
|
Supported Version Ranges |
| high |
v6.0.0 -> 7.6.6 |
- low - Low level score value (1 - 100). type: int
more...
|
Supported Version Ranges |
| low |
v6.0.0 -> 7.6.6 |
- medium - Medium level score value (1 - 100). type: int
more...
|
Supported Version Ranges |
| medium |
v6.0.0 -> 7.6.6 |
- malware - Anti-virus malware threat weight settings. type: dict
more...
| Supported Version Ranges |
| malware |
v6.0.0 -> 7.6.6 |
- botnet_connection - Threat weight score for detected botnet connections. type: str choices: disable, low, medium, high, critical
more...
|
Supported Version Ranges |
| botnet_connection |
v6.0.0 -> v6.0.11 |
| [disable] |
v6.0.0 -> v6.0.11 |
| [low] |
v6.0.0 -> v6.0.11 |
| [medium] |
v6.0.0 -> v6.0.11 |
| [high] |
v6.0.0 -> v6.0.11 |
| [critical] |
v6.0.0 -> v6.0.11 |
- command_blocked - Threat weight score for blocked command detected. type: str choices: disable, low, medium, high, critical
more...
|
Supported Version Ranges |
| command_blocked |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
| [low] |
v6.0.0 -> 7.6.6 |
| [medium] |
v6.0.0 -> 7.6.6 |
| [high] |
v6.0.0 -> 7.6.6 |
| [critical] |
v6.0.0 -> 7.6.6 |
- content_disarm - Threat weight score for virus (content disarm) detected. type: str choices: disable, low, medium, high, critical
more...
|
Supported Version Ranges |
| content_disarm |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
| [low] |
v6.0.0 -> 7.6.6 |
| [medium] |
v6.0.0 -> 7.6.6 |
| [high] |
v6.0.0 -> 7.6.6 |
| [critical] |
v6.0.0 -> 7.6.6 |
- ems_threat_feed - Threat weight score for virus (EMS threat feed) detected. type: str choices: disable, low, medium, high, critical
more...
|
Supported Version Ranges |
| ems_threat_feed |
v7.0.0 -> 7.6.6 |
| [disable] |
v7.0.0 -> 7.6.6 |
| [low] |
v7.0.0 -> 7.6.6 |
| [medium] |
v7.0.0 -> 7.6.6 |
| [high] |
v7.0.0 -> 7.6.6 |
| [critical] |
v7.0.0 -> 7.6.6 |
- file_blocked - Threat weight score for blocked file detected. type: str choices: disable, low, medium, high, critical
more...
|
Supported Version Ranges |
| file_blocked |
v6.2.0 -> 7.6.6 |
| [disable] |
v6.2.0 -> 7.6.6 |
| [low] |
v6.2.0 -> 7.6.6 |
| [medium] |
v6.2.0 -> 7.6.6 |
| [high] |
v6.2.0 -> 7.6.6 |
| [critical] |
v6.2.0 -> 7.6.6 |
- fortiai - Threat weight score for FortiAI-detected virus. type: str choices: disable, low, medium, high, critical
more...
|
Supported Version Ranges |
| fortiai |
v7.0.1 -> v7.0.7 |
| [disable] |
v7.0.1 -> v7.0.7 |
| [low] |
v7.0.1 -> v7.0.7 |
| [medium] |
v7.0.1 -> v7.0.7 |
| [high] |
v7.0.1 -> v7.0.7 |
| [critical] |
v7.0.1 -> v7.0.7 |
- fortindr - Threat weight score for FortiNDR-detected virus. type: str choices: disable, low, medium, high, critical
more...
|
Supported Version Ranges |
| fortindr |
v7.0.8 -> v7.2.4 |
| [disable] |
v7.0.8 -> v7.2.4 |
| [low] |
v7.0.8 -> v7.2.4 |
| [medium] |
v7.0.8 -> v7.2.4 |
| [high] |
v7.0.8 -> v7.2.4 |
| [critical] |
v7.0.8 -> v7.2.4 |
- fortisandbox - Threat weight score for FortiSandbox-detected virus. type: str choices: disable, low, medium, high, critical
more...
|
Supported Version Ranges |
| fortisandbox |
v7.2.0 -> v7.2.4 |
| [disable] |
v7.2.0 -> v7.2.4 |
| [low] |
v7.2.0 -> v7.2.4 |
| [medium] |
v7.2.0 -> v7.2.4 |
| [high] |
v7.2.0 -> v7.2.4 |
| [critical] |
v7.2.0 -> v7.2.4 |
- fsa_high_risk - Threat weight score for FortiSandbox high risk malware detected. type: str choices: disable, low, medium, high, critical
more...
|
Supported Version Ranges |
| fsa_high_risk |
v6.2.0 -> 7.6.6 |
| [disable] |
v6.2.0 -> 7.6.6 |
| [low] |
v6.2.0 -> 7.6.6 |
| [medium] |
v6.2.0 -> 7.6.6 |
| [high] |
v6.2.0 -> 7.6.6 |
| [critical] |
v6.2.0 -> 7.6.6 |
- fsa_malicious - Threat weight score for FortiSandbox malicious malware detected. type: str choices: disable, low, medium, high, critical
more...
|
Supported Version Ranges |
| fsa_malicious |
v6.2.0 -> 7.6.6 |
| [disable] |
v6.2.0 -> 7.6.6 |
| [low] |
v6.2.0 -> 7.6.6 |
| [medium] |
v6.2.0 -> 7.6.6 |
| [high] |
v6.2.0 -> 7.6.6 |
| [critical] |
v6.2.0 -> 7.6.6 |
- fsa_medium_risk - Threat weight score for FortiSandbox medium risk malware detected. type: str choices: disable, low, medium, high, critical
more...
|
Supported Version Ranges |
| fsa_medium_risk |
v6.2.0 -> 7.6.6 |
| [disable] |
v6.2.0 -> 7.6.6 |
| [low] |
v6.2.0 -> 7.6.6 |
| [medium] |
v6.2.0 -> 7.6.6 |
| [high] |
v6.2.0 -> 7.6.6 |
| [critical] |
v6.2.0 -> 7.6.6 |
- inline_block - Threat weight score for malware detected by inline block. type: str choices: disable, low, medium, high, critical
more...
|
Supported Version Ranges |
| inline_block |
v7.4.0 -> 7.6.6 |
| [disable] |
v7.4.0 -> 7.6.6 |
| [low] |
v7.4.0 -> 7.6.6 |
| [medium] |
v7.4.0 -> 7.6.6 |
| [high] |
v7.4.0 -> 7.6.6 |
| [critical] |
v7.4.0 -> 7.6.6 |
- malware_list - Threat weight score for virus (malware list) detected. type: str choices: disable, low, medium, high, critical
more...
|
Supported Version Ranges |
| malware_list |
v6.2.0 -> 7.6.6 |
| [disable] |
v6.2.0 -> 7.6.6 |
| [low] |
v6.2.0 -> 7.6.6 |
| [medium] |
v6.2.0 -> 7.6.6 |
| [high] |
v6.2.0 -> 7.6.6 |
| [critical] |
v6.2.0 -> 7.6.6 |
- mimefragmented - Threat weight score for mimefragmented detected. type: str choices: disable, low, medium, high, critical
more...
|
Supported Version Ranges |
| mimefragmented |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
| [low] |
v6.0.0 -> 7.6.6 |
| [medium] |
v6.0.0 -> 7.6.6 |
| [high] |
v6.0.0 -> 7.6.6 |
| [critical] |
v6.0.0 -> 7.6.6 |
- oversized - Threat weight score for oversized file detected. type: str choices: disable, low, medium, high, critical
more...
|
Supported Version Ranges |
| oversized |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
| [low] |
v6.0.0 -> 7.6.6 |
| [medium] |
v6.0.0 -> 7.6.6 |
| [high] |
v6.0.0 -> 7.6.6 |
| [critical] |
v6.0.0 -> 7.6.6 |
- switch_proto - Threat weight score for switch proto detected. type: str choices: disable, low, medium, high, critical
more...
|
Supported Version Ranges |
| switch_proto |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
| [low] |
v6.0.0 -> 7.6.6 |
| [medium] |
v6.0.0 -> 7.6.6 |
| [high] |
v6.0.0 -> 7.6.6 |
| [critical] |
v6.0.0 -> 7.6.6 |
- virus_blocked - Threat weight score for virus (blocked) detected. type: str choices: disable, low, medium, high, critical
more...
|
Supported Version Ranges |
| virus_blocked |
v6.0.0 -> v6.0.11 |
| [disable] |
v6.0.0 -> v6.0.11 |
| [low] |
v6.0.0 -> v6.0.11 |
| [medium] |
v6.0.0 -> v6.0.11 |
| [high] |
v6.0.0 -> v6.0.11 |
| [critical] |
v6.0.0 -> v6.0.11 |
- virus_file_type_executable - Threat weight score for virus (file type executable) detected. type: str choices: disable, low, medium, high, critical
more...
|
Supported Version Ranges |
| virus_file_type_executable |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
| [low] |
v6.0.0 -> 7.6.6 |
| [medium] |
v6.0.0 -> 7.6.6 |
| [high] |
v6.0.0 -> 7.6.6 |
| [critical] |
v6.0.0 -> 7.6.6 |
- virus_infected - Threat weight score for virus (infected) detected. type: str choices: disable, low, medium, high, critical
more...
|
Supported Version Ranges |
| virus_infected |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
| [low] |
v6.0.0 -> 7.6.6 |
| [medium] |
v6.0.0 -> 7.6.6 |
| [high] |
v6.0.0 -> 7.6.6 |
| [critical] |
v6.0.0 -> 7.6.6 |
- virus_outbreak_prevention - Threat weight score for virus (outbreak prevention) event. type: str choices: disable, low, medium, high, critical
more...
|
Supported Version Ranges |
| virus_outbreak_prevention |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
| [low] |
v6.0.0 -> 7.6.6 |
| [medium] |
v6.0.0 -> 7.6.6 |
| [high] |
v6.0.0 -> 7.6.6 |
| [critical] |
v6.0.0 -> 7.6.6 |
- virus_scan_error - Threat weight score for virus (scan error) detected. type: str choices: disable, low, medium, high, critical
more...
|
Supported Version Ranges |
| virus_scan_error |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
| [low] |
v6.0.0 -> 7.6.6 |
| [medium] |
v6.0.0 -> 7.6.6 |
| [high] |
v6.0.0 -> 7.6.6 |
| [critical] |
v6.0.0 -> 7.6.6 |
- status - Enable/disable the threat weight feature. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| status |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- url_block_detected - Threat weight score for URL blocking. type: str choices: disable, low, medium, high, critical
more...
|
Supported Version Ranges |
| url_block_detected |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
| [low] |
v6.0.0 -> 7.6.6 |
| [medium] |
v6.0.0 -> 7.6.6 |
| [high] |
v6.0.0 -> 7.6.6 |
| [critical] |
v6.0.0 -> 7.6.6 |
- web - Web filtering threat weight settings. type: list member_path: web:id
more...
| Supported Version Ranges |
| web |
v6.0.0 -> 7.6.6 |
- category - Threat weight score for web category filtering matches. type: int
more...
|
Supported Version Ranges |
| category |
v6.0.0 -> 7.6.6 |
- id - Entry ID. see Notes. type: int required: true
more...
|
Supported Version Ranges |
| id |
v6.0.0 -> 7.6.6 |
- level - Threat weight score for web category filtering matches. type: str choices: disable, low, medium, high, critical
more...
|
Supported Version Ranges |
| level |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
| [low] |
v6.0.0 -> 7.6.6 |
| [medium] |
v6.0.0 -> 7.6.6 |
| [high] |
v6.0.0 -> 7.6.6 |
| [critical] |
v6.0.0 -> 7.6.6 |
Notes
-----
.. note::
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
- The module supports check_mode.
Examples
--------
.. code-block:: yaml+jinja
- 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: ""
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"
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:
.. raw:: html
- 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.