fortios_log_setting – Configure general log settings in Fortinet’s FortiOS and FortiGate.¶
New in version 2.8.
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.9.0
Parameters¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: 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
- log_setting - Configure general log settings. type: dict
- brief_traffic_format - Enable/disable brief format traffic logging. type: str choices: enable, disable
- custom_log_fields - Custom fields to append to all log messages. type: list
- field_id - Custom log field. Source log.custom-field.id. type: str
- daemon_log - Enable/disable daemon logging. type: str choices: enable, disable
- expolicy_implicit_log - Enable/disable explicit proxy firewall implicit policy logging. type: str choices: enable, disable
- fwpolicy_implicit_log - Enable/disable implicit firewall policy logging. type: str choices: enable, disable
- fwpolicy6_implicit_log - Enable/disable implicit firewall policy6 logging. type: str choices: enable, disable
- local_in_allow - Enable/disable local-in-allow logging. type: str choices: enable, disable
- local_in_deny_broadcast - Enable/disable local-in-deny-broadcast logging. type: str choices: enable, disable
- local_in_deny_unicast - Enable/disable local-in-deny-unicast logging. type: str choices: enable, disable
- local_out - Enable/disable local-out logging. type: str choices: enable, disable
- log_invalid_packet - Enable/disable invalid packet traffic logging. type: str choices: enable, disable
- log_policy_comment - Enable/disable inserting policy comments into traffic logs. type: str choices: enable, disable
- log_policy_name - Enable/disable inserting policy name into traffic logs. type: str choices: enable, disable
- log_user_in_upper - Enable/disable logs with user-in-upper. type: str choices: enable, disable
- neighbor_event - Enable/disable neighbor event logging. type: str choices: enable, disable
- resolve_ip - Enable/disable adding resolved domain names to traffic logs if possible. type: str choices: enable, disable
- resolve_port - Enable/disable adding resolved service names to traffic logs. type: str choices: enable, disable
- user_anonymize - Enable/disable anonymizing user names in log messages. type: str choices: enable, disable
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: 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"
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"
user_anonymize: "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