fmgr_system_locallog_fortianalyzer2_filter – Filter for FortiAnalyzer2 logging.¶
New in version 2.10.
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.0.0.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- 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
- 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
- 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
- system_locallog_fortianalyzer2_filter - Filter for FortiAnalyzer2 logging. type: dict
- devcfg - Log device configuration message. type: str choices: [disable, enable] default: enable
- devops - Managered devices operations messages. type: str choices: [disable, enable] default: enable
- diskquota - Log Fortianalyzer disk quota messages. type: str choices: [disable, enable] default: enable
- dm - Log deployment manager message. type: str choices: [disable, enable] default: enable
- dvm - Log device manager messages. type: str choices: [disable, enable] default: enable
- ediscovery - Log Fortianalyzer ediscovery messages. type: str choices: [disable, enable] default: enable
- epmgr - Log endpoint manager message. type: str choices: [disable, enable] default: enable
- event - Log event messages. type: str choices: [disable, enable] default: enable
- eventmgmt - Log Fortianalyzer event handler messages. type: str choices: [disable, enable] default: enable
- faz - Log Fortianalyzer messages. type: str choices: [disable, enable] default: enable
- fazha - Log Fortianalyzer HA messages. type: str choices: [disable, enable] default: enable
- fazsys - Log Fortianalyzer system messages. type: str choices: [disable, enable] default: enable
- fgd - Log FortiGuard service message. type: str choices: [disable, enable] default: enable
- fgfm - Log FGFM protocol message. type: str choices: [disable, enable] default: enable
- fips - Whether to log fips messages. type: str choices: [disable, enable] default: enable
- fmgws - Log web service messages. type: str choices: [disable, enable] default: enable
- fmlmgr - Log FortiMail manager message. type: str choices: [disable, enable] default: enable
- fmwmgr - Log firmware manager message. type: str choices: [disable, enable] default: enable
- fortiview - Log Fortianalyzer FortiView messages. type: str choices: [disable, enable] default: enable
- glbcfg - Log global database message. type: str choices: [disable, enable] default: enable
- ha - Log HA message. type: str choices: [disable, enable] default: enable
- hcache - Log Fortianalyzer hcache messages. type: str choices: [disable, enable] default: enable
- iolog - Log debug IO log message. type: str choices: [disable, enable] default: enable
- logd - Log the status of log daemon. type: str choices: [disable, enable] default: enable
- logdb - Log Fortianalyzer log DB messages. type: str choices: [disable, enable] default: enable
- logdev - Log Fortianalyzer log device messages. type: str choices: [disable, enable] default: enable
- logfile - Log Fortianalyzer log file messages. type: str choices: [enable, disable]
- logging - Log Fortianalyzer logging messages. type: str choices: [disable, enable] default: enable
- lrmgr - Log log and report manager message. type: str choices: [disable, enable] default: enable
- objcfg - Log object configuration change message. type: str choices: [disable, enable] default: enable
- report - Log Fortianalyzer report messages. type: str choices: [disable, enable] default: enable
- rev - Log revision history message. type: str choices: [disable, enable] default: enable
- rtmon - Log real-time monitor message. type: str choices: [disable, enable] default: enable
- scfw - Log firewall objects message. type: str choices: [disable, enable] default: enable
- scply - Log policy console message. type: str choices: [disable, enable] default: enable
- scrmgr - Log script manager message. type: str choices: [disable, enable] default: enable
- scvpn - Log VPN console message. type: str choices: [disable, enable] default: enable
- system - Log system manager message. type: str choices: [disable, enable] default: enable
- webport - Log web portal message. type: str choices: [disable, enable] default: enable
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 FortiAnalyzer2 logging.
fmgr_system_locallog_fortianalyzer2_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_fortianalyzer2_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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- 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_message - The descriptive message of the api response returned: always type: str sample: OK
- response_data - The data body of the api response returned: optional type: list or dict