FortiWiFi and FortiAP Configuration Guide

What's new in this release
Introduction
Getting started with FortiAP management
- Configuring the FortiGate interface to manage FortiAP units
- Discovering, authorizing, and deauthorizing FortiAP units
- FortiAP diagnostics and tools
- Setting up a mesh connection between FortiAP units
- Data channel security: clear-text, DTLS, and IPsec VPN
Wireless network configuration
- Wireless network configuration tasks
- Setting your geographic location
- Configuring the network interface for the AP unit
- Creating a FortiAP profile
- Defining a wireless network interface (SSID)
  - Changing SSID to VDOM only
  - Airtime fairness
- Configuring security
  - WPA2 Security
    - Configuring WPA2-Personal security
    - Configuring WPA2-Enterprise SSID
  - WPA3 Security
    - Generating SAE-PK private key and password
  - MPSK profiles
  - Captive Portal Security
  - Adding a MAC filter
  - Limiting the number of clients
  - Enabling multicast enhancement
  - Replacing WiFi certificate
  - Configuring WiFi with WSSO using Windows NPS and user groups
  - Enabling Beacon Protection
- Defining SSID groups
- Configuring dynamic user VLAN assignment
  - VLAN assignment by RADIUS
  - VLAN assignment by Name Tag
  - VLAN assignment by FortiAP group
  - VLAN assignment by VLAN pool
- Configuring wireless NAC support
- Configuring user authentication
  - WPA2 and WPA3 Enterprise authentication
    - Custom RADIUS NAS-ID
  - WiFi single sign-on (WSSO) authentication
  - Assigning WiFi users to VLANs dynamically
  - MAC-based authentication
  - User self-registration of MPSKs through FortiGuest
  - Authenticating guest WiFi users
  - Configuring 802.1X supplicant on LAN
  - Configure NAS-Filter-Rule attribute to set up dACL
- Configuring firewall policies for the SSID
- Configuring the built-in access point on a FortiWiFi unit
- Enforcing UTM policies on a local bridge SSID
- Configuring a Syslog profile
- Understanding Distributed Radio Resource Provisioning
  - Configuring Distributed Radio Resource Provisioning
- Translating WiFi QoS WMM marking to DSCP values
- Configuring Layer 3 roaming
  - Configuring L3 Roaming for Tunnel Mode SSIDs
  - Configuring L3 Roaming for Bridge Mode SSIDs
- Advanced Wireless Features
  - Operations Profiles Entry
  - Connectivity Profiles Entry
  - Protection Profiles Entry
  - Advanced SSID options
  - Advanced WiFi Settings options
- Configuring UNII-4 5GHz radio bands
- Configuring Agile Multiband Operation
Access point configuration
- Network topology of managed APs
- Discovery and authorization of APs
- Register a FortiAP to FortiCloud
- FortiAP CLI access
- FortiAP Configuration mode
- FortiAP unit firmware upgrade
- Advanced WiFi controller discovery
  - Configure automatic AP reboot
- Wireless client load balancing for high-density deployments
- FortiAP groups
- LAN port options
  - MAC Authentication for LAN port hosts
- LAN port aggregation and redundancy
  - LAN port uplink redundancy without LACP
- CAPWAP
- LED options
- Configure FortiAP MIMO values
- Configure Fortinet external antenna parameters for specific FortiAPs
- Configure third-party antennas in select FortiAP models
- Configure FortiAP USB port status
Wireless mesh configuration
- Configuring a meshed WiFi network
- Configuring a point-to-point bridge
Hotspot 2.0 ANQP configuration
- Configuring OpenRoaming on FortiAP
Wireless network with wired LAN configuration
- How to configure a FortiAP local bridge (private cloud-managed AP)
- How to increase the number of supported FortiAPs
- How to implement multi-processing for large-scale FortiAP management
Remote WLAN FortiAPs
Features for high-density deployments
Wireless network protection
- Wireless Intrusion Detection System
- WiFi data channel encryption
- Protected Management Frames and Opportunistic Key Caching support
- Preventing local bridge traffic from reaching the LAN
- FortiAP-S and FortiAP-U bridge mode security profiles
- DHCP snooping and option-82 data insertion
- DHCP address enforcement
- Disabling FortiAP port access
- Suppressing phishing SSID
Wireless network monitoring
- Monitoring wireless health and clients
- Monitoring rogue APs
- Suppressing rogue APs
- Monitoring wireless clients
- Monitoring wireless clients over IPv6 traffic
- Monitoring application usage for clients connected to bridge mode SSIDs
- Monitoring FortiAP with SNMP
- Monitoring FortiAP temperatures
- Enabling spectrum analysis
- Disable dedicated scanning on FortiAP F-Series profiles
- Enabling AP scan channel lists to optimize foreground scanning
- Optimizing memory storage by limiting monitoring data
Wireless network examples
- Basic wireless network example
- Wireless network example with FortiSwitch
- Complex wireless network example
- FortiGate WiFi controller 1+1 fast failover example
- CAPWAP hitless failover using FGCP
- Wireless network with segregated WLAN traffic
FortiWiFi unit as a wireless client
- Configuring a FortiWiFi unit as a wireless client
- Enabling EAP/TLS authentication on a FortiWiFi unit in client mode
- Configuring WPA3 security modes on FortiWiFi units operating in client mode
WiFi maps
Bluetooth Low Energy scan
- Pole Star NAO Cloud service integration
- Eddystone BLE beacon profile integration
Location-based services
- Configuring location tracking
- Viewing device location data on a FortiGate unit
- Configuring FortiPresence
Support for Electronic Shelf Label systems
Troubleshooting
- FortiAP shell command
- Signal strength issues
- Throughput issues
- Client connection issues
- FortiAP connection issues
- Testing wireless network health with SAM
- Determining the coverage area of a FortiAP
- Best practices for OSI common sources of wireless issues
- Extended logging
- Packet sniffer
- Debug commands
- Disabling 802.11d for client backward compatibility
FortiAP CLI configuration and diagnostics commands
FortiAP API
Change log

Home FortiAP / FortiWiFi 7.6.0 FortiWiFi and FortiAP Configuration Guide

7.6.0

FortiAP API

FortiAP-S and FortiAP-W2 version 6.2.0 and later support REST API calls that allow you to see device information, apply configurations, reboot your devices, and more.

You can access the host at https://<FAP-IP> where <FAP-IP> is the IP address of the FortiAP.

API Schema and documentation

To see the full FortiAP API schema, you will need a Fortinet Developer Network account.

Once you have an account, you can access the FortiAP API documentation.

The following REST API calls are supported:

REST API call	HTTP	Path	Description
cfg-get	GET	/api/v1/cfg-get	List effective FortiAP variables. To filter for specific parameters: /api/v1/cfg-get?names=parameter-name Examples: Get WTP_NAME: /api/v1/cfg-get?names=WTP_NAME Get WTP_NAME and ADMIN_TIMEOUT: /api/v1/cfg-get?names=WTP_NAME,ADMIN_TIMEOUT
cfg-meta-get	GET	/api/v1/cfg-meta-get	List all variables.
cfg-set	POST	/api/v1/cfg-set	Add or change variables.
logincheck	POST	/logincheck	Log in to FortiAP with/without a password.
logout	POST	/logout	Log out from FortiAP.
radio-cfg	GET	/api/v1/radio-cfg	Get current radios configuration parameters of the control plane. To get specific radio configuration parameters of the control plane: rcfg info from radio 0: /api/v1/radio-cfg?rId=0 rcfg info from radio 1: /api/v1/radio-cfg?rId=1
reboot	POST	/api/v1/reboot	Reboot FortiAP.
sys-perf	GET	/api/v1/sys-perf	Get system performance values (CPU, memory).
sys-status	GET	/api/v1/sys-status	Get system status (`fap-get-status`).
vap-cfg	GET	/api/v1/vap-cfg	Get current SSIDs of the control plane. To get the current SSIDs for each independent radios: vcfg info from radio 0: /api/v1/vap-cfg?rId=0 vcfg info from radio-1: /api/v1/vap-cfg?rId=1 To get specific SSIDs from specific radios: wlan 0 vcfg info from radio 0: /api/v1/vap-cfg?rId=0&wId=0 wlan 1 vcfg info from radio 0: /api/v1/vap-cfg?rId=0&wId=1
wtp-cfg	GET	/api/v1/wtp-cfg	Get current FortiAP configuration parameters of the control plane.

