fortinet.fortimanager.fmgr_system_locallog_fortianalyzer_filter – Filter for FortiAnalyzer 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_fortianalyzer_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
    Choices:
  • 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
    Choices:
  • present
  • absent
the directive to create, update or delete an object
system_locallog_fortianalyzer_filter
dictionary
the top level parameters set
devcfg
string
    Choices:
  • disable
  • enable ←
Log device configuration message.
disable - Disable setting.
enable - Enable setting.
devops
string
    Choices:
  • disable
  • enable ←
Managered devices operations messages.
disable - Disable setting.
enable - Enable setting.
diskquota
string
    Choices:
  • disable
  • enable ←
Log Fortianalyzer disk quota messages.
disable - Disable setting.
enable - Enable setting.
dm
string
    Choices:
  • disable
  • enable ←
Log deployment manager message.
disable - Disable setting.
enable - Enable setting.
dvm
string
    Choices:
  • disable
  • enable ←
Log device manager messages.
disable - Disable setting.
enable - Enable setting.
ediscovery
string
    Choices:
  • disable
  • enable ←
Log Fortianalyzer ediscovery messages.
disable - Disable setting.
enable - Enable setting.
epmgr
string
    Choices:
  • disable
  • enable ←
Log endpoint manager message.
disable - Disable setting.
enable - Enable setting.
event
string
    Choices:
  • disable
  • enable ←
Log event messages.
disable - Disable setting.
enable - Enable setting.
eventmgmt
string
    Choices:
  • disable
  • enable ←
Log Fortianalyzer event handler messages.
disable - Disable setting.
enable - Enable setting.
faz
string
    Choices:
  • disable
  • enable ←
Log Fortianalyzer messages.
disable - Disable setting.
enable - Enable setting.
fazha
string
    Choices:
  • disable
  • enable ←
Log Fortianalyzer HA messages.
disable - Disable setting.
enable - Enable setting.
fazsys
string
    Choices:
  • disable
  • enable ←
Log Fortianalyzer system messages.
disable - Disable setting.
enable - Enable setting.
fgd
string
    Choices:
  • disable
  • enable ←
Log FortiGuard service message.
disable - Disable setting.
enable - Enable setting.
fgfm
string
    Choices:
  • disable
  • enable ←
Log FGFM protocol message.
disable - Disable setting.
enable - Enable setting.
fips
string
    Choices:
  • disable
  • enable ←
Whether to log fips messages.
disable - Disable setting.
enable - Enable setting.
fmgws
string
    Choices:
  • disable
  • enable ←
Log web service messages.
disable - Disable setting.
enable - Enable setting.
fmlmgr
string
    Choices:
  • disable
  • enable ←
Log FortiMail manager message.
disable - Disable setting.
enable - Enable setting.
fmwmgr
string
    Choices:
  • disable
  • enable ←
Log firmware manager message.
disable - Disable setting.
enable - Enable setting.
fortiview
string
    Choices:
  • disable
  • enable ←
Log Fortianalyzer FortiView messages.
disable - Disable setting.
enable - Enable setting.
glbcfg
string
    Choices:
  • disable
  • enable ←
Log global database message.
disable - Disable setting.
enable - Enable setting.
ha
string
    Choices:
  • disable
  • enable ←
Log HA message.
disable - Disable setting.
enable - Enable setting.
hcache
string
    Choices:
  • disable
  • enable ←
Log Fortianalyzer hcache messages.
disable - Disable setting.
enable - Enable setting.
iolog
string
    Choices:
  • disable
  • enable ←
Log debug IO log message.
disable - Disable setting.
enable - Enable setting.
logd
string
    Choices:
  • disable
  • enable ←
Log the status of log daemon.
disable - Disable setting.
enable - Enable setting.
logdb
string
    Choices:
  • disable
  • enable ←
Log Fortianalyzer log DB messages.
disable - Disable setting.
enable - Enable setting.
logdev
string
    Choices:
  • disable
  • enable ←
Log Fortianalyzer log device messages.
disable - Disable setting.
enable - Enable setting.
logfile
string
    Choices:
  • enable
  • disable
Log Fortianalyzer log file messages.
enable - Enable setting.
disable - Disable setting.
logging
string
    Choices:
  • disable
  • enable ←
Log Fortianalyzer logging messages.
disable - Disable setting.
enable - Enable setting.
lrmgr
string
    Choices:
  • disable
  • enable ←
Log log and report manager message.
disable - Disable setting.
enable - Enable setting.
objcfg
string
    Choices:
  • disable
  • enable ←
Log object configuration change message.
disable - Disable setting.
enable - Enable setting.
report
string
    Choices:
  • disable
  • enable ←
Log Fortianalyzer report messages.
disable - Disable setting.
enable - Enable setting.
rev
string
    Choices:
  • disable
  • enable ←
Log revision history message.
disable - Disable setting.
enable - Enable setting.
rtmon
string
    Choices:
  • disable
  • enable ←
Log real-time monitor message.
disable - Disable setting.
enable - Enable setting.
scfw
string
    Choices:
  • disable
  • enable ←
Log firewall objects message.
disable - Disable setting.
enable - Enable setting.
scply
string
    Choices:
  • disable
  • enable ←
Log policy console message.
disable - Disable setting.
enable - Enable setting.
scrmgr
string
    Choices:
  • disable
  • enable ←
Log script manager message.
disable - Disable setting.
enable - Enable setting.
scvpn
string
    Choices:
  • disable
  • enable ←
Log VPN console message.
disable - Disable setting.
enable - Enable setting.
system
string
    Choices:
  • disable
  • enable ←
Log system manager message.
disable - Disable setting.
enable - Enable setting.
webport
string
    Choices:
  • 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 FortiAnalyzer logging.
     fmgr_system_locallog_fortianalyzer_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_fortianalyzer_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_fortianalyzer_filter_module.html