fortios_log_threat_weight – Configure threat weight settings in Fortinet’s FortiOS and FortiGate.
New in version 2.0.0.
Synopsis
This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify 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.15
Tips
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
Supported Version Ranges: v6.0.0 -> 7.4.3
Parameters
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- vdom - Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. type: str default: root
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- log_threat_weight - Configure threat weight settings. type: dict more...
- application - Application-control threat weight settings. type: list member_path: application:id more...
- category - Application category. type: int more...
- id - Entry ID. see Notes. type: int required: true more...
- level - Threat weight score for Application events. type: str choices: disable, low, medium, high, critical more...
- blocked_connection - Threat weight score for blocked connections. type: str choices: disable, low, medium, high, critical more...
- botnet_connection_detected - Threat weight score for detected botnet connections. type: str choices: disable, low, medium, high, critical more...
- failed_connection - Threat weight score for failed connections. type: str choices: disable, low, medium, high, critical more...
- geolocation - Geolocation-based threat weight settings. type: list member_path: geolocation:id more...
- country - Country code. type: str more...
- id - Entry ID. see Notes. type: int required: true more...
- level - Threat weight score for Geolocation-based events. type: str choices: disable, low, medium, high, critical more...
- ips - IPS threat weight settings. type: dict more...
- critical_severity - Threat weight score for IPS critical severity events. type: str choices: disable, low, medium, high, critical more...
- high_severity - Threat weight score for IPS high severity events. type: str choices: disable, low, medium, high, critical more...
- info_severity - Threat weight score for IPS info severity events. type: str choices: disable, low, medium, high, critical more...
- low_severity - Threat weight score for IPS low severity events. type: str choices: disable, low, medium, high, critical more...
- medium_severity - Threat weight score for IPS medium severity events. type: str choices: disable, low, medium, high, critical more...
- level - Score mapping for threat weight levels. type: dict more...
- critical - Critical level score value (1 - 100). type: int more...
- high - High level score value (1 - 100). type: int more...
- low - Low level score value (1 - 100). type: int more...
- medium - Medium level score value (1 - 100). type: int more...
- malware - Anti-virus malware threat weight settings. type: dict more...
- botnet_connection - Threat weight score for detected botnet connections. type: str choices: disable, low, medium, high, critical more...
- command_blocked - Threat weight score for blocked command detected. type: str choices: disable, low, medium, high, critical more...
- content_disarm - Threat weight score for virus (content disarm) detected. type: str choices: disable, low, medium, high, critical more...
- ems_threat_feed - Threat weight score for virus (EMS threat feed) detected. type: str choices: disable, low, medium, high, critical more...
- file_blocked - Threat weight score for blocked file detected. type: str choices: disable, low, medium, high, critical more...
- fortiai - Threat weight score for FortiAI-detected virus. type: str choices: disable, low, medium, high, critical more...
- fortindr - Threat weight score for FortiNDR-detected virus. type: str choices: disable, low, medium, high, critical more...
- fortisandbox - Threat weight score for FortiSandbox-detected virus. type: str choices: disable, low, medium, high, critical more...
- fsa_high_risk - Threat weight score for FortiSandbox high risk malware detected. type: str choices: disable, low, medium, high, critical more...
- fsa_malicious - Threat weight score for FortiSandbox malicious malware detected. type: str choices: disable, low, medium, high, critical more...
- fsa_medium_risk - Threat weight score for FortiSandbox medium risk malware detected. type: str choices: disable, low, medium, high, critical more...
- inline_block - Threat weight score for malware detected by inline block. type: str choices: disable, low, medium, high, critical more...
- malware_list - Threat weight score for virus (malware list) detected. type: str choices: disable, low, medium, high, critical more...
- mimefragmented - Threat weight score for mimefragmented detected. type: str choices: disable, low, medium, high, critical more...
- oversized - Threat weight score for oversized file detected. type: str choices: disable, low, medium, high, critical more...
- switch_proto - Threat weight score for switch proto detected. type: str choices: disable, low, medium, high, critical more...
- virus_blocked - Threat weight score for virus (blocked) detected. type: str choices: disable, low, medium, high, critical more...
- virus_file_type_executable - Threat weight score for virus (file type executable) detected. type: str choices: disable, low, medium, high, critical more...
- virus_infected - Threat weight score for virus (infected) detected. type: str choices: disable, low, medium, high, critical more...
- virus_outbreak_prevention - Threat weight score for virus (outbreak prevention) event. type: str choices: disable, low, medium, high, critical more...
- virus_scan_error - Threat weight score for virus (scan error) detected. type: str choices: disable, low, medium, high, critical more...
- status - Enable/disable the threat weight feature. type: str choices: enable, disable more...
- url_block_detected - Threat weight score for URL blocking. type: str choices: disable, low, medium, high, critical more...
- web - Web filtering threat weight settings. type: list member_path: web:id more...
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- 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"
Return Values
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3
Status
This module is not guaranteed to have a backwards compatible interface.