ansible.builtin.fortios_log_syslogd_filter (v2.8.20) — module

Install Ansible via pip

Install with pip install ansible==2.8.20

Description

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

Requirements

• fortiosapi>=0.9.8

Usage examples

Scanned by Steampunk Spotter

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

- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
  tasks:
  - name: Filters for remote system server.
    fortios_log_syslogd_filter:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      log_syslogd_filter:
        anomaly: "enable"
        dns: "enable"
        filter: "<your_own_value>"
        filter-type: "include"
        forward-traffic: "enable"
        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"

Inputs

    
host:
    description:
    - FortiOS or FortiGate ip address.
    required: true

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.

https:
    default: true
    description:
    - Indicates if the requests towards FortiGate must use HTTPS protocol
    type: bool

password:
    default: ''
    description:
    - FortiOS or FortiGate password.

username:
    description:
    - FortiOS or FortiGate username.
    required: true

log_syslogd_filter:
    default: null
    description:
    - Filters for remote system server.
    suboptions:
      anomaly:
        choices:
        - enable
        - disable
        description:
        - Enable/disable anomaly logging.
      dns:
        choices:
        - enable
        - disable
        description:
        - Enable/disable detailed DNS event logging.
      filter:
        description:
        - Syslog filter.
      filter-type:
        choices:
        - include
        - exclude
        description:
        - Include/exclude logs that match the filter.
      forward-traffic:
        choices:
        - enable
        - disable
        description:
        - Enable/disable forward traffic logging.
      gtp:
        choices:
        - enable
        - disable
        description:
        - Enable/disable GTP messages logging.
      local-traffic:
        choices:
        - enable
        - disable
        description:
        - Enable/disable local in or out traffic logging.
      multicast-traffic:
        choices:
        - enable
        - disable
        description:
        - Enable/disable multicast traffic logging.
      netscan-discovery:
        description:
        - Enable/disable netscan discovery event logging.
      netscan-vulnerability:
        description:
        - Enable/disable netscan vulnerability event logging.
      severity:
        choices:
        - emergency
        - alert
        - critical
        - error
        - warning
        - notification
        - information
        - debug
        description:
        - Lowest severity level to log.
      sniffer-traffic:
        choices:
        - enable
        - disable
        description:
        - Enable/disable sniffer traffic logging.
      ssh:
        choices:
        - enable
        - disable
        description:
        - Enable/disable SSH logging.
      voip:
        choices:
        - enable
        - disable
        description:
        - Enable/disable VoIP logging.

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