Example request

https://<FAP-IP>/api/v1/sys-perf

Example response

 "cpu_usage": 1,

 "memory_usage": 60

Enable API for Location Based Services station info

You can retrieve Location Based Services (LBS) information of associated and unassociated wireless stations through the FortiOS REST API. To enable this feature, configure the following:

Configure the region on a managed FortiAP:

config wireless-controller wtp

edit "FP431FTF20012724"

set uuid 882b4410-fac9-51eb-ab55-520bdbb17d52

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
Enable station-location in an applied profile:

FortiGate-101F (vdom1) # config wireless-controller wtp-profile

FortiGate-101F (wtp-profile) # ed FAP431F-default

FortiGate-101F (FAP431F-default) # config lbs

FortiGate-101F (lbs) # set station-locate enable

FortiGate-101F (lbs) # end

FortiGate-101F (FAP431F-default) # end

FortiGate-101F (vdom1) #
Enable ble-scanning to detect BLE devices, if needed:

FortiGate-101F (vdom1) # config wireless-controller ble-profile

FortiGate-101F (ble-profile) # edit fortiap-discovery

FortiGate-101F (fortiap-discovery) # set ble-scanning enable

FortiGate-101F (fortiap-discovery) # en

FortiGate-101F (vdom1) #

FortiGate-101F (vdom1) # config wireless-controller wtp-profile

FortiGate-101F (wtp-profile) # ed FAP431F-default

FortiGate-101F (FAP431F-default) # set ble-profile fortiap-discovery

FortiGate-101F (FAP431F-default) # end

FortiGate-101F (vdom1) #

FortiAP API

FortiAP-S and FortiAP-W2 version 6.2.0 and later support REST API calls that allow you to see device information, apply configurations, reboot your devices, and more.

You can access the host at https://<FAP-IP> where <FAP-IP> is the IP address of the FortiAP.

API Schema and documentation

To see the full FortiAP API schema, you will need a Fortinet Developer Network account.

Once you have an account, you can access the FortiAP API documentation.

The following REST API calls are supported:

REST API call	HTTP	Path	Description
cfg-get	GET	/api/v1/cfg-get	List effective FortiAP variables. To filter for specific parameters: /api/v1/cfg-get?names=parameter-name Examples: Get WTP_NAME: /api/v1/cfg-get?names=WTP_NAME Get WTP_NAME and ADMIN_TIMEOUT: /api/v1/cfg-get?names=WTP_NAME,ADMIN_TIMEOUT
cfg-meta-get	GET	/api/v1/cfg-meta-get	List all variables.
cfg-set	POST	/api/v1/cfg-set	Add or change variables.
logincheck	POST	/logincheck	Log in to FortiAP with/without a password.
logout	POST	/logout	Log out from FortiAP.
radio-cfg	GET	/api/v1/radio-cfg	Get current radios configuration parameters of the control plane. To get specific radio configuration parameters of the control plane: rcfg info from radio 0: /api/v1/radio-cfg?rId=0 rcfg info from radio 1: /api/v1/radio-cfg?rId=1
reboot	POST	/api/v1/reboot	Reboot FortiAP.
sys-perf	GET	/api/v1/sys-perf	Get system performance values (CPU, memory).
sys-status	GET	/api/v1/sys-status	Get system status (`fap-get-status`).
vap-cfg	GET	/api/v1/vap-cfg	Get current SSIDs of the control plane. To get the current SSIDs for each independent radios: vcfg info from radio 0: /api/v1/vap-cfg?rId=0 vcfg info from radio-1: /api/v1/vap-cfg?rId=1 To get specific SSIDs from specific radios: wlan 0 vcfg info from radio 0: /api/v1/vap-cfg?rId=0&wId=0 wlan 1 vcfg info from radio 0: /api/v1/vap-cfg?rId=0&wId=1
wtp-cfg	GET	/api/v1/wtp-cfg	Get current FortiAP configuration parameters of the control plane.

