Provide LBS station information with REST API 7.0.2

Location based services (LBS) information of associated and unassociated wireless stations can be retrieved through a REST API.

This feature requires FortiAP 7.0.2 or FortiAP-W2 7.0.2 and later.

Example

In this example, a FortiGate manages two FortiAPs (FAP-231F and FAP-431F).

To configure the FortiAPs:

1. Configure the region on the devices, for example on the FAP-431F:

   config wireless-controller wtp
       edit "FP431FTF20012724"
           set admin enable
           set region "wifi"
           set region-x "0.2514256912442"
           set region-y "0.3601190476190"
           set wtp-profile "FAP431F-default"
           config radio-1
           end
           config radio-2
           end
       next
   end

2. Enable station location in the corresponding WTP profiles, for example on the FAP-431F:

   config wireless-controller wtp-profile
       edit FAP431F-default
           config lbs
               set station-locate enable
           end
       next
   end

3. Enable BLE scanning on the devices:

   config wireless-controller ble-profile
       edit fortiap-discovery
           set ble-scanning enable
       next
   end

4. Add the BLE profile to the WTP profiles, for example on the FAP-431F:

   config wireless-controller wtp-profile
       edit FAP431F-default
           set ble-profile fortiap-discovery
       next
   end

REST APIs

Associated wireless stations:

https://<FortiGate IP>/api/v2/monitor/wifi/client?with_triangulation=true

{
  "http_method": "GET",
  "results": [
    {
      "ip": "10.10.80.2",
      "ip6": [
        "::"
      ],
      "wtp_name": "FP431FTF20012724",
      "wtp_id": "FP431FTF20012724",
      "wtp_radio": 2,
      "wtp_ip": "10.100.100.234",
      "vap_name": "wifi.fap.01",
      "ssid": "wifi-ssid.fap.01",
      "mac": "f8:e4:e3:d8:5e:af",
      "11k_capable": false,
      "11v_capable": false,
      "11r_capable": false,
      "sta_maxrate": 286800,
      "sta_rxrate_mcs": 3,
      "sta_txrate": 48000,
      "sta_txrate_mcs": 0,
      "sta_txrate_score": 16,
      "os": "Debian",
      "hostname": "fosqa-PowerEdge-R210",
      "authentication": "pass",
      "captive_portal_authenticated": 0,
      "manufacturer": "Intel",
      "data_rate_bps": 48000000,
      "data_rxrate_bps": 0,
      "data_txrate_bps": 48000000,
      "snr": 0,
      "idle_time": 0,
      "association_time": 1628812700,
      "bandwidth_tx": 4048,
      "bandwidth_rx": 2314,
      "lan_authenticated": false,
      "channel": 140,
      "signal": 0,
      "vci": "",
      "host": "fosqa-PowerEdge-R210",
      "security": 1,
      "security_str": "captive",
      "encrypt": 1,
      "noise": 0,
      "radio_type": "802.11ax-5G",
      "mimo": "2x2",
      "vlan_id": 0,
      "tx_discard_percentage": 0,
      "tx_retry_percentage": 0,
      "triangulation_regions": [
        {
          "wtp_id": "FP431FTF20012724",
          "rssi": 60,
          "last_seen": 1628781149
        },
        {
          "wtp_id": "FP231FTF20000041",
          "rssi": 66,
          "last_seen": 1628783914
        }
      ],
      "health": {
        "signal_strength": {
          "value": 0,
          "severity": "good"
        },
        "snr": {
          "value": 0,
          "severity": "poor"
        },
        "band": {
          "value": "5ghz",
          "severity": "good"
        },
        "transmission_retry": {
          "value": 0,
          "severity": "good"
        },
        "transmission_discard": {
          "value": 0,
          "severity": "good"
        }
      }
    }
  ],
  "vdom": "vdom1",
  "path": "wifi",
  "name": "client",
  "action": "",
  "status": "success",
  "serial": "FG101FTK20003465",
  "version": "v7.0.2",
  "build": 189
}

Unassociated wireless stations and BLE devices:

https://<FortiGate IP>/api/v2/monitor/wifi/unassociated-devices?with_triangulation=true

{
      ...
      "type":"unassociated device",
      "mac":"00:00:c7:6e:c5:e2",
      "manufacturer":"ARIX CORPORATION",
      "triangulation_regions":[
        {
          "wtp_id":"FP431FTF20012724",
          "rssi":54,
          "last_seen":1628813005
        },
        {
          "wtp_id":"FP231FTF20000041",
          "rssi":50,
          "last_seen":1628812378
        }
      ]
    },
{
      "type":"BLE device",
      "mac":"78:bd:bc:cc:7e:3d",
      "manufacturer":"Samsung",
      "triangulation_regions":[
        {
          "wtp_id":"FP431FTF20012724",
          "rssi":2,
          "last_seen":1628810553
        }
      ]
    },