fortios_log_null_device_filter – Filters for null device logging in Fortinet’s FortiOS and FortiGate

New in version 2.8.

Synopsis
Requirements
Parameters
Notes
Examples
Return Values
Status

Synopsis

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

Requirements

The below requirements are needed on the host that executes this module.

fortiosapi>=0.9.8

Parameters

Parameter		Choices/Defaults	Comments
host string			FortiOS or FortiGate IP address.
https boolean		no yes ←	Indicates if the requests towards FortiGate must use HTTPS protocol.
log_null_device_filter dictionary		Default: null	Filters for null device logging.
	anomaly string	enable disable	Enable/disable anomaly logging.
	dns string	enable disable	Enable/disable detailed DNS event logging.
	filter string		Null-device log filter.
	filter_type string	include exclude	Include/exclude logs that match the filter.
	forward_traffic string	enable disable	Enable/disable forward traffic logging.
	gtp string	enable disable	Enable/disable GTP messages logging.
	local_traffic string	enable disable	Enable/disable local in or out traffic logging.
	multicast_traffic string	enable disable	Enable/disable multicast traffic logging.
	netscan_discovery string		Enable/disable netscan discovery event logging.
	netscan_vulnerability string		Enable/disable netscan vulnerability event logging.
	severity string	emergency alert critical error warning notification information debug	Lowest severity level to log.
	sniffer_traffic string	enable disable	Enable/disable sniffer traffic logging.
	ssh string	enable disable	Enable/disable SSH logging.
	voip string	enable disable	Enable/disable VoIP logging.
password string		Default: ""	FortiOS or FortiGate password.
ssl_verify boolean added in 2.9		no yes ←	Ensures FortiGate certificate must be verified by a proper CA.
username string			FortiOS or FortiGate username.
vdom string		Default: "root"	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.

Notes

Note

Requires fortiosapi library developed by Fortinet
Run as a local_action in your playbook

Examples

- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
   ssl_verify: "False"
  tasks:
  - name: Filters for null device logging.
    fortios_log_null_device_filter:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      log_null_device_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"

Return Values

Common return values are documented here, the following are the fields unique to this module:

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

Status

This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community. [community]

Authors

Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/fortios_log_null_device_filter_module.html