fortinet.fortios.fortios_log_setting module – Configure general log settings in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.8).
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_setting
.
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 feature and setting 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 |
---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Configure general log settings. |
|
User name anonymization hash salt. |
|
Enable/disable brief format traffic logging. Choices:
|
|
Custom fields to append to all log messages. |
|
Custom log field. Source log.custom-field.id. |
|
Enable/disable daemon logging. Choices:
|
|
Enable/disable explicit proxy firewall implicit policy logging. Choices:
|
|
Enable/disable extended traffic logging. Choices:
|
|
Enable/disable extended UTM logging. Choices:
|
|
Enable/disable override FortiAnalyzer settings. Choices:
|
|
Enable/disable FortiView weekly data. Choices:
|
|
Enable/disable implicit firewall policy6 logging. Choices:
|
|
Enable/disable implicit firewall policy logging. Choices:
|
|
Enable/disable local-in-allow logging. Choices:
|
|
Enable/disable local-in-deny-broadcast logging. Choices:
|
|
Enable/disable local-in-deny-unicast logging. Choices:
|
|
Enable/disable local-in-policy logging. Choices:
|
|
Enable/disable local-out logging. Choices:
|
|
Enable/disable local-out traffic IoC detection. Requires local-out to be enabled. Choices:
|
|
Enable/disable invalid packet traffic logging. Choices:
|
|
Enable/disable inserting policy comments into traffic logs. Choices:
|
|
Enable/disable inserting policy name into traffic logs. Choices:
|
|
Enable/disable logs with user-in-upper. Choices:
|
|
Enable/disable long-live-session statistics logging. Choices:
|
|
Enable/disable neighbor event logging. Choices:
|
|
Enable/disable adding resolved domain names to traffic logs if possible. Choices:
|
|
Enable/disable adding resolved service names to traffic logs. Choices:
|
|
Enable/disable REST API GET request logging. Choices:
|
|
Enable/disable REST API POST/PUT/DELETE request logging. Choices:
|
|
Enable/disable override Syslog settings. Choices:
|
|
Enable/disable anonymizing user names in log messages. Choices:
|
|
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. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
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: |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- name: Configure general log settings.
fortinet.fortios.fortios_log_setting:
vdom: "{{ vdom }}"
log_setting:
anonymization_hash: "<your_own_value>"
brief_traffic_format: "enable"
custom_log_fields:
-
field_id: "<your_own_value> (source log.custom-field.id)"
daemon_log: "enable"
expolicy_implicit_log: "enable"
extended_log: "enable"
extended_utm_log: "enable"
faz_override: "enable"
fortiview_weekly_data: "enable"
fwpolicy_implicit_log: "enable"
fwpolicy6_implicit_log: "enable"
local_in_allow: "enable"
local_in_deny_broadcast: "enable"
local_in_deny_unicast: "enable"
local_in_policy_log: "enable"
local_out: "enable"
local_out_ioc_detection: "enable"
log_invalid_packet: "enable"
log_policy_comment: "enable"
log_policy_name: "enable"
log_user_in_upper: "enable"
long_live_session_stat: "enable"
neighbor_event: "enable"
resolve_ip: "enable"
resolve_port: "enable"
rest_api_get: "enable"
rest_api_set: "enable"
syslog_override: "enable"
user_anonymize: "enable"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |