:source: fortios_wireless_controller_log.py
:orphan:
.. fortios_wireless_controller_log:
fortios_wireless_controller_log -- Configure wireless controller event log filters in Fortinet's FortiOS and FortiGate.
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. versionadded:: 2.0.0
.. contents::
:local:
:depth: 1
Synopsis
--------
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless_controller feature and log category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
- ansible>=2.15
Tips
----
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
-----------------------------
Supported Version Ranges: v6.2.0 -> v7.6.6
Parameters
----------
.. raw:: html
- 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
- wireless_controller_log - Configure wireless controller event log filters. type: dict
more...
| Supported Version Ranges |
| wireless_controller_log |
v6.2.0 -> 7.6.6 |
- addrgrp_log - Lowest severity level to log address group message. type: str choices: emergency, alert, critical, error, warning, notification, information, debug
more...
|
Supported Version Ranges |
| addrgrp_log |
v6.2.0 -> 7.6.6 |
| [emergency] |
v6.2.0 -> 7.6.6 |
| [alert] |
v6.2.0 -> 7.6.6 |
| [critical] |
v6.2.0 -> 7.6.6 |
| [error] |
v6.2.0 -> 7.6.6 |
| [warning] |
v6.2.0 -> 7.6.6 |
| [notification] |
v6.2.0 -> 7.6.6 |
| [information] |
v6.2.0 -> 7.6.6 |
| [debug] |
v6.2.0 -> 7.6.6 |
- ble_log - Lowest severity level to log BLE detection message. type: str choices: emergency, alert, critical, error, warning, notification, information, debug
more...
|
Supported Version Ranges |
| ble_log |
v6.2.0 -> 7.6.6 |
| [emergency] |
v6.2.0 -> 7.6.6 |
| [alert] |
v6.2.0 -> 7.6.6 |
| [critical] |
v6.2.0 -> 7.6.6 |
| [error] |
v6.2.0 -> 7.6.6 |
| [warning] |
v6.2.0 -> 7.6.6 |
| [notification] |
v6.2.0 -> 7.6.6 |
| [information] |
v6.2.0 -> 7.6.6 |
| [debug] |
v6.2.0 -> 7.6.6 |
- clb_log - Lowest severity level to log client load balancing message. type: str choices: emergency, alert, critical, error, warning, notification, information, debug
more...
|
Supported Version Ranges |
| clb_log |
v6.2.0 -> 7.6.6 |
| [emergency] |
v6.2.0 -> 7.6.6 |
| [alert] |
v6.2.0 -> 7.6.6 |
| [critical] |
v6.2.0 -> 7.6.6 |
| [error] |
v6.2.0 -> 7.6.6 |
| [warning] |
v6.2.0 -> 7.6.6 |
| [notification] |
v6.2.0 -> 7.6.6 |
| [information] |
v6.2.0 -> 7.6.6 |
| [debug] |
v6.2.0 -> 7.6.6 |
- dhcp_starv_log - Lowest severity level to log DHCP starvation event message. type: str choices: emergency, alert, critical, error, warning, notification, information, debug
more...
|
Supported Version Ranges |
| dhcp_starv_log |
v6.2.0 -> 7.6.6 |
| [emergency] |
v6.2.0 -> 7.6.6 |
| [alert] |
v6.2.0 -> 7.6.6 |
| [critical] |
v6.2.0 -> 7.6.6 |
| [error] |
v6.2.0 -> 7.6.6 |
| [warning] |
v6.2.0 -> 7.6.6 |
| [notification] |
v6.2.0 -> 7.6.6 |
| [information] |
v6.2.0 -> 7.6.6 |
| [debug] |
v6.2.0 -> 7.6.6 |
- led_sched_log - Lowest severity level to log LED schedule event message. type: str choices: emergency, alert, critical, error, warning, notification, information, debug
more...
|
Supported Version Ranges |
| led_sched_log |
v6.2.0 -> 7.6.6 |
| [emergency] |
v6.2.0 -> 7.6.6 |
| [alert] |
v6.2.0 -> 7.6.6 |
| [critical] |
v6.2.0 -> 7.6.6 |
| [error] |
v6.2.0 -> 7.6.6 |
| [warning] |
v6.2.0 -> 7.6.6 |
| [notification] |
v6.2.0 -> 7.6.6 |
| [information] |
v6.2.0 -> 7.6.6 |
| [debug] |
v6.2.0 -> 7.6.6 |
- radio_event_log - Lowest severity level to log radio event message. type: str choices: emergency, alert, critical, error, warning, notification, information, debug
more...
|
Supported Version Ranges |
| radio_event_log |
v6.2.0 -> 7.6.6 |
| [emergency] |
v6.2.0 -> 7.6.6 |
| [alert] |
v6.2.0 -> 7.6.6 |
| [critical] |
v6.2.0 -> 7.6.6 |
| [error] |
v6.2.0 -> 7.6.6 |
| [warning] |
v6.2.0 -> 7.6.6 |
| [notification] |
v6.2.0 -> 7.6.6 |
| [information] |
v6.2.0 -> 7.6.6 |
| [debug] |
v6.2.0 -> 7.6.6 |
- rogue_event_log - Lowest severity level to log rogue AP event message. type: str choices: emergency, alert, critical, error, warning, notification, information, debug
more...
|
Supported Version Ranges |
| rogue_event_log |
v6.2.0 -> 7.6.6 |
| [emergency] |
v6.2.0 -> 7.6.6 |
| [alert] |
v6.2.0 -> 7.6.6 |
| [critical] |
v6.2.0 -> 7.6.6 |
| [error] |
v6.2.0 -> 7.6.6 |
| [warning] |
v6.2.0 -> 7.6.6 |
| [notification] |
v6.2.0 -> 7.6.6 |
| [information] |
v6.2.0 -> 7.6.6 |
| [debug] |
v6.2.0 -> 7.6.6 |
- sta_event_log - Lowest severity level to log station event message. type: str choices: emergency, alert, critical, error, warning, notification, information, debug
more...
|
Supported Version Ranges |
| sta_event_log |
v6.2.0 -> 7.6.6 |
| [emergency] |
v6.2.0 -> 7.6.6 |
| [alert] |
v6.2.0 -> 7.6.6 |
| [critical] |
v6.2.0 -> 7.6.6 |
| [error] |
v6.2.0 -> 7.6.6 |
| [warning] |
v6.2.0 -> 7.6.6 |
| [notification] |
v6.2.0 -> 7.6.6 |
| [information] |
v6.2.0 -> 7.6.6 |
| [debug] |
v6.2.0 -> 7.6.6 |
- sta_locate_log - Lowest severity level to log station locate message. type: str choices: emergency, alert, critical, error, warning, notification, information, debug
more...
|
Supported Version Ranges |
| sta_locate_log |
v6.2.0 -> 7.6.6 |
| [emergency] |
v6.2.0 -> 7.6.6 |
| [alert] |
v6.2.0 -> 7.6.6 |
| [critical] |
v6.2.0 -> 7.6.6 |
| [error] |
v6.2.0 -> 7.6.6 |
| [warning] |
v6.2.0 -> 7.6.6 |
| [notification] |
v6.2.0 -> 7.6.6 |
| [information] |
v6.2.0 -> 7.6.6 |
| [debug] |
v6.2.0 -> 7.6.6 |
- status - Enable/disable wireless event logging. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| status |
v6.2.0 -> 7.6.6 |
| [enable] |
v6.2.0 -> 7.6.6 |
| [disable] |
v6.2.0 -> 7.6.6 |
- wids_log - Lowest severity level to log WIDS message. type: str choices: emergency, alert, critical, error, warning, notification, information, debug
more...
|
Supported Version Ranges |
| wids_log |
v6.2.0 -> 7.6.6 |
| [emergency] |
v6.2.0 -> 7.6.6 |
| [alert] |
v6.2.0 -> 7.6.6 |
| [critical] |
v6.2.0 -> 7.6.6 |
| [error] |
v6.2.0 -> 7.6.6 |
| [warning] |
v6.2.0 -> 7.6.6 |
| [notification] |
v6.2.0 -> 7.6.6 |
| [information] |
v6.2.0 -> 7.6.6 |
| [debug] |
v6.2.0 -> 7.6.6 |
- wtp_event_log - Lowest severity level to log WTP event message. type: str choices: emergency, alert, critical, error, warning, notification, information, debug
more...
|
Supported Version Ranges |
| wtp_event_log |
v6.2.0 -> 7.6.6 |
| [emergency] |
v6.2.0 -> 7.6.6 |
| [alert] |
v6.2.0 -> 7.6.6 |
| [critical] |
v6.2.0 -> 7.6.6 |
| [error] |
v6.2.0 -> 7.6.6 |
| [warning] |
v6.2.0 -> 7.6.6 |
| [notification] |
v6.2.0 -> 7.6.6 |
| [information] |
v6.2.0 -> 7.6.6 |
| [debug] |
v6.2.0 -> 7.6.6 |
- wtp_fips_event_log - Lowest severity level to log FAP fips event message. type: str choices: emergency, alert, critical, error, warning, notification, information, debug
more...
|
Supported Version Ranges |
| wtp_fips_event_log |
v7.4.4 -> 7.6.6 |
| [emergency] |
v7.4.4 -> 7.6.6 |
| [alert] |
v7.4.4 -> 7.6.6 |
| [critical] |
v7.4.4 -> 7.6.6 |
| [error] |
v7.4.4 -> 7.6.6 |
| [warning] |
v7.4.4 -> 7.6.6 |
| [notification] |
v7.4.4 -> 7.6.6 |
| [information] |
v7.4.4 -> 7.6.6 |
| [debug] |
v7.4.4 -> 7.6.6 |
Notes
-----
.. note::
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
- The module supports check_mode.
Examples
--------
.. code-block:: yaml+jinja
- name: Configure wireless controller event log filters.
fortinet.fortios.fortios_wireless_controller_log:
vdom: "{{ vdom }}"
wireless_controller_log:
addrgrp_log: "emergency"
ble_log: "emergency"
clb_log: "emergency"
dhcp_starv_log: "emergency"
led_sched_log: "emergency"
radio_event_log: "emergency"
rogue_event_log: "emergency"
sta_event_log: "emergency"
sta_locate_log: "emergency"
status: "enable"
wids_log: "emergency"
wtp_event_log: "emergency"
wtp_fips_event_log: "emergency"
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:
.. raw:: html
- 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
Status
------
- This module is not guaranteed to have a backwards compatible interface.
Authors
-------
- 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.