Example request

https://<FAP-IP>/api/v1/sys-perf

Example response

 "cpu_usage": 1,

 "memory_usage": 60

Enable API for Location Based Services station info

You can retrieve Location Based Services (LBS) information of associated and unassociated wireless stations through the FortiOS REST API. To enable this feature, configure the following:

Configure the region on a managed FortiAP:

config wireless-controller wtp

edit "FP431FTF20012724"

set uuid 882b4410-fac9-51eb-ab55-520bdbb17d52

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
Enable station-location in an applied profile:

FortiGate-101F (vdom1) # config wireless-controller wtp-profile

FortiGate-101F (wtp-profile) # ed FAP431F-default

FortiGate-101F (FAP431F-default) # config lbs

FortiGate-101F (lbs) # set station-locate enable

FortiGate-101F (lbs) # end

FortiGate-101F (FAP431F-default) # end

FortiGate-101F (vdom1) #
Enable ble-scanning to detect BLE devices, if needed:

FortiGate-101F (vdom1) # config wireless-controller ble-profile

FortiGate-101F (ble-profile) # edit fortiap-discovery

FortiGate-101F (fortiap-discovery) # set ble-scanning enable

FortiGate-101F (fortiap-discovery) # en

FortiGate-101F (vdom1) #

FortiGate-101F (vdom1) # config wireless-controller wtp-profile

FortiGate-101F (wtp-profile) # ed FAP431F-default

FortiGate-101F (FAP431F-default) # set ble-profile fortiap-discovery

FortiGate-101F (FAP431F-default) # end

FortiGate-101F (vdom1) #

Secure Networking

Hybrid Mesh Firewall

NOC Management

LAN

WAN

Unified SASE

Single Vendor SASE

Cloud Network Security

Secure Endpoint Connectivity

Web Application / API Protection

Security Operations

Security Operations Automation

Identity

Early Detection & Prevention

Secure Networking

Hybrid Mesh Firewall

NOC Management

LAN

WAN

Communication & Surveillance

Unified SASE

Single Vendor SASE

Secure Endpoint Connectivity

Cloud Network Security

Cloud-Native Security

Web Application / API Protection

Security Operations

Security Operations Automation

Endpoint

Data Protection

Identity

Email

Early Detection & Prevention

Expert Services

Edge Firewall

Orchestration & management

SD Branch

Application Delivery

Single Vendor SASE

Secure Endpoint Connectivity

Secure Private Access

Thin Edge

Identity

Application Gateway

Enterprise Asset Management

Endpoint Agent

Agentless Security Posture

Identity

Wireless

Switching

Identity

Privilege Acccess Management

Next Generation Firewall

Orchestration & management

Expert Services

All

All

Account Management

SAAS Management

SAAS Application Security

Managed Services

Platform as a service (PAAS)

Other SAAS Services

4D Pillars

Cloud

Popular Solutions

FortiWiFi and FortiAP Configuration Guide

FortiAP API

FortiAP API

API Schema and documentation

Example request

Example response

Enable API for Location Based Services station info

More Links

FortiAP API

FortiAP API

API Schema and documentation

Example request

Example response

Enable API for Location Based Services station info