fortinet.fortimanager.fmgr_system_locallog_fortianalyzer3_filter – Filter for FortiAnalyzer3 logging.

From Get docs
Ansible/docs/2.11/collections/fortinet/fortimanager/fmgr system locallog fortianalyzer3 filter module


fortinet.fortimanager.fmgr_system_locallog_fortianalyzer3_filter – Filter for FortiAnalyzer3 logging.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.0.1).

To install it use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_system_locallog_fortianalyzer3_filter.


New in version 2.10: of fortinet.fortimanager


Synopsis

  • This module is able to configure a FortiManager device.
  • Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter Choices/Defaults Comments

bypass_validation

boolean

  • no

  • yes

only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters

rc_failed

list / elements=string

the rc codes list with which the conditions to fail will be overriden

rc_succeeded

list / elements=string

the rc codes list with which the conditions to succeed will be overriden

state

string / required

  • present
  • absent

the directive to create, update or delete an object

system_locallog_fortianalyzer3_filter

dictionary

the top level parameters set

devcfg

string

  • disable
  • enable

Log device configuration message.

disable - Disable setting.

enable - Enable setting.

devops

string

  • disable
  • enable

Managered devices operations messages.

disable - Disable setting.

enable - Enable setting.

diskquota

string

  • disable
  • enable

Log Fortianalyzer disk quota messages.

disable - Disable setting.

enable - Enable setting.

dm

string

  • disable
  • enable

Log deployment manager message.

disable - Disable setting.

enable - Enable setting.

dvm

string

  • disable
  • enable

Log device manager messages.

disable - Disable setting.

enable - Enable setting.

ediscovery

string

  • disable
  • enable

Log Fortianalyzer ediscovery messages.

disable - Disable setting.

enable - Enable setting.

epmgr

string

  • disable
  • enable

Log endpoint manager message.

disable - Disable setting.

enable - Enable setting.

event

string

  • disable
  • enable

Log event messages.

disable - Disable setting.

enable - Enable setting.

eventmgmt

string

  • disable
  • enable

Log Fortianalyzer event handler messages.

disable - Disable setting.

enable - Enable setting.

faz

string

  • disable
  • enable

Log Fortianalyzer messages.

disable - Disable setting.

enable - Enable setting.

fazha

string

  • disable
  • enable

Log Fortianalyzer HA messages.

disable - Disable setting.

enable - Enable setting.

fazsys

string

  • disable
  • enable

Log Fortianalyzer system messages.

disable - Disable setting.

enable - Enable setting.

fgd

string

  • disable
  • enable

Log FortiGuard service message.

disable - Disable setting.

enable - Enable setting.

fgfm

string

  • disable
  • enable

Log FGFM protocol message.

disable - Disable setting.

enable - Enable setting.

fips

string

  • disable
  • enable

Whether to log fips messages.

disable - Disable setting.

enable - Enable setting.

fmgws

string

  • disable
  • enable

Log web service messages.

disable - Disable setting.

enable - Enable setting.

fmlmgr

string

  • disable
  • enable

Log FortiMail manager message.

disable - Disable setting.

enable - Enable setting.

fmwmgr

string

  • disable
  • enable

Log firmware manager message.

disable - Disable setting.

enable - Enable setting.

fortiview

string

  • disable
  • enable

Log Fortianalyzer FortiView messages.

disable - Disable setting.

enable - Enable setting.

glbcfg

string

  • disable
  • enable

Log global database message.

disable - Disable setting.

enable - Enable setting.

ha

string

  • disable
  • enable

Log HA message.

disable - Disable setting.

enable - Enable setting.

hcache

string

  • disable
  • enable

Log Fortianalyzer hcache messages.

disable - Disable setting.

enable - Enable setting.

iolog

string

  • disable
  • enable

Log debug IO log message.

disable - Disable setting.

enable - Enable setting.

logd

string

  • disable
  • enable

Log the status of log daemon.

disable - Disable setting.

enable - Enable setting.

logdb

string

  • disable
  • enable

Log Fortianalyzer log DB messages.

disable - Disable setting.

enable - Enable setting.

logdev

string

  • disable
  • enable

