fmgr_system_locallog_syslogd_filter – Filter for syslog logging.

New in version 2.0.0.

Synopsis

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

Requirements

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

• ansible>=2.9.0

FortiManager Version Compatibility

6.0.0
True
6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
True	True	True	True	True	True	True	True	True	True	True
6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
True	True	True	True	True	True	True	True	True	True	True	True	True
7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
True	True	True	True	True	True	True	True	True
7.2.0	7.2.1	7.2.2	7.2.3
True	True	True	True
7.4.0
True

Parameters

• access_token -The token to access FortiManager without using username and password. type: str required: false
• bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
• enable_log - Enable/Disable logging for task. type: bool required: false default: False
• forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
• proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
• rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
• rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
• workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
• workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
• system_locallog_syslogd_filter - Filter for syslog logging. type: dict
• devcfg - Log device configuration message. type: str choices: [disable, enable] default: enable more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• devops - Managered devices operations messages. type: str choices: [disable, enable] default: enable more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• diskquota - Log Fortianalyzer disk quota messages. type: str choices: [disable, enable] default: enable more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• dm - Log deployment manager message. type: str choices: [disable, enable] default: enable more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• dvm - Log device manager messages. type: str choices: [disable, enable] default: enable more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• ediscovery - Log Fortianalyzer ediscovery messages. type: str choices: [disable, enable] default: enable more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• epmgr - Log endpoint manager message. type: str choices: [disable, enable] default: enable more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• event - Log event messages. type: str choices: [disable, enable] default: enable more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• eventmgmt - Log Fortianalyzer event handler messages. type: str choices: [disable, enable] default: enable more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• faz - Log Fortianalyzer messages. type: str choices: [disable, enable] default: enable more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• fazha - Log Fortianalyzer HA messages. type: str choices: [disable, enable] default: enable more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• fazsys - Log Fortianalyzer system messages. type: str choices: [disable, enable] default: enable more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• fgd - Log FortiGuard service message. type: str choices: [disable, enable] default: enable more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• fgfm - Log FGFM protocol message. type: str choices: [disable, enable] default: enable more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• fips - Whether to log fips messages. type: str choices: [disable, enable] default: enable more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• fmgws - Log web service messages. type: str choices: [disable, enable] default: enable more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• fmlmgr - Log FortiMail manager message. type: str choices: [disable, enable] default: enable more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• fmwmgr - Log firmware manager message. type: str choices: [disable, enable] default: enable more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• fortiview - Log Fortianalyzer FortiView messages. type: str choices: [disable, enable] default: enable more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• glbcfg - Log global database message. type: str choices: [disable, enable] default: enable more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• ha - Log HA message. type: str choices: [disable, enable] default: enable more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• hcache - Log Fortianalyzer hcache messages. type: str choices: [disable, enable] default: enable more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• iolog - Log debug IO log message. type: str choices: [disable, enable] default: enable more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• logd - Log the status of log daemon. type: str choices: [disable, enable] default: enable more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• logdb - Log Fortianalyzer log DB messages. type: str choices: [disable, enable] default: enable more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• logdev - Log Fortianalyzer log device messages. type: str choices: [disable, enable] default: enable more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• logfile - Log Fortianalyzer log file messages. type: str choices: [enable, disable] more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• logging - Log Fortianalyzer logging messages. type: str choices: [disable, enable] default: enable more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• lrmgr - Log log and report manager message. type: str choices: [disable, enable] default: enable more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• objcfg - Log object configuration change message. type: str choices: [disable, enable] default: enable more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• report - Log Fortianalyzer report messages. type: str choices: [disable, enable] default: enable more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• rev - Log revision history message. type: str choices: [disable, enable] default: enable more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• rtmon - Log real-time monitor message. type: str choices: [disable, enable] default: enable more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• scfw - Log firewall objects message. type: str choices: [disable, enable] default: enable more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• scply - Log policy console message. type: str choices: [disable, enable] default: enable more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• scrmgr - Log script manager message. type: str choices: [disable, enable] default: enable more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• scvpn - Log VPN console message. type: str choices: [disable, enable] default: enable more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• system - Log system manager message. type: str choices: [disable, enable] default: enable more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• webport - Log web portal message. type: str choices: [disable, enable] default: enable more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• incident - Log Fortianalyzer incident messages. type: str choices: [disable, enable] default: enable more...

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• aid - Log aid messages. type: str choices: [disable, enable] default: enable more...

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  False

• docker - Docker application generic messages. type: str choices: [disable, enable] default: enable more...

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

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 syslog logging.
     fmgr_system_locallog_syslogd_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_syslogd_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]>
           incident: <value in [disable, enable]>
           aid: <value in [disable, enable]>
           docker: <value in [disable, enable]>

Return Values

Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

• meta - The result of the request.returned: always type: dict
• request_url - The full url requested. returned: always type: str sample: /sys/login/user
• response_code - The status of api request. returned: always type: int sample: 0
• response_data - The data body of the api response. returned: optional type: list or dict
• response_message - The descriptive message of the api response. returned: always type: str sample: OK
• system_information - The information of the target system. returned: always type: dict
• rc - The status the request. returned: always type: int 0
• version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least on parameter mpt supported by the current FortiManager version type: list 0

Status

• This module is not guaranteed to have a backwards compatible interface.

Authors

• Xinwei Du (@dux-fortinet)
• Xing Li (@lix-fortinet)
• Jie Xue (@JieX19)
• Link Zheng (@chillancezen)
• Frank Shen (@fshen01)
• Hongbin Lu (@fgtdev-hblu)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.