Note
This plugin is part of the fortinet.fortios collection (version 2.1.2).
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
.
To use it in a playbook, specify: fortinet.fortios.fortios_log_disk_filter
.
New in version 2.10: of fortinet.fortios
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | ||
---|---|---|---|---|
access_token string | Token-based authentication. Generated from GUI of Fortigate. | |||
enable_log boolean |
| Enable/Disable logging for task. | ||
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. | ||
anomaly string |
| Enable/disable anomaly logging. | ||
auth string |
| Enable/disable firewall authentication logging. | ||
cpu_memory_usage string |
| Enable/disable CPU & memory usage logging every 5 minutes. | ||
dhcp string |
| Enable/disable DHCP service messages logging. | ||
dlp_archive string |
| Enable/disable DLP archive logging. | ||
dns string |
| Enable/disable detailed DNS event logging. | ||
event string |
| Enable/disable event logging. | ||
filter string | Disk log filter. | |||
filter_type string |
| Include/exclude logs that match the filter. | ||
forward_traffic string |
| Enable/disable forward traffic logging. | ||
free_style list / elements=string | Free Style Filters | |||
category string |
| Log category. | ||
filter string | Free style filter string. | |||
filter_type string |
| Include/exclude logs that match the filter. | ||
id integer / required | Entry ID. | |||
gtp string |
| Enable/disable GTP messages logging. | ||
ha string |
| Enable/disable HA logging. | ||
ipsec string |
| Enable/disable IPsec negotiation messages logging. | ||
ldb_monitor string |
| Enable/disable VIP real server health monitoring logging. | ||
local_traffic string |
| Enable/disable local in or out traffic logging. | ||
multicast_traffic string |
| Enable/disable multicast traffic logging. | ||
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. | ||
pattern string |
| Enable/disable pattern update logging. | ||
ppp string |
| Enable/disable L2TP/PPTP/PPPoE logging. | ||
radius string |
| Enable/disable RADIUS messages logging. | ||
severity string |
| Log to disk every message above and including this severity level. | ||
sniffer_traffic string |
| Enable/disable sniffer traffic logging. | ||
ssh string |
| Enable/disable SSH logging. | ||
sslvpn_log_adm string |
| Enable/disable SSL administrator login logging. | ||
sslvpn_log_auth string |
| Enable/disable SSL user authentication logging. | ||
sslvpn_log_session string |
| Enable/disable SSL session logging. | ||
system string |
| Enable/disable system activity logging. | ||
vip_ssl string |
| Enable/disable VIP SSL logging. | ||
voip string |
| Enable/disable VoIP logging. | ||
wan_opt string |
| Enable/disable WAN optimization event logging. | ||
wireless_activity string |
| Enable/disable wireless activity 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. |
Note
- 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"
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 |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_log_disk_filter_module.html