fmgr_devprof_log_syslogd_filter – Filters for remote system server.¶
New in version 1.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 |
||
| True | True | True | True | True | False | 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 |
| True | True | False | 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 |
||||
| True | True | True | True | True | True | True | True | ||||
7.2.0 |
7.2.1 |
7.2.2 |
|||||||||
| 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
- adom - The parameter in requested url type: str required: true
- devprof - The parameter in requested url type: str required: true
- devprof_log_syslogd_filter - Filters for remote system server. type: dict
- severity - Lowest severity level to log. type: str choices: [emergency, alert, critical, error, warning, notification, information, debug] more...
- anomaly - Enable/disable anomaly logging. type: str choices: [disable, enable] more...
- exclude-list - No description for the parameter type: array more...
- forward-traffic - Enable/disable forward traffic logging. type: str choices: [disable, enable] more...
- free-style - No description for the parameter type: array
more...
- category - Log category. type: str choices: [traffic, event, virus, webfilter, attack, spam, voip, dlp, app-ctrl, anomaly, waf, gtp, dns, ssh, ssl, file-filter, icap, ztna] more...
- filter - Free style filter string. type: str more...
- filter-type - Include/exclude logs that match the filter. type: str choices: [include, exclude] more...
- id - Entry ID. type: int more...
- gtp - Enable/disable GTP messages logging. type: str choices: [disable, enable] more...
- local-traffic - Enable/disable local in or out traffic logging. type: str choices: [disable, enable] more...
- multicast-traffic - Enable/disable multicast traffic logging. type: str choices: [disable, enable] more...
- sniffer-traffic - Enable/disable sniffer traffic logging. type: str choices: [disable, enable] more...
- voip - Enable/disable VoIP logging. type: str choices: [disable, enable] more...
- ztna-traffic - Enable/disable ztna traffic logging. type: str choices: [disable, enable] more...
- filter-type - Include/exclude logs that match the filter. type: str choices: [include, exclude] more...
- filter - Syslog filter. type: str more...
- dns - Enable/disable detailed DNS event logging. type: str choices: [disable, enable] more...
- cifs - No description for the parameter type: str choices: [disable, enable] more...
- ssh - Enable/disable SSH logging. type: str choices: [disable, enable] more...
- ssl - No description for the parameter type: str choices: [disable, enable] more...
- netscan-vulnerability - Enable/disable netscan vulnerability event logging. type: str choices: [disable, enable] more...
- netscan-discovery - Enable/disable netscan discovery event logging. type: str choices: [disable, 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¶
- 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: Filters for remote system server.
fmgr_devprof_log_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, ...]
adom: <your own value>
devprof: <your own value>
devprof_log_syslogd_filter:
severity: <value in [emergency, alert, critical, ...]>
anomaly: <value in [disable, enable]>
exclude-list:
-
category: <value in [app-ctrl, attack, dlp, ...]>
fields:
-
args: <value of string>
field: <value of string>
negate: <value in [disable, enable]>
id: <value of integer>
forward-traffic: <value in [disable, enable]>
free-style:
-
category: <value in [traffic, event, virus, ...]>
filter: <value of string>
filter-type: <value in [include, exclude]>
id: <value of integer>
gtp: <value in [disable, enable]>
local-traffic: <value in [disable, enable]>
multicast-traffic: <value in [disable, enable]>
sniffer-traffic: <value in [disable, enable]>
voip: <value in [disable, enable]>
ztna-traffic: <value in [disable, enable]>
filter-type: <value in [include, exclude]>
filter: <value of string>
dns: <value in [disable, enable]>
cifs: <value in [disable, enable]>
ssh: <value in [disable, enable]>
ssl: <value in [disable, enable]>
netscan-vulnerability: <value in [disable, enable]>
netscan-discovery: <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