fortios_log_setting.rst

source:	fortios_log_setting.py
orphan:

fortios_log_setting -- Configure general log settings in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

• Synopsis
• Requirements
• Tips
• FortiOS Version Compatibility
• Parameters
• Notes
• Examples
• Return Values
• Status
• Authors

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.14

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility

	Supported Version Ranges
fortios_log_setting	v6.0.0 -> latest

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_setting - Configure general log settings. type: dict more...

  	Supported Version Ranges
  log_setting	v6.0.0 -> latest

• anonymization_hash - User name anonymization hash salt. type: str more...

  	Supported Version Ranges
  anonymization_hash	v7.0.2 -> latest

• brief_traffic_format - Enable/disable brief format traffic logging. type: str choices: enable, disable more...

  	Supported Version Ranges
  brief_traffic_format	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• custom_log_fields - Custom fields to append to all log messages. type: list member_path: custom_log_fields:field_id more...

  	Supported Version Ranges
  custom_log_fields	v6.0.0 -> latest

• field_id - Custom log field. Source log.custom-field.id. type: str required: true more...

  	Supported Version Ranges
  field_id	v6.0.0 -> latest

• daemon_log - Enable/disable daemon logging. type: str choices: enable, disable more...

  	Supported Version Ranges
  daemon_log	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• expolicy_implicit_log - Enable/disable explicit proxy firewall implicit policy logging. type: str choices: enable, disable more...

  	Supported Version Ranges
  expolicy_implicit_log	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• extended_log - Enable/disable extended traffic logging. type: str choices: enable, disable more...

  	Supported Version Ranges
  extended_log	v7.4.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• faz_override - Enable/disable override FortiAnalyzer settings. type: str choices: enable, disable more...

  	Supported Version Ranges
  faz_override	v6.2.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• fortiview_weekly_data - Enable/disable FortiView weekly data. type: str choices: enable, disable more...

  	Supported Version Ranges
  fortiview_weekly_data	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• fwpolicy_implicit_log - Enable/disable implicit firewall policy logging. type: str choices: enable, disable more...

  	Supported Version Ranges
  fwpolicy_implicit_log	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• fwpolicy6_implicit_log - Enable/disable implicit firewall policy6 logging. type: str choices: enable, disable more...

  	Supported Version Ranges
  fwpolicy6_implicit_log	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• local_in_allow - Enable/disable local-in-allow logging. type: str choices: enable, disable more...

  	Supported Version Ranges
  local_in_allow	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• local_in_deny_broadcast - Enable/disable local-in-deny-broadcast logging. type: str choices: enable, disable more...

  	Supported Version Ranges
  local_in_deny_broadcast	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• local_in_deny_unicast - Enable/disable local-in-deny-unicast logging. type: str choices: enable, disable more...

  	Supported Version Ranges
  local_in_deny_unicast	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• local_out - Enable/disable local-out logging. type: str choices: enable, disable more...

  	Supported Version Ranges
  local_out	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• local_out_ioc_detection - Enable/disable local-out traffic IoC detection. Requires local-out to be enabled. type: str choices: enable, disable more...

  	Supported Version Ranges
  local_out_ioc_detection	v7.2.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• log_invalid_packet - Enable/disable invalid packet traffic logging. type: str choices: enable, disable more...

  	Supported Version Ranges
  log_invalid_packet	v6.0.0 -> v7.2.4
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• log_policy_comment - Enable/disable inserting policy comments into traffic logs. type: str choices: enable, disable more...

  	Supported Version Ranges
  log_policy_comment	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• log_policy_name - Enable/disable inserting policy name into traffic logs. type: str choices: enable, disable more...

  	Supported Version Ranges
  log_policy_name	v6.0.0 -> v6.2.7
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• log_user_in_upper - Enable/disable logs with user-in-upper. type: str choices: enable, disable more...

  	Supported Version Ranges
  log_user_in_upper	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• neighbor_event - Enable/disable neighbor event logging. type: str choices: enable, disable more...

  	Supported Version Ranges
  neighbor_event	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• resolve_ip - Enable/disable adding resolved domain names to traffic logs if possible. type: str choices: enable, disable more...

  	Supported Version Ranges
  resolve_ip	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• resolve_port - Enable/disable adding resolved service names to traffic logs. type: str choices: enable, disable more...

  	Supported Version Ranges
  resolve_port	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• rest_api_get - Enable/disable REST API GET request logging. type: str choices: enable, disable more...

  	Supported Version Ranges
  rest_api_get	v7.0.4 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• rest_api_set - Enable/disable REST API POST/PUT/DELETE request logging. type: str choices: enable, disable more...

  	Supported Version Ranges
  rest_api_set	v7.0.4 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• syslog_override - Enable/disable override Syslog settings. type: str choices: enable, disable more...

  	Supported Version Ranges
  syslog_override	v6.2.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• user_anonymize - Enable/disable anonymizing user names in log messages. type: str choices: enable, disable more...

  	Supported Version Ranges
  user_anonymize	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

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"
          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"
          local_out_ioc_detection: "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"
          rest_api_get: "enable"
          rest_api_set: "enable"
          syslog_override: "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

Status

• This module is not guaranteed to have a backwards compatible interface.

Authors

• Link Zheng (@chillancezen)
• Jie Xue (@JieX19)
• Hongbin Lu (@fgtdev-hblu)
• Frank Shen (@frankshen01)
• Miguel Angel Munoz (@mamunozgonzalez)
• Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.