fortinet.fortios.fortios_log_eventfilter – Configure log event filters in Fortinet’s FortiOS and FortiGate.

Note

This plugin is part of the fortinet.fortios collection (version 2.1.2).

To install it use: ansible-galaxy collection install fortinet.fortios.

To use it in a playbook, specify: fortinet.fortios.fortios_log_eventfilter.

New in version 2.10: of fortinet.fortios

Synopsis

  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log feature and eventfilter 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

Parameter Choices/Defaults Comments
access_token
string
Token-based authentication. Generated from GUI of Fortigate.
enable_log
boolean
    Choices:
  • no ←
  • yes
Enable/Disable logging for task.
log_eventfilter
dictionary
Configure log event filters.
cifs
string
    Choices:
  • enable
  • disable
Enable/disable CIFS logging.
compliance_check
string
    Choices:
  • enable
  • disable
Enable/disable PCI DSS compliance check logging.
connector
string
    Choices:
  • enable
  • disable
Enable/disable SDN connector logging.
endpoint
string
    Choices:
  • enable
  • disable
Enable/disable endpoint event logging.
event
string
    Choices:
  • enable
  • disable
Enable/disable event logging.
fortiextender
string
    Choices:
  • enable
  • disable
Enable/disable FortiExtender logging.
ha
string
    Choices:
  • enable
  • disable
Enable/disable ha event logging.
router
string
    Choices:
  • enable
  • disable
Enable/disable router event logging.
sdwan
string
    Choices:
  • enable
  • disable
Enable/disable SD-WAN logging.
security_rating
string
    Choices:
  • enable
  • disable
Enable/disable Security Rating result logging.
switch_controller
string
    Choices:
  • enable
  • disable
Enable/disable Switch-Controller logging.
system
string
    Choices:
  • enable
  • disable
Enable/disable system event logging.
user
string
    Choices:
  • enable
  • disable
Enable/disable user authentication event logging.
vpn
string
    Choices:
  • enable
  • disable
Enable/disable VPN event logging.
wan_opt
string
    Choices:
  • enable
  • disable
Enable/disable WAN optimization event logging.
wireless_activity
string
    Choices:
  • enable
  • disable
Enable/disable wireless event logging.
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

  • 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 log event filters.
    fortios_log_eventfilter:
      vdom:  "{{ vdom }}"
      log_eventfilter:
        cifs: "enable"
        compliance_check: "enable"
        connector: "enable"
        endpoint: "enable"
        event: "enable"
        fortiextender: "enable"
        ha: "enable"
        router: "enable"
        sdwan: "enable"
        security_rating: "enable"
        switch_controller: "enable"
        system: "enable"
        user: "enable"
        vpn: "enable"
        wan_opt: "enable"
        wireless_activity: "enable"

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


Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)