source:	fortios_log_disk_filter.py
orphan:

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

.. versionadded:: 2.0.0

Synopsis
Requirements
Tips
FortiOS Version Compatibility
Parameters
Notes
Examples
Return Values
Status
Authors

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

Tips

Using member operation to add an element to an existing object.

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4 v7.0.0 v7.0.1 v7.0.2 v7.0.3 v7.0.4 v7.0.5 v7.0.6 v7.0.7 v7.0.8 v7.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0

fortios_log_disk_filter yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

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_disk_filter - Configure filters for local disk logging. Use these filters to determine the log messages to record according to severity and type. type: dict more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4 v7.0.0 v7.0.1 v7.0.2 v7.0.3 v7.0.4 v7.0.5 v7.0.6 v7.0.7 v7.0.8 v7.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0

log_disk_filter yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

admin - Enable/disable admin login/logout logging. type: str choices: enable, disable more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7

admin yes yes yes yes yes yes yes

[enable] yes yes yes yes yes yes yes

[disable] yes yes yes yes yes yes yes

anomaly - Enable/disable anomaly logging. type: str choices: enable, disable more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4 v7.0.0 v7.0.1 v7.0.2 v7.0.3 v7.0.4 v7.0.5 v7.0.6 v7.0.7 v7.0.8 v7.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0

anomaly yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

