fortios_log_memory_filter – Filters for memory buffer 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_memory 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
Tips
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
Supported Version Ranges: v6.0.0 -> 7.4.3
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_memory_filter - Filters for memory buffer. type: dict more...
- admin - Enable/disable admin login/logout logging. type: str choices: enable, disable more...
- anomaly - Enable/disable anomaly logging. type: str choices: enable, disable more...
- auth - Enable/disable firewall authentication logging. type: str choices: enable, disable more...
- cpu_memory_usage - Enable/disable CPU & memory usage logging every 5 minutes. type: str choices: enable, disable more...
- dhcp - Enable/disable DHCP service messages logging. type: str choices: enable, disable more...
- dns - Enable/disable detailed DNS event logging. type: str choices: enable, disable more...
- event - Enable/disable event logging. type: str choices: enable, disable more...
- filter - Memory log filter. type: str more...
- filter_type - Include/exclude logs that match the filter. type: str choices: include, exclude more...
- forti_switch - Enable/disable Forti-Switch logging. type: str choices: enable, disable more...
- forward_traffic - Enable/disable forward traffic logging. type: str choices: enable, disable more...
- free_style - Free style filters. type: list member_path: free_style:id 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, virtual-patch, 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. see Notes. type: int required: true more...
- gtp - Enable/disable GTP messages logging. type: str choices: enable, disable more...
- ha - Enable/disable HA logging. type: str choices: enable, disable more...
- ipsec - Enable/disable IPsec negotiation messages logging. type: str choices: enable, disable more...
- ldb_monitor - Enable/disable VIP real server health monitoring 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...
- notification - Enable/disable notification messages logging. type: str choices: enable, disable more...
- pattern - Enable/disable pattern update logging. type: str choices: enable, disable more...
- ppp - Enable/disable L2TP/PPTP/PPPoE logging. type: str choices: enable, disable more...
- radius - Enable/disable RADIUS messages logging. type: str choices: enable, disable more...
- severity - Log every message above and including this severity level. 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...
- sslvpn_log_adm - Enable/disable SSL administrator login logging. type: str choices: enable, disable more...
- sslvpn_log_auth - Enable/disable SSL user authentication logging. type: str choices: enable, disable more...
- sslvpn_log_session - Enable/disable SSL session logging. type: str choices: enable, disable more...
- system - Enable/disable system activity logging. type: str choices: enable, disable more...
- vip_ssl - Enable/disable VIP SSL logging. type: str choices: enable, disable more...
- voip - Enable/disable VoIP logging. type: str choices: enable, disable more...
- wan_opt - Enable/disable WAN optimization event logging. type: str choices: enable, disable more...
- wireless_activity - Enable/disable wireless activity event logging. type: str choices: enable, disable more...
- ztna_traffic - Enable/disable ztna traffic logging. type: str choices: enable, disable more...
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- name: Filters for memory buffer.
fortinet.fortios.fortios_log_memory_filter:
vdom: "{{ vdom }}"
log_memory_filter:
admin: "enable"
anomaly: "enable"
auth: "enable"
cpu_memory_usage: "enable"
dhcp: "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: "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.