Log Fortianalyzer log device messages.

disable - Disable setting.

enable - Enable setting.

logfile

string

  • enable
  • disable

Log Fortianalyzer log file messages.

enable - Enable setting.

disable - Disable setting.

logging

string

  • disable
  • enable

Log Fortianalyzer logging messages.

disable - Disable setting.

enable - Enable setting.

lrmgr

string

  • disable
  • enable

Log log and report manager message.

disable - Disable setting.

enable - Enable setting.

objcfg

string

  • disable
  • enable

Log object configuration change message.

disable - Disable setting.

enable - Enable setting.

report

string

  • disable
  • enable

Log Fortianalyzer report messages.

disable - Disable setting.

enable - Enable setting.

rev

string

  • disable
  • enable

Log revision history message.

disable - Disable setting.

enable - Enable setting.

rtmon

string

  • disable
  • enable

Log real-time monitor message.

disable - Disable setting.

enable - Enable setting.

scfw

string

  • disable
  • enable

Log firewall objects message.

disable - Disable setting.

enable - Enable setting.

scply

string

  • disable
  • enable

Log policy console message.

disable - Disable setting.

enable - Enable setting.

scrmgr

string

  • disable
  • enable

Log script manager message.

disable - Disable setting.

enable - Enable setting.

scvpn

string

  • disable
  • enable

Log VPN console message.

disable - Disable setting.

enable - Enable setting.

system

string

  • disable
  • enable

Log system manager message.

disable - Disable setting.

enable - Enable setting.

webport

string

  • disable
  • enable

Log web portal message.

disable - Disable setting.

enable - Enable setting.

workspace_locking_adom

string

the adom to lock for FortiManager running in workspace mode, the value can be global and others including root

workspace_locking_timeout

integer

Default:

300

the maximum time in seconds to wait for other user to release the workspace lock



Notes

Note

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
  • To create or update an object, use state present directive.
  • To delete an object, use state absent directive.
  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded


Examples

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Filter for FortiAnalyzer3 logging.
     fmgr_system_locallog_fortianalyzer3_filter:
        bypass_validation: False
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        system_locallog_fortianalyzer3_filter:
           devcfg: <value in [disable, enable]>
           devops: <value in [disable, enable]>
           diskquota: <value in [disable, enable]>
           dm: <value in [disable, enable]>
           dvm: <value in [disable, enable]>
           ediscovery: <value in [disable, enable]>
           epmgr: <value in [disable, enable]>
           event: <value in [disable, enable]>
           eventmgmt: <value in [disable, enable]>
           faz: <value in [disable, enable]>
           fazha: <value in [disable, enable]>
           fazsys: <value in [disable, enable]>
           fgd: <value in [disable, enable]>
           fgfm: <value in [disable, enable]>
           fips: <value in [disable, enable]>
           fmgws: <value in [disable, enable]>
           fmlmgr: <value in [disable, enable]>
           fmwmgr: <value in [disable, enable]>
           fortiview: <value in [disable, enable]>
           glbcfg: <value in [disable, enable]>
           ha: <value in [disable, enable]>
           hcache: <value in [disable, enable]>
           iolog: <value in [disable, enable]>
           logd: <value in [disable, enable]>
           logdb: <value in [disable, enable]>
           logdev: <value in [disable, enable]>
           logfile: <value in [enable, disable]>
           logging: <value in [disable, enable]>
           lrmgr: <value in [disable, enable]>
           objcfg: <value in [disable, enable]>
           report: <value in [disable, enable]>
           rev: <value in [disable, enable]>
           rtmon: <value in [disable, enable]>
           scfw: <value in [disable, enable]>
           scply: <value in [disable, enable]>
           scrmgr: <value in [disable, enable]>
           scvpn: <value in [disable, enable]>
           system: <value in [disable, enable]>
           webport: <value in [disable, enable]>

Return Values

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

Key Returned Description

request_url

string

always

The full url requested


Sample:

/sys/login/user

response_code

integer

always

The status of api request


response_message

string

always

The descriptive message of the api response


Sample:

OK.




Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_system_locallog_fortianalyzer3_filter_module.html