Skip to content

Latest commit

 

History

History
526 lines (485 loc) · 21.8 KB

fortios_log_eventfilter.rst

File metadata and controls

526 lines (485 loc) · 21.8 KB
Raw
source:fortios_log_eventfilter.py
orphan:

fortios_log_eventfilter -- Configure log event filters in Fortinet's FortiOS and FortiGate.

.. versionadded:: 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 eventfilter 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_eventfilter - Configure log event filters. type: dict more...
    Supported Version Ranges
    log_eventfilter v6.0.0 -> 7.4.3
    • cifs - Enable/disable CIFS logging. type: str choices: enable, disable more...
      Supported Version Ranges
      cifs v7.0.0 -> 7.4.3
      [enable] v7.0.0 -> 7.4.3
      [disable] v7.0.0 -> 7.4.3
    • compliance_check - Enable/disable PCI DSS compliance check logging. type: str choices: enable, disable more...
      Supported Version Ranges
      compliance_check v6.0.0 -> v6.0.11
      [enable] v6.0.0 -> v6.0.11
      [disable] v6.0.0 -> v6.0.11
    • connector - Enable/disable SDN connector logging. type: str choices: enable, disable more...
      Supported Version Ranges
      connector v6.2.0 -> 7.4.3
      [enable] v6.2.0 -> 7.4.3
      [disable] v6.2.0 -> 7.4.3
    • endpoint - Enable/disable endpoint event logging. type: str choices: enable, disable more...
      Supported Version Ranges
      endpoint v6.0.0 -> 7.4.3
      [enable] v6.0.0 -> 7.4.3
      [disable] v6.0.0 -> 7.4.3
    • event - Enable/disable event logging. type: str choices: enable, disable more...
      Supported Version Ranges
      event v6.0.0 -> 7.4.3
      [enable] v6.0.0 -> 7.4.3
      [disable] v6.0.0 -> 7.4.3
    • fortiextender - Enable/disable FortiExtender logging. type: str choices: enable, disable more...
      Supported Version Ranges
      fortiextender v6.2.0 -> 7.4.3
      [enable] v6.2.0 -> 7.4.3
      [disable] v6.2.0 -> 7.4.3
    • ha - Enable/disable ha event logging. type: str choices: enable, disable more...
      Supported Version Ranges
      ha v6.0.0 -> 7.4.3
      [enable] v6.0.0 -> 7.4.3
      [disable] v6.0.0 -> 7.4.3
    • rest_api - Enable/disable REST API logging. type: str choices: enable, disable more...
      Supported Version Ranges
      rest_api v7.0.4 -> 7.4.3
      [enable] v7.0.4 -> 7.4.3
      [disable] v7.0.4 -> 7.4.3
    • router - Enable/disable router event logging. type: str choices: enable, disable more...
      Supported Version Ranges
      router v6.0.0 -> 7.4.3
      [enable] v6.0.0 -> 7.4.3
      [disable] v6.0.0 -> 7.4.3
    • sdwan - Enable/disable SD-WAN logging. type: str choices: enable, disable more...
      Supported Version Ranges
      sdwan v6.4.0 -> 7.4.3
      [enable] v6.4.0 -> 7.4.3
      [disable] v6.4.0 -> 7.4.3
    • security_rating - Enable/disable Security Rating result logging. type: str choices: enable, disable more...
      Supported Version Ranges
      security_rating v6.0.0 -> 7.4.3
      [enable] v6.0.0 -> 7.4.3
      [disable] v6.0.0 -> 7.4.3
    • switch_controller - Enable/disable Switch-Controller logging. type: str choices: enable, disable more...
      Supported Version Ranges
      switch_controller v6.4.4 -> 7.4.3
      [enable] v6.4.4 -> 7.4.3
      [disable] v6.4.4 -> 7.4.3
    • system - Enable/disable system event logging. type: str choices: enable, disable more...
      Supported Version Ranges
      system v6.0.0 -> 7.4.3
      [enable] v6.0.0 -> 7.4.3
      [disable] v6.0.0 -> 7.4.3
    • user - Enable/disable user authentication event logging. type: str choices: enable, disable more...
      Supported Version Ranges
      user v6.0.0 -> 7.4.3
      [enable] v6.0.0 -> 7.4.3
      [disable] v6.0.0 -> 7.4.3
    • vpn - Enable/disable VPN event logging. type: str choices: enable, disable more...
      Supported Version Ranges
      vpn v6.0.0 -> 7.4.3
      [enable] v6.0.0 -> 7.4.3
      [disable] v6.0.0 -> 7.4.3
    • wan_opt - Enable/disable WAN optimization event logging. type: str choices: enable, disable more...
      Supported Version Ranges
      wan_opt v6.0.0 -> 7.4.3
      [enable] v6.0.0 -> 7.4.3
      [disable] v6.0.0 -> 7.4.3
    • webproxy - Enable/disable web proxy event logging. type: str choices: enable, disable more...
      Supported Version Ranges
      webproxy v7.2.4 -> 7.4.3
      [enable] v7.2.4 -> 7.4.3
      [disable] v7.2.4 -> 7.4.3
    • wireless_activity - Enable/disable wireless event logging. type: str choices: enable, disable more...
      Supported Version Ranges
      wireless_activity v6.0.0 -> 7.4.3
      [enable] v6.0.0 -> 7.4.3
      [disable] v6.0.0 -> 7.4.3

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- name: Configure log event filters.
  fortinet.fortios.fortios_log_eventfilter:
      vdom: "{{ vdom }}"
      log_eventfilter:
          cifs: "enable"
          compliance_check: "enable"
          connector: "enable"
          endpoint: "enable"
          event: "enable"
          fortiextender: "enable"
          ha: "enable"
          rest_api: "enable"
          router: "enable"
          sdwan: "enable"
          security_rating: "enable"
          switch_controller: "enable"
          system: "enable"
          user: "enable"
          vpn: "enable"
          wan_opt: "enable"
          webproxy: "enable"
          wireless_activity: "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.