fortinet.fortios.fortios_wireless_controller_timers module – Configure CAPWAP timers in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.8).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install fortinet.fortios.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_wireless_controller_timers.
New in fortinet.fortios 2.0.0
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 timers 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
Parameters
Parameter |
Comments |
|---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
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. Default: |
|
Configure CAPWAP timers. |
|
Time in minutes to wait before AP reboots when there is no controller detected (5 - 65535). |
|
Time in minutes to wait before AP reboots when there is no controller detected and standalone SSIDs are pushed to the AP in the previous session (5 - 65535). |
|
Time to reboot the AP when there is no controller detected and standalone SSIDs are pushed to the AP in the previous session, format hh :mm. |
|
Time after which a client is considered failed in RADIUS authentication and times out (5 - 30 sec). |
|
Time period in minutes to keep BLE device after it is gone . |
|
Time between running Bluetooth Low Energy (BLE) reports (10 - 3600 sec). |
|
Time after which a client is considered idle and disconnected from the home controller (2 - 3600 sec). |
|
Time after which a client is considered idle and times out (20 - 3600 sec). |
|
Weekday on which to run DARRP optimization. Choices:
|
|
Time for running Dynamic Automatic Radio Resource Provisioning (DARRP) optimizations (0 - 86400 sec). |
|
Time at which DARRP optimizations run (you can add up to 8 times). |
|
Time. |
|
Time between discovery requests (2 - 180 sec). |
|
Dynamic radio mode assignment (DRMA) schedule interval in minutes (10 - 1440). |
|
Time between echo requests sent by the managed WTP, AP, or FortiAP (1 - 255 sec). |
|
Time between recording logs about fake APs if periodic fake AP logging is configured (0 - 1440 min). |
|
Time period to keep IPsec VPN interfaces up after WTP sessions are disconnected (30 - 3600 sec). |
|
Maximal time in seconds between control requests sent by the managed WTP, AP, or FortiAP (0 - 255 sec). |
|
Time between running radio reports (1 - 255 sec). |
|
Time period in minutes to keep rogue AP after it is gone . |
|
Time between logging rogue AP messages if periodic rogue AP logging is configured (0 - 1440 min). |
|
Time period in minutes to keep rogue station after it is gone . |
|
Time period in minutes to keep station capability data after it is gone . |
|
Time between running station capability reports (1 - 255 sec). |
|
Time between running client presence flushes to remove clients that are listed but no longer present (0 - 86400 sec). |
|
Time between running client (station) reports (1 - 255 sec). |
|
Time between running Virtual Access Point (VAP) reports (1 - 255 sec). |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- name: Configure CAPWAP timers.
fortinet.fortios.fortios_wireless_controller_timers:
vdom: "{{ vdom }}"
wireless_controller_timers:
ap_reboot_wait_interval1: "0"
ap_reboot_wait_interval2: "0"
ap_reboot_wait_time: "<your_own_value>"
auth_timeout: "5"
ble_device_cleanup: "60"
ble_scan_report_intv: "30"
client_idle_rehome_timeout: "20"
client_idle_timeout: "300"
darrp_day: "sunday"
darrp_optimize: "43200"
darrp_time:
-
time: "<your_own_value>"
discovery_interval: "5"
drma_interval: "60"
echo_interval: "30"
fake_ap_log: "1"
ipsec_intf_cleanup: "120"
nat_session_keep_alive: "0"
radio_stats_interval: "15"
rogue_ap_cleanup: "0"
rogue_ap_log: "0"
rogue_sta_cleanup: "0"
sta_cap_cleanup: "0"
sta_capability_interval: "30"
sta_locate_timer: "1800"
sta_stats_interval: "10"
vap_stats_interval: "15"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |