fmgr_system_locallog_fortianalyzer_filter – Filter for FortiAnalyzer logging.
Added in version 2.0.0.
Warning
Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).
Argument name before 3.0.0:
var-name,var name,var.nameNew argument name starting in 3.0.0:
var_name
FortiManager Ansible v2.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 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.15.0
FortiManager Version Compatibility
Supported Version Ranges: v6.0.0 -> latest
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_fortianalyzer_filter - Filter for FortiAnalyzer logging. type: dict
- devcfg Log device configuration message. type: str choices: [disable, enable] default: enable 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: enable 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: enable 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: enable more...
- fgfm Log fgfm protocol message. type: str choices: [disable, enable] default: enable 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: enable more...
- fmwmgr Log firmware manager message. type: str choices: [disable, enable] default: enable 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: enable more...
- ha Log ha message. type: str choices: [disable, enable] default: enable more...
- hcache Log fortianalyzer hcache 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: enable more...
- objcfg Log object configuration change message. type: str choices: [disable, enable] default: enable 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: enable more...
- rtmon Log real-time monitor message. type: str choices: [disable, enable] default: enable more...
- scfw Log firewall objects message. type: str choices: [disable, enable] default: enable more...
- scply Log policy console message. type: str choices: [disable, enable] default: enable more...
- scrmgr Log script manager message. type: str choices: [disable, enable] default: enable more...
- scvpn Log vpn console message. type: str choices: [disable, enable] default: enable 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: enable more...
- incident Log fortianalyzer incident messages. type: str choices: [disable, enable] default: enable 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
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
- 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 FortiAnalyzer logging.
fortinet.fortimanager.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]>
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: 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 FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
Status
This module is not guaranteed to have a backwards compatible interface.