fortinet.fortios.fortios_log_fortianalyzer_filter (1.1.7) — module

Install collection

Install with ansible-galaxy collection install fortinet.fortios:==1.1.7

Add to requirements.yml

  collections:
    - name: fortinet.fortios
      version: 1.1.7

Description

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log_fortianalyzer feature and filter category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.4.0

Requirements

• ansible>=2.9.0

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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: Filters for FortiAnalyzer.
    fortios_log_fortianalyzer_filter:
      vdom:  "{{ vdom }}"
      log_fortianalyzer_filter:
        anomaly: "enable"
        dlp_archive: "enable"
        filter: "<your_own_value>"
        filter_type: "include"
        forward_traffic: "enable"
        gtp: "enable"
        local_traffic: "enable"
        multicast_traffic: "enable"
        severity: "emergency"
        sniffer_traffic: "enable"
        voip: "enable"

Inputs

    
vdom:
    default: root
    description:
    - 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

access_token:
    description:
    - Token-based authentication. Generated from GUI of Fortigate.
    required: false
    type: str

log_fortianalyzer_filter:
    default: null
    description:
    - Filters for FortiAnalyzer.
    suboptions:
      anomaly:
        choices:
        - enable
        - disable
        description:
        - Enable/disable anomaly logging.
        type: str
      dlp_archive:
        choices:
        - enable
        - disable
        description:
        - Enable/disable DLP archive logging.
        type: str
      filter:
        description:
        - FortiAnalyzer log filter.
        type: str
      filter_type:
        choices:
        - include
        - exclude
        description:
        - Include/exclude logs that match the filter.
        type: str
      forward_traffic:
        choices:
        - enable
        - disable
        description:
        - Enable/disable forward traffic logging.
        type: str
      gtp:
        choices:
        - enable
        - disable
        description:
        - Enable/disable GTP messages logging.
        type: str
      local_traffic:
        choices:
        - enable
        - disable
        description:
        - Enable/disable local in or out traffic logging.
        type: str
      multicast_traffic:
        choices:
        - enable
        - disable
        description:
        - Enable/disable multicast traffic logging.
        type: str
      severity:
        choices:
        - emergency
        - alert
        - critical
        - error
        - warning
        - notification
        - information
        - debug
        description:
        - Lowest severity level to log.
        type: str
      sniffer_traffic:
        choices:
        - enable
        - disable
        description:
        - Enable/disable sniffer traffic logging.
        type: str
      voip:
        choices:
        - enable
        - disable
        description:
        - Enable/disable VoIP logging.
        type: str
    type: dict

Outputs

build:
  description: Build number of the fortigate image
  returned: always
  sample: '1547'
  type: str
http_method:
  description: Last method used to provision the content into FortiGate
  returned: always
  sample: PUT
  type: str
http_status:
  description: Last result given by FortiGate on last operation applied
  returned: always
  sample: '200'
  type: str
mkey:
  description: Master key (id) used in the last call to FortiGate
  returned: success
  sample: id
  type: str
name:
  description: Name of the table used to fulfill the request
  returned: always
  sample: urlfilter
  type: str
path:
  description: Path of the table used to fulfill the request
  returned: always
  sample: webfilter
  type: str
revision:
  description: Internal revision number
  returned: always
  sample: 17.0.2.10658
  type: str
serial:
  description: Serial number of the unit
  returned: always
  sample: FGVMEVYYQT3AB5352
  type: str
status:
  description: Indication of the operation's result
  returned: always
  sample: success
  type: str
vdom:
  description: Virtual domain used
  returned: always
  sample: root
  type: str
version:
  description: Version of the FortiGate
  returned: always
  sample: v5.6.3
  type: str