fortinet.fortimanager.fmgr_system_locallog_syslogd3_filter module – Filter for syslog logging.
Note
This module is part of the fortinet.fortimanager collection (version 2.8.2).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install fortinet.fortimanager
.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_system_locallog_syslogd3_filter
.
New in fortinet.fortimanager 2.0.0
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 |
Comments |
---|---|
The token to access FortiManager without using username and password. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The top level parameters set. |
|
Log aid messages. disable - Disable setting. enable - Enable setting. Choices:
|
|
Controller application generic messages. disable - Disable setting. enable - Enable setting. Choices:
|
|
Log device configuration message. disable - Disable setting. enable - Enable setting. Choices:
|
|
Managered devices operations messages. disable - Disable setting. enable - Enable setting. Choices:
|
|
Log Fortianalyzer disk quota messages. disable - Disable setting. enable - Enable setting. Choices:
|
|
Log deployment manager message. disable - Disable setting. enable - Enable setting. Choices:
|
|
Docker application generic messages. disable - Disable setting. enable - Enable setting. Choices:
|
|
Log device manager messages. disable - Disable setting. enable - Enable setting. Choices:
|
|
Log Fortianalyzer ediscovery messages. disable - Disable setting. enable - Enable setting. Choices:
|
|
Log endpoint manager message. disable - Disable setting. enable - Enable setting. Choices:
|
|
Log event messages. disable - Disable setting. enable - Enable setting. Choices:
|
|
Log Fortianalyzer event handler messages. disable - Disable setting. enable - Enable setting. Choices:
|
|
Log Fortianalyzer messages. disable - Disable setting. enable - Enable setting. Choices:
|
|
Log Fortianalyzer HA messages. disable - Disable setting. enable - Enable setting. Choices:
|
|
Log Fortianalyzer system messages. disable - Disable setting. enable - Enable setting. Choices:
|
|
Log FortiGuard service message. disable - Disable setting. enable - Enable setting. Choices:
|
|
Log FGFM protocol message. disable - Disable setting. enable - Enable setting. Choices:
|
|
Whether to log fips messages. disable - Disable setting. enable - Enable setting. Choices:
|
|
Log web service messages. disable - Disable setting. enable - Enable setting. Choices:
|
|
Log FortiMail manager message. disable - Disable setting. enable - Enable setting. Choices:
|
|
Log firmware manager message. disable - Disable setting. enable - Enable setting. Choices:
|
|
Log Fortianalyzer FortiView messages. disable - Disable setting. enable - Enable setting. Choices:
|
|
Log global database message. disable - Disable setting. enable - Enable setting. Choices:
|
|
Log HA message. disable - Disable setting. enable - Enable setting. Choices:
|
|
Log Fortianalyzer hcache messages. disable - Disable setting. enable - Enable setting. Choices:
|
|
Log Fortianalyzer incident messages. disable - Disable setting. enable - Enable setting. Choices:
|
|
Log debug IO log message. disable - Disable setting. enable - Enable setting. Choices:
|
|
Log the status of log daemon. disable - Disable setting. enable - Enable setting. Choices:
|
|
Log Fortianalyzer log DB messages. disable - Disable setting. enable - Enable setting. Choices:
|
|
Log Fortianalyzer log device messages. disable - Disable setting. enable - Enable setting. Choices:
|
|
Log Fortianalyzer log file messages. enable - Enable setting. disable - Disable setting. Choices:
|
|
Log Fortianalyzer logging messages. disable - Disable setting. enable - Enable setting. Choices:
|
|
Log log and report manager message. disable - Disable setting. enable - Enable setting. Choices:
|
|
Log object configuration change message. disable - Disable setting. enable - Enable setting. Choices:
|
|
Log Fortianalyzer report messages. disable - Disable setting. enable - Enable setting. Choices:
|
|
Log revision history message. disable - Disable setting. enable - Enable setting. Choices:
|
|
Log real-time monitor message. disable - Disable setting. enable - Enable setting. Choices:
|
|
Log firewall objects message. disable - Disable setting. enable - Enable setting. Choices:
|
|
Log policy console message. disable - Disable setting. enable - Enable setting. Choices:
|
|
Log script manager message. disable - Disable setting. enable - Enable setting. Choices:
|
|
Log VPN console message. disable - Disable setting. enable - Enable setting. Choices:
|
|
Log system manager message. disable - Disable setting. enable - Enable setting. Choices:
|
|
Log web portal message. disable - Disable setting. enable - Enable setting. Choices:
|
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
Notes
Note
Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
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.
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
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Filter for syslog logging.
fortinet.fortimanager.fmgr_system_locallog_syslogd3_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_syslogd3_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]>
controller: <value in [disable, enable]>
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |