source: | fortios_log_webtrends_filter.py |
---|---|
orphan: |
.. versionadded:: 2.0.0
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log_webtrends feature and filter category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
The below requirements are needed on the host that executes this module.
- ansible>=2.14
Using member operation to add an element to an existing object.
Supported Version Ranges | |
fortios_log_webtrends_filter | v6.0.0 -> latest |
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- vdom - Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. type: str default: root
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- log_webtrends_filter - Filters for WebTrends. type: dict
more...
Supported Version Ranges log_webtrends_filter v6.0.0 -> latest
- anomaly - Enable/disable anomaly logging. type: str choices: enable, disable
more...
Supported Version Ranges anomaly v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- dns - Enable/disable detailed DNS event logging. type: str choices: enable, disable
more...
Supported Version Ranges dns v6.0.0 -> v6.0.11
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- filter - Webtrends log filter. type: str
more...
Supported Version Ranges filter v6.0.0 -> v6.4.4
- filter_type - Include/exclude logs that match the filter. type: str choices: include, exclude
more...
Supported Version Ranges filter_type v6.0.0 -> v6.4.4
[include] v6.0.0 -> latest
[exclude] v6.0.0 -> latest
- forward_traffic - Enable/disable forward traffic logging. type: str choices: enable, disable
more...
Supported Version Ranges forward_traffic v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- free_style - Free style filters. type: list member_path: free_style:id
more...
Supported Version Ranges free_style v7.0.0 -> latest
- category - Log category. type: str choices: traffic, event, virus, webfilter, attack, spam, anomaly, voip, dlp, app-ctrl, waf, gtp, dns, ssh, ssl, file-filter, icap, virtual-patch, ztna
more...
Supported Version Ranges category v7.0.0 -> latest
[traffic] v6.0.0 -> latest
[event] v6.0.0 -> latest
[virus] v6.0.0 -> latest
[webfilter] v6.0.0 -> latest
[attack] v6.0.0 -> latest
[spam] v6.0.0 -> latest
[anomaly] v6.0.0 -> latest
[voip] v6.0.0 -> latest
[dlp] v6.0.0 -> latest
[app-ctrl] v6.0.0 -> latest
[waf] v6.0.0 -> latest
[gtp] v6.0.0 -> latest
[dns] v6.0.0 -> latest
[ssh] v6.0.0 -> latest
[ssl] v6.0.0 -> latest
[file-filter] v6.0.0 -> latest
[icap] v6.0.0 -> latest
[virtual-patch] v7.4.1 -> latest
[ztna] v7.0.1 -> v7.0.3
- filter - Free style filter string. type: str
more...
Supported Version Ranges filter v7.0.0 -> latest
- filter_type - Include/exclude logs that match the filter. type: str choices: include, exclude
more...
Supported Version Ranges filter_type v7.0.0 -> latest
[include] v6.0.0 -> latest
[exclude] v6.0.0 -> latest
- id - Entry ID. see Notes. type: int required: true
more...
Supported Version Ranges id v7.0.0 -> latest
- gtp - Enable/disable GTP messages logging. type: str choices: enable, disable
more...
Supported Version Ranges gtp v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- local_traffic - Enable/disable local in or out traffic logging. type: str choices: enable, disable
more...
Supported Version Ranges local_traffic v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- multicast_traffic - Enable/disable multicast traffic logging. type: str choices: enable, disable
more...
Supported Version Ranges multicast_traffic v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- netscan_discovery - Enable/disable netscan discovery event logging. type: str
more...
Supported Version Ranges netscan_discovery v6.0.0 -> v6.0.11
- netscan_vulnerability - Enable/disable netscan vulnerability event logging. type: str
more...
Supported Version Ranges netscan_vulnerability v6.0.0 -> v6.0.11
- severity - Lowest severity level to log to WebTrends. type: str choices: emergency, alert, critical, error, warning, notification, information, debug
more...
Supported Version Ranges severity v6.0.0 -> latest
[emergency] v6.0.0 -> latest
[alert] v6.0.0 -> latest
[critical] v6.0.0 -> latest
[error] v6.0.0 -> latest
[warning] v6.0.0 -> latest
[notification] v6.0.0 -> latest
[information] v6.0.0 -> latest
[debug] v6.0.0 -> latest
- sniffer_traffic - Enable/disable sniffer traffic logging. type: str choices: enable, disable
more...
Supported Version Ranges sniffer_traffic v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- ssh - Enable/disable SSH logging. type: str choices: enable, disable
more...
Supported Version Ranges ssh v6.0.0 -> v6.0.11
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- voip - Enable/disable VoIP logging. type: str choices: enable, disable
more...
Supported Version Ranges voip v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- ztna_traffic - Enable/disable ztna traffic logging. type: str choices: enable, disable
more...
Supported Version Ranges ztna_traffic v7.0.4 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
- name: Filters for WebTrends.
fortinet.fortios.fortios_log_webtrends_filter:
vdom: "{{ vdom }}"
log_webtrends_filter:
anomaly: "enable"
dns: "enable"
filter: "<your_own_value>"
filter_type: "include"
forward_traffic: "enable"
free_style:
-
category: "traffic"
filter: "<your_own_value>"
filter_type: "include"
id: "12"
gtp: "enable"
local_traffic: "enable"
multicast_traffic: "enable"
netscan_discovery: "<your_own_value>"
netscan_vulnerability: "<your_own_value>"
severity: "emergency"
sniffer_traffic: "enable"
ssh: "enable"
voip: "enable"
ztna_traffic: "enable"
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:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3
- This module is not guaranteed to have a backwards compatible interface.
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
Hint
If you notice any issues in this documentation, you can create a pull request to improve it.