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_setting.
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_setting dictionary | Configure general log settings. | |||
| brief_traffic_format string |
| Enable/disable brief format traffic logging. | ||
| custom_log_fields list / elements=string | Custom fields to append to all log messages. | |||
| field_id string | Custom log field. Source log.custom-field.id. | |||
| daemon_log string |
| Enable/disable daemon logging. | ||
| expolicy_implicit_log string |
| Enable/disable explicit proxy firewall implicit policy logging. | ||
| faz_override string |
| Enable/disable override FortiAnalyzer settings. | ||
| fortiview_weekly_data string |
| Enable/disable FortiView weekly data. | ||
| fwpolicy6_implicit_log string |
| Enable/disable implicit firewall policy6 logging. | ||
| fwpolicy_implicit_log string |
| Enable/disable implicit firewall policy logging. | ||
| local_in_allow string |
| Enable/disable local-in-allow logging. | ||
| local_in_deny_broadcast string |
| Enable/disable local-in-deny-broadcast logging. | ||
| local_in_deny_unicast string |
| Enable/disable local-in-deny-unicast logging. | ||
| local_out string |
| Enable/disable local-out logging. | ||
| log_invalid_packet string |
| Enable/disable invalid packet traffic logging. | ||
| log_policy_comment string |
| Enable/disable inserting policy comments into traffic logs. | ||
| log_policy_name string |
| Enable/disable inserting policy name into traffic logs. | ||
| log_user_in_upper string |
| Enable/disable logs with user-in-upper. | ||
| neighbor_event string |
| Enable/disable neighbor event logging. | ||
| resolve_ip string |
| Enable/disable adding resolved domain names to traffic logs if possible. | ||
| resolve_port string |
| Enable/disable adding resolved service names to traffic logs. | ||
| syslog_override string |
| Enable/disable override Syslog settings. | ||
| user_anonymize string |
| Enable/disable anonymizing user names in log messages. | ||
| 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 general log settings.
fortios_log_setting:
vdom: "{{ vdom }}"
log_setting:
brief_traffic_format: "enable"
custom_log_fields:
-
field_id: "<your_own_value> (source log.custom-field.id)"
daemon_log: "enable"
expolicy_implicit_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_out: "enable"
log_invalid_packet: "enable"
log_policy_comment: "enable"
log_policy_name: "enable"
log_user_in_upper: "enable"
neighbor_event: "enable"
resolve_ip: "enable"
resolve_port: "enable"
syslog_override: "enable"
user_anonymize: "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_setting_module.html