fortios_log_fortianalyzer3_filter – Filters for FortiAnalyzer in Fortinet’s FortiOS and FortiGate.¶
New in version 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_fortianalyzer3 feature and filter category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
FortiOS Version Compatibility¶
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.2.0 |
v7.2.1 |
v7.2.2 |
|
fortios_log_fortianalyzer3_filter | 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_fortianalyzer3_filter - Filters for FortiAnalyzer. type: dict more...
- anomaly - Enable/disable anomaly logging. type: str choices: enable, disable more...
- dlp_archive - Enable/disable DLP archive logging. type: str choices: enable, disable more...
- dns - Enable/disable detailed DNS event logging. type: str choices: enable, disable more...
- filter - FortiAnalyzer 3 log filter. type: str more...
- filter_type - Include/exclude logs that match the filter. type: str choices: include, exclude more...
- forward_traffic - Enable/disable forward traffic logging. type: str choices: enable, disable more...
- free_style - Free style filters. type: list more...
- 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...
- filter - Free style filter string. type: str more...
- filter_type - Include/exclude logs that match the filter. type: str choices: include, exclude more...
- id - Entry ID. type: int more...
- gtp - Enable/disable GTP messages logging. type: str choices: enable, disable more...
- local_traffic - Enable/disable local in or out traffic logging. type: str choices: enable, disable more...
- multicast_traffic - Enable/disable multicast traffic logging. type: str choices: enable, disable more...
- netscan_discovery - Enable/disable netscan discovery event logging. type: str more...
- netscan_vulnerability - Enable/disable netscan vulnerability event logging. type: str more...
- severity - Lowest severity level to log. type: str choices: emergency, alert, critical, error, warning, notification, information, debug more...
- sniffer_traffic - Enable/disable sniffer traffic logging. type: str choices: enable, disable more...
- ssh - Enable/disable SSH logging. type: str choices: enable, disable more...
- voip - Enable/disable VoIP logging. type: str choices: enable, disable more...
- ztna_traffic - Enable/disable ztna traffic logging. type: str choices: enable, disable more...
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: Filters for FortiAnalyzer.
fortios_log_fortianalyzer3_filter:
vdom: "{{ vdom }}"
log_fortianalyzer3_filter:
anomaly: "enable"
dlp_archive: "enable"
dns: "enable"
filter: "<your_own_value>"
filter_type: "include"
forward_traffic: "enable"
free_style:
-
category: "traffic"
filter: "<your_own_value>"
filter_type: "include"
id: "13"
gtp: "enable"
local_traffic: "enable"
multicast_traffic: "enable"
netscan_discovery: "<your_own_value>"
netscan_vulnerability: "<your_own_value>"
severity: "emergency"
sniffer_traffic: "enable"
ssh: "enable"
voip: "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