Skip to content

Latest commit

 

History

History
480 lines (436 loc) · 20.9 KB

fortios_wireless_controller_timers.rst

File metadata and controls

480 lines (436 loc) · 20.9 KB
Raw
source:fortios_wireless_controller_timers.py
orphan:

fortios_wireless_controller_timers -- Configure CAPWAP timers in Fortinet's FortiOS and FortiGate.

.. versionadded:: 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.14

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility


Supported Version Ranges
fortios_wireless_controller_timers v6.0.0 -> latest

Parameters

  • 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_timers - Configure CAPWAP timers. type: dict more...
    Supported Version Ranges
    wireless_controller_timers v6.0.0 -> latest
    • auth_timeout - Time after which a client is considered failed in RADIUS authentication and times out (5 - 30 sec). type: int more...
      Supported Version Ranges
      auth_timeout v7.0.6 -> latest
    • ble_scan_report_intv - Time between running Bluetooth Low Energy (BLE) reports (10 - 3600 sec). type: int more...
      Supported Version Ranges
      ble_scan_report_intv v6.0.0 -> latest
    • client_idle_rehome_timeout - Time after which a client is considered idle and disconnected from the home controller (2 - 3600 sec). type: int more...
      Supported Version Ranges
      client_idle_rehome_timeout v7.2.0 -> latest
    • client_idle_timeout - Time after which a client is considered idle and times out (20 - 3600 sec). type: int more...
      Supported Version Ranges
      client_idle_timeout v6.0.0 -> latest
    • darrp_day - Weekday on which to run DARRP optimization. type: str choices: sunday, monday, tuesday, wednesday, thursday, friday, saturday more...
      Supported Version Ranges
      darrp_day v6.0.0 -> v6.0.11
      [sunday] v6.0.0 -> latest
      [monday] v6.0.0 -> latest
      [tuesday] v6.0.0 -> latest
      [wednesday] v6.0.0 -> latest
      [thursday] v6.0.0 -> latest
      [friday] v6.0.0 -> latest
      [saturday] v6.0.0 -> latest
    • darrp_optimize - Time for running Dynamic Automatic Radio Resource Provisioning (DARRP) optimizations (0 - 86400 sec). type: int more...
      Supported Version Ranges
      darrp_optimize v6.0.0 -> v6.0.11
    • darrp_time - Time at which DARRP optimizations run (you can add up to 8 times). type: list member_path: darrp_time:time more...
      Supported Version Ranges
      darrp_time v6.0.0 -> v6.0.11
      • time - Time. type: str required: true more...
        Supported Version Ranges
        time v6.0.0 -> v6.0.11
    • discovery_interval - Time between discovery requests (2 - 180 sec). type: int more...
      Supported Version Ranges
      discovery_interval v6.0.0 -> latest
    • drma_interval - Dynamic radio mode assignment (DRMA) schedule interval in minutes (10 - 1440). type: int more...
      Supported Version Ranges
      drma_interval v6.4.4 -> latest
    • echo_interval - Time between echo requests sent by the managed WTP, AP, or FortiAP (1 - 255 sec). type: int more...
      Supported Version Ranges
      echo_interval v6.0.0 -> latest
    • fake_ap_log - Time between recording logs about fake APs if periodic fake AP logging is configured (0 - 1440 min). type: int more...
      Supported Version Ranges
      fake_ap_log v6.0.0 -> latest
    • ipsec_intf_cleanup - Time period to keep IPsec VPN interfaces up after WTP sessions are disconnected (30 - 3600 sec). type: int more...
      Supported Version Ranges
      ipsec_intf_cleanup v6.0.0 -> latest
    • radio_stats_interval - Time between running radio reports (1 - 255 sec). type: int more...
      Supported Version Ranges
      radio_stats_interval v6.0.0 -> latest
    • rogue_ap_cleanup - Time period in minutes to keep rogue AP after it is gone . type: int more...
      Supported Version Ranges
      rogue_ap_cleanup v7.0.6 -> latest
    • rogue_ap_log - Time between logging rogue AP messages if periodic rogue AP logging is configured (0 - 1440 min). type: int more...
      Supported Version Ranges
      rogue_ap_log v6.0.0 -> latest
    • sta_capability_interval - Time between running station capability reports (1 - 255 sec). type: int more...
      Supported Version Ranges
      sta_capability_interval v6.0.0 -> latest
    • sta_locate_timer - Time between running client presence flushes to remove clients that are listed but no longer present (0 - 86400 sec). type: int more...
      Supported Version Ranges
      sta_locate_timer v6.0.0 -> latest
    • sta_stats_interval - Time between running client (station) reports (1 - 255 sec). type: int more...
      Supported Version Ranges
      sta_stats_interval v6.0.0 -> latest
    • vap_stats_interval - Time between running Virtual Access Point (VAP) reports (1 - 255 sec). type: int more...
      Supported Version Ranges
      vap_stats_interval v6.0.0 -> latest

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:
          auth_timeout: "5"
          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"
          radio_stats_interval: "15"
          rogue_ap_cleanup: "0"
          rogue_ap_log: "0"
          sta_capability_interval: "30"
          sta_locate_timer: "1800"
          sta_stats_interval: "1"
          vap_stats_interval: "15"

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:

  • 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.