fmgd_wireless_timers – Configure CAPWAP timers.
Added 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 v7.x.
Requirements
The below requirements are needed on the host that executes this module.
ansible-core>=2.16.0
FortiManager Version Compatibility
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> 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
- device - The parameter in requested url type: str required: true
- wireless_timers - Configure CAPWAP timers. type: dict
- ap_reboot_wait_interval1 (Alias name: ap-reboot-wait-interval1) Time in minutes to wait before ap reboots when there is no controller detected (5 - 65535, default = 0, 0 for no reboot). type: int more...
- ap_reboot_wait_interval2 (Alias name: ap-reboot-wait-interval2) 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, default = 0, 0 for no reboot). type: int more...
- ap_reboot_wait_time (Alias name: ap-reboot-wait-time) 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. type: str more...
- auth_timeout (Alias name: auth-timeout) Time after which a client is considered failed in radius authentication and times out (5 - 30 sec, default = 5). type: int more...
- ble_device_cleanup (Alias name: ble-device-cleanup) Time period in minutes to keep ble device after it is gone (default = 60). type: int more...
- ble_scan_report_intv (Alias name: ble-scan-report-intv) Time between running bluetooth low energy (ble) reports (10 - 3600 sec, default = 30). type: int more...
- client_idle_rehome_timeout (Alias name: client-idle-rehome-timeout) Time after which a client is considered idle and disconnected from the home controller (2 - 3600 sec, default = 20, 0 for no timeout). type: int more...
- client_idle_timeout (Alias name: client-idle-timeout) Time after which a client is considered idle and times out (20 - 3600 sec, default = 300, 0 for no timeout). type: int more...
- discovery_interval (Alias name: discovery-interval) Time between discovery requests (2 - 180 sec, default = 5). type: int more...
- drma_interval (Alias name: drma-interval) Dynamic radio mode assignment (drma) schedule interval in minutes (10 - 1440, default = 60). type: int more...
- echo_interval (Alias name: echo-interval) Time between echo requests sent by the managed wtp, ap, or fortiap (1 - 255 sec, default = 30). type: int more...
- fake_ap_log (Alias name: fake-ap-log) Time between recording logs about fake aps if periodic fake ap logging is configured (0 - 1440 min, default = 1). type: int more...
- ipsec_intf_cleanup (Alias name: ipsec-intf-cleanup) Time period to keep ipsec vpn interfaces up after wtp sessions are disconnected (30 - 3600 sec, default = 120). type: int more...
- nat_session_keep_alive (Alias name: nat-session-keep-alive) Maximal time in seconds between control requests sent by the managed wtp, ap, or fortiap (0 - 255 sec, default = 0). type: int more...
- radio_stats_interval (Alias name: radio-stats-interval) Time between running radio reports (1 - 255 sec, default = 15). type: int more...
- rogue_ap_cleanup (Alias name: rogue-ap-cleanup) Time period in minutes to keep rogue ap after it is gone (default = 0). type: int more...
- rogue_ap_log (Alias name: rogue-ap-log) Time between logging rogue ap messages if periodic rogue ap logging is configured (0 - 1440 min, default = 0). type: int more...
- rogue_sta_cleanup (Alias name: rogue-sta-cleanup) Time period in minutes to keep rogue station after it is gone (default = 0). type: int more...
- sta_cap_cleanup (Alias name: sta-cap-cleanup) Time period in minutes to keep station capability data after it is gone (default = 0). type: int more...
- sta_capability_interval (Alias name: sta-capability-interval) Time between running station capability reports (1 - 255 sec, default = 30). type: int more...
- sta_locate_timer (Alias name: sta-locate-timer) Time between running client presence flushes to remove clients that are listed but no longer present (0 - 86400 sec, default = 1800). type: int more...
- sta_stats_interval (Alias name: sta-stats-interval) Time between running client (station) reports (1 - 255 sec, default = 10). type: int more...
- vap_stats_interval (Alias name: vap-stats-interval) Time between running virtual access point (vap) reports (1 - 255 sec, default = 15). type: int more...
- wids_entry_cleanup (Alias name: wids-entry-cleanup) Time period in minutes to keep wids entry after it is gone (default = 0). type: int more...
- sta_offline_cleanup (Alias name: sta-offline-cleanup) Time period in seconds to keep station offline data after it is gone (default = 300). type: int more...
- sta_offline_ip2mac_cleanup (Alias name: sta-offline-ip2mac-cleanup) Time period in seconds to keep station offline ip2mac data after it is gone (default = 300). type: int 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
gather_facts: false
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure CAPWAP timers.
fortinet.fmgdevice.fmgd_wireless_timers:
# bypass_validation: false
# workspace_locking_adom: <global or your adom name>
# workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
device: <your own value>
wireless_timers:
# ap_reboot_wait_interval1: <integer>
# ap_reboot_wait_interval2: <integer>
# ap_reboot_wait_time: <string>
# auth_timeout: <integer>
# ble_device_cleanup: <integer>
# ble_scan_report_intv: <integer>
# client_idle_rehome_timeout: <integer>
# client_idle_timeout: <integer>
# discovery_interval: <integer>
# drma_interval: <integer>
# echo_interval: <integer>
# fake_ap_log: <integer>
# ipsec_intf_cleanup: <integer>
# nat_session_keep_alive: <integer>
# radio_stats_interval: <integer>
# rogue_ap_cleanup: <integer>
# rogue_ap_log: <integer>
# rogue_sta_cleanup: <integer>
# sta_cap_cleanup: <integer>
# sta_capability_interval: <integer>
# sta_locate_timer: <integer>
# sta_stats_interval: <integer>
# vap_stats_interval: <integer>
# wids_entry_cleanup: <integer>
# sta_offline_cleanup: <integer>
# sta_offline_ip2mac_cleanup: <integer>
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.