[enable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

[disable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

auth - Enable/disable firewall authentication logging. type: str choices: enable, disable more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7

auth yes yes yes yes yes yes yes

[enable] yes yes yes yes yes yes yes

[disable] yes yes yes yes yes yes yes
cpu_memory_usage - Enable/disable CPU & memory usage logging every 5 minutes. type: str choices: enable, disable more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7

cpu_memory_usage yes yes yes yes yes yes yes

[enable] yes yes yes yes yes yes yes

[disable] yes yes yes yes yes yes yes
dhcp - Enable/disable DHCP service messages logging. type: str choices: enable, disable more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7

dhcp yes yes yes yes yes yes yes

[enable] yes yes yes yes yes yes yes

[disable] yes yes yes yes yes yes yes

dlp_archive - Enable/disable DLP archive logging. type: str choices: enable, disable more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4 v7.0.0 v7.0.1 v7.0.2 v7.0.3 v7.0.4 v7.0.5 v7.0.6 v7.0.7 v7.0.8 v7.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0

dlp_archive yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

[enable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

[disable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

dns - Enable/disable detailed DNS event logging. type: str choices: enable, disable more...

v6.0.0 v6.0.5 v6.0.11

dns yes yes yes

[enable] yes yes yes

[disable] yes yes yes
event - Enable/disable event logging. type: str choices: enable, disable more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7

event yes yes yes yes yes yes yes

[enable] yes yes yes yes yes yes yes

[disable] yes yes yes yes yes yes yes
filter - Disk log filter. type: str more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4

filter yes yes yes yes yes yes yes yes yes yes

filter_type - Include/exclude logs that match the filter. type: str choices: include, exclude more...

	`v6.0.0`	`v6.0.5`	`v6.0.11`	`v6.2.0`	`v6.2.3`	`v6.2.5`	`v6.2.7`	`v6.4.0`	`v6.4.1`	`v6.4.4`
filter_type	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[include]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[exclude]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes

forward_traffic - Enable/disable forward traffic logging. type: str choices: enable, disable more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4 v7.0.0 v7.0.1 v7.0.2 v7.0.3 v7.0.4 v7.0.5 v7.0.6 v7.0.7 v7.0.8 v7.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0

forward_traffic yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

[enable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

[disable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

free_style - Free style filters. type: list member_path: free_style:id more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4 v7.0.0 v7.0.1 v7.0.2 v7.0.3 v7.0.4 v7.0.5 v7.0.6 v7.0.7 v7.0.8 v7.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0

free_style no no no no no no no no no no yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

category - Log category. type: str choices: traffic, event, virus, webfilter, attack, spam, anomaly, voip, dlp, app-ctrl, waf, gtp, dns, ssh, ssl, file-filter, icap, ztna more...

v7.0.0 v7.0.1 v7.0.2 v7.0.3 v7.0.4 v7.0.5 v7.0.6 v7.0.7 v7.0.8 v7.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0

category yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

[traffic] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

[event] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

[virus] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

[webfilter] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

[attack] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

[spam] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

[anomaly] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

[voip] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

[dlp] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

[app-ctrl] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

[waf] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

[gtp] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

[dns] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

[ssh] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

[ssl] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

[file-filter] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

[icap] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

[ztna] no yes yes yes n/a n/a n/a n/a n/a no n/a n/a n/a n/a n/a

filter - Free style filter string. type: str more...

v7.0.0 v7.0.1 v7.0.2 v7.0.3 v7.0.4 v7.0.5 v7.0.6 v7.0.7 v7.0.8 v7.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0

filter yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

filter_type - Include/exclude logs that match the filter. type: str choices: include, exclude more...

v7.0.0 v7.0.1 v7.0.2 v7.0.3 v7.0.4 v7.0.5 v7.0.6 v7.0.7 v7.0.8 v7.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0

filter_type yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

[include] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

[exclude] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

id - Entry ID. see Notes. type: int required: true more...

v7.0.0 v7.0.1 v7.0.2 v7.0.3 v7.0.4 v7.0.5 v7.0.6 v7.0.7 v7.0.8 v7.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0

id yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

gtp - Enable/disable GTP messages logging. type: str choices: enable, disable more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4 v7.0.0 v7.0.1 v7.0.2 v7.0.3 v7.0.4 v7.0.5 v7.0.6 v7.0.7 v7.0.8 v7.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0

gtp yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

[enable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

[disable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

ha - Enable/disable HA logging. type: str choices: enable, disable more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7

ha yes yes yes yes yes yes yes

[enable] yes yes yes yes yes yes yes

[disable] yes yes yes yes yes yes yes
ipsec - Enable/disable IPsec negotiation messages logging. type: str choices: enable, disable more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7

ipsec yes yes yes yes yes yes yes

[enable] yes yes yes yes yes yes yes

[disable] yes yes yes yes yes yes yes
ldb_monitor - Enable/disable VIP real server health monitoring logging. type: str choices: enable, disable more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7

ldb_monitor yes yes yes yes yes yes yes

[enable] yes yes yes yes yes yes yes

[disable] yes yes yes yes yes yes yes

local_traffic - Enable/disable local in or out traffic logging. type: str choices: enable, disable more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4 v7.0.0 v7.0.1 v7.0.2 v7.0.3 v7.0.4 v7.0.5 v7.0.6 v7.0.7 v7.0.8 v7.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0

local_traffic yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

[enable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

[disable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

multicast_traffic - Enable/disable multicast traffic logging. type: str choices: enable, disable more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4 v7.0.0 v7.0.1 v7.0.2 v7.0.3 v7.0.4 v7.0.5 v7.0.6 v7.0.7 v7.0.8 v7.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0

multicast_traffic yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

[enable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

[disable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

netscan_discovery - Enable/disable netscan discovery event logging. type: str more...

v6.0.0 v6.0.5 v6.0.11

netscan_discovery yes yes yes
netscan_vulnerability - Enable/disable netscan vulnerability event logging. type: str more...

v6.0.0 v6.0.5 v6.0.11

netscan_vulnerability yes yes yes
notification - Enable/disable notification messages logging. type: str choices: enable, disable more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7

notification yes yes yes yes yes yes yes

[enable] yes yes yes yes yes yes yes

[disable] yes yes yes yes yes yes yes
pattern - Enable/disable pattern update logging. type: str choices: enable, disable more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7

pattern yes yes yes yes yes yes yes

[enable] yes yes yes yes yes yes yes

[disable] yes yes yes yes yes yes yes
ppp - Enable/disable L2TP/PPTP/PPPoE logging. type: str choices: enable, disable more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7

ppp yes yes yes yes yes yes yes

[enable] yes yes yes yes yes yes yes

[disable] yes yes yes yes yes yes yes
radius - Enable/disable RADIUS messages logging. type: str choices: enable, disable more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7

radius yes yes yes yes yes yes yes

[enable] yes yes yes yes yes yes yes

[disable] yes yes yes yes yes yes yes

severity - Log to disk every message above and including this severity level. type: str choices: emergency, alert, critical, error, warning, notification, information, debug more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4 v7.0.0 v7.0.1 v7.0.2 v7.0.3 v7.0.4 v7.0.5 v7.0.6 v7.0.7 v7.0.8 v7.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0

severity yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

[emergency] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

[alert] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

[critical] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

[error] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

[warning] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

[notification] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

[information] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

[debug] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

sniffer_traffic - Enable/disable sniffer traffic logging. type: str choices: enable, disable more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4 v7.0.0 v7.0.1 v7.0.2 v7.0.3 v7.0.4 v7.0.5 v7.0.6 v7.0.7 v7.0.8 v7.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0

sniffer_traffic yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

[enable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

[disable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

ssh - Enable/disable SSH logging. type: str choices: enable, disable more...

v6.0.0 v6.0.5 v6.0.11

ssh yes yes yes

[enable] yes yes yes

[disable] yes yes yes
sslvpn_log_adm - Enable/disable SSL administrator login logging. type: str choices: enable, disable more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7

sslvpn_log_adm yes yes yes yes yes yes yes

[enable] yes yes yes yes yes yes yes

[disable] yes yes yes yes yes yes yes
sslvpn_log_auth - Enable/disable SSL user authentication logging. type: str choices: enable, disable more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7

sslvpn_log_auth yes yes yes yes yes yes yes

[enable] yes yes yes yes yes yes yes

[disable] yes yes yes yes yes yes yes
sslvpn_log_session - Enable/disable SSL session logging. type: str choices: enable, disable more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7

sslvpn_log_session yes yes yes yes yes yes yes

[enable] yes yes yes yes yes yes yes

[disable] yes yes yes yes yes yes yes
system - Enable/disable system activity logging. type: str choices: enable, disable more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7

system yes yes yes yes yes yes yes

[enable] yes yes yes yes yes yes yes

[disable] yes yes yes yes yes yes yes
vip_ssl - Enable/disable VIP SSL logging. type: str choices: enable, disable more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7

vip_ssl yes yes yes yes yes yes yes

[enable] yes yes yes yes yes yes yes

[disable] yes yes yes yes yes yes yes

voip - Enable/disable VoIP logging. type: str choices: enable, disable more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4 v7.0.0 v7.0.1 v7.0.2 v7.0.3 v7.0.4 v7.0.5 v7.0.6 v7.0.7 v7.0.8 v7.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0

voip yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

[enable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

[disable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

wan_opt - Enable/disable WAN optimization event logging. type: str choices: enable, disable more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7

wan_opt yes yes yes yes yes yes yes

[enable] yes yes yes yes yes yes yes

[disable] yes yes yes yes yes yes yes
wireless_activity - Enable/disable wireless activity event logging. type: str choices: enable, disable more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7

wireless_activity yes yes yes yes yes yes yes

[enable] yes yes yes yes yes yes yes

[disable] yes yes yes yes yes yes yes

ztna_traffic - Enable/disable ztna traffic logging. type: str choices: enable, disable more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4 v7.0.0 v7.0.1 v7.0.2 v7.0.3 v7.0.4 v7.0.5 v7.0.6 v7.0.7 v7.0.8 v7.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0

ztna_traffic no no no no no no no no no no no no no no yes yes yes yes yes yes yes yes yes yes yes

[enable] n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a yes yes yes yes yes yes yes yes yes yes yes

[disable] n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a yes yes yes yes yes yes yes yes yes yes yes

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 filters for local disk logging. Use these filters to determine the log messages to record according to severity and type.
    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"
        forward_traffic: "enable"
        free_style:
         -
            category: "traffic"
            filter: "<your_own_value>"
            filter_type: "include"
            id:  "18"
        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: 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.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fortios_log_disk_filter.rst

fortios_log_disk_filter.rst

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

Synopsis

Requirements

Tips

FortiOS Version Compatibility

Parameters

Notes

Examples

Return Values

Status

Authors

Files

fortios_log_disk_filter.rst

Latest commit

History

fortios_log_disk_filter.rst

File metadata and controls

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