This is the multi-page printable view of this section. Click here to print.
Open Locate deployment guide
- 1: Overview
- 2: Getting started
- 3: AP testing and verification
- 4: Partner integration
- 5: FAQ
1 - Overview
HPE Aruba Networking Open Locate is an initiative designed to standardize and enhance indoor location services across enterprise environments, aiming to improve the accuracy, flexibility, and interoperability of location-based solutions by leveraging multiple positioning technologies. To ensure seamless integration across various platforms, Open Locate also focuses on enabling the HPE Aruba Networking Access Points to broadcast their location, also known as location coordination information (LCI), through APIs and standardized protocols, including Wi-Fi and Bluetooth Low Energy (BLE). This allows third-party applications and ecosystem partners to leverage real-time location data more effectively, driving innovation in asset tracking, indoor positioning, and other location-based services.
The current landscape of Wi-Fi location solutions requires manual placement of APs on a digitized floor plan for a location-aware infrastructure. This can be time-consuming, resource-intensive, and prone to user error. Open Locate and HPE Aruba Networking Central delivers automatic placement of APs on a floor plan, empowering workplace owners to eliminate operational bottlenecks and enhancing their overall efficiency.
A key component of Wi-Fi-based locationing using the Fine Timing Measurement (802.11mc) protocol, which utilizes time-of-flight techniques to measure distances between access points and devices and enhance location accuracy. Support for FTM was introduced with the Wi-Fi 6 family of APs and is available with all AP models introduced since then. To explore use cases and understand how APs can auto-locate themselves to enable highly accurate indoor positioning using Open Locate, watch Delivering Accurate Indoor Location Services at Scale.
To support automatic AP placement the Central floorplan manager facilitates the seamless placement of APs on the floor plan. The floorplan manager forms the foundational layer by anchoring a digital floor plan to geo-referenced map services thereby automatically scaling the floor plan based on latitude and longitude coordinates.
The floorplan manager with Open Locate functionality is being introduced with New Central and will only be available through that interface.
High-level design
When Fine Time Measurement (FTM) is enabled in a site with HPE Aruba Networking Access Points, the following process takes place -
-
The APs engage in the exchange of FTM information.
-
The APs transmit FTM telemetry to HPE Aruba Networking Central.
-
Central performs detailed calculations to determine the location coordination information (LCI).
-
Central pushes the calculated LCI to the APs.
-
If the Advertise Location feature is enabled, APs can broadcast this information, allowing client devices to perform their own location calculations.
The primary components of Open Locate
Licensing
Open Locate is available to New Central customers using AOS-10 based APs with Foundation and/or Advanced AP licenses. Separate licenses are not required for Open Locate.
| Feature/Service | Foundation | Advanced |
|---|---|---|
| Auto-AP placement | Included | Included |
| Open Locate REST API | Included | Included |
| Open Locate Streaming API | Not included | Included |
For more information on subscription licenses, refer to the licensing documentation.
2 - Getting started
Prerequisites
To successfully auto-place APs on the floor plan, ensure that the following prerequisite categories are met:
Hardware
-
AP auto-placement is supported for 500, 600 & 700 series APs.
-
A minimum of five APs that support FTM functionality are required to facilitate the auto-locate process, utilizing four anchor APs and requiring at least one additional AP for effective auto-placement.
-
The usage of the 6 GHz band for AP-to-AP and STA-to-AP ranging is currently only supported on the AP-605H & AP-615.
Software
-
Support for FTM is introduced with AOS-10 version 10.5.
-
Support for FTM Monitor mode is introduced with AOS-10 version 10.7.1.
-
Minimum AOS-10 version required for auto placing 700 series APs is 10.7.2.
Configuration
-
Ensure that the APs are provisioned and belong to the same AP group and site on HPE Aruba Networking Central.
-
Geo-Locate the floor on the map must be selected when creating a floorplan. For more details on how to scale the floor, refer to Creating Initial Floor and Building.
The knobs to enable FTM functionalities are currently available only in Classic Central, and these adjustments cannot presently be made on the New Central platform.
Operational
-
Confirm that APs can detect neighboring APs to initiate FTM exchanges, a crucial step for accurate auto-locate functionality. For more details on verifying the FTM telemetry, refer to AP Testing and Verification.
-
APs must operate for at least 24 hours to compute auto-locate data efficiently. During this time, APs scan the RF environment, send FTM requests to each other, and transmit telemetry data to Central.
-
During the Open Locate provisioning phase, all APs must be able to operate on an 80 MHz bandwidth channel; currently, the AP-to-AP and STA-to-AP FTM data needed for location determination is most efficiently obtained using 80 MHz channels.
- For environments where using 80 MHz channels in production is not feasible, FTM Monitor mode can be used.
Configuration steps
Open Locate operation requires two levels of configuration.
- Enabling FTM functionality in Classic Central
- Initiating the auto-locate process in New Central
Enabling FTM
Enable the FTM scan and FTM responder modes in Classic Central.
- FTM scan: To enable the FTM scan, follow the steps at Configuring Automatic Placement of an AP.
Checking the Enable Automatic Placement box activates FTM scanning, and configures the APs to handle FTM tasks 25% of the time reserved for off band channel scanning, that is only valid when no clients are connected and hence it takes up to 24-48 hours to collect FTM data if not using FTM Monitor mode.
You can optionally also activate the “Advertise Location” option. This feature integrates location configuration information (LCI) into probe request and FTM response frames. This inclusion of data enables FTM-supported clients to autonomously calculate their own location for various use cases.
Enabling FTM scan mode
- FTM Responder mode: To enable the FTM-responder mode, follow the steps at Configuring Advanced Settings for a WLAN SSID Profile.
Checking the Fine Timing Measurement (802.11 mc) Responder Mode enables FTM capability on the APs and enables FTM communication between APs and stations like phones or laptops.
Enabling FTM responder mode
- Additionally, set 80 MHz channel width: If the deployment does not allow usage of 80 MHz channels, fast forward to FTM Monitor mode configuration.
Otherwise, set the channel bandwidth to 80 MHz by following the steps at Configuring Radio Parameters.
Set the Minimum and Maximum bandwidth to 80 MHz. A wider bandwidth improves FTM exchanges and reduces multipath effects, leading to better accuracy in location-based applications.
Bandwidth configuration on 5 GHz band radio
After completing the above steps, please allow a waiting period of 24 hours, or 48 hours if AirMatch is enabled. For Open Locate functionality to operate effectively, sufficient FTM data is required from APs. Failure to transmit adequate FTM data to the cloud may result in the inability to auto-locate.
The time required to gather the required FTM data is 15-30 mins when FTM Monitor mode is used.
Initiating auto locate
The floorplan manager serves as the starting point for initiating location-aware services within New Central. In this dashboard, site properties, including buildings and floors, can be created, and floor plans can be uploaded and configured. After creating the floors, devices can be assigned to the floors so the system can begin the process of auto-placing the APs. To access and create the floorplan, refer to New Central Floorplan Manager techdocs.
Once the floorplan is ready, we need to assign devices to the floorplan before we auto place the APs.
Assigning devices to floorplans
To assign devices to specific floorplans, complete the steps at Assigning Devices to Floorplan in Floorplan Dashboard.
Automatic AP deployment
To start placing APs automatically on the floorplan, follow the steps at Automatic AP Placement.
FTM monitor mode
FTM Monitor mode activates a special monitor mode on the 5 GHz band. While in FTM Monitor mode, the APs on the specified floor sequentially scan each 80 MHz channel within the 5GHz band to collect FTM ranging data. Once the required inter-AP ranging information is gathered, the APs are returned to their original bandwidth settings. This approach significantly reduces the time required to collect accurate location data, enhancing overall system efficiency in environments where continuous 80 MHz operation isn’t feasible.
FTM Monitor mode is a one-time action for AP auto-placement unless there are any changes in the physical topology of the network. For example, when an AP is added to the topology, the FTM Monitor mode needs to be restarted in order to determine the new AP location and be auto placed.
Prerequisites for utilizing FTM Monitor mode:
-
FTM Monitor mode currently only operates on the 5 GHz radio band. Support for 6 GHz radio is on the roadmap.
-
APs on the given floor-id must be ‘ftm-monitor’ capable, running AOS 10.7.1 or greater.
-
APs must be configured to support FTM and assigned to a floor in New Central.
-
APs on the given floor-id must be configured in the same regulatory domain (ie. configured with the same country code).
-
APs on the given floor must be synchronized with the same NTP server.
Currently, FTM Monitor mode can only be enabled through API and FTM monitor mode can be scheduled to run at a different time.
Configuration
Endpoint: POST https://example-central-server.com/network-monitoring/v1alpha1/sitemaps/{site-id}/floors/{floor-id}/ftm-scans/start
Parameters:
site-id: Site ID where the FTM scan is required.floor-id: Starts an FTM scan for the given floor-id.
The site-id and floor-id can be found by navigating to the floor plan in new Central and inspecting the URL.
Use this feature with caution. Enabling an FTM scan will temporarily disrupt Wi-Fi connectivity on the 5 GHz radio. During the scan, all connected Wi-Fi clients will experience an outage for the duration of the system-calculated scan. Once the scan is complete, the network will automatically restore itself.
Example response of “Start FTM Monitor mode” POST API:
{
"scanStartTime": "2024-12-11T22:17:33.574Z",
"id": "2174534000",
"result": "SUCCESS",
"errorMessage": null
}
Description of the fields in the response:
| Field | Description |
|---|---|
| scanStartTime | Scheduled scan start time, will be 10 minutes after enabling monitor mode. |
| id | Unique system-generated identifier. |
| result | Status of the FTM scan. |
| errorMessage | Error details in the case that a scan could not be scheduled. |
The result returned will be one of the following:
SUCCESS- Scan was successfully created and is now PENDINGFTM_SCAN_ALREADY_ACTIVE- Scan already active on the given floor-id. Only one scan is allowed per floor at any given time. Scan cannot be started.NOT_ENOUGH_APS- There were not enough ftm-monitor enabled APs on the given floor-id. Scan cannot be started.REGULATORY_DOMAIN_MISMATCH- Not all APs are configured with the same country code. Scan cannot be started.NO_VALID_CHANNELS- Based on the user configured country code and channel selections, there are no available channels to run the FTM scan on. Scan cannot be started.ERROR- There was an error starting the scan, see errorMessage for details of the error.
Note down the id provided in the response to check the status using the next API call.
Only one scan can be active on a floor at any time.
Verification
The scan typically takes between 15 to 30 minutes to complete. During this process, the APs sequentially scan each 80 MHz channel within the 5GHz band to collect FTM ranging data. Throughout the scan, all APs operate in monitor mode.
Currently, there is no API to stop the FTM scan once started.
Use the following REST API to verify the scan process.
Endpoint: GET https://example-central-server.com/network-monitoring/v1alpha1/sitemaps/{site-id}/floors/{floor-id}/ftm-scans/{ftm-scan-id}
Parameters:
site-id: Site ID where the FTM scan is required.floor-id: Starts an FTM scan for the given floor-id.ftm-scan-id: Retrieved from the ftm-scan-start API.
Example response of “Status of the FTM Monitor mode” GET API:
{
"total": 1,
"next": null,
"items": [
{
"dwellTimeMillis": 90000,
"updatedAt": "2024-12-11T22:12:32.682Z",
"serialNumbers": [
"CNMSKY0000",
"CNMSKY0000",
"PHPNKY0000",
"PHPNKY0000",
"PHPNKY0000",
"PHPNKYJ000",
"PHPNKYJ000",
"PHPNKYJ000",
"PHPNKYJ000"
],
"errorMessage": null,
"scannedChannels": [
{
"primaryChannelList": [
36,
52,
100,
116,
132,
149
],
"bandwidth": "CHANNEL_BW_80MHZ",
"band": "RADIO_BAND_5GHZ"
}
],
"estimatedCompletionTime": "2024-12-11T22:32:33.574Z",
"floorId": "9f8ba9ee-c866-4654-82b1-xxxxxx",
"siteId": "791830000",
"status": "SCHEDULED",
"scanStartTime": "2024-12-11T22:17:33.574Z",
"id": "2174534000",
"type": "FTM_SCAN",
"createdAt": "2024-12-11T22:12:32.682Z"
}
],
"count": 1
}
Descriptions of the fields in the response:
| Field | Description |
|---|---|
| dwellTimeMillis | The number of milliseconds that the scan spends on each channel to attempt FTM ranging to other nearby APs. |
| updatedAt | Timestamp of the latest ftm scan state change |
| serialNumbers | Serial Numbers of the APs involved in FTM scanning |
| errorMessage | Error message (if applicable). Indicates the reason for the scan failure |
| primaryChannelList | List of all the channels being used for the FTM scans |
| Bandwidth | Channel bandwidth used for the FTM scans |
| Band | Radio used for the FTM scan |
| estimatedCompletionTime | The estimated scan completion time and network restoration |
| floorId | Floor ID of the given floor |
| siteId | Site ID of the given floor |
| status | FTM scan status |
| scanStartTime | Estimated start time of the ftm scan and associated network outage |
| id | Unique system-generated identifier for an ftm scan |
| type | String indicating the document type |
| createdAt | Timestamp of the initial scan request |
The status returned will be one of the following:
Pending: Scan request was accepted and awaiting scheduling by the system.Aborted: Scan request was delayed and could not be scheduled before the calculated start time.Scheduled: Scan request has been scheduled by the system and is awaiting the scan start time.Scanning: Scan is currently running (wifi network connectivity is currently unavailable).Complete: Scan has completed.
Once the FTM Monitor mode scan has completed, proceed with initiating the auto locate process.
3 - AP testing and verification
If there are telemetry or other FTM data issues, navigate to the AP and execute specific show commands to pinpoint the problem.
Verifying AP configuration
To verify that the configuration has been successfully pushed to the AP, run the command show running-config | include FTM. Ensure that both ftm-scan-enable and ftm-responder-enable are present, indicating that FTM is enabled and capable of facilitating FTM exchanges between APs.
Example:
AP-AOS10# show running-config | include ftm
ftm-scan-enable
ftm-responder-enable
Additionally, you can check if the GPS setting is enabled.
AP-AOS10# show running-config
gps
state enable
Analyzing FTM details
To examine FTM data, use the command show ap range scanning-results. This command provides a display of all successful FTM measurements between peer APs within the last 20 minutes. The output includes the following information, which proves useful for debugging the channel:
-
Average RTT: Presented in nanoseconds, to be later converted into meters.
-
Average RSSI: If the RSSI increments, it indicates that the AP is farther away, resulting in higher RTT.
-
Average STD: The standard deviation can indicate the quality of the results.
-
Channel: The AP predominantly selects an 80 MHz channel, which is optimal for accurate FTM. Choosing 80 MHz provides more resolution and better accuracy, making it the recommended option for improved results.
Example:
AP-AOS10# show ap range scanning-results
Ranging results
---------------
Peer-bssid Average RTT Average rssi (dbm) Average std (100ps) Channel Number of valid RTTs Number of FTMs Antenna RTTs/Init-mask/Resp-mask Time Stamp
---------- ----------- ------------------ ------------------- ------- -------------------- -------------- ------- ------------------------ ----------
74:9e:75:41:17:30 69 60 10 36E 15 16 0 69,0,0 69,0,0 69,0,0 69,0,0 68,0,0 66,0,0 69,0,0 69,0,0 70,0,0 70,0,0 70,0,0 70,0,0 69,0,0 70,0,0 68,0,0 2024-03-21 11:47:01
74:9e:75:41:4f:70 114 64 4 36E 16 16 0 114,0,0 113,0,0 113,0,0 114,0,0 114,0,0 114,0,0 114,0,0 113,0,0 113,0,0 114,0,0 114,0,0 114,0,0 114,0,0 114,0,0 113,0,0 114,0,0 2024-03-21 11:47:15
74:9e:75:41:7c:70 137 61 53 36E 15 16 0 127,0,0 141,0,0 141,0,0 138,0,0 139,0,0 140,0,0 139,0,0 126,0,0 141,0,0 140,0,0 126,0,0 140,0,0 141,0,0 140,0,0 138,0,0 2024-03-21 11:47:30
00:4e:35:e9:19:50 146 69 14 36E 13 16 0 147,0,0 145,0,0 144,0,0 144,0,0 145,0,0 144,0,0 144,0,0 146,0,0 147,0,0 147,0,0 147,0,0 147,0,0 147,0,0 2024-03-21 11:48:13
00:4e:35:e9:12:d0 143 64 7 36E 15 16 0 142,0,0 143,0,0 142,0,0 142,0,0 144,0,0 143,0,0 144,0,0 142,0,0 142,0,0 144,0,0 143,0,0 143,0,0 144,0,0 142,0,0 142,0,0 2024-03-21 11:48:27
74:9e:75:41:0e:60 147 71 3 36E 14 16 0 147,0,0 147,0,0 147,0,0 147,0,0 147,0,0 147,0,0 147,0,0 146,0,0 147,0,0 147,0,0 147,0,0 146,0,0 147,0,0 148,0,0 2024-03-21 11:48:39
74:9e:75:41:4f:70 115 66 3 36E 16 16 0 114,0,0 114,0,0 115,0,0 114,0,0 115,0,0 115,0,0 115,0,0 114,0,0 115,0,0 115,0,0 114,0,0 115,0,0 115,0,0 114,0,0 113,0,0 115,0,0 2024-03-21 11:48:56
74:9e:75:41:7c:70 138 62 3 36E 16 16 0 138,0,0 138,0,0 138,0,0 138,0,0 138,0,0 138,0,0 138,0,0 137,0,0 138,0,0 137,0,0 137,0,0 137,0,0 137,0,0 138,0,0 138,0,0 138,0,0 2024-03-21 11:49:11
Total:8
About 20 mins to age out
Reading FTM summary
Run the command show ap range scanning-summary. This command can be used for debugging purposes, it allows you to determine if an AP is rejecting FTM data, providing insights into potential issues within the setup. For instance, if the Fail Scan counter continues to rise or matches the Scan counter, it indicates that the AP is unable to reach or communicate with the neighboring AP indicated by the Peer-bssid.
Example:
AP-AOS10# show ap range scanning-summary
Ranging History
---------------
Peer-bssid Total Scan Fail Scan
---------- ---------- ---------
74:9e:75:41:3d:d0 4877 4800
74:9e:75:41:17:30 9119 637
00:4e:35:e9:12:d0 8930 82
74:9e:75:41:27:20 6467 3289
74:9e:75:41:40:70 5524 4231
74:9e:75:41:4f:70 8838 919
00:4e:35:e9:19:50 8957 798
74:9e:75:41:7c:70 9068 687
74:9e:75:41:0e:60 8522 123
d0:d3:e0:ef:61:50 4914 4844
Total:10
AP-AOS10#
Analyzing FTM history
Use the command show ap range scanning-history, which provides the following fields:
-
Peer-bssid: BSSID of neighboring APs.
-
Last scan result, with possible values:
- 0: Success
- 1: AP driver is engaged in other tasks (busy), which occurs as the AP changes channels and requires time for detection.
- 2: Unreachable target BSSID, indicating a lack of connection with the peer AP.
It is normal to observe occasional failures and achieving a 100% success rate may not always be possible.
Example:
AP-AOS10# show ap range scanning-history
Ranging History
---------------
Peer-bssid Last Scan Result Time Stamp
---------- ---------------- ----------
00:4e:35:e9:12:d0 0 2023-12-17 18:28:18
74:9e:75:41:27:20 0 2023-12-17 18:28:51
74:9e:75:41:3d:d0 0 2023-12-17 18:29:29
d0:d3:e0:ef:61:50 0 2023-12-17 18:30:02
74:9e:75:41:27:20 0 2023-12-17 18:30:33
74:9e:75:41:3d:d0 0 2023-12-17 18:31:06
d0:d3:e0:ef:61:50 0 2023-12-17 18:31:41
74:9e:75:41:0e:60 2 2023-12-17 18:32:08
74:9e:75:41:0e:60 2 2023-12-17 18:32:22
74:9e:75:41:0e:60 0 2023-12-17 18:32:35
d0:d3:e0:ef:61:50 0 2023-12-17 18:49:10
Total:11
For result, 0: success; 1: fail because of driver busy; 2: unreachable target BSSID
Verifying cloud telemetry
Activate the debug log by executing the command debug-log-to-cloud. Subsequently, wait for 5 minutes, as the AP sends the telemetry to the cloud every 5 minutes. Then use the command show log stats-to-cloud ftmscan to confirm that the AP is indeed sending the FTM telemetry. This command enables you to verify details such as the BSSIDs, radios and channels of peer APs, and whether the AP is actively engaging in FTM exchanges, providing additional diagnostic information.
Example:
AP-AOS10# debug-log-to-cloud
AP-AOS10# show log stats-to-cloud ftmscan
2023-12-17 19:07:07 T PeerFTMReport Stats: peer_mac[74:9e:75:41:3d:d0], radio_mac[74:9e:75:41:40:70], channel[124], band[1], bandwidth[1], ftm_avg_rssi[49]
2023-12-17 19:07:07 ... ftm_avg_rtt[73], ftm_min_rtt[70], ftm_max_rtt[74], ftm_std_dev[13], ftm_num_samples[16], ftm_valid_samples[16], chain_mask[0]
2023-12-17 19:07:07 ... time_stamp[1702867028]
2023-12-17 19:07:07 T FTMMeasurement Stats: ftm_rtt[70], init_mask[0], resp_mask[0]
2023-12-17 19:07:07 T FTMMeasurement Stats: ftm_rtt[74], init_mask[0], resp_mask[0]
2023-12-17 19:07:07 T FTMMeasurement Stats: ftm_rtt[74], init_mask[0], resp_mask[0]
2023-12-17 19:07:07 T FTMMeasurement Stats: ftm_rtt[74], init_mask[0], resp_mask[0]
2023-12-17 19:07:07 T PeerFTMReport Stats: peer_mac[00:4e:35:e9:12:d0], radio_mac[74:9e:75:41:40:70], channel[44], band[1], bandwidth[1], ftm_avg_rssi[79]
2023-12-17 19:07:07 ... ftm_avg_rtt[327], ftm_min_rtt[323], ftm_max_rtt[330], ftm_std_dev[21], ftm_num_samples[16], ftm_valid_samples[16], chain_mask[0]
2023-12-17 19:07:07 ... time_stamp[1702867066]
2023-12-17 19:07:07 T FTMMeasurement Stats: ftm_rtt[323], init_mask[0], resp_mask[0]
2023-12-17 19:07:07 T FTMMeasurement Stats: ftm_rtt[330], init_mask[0], resp_mask[0]
2023-12-17 19:07:07 T FTMMeasurement Stats: ftm_rtt[326], init_mask[0], resp_mask[0]
2023-12-17 19:07:07 T FTMMeasurement Stats: ftm_rtt[328], init_mask[0], resp_mask[0]
Verifying GPS telemetry
Confirm the availability of GPS telemetry for the 600 series APs by using the command show ap gps summary. This command displays GPS information on the AP, allowing you to assess whether the AP is obtaining GPS latitude and longitude values. In cases where the AP is situated indoors and may face challenges in acquiring GPS location, checking this information becomes particularly useful for the APs.
Example:
AP-AOS10# sh ap gps summary
GPS Information
---------------
Type Position (Latitude,Longitude) Altitude
---- ------------------------------ --------
$GNGGA 37.385870, -121.987549 34.2 M
$GNRMC 37.385870, -121.987549 N/A
$GNGLL 37.385870, -121.987549 N/A
GPS Configuration
------------------
Current Dynamic Model
---------------------
stationary
AP-AOS10#
This GPS information is only populated for APs that have a GPS receiver.
If you do not observe any FTM or GPS data, ensure that the AP can detect neighboring APs by executing the command show ap monitor ap-list. This command provides a list of AP neighbors and indicates whether the AP is FTM capable or not in the FTM support column at the right most side.
Additionally, validate whether the AP is scanning different channels by using the command show ap arm scan-times.
Example:
AP-AOS10# show ap monitor ap-list
Monitored AP Table
------------------
bssid essid band/chan/ch-width/ht-type ap-type transition-type confirmed dos dt/mt ut/it encr nstas avg-snr curr-snr avg-rssi curr-rssi wmacs ibss cl-delay pathloss bss-color partial bss color bss color disabled FTM support snr/rssi-age snr/rssi-report-age
----- ----- -------------------------- ------- --------------- --------- --- ----- ----- ---- ----- ------- -------- -------- --------- ----- ---- -------- -------- --------- ----------------- ------------------ ----------- ------------ -------------------
74:9e:75:41:0e:60 Open-Locate-Network 5GHz/36E/80MHz/HE valid valid no disable 1280967/1280967 10/9 wpa2-psk-aes 0 25 25 70 70 0 no 0 0 21 false false yes 9 2
74:9e:75:41:40:70 Open-Locate-Network 5GHz/36E/80MHz/HE valid valid yes disable 1280964/1280964 7/6 wpa2-psk-aes 0 12 12 82 83 0 no 256 96 25 false false yes 6 2
00:4e:35:e9:19:50 Open-Locate-Network 5GHz/36E/80MHz/HE valid valid yes disable 1280964/1280964 7/6 wpa2-psk-aes 0 34 34 60 61 0 no 256 76 37 false false yes 6 2
74:9e:75:41:27:20 Open-Locate-Network 5GHz/36E/80MHz/HE valid valid yes disable 1280964/1280964 7/6 wpa2-psk-aes 0 31 31 63 64 0 no 256 75 3 false false yes 6 2
00:4e:35:e9:12:d0 Open-Locate-Network 5GHz/36E/80MHz/HE valid valid yes disable 1280964/1280964 2/1 wpa2-psk-aes 0 32 33 62 62 0 no 256 78 45 false false yes 1 2
74:9e:75:41:3d:d0 Open-Locate-Network 5GHz/36E/80MHz/HE valid valid yes disable 1280952/1280952 7/6 wpa2-psk-aes 0 7 7 87 88 0 no 244 99 26 false false yes 6 2
Additionally, validate whether the AP is scanning different channels by using the command show ap arm scan-times.
AP-AOS10# sh ap arm scan-times
Channel Scan Time
-----------------
channel band assign-time(ms) scans-attempted scans-rejected scans-deferred dos-scans flags timer-tick
------- ---- --------------- --------------- -------------- -------------- --------- ----- ----------
34 5GHz 19580 178 0 0 0 DYp 2261483
36 5GHz 1102671440 3604 0 0 0 DVACLYFETSp 2265270
38 5GHz 182270 1657 0 0 0 DYp 2261857
40 5GHz 377630 3433 0 0 0 DVACUYBPTSJp 2264996
42 5GHz 0 543 1086 0 0 DYp 0
44 5GHz 404030 3673 0 0 0 DVACLYFBTSMp 2265003
46 5GHz 202620 1842 0 0 0 DAYp 2265025
112 5GHz 348370 3167 0 0 0 DACUYXSJp 2265117
116 5GHz 402270 3657 0 0 0 DACLYXSMp 2265126
120 5GHz 402050 3655 0 0 0 DACUYXSJp 2265129
124 5GHz 375320 3412 0 0 0 DACLYXSMp 2265178
128 5GHz 356400 3240 0 0 0 DACUYXSJp 2265182
132 5GHz 365860 3326 0 0 0 DACLYXSMp 2265192
136 5GHz 345840 3144 0 0 0 DACUYXSJp 2265197
140 5GHz 317350 2885 0 0 0 DACLYXSMp 2265210
144 5GHz 345840 3144 0 0 0 DACUYXSp 2265238
149 5GHz 396110 3601 0 0 0 DACLYSp 2265222
153 5GHz 399520 3632 0 0 0 DACUYSJp 2265232
Channel Flags:
D: All-Reg-Domain Channel, C: Reg-Domain Channel, A: Activity Present, Z: Rare Channel
V: Valid, T: Valid 20MHZ Channel, F: Valid 40MHz Channel, P: Valid 40MHZ Channel Pair
E: Valid 80/80+80MHz Channel (First 20M), B: Belongs to valid 80/80+80MHz channel, G: Valid 160MHz Channel (First 20M), Q: Belongs to valid 160MHz channel
O: DOS Channel, K: DOS 40MHz Upper, H: DOS 40MHz Lower
R: Radar detected in last 30 min, X: DFS required, q: Zero Wait DFS, t: Zero Wait DFS Test Mode
N: Split Channel Scan J: Unconventional Scan 40MHz Above, M: Unconventional Scan 40MHz Below, L: Scan Secondary Above
U: Scan Secondary Below, Y: Scan 80MHz, W: Scan 160MHz, b: Out-of-band scan Channel (valid only for dual 5GHz mode)
p: Pooling Preference, S: Transmit Allowed, u: UTB filtered channel, x: Preferred Scan Channel (6GHz Only)
WIF Channel Scanning State.
Current opmode: Default
-----------------------------------------------------
Scan mode channel current-scan-band current-scan-channel last-dos-channel timer-milli-tick next-scan-milli-tick (jitter) scans (Tot:Rej:Eff(%):Last intvl(%))
--------- ------- ----------------- -------------------- ---------------- ---------------- ----------------------------- ------------------------------------
Moderate 36E 5GHz 161E 0 2265270000 2265273560 (166) 192086:2290:98:100
Moderate 6 2.4GHz 8+ 0 2265270000 2265270560 (165) 449753:1:99:100
Default 69S 5GHz 0 0 2265270000 0 (0) 1:0:100:0
UTB filter Info:
------------------
Type Version A1 Version A2 Version A3 Version A4 Channel Spacing
---- ---------- ---------- ---------- ---------- ---------------
BAW 3 3 3 3 50 MHz
UTB filter results:
---------------------
Band selected Last blocked channel
------------- --------------------
6GHz 0
4 - Partner integration
Currently, New Central offers three REST APIs pertaining to Open Locate.
The APIs provided herein are preliminary and intended primarily for early testing purposes. As such, the specifications may undergo modifications and be different in a release version later.
NBAPI for device locations
Endpoint: GET https://example.com/network-monitoring/v1alpha1/devices/with-location?
Parameter: filter=siteId eq ‘012931’
-
This endpoint provides a list of devices with available location data, either in (x/y) coordinates or latitude/longitude or both. Use this endpoint to obtain the count of devices with longitude and latitude values for a given site.
-
The filter requires at least the siteId parameter. Additionally, you can use floorId and buildingId as supported fields for more specific filtering.
-
Using this endpoint, you can easily fetch a list of devices with precise location information, such as latitude and longitude, associated with a specific site. By specifying the site_id, you can focus on devices within a particular building or floor, streamlining your monitoring efforts and enhancing facility management.
{
"data": {
"listConsolidatedDeviceLocationsNBAPI": {
"deviceLocationSummary": {
"deviceLocations": [
{
"id": "CNXXXXXXXX",
"type": "ACCESS_POINT",
"createdAt": "2024-04-16T17:24:44.055Z",
"siteId": "791852196",
"floorId": "adbbb348-3c3f-4043-b10c-c7a01522c57f",
"buildingId": "8270en8z2xiwsljdkqlwi931ue",
"tenantId": "iwpmdowier03qrjasdklweifqiwdjw",
"ipv4": "x.x.x.x",
"ipv6": "",
"mac": "AA:BB:CC:DD:EE:FF",
"model": "AP-535",
"deployment": "Standalone",
"status": "ONLINE",
"consolidatedLocation": {
"source": "ADMIN_SPECIFIED",
"timestamp": "2024-04-24T16:35:09.087Z",
"cartesianCoordinates": {
"unit": "METERS",
"x_position": 4.133599281311035,
"y_position": 53.278629302978516
},
"center": {
"longitude": -121.98750299786495,
"latitude": 37.385833803552615
},
"lciUncertainty": null,
"altitude": null
}
}
],
"count": 1,
"total": 1,
"next": null
}
}
}
}
Retrieve data for all devices with no location on the mentioned site
Endpoint: GET https://example.com/network-monitoring/v1alpha1/devices/without-location?
Parameter: filter=siteId eq ‘012931’
-
Utilize this endpoint to retrieve a list of devices lacking location data for a specified site.
-
The filter requires at least the siteId parameter. Additionally, you can use floorId and buildingId as supported fields for more specific filtering.
-
This endpoint is particularly useful for users troubleshooting issues related to devices without location information on a given site.
{
"data": {
"listConsolidatedDeviceLocationsNBAPI": {
"deviceLocationSummary": {
"deviceLocations": [
{
"id": "CNXXXXXXX",
"type": "GATEWAY",
"createdAt": "2024-04-19T20:27:53.566Z",
"siteId": "791852196",
"floorId": null,
"buildingId": null,
"tenantId": "416bc832bc6111ed961e6aa14dbf31f1",
"ipv4": "172.30.32.21",
"ipv6": "",
"mac": "AA:BB:CC:DD:EE:FF",
"model": "A7008",
"deployment": "Cluster",
"status": "ONLINE",
"consolidatedLocation": null
}
],
"count": 1,
"total": 1,
"next": null
}
}
}
}
Retrieve data for a particular device using serial number
Endpoint: GET https://cnx-apigw-internal2.central.arubanetworks.com/network-monitoring/v1alpha1/devices/<SERIAL>/location?siteId=<siteId>
-
Utilize this endpoint to retrieve data for a particular device.
-
This endpoint is particularly useful for users troubleshooting issues related to devices without location information on a given site.
{
"data": {
"getDeviceLocationDetails": {
"id": "CNXXXXXXX",
"type": "ACCESS_POINT",
"createdAt": "2024-04-28T16:06:15.403Z",
"siteId": "791852196",
"floorId": "adbbb348-3c3f-4043-b10c-c7a01522c57f",
"buildingId": "7695ba72-8663-474d-8979-bb567e9cf83d",
"tenantId": "416bc832bc6111ed961e6aa14dbf31f1",
"ipv4": "10.1.1.1",
"ipv6": "",
"mac": "AA:BB:CC:DD:EE:FF",
"model": "AP-635",
"deployment": "Standalone",
"status": "ONLINE",
"gpsLocation": null,
"autoPlacedLocation": null,
"adminSpecifiedLocation": {
"source": "ADMIN_SPECIFIED",
"timestamp": "2024-04-24T16:35:09.087Z",
"cartesianCoordinates": {
"unit": "METERS",
"x_position": 4.133599281311035,
"y_position": 53.278629302978516
},
"center": {
"longitude": -121.98750299786495,
"latitude": 37.385833803552615
},
"lciUncertainty": null,
"altitude": null
},
"consolidatedLocation": {
"source": "ADMIN_SPECIFIED",
"timestamp": "2024-04-24T16:35:09.087Z",
"cartesianCoordinates": {
"unit": "METERS",
"x_position": 4.133599281311035,
"y_position": 53.278629302978516
},
"center": {
"longitude": -121.98750299786495,
"latitude": 37.385833803552615
},
"lciUncertainty": null,
"altitude": null
}
}
}
}
5 - FAQ
- Are GPS enabled APs required for AP auto placement?
-
No, GPS enabled APs are not a requirement. AP auto placement can be achieved using FTM.
- Is AP auto placement possible with 500 series APs?
-
500 series APs can be auto-placed on a floor plan. The integrated FTM radio in the AP helps to facilitate auto-locate. With the use of the Central floorplan manager and the anchor APs, 500 series APs can be auto-placed on a floorplan.
- Will GPS enabled Anchor APs be automatically placed on the floor plan?
-
Currently, floorplan manager does not automatically place Anchor APs with GPS on floor plan.
- Does my Central account need to be allow listed, to try open locate?
-
No additional allow list is required other than access to New Central.
- How does the system auto place the APs on the correct floor?
-
The user must manually assign the APs to the appropriate floor.
- Does FTM work on a 6 GHz band?
-
That depends on the AP model. Currently AP-605H & AP-615 support AP-to-AP and STA-to-AP, with support for the 700 series APs coming soon.
- Why is 80 MHz wide channel required for AP auto placement?
-
An 80MHz wide channel is essential because larger bandwidth enables efficient exchange of AP-to-AP or STA-to-AP FTM data, ensuring optimal performance and reliability.
- How long does data collection take with FTM monitor mode?
-
FTM monitor mode takes between 15 – 30 minutes to gather the FTM data required for AP auto-placement.
- Will FTM monitor mode disrupt Wi-Fi connectivity?
-
Enabling an FTM scan will temporarily disrupt Wi-Fi connectivity on the 5 GHz radio. During the scan, all connected Wi-Fi clients will experience an outage for the duration of the system-calculated scan. Once the scan is complete, the network will automatically restore connectivity.
- Does an FTM Monitor mode scan need to be rerun after adding new APs to the floor plan?
-
Yes. However, if an AP is deleted, rerunning the FTM Monitor mode is not necessary, but the deleted AP should be unassigned from the floor plan.