lix_fortinet.fortios.fortios_log_eventfilter (102.2.120) — module

Install collection

Install with ansible-galaxy collection install lix_fortinet.fortios:==102.2.120

Add to requirements.yml

  collections:
    - name: lix_fortinet.fortios
      version: 102.2.120

Description

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

• ansible>=2.9

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: Configure log event filters.
    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"
        wireless_activity: "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

enable_log:
    default: false
    description:
    - Enable/Disable logging for task.
    required: false
    type: bool

member_path:
    description:
    - Member attribute path to operate on.
    - Delimited by a slash character if there are more than one attribute.
    - Parameter marked with member_path is legitimate for doing member operation.
    type: str

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

member_state:
    choices:
    - present
    - absent
    description:
    - Add or delete a member under specified attribute path.
    - When member_state is specified, the state option is ignored.
    type: str

log_eventfilter:
    default: null
    description:
    - Configure log event filters.
    suboptions:
      cifs:
        choices:
        - enable
        - disable
        description:
        - Enable/disable CIFS logging.
        type: str
      compliance_check:
        choices:
        - enable
        - disable
        description:
        - Enable/disable PCI DSS compliance check logging.
        type: str
      connector:
        choices:
        - enable
        - disable
        description:
        - Enable/disable SDN connector logging.
        type: str
      endpoint:
        choices:
        - enable
        - disable
        description:
        - Enable/disable endpoint event logging.
        type: str
      event:
        choices:
        - enable
        - disable
        description:
        - Enable/disable event logging.
        type: str
      fortiextender:
        choices:
        - enable
        - disable
        description:
        - Enable/disable FortiExtender logging.
        type: str
      ha:
        choices:
        - enable
        - disable
        description:
        - Enable/disable ha event logging.
        type: str
      rest_api:
        choices:
        - enable
        - disable
        description:
        - Enable/disable REST API logging.
        type: str
      router:
        choices:
        - enable
        - disable
        description:
        - Enable/disable router event logging.
        type: str
      sdwan:
        choices:
        - enable
        - disable
        description:
        - Enable/disable SD-WAN logging.
        type: str
      security_rating:
        choices:
        - enable
        - disable
        description:
        - Enable/disable Security Rating result logging.
        type: str
      switch_controller:
        choices:
        - enable
        - disable
        description:
        - Enable/disable Switch-Controller logging.
        type: str
      system:
        choices:
        - enable
        - disable
        description:
        - Enable/disable system event logging.
        type: str
      user:
        choices:
        - enable
        - disable
        description:
        - Enable/disable user authentication event logging.
        type: str
      vpn:
        choices:
        - enable
        - disable
        description:
        - Enable/disable VPN event logging.
        type: str
      wan_opt:
        choices:
        - enable
        - disable
        description:
        - Enable/disable WAN optimization event logging.
        type: str
      wireless_activity:
        choices:
        - enable
        - disable
        description:
        - Enable/disable wireless event 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