faz_cli_system_locallog_fortianalyzer2_filter – Filter for FortiAnalyzer2 logging.
New in version 1.0.0.
Warning
Starting in version 2.0.0, all variables will be named in the underscore naming convention.
Possible variable names before 2.0.0:
variable-name
,variable name
,variable.name
Corresponding variable names since 2.0.0:
variable_name
FortiAnalyzer Ansible v1.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.
Synopsis
This module is able to configure a FortiAnalyzer device.
Examples include all parameters and values need to be adjusted to data sources before usage.
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.15.0
FortiAnalyzer Version Compatibility
6.2.0 |
6.2.1 |
6.2.2 |
6.2.3 |
6.2.4 |
6.2.5 |
6.2.6 |
6.2.7 |
6.2.8 |
6.2.9 |
6.2.10 |
6.2.11 |
6.2.12 |
||
None | True | True | True | None | 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 |
6.4.13 |
6.4.14 |
None | True | 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 |
7.0.9 |
7.0.10 |
7.0.11 |
|||
True | True | True | True | True | True | True | True | True | True | True | True | |||
7.2.0 |
7.2.1 |
7.2.2 |
7.2.3 |
7.2.4 |
||||||||||
True | True | True | True | True | ||||||||||
7.4.0 |
7.4.1 |
7.4.2 |
||||||||||||
True | True | True |
Parameters
- access_token -The token to access FortiAnalyzer without using ansible_username and ansible_password. type: str required: false
- enable_log - Enable/Disable logging for task type: bool required: false default: False
- forticloud_access_token - Access token of forticloud analyzer API users. type: str required: false
- log_path - The path to save log. Used if enable_log is true. Please use absolute path instead of relative path. If the log_path setting is incorrect, the log will be saved in /tmp/fortianalyzer.ansible.logtype: str required: false default: "/tmp/fortianalyzer.ansible.log"
- proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
- bypass_validation - Only set to True when module schema diffs with FortiAnalyzer API structure, module continues to execute without validating parameters type: bool required: false default: False
- 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
- cli_system_locallog_fortianalyzer2_filter - Filter for FortiAnalyzer2 logging. type: dict
- devcfg - Log device configuration message. type: str choices: [disable, enable] default: disable more...
- devops - Managered devices operations messages. type: str choices: [disable, enable] default: enable more...
- diskquota - Log Fortianalyzer disk quota messages. type: str choices: [disable, enable] default: enable more...
- dm - Log deployment manager message. type: str choices: [disable, enable] default: disable more...
- dvm - Log device manager messages. type: str choices: [disable, enable] default: enable more...
- ediscovery - Log Fortianalyzer ediscovery messages. type: str choices: [disable, enable] default: enable more...
- epmgr - Log endpoint manager message. type: str choices: [disable, enable] default: disable more...
- event - Log event messages. type: str choices: [disable, enable] default: enable more...
- eventmgmt - Log Fortianalyzer event handler messages. type: str choices: [disable, enable] default: enable more...
- faz - Log Fortianalyzer messages. type: str choices: [disable, enable] default: enable more...
- fazha - Log Fortianalyzer HA messages. type: str choices: [disable, enable] default: enable more...
- fazsys - Log Fortianalyzer system messages. type: str choices: [disable, enable] default: enable more...
- fgd - Log FortiGuard service message. type: str choices: [disable, enable] default: disable more...
- fgfm - Log FGFM protocol message. type: str choices: [disable, enable] default: disable more...
- fips - Whether to log fips messages. type: str choices: [disable, enable] default: enable more...
- fmgws - Log web service messages. type: str choices: [disable, enable] default: enable more...
- fmlmgr - Log FortiMail manager message. type: str choices: [disable, enable] default: disable more...
- fmwmgr - Log firmware manager message. type: str choices: [disable, enable] default: disable more...
- fortiview - Log Fortianalyzer FortiView messages. type: str choices: [disable, enable] default: enable more...
- glbcfg - Log global database message. type: str choices: [disable, enable] default: disable more...
- ha - Log HA message. type: str choices: [disable, enable] default: disable more...
- hcache - Log Fortianalyzer hcache messages. type: str choices: [disable, enable] default: enable more...
- incident - Log Fortianalyzer incident messages. type: str choices: [disable, enable] default: enable more...
- iolog - Log debug IO log message. type: str choices: [disable, enable] default: enable more...
- logd - Log the status of log daemon. type: str choices: [disable, enable] default: enable more...
- logdb - Log Fortianalyzer log DB messages. type: str choices: [disable, enable] default: enable more...
- logdev - Log Fortianalyzer log device messages. type: str choices: [disable, enable] default: enable more...
- logfile - Log Fortianalyzer log file messages. type: str choices: [enable, disable] more...
- logging - Log Fortianalyzer logging messages. type: str choices: [disable, enable] default: enable more...
- lrmgr - Log log and report manager message. type: str choices: [disable, enable] default: disable more...
- objcfg - Log object configuration change message. type: str choices: [disable, enable] default: disable more...
- report - Log Fortianalyzer report messages. type: str choices: [disable, enable] default: enable more...
- rev - Log revision history message. type: str choices: [disable, enable] default: disable more...
- rtmon - Log real-time monitor message. type: str choices: [disable, enable] default: disable more...
- scfw - Log firewall objects message. type: str choices: [disable, enable] default: disable more...
- scply - Log policy console message. type: str choices: [disable, enable] default: disable more...
- scrmgr - Log script manager message. type: str choices: [disable, enable] default: disable more...
- scvpn - Log VPN console message. type: str choices: [disable, enable] default: disable more...
- system - Log system manager message. type: str choices: [disable, enable] default: enable more...
- webport - Log web portal message. type: str choices: [disable, enable] default: disable more...
- aid - Log aid messages. type: str choices: [disable, enable] default: enable more...
- docker - Docker application generic messages. type: str choices: [disable, enable] default: enable more...
- controller - Controller application generic messages. type: str choices: [disable, enable] default: enable more...
Notes
Note
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
- name: Example playbook
connection: httpapi
hosts: fortianalyzers
tasks:
- name: Filter for FortiAnalyzer2 logging.
fortinet.fortianalyzer.faz_cli_system_locallog_fortianalyzer2_filter:
cli_system_locallog_fortianalyzer2_filter:
# aid: disable
devcfg: disable
devops: disable
diskquota: disable
dm: disable
# docker: disable
dvm: disable
ediscovery: disable
epmgr: disable
event: disable
eventmgmt: disable
faz: disable
fazha: disable
fazsys: disable
fgd: disable
fgfm: disable
fips: disable
fmgws: disable
fmlmgr: disable
fmwmgr: disable
fortiview: disable
glbcfg: disable
ha: disable
hcache: disable
# incident: disable
iolog: disable
logd: disable
logdb: disable
logdev: disable
# logfile: <value in [enable, disable]>
logging: disable
lrmgr: disable
objcfg: disable
report: disable
rev: disable
rtmon: disable
scfw: disable
scply: disable
scrmgr: disable
scvpn: disable
system: disable
webport: disable
vars:
ansible_httpapi_port: 443
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
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 sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current fortianalyzer version. returned: if params are not supported in the current version type: list
Status
This module is not guaranteed to have a backwards compatible interface.