fortinet.fortios.fortios_log_disk_filter module – Configure filters for local disk logging. Use these filters to determine the log messages to record according to severity and type in Fortinet’s FortiOS and FortiGate.

Note

This module is part of the fortinet.fortios collection (version 2.3.7).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortios. You need further requirements to be able to use this module, see Requirements for details.

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

New in fortinet.fortios 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_disk feature and filter 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

Parameters

Parameter

Comments

access_token

string

Token-based authentication. Generated from GUI of Fortigate.

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

log_disk_filter

dictionary

Configure filters for local disk logging. Use these filters to determine the log messages to record according to severity and type.

admin

string

Enable/disable admin login/logout logging.

Choices:

  • "enable"

  • "disable"

anomaly

string

Enable/disable anomaly logging.

Choices:

  • "enable"

  • "disable"

auth

string

Enable/disable firewall authentication logging.

Choices:

  • "enable"

  • "disable"

cpu_memory_usage

string

Enable/disable CPU & memory usage logging every 5 minutes.

Choices:

  • "enable"

  • "disable"

dhcp

string

Enable/disable DHCP service messages logging.

Choices:

  • "enable"

  • "disable"

dlp_archive

string

Enable/disable DLP archive logging.

Choices:

  • "enable"

  • "disable"

dns

string

Enable/disable detailed DNS event logging.

Choices:

  • "enable"

  • "disable"

event

string

Enable/disable event logging.

Choices:

  • "enable"

  • "disable"

filter

string

Disk log filter.

filter_type

string

Include/exclude logs that match the filter.

Choices:

  • "include"

  • "exclude"

forti_switch

string

Enable/disable Forti-Switch logging.

Choices:

  • "enable"

  • "disable"

forward_traffic

string

Enable/disable forward traffic logging.

Choices:

  • "enable"

  • "disable"

free_style

list / elements=dictionary

Free style filters.

category

string

Log category.

Choices:

  • "traffic"

  • "event"

  • "virus"

  • "webfilter"

  • "attack"

  • "spam"

  • "anomaly"

  • "voip"

  • "dlp"

  • "app-ctrl"

  • "waf"

  • "gtp"

  • "dns"

  • "ssh"

  • "ssl"

  • "file-filter"

  • "icap"

  • "virtual-patch"

  • "ztna"

filter

string

Free style filter string.

filter_type

string

Include/exclude logs that match the filter.

Choices:

  • "include"

  • "exclude"

id

integer / required

Entry ID. see <a href=’#notes’>Notes</a>.

gtp

string

Enable/disable GTP messages logging.

Choices:

  • "enable"

  • "disable"

ha

string

Enable/disable HA logging.

Choices:

  • "enable"

  • "disable"

ipsec

string

Enable/disable IPsec negotiation messages logging.

Choices:

  • "enable"

  • "disable"

ldb_monitor

string

Enable/disable VIP real server health monitoring logging.

Choices:

  • "enable"

  • "disable"

local_traffic

string

Enable/disable local in or out traffic logging.

Choices:

  • "enable"

  • "disable"

multicast_traffic

string

Enable/disable multicast traffic logging.

Choices:

  • "enable"

  • "disable"

netscan_discovery

string

Enable/disable netscan discovery event logging.

netscan_vulnerability

string

Enable/disable netscan vulnerability event logging.

notification

string

Enable/disable notification messages logging.

Choices:

  • "enable"

  • "disable"

pattern

string

Enable/disable pattern update logging.

Choices:

  • "enable"

  • "disable"

ppp

string

Enable/disable L2TP/PPTP/PPPoE logging.

Choices:

  • "enable"

  • "disable"

radius

string

Enable/disable RADIUS messages logging.

Choices:

  • "enable"

  • "disable"

severity

string

Log to disk every message above and including this severity level.

Choices:

  • "emergency"

  • "alert"

  • "critical"

  • "error"

  • "warning"

  • "notification"

  • "information"

  • "debug"

sniffer_traffic

string

Enable/disable sniffer traffic logging.

Choices:

  • "enable"

  • "disable"

ssh

string

Enable/disable SSH logging.

Choices:

  • "enable"

  • "disable"

sslvpn_log_adm

string

Enable/disable SSL administrator login logging.

Choices:

  • "enable"

  • "disable"

sslvpn_log_auth

string

Enable/disable SSL user authentication logging.

Choices:

  • "enable"

  • "disable"

sslvpn_log_session

string

Enable/disable SSL session logging.

Choices:

  • "enable"

  • "disable"

system

string

Enable/disable system activity logging.

Choices:

  • "enable"

  • "disable"

vip_ssl

string

Enable/disable VIP SSL logging.

Choices:

  • "enable"

  • "disable"

voip

string

Enable/disable VoIP logging.

Choices:

  • "enable"

  • "disable"

wan_opt

string

Enable/disable WAN optimization event logging.

Choices:

  • "enable"

  • "disable"

wireless_activity

string

Enable/disable wireless activity event logging.

Choices:

  • "enable"

  • "disable"

ztna_traffic

string

Enable/disable ztna traffic logging.

Choices:

  • "enable"

  • "disable"

member_path

string

Member attribute path to operate on.

Delimited by a slash character if there are more than one attribute.

Parameter marked with member_path is legitimate for doing member operation.

member_state

string

Add or delete a member under specified attribute path.

When member_state is specified, the state option is ignored.

Choices:

  • "present"

  • "absent"

vdom

string

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.

Default: "root"

Notes

Note

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

Examples

- name: Configure filters for local disk logging. Use these filters to determine the log messages to record according to severity and type.
  fortinet.fortios.fortios_log_disk_filter:
      vdom: "{{ vdom }}"
      log_disk_filter:
          admin: "enable"
          anomaly: "enable"
          auth: "enable"
          cpu_memory_usage: "enable"
          dhcp: "enable"
          dlp_archive: "enable"
          dns: "enable"
          event: "enable"
          filter: "<your_own_value>"
          filter_type: "include"
          forti_switch: "enable"
          forward_traffic: "enable"
          free_style:
              -
                  category: "traffic"
                  filter: "<your_own_value>"
                  filter_type: "include"
                  id: "19"
          gtp: "enable"
          ha: "enable"
          ipsec: "enable"
          ldb_monitor: "enable"
          local_traffic: "enable"
          multicast_traffic: "enable"
          netscan_discovery: "<your_own_value>"
          netscan_vulnerability: "<your_own_value>"
          notification: "enable"
          pattern: "enable"
          ppp: "enable"
          radius: "enable"
          severity: "emergency"
          sniffer_traffic: "enable"
          ssh: "enable"
          sslvpn_log_adm: "enable"
          sslvpn_log_auth: "enable"
          sslvpn_log_session: "enable"
          system: "enable"
          vip_ssl: "enable"
          voip: "enable"
          wan_opt: "enable"
          wireless_activity: "enable"
          ztna_traffic: "enable"

Return Values

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

Key

Description

build

string

Build number of the fortigate image

Returned: always

Sample: "1547"

http_method

string

Last method used to provision the content into FortiGate

Returned: always

Sample: "PUT"

http_status

string

Last result given by FortiGate on last operation applied

Returned: always

Sample: "200"

mkey

string

Master key (id) used in the last call to FortiGate

Returned: success

Sample: "id"

name

string

Name of the table used to fulfill the request

Returned: always

Sample: "urlfilter"

path

string

Path of the table used to fulfill the request

Returned: always

Sample: "webfilter"

revision

string

Internal revision number

Returned: always

Sample: "17.0.2.10658"

serial

string

Serial number of the unit

Returned: always

Sample: "FGVMEVYYQT3AB5352"

status

string

Indication of the operation’s result

Returned: always

Sample: "success"

vdom

string

Virtual domain used

Returned: always

Sample: "root"

version

string

Version of the FortiGate

Returned: always

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)