lix_fortinet.fortios.fortios_wireless_controller_timers (102.2.120) — module

Configure CAPWAP timers in Fortinet's FortiOS and FortiGate.

| "added in version" 2.0.0 of lix_fortinet.fortios"

Authors: Link Zheng (@chillancezen), Jie Xue (@JieX19), Hongbin Lu (@fgtdev-hblu), Frank Shen (@frankshen01), Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)

preview | supported by community

Install collection

Install with ansible-galaxy collection install lix_fortinet.fortios:==102.2.120


Add to requirements.yml

  collections:
    - name: lix_fortinet.fortios
      version: 102.2.120

Description

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

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure CAPWAP timers.
    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"

Inputs

    
vdom:
    default: root
    description:
    - 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

enable_log:
    default: false
    description:
    - Enable/Disable logging for task.
    required: false
    type: bool

member_path:
    description:
    - 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.
    type: str

access_token:
    description:
    - Token-based authentication. Generated from GUI of Fortigate.
    required: false
    type: str

member_state:
    choices:
    - present
    - absent
    description:
    - Add or delete a member under specified attribute path.
    - When member_state is specified, the state option is ignored.
    type: str

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

Outputs

build:
  description: Build number of the fortigate image
  returned: always
  sample: '1547'
  type: str
http_method:
  description: Last method used to provision the content into FortiGate
  returned: always
  sample: PUT
  type: str
http_status:
  description: Last result given by FortiGate on last operation applied
  returned: always
  sample: '200'
  type: str
mkey:
  description: Master key (id) used in the last call to FortiGate
  returned: success
  sample: id
  type: str
name:
  description: Name of the table used to fulfill the request
  returned: always
  sample: urlfilter
  type: str
path:
  description: Path of the table used to fulfill the request
  returned: always
  sample: webfilter
  type: str
revision:
  description: Internal revision number
  returned: always
  sample: 17.0.2.10658
  type: str
serial:
  description: Serial number of the unit
  returned: always
  sample: FGVMEVYYQT3AB5352
  type: str
status:
  description: Indication of the operation's result
  returned: always
  sample: success
  type: str
vdom:
  description: Virtual domain used
  returned: always
  sample: root
  type: str
version:
  description: Version of the FortiGate
  returned: always
  sample: v5.6.3
  type: str