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

New in version 2.8.

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

Parameters

  • access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: 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
  • log_threat_weight - Configure threat weight settings. type: dict
    • application - Application-control threat weight settings. type: list
      • category - Application category. type: int
      • id - Entry ID. type: int required: True
      • level - Threat weight score for Application events. type: str choices: disable, low, medium, high, critical
    • blocked_connection - Threat weight score for blocked connections. type: str choices: disable, low, medium, high, critical
    • botnet_connection_detected - Threat weight score for detected botnet connections. type: str choices: disable, low, medium, high, critical
    • failed_connection - Threat weight score for failed connections. type: str choices: disable, low, medium, high, critical
    • geolocation - Geolocation-based threat weight settings. type: list
      • country - Country code. type: str
      • id - Entry ID. type: int required: True
      • level - Threat weight score for Geolocation-based events. type: str choices: disable, low, medium, high, critical
    • ips - IPS threat weight settings. type: dict
      • critical_severity - Threat weight score for IPS critical severity events. type: str choices: disable, low, medium, high, critical
      • high_severity - Threat weight score for IPS high severity events. type: str choices: disable, low, medium, high, critical
      • info_severity - Threat weight score for IPS info severity events. type: str choices: disable, low, medium, high, critical
      • low_severity - Threat weight score for IPS low severity events. type: str choices: disable, low, medium, high, critical
      • medium_severity - Threat weight score for IPS medium severity events. type: str choices: disable, low, medium, high, critical
    • level - Score mapping for threat weight levels. type: dict
      • critical - Critical level score value (1 - 100). type: int
      • high - High level score value (1 - 100). type: int
      • low - Low level score value (1 - 100). type: int
      • medium - Medium level score value (1 - 100). type: int
    • malware_detected - Threat weight score for detected malware. type: str choices: disable, low, medium, high, critical
    • status - Enable/disable the threat weight feature. type: str choices: enable, disable
    • url_block_detected - Threat weight score for URL blocking. type: str choices: disable, low, medium, high, critical
    • web - Web filtering threat weight settings. type: list
      • category - Threat weight score for web category filtering matches. type: int
      • id - Entry ID. type: int required: True
      • level - Threat weight score for web category filtering matches. type: str choices: disable, low, medium, high, critical

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- 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 threat weight settings.
    fortios_log_threat_weight:
      vdom:  "{{ vdom }}"
      log_threat_weight:
        application:
         -
            category: "4"
            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: "21"
            high: "22"
            low: "23"
            medium: "24"
        malware_detected: "disable"
        status: "enable"
        url_block_detected: "disable"
        web:
         -
            category: "29"
            id:  "30"
            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.

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.