ansible.builtin.fortios_wireless_controller_timers (v2.9.27) — module

Install Ansible via pip

Install with pip install ansible==2.9.27

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

Requirements

• fortiosapi>=0.9.8

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
   ssl_verify: "False"
  tasks:
  - name: Configure CAPWAP timers.
    fortios_wireless_controller_timers:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      wireless_controller_timers:
        ble_scan_report_intv: "3"
        client_idle_timeout: "4"
        darrp_day: "sunday"
        darrp_optimize: "6"
        darrp_time:
         -
            time: "<your_own_value>"
        discovery_interval: "9"
        echo_interval: "10"
        fake_ap_log: "11"
        ipsec_intf_cleanup: "12"
        radio_stats_interval: "13"
        rogue_ap_log: "14"
        sta_capability_interval: "15"
        sta_locate_timer: "16"
        sta_stats_interval: "17"
        vap_stats_interval: "18"

Inputs

    
host:
    description:
    - FortiOS or FortiGate IP address.
    required: false
    type: str

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

https:
    default: true
    description:
    - Indicates if the requests towards FortiGate must use HTTPS protocol.
    type: bool

password:
    default: ''
    description:
    - FortiOS or FortiGate password.
    type: str

username:
    description:
    - FortiOS or FortiGate username.
    required: false
    type: str

ssl_verify:
    default: true
    description:
    - Ensures FortiGate certificate must be verified by a proper CA.
    type: bool

wireless_controller_timers:
    default: null
    description:
    - Configure CAPWAP timers.
    suboptions:
      ble_scan_report_intv:
        description:
        - Time between running Bluetooth Low Energy (BLE) reports (10 - 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).
        suboptions:
          time:
            description:
            - Time.
            required: true
            type: str
        type: list
      discovery_interval:
        description:
        - Time between discovery requests (2 - 180 sec).
        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_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