Skip to content

Latest commit

 

History

History
651 lines (610 loc) · 26.7 KB

fortios_log_fortianalyzer3_filter.rst

File metadata and controls

651 lines (610 loc) · 26.7 KB
Raw
source:fortios_log_fortianalyzer3_filter.py
orphan:

fortios_log_fortianalyzer3_filter -- Filters for FortiAnalyzer 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_fortianalyzer3 feature and filter 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_fortianalyzer3_filter - Filters for FortiAnalyzer. type: dict more...
    Supported Version Ranges
    log_fortianalyzer3_filter v6.0.0 -> 7.4.3
    • anomaly - Enable/disable anomaly logging. type: str choices: enable, disable more...
      Supported Version Ranges
      anomaly v6.0.0 -> 7.4.3
      [enable] v6.0.0 -> 7.4.3
      [disable] v6.0.0 -> 7.4.3
    • dlp_archive - Enable/disable DLP archive logging. type: str choices: enable, disable more...
      Supported Version Ranges
      dlp_archive v6.0.0 -> 7.4.3
      [enable] v6.0.0 -> 7.4.3
      [disable] v6.0.0 -> 7.4.3
    • dns - Enable/disable detailed DNS event logging. type: str choices: enable, disable more...
      Supported Version Ranges
      dns v6.0.0 -> v6.0.11
      [enable] v6.0.0 -> v6.0.11
      [disable] v6.0.0 -> v6.0.11
    • filter - FortiAnalyzer 3 log filter. type: str more...
      Supported Version Ranges
      filter v6.0.0 -> v6.4.4
    • filter_type - Include/exclude logs that match the filter. type: str choices: include, exclude more...
      Supported Version Ranges
      filter_type v6.0.0 -> v6.4.4
      [include] v6.0.0 -> v6.4.4
      [exclude] v6.0.0 -> v6.4.4
    • forti_switch - Enable/disable Forti-Switch logging. type: str choices: enable, disable more...
      Supported Version Ranges
      forti_switch v7.4.2 -> 7.4.3
      [enable] v7.4.2 -> 7.4.3
      [disable] v7.4.2 -> 7.4.3
    • forward_traffic - Enable/disable forward traffic logging. type: str choices: enable, disable more...
      Supported Version Ranges
      forward_traffic v6.0.0 -> 7.4.3
      [enable] v6.0.0 -> 7.4.3
      [disable] v6.0.0 -> 7.4.3
    • free_style - Free style filters. type: list member_path: free_style:id more...
      Supported Version Ranges
      free_style v7.0.0 -> 7.4.3
      • category - Log category. type: str choices: traffic, event, virus, webfilter, attack, spam, anomaly, voip, dlp, app-ctrl, waf, gtp, dns, ssh, ssl, file-filter, icap, virtual-patch, ztna more...
        Supported Version Ranges
        category v7.0.0 -> 7.4.3
        [traffic] v7.0.0 -> 7.4.3
        [event] v7.0.0 -> 7.4.3
        [virus] v7.0.0 -> 7.4.3
        [webfilter] v7.0.0 -> 7.4.3
        [attack] v7.0.0 -> 7.4.3
        [spam] v7.0.0 -> 7.4.3
        [anomaly] v7.0.0 -> 7.4.3
        [voip] v7.0.0 -> 7.4.3
        [dlp] v7.0.0 -> 7.4.3
        [app-ctrl] v7.0.0 -> 7.4.3
        [waf] v7.0.0 -> 7.4.3
        [gtp] v7.0.0 -> 7.4.3
        [dns] v7.0.0 -> 7.4.3
        [ssh] v7.0.0 -> 7.4.3
        [ssl] v7.0.0 -> 7.4.3
        [file-filter] v7.0.0 -> 7.4.3
        [icap] v7.0.0 -> 7.4.3
        [virtual-patch] v7.4.1 -> 7.4.3
        [ztna] v7.0.1 -> v7.0.3
      • filter - Free style filter string. type: str more...
        Supported Version Ranges
        filter v7.0.0 -> 7.4.3
      • filter_type - Include/exclude logs that match the filter. type: str choices: include, exclude more...
        Supported Version Ranges
        filter_type v7.0.0 -> 7.4.3
        [include] v7.0.0 -> 7.4.3
        [exclude] v7.0.0 -> 7.4.3
      • id - Entry ID. see Notes. type: int required: true more...
        Supported Version Ranges
        id v7.0.0 -> 7.4.3
    • gtp - Enable/disable GTP messages logging. type: str choices: enable, disable more...
      Supported Version Ranges
      gtp v6.0.0 -> 7.4.3
      [enable] v6.0.0 -> 7.4.3
      [disable] v6.0.0 -> 7.4.3
    • local_traffic - Enable/disable local in or out traffic logging. type: str choices: enable, disable more...
      Supported Version Ranges
      local_traffic v6.0.0 -> 7.4.3
      [enable] v6.0.0 -> 7.4.3
      [disable] v6.0.0 -> 7.4.3
    • multicast_traffic - Enable/disable multicast traffic logging. type: str choices: enable, disable more...
      Supported Version Ranges
      multicast_traffic v6.0.0 -> 7.4.3
      [enable] v6.0.0 -> 7.4.3
      [disable] v6.0.0 -> 7.4.3
    • netscan_discovery - Enable/disable netscan discovery event logging. type: str more...
      Supported Version Ranges
      netscan_discovery v6.0.0 -> v6.0.11
    • netscan_vulnerability - Enable/disable netscan vulnerability event logging. type: str more...
      Supported Version Ranges
      netscan_vulnerability v6.0.0 -> v6.0.11
    • severity - Lowest severity level to log. type: str choices: emergency, alert, critical, error, warning, notification, information, debug more...
      Supported Version Ranges
      severity v6.0.0 -> 7.4.3
      [emergency] v6.0.0 -> 7.4.3
      [alert] v6.0.0 -> 7.4.3
      [critical] v6.0.0 -> 7.4.3
      [error] v6.0.0 -> 7.4.3
      [warning] v6.0.0 -> 7.4.3
      [notification] v6.0.0 -> 7.4.3
      [information] v6.0.0 -> 7.4.3
      [debug] v6.0.0 -> 7.4.3
    • sniffer_traffic - Enable/disable sniffer traffic logging. type: str choices: enable, disable more...
      Supported Version Ranges
      sniffer_traffic v6.0.0 -> 7.4.3
      [enable] v6.0.0 -> 7.4.3
      [disable] v6.0.0 -> 7.4.3
    • ssh - Enable/disable SSH logging. type: str choices: enable, disable more...
      Supported Version Ranges
      ssh v6.0.0 -> v6.0.11
      [enable] v6.0.0 -> v6.0.11
      [disable] v6.0.0 -> v6.0.11
    • voip - Enable/disable VoIP logging. type: str choices: enable, disable more...
      Supported Version Ranges
      voip v6.0.0 -> 7.4.3
      [enable] v6.0.0 -> 7.4.3
      [disable] v6.0.0 -> 7.4.3
    • ztna_traffic - Enable/disable ztna traffic logging. type: str choices: enable, disable more...
      Supported Version Ranges
      ztna_traffic v7.0.4 -> 7.4.3
      [enable] v7.0.4 -> 7.4.3
      [disable] v7.0.4 -> 7.4.3

Notes

Note

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

Examples

- name: Filters for FortiAnalyzer.
  fortinet.fortios.fortios_log_fortianalyzer3_filter:
      vdom: "{{ vdom }}"
      log_fortianalyzer3_filter:
          anomaly: "enable"
          dlp_archive: "enable"
          dns: "enable"
          filter: "<your_own_value>"
          filter_type: "include"
          forti_switch: "enable"
          forward_traffic: "enable"
          free_style:
              -
                  category: "traffic"
                  filter: "<your_own_value>"
                  filter_type: "include"
                  id: "14"
          gtp: "enable"
          local_traffic: "enable"
          multicast_traffic: "enable"
          netscan_discovery: "<your_own_value>"
          netscan_vulnerability: "<your_own_value>"
          severity: "emergency"
          sniffer_traffic: "enable"
          ssh: "enable"
          voip: "enable"
          ztna_traffic: "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.