UniFi Controller V5 UG PDF

Enterprise System Controller
Release Version: 5.0.6
UniFi Controller User Guide
Table of Contents
Table of Contents
Chapter 1: Software Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Network Topology Requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Software Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Chapter 2: UniFi Cloud. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
UniFi Cloud Key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
UniFi Cloud Account. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Chapter 3: Using the UniFi Controller Software. . . . . . . . . . . . . . . . . . . . .
17
Navigation Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Common Interface Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Chapter 4: Dashboard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
39
Latency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Throughput. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
WAN. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
LAN. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
WLAN. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Download Throughput & Latency. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Upload Throughput & Latency. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Devices on 2.4 GHz Channel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Devices on 5 GHz Channel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Deep Packet Inspection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Chapter 5: Map. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
45
Adding Custom Maps. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .45

Adding a Google Map. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Placing Devices on the Map. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Map Display Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Setting the Map Scale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Chapter 6: Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
51
All. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Gateway/Switches. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
APs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Phones. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Ubiquiti Networks, Inc.
Table of Contents
Chapter 7: Clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
59
All. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Wireless. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Wired. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Chapter 8: Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
63
Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Traffic Stats. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Chapter 9: Insights . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
67
Known Clients. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Neighboring Access Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Past Connections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Past Guest Authorizations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Switch Stats. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Port Forward Stats. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Dynamic DNS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Remote User VPN. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
AC-EDU Streams. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Chapter 10: UniFi Security Gateway Details . . . . . . . . . . . . . . . . . . . . . . . .
77
Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
UniFi Security Gateway Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
UniFi Security Gateway Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
UniFi Security Gateway Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Chapter 11: UniFi Switch Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
85
Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
UniFi Switch Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
UniFi Switch Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Mirroring. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
UniFi Switch Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Chapter 12: UniFi Access Point Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
95
Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
UniFi Access Point Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
UniFi Access Point Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
UniFi Access Point Guests. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
UniFi Access Point Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Chapter 13: UniFi VoIP Phone Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
UniFi VoIP Phone Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
UniFi VoIP Phone Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
ii
Table of Contents
Chapter 14: Client Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
Wireless Client Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
Wireless Client Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
Wireless Client History. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
Wireless Client Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Wired Client Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Wired Client Statistics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Wired Client History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Wired Client Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Chapter 15: Hotspot Manager. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

Guests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Payments and Transactions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Vouchers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Operator Accounts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
Appendix A: Portal Customization with LegacyJSP. . . . . . . . . . . . . . . . . 117

Before You Begin. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Configuring Portal Customization. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Viewing the Default Portal. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Setup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Appendix B: UniFi Discovery Utility. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
Launching the UniFi Discovery Utility. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
UniFi Discovery Utility Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
Appendix C: UniFi Mobile App. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125

Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
Basic Setup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
Controller Mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
Appendix D: UniFi EDU MobileApp. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
Broadcast. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
Schedule. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
Recordings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
Volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
iii
Table of Contents
Appendix E: Controller Scenarios. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
Hosting Controller Software. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
Deployment Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
Layer-3 Adoption. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
Appendix F: Contact Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

Ubiquiti Networks Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
iv
Chapter 1: Software Installation
Chapter 1: Software
Installation
All UniFi devices support off-site management controllers.

Follow the instructions in this chapter after you install the
hardware, which is described in the Quick Start Guide.
Software Installation
Introduction
Thank you for purchasing the Ubiquiti Networks UniFi
Enterprise System. The UniFi devices are bundled with the
UniFi Controller software, which allows you to manage
your UniFi network using a web browser.
This User Guide is for use with version 4.8.7 or above of the
UniFi Controller software.
System Requirements
Download the latest version of the UniFi Controller

software at downloads.ubnt.com/unifi
Follow the instructions for your specific computer or
device type.
UniFi Cloud Key Users

If you have the UniFi Cloud Key, please refer to UniFi
Cloud Key on page 5 for more information.
Linux, MacOSX, or Microsoft Windows 7/8/10
UniFi Cloud Users
Java Runtime Environment 1.6 (1.8 or above

recommended)
If you have a UniFi cloud account, please refer to UniFi

Cloud Account on page 12 for more information.
Web Browser: Mozilla Firefox, Google Chrome, Microsoft

Edge, or Microsoft Internet Explorer 11 (or above)
Linux Users
Network Topology Requirements

A DHCP-enabled network (so any device can obtain an
IP address)
Please refer to the UniFi blog on our community site at:

http://ubnt.link/UniFi-Blog
Mac Users
1. Launch UniFi.pkg.
One of the following:

UniFi Cloud Key
A management station running the UniFi Controller
software, located either on-site and connected to the
same Layer-2 network, or off-site* in a cloud or NOC
For the public address system capability of the
UAPACEDU: A compatible Android or iOS device
located on the same Layer-2 network as the UniFi
Controller and UniFi APs
2. Click Continue and follow the on-screen instructions to

install the software.
UniFi Cloud Key

(UniFi Controller)
UAP-AC-PRO
UAP-AC-LR
UAP-AC Outdoor
3. Go to Go > Applications and double-click the UniFi

icon.
US-16-150W
LAN
WAN
USG-PRO-4
(DHCP Server)
Internet
Remote Access to
UniFi Controller
Proceed to Configuring the UniFi Controller Software

on page 2.
Sample Network Diagram
* Requires Layer-3 adoption. For details, refer to:

http://ubnt.link/UniFi-Layer3-Adoption
PC Users
Configuring the UniFi Controller Software
1. Launch UniFi-installer.exe.
1. The UniFi Controller software startup will begin. Click

Launch a Browser to Manage Wireless Network.
2. Click Install.
2. Select your country and time zone. Alternatively, you

can click restore from a previous backup to use a file
that contains your backup settings. Click Next.
3. If your computer doesnt have Java 1.6 or above
installed, you will be prompted to install it. Click Install
to continue.
4. Click Next.
Note: U.S. product versions are locked to the U.S.

Country Code to ensure compliance with FCC
regulations.
3. Select the devices that you want to configure and
clickNext. You can click Refresh Now to have the UniFi
Controller repeat its device discovery process.
5. Ensure that the Start UniFi Controller after installation

option is checked and click Finish.
Note: The UniFi Controller software can also be

launched from Start > All Programs.
Note: If there is more than one page of entries

to display, click the navigation controls or page
numbers at the bottom right of the screen to display
different pages.

4. The UniFi Setup Wizard will create a secure primary
wireless network for your devices.

6. Review your settings. Click Finish to save your settings
or click Back to make changes. Once the wizard
is finished, the browser will be redirected to the
management interface.
Perform the following steps:

a. Enter the wireless network name (SSID) in the Secure
SSID field.
Congratulations, your wireless network is now configured.
b. Enter a passphrase to be used for your primary

network in the Security Key field.
A login screen will appear for the UniFi Controller

management interface. Enter the admin name and
password that you created and click Login.
c. To enable guest access, select Enable Guest Access,

and enter a guest network name in the Guest
SSIDfield.
d. Click Next.
5. Create the super admin for your UniFi Controller.
Proceed to Using the UniFi Controller Software on

page 17 for information on using the UniFi Controller
software.
a. Enter an admin name in the Admin Name field.
b. Enter an email address in the Admin Email field.
c. Enter a password in the Password field to use when
accessing the management interface as a super
admin.
d. Confirm your password in the Confirm Password
field.
e. Click Next.
Note: Only the super admin not any site admin
can view wired devices that are Pending Approval
and then adopt them on the UniFi Controller. Ensure
that you save the super admin login information for
futureuse.
Chapter 2: UniFi Cloud
Chrome Instructions
1. Ensure that your host system is on the same Layer-2
network as the UniFi CloudKey.
Introduction
You can access the UniFi Controller via the UniFi Cloud Key
and/or the UniFi cloud account. This chapter describes the
following:
UniFi Cloud Key
2. Launch the Chrome web browser and type

https://unifi.ubnt.com in the address field. Press enter
(PC) or return (Mac).
https://unifi.ubnt.com
UniFi Cloud Account on page 12
UniFi Cloud Key

The UniFi Cloud Key includes the pre-installed UniFi
Controller software.
3. Enter the username and password for your UBNT

account. Click Sign In.
System Requirement
Web Browser: Google Chrome, Mozilla Firefox, Microsoft
Edge, or Microsoft Internet Explorer 11 (or above)
Network Topology Requirement

A DHCP-enabled network (for the UniFi Cloud Key to
obtain an IP address)
UniFi Cloud Key

(UniFi Controller)
UAP-AC-PRO
4. Click Find Cloud Key.
UAP-AC-LR
UAP-AC Outdoor
US-16-150W
LAN
WAN
USG-PRO-4
(DHCP Server)
Internet
Note: The default fallback IP address of the UniFi

Cloud Key is 192.168.1.30.
Remote Access to
UniFi Controller
Sample Network Diagram
Software Installation
5. If the Ubiquiti Device Discovery Tool is already

installed, proceed to step 7.
If the tool is not installed, you will be prompted to add
it. Proceed to step 6.
After you follow the hardware installation instructions

in the UniFi Cloud Key Quick Start Guide, use one of the
following methods to launch the software:
If you are using Chrome, go to the Chrome Instructions
section (recommended).
If you are using a different web browser, go to
Instructions for Other Web Browsers on page 7.

6. To install the tool:
a. Click Install.

9. Wait for the UniFi Controller to be adopted, and then
select it.
b. Click Add app to confirm.
10. Click Launch Site.

7. The Ubiquiti Device Discovery Tool will search for the
UniFi Cloud Key. Select it to continue.
8. Configure the UniFi Controller:

a. Select the appropriate country.
b. Select the appropriate time zone.
c. Enter an admin name in the Admin Name field
and a password in the Password field to use when
accessing the management interface.


field.
e. Keep the IP address or enter a hostname in the
Controller Hostname field.
f. If you want to set up an SSH login for management
access to the UniFi Cloud Key, then select Use
nondefault SSH credentials. Enter a username in
the SSH Username field, and enter a password in the
SSH Password field.
g. Click Submit to save your changes.

software.
Note: A future feature will enable backup of the
UniFi Controller database and configuration on the
included microSD card.
Instructions for Other Web Browsers


6. Select the devices that you want to configure and
clickNext.
2. The UniFi Cloud Key is set to DHCP by default, so it

will try to automatically obtain an IP address. Assign a
specific IP address to the UniFi Cloud Key, or check the
DHCP server for its IP address.
Cloud Key is 192.168.1.30.
3. Launch the web browser. In the address field, type
https:// followed by the appropriate IP address. Press
enter (PC) or return (Mac).
7. The UniFi Setup Wizard will create a secure primary
wireless network for your devices.
4. Click Manage to run the UniFi Setup Wizard.

Note: You can click Configure to change the
settings of the UniFi Cloud Key (refer to UniFi
Cloud Key Configuration on page 8 for
more information). The default login is ubnt/ubnt
or root/ubnt.
5. The UniFi Setup Wizard screen appears. Alternatively,
you can click restore from a previous backup to use a
file that contains your backup settings. Click Next.
a. Enter the wireless network name (SSID) in the Secure

SSID field.
b. Enter a passphrase to be used for your primary
network in the Security Key field.
c. To enable guest access, select Enable Guest Access,
and enter a guest network name in the Guest
SSIDfield.
d. Click Next.
Note: U.S. product versions are locked to the U.S.

Country Code to ensure compliance with FCC
regulations.

8. Create the super admin for your UniFi Controller.


a. Enter an admin name in the Admin Name field.
b. Enter an email address in the Admin Email field.
c. Enter a password in the Password field to use when
accessing the management interface as a super
admin.
field.
e. Click Next.
Note: Only the super admin not any site admin
can view devices that are Pending Approval and
then adopt them on the UniFi Controller. Ensure
that you save the super admin login information for
futureuse.
9. Review your settings. Click Finish to save your settings
or click Back to make changes. Once the wizard
is finished, the browser will be redirected to the
management interface.

software.
Note: A future feature will enable backup of the
UniFi Controller database and configuration on the
included microSD card.
UniFi Cloud Key Configuration

Login Instructions
2. The UniFi Cloud Key is set to DHCP by default, so it
will try to automatically obtain an IP address. Assign a
specific IP address to the UniFi Cloud Key, or check the
DHCP server for its IP address.
Cloud Key is 192.168.1.30.
3. Launch the web browser. In the address field, type
https:// followed by the appropriate IP address. Press
enter (PC) or return (Mac).
Congratulations, your wireless network is now configured.

4. You have two options:
Manage Click Manage to access the UniFi
Controller. Proceed to Using the UniFi Controller
Software on page 17 for more information.
Username
At the top right of each screen, click the Username to
display the Change Password and Logout options:
Configure Click Configure to change the settings of

the UniFi Cloud Key.
Change password To change the password, click

. The Change Password screen will appear:
5. After you click Configure, enter the Username and

Password (the default login is ubnt/ubnt). Then click
Login.
Old password Enter the current password (the default
is ubnt).
New password Enter the new password.
Confirm Password Enter the new password again.
Submit Click Submit to apply changes.
Cancel Click Cancel to discard changes.
Logout To manually sign out of the UniFi Cloud Key
configuration, click
.
Main
The Main screen will appear.
Navigation Bar
The Main screen displays basic status information about

The UniFi Cloud Key configuration consists of three

primary pages:
Main (see next column)
Configuration on page 10
Maintenance on page 10
Status
Device Name Displays the hostname or alias of the UniFi
Cloud Key.
MAC Address Displays the MAC address or hardware
identifier of the UniFi Cloud Key.
Version Displays the version number of the UniFi Cloud
Key firmware.
Uptime Displays the duration of time the UniFi Cloud Key

has been running.
Date Displays the current date and time.
Disk Space
Available Displays the percentage of available disk space.
Used Displays the amount of used disk space.
Free Displays the amount of available disk space.
Total Displays the total amount of disk space.
Configuration
The Configuration screen allows you to configure the basic
and network settings of the UniFi Cloud Key.
DHCP The use of the Dynamic Host Configuration

Protocol (DHCP) is the default. The UniFi Cloud Key
automatically acquires network settings from the
networks DHCP server.
-- Fallback IP Address Enter the IP address for the UniFi
Cloud Key to use if an external DHCP server is not
found.
-- Fallback Netmask Enter the netmask for the UniFi
Cloud Key to use if an external DHCP server is not
found.
Basic Settings
Device Name Enter a descriptive name or identifier for
the UniFi Cloud Key. Also known as a host name.
Time Zone Select the appropriate time zone.
Reset Button Use of the hardware Reset button on the
UniFi Cloud Key is enabled by default. To prevent an
accidental reset to default settings, click to toggle Off.
Network Settings
Apply Changes Click Apply Changes to save changes.
Configuration Mode Select the Internet connection type

for your service: Static or DHCP.
Discard Click Discard to cancel changes.
Static The service provider assigns fixed network

settings to your service for manual entry. Enter the
following information:
-- IP address Enter the Internet IP address of the UniFi
Cloud Key.
Maintenance
The Maintenance screen contains administrative options,
so you can change the password, reboot the UniFi Cloud
Key, power it off, reset it to factory defaults, upgrade the
UniFi Cloud Key firmware, or upgrade the UniFi Controller
software.
-- Netmask Enter the subnet mask of the UniFi Cloud

Key.
-- Gateway Enter the IP address of the networks
gateway router.
-- Primary DNS Enter the IP address of the networks
primary DNS server.
-- Secondary DNS Enter the IP address of the networks
secondary DNS server.
10
Security
You have two options:
Password To change the password, click Change

Password. The Change Password screen will appear:
upload file If you have the firmware saved in a specific

location, then click Select File to browse for the file.
Old password Enter the current password (the default

is ubnt).
New password Enter the new password.
get file from URL If you know the URL of the firmwares
location, then enter it in the URL field.
Submit Click Submit to apply changes.

Maintenance
Reboot Click Reboot to powercycle the UniFi Cloud Key.
Power Off Click Power Off to turn off the UniFi Cloud Key.
Reset to Defaults Click Reset to Defaults to reset the
UniFi Cloud Key to its factory default settings. This option
will reboot the UniFi Cloud Key, and all factory default
settings will be restored.
Note: We recommend that you back up your UniFi
Controller configuration (refer to Backup on page
37 for more information) before resetting the
UniFi Cloud Key to its defaults.
Update Click Update to proceed with the update.

Cancel Click Cancel to skip the update.
Note: Updating the UniFi Cloud Key firmware will
also update the UniFi Controller software. We
recommend that you back up your UniFi Controller
configuration (refer to Backup on page 37 for
more information) before updating the UniFi Cloud
Key firmware.
Firmware
Version Displays the version number of the UniFi Cloud
Key firmware.
Check for Updates Click Check for Updates to see if
there is a newer firmware version. If there is, then you can
follow the on-screen instructions to upgrade now.
UniFi
Update Manually Click Update Manually to update the

firmware. The Please Confirm Update screen will appear.
Version Displays the version number of the UniFi

Check for Updates Click Check for Updates to see if
there is a newer software version. If there is, then you can
follow the on-screen instructions to upgrade now.
37 for more information) before upgrading.
11
UniFi Cloud Account
A secondary filter is available:
You must be a super admin for initial cloud management.

Once cloud access is enabled by the super admin, then
any other admin can also enable cloud access.
Online Only displays online UniFi Controllers.
Note: The cloud account is also known as the Single

Sign-On (SSO) account.
Login Instructions
1. Launch the Chrome web browser and type
https:// followed by the appropriate Controller
Hostname/IP address as specified in Settings >
Controller on page 35. Press enter (PC) or return
(Mac).
All Displays all UniFi Controllers.

Offline Only displays offline UniFi Controllers.
Find Cloud Key Click to discover a UniFi Cloud Key on
your local network.
Search
Enter the text you want to search
for. Simply begin typing; there is no need to press Enter.
You can click any of the column headers to change the
listorder.
(icon) Displays the icon corresponding to the device
running the UniFi Controller. Green indicates an active
UniFi Controller. Gray indicates an inactive UniFi Controller.
UniFi Cloud Key
Computer
2. Enter the username and password for your UBNT

account. Click Sign In.
Controller Displays the hostname, alias, or MAC address

of the device running the UniFi Controller. You can click
the name to get additional details at the bottom of the
screen. (Go to Additional Details on page 14 for
more information.)
IP Address Displays the IP address of the device running
the UniFi Controller.
Sites Displays the total number of sites managed by the
UniFi Controller.
Devices Displays the total number of devices managed
by the UniFi Controller.
Clients Displays the total number of clients on the sites
managed by the UniFi Controller.
Note: If you do not have an account, click

Register and follow the on-screen instructions.
A list of UniFi Controllers will appear.
Version Displays the software version number of your

UniFi Controller.
Actions Click a button to perform the desired action:
Remove Click
to remove the UniFi Controller
from your cloud account.
Chat At the lower left of the screen, click
window for online chat support.
to open a
Admin
At the top right of the screen, click
Account and Sign Out options:
to display the My
You can apply one of the following primary filters:

All Displays all UniFi Controllers
Cloud Key Only displays UniFi Cloud Keys.
Software Installation Only displays instances of
software installations.
12

My Account To change your account settings and/or
password, click
. The Account Settings screen
will appear:
Find Cloud Key

To add a UniFi Cloud Key, click Find Cloud Key at the top
right of the screen. The Find Cloud Key screen will appear:
Adopt
IP address Displays the IP address of the UniFi Cloud Key.
(status) Displays the status information: Pending
Adoption.
There are three pages available:
Profile Access your account settings:
-- First Name Enter your first name.
mac Displays the MAC address or hardware identifier of

firmware Displays the firmware version number of the
UniFi Cloud Key.
-- Username Enter your login username.
Adopt Click to adopt the UniFi Cloud Key. Refer to step

8 of Chrome Instructions on page 5 for more
information.
-- Email Enter the email address of your cloud account.
Cancel Click to exit this screen.
-- Update Settings Click to apply your changes.
Manage
-- Last Name Enter your last name.
Security Change your account password:

-- Create a New Password Enter a new password with
at least eight characters.
-- Update Settings Click to apply your changes.
IP address Displays the IP address of the UniFi Cloud Key.
(status) Displays the status information: Adopted or
Pending Adoption.
mac Displays the MAC address or hardware identifier of
firmware Displays the firmware version number of the
UniFi Cloud Key.
Manage Click to configure the UniFi Cloud Key. Refer to
UniFi Cloud Key Configuration on page 8 for more
information.
Beta Program Follow the on-screen instructions if you
want to join the beta program.
Cancel Click to exit this screen.
Sign Out To manually sign out of the cloud account, click

.
13
Additional Details
(site_name)
Select a UniFi Controller to display more information at

the bottom of the screen.
Launch Site Click Launch Site to access the UniFi

Controller. Proceed to Using the UniFi Controller
Software on page 17 for more information.
Note: If you have an issue accessing the local
Controller, then click force WebRTC.
(map) Displays a visual representation of your
networks status. The status of each dashboard node is
indicated by color:
-- Black Black indicates that the Internet connection is
active.
-- Green Green indicates that the node is active and all
devices are online.
(icon) Green indicates an active UniFi Controller. Gray

indicates an inactive UniFi Controller.
Overview
(controller_name) Displays the Controller Hostname/IP
address as specified in Settings > Controller on page
35.
IP Address Displays the IP address of the device
running the UniFi Controller.
-- Red Red indicates one of the following:

WWW Internet connectivity is down.
WAN The UniFi Security Gateway is offline.
LAN One or more Switches are offline.
WLAN More than half of the APs are offline.
Sites Displays the total number of sites managed by the

UniFi Controller.
Devices Displays the total number of devices managed
by the UniFi Controller.
Clients Displays the total number of clients on the sites
managed by the UniFi Controller.
Software Version Displays the software version
number of your UniFi Controller.
-- Remove Click
to remove the UniFi Controller
from your cloud account.
-- Gray Gray indicates that there is no Internet

connection or there are no devices available for
thatnode.
You can place the mouse over each node icon to display
basic status information.
-- WWW The basic details of the Internet connection
are displayed.
Sites
Search
Enter the text you want to
search for. Simply begin typing; there is no need to press
Enter.
(site_name) Displays the name of the site. You can click
the name to get additional details on the right.
(Unread Alerts)
alerts.
Displays the number of unread

Gateway Displays the IP address of the service
providers gateway.
DNS Displays the IP addresses of the Domain Name
System (DNS) servers.
IP Displays the Internet IP address of the UniFi
Security Gateway.
Uptime Displays the length of time the Internet
connection has been active.
14

Latency Displays the amount of time it takes a
packet to travel from the UniFi Security Gateway to
the service providers gateway.

-- WLAN The basic details of the wireless network(s) are
displayed.
Up Displays the upload rate of your Internet

connection.
Down Displays the download rate of your Internet
connection.
-- WAN The basic details of the UniFi Security Gateway
connection are displayed.
Users Displays the number of clients connected to
the primary wireless network(s).
Guests Displays the number of clients connected
to the guest wireless network(s).
LAN IP Displays the local IP address of the UniFi

Security Gateway.
Clients Displays the total number of local clients.
Up Displays the upload rate of the UniFi Security
Gateway.
APs Displays the number of APs in the primary

wireless network(s) and the number of APs in the
guest wireless network(s).
Down Displays the download rate of the wireless
network(s).
Up Displays the upload rate of the wireless
network(s).
Down Displays the download rate of the UniFi

Security Gateway.
-- LAN The basic details of the wired network(s) are
displayed.

providers gateway.
Users Displays the number of clients connected to
the wired network.
Guests Displays the number of clients connected
to the guest wired network.
Switches Displays the number of UniFi Switches
connected to the wired network.
Down Displays the download rate of the wired
network(s).
Up Displays the upload rate of the wired
network(s).
15
16
Chapter 3: Using the UniFi Controller Software
Chapter 3: Using the UniFi

Controller Software
Common Interface Options

The common interface options are accessible from all tabs
in the UniFi interface.
The UniFi Controller software has a browser-based

interface for easy configuration and management.
To access the interface, perform the following steps:
1. Launch the UniFi Controller application if hasnt already
been started.
Mac users: Go > Applications > UniFi
Windows users: Start > All Programs >
UbiquitiUniFi
2. The UniFi login screen will appear. Enter the username
and password in the appropriate fields and clickLogIn.
Refresh
Click the refresh icon to update the on-screen
information. Click the arrow icon to change the refresh
interval: 15seconds, 1minute, 2minutes (default),
5minutes, or Never refresh.
Navigation Bar
The UniFi software consists of six primary pages. This User
Guide covers each page with a chapter. For details on a
specific page, refer to the appropriate chapter.
Dashboard on page 39
Map on page 45
Devices on page 51
Clients on page 59
Current Site
The UniFi Controller can manage multiple UniFi networks,
which are called sites. Each site has its own configurations,
maps, statistics, guest portals, and site administrator
accounts. The multiple sites are logically separated, and
the initial site is named Default.
Statistics on page 63
Insights on page 67
Current Site To view available sites or create a new site,

click the arrow icon.
17
Sites overview To display a list of available sites, click

Sites overview .The Sites Overview screen will appear.
Username
At the top right of the screen, click the Username to
display the Preferences, Edit Account, and Logout options:
Each site is displayed with the following:

-- Name Displays the name of the site.
-- WAN The icon is color-coded to display the
WAN connection status. Green indicates active; red
indicates inactive.
-- LAN The
icon is color-coded to display the wired
network connection status. Green indicates active; red
indicates inactive.
Preferences To change the UI settings, click

.
-- Active Displays the number of active wired devices.

-- Inactive Displays the number of inactive wired
devices.
-- Pending Displays the number of wired devices
pending adoption.
-- WLAN The icon is color-coded to display the
sireless network connection status. Green indicates
active; red indicates inactive.
-- Active Displays the number of active wireless
devices.
-- Inactive Displays the number of inactive wireless
devices.
-- Pending Displays the number of wireless devices pen
adoption.
-- Users Displays the number of wireless users
wired users .
and
-- Guests Displays the number of wireless guests

and wired guests
.
Add new site ,
Add new site To create a new site, click
and the Add a New Site screen will appear:
Dark settings Enabled by default. A dark theme is used

on the Settings screens.
Condensed view Enabled by default. The table
padding is condensed and the font size is minimized to
fit as much data on the screen as possible.
Responsive tables Disabled by default. If enabled,
the Responsive tables option removes columns on
smallersized browsers to prevent excessive scrolling
when the table columns are not customized.
Inline property panel Enabled by default. When the
property panel is inline, it compresses the main content
when it is open. When the property panel is not inline, it
opens on top of the content, as a popup.
Language Select the appropriate language.
Alerts position Select the position you want alerts to
appear: Top left, Top center, Top right, Bottom left,
Bottom center, or Bottom right.
-- Site Name Enter a name that describes the site. It will

be used in the Current Site drop-down menu.
-- Cancel Click to discard changes.
-- Submit Click to save changes.
Date format Enter the format you want to use. The

default is MM/DD/YYYY.
Time format Enter the format you want to use. The
default is hh:mm a.
Datetime format Enter the date and time format you
want to use. The default is MM/DD/YYYY hh:mm a. Click
Learn more for more information about date and time
format options.
Cancel Click to discard changes.
Reset to Defaults Click to reset to factory defaults.
18

Edit Account To change the login name and/or password,
click
. The Edit Account screen will appear:
Events
Password Enter your current password.
Maximize/Minimize Click to maximize the screen size.

Click again to minimize the screen size.
Admin Enter the admin name.
Close Click
Email Enter the email address of the admin account.

Show Filter recent events based on the time period you

specify. Select Last hour, Last 8 hours, Last 24 hours,
Last 48 hours, 7 days, 2weeks, or 30 days.
Submit Click to apply changes.
You can apply one of the following filters:
All Display all of the recent events.
Logout To manually sign out of the UniFi Configuration

.
Interface, click
Admin Only display recent events for the administrator.
Properties
WLAN Only display recent events for the wireless

networks.
New Password Enter the new password.
The Properties panel is hidden by default. To display it,

select a device.
Information about each selected device appears as
a popup within this panel. The information varies
depending on the device type. For more information, see
the appropriate chapter:
UniFi Security Gateway Details on page 77
UniFi Switch Details on page 85
UniFi Access Point Details on page 95
UniFi VoIP Phone Details on page 107
Client Details on page 109
Controls and Live Chat

At the bottom left of the screen, there are four controls:
The Events tab displays a list of recent events, along

with the corresponding device icon, device name,
message, date, and time.
to close the screen.
LAN Only display recent events for the wired network.
Search
You can enter text that you want
to search for. Simply begin typing; there is no need to
press Enter.
Icons
The messages use the following icons (not all are shown
here):
Scheduled for upgrade
UniFi Security Gateway
UniFi Switch
UniFi Access Point
UniFi VoIP Phone
Events (see the next column)
Clicking an Event Device Link
Alerts (see Alerts on page 20)
Settings (see Settings on page 20)

Chat with Us (see Chat with Us on page 38)
The messages have clickable links for client and UniFi

devices:

19
Alerts
Settings
When there is a new alert, an orange icon displaying the

number of new alerts appears.
The Settings
tab displays a list of available subtabs:
Site Site-related settings.

Wireless Networks Wireless network and group setup,
including Zero Handoff Roaming.
The Alerts tab displays a list of important events,

along with the corresponding device icon, device name,
message, date, andtime.
Networks Wired network setup.

Guest Control Guest portal and policies.
Admins Admin accounts and privileges.
User Groups User group settings.
Controller Identity, discovery, and email server settings.
Cloud Access Cloud login credentials.
Maintenance System configuration backup, system
configuration restore, and support files.
Settings > Site

Configure the site-specific settings. To switch sites, select a
different site from the Current Site drop-down menu at the
top of any screen.
Maximize/Minimize Click to maximize the screen size.

Click again to minimize the screen size.
Close Click
to close the screen.
Show archived alerts Select this option to display all of

the archived alert messages.
Archive All Click Archive All to archives all of the alert
messages.
Search
You can enter text that you want
to search for. Simply begin typing; there is no need to
press Enter.
Archive Click
to archive the selected alert message.
Icons
The messages use the following icons (not all are shown
here):
UniFi Switch
Site Name Change the name of the site.

Country Select the appropriate country.
UniFi Access Point
Time Zone Select the appropriate time zone.
UniFi VoIP Phone
Services
Clicking an Alert Device Link

The messages have clickable links for client and UniFi
devices:
20
Site Configuration
Automatic Upgrade When enabled, the UniFi Controller

will automatically upgrade your firmware when an update
is available.
LED When enabled, the LEDs on the UniFi devices will
light up. When disabled, the LEDs will turn off.
Alerts Select this option to enable alert emails, which will
be sent to the email addresses of the administrators.
Speed Test (Beta) When enabled, you can run a periodic
speed test.

DPI (Beta) Deep Packet Inspection (DPI) is more
advanced than conventional Stateful Packet Inspection
(SPI) filtering for traffic analysis. Ubiquitis proprietary
DPI engine includes the latest application identification
signatures to track which applications (and IP addresses)
are using the most bandwidth.
Settings > Wireless Networks

Configure the wireless networks for each site. You can
have up to four wireless network names or SSIDs per
WLANgroup.
Clear DPI Counters Click to delete all collected DPI

data. Click Confirm or Cancel.
Note: The DPI feature requires use of the UniFi
Security Gateway.
Port Remapping (Beta) When enabled, the VOIP port on
the UniFi Security Gateway, model USG, will be remapped
as a WAN2 port.
Uplink Connectivity Monitor It monitors the uplinks of
the managed APs, either wired or wireless, by checking to
see if the gateway/custom IP can be reached. The monitor
and wireless uplink capability are enabled by default.
WLAN Group The Default WLAN group is automatically

created.
Default Gateway Enabled by default. All managed

APs will use the gateway of the AP that is providing IP
information, either by DHCP or Static designation.
Add a New WLAN Group To add a new WLAN group,

click the button. Go to the Add or Edit a WLAN Group
section.
Custom IP Click to specify an IP address.
Add or Edit a WLAN Group
-- Uplink IP Address All managed APs will use the IP

address you enter.
SNMP Select this option to activate the SNMP
(Simple Network Monitor Protocol) agent. SNMP
is an application layer protocol that facilitates the
exchange of management information between
network devices. Network administrators use SNMP
to monitor networkattached devices for issues that
warrantattention.
Community String Specify the SNMP community
string. It is required to authenticate access to MIB
(Management Information Base) objects and functions
as an embedded password. The device supports a
read-only community string; authorized management
stations have read access to all the objects in the MIB
except the community strings, but do not have write
access. The device supports SNMP v1. The default
ispublic.
Remote Logging Enable to define a remote syslog server.
Remote IP Address Enter the IP address of the syslog
server.
Port Enter the port number of the syslog server. The
default is 514.
Device Authentication This option protects SSH access
to the UniFi devices. All devices in the same site share the
same SSH username and password. You can also make
changes:
Username Enter the new username.
Password Enter the new password.
Apply Changes Click to save changes.
Name Enter or edit a descriptive name for the WLAN

group.
Mobility To enable seamless roaming (Zero Handoff ),
select the checkbox.
Note: The UAP-AC, UAP-AC-Outdoor, UAPACLITE,
UAPACLR, UAPACPRO, and UAPACEDU do not
support Zero Handoff Roaming.
When you enable this option, multiple Access Points
(APs) act as an AP cluster, appearing as a single AP. The
wireless client detects only one AP, so it seamlessly
roams from AP to AP there is no need to re-negotiate.
The APs determine which AP has the best connection
and should serve the client. They use multicasting to
communicate so they must be wired in the same Layer 2
domain.
Zero Handoff Roaming does not support wireless
uplinks and can only be used on a secured network. It
is also not meant for all scenarios. For example, if there
is too much load or interference, then Zero Handoff
Roaming may not be appropriate for your scenario.
Reset Click to cancel changes.
21

Create or Edit a Wireless Network
Configure the following options:

-- Radio Select the appropriate radio, 2G or 5G.
-- Channel Select the channel that all of the APs will use
for Zero Handoff Roaming.
Load Balancing (Not available if you enabled the Mobility
option.) Select this option to balance the number of
clients you specify per radio. Then enter the number of
clients in the field provided.
Legacy Support (Not available if you enabled the Mobility
option.) By default, legacy devices, such as 802.11b
devices, are excluded. Select this option if you want to
support legacy devices.
Save Click to apply changes.
Name/SSID Enter or edit the wireless network name

orSSID.
Enabled Select this option to make this network active.
Security Select the type of security to use on your
wireless network.
-- Open This option is typically only used on the guest
network. When enabled, wireless network access is
open to anyone without requiring a password.
-- WEP WEP (Wired Equivalent Privacy) is the oldest
and least secure security algorithm. WPA security
methods should be used when possible.

For each WLAN group, you have the following:
Remove a WLAN Group To remove a WLAN group
(except for the Default, which cannot be removed),
select it from the drop-down menu, and then click the
delete button.
WEP Key Enter a WEP encryption key in

hexadecimal format. You can enter a 64-bit or
128bit key:
Type
Hex
64-bit
10 Hexadecimal Characters
(0-9, A-F, or a-f )
Example: 00112233AA
Note: You can use 5 printable characters,
which will be translated to the
corresponding HEX code.
128-bit
26 Hexadecimal Characters
(0-9, A-F, or a-f )
Example:
00112233445566778899AABBCC
Note: You can use 13 printable
characters, which will be translated to the
corresponding HEX code.
Options To make changes, select the WLAN group from

the dropdown menu, and then click the edit button.
Go to Add or Edit a WLAN Group on page 21.
Wireless Networks
Name/SSID Displays the wireless network name or SSID.
Security Displays the type of security being used on your
wireless network.
Guest Network Indicates whether or not the network is a
guest network.
to make changes to the wireless
Edit Click
network settings. Go to the Create or Edit a Wireless
Network section in the next column.
EDIT
Delete Click
to remove the wireless network.
to add
Create Wireless Network Click
a wireless network. Go to the Create or Edit a Wireless
Network section in the next column.
Key Index Specify which Index of the WEP Key

to use. Four different WEP keys can be configured
at the same time, but only one is used. Select the
effective key: 1, 2, 3, or 4.
-- WPA-Personal WPA or Wi-Fi Protected Access was
developed as an encryption method stronger than
WEP. WPA-Personal requires a passphrase to connect
to the wireless network.
Security Key Enter the passphrase that users will

use to connect to the wireless network.
22

-- WPA-Enterprise WPA Enterprise uses a RADIUS
server to authenticate users on the wireless network.
VLAN To use a VLAN, select Use VLAN ID and enter the

VLAN ID number. If you enable WPA Enterprise, you have
another option:
-- Enable RADIUS assigned VLAN (beta) Select this
option to allow the RADIUS server to dynamically
assign a VLAN to a wireless client.
RADIUS Auth Server Provide the following

information about the RADIUS authentication
server:
IP Address Enter the IP address.
Port Enter the port number. The default is 1812.
Password Enter the password.
Delete Click the delete
authentication server.
icon to remove this
Add Auth Server If you have another

authentication server, click this option and
complete the IP Address, Port, and Password fields.
RADIUS Accounting Server Provide the following
information about the RADIUS server:
IP Address Enter the IP address.
Port Enter the port number. The default is 1813.
Password Enter the password.
Delete Click the delete
accounting server.
icon to remove this
Add Accounting Server If you have another

accounting server, click this option and complete
the IP Address, Port, and Password fields.
If you set a VLAN ID as a static value for another SSID

on the same AP, then you cannot reuse the same
VLAN ID for the RADIUS-assigned (dynamic) VLAN. For
example, if you have a VLAN set to VLAN 10, then you
cannot use VLAN ID 10 for RADIUScontrolled VLAN
users as those users will not be assigned an IP address.
Hide SSID Select this option if you dont want the
wireless network name or SSID to be broadcast.
WPA Mode (Available if WPA security is enabled.) Select
the appropriate WPA method: Both, WPA1 Only, or
WPA2 Only (default).
Encryption Select the appropriate encryption method:
Auto, TKIP Only, or AES/CCMPOnly (default).
User Group Assign wireless users to a specific user
group. For more information about user groups, see
Settings > User Groups on page 34.
UAPSD Disabled by default. Unscheduled Automatic
Power Save Delivery. Select this option to enable the
power save mode of Wi-Fi devices.
Scheduled Select Enable WLAN Schedule to restrict
wireless access to the schedule you set.
-- Monday-Sunday Select the days you want to
schedule.
-- Hours Use the sliders to select the start and end
times of the days wireless access.
Guest Policy Select this option to enable guest access

policies on this wireless network.
Advanced Options
Click to display options for advanced users.
Settings > Networks

Configure the networks for each site.
Networks
Name Displays the network name.
Purpose Displays a description of this network.
Subnet Displays the IP address and prefix size.
VLAN Displays the VLAN ID, if applicable.
23

Edit Click
to make changes to the network
settings. Go to Create or Edit a Network on page
24.
EDIT
Delete (Not available for the default network.) Click

to remove the network.

DHCP Server Enabled by default. The local DHCP server
assigns IP addresses to DHCP clients on the network.
DHCP Range Enter the starting and ending IP
addresses of the range in the fields provided.
DHCP Name Server Configure the name or DNS
(Domain Name System) server setting.
Create New Network Click

to add a network.
Go to Create or Edit a Network on page 24.
-- Auto Enabled by default. Name servers are

automatically assigned by the DHCP server.
Create or Edit a Network
-- Manual Select this option to manually select name

servers.
Name Server 1/2 Enter the IP address of the name
server in each field.
DHCP WINS Server Select this option to designate
WINS (Windows Internet Naming Service) server(s).
-- WINS Server 1/2 Enter the IP address of the WINS
Name Enter or edit the network name.

Purpose Select the most appropriate description:
Corporate, Guest, Voice, VLAN Only, Remote User
VPN, Site-to-Site VPN, or VPN Client. Then follow the
instructions for your selection:
Corporate or Guest Network
DHCP Lease Time The IP addresses assigned by the

DHCP server are valid only for the duration specified
by the lease time. Increasing the time ensures client
operation without interruption, but could introduce
potential conflicts. Decreasing the lease time avoids
potential address conflicts, but might cause more slight
interruptions to the client while it acquires a new IP
address from the DHCP server. Enter the number of
seconds.
DHCP Guarding Disabled by default. Select this option
to detect and block unauthorized DHCP servers.
-- Trusted DHCP Server IP Enter the IP address of the
trusted DHCP server.
Voice
Network Group (Beta) Select the appropriate option,

LAN or LAN2.
IP/Subnet Enter the IP address and prefix size.
VLAN (Not available for the default Corporate network,
LAN.) Enter the VLAN ID.
IGMP Snooping Select this option to monitor IGMP
(Internet Group Management Protocol) traffic and
thereby manage multicast traffic.
24
If you previously enabled VoIP, then there is a Voice

network; otherwise this network option is not available.
IP/Subnet Enter the IP address and prefix size. The
Gateway IP, Network Broadcast IP, Network IP Count,
Network IP Range, and Network Subnet Mask are
displayed.


DHCP Server Enabled by default. The local DHCP server

assigns IP addresses to DHCP clients on the network.
DHCP Guarding Select this option to detect and block

unauthorized DHCP servers.
DHCP Range Enter the starting and ending IP

addresses of the range in the fields provided.
DHCP Name Server Configure the name or DNS
(Domain Name System) server setting.
servers.

Remote User VPN
The UniFi Security Gateway is required for this option.

DHCP WINS Server Select this option to designate
WINS (Windows Internet Naming Service) server(s).
DHCP Lease Time The IP addresses assigned by the
DHCP server are valid only for the duration specified
by the lease time. Increasing the time ensures client
operation without interruption, but could introduce
potential conflicts. Decreasing the lease time avoids
potential address conflicts, but might cause more slight
interruptions to the client while it acquires a new IP
address from the DHCP server. Enter the number of
seconds.
DHCP Guarding Select this option to detect and block
unauthorized DHCP servers.
VLAN Only
The UniFi Switch is required for this option.
IP/Subnet Enter the IP address and prefix size.

IP Pool The starting and ending IP addresses of the
pool automatically appear after you complete the
IP/Subnet field.
Name Server Configure the name or DNS (Domain
Name System) server setting.
servers.
WINS Server Select this option to designate WINS
(Windows Internet Naming Service) server(s).
RADIUS IP Enter the IP address of the RADIUS server,
which is used for authentication.
RADIUS Password Enter the password of the RADIUS
server.
VLAN Enter the ID number of the VLAN. Devices

belonging to the same VLAN communicate as if
they were attached to the same wire. Every VLAN ID
represents a different VLAN. The VLAN ID range is 2 to
4009.
Site-to-Site VPN Enabled by default. The remote user

can access the sites resources as well as the resources of
any other VPNs connected to the site. If you disable this
option, then the remote user can only access the sites
resources.
25

Site-to-Site VPN

Azure dynamic routing Select this option if you
are using Microsoft Azure with dynamic routing
for a route-based VPN.
Azure static routing Select this option if you are
using Microsoft Azure with static routing for a
policy-based VPN.
Advanced Options Click to access the advanced
configuration.
Key Exchange Version Both peer routers must
use the same Internet Key Exchange (IKE) version.
Select the appropriate version: IKEv1 or IKEv2.
VPN Client (Beta) Select the appropriate option:

-- Auto Auto is the default.
Remote Site Select the appropriate site from the
dropdown list.
Note: If you have admin privileges for the local and
remote sites, then you can view and select sites.
Encryption Both peer routers must use the

same encryption method. Select the appropriate
encryption method: AES-128, AES-256, or 3DES.
Hash Both peer routers must use the same hash
algorithm. Select the appropriate hash algorithm:
SHA1 or MD5.
DH Group The DH (Diffie-Hellman) group
specifies the strength of the DH encryption key
for the key exchange. Both peer routers must use
the same DH group. Select the appropriate DH
group: 2, 5, 14, 15, 16, 19, 20, 21, 25, or 26. The
default is 14.
PFS Select this option to enable PFS (Perfect
Forward Secrecy), which helps enhance the
security of keys.
Dynamic Routing Select this option to enable
dynamic routing over the VPN tunnel.
Note: If you selected Azure dynamic routing or
Azure static routing, then the defaults of the
Advanced Options will also change accordingly.
-- IPsec VPN Select this option create a VPN that uses

IPsec (IP security protocol).
Enabled Select this option to create an IPsec VPN
tunnel over the Internet between two peer routers.
(The UniFi Security Gateway is the local peer router.)
Remote Subnets Click Add Subnet to add an
address for a remote network.
Add Subnet If you have another remote subnet,
click this option and enter its network address.
Peer IP Enter the IP address of the peer router.
Local WAN IP Enter the Internet IP address of the
UniFi Security Gateway.
Pre-Shared Key Enter the pre-shared secret key.
Both peer routers must use the same pre-shared
secret key for authentication.
IPsec Profile Select the appropriate option:
Customized Select this option to customize your
settings.
26
-- OpenVPN Select this option to create a VPN that

uses the OpenSSL (Secure Sockets Layer) library and
SSL/TLS (Transport Layer Security) protocols.
Enabled Select this option to create an OpenVPN
tunnel over the Internet between two peer routers.
(The UniFi Security Gateway is the local peer router.)
Remote Subnets Click Add Subnet to add an
address for a remote network.
Add Subnet If you have another remote subnet,
click this option and enter its network address.
Remote Host Enter the hostname of the remote

router.
Remote Address Enter the Internet IP address and
port number of the remote router.
Local Address Enter the Internet IP address and
port number of the UniFi Security Gateway.
Shared Secret Key Enter the pre-shared secret key.
Both peer routers must use the same pre-shared
secret key for authentication.
VPN Client
Guest Policies
Enable Guest Portal Disabled by default. When disabled,
guests can access the Internet without entering a
password or accepting the terms of service. When this
option is enabled, you can control the Guest Portal.
Authentication When the Guest Portal is enabled, the
authentication options will appear:
Authentication > No Authentication (see below)
Authentication > Simple Password on page 28
VPN Client (Beta) PPTP Client is automatically
selected.
Authentication > Hotspot on page 28
Enabled Select this option to enable the VPN client.
Authentication > No Authentication
Remote Subnets Enter the network address of the

remote network.
-- Add Subnet If you have another remote subnet, click
this option and enter its network address.
Authentication > External Portal Server on page 33

Select this option if guests are not required to log in (you
can choose to require the terms of service).
Server IP Enter the IP address of the VPN server.

Username Enter the VPN username.
Password Enter the VPN password.
MPPE Select this option to require MPPE (Microsoft
Point-to-Point Encryption).
Settings > Guest Control

The Guest Control screen displays the following sections:
Guest Policies (see below)
Access Control on page 33
Hotspot on page 30 (for Hotspot authentication)
Access Control on page 33
Expiration Specify the guest login expiration after a

designated period of time: 8 hours, 24hours, 2 days, 3 days,
4 days, 7 days, or Userdefined, which can be designated in
minutes, hours, and days.
27

Landing Page After connecting, guests are redirected to
the landing page. Select one of the following options:
Redirect to the original URL After connecting, guests
are directed to the URL they requested.
Promotional URL After connecting, guests are
redirected to the URL that you specify. Ensure that the
URL begins with http://. Example: http://www.ubnt.com
Redirect Using Hostname Select this option to enter and
use a hostname for the portal URL in place of the default
IP address. Paired with an SSL certificate, this ensures
that site certificates are displayed as trusted in the guest
browser. Example: www.ubnt.com
When logging in with No authentication, guests can click
Connect for immediate access.
If you enable the terms of service, then guests will be

required to accept the terms of use before gaining access
to the Internet.
You can select Enable terms of service under Settings >

Guest Control > Portal Customization to enforce selection of
the terms of service by the guest. See Access Control on
page 33 for more information.

Expiration Specify the guest login expiration after a
designated period of time: 8 hours, 24hours, 2 days, 3 days,
4 days, 7 days, or Userdefined, which can be designated in
minutes, hours, and days.
When logging in with Simple Password authentication,
guests will be required to enter the Guest Password before
gaining access to the Internet.

to the Internet.
Authentication > Simple Password

Select this option if guests are required to enter a simple
password (you can choose to require the terms of service).
See Guest Policy on page 23 for more information.
You can select Enable terms of service under Settings >

Guest Control > Portal Customization to enforce selection of
the terms of service by the guest. See Access Control on
Authentication > Hotspot
Select this option to enable Hotspot functionality,
including the ability to customize portal login pages
and bill customers using major credit cards or other
supported methods. You must also select Enable Guest
Portal under Settings > Guest Control to enforce voucher
entry, payment, and selection of the terms of service by
the guest. See Guest Policy on page 23 for more
information.
Guest Password Enter a password that guests must enter

before connecting to the Internet.
28

AngularJS is a single-page app, so it should work more
quickly. However, AngularJS uses JS (JavaScript), which
may not work with some really old web browsers or newer
browsers with JS support disabled.
AngularJS uses responsive design, so it will adapt to the
size of a mobile device, such as a tablet or smartphone.
Legacy JSP is fully customizable and uses old HTML, so it
should work with any web browser. You can customize
Legacy JSP only by overriding files. Legacy JSP works more
slowly and is not responsive by default.
AngularJS Select AngularJS for client-side rendering.

Portal Customization
Select this option to have customized portal pages appear
in place of the default login pages. (This option is not
available if you are using an external portal server.)
Title Enter the title of your portal. The default is Hotspot

portal.
Welcome Text Select Enable welcome text to add a
welcome message.
Template Engine Select AngularJS for client-side

rendering or Legacy JSP for server-side rendering. We
recommend AngularJS unless you are using old templates.
Note: AngularJS is not compatible with old
templates because the old templates were
designed to work with JSP (Java Server Pages).
The UniFi Controller offers a built-in editor to customize
AngularJS; however, it is not fully customizable at
thistime.
After you have added your welcome text, click Submit

to save your changes or click Cancel.
Once you have welcome text, then you can click
make changes.
EDIT
to
-- Text position Select the appropriate location for the

welcome text, Under the logo or Above boxes.
29

Terms of Service Select Enable terms of service to add
any terms of service you want hotspot users to accept.

Desktop Preview Enabled by default. The Desktop
Preview previews the portal in the desktop view.
Mobile Preview Click Mobile Preview to preview the
portal in the mobile view.
Reset Style Reset Portal Customization changes to the
factory defaults.
Note: At this time AngularJS does not support
voucher customization; however, you can
customize vouchers using the voucher.html and
voucher.css files. Refer to Customizable Default
Files on page 120 for more information.
Legacy JSP Server-side rendering is enabled by default.
Click Submit to save your changes or click Cancel.

Once you have the terms of service, then you can click
to make changes.
EDIT
Portal Customization You can make the following

formatting changes:
-- Customize logo Click Upload image and select the
logo you want to use. (We recommend the use of the
.png format.) Then click Open.
-- Background image Click Upload image and select
the image you want to use. (We recommend the use
of the .jpg format.) Then click Open.
Tile background image Select this option if you
want to repeat the background image in a tile
pattern.
-- Background color Click Button color to select the
appropriate color, or enter the hexadecimal HTML
color value you want to use. The default is #cccccc.
-- Text color Click Button color to select the
color value you want to use. The default is #1379b7.
Override Default Templates Select this option if

you want to manually edit templates. See Portal
Customization with LegacyJSP on page 117 for
more information.
Hotspot
When Hotspot authentication is selected, the Hotspot
section is displayed.
-- Button color Click Button color to select the

-- Button text color Click Button text color to select
the appropriate color, or enter the hexadecimal HTML
color value you want to use. The default is #ffffff.
-- Link color Click Link color in box to select the
-- Box color Click Box color to select the appropriate
color, or enter the hexadecimal HTML color value you
want to use. The default is #ffffff.
-- Text color in box Click Link color in box to select
color value you want to use. The default is #000000.
-- Link color in box Click Link color in box to select
-- Box opacity You can change the opacity of the box
background color. The default is 90.
30
Select the Voucher and/or Payment method of

authorization:
-- Hours Enter the number of access hours the package

allows.
Vouchers Use Hotspot Manager to create vouchers

(including distributable code, duration values, and use
restrictions). See Hotspot Manager on page 113.
-- Limit Download Enter the maximum download

bandwidth in Kbps.
Payments Set up payment-based authentication.
-- Limit Upload Enter the maximum upload bandwidth

in Kbps.
-- Limit Quota Enter the maximum amount (in
megabytes) of data transfer allowed per session.
-- Submit Click to apply changes.
-- Cancel Click to discard changes.
Payment Field Options (Available only for paymentbased authentication.)
-- Enable first name field Select this option to create a
field for a first name.
Required Select this option if you want to make
this field mandatory.
Payment Packages (Available only for payment-based

authentication.) There are three packages by default:
Basic 8HR ($5.99), Premium Daypass ($8.99), and Free Trial.
-- Actions Click a button to perform the desired action:
to make changes to the package
-- Edit Click
settings. Go to the Add or Edit a Package section.
EDIT
-- Delete Click
to delete the package.
Add Another Package Click ADD ANOTHER PACKAGE to create

a new package. Go to the Add or Edit a Package section.
Add or Edit a Package
-- Enable last name field Select this option to create a

field for a last name.
-- Enable address field Select this option to create a
field for an address.
-- Enable city field Select this option to create a field
for a city.
-- Enable state field Select this option to create a field
for a state.
-- Enable zip field Select this option to create a field for
a zip code.
-- Enable country field Select this option to create a
field for a country.
-- Name Enter or edit the name of the package.

-- Payment Select Free package if appropriate. (Only
one free package is allowed. There is a free package
by default, so unless you delete it, then this option is
not available.)

Default value Select the appropriate default
country from the drop-down menu.
-- Price Select the appropriate currency from the

dropdown menu, and then enter the price.
-- Charged as Enter the text that will be shown on the
credit card statement.
-- Overwrite Limit Select this option if you want to
overwrite the user group policy per WLAN/user.
31
Gateway (Available only for payment-based

authentication.) You have multiple options:
-- PayPal Website Payment Pro (US, Canada,
UK) Use your PayPal Website Payments Pro
account. To manage payments and transactions, click
, and see Hotspot Manager on page
113.
GO TO HOTSPOT MANAGER
Enter the Authorize.Net account details:

API Login ID Enter the API login ID used to identify
yourself as an authorized user.
Transaction Key Enter the key used to authenticate
transactions.
Enter the PayPal account details:

Username Enter the corresponding Username.
Password Enter the corresponding Password.
Signature Enter the corresponding Signature for
the PayPal account that will receive payments.
Use sandbox account For PayPal testing purposes,
select this option. Then click Apply Sandbox
Account to set up or access your PayPal Sandbox
Test Environment.
-- Stripe (US, Canada) Use your Stripe account. To
manage payments and transactions, click Go to
Hotspot Manager, and see Hotspot Manager on
page 113.
Use test account For Authorize.Net testing

purposes, select this option. Then click Apply Test
Account to set up or access your Authorize.Net
test account.
-- Merchant Warrior (Australia, New Zealand) Use
your Merchant Warrior account. To manage
payments and transactions, click Go to Hotspot
Manager, and see Hotspot Manager on page
113.
Enter the Merchant Warrior account details:

Merchant UUID Enter the ID for your merchant
account.
API Key Enter the API key.
Enter the Stripe account detail:

API Key Enter the live secret API key.
Note: We recommend that you perform a test
transaction with the test secret API key first before
using the live secret API key.
-- Quickpay (Europe) Use your Quickpay account.
To manage payments and transactions, click Go to
page 113.
API Passphrase Enter the API passphrase.

Use test account For Merchant Warrior testing
purposes, select this option. Then click Apply Test
Account to set up or access your Merchant Warrior
test account.
-- IPpay (US, Canada) Use your IPpay account. To
manage payments and transactions, click Go to
page 113.
Enter the IPpay account details:

Enter the Quickpay account details:
Merchant ID Enter the ID for your merchant
account.
MD5 Secret Enter the MD5 secret key.
-- Authorize.Net (US, Canada) Use your Authorize.Net
account. To manage payments and transactions, click
Go to Hotspot Manager, and see Hotspot Manager
on page 113.
32
Terminal ID Enter the terminal number for your

merchant account.
Use test account For IPpay testing purposes, select
this option. Then click Apply Test Account to set up
or access your IPpay test account.

Hotspot Operator Click Go to Hotspot Manager
to manage Wireless Guests, Payments/Transactions,
Vouchers, and Operator Accounts. See Hotspot
Manager on page 113.

Authentication > External Portal Server
Select this option if you are using an external server to
host a custom guest portal.
When logging in with voucher-based Hotspot

authentication, guests will be required to enter the
voucher number before gaining access to the Internet.

to the Internet.
Custom Portal Enter the IP address in the IP Address field.
When logging in with payment-based Hotspot

authentication, guests will be required to select the
package type and click the payment choice before gaining
access to the Internet.

Access Control

to the Internet.
Pre-Authorization Access Enter any subnets that you

want guests to be able to access, even if they have not
been authenticated. Click the delete icon to remove a
subnet from this list.
You can select Enable terms of service under Settings
> Guest Control > Portal Customization to enforce
selection of the terms of service by the guest. See Portal
Customization with LegacyJSP on page 117 for more
information.
Add Subnet Click Add Subnet to add more allowed

subnets.
Post-Authorization Restrictions Enter any subnets that
you dont want guests to be able to access. Click the delete
icon to remove a subnet from this list.
Add Subnet Click Add Subnet to add more restricted
subnets.
33
Settings > Admins
Name Enter the name of the new administrator.
You can create administrator accounts that are

sitespecific; these site administrators can only see the
sites they manage and cannot see any devices that are
Pending Approval.
Invite to SDN Select this option to allow the new

administrator access to SDN (Software-Defined
Networking) settings. The new administrator must use
his or her own cloud account (linked to the same email
address) to manage the UniFi Controller. The admin
who issued the invitation can select which role the
new administrator will have with respect to the UniFi
Controller.
The super admin account is created during the Setup

Wizard and has global admin (read/write) access; this
super admin account cannot be revoked or re-invited.
Only the super admin not any site admin can view
wired devices that are Pending Approval and then adopt
them on the UniFi Controller.
Note: Ensure that you save the super admin login
information for futureuse, including the adoption of
new wired devices.
To create operator accounts for the Hotspot Manager, see
Operator Accounts on page 115.
Username Displays the name of the administrator.

Email Displays the email address of the administrator.
Role Displays the permissions level: Admin (read/write
access) or Read Only.
Verified Displays a checkmark to indicate that an admin
is verified after he or she responds to an email invitation.
Role Select Administrator (read/write access) or

ReadOnly.
Invite Click to send an email invitation.
Settings > User Groups

Configure user groups on this screen. The default user
group is named Default and has no bandwidth limits.
User Group Settings

Name Displays the name of the user group.
Bandwidth Limit (Download) Displays the download
limit.
Bandwidth Limit (Upload) Displays the upload limit.
Revoke Click
Edit Click
to make changes to the user group
settings. Go to the Create or Edit a User Group on
page 34 section below.
REVOKE
Re-invite Click
pending account.
Edit Click
EDIT
to remove the selected account.

to re-send an invitation to a
to make changes.
Create New Admin Click

to add a new site
admin. Go to the Create or Edit an Admin section.
To create operator accounts for the Hotspot Manager, see
Operator Accounts on page 115.
Create or Edit an Admin
Email Enter the email address of the new administrator.

34
EDIT
to delete the user group. (The

Delete Click
Default user group cannot be deleted.)
Create New User Group Click
to create
a new user group. Go to the Create or Edit a User Group
section.
Create or Edit a User Group
Name Enter or edit the name of the user group.

Bandwidth Limit (Download) Select to limit the
download bandwidth. Enter the maximum in Kbps.
Bandwidth Limit (Upload) Select to limit the upload
bandwidth. Enter the maximum in Kbps.
See Wireless Client Configuration on page 111
or Wired Client Configuration on page 112
for information on how to assign a user or guest to a
usergroup.
Settings > Controller

(Available for the superadmin only.) Configure the system
settings of the UniFi Controller.

Port The default is 25. If Secure Sockets Layer (SSL)
is enabled, then the port number will automatically
change to 465.
Enable SSL You can enable SSL to enhance secure
communications over the Internet.
Enable authentication Select this option to enable
authentication.
-- Username Enter the username required by the
mailserver.
-- Password Enter the password required by the
mailserver.
Specify sender address Select this option to specify
the sender email address. Enter the email address that
will appear as the sender of the email alert.
Test SMTP Server Enter an email address and click
Send to test the mail server setup.
Settings > Cloud Access

Set up the login for cloud access.
Controller Settings
Controller Hostname/IP Enter the hostname or IP
address of the UniFi Controller.
Note: When alert emails are sent out, the Controller
Hostname/IP will be specified in the Controller URL at
the bottom of every message.
Override inform host with Controller
Hostname/IP An inform host URL is used for layer-3
device adoption using the UniFi Discovery Utility. Select
this option to override the inform host URL. Then enter
the appropriate hostname or IP address.
Enable Cloud Access Click to configure the login. The

Cloud Login Credentials screen will appear.
Cloud Login Credentials
Note: The default inform port is 8080. (You can

customize this in system.properties.)
Network Discovery When enabled, this option allows
UniFi to be discoverable via UPnP on the Layer-2 network.
This option is disabled by default.
Support Messaging Select the appropriate option:
Enable Live Chat for the Super Admin only, Enable Live
Chat for all users, or Disable Live Chat for all users.
Mail Server
When enabled, UniFi will send email alerts triggered by
disconnected UniFi devices. Specify the administrator
email address when you create an account under
Settings > Admins on page 34.
SMTP Server Select this option to enable emails.
Hostname Enter the outgoing (SMTP) mail server
name.
Email or Username Enter the email address or

username of your UBNT account.
Password Enter the password of your UBNT account.
No account? Register now. If you do not have a UBNT
account, click here to visit this link:
https://account.ubnt.com/register
Follow the on-screen instructions to set up an account.
Enable Cloud Access Click to save changes.
35
Cloud Access
Settings > Maintenance
If the login for cloud access is configured, then the Cloud

Access screen will appear:
(Available for the superadmin only.) The Maintenance

screen contains administrative options, so you can
customize logs, manage system backups, and download
configuration information to assist in support issues.
If your UniFi Controller is running on a UniFi Cloud Key,
you can use the Maintenance tab to upgrade the UniFi
Cloud Key firmware, upgrade the UniFi Controller software
located on the UniFi Cloud Key, reboot the UniFi Cloud
Key, power it off, or reset it to factory defaults.
Enable Cloud Access Click to enable or disable cloud

access.
Status Displays Connected if cloud access is active.
Configured for Displays the username or email address
of your UBNT account.
Disable User Cloud Access (Available if you are a site
admin.) Click to disable cloud access and remove the
cloud login credentials.
Server Information
Disable and Remove Cloud Access (Available if you are
a super-admin.) Click to disable cloud access and remove
the cloud login credentials.
Note: Enabling or disabling cloud access will affect
cloud access for all admins on that UniFi Controller.
Current Version Displays the software version.
Services
Log Level You can customize the support information
that is collected:
Device Select the level of severity required to trigger
device log entries: Normal, More, or Debug. The default
is Normal.
Mgmt Select the level of severity required to trigger
management log entries: Normal, More, or Debug. The
default is Normal.
System Select the level of severity required to trigger
system log entries: Normal, More, or Debug. The
default is Normal.

Historical Data Retention Select the time duration of

the historical data retention: 7 days, 30 days, 60 days,
90 days, 180days, 365days, or Disabled. The default is
Disabled. Then click Apply.
Compact Database Click to optimize disk usage by
freeing up pre-allocated disk space. There may be
service interruptions during the process. Click Confirm
to continue.
36

Conn Monitor Displays the status of the Uplink
Connectivity Monitor feature, which is configured in
Settings > Site on page 20.
Cloud Access Displays the status of the Cloud Access
feature.
Current Site Displays the name of the current site.
Networks Displays the name(s) of the current
network(s).
Wireless Networks Displays the name(s) of the current
wireless networks.
Guest Portal Displays the status of the Guest Portal
feature, which configured in Settings > Guest Control
on page 27.
Authentication Displays the type of authentication
required for guest access, which configured in Settings
> Guest Control on page 27.
Expiration Displays the period of time before a guest
login expires, which configured in Settings > Guest
Control on page 27.
Backup
Backup Data Retention Select the time duration of the
backup data retention: 7 days, 30 days, 60 days, 90 days,
180 days, 365days, or All time. The default is 7days.
Download Backup Click this option to download a file
that contains all of your settings and data retained for the
duration you specify, so you can restore them later if you
choose.
Restore
Browse Click Choose File to select a backup file that
youve already downloaded. Follow the on-screen
instructions to restore settings from the selected file.
Landing Page Displays the type of landing page for

guest access, which configured in Settings > Guest
Control on page 27.
Portal Customization Displays the status of the Portal
Customization feature, which configured in Portal
Customization on page 29.
Close Click Close to exit this screen.
Download Click Download to download a screenshot
in .png format.
Network Config
System Config Click Show System Config to view

configuration settings. The System Config screen appears.
Support Info
Download Click this option to download a file to your
computer with information about your configuration. You
can email this file to our support team.
System Config
Name Displays the name of the local wired network.

Purpose Displays a description of this network.
Subnet Displays the IP address and prefix size.
DHCP Server Displays the status of the DHCP server
feature.
DHCP Range Displays the range of available IP
addresses.
DHCP Name Server Displays the IP address of the DNS
server.
Network Config Click Network Config to view the

network configuration settings.
Version Displays the software version.
DPI Displays the status of the DPI (Deep Packet
Inspection) feature, which is configured in Settings >
Site on page 20.
DHCP WINS Server Displays the IP address of the WINS

server.
DHCP Lease Time Displays the lease time for any
assigned IP address.
IGMP Snooping Displays the status of the IGMP
Snooping feature.
Close Click Close to exit this screen.
Download Click Download to download a screenshot
in .png format.
37
Cloud Key Firmware
Cloud Key Operations
The Cloud Key Firmware section is available if you are using

a UniFi Cloud Key.
Restart Cloud Key Click this option to powercycle the

UniFi Cloud Key.
Shut Down Cloud Key Click this option to turn off the
UniFi Cloud Key.
Reset Cloud Key Click this option to reset the UniFi Cloud
Key to its factory default settings. This option will reboot
the UniFi Cloud Key, and all factory default settings will be
restored.
37 for more information) before resetting the
UniFi Cloud Key to its defaults.
Chat with Us
Click
to open a window for online chat suport.
Current Version Displays the version number of the UniFi

Cloud Key firmware. Click Check for Update to see if there
is a newer firmware version. If there is, then you can follow
the on-screen instructions to upgrade now.
Available Version If there is an available update, then
the available firmware version number is displayed. Click
Apply Update to upgrade the firmware.
Status Displays the current status, Up to Date or Update
Available.
Cloud Key Controller

The Cloud Key Controller section is available if you are
using a UniFi Cloud Key.
Current Version Displays the version number of the UniFi
Controller software. Click Check for Update to see if there
is a newer software version. If there is, then you can follow
the on-screen instructions to upgrade now.
Available Update If there is an available update, then
the available software version number is displayed. Click
Apply Update to upgrade the software.
Status Displays the current status, Up to Date or Update
Available.
38
Chapter 4: Dashboard
Red The Speed Test is not available because it requires an

active UniFi Security Gateway.
The Dashboard screen provides a visual representation of

your networks status. Basic information is provided for
each node:
Status information Place your mouse over the Latency or

Throughput monitor to display the following:
Latency
Throughput
WAN on page 40
LAN on page 40
WWW
Current status information is displayed.
providers gateway.
WLAN on page 41
DNS Displays the IP addresses of the Domain Name

System (DNS) servers.
Latency
IP Displays the Internet IP address of the UniFi Security

Gateway.
The latency value from the latest Speed Test is displayed.

The monitor is color-coded to indicate status:
Black A UniFi Security Gateway is active, and the Speed
Test is available.
Red The Speed Test is not available because it requires an
active UniFi Security Gateway.
Throughput
The throughput value from the latest Speed Test is
displayed. The monitor is color-coded to indicate status:
Uptime Displays the length of time the Internet

connection has been active.
Latency Displays the amount of time it takes a packet
to travel from the UniFi Security Gateway to the service
providers gateway.
connection.
connection.
Black A UniFi Security Gateway is active, and the Speed

Test is available.
39
Speed Test
WAN
Results from the latest Speed Test are displayed.
The basic details of the UniFi Security Gateway are

displayed.
Last Run Displays the duration of time since the last

Speed Test.
providers gateway.
Up Displays the upload speed.
Down Displays the download speed.

Green The WAN connection is active.
Red The WAN connection is inactive.
Active Devices Displays the number of Gateway devices
adopted and active.
Inactive Displays the number of Gateway devices
adopted but not active.
Pending Displays the number of Gateway devices
pending adoption.
Status information Place your mouse over the monitor
to display the following:
Speed Test Click the monitor to run the Speed Test.
LAN IP Displays the local IP address of the UniFi

Security Gateway.
Clients Displays the total number of local clients.
connection.
connection.
After the Speed Test is complete, the following will be

displayed:
Latency, duration of the average Ping round-trip time
Download speed
Upload speed
LAN
The basic details of the wired network(s) are displayed.

Run Speed Test Click to run the test again.
Close Click to exit the Speed Test.
Green The wireless network is active.

Red The wireless network is inactive.
Active Devices Displays the number of wired devices
adopted and active.
Inactive Displays the number of wired devices adopted
but not active.
40
Pending Displays the number of wired devices pending

adoption.
Gateway Displays the Internet IP address of the UniFi
Security Gateway.
Users Displays the number of clients connected to the
wired network.
Guests Displays the number of clients connected to the
guest wired network.
Switches Displays the number of UniFi Switches
managed on this site.
Down Displays the download rate of the wired
network(s).
Download Throughput & Latency

The historical chart displays the download traffic in terms
of throughput and latency over a 24-hour period.
Note: A UniFi Security Gateway must be active to
enable this chart.
Up Displays the upload rate of the wired network(s).
Avg/Max Throughput Average throughput is displayed

as a dark gray bar. Maximum throughput is displayed as a
light gray bar.
Latency Latency is displayed as a blue line.
WLAN
The basic details of the wireless network(s) are displayed.
Status information Place your mouse over a specific

point to display the following about a date and time:
Avg/Max Throughput Displays the average and
maximum throughput values.
Latency Displays the latency value.
Upload Throughput & Latency

The historical chart displays the upload traffic in terms of
throughput and latency over a 24-hour period.
Note: A UniFi Security Gateway must be active to

enable this chart.
Green The wired network is active.

Red The wired network is inactive.
Active Devices Displays the number of APs adopted and
active.
Inactive Displays the number of APs adopted but not
active.
Pending Displays the number of APs pending adoption.
Users Displays the number of clients connected to the
primary wireless network(s).
Guests Displays the number of clients connected to the
guest wireless network(s).
APs Displays the number of APs managed on this site.
Avg/Max Throughput Average throughput is displayed

as a dark gray bar. Maximum throughput is displayed as a
light gray bar.
Latency Latency is displayed as a blue line.
point to display the following about a date and time:
Avg/Max Throughput Displays the average and
maximum throughput values.
Latency Displays the latency value.
Down Displays the download rate of the wireless

network(s).
Up Displays the upload rate of the wireless network(s).
41
Devices on 2.4 GHz Channel

The 2.4 GHz Channel Occupancy Chart displays the
channel use of the 2.4 GHz devices.
Note: At least one 2.4 GHz UniFi AP must be active
to enable this chart.

WLAN Displays the number of wireless devices.
device category to display the device models and their
quantities.
Clients
Network clients are displayed.
Note: The DPI feature must be enabled to display
client information.
1-11 Each device is displayed as a blue square in its

channel.
channel to display the number of devices using that
channel.
Devices on 5 GHz Channel

The 5 GHz Channel Occupancy Chart displays the channel
use of the 5 GHz devices.
Note: At least one 5 GHz UniFi AP must be active to
enable this chart.
Traffic Displays the total number devices and a

colorcoded breakdown of the device types.
Ubiquiti Displays the number of Ubiquiti clients.
(Various) Displays the number of clients that belong in
each of the remaining client categories.
Other Displays the number of clients that dont belong in
the aforementioned categories.
client category to display the client category name.
Deep Packet Inspection
(Channels) Each device is displayed as a blue square in its

channel.
channel to display the number of devices using that
channel.
Devices
UniFi devices are displayed.
Traffic Displays the total number devices and a

colorcoded breakdown of the device types.
WAN Displays the number of gateway devices.
Deep Packet Inspection (DPI) is more advanced than

conventional Stateful Packet Inspection (SPI) filtering for
traffic analysis. Ubiquitis proprietary DPI engine includes
the latest application identification signatures to track
which applications (and IP addresses) are using the most
bandwidth.
The DPI feature requires the following:
A UniFi Security Gateway must be active to enable this
feature.
DPI must enabled on the Settings > Site screen. See
Settings > Site on page 20 for more information.
Traffic Displays the total amount of traffic and a colorcoded breakdown of the traffic types.
Streaming Media Displays the amount of data that is
identified as streaming media.
LAN Displays the number of wired devices.

42
Network Protocols Displays the amount of data that is

identified as network protocol traffic.
Web / Web 2.0 Displays the amount of data that is
identified as web-related traffic.
Security Update Displays the amount of data that is
identified as part of a security update.
Unknown Displays the amount of data that is
unidentified.
Other Displays the amount of data that doesnt belong in
the aforementioned categories.
traffic category to display the traffic category name and
amount of data.
43
44
Chapter 5: Map
Chapter 5: Map
The UniFi Controller software allows you to upload custom
map images of your location(s) or use Google Maps for
a visual representation of your UniFi network. When you
initially launch the UniFi Controller application, a default
map is displayed. The legend at the bottom of the map
shows the scale of the map.
2. Click Add a Map.
3. The default is Google Maps. Click Upload Image.
Adding Custom Maps

To add a custom map, you must first create the image
using an illustration, image editing, or blueprint
application that exports a file in .jpg, .gif, or .png
fileformat.
Once youve created the map, you can upload it to the
UniFi Controller software:
1. Click
45
Chapter 5: Map
4. Click Choose map image.
Adding a Google Map

To add a Google Map to the UniFi Controller software
Mapview:
1. Click
5. Locate the file to use as a map (valid file formats are

.jpg, .gif, and .png) and then click Open. If you do not
want to upload a file, click Cancel.
2. Click Add a Map.
3. The default view is Map view, which looks like a street

map. Click Terrain to display geographic markers.
Use the tools to navigate the map or adjust the zoom
using the zoom control.
6. Enter a map name in the field provided and click Save.
Note: If the map is incorrect, click Select a different
map and try again.
In the field provided, enter an address or the latitude

and longitude of a specific location. Then press Enter
or Return.
7. Click Done.
46
Chapter 5: Map

You can also click Satellite for a birds-eye view. Click
Labels to display street and location names.
Status
The device icon indicates the UniFi model (not all icons are
shown below):
UniFi AP Pro, UniFi AP AC Lite/LR/Pro
UniFi AP AC EDU
UniFi AP In-Wall
UniFi AP/AP LR
UniFi AP AC
UniFi AP AC Outdoor
UniFi AP Outdoor+
UniFi AP Outdoor5
Enter a map name in the field provided and click Save.

You can adjust
4. Click Done.
Placing Devices on the Map

1. Click
at the lower right.
2. Drag each device icon from the Unplaced Devices list to

the appropriate location on themap.

UniFi Security Gateway Pro
UniFi 24-Port Switch
UniFi VoIP Phone/Pro
UniFi VoIP Phone Executive
The LED color of the icon indicates the device status.
Blue/Green Indicates the device is connected.
Red/Orange Indicates the device is disconnected. A
disconnected icon also marks the device icon.
Device Options
Click a UniFi icon to reveal options. Click the UniFi icon
again to hide them.
Lock Lock the device icon to its current location.
Details Display the Details screen. For more
information, go to the appropriate chapter:
The device icon will appear in the area that you placed it.

Statistics (Available for the UAPACLITE,
UAPACLR, UAPACPRO, and UAPACEDU only.)
Displays the RF Environment screen. For more
information, go to RF Environment on page
98.
Remove Remove the device icon from its location.
47
Chapter 5: Map
Map Display Options

(Map) If multiple maps have been uploaded, you can
select which map you want to view using this option.

Details Displays the applicable information:
MAC address, transmit/receive channel(s), number of users
connected, and number of guests connected.

2G Devices Displays the 2.4 GHz devices.
5G Devices Displays the 5 GHz devices.
Coverage Displays a visual representation of the wireless
range covered by any APs.
2G Coverage Displays the coverage by 2.4 GHz devices.
5G Coverage Displays the coverage by 5 GHz devices.
-- __ dBm You can change the receiver sensitivity value
for more accurate coverage results. The default is
-90dBm.
Each device is displayed with its name. If no custom label

is applied, the devices MAC address will be displayed.
To change a name applied to a device, refer to Alias in the
appropriate section:
UniFi Security Gateway Configuration on page
79
UniFi Switch Configuration on page 89
UniFi Access Point Configuration on page 100
You can apply one of the following display options:
Details
Coverage
Topology
48
Topology Displays a visual representation of the network

configuration and connections between any APs. A
dashed line will indicate the wirelessly connected AP and
its uplink to a wired AP, even if the wirelessly connected
AP is isolated.
Chapter 5: Map

Configure Maps Click
the current map(s).
to add maps or edit
The left side of the map offers the following options:

Zoom Slider Use to zoom the map detail in and
out.
Unplaced Devices Drag each device icon from the
Unplaced Devices list to the appropriate location on
themap.
Set Map Scale Use this option to define the scale
of the map. You will draw a line and define the
distance that the line represents.
Setting the Map Scale

1. Click the set map scale
button.
2. Click and hold to draw a line in the area that you want
to use to set the scale of the map. If you need to redraw
the line, just click and hold again to draw a new line.
3. Enter the distance that the line represents in the

Distance field. By default, the distance is specified in
meters but you can switch to feet using the drop-down
menu on the right. Click Set Scale.
The legend at the bottom of the map shows the new scale
of the map.
49
Chapter 5: Map
50
Chapter 6: Devices
Chapter 6: Devices
The Devices screen displays a list of UniFi devices
discovered by the UniFi Controller. You can click any of the
column headers to change the listorder.
All Displays all UniFi devices.
Gateway/Switches Displays all UniFi Security Gateways
and Switches.
APs Displays all UniFi APs.
Phones Displays all UniFi VoIP Phones.
If the APs filter is applied, then another filter is available:
Overview Displays the number of clients, amount
of data downloaded, amount of data uploaded, and
channel setting.
If there is more than one page of entries to display, click

the navigation controls or page numbers at the bottom
right of the screen to display different pages.
Search
(sort) You can click any column to sort the displayed list.
The selected column displays or to indicate ascending
or descending order.
The icon column sorts by state, and for connected devices
it also sorts by device type. This is the order:
Connected Gateway
Connected Switch
Connected AP
Connected Phone
Any device that is being upgraded or provisioned
Config Displays the WLAN and radio settings for the

2.4GHz and 5 GHz radio bands.
Any device that is being adopted or is restarting
Performance Displays the number of 2.4 GHz and

5GHz clients, overall transmit rate, overall receive rate,
transmit rates in the 2.4 GHz and 5GHz radio bands, and
channel setting.
Items per page Select how many results are displayed
per page: 10, 50, 100, or 200.
Any device that is disconnected or in an error state
Any device that is pending

After this sorting is applied, the sort order uses
alphabetical order according to the device name.
Customize Columns Each primary filter: All,
Gateway/Switches, APs, or Phones applies a default set of
columns to display. If you enable the Customize Columns
option, then the primary filter no longer changes the
columns.
51
Chapter 6: Devices
The very first time you enable the Customize Columns
option, the UniFi Controller software will detect which
columns are currently visible and remember your
selection. For example:
1. Enable the Customize Columns option on the APs >
Performance screen.
2. Disable customization.
3. Apply the Gateway/Switches filter.

-- AP Performance The Device Name, IP Address, Status,
2G Clients, 5G Clients, TX, RX, TX 2G, TX 5G, and Channel
columns are displayed.
-- All columns The Device Name, MAC Address, IP
Address, Status, Model, Version, Uptime, Clients, Down,
WLAN2G, WLAN5G, Radio2G, Radio5G, 2G Clients, 5G
Clients, TX, RX, TX 2G, TX 5G, and Channel columns are
displayed.
4. Enable the Customize Columns option again.

5. The columns of the APs > Performance screen will be
displayed.
Click
to customize the columns used for display.
Select Customize columns.
All
All UniFi device types are displayed.
(icon) Displays the icon corresponding to the UniFi device
(not all icons are shown below):
You can select additional columns for display.
Reset columns to Click the drop-down at the bottom
of the Customize columns screen to display the Reset
columns to ... options. The option you select will apply
no matter which primary filter: All, Gateway/Switches,
APs, or Phones you select. This resets the columns but
the UniFi Controller software will not remember your
selection.

UniFi AP AC EDU
UniFi AP In-Wall
UniFi AP/AP LR
UniFi AP AC
UniFi AP AC Outdoor
-- Default The Device Name, IP Address, Status, Model,

Version, and Uptime columns are displayed.
UniFi AP Outdoor+
-- Gateway/Switches The Device Name, IP Address,

Status, Model, Down, and Up columns are displayed.
-- AP Overview The Device Name, IP Address, Status,

Model, Clients, Down, Up, and Channel columns are
displayed.
-- AP Config The Device Name, Status, Version, WLAN2G,

WLAN5G, Radio2G, and Radio5G columns are
displayed.
52
UniFi AP Outdoor5
Chapter 6: Devices

If displayed, the LED color of the device icon indicates the
device status.
Gateway/Switches
All UniFi Gateway and Switch devices are displayed.
Gray Indicates the device is pending approval.

Red/Orange Indicates the device is disconnected or
not managed by this site (Pending Approval or Managed
by Other).
Device Name Displays the hostname, alias, or MAC
address of the UniFi device. You can click the name to
get additional details. For more information, see the
appropriate chapter:
IP Address Displays the IP address used by the UniFi
device.
Status Indicates the device status: Connected,
Disconnected, Pending Approval, Adopting, Upgrading,
Managed by Other, or Isolated (APs only).
devices that are Pending Approval and then adopt them on
Note: The super admin account was created during
the initial installation; for more information, see
Configuring the UniFi Controller Software on
page 2.
Model Displays the model name of the UniFi device.
Version Displays the version number of the UniFi devices
firmware.
Uptime Displays the duration of time the UniFi device has
been running.
Locate For most devices, click
to flash the LED
on the physical device and the devices icon on the
Map tab so you can locate it. The LED will flash until the
Locate button is clicked again. (The icon on the Map tab
will flash three times and stop.)
If the device is a Phone, then click
to ring the
Phone and flash the Phones icon on the Map tab so you
can locate it. The Phone will ring until you click Locate
again. (The icon on the Map tab will flash three times
and stop.)
Restart Click
to restart the selected device.
Upgrade If a software upgrade is available for the

device, click
to install the latest UniFi firmware
on the device. The Status will appear as Upgrading until
the process is complete and the device reconnects to
the UniFi Controller software.
Adopt Click
to adopt a device that appears as
Pending Approval for its status. The Status will appear as
Adopting until the device is connected.
(icon) Displays the icon corresponding to the UniFi device

The LED color of the device icon indicates the device
status.
Blue Indicates the device is connected.
Red Indicates the device is disconnected or not
managed by this site (Pending Approval or Managed by
Other).
address of the UniFi device. You can click the name to
get additional details. For more information, see the
appropriate chapter:
IP Address Displays the IP address used by the UniFi
device.
Disconnected, Pending Approval, Adopting, Upgrading, or
Managed by Other.
page 2.
Down Displays the total amount of data downloaded by
the UniFi device.
53
Chapter 6: Devices
Up Displays the total amount of data uploaded by

theUniFi device.
to flash the Status LED on the
Locate Click
Gateway/Switch and its icon on the Map tab so you can
locate it. The LED will flash until the Locate button is
clicked again. (The icon on the Map tab will flash three
times and stop.)
Restart Click

device, click
Adopt Click
APs
You can apply one of the following filters to display
different status information:
Overview Displays the number of clients, amount
of data downloaded, amount of data uploaded, and
channel setting.
Performance Displays the number of 2.4 and 5GHz
clients, overall transmit rate, overall receive rate, 2.4 and
5 GHz transmit rates, and channel setting.
Config Displays the WLAN and radio settings for the
2.4GHz and 5 GHz radio bands.
On any sub-tab, you can initiate a rolling upgrade of the
firmware for all APs.
Start Rolling Upgrade (Available if any AP has an
upgrade available.) Click START ROLLING UPGRADE to begin
automatically upgrading APs, one by one, except for
wirelessly uplinked APs, which are intentionally excluded
from upgrading.
Overview
(icon) Displays the icon corresponding to the AP model

UniFi AP AC EDU
UniFi AP In-Wall
UniFi AP/AP LR
UniFi AP AC
UniFi AP AC Outdoor
UniFi AP Outdoor+
UniFi AP Outdoor5
by Other).
address of the AP. You can click the name to get additional
details; see UniFi Access Point Details on page 95
for more information.
IP Address Displays the IP address of the AP.
Status Displays the connection status.
Connected The AP is physically wired to thenetwork.
Connected (100 FDX) The AP is physically wired to the
network at 100 Mbps in full-duplex mode.
Connected (wireless) The AP is wirelessly uplinked to a
physically wired AP.
Disconnected The AP is unreachable by the UniFi
Isolated A managed AP is unable to locate itsuplink.
Managed by Other The AP is not in the default state
but it is not controlled by the UniFi Controller.
Pending Approval The AP is in the default state and is
available for adoption.
devices that are Pending Approval and then adopt them
on the UniFi Controller.
Note: The super admin account was created
during the initial installation; for more
information, see Configuring the UniFi
Controller Software on page 2.
Clients Displays the number of clients connected to
theAP.
the AP.
54
Chapter 6: Devices

Up Displays the total amount of data uploaded by the AP.
Channel Displays the transmit/receive channel being
used by the AP. The radio band is represented as (ng) for
2.4 GHz and (na)/(ac) for 5 GHz.

Locate Click
to flash the LED on the AP and the
APs icon on the Map tab so you can locate it. The LED
will flash until the Locate button is clicked again. (The
icon on the Map tab will flash three times and stop.)
Restart Click


device, click
Adopt Click
Performance
Connected The AP is physically wired to the network.


2G Clients Displays the number of clients connected to
the AP using the 2.4 GHz band.
5G Clients Displays the number of clients connected to
the AP using the 5 GHz band.
TX Displays the overall TX (transmit) rate.

RX Displays the overall RX (receive) rate.

TX 2G Displays the overall TX rate for the 2.4 GHz radio
band. The different colors represent different types of
packet activity:
UniFi AP AC EDU
UniFi AP In-Wall
Color
Packet Activity
Packets sent
UniFi AP/AP LR
Packets retried
UniFi AP AC
Packets not sent due to likely interference
UniFi AP AC Outdoor
UniFi AP Outdoor+
UniFi AP Outdoor5
TX 5G Displays the overall TX rate for the 5 GHz radio

band. The different colors represent different types of
packet activity:
Color
Packet Activity
Packets sent
Packets retried

by Other).
Packets not sent due to likely interference
55
Chapter 6: Devices
Channel Displays the transmit/receive channel being

used by the AP. The radio band is represented as (ng) for
2.4 GHz and (na)/(ac) for 5 GHz.


Locate Click
Restart Click


device, click
Adopt Click
Config
Connected The AP is physically wired to thenetwork.


Version Displays the version number of the UniFi APs
firmware.
WLAN 2G Displays the name of the WLAN group using
the 2.4 GHz radio band.

UniFi AP AC EDU
UniFi AP In-Wall
UniFi AP/AP LR
UniFi AP AC
UniFi AP AC Outdoor
UniFi AP Outdoor+
UniFi AP Outdoor5
by Other).
56
WLAN 5G Displays the name of the WLAN group using

the 5 GHz radio band.
Radio 2G Displays the channel and TX power settings
used in the 2.4 GHz radio band.
Radio 5G Displays the channel and TX power settings
used in the 5 GHz radio band.
Locate Click
Restart Click

device, click
Adopt Click
Phones
Important: For management of the UniFi VoIP
Phones, please download the UniFi VoIP Controller
here: downloads.ubnt.com/unifi
Chapter 6: Devices
Adopt Click
(icon) Displays the icon corresponding to the Phone (not

all icons are shown below):
address of the Phone. You can click the name to get
additional details; see UniFi VoIP Phone Details on
IP Address Displays the IP address used by the Phone.
Disconnected, Pending Approval, Adopting, Upgrading, or
Managed by Other.
page 2.
Model Displays the model name of the Phone.
Version Displays the version number of the Phones
firmware.
Uptime Displays the duration of time the Phone has been
running.
Locate Click
to ring the Phone and flash the
Phones icon on the Map tab so you can locate it. The
Phone will ring until you click Locate again. (The icon on
the Map tab will flash three times and stop.)
Restart Click

device, click
57
Chapter 6: Devices
58
Chapter 7: Clients
Chapter 7: Clients
The Clients screen displays a list of network clients. You can
click any of the column headers to change the listorder.
All Displays all clients, regardless of connection type.
Wireless Displays all wireless clients.
Wired Displays all wired clients.
A secondary filter is available:
All Displays all users and guests.
Users Only displays users.
Guests Only displays guests.
per page: 10, 50, 100, or 200.
The columns of information vary depending on which
primary filter (All, Wireless, or Wired) is applied.
The icon column sorts by state, and for connected devices
it also sorts by device type. This is the order:
Connected wireless user
Connected wireless guest
Connected wired user
Connected wired guest
After this sorting is applied, the sort order uses
alphabetical order according to the client name.
Customize Columns Each primary filter: All, Wireless, or
Wired applies a default set of columns to display. If you
enable the Customize Columns option, then the primary
filter no longer changes the columns.
Click
Search
59
Chapter 7: Clients

Signal Displays the signal strength level and signal
type:
TX Rate Displays the overall TX (transmit) rate.
RX Rate Displays the overall RX (receive) rate.
Activity Displays the relative level of activity for each
client.
Down Displays the total amount of data downloaded
by the client.
theclient.
Uptime Displays the amount of time the client has
been connected for this session.
All
You can select additional columns for display. Options
include the following:
Name Displays the hostname, alias, or MAC address
of the connected client. You can click the name to get
additional details; refer to Chapter 7: Clients on page
59 for more information.
Hostname Displays the hostname of the connected
client.
MAC Address Displays the MAC address of the
connected client.
IP Address Displays the IP address used by the client.
802.1x Identity Displays the identity used for 802.1x
authentication.
802.1x VLAN Displays the VLAN (Virtual Local Area
Network) used for 802.1x authentication.
Status Displays Authorized for all authorized guests or
Pending for guests pending authorization.
Network Indicates which local network is used.
AP/Port For wireless clients, displays the name of the
connected AP or port. You can click the name to get
additional details; refer to UniFi Access Point Details
on page 95 for more information.
For wired clients, displays the name of the network
device and port number used by the client. You can
click the name to get additional details; refer to UniFi
Switch Details on page 85 for more information.
Channel Displays the channel used.
PHY Mode Displays the wireless standard and
frequency band used by the signal. Displays a leaf
icon if the device uses power save mode.
11na (5 GHz)
11ac (5 GHz)
11ng (2.4 GHz)
11b (2.4 GHz)
60
(icon) Displays the icon corresponding to a wireless or

wired client:
wireless user
wireless guest
wired user
wired guest
Name Displays the hostname, alias, or MAC address of the
connected client. You can click the name to get additional
details; refer to Client Details on page 109 for more
information.
Connection Indicates which local network is used. If
the connection is wireless, then this displays the wireless
network name or SSID.
AP/Port Indicates which AP or switch port is used.
client.
the client.
theclient.
Uptime Displays the amount of time the client has been
connected for this session.
Block Click BLOCK to block this client from accessing
the network. Click UNBLOCK to unblock this client.
Reconnect Click RECONNECT to reconnect a wireless
client. You can click RECONNECT to kick out a client,
which usually reconnects back quickly; this is useful for
troubleshooting or resolving a problematic wireless
connection.
Unauthorize/Authorize (Available for Guests only.)
Click UNAUTHORIZE to remove authorization of guest access
and disconnect the guest, or click AUTHORIZE for guests
pending authorization.
Chapter 7: Clients
Wireless

the client.
theclient.
Frequency band If the Wireless filter is applied, then the

Frequency band filter is available:
All Displays all wireless clients.
2G Only displays 2.4 GHz clients.
5G Only displays 5 GHz clients.
AP Select the AP whose clients you want displayed. Each
option in the drop-down list also indicates the number of
wireless clients in parentheses.

connection.
Wired
(icon) Displays the icon corresponding to a wireless client:

wireless user
wireless guest
information.
Status (Displayed when the Guests filter is applied.)
Displays Authorized for all authorized guests or Pending for
guests pending authorization.
Network If the Wired filter is applied, then the Network

filter is available. Each option in the drop-down list also
indicates the number of wired clients in parentheses.
WLAN Displays the name of the wireless network.
All Displays all wired clients.
AP/Port Displays the name of the connected AP. You

can click the name to get additional details; refer to
UniFi Access Point Details on page 95 for more
information.
(name) Select the network whose clients you want

displayed.
(icon) Displays the icon corresponding to a wired client:
wired user
Phy Mode Displays the wireless standard and frequency

band used by the signal. Displays a leaf icon if the
device uses power save mode.
wired guest
11ac (5 GHz)

information.
11ng (2.4 GHz)
11b (2.4 GHz)
Network Indicates which local network is used.
Signal Displays the signal strength level and signal type:
AP/Port Displays the name of the network device and

port number used by the client. You can click the name to
get additional details; refer to UniFi Switch Details on
11na (5 GHz)

client.
61
Chapter 7: Clients

client.
the client.
theclient.
62
Chapter 8: Statistics
The Statistics screen provides a visual representation
of the clients and network traffic connected to your
managed UniFi network.
Overview
The Overview screen describes the usage by wireless
clients and UniFi Access Points.
There are two views available:

Overview The default view describes the wireless
clients and network traffic. Please refer to the next
column for more information.
Traffic Stats (Available if you have a UniFi Security
Gateway with the DPI feature enabled.) The Traffic Stats
screen describes the network traffic by application
usage. Go to Traffic Stats on page 65 for more
information.
24 Hours The default view. Select Week or Month to
change the duration interval.
Date Click either arrow to change the date in one-day
increments.
63
Click the date to display the calendar.
You can select multiple APs for filtering. For example, if

you select a second AP:
Calendar Click a specific date to display its statistics.

Click either arrow to change the calendar in one-month
increments.
A third graph that is color-coded to the additional AP

appears.
Filter You can view the number of clients and amount

of traffic by UniFi AP. The Filter drop-down list displays
managed UniFi APs by name or MAC address.
Click
to view the drop-down list. Then click the
appropriate AP.
A second graph that is color-coded to the selected AP

appears.
You can place your mouse over an hour or day to display

the number of clients and amount of data.
Clear Current Stats Reset the current statistics to

startover.
Clients (Total)
# of Clients A visual pie chart represents the client

distribution amongst the APs. Place the mouse cursor over
the chart for the number of clients per network.
Quick Look
64
Most Active AP
Recent Activities
The details of the most active Access Point are displayed:
The details of recent network activities are displayed.
Name or MAC address You can click this link to open the
AP Details screen. See UniFi Access Point Details on
page 95 for additional information.
Download Displays the total amount of data downloaded
by the AP.
Upload Displays the total amount of data uploaded by
the AP.
Most Active Client

The details of the most active client in current use are
displayed:
Clients In the graph, a dashed line displays the number of

clients connected during the selected time period. Place
the mouse cursor over an hour or day to display the exact
number.
Client Details screen. See Client Details on page 109
for additional information.
Traffic In the graph, a solid line displays the network

traffic during the selected time period. Place the mouse
cursor over an hour or day to display the specific amount
of data.

by the client.
Traffic Stats

the client.
(Available if you have a UniFi Security Gateway with the

DPI feature enabled. Go to Settings > Site on page
20 for more information.) The Traffic Stats screen
describes the network traffic by application usage.
All-Time Top Client

The details of the all-time, most active client are displayed:
Client Details screen. See Client Details on page 109
for additional information.
Uptime Displays the duration of time the client has been
connected.
Deep Packet Inspection (DPI) is more advanced than

conventional Stateful Packet Inspection (SPI) filtering for
traffic analysis. Ubiquitis proprietary DPI engine includes
the latest application identification signatures to track
which applications (and IP addresses) are using the most
bandwidth.

by the client.
the client.
Current Usage: Top Access Points

The details of the most active Access Points in current use
are displayed.
# of Clients A pie chart represents the client distribution
on the most active Access Points. Place the mouse cursor
over the chart for the number of clients per specified AP.
Overall Traffic
Applications are organized by category, such as Streaming
Media, Web / Web 2.0, and Network Protocols. The total
amount of traffic is broken down by category.
Traffic A pie chart represents traffic on the most active
Access Points. Place the mouse cursor over the chart for
the amount of traffic per specified AP.
Amount of Traffic A pie chart represents the traffic

distribution by the most popular categories. Place the
mouse cursor over the chart for the amount of traffic per
category.
65
A list displays a comprehensive breakdown of the traffic by

category. You can click any category to have it displayed
with a detailed breakdown of the application usage within
that category.
2. Select a category. You can also enter a keyword in the

Filter field; simply begin typing; there is no need to
press Enter.
(Category)
The most popular categories are displayed with the
amount of traffic broken down further by application.
Amount of Traffic A pie chart represents the traffic
distribution by the most popular applications. Place the
mouse cursor over the chart for the amount of traffic per
application.
3. Click Save.
A list displays a comprehensive breakdown of the traffic

by application.
You can click
to remove a category from display.
Add Category
To add a new category for display, follow these steps:
1. Click Add Category or the
66
sign.
Chapter 9: Insights
Chapter 9: Insights
On any sub-tab, you can click any of the column headers

to change the list order.
The Insights screen displays different kinds of status

information. Eight filters are available:

Known Clients Displays information about detected

clients.
Neighboring Access Points Displays information about
wireless devices not managed by the UniFi Controller.
Past Connections Displays information about previous
client connection sessions (for example, a client can
have multiple sessions from different days).
Past Guest Authorizations Displays information about
the authorization of previous guest connections.
Switch Stats Displays information about the status,
ports, PoE, and traffic activity of the UniFi Switches.
Port Forward Stats Displays information about the
port forwarding entries used by the UniFi Security
Gateway.
Dynamic DNS Displays information about the use of
DDNS services.
Remote User VPN Displays information about the
remote user VPN connections.
AC-EDU Streams Displays information about the
streaming by the UniFi AC EDU Access Points.
These sub-tabs share common options:
per page: 10, 50, 100, or 200.
Search
Customize Columns Each of these filters: Switch Stats,
Port Forward Stats, Dynamic DNS, Remote User VPN, and
ACEDU Streams, applies a default set of columns to
display. If you enable the Customize Columns option,
then the selected columns are displayed.
Click

The column options will vary depending on the filter. They
are described further in the following sections:
Switch Stats on page 70
Port Forward Stats on page 73
Dynamic DNS on page 74
Remote User VPN on page 75
AC-EDU Streams on page 75
67
Chapter 9: Insights
Known Clients

An additional filter is available:
Blocked Only display blocked clients.
Noted Only display clients whose configurations
include notes. (See Wireless Client Configuration
on page 111 or Wired Client Configuration on
page 112 for more information.)
Static IP Only display clients using static IP addresses.
details; see Client Details on page 109 for more
information.
Manufacturer Displays the name of the device
manufacturer.
Show Filter the results on the page based on the date the
client was last seen. Select last 24hours, 3days, 7days,
2weeks, 30 days, 120 days, or All.
All Display all clients, regardless of connection type.
Wireless Display all wireless clients.
User/Guest Indicates whether the client is/was

connected to a primary or guest network.
the client.
theclient.
Last Seen Displays the last date and time the client was
connected.
connection.
Wired Display all wired clients.

Neighboring Access Points
You can also apply one of the following filters:

All Display all users and guests.
User Only display users.
Guest Only display guests.
Show Filter the results on the page based on the time

the AP was last seen. Select last 24hours, 3days, 7days,
2weeks, 30 days, 120 days, or All.
All Displays all wireless APs.
2G Only displays 2.4 GHz APs.
68
Chapter 9: Insights

5G Only displays 5 GHz APs.
Name/SSID Displays the name of the wireless network.
BSSID Displays the MAC address of the APs wireless
interface.
Channel Displays the channel setting that the AP was
detected on.
Security Displays the security status indicating whether
encryption is used.
Manufacturer Displays the name of the AP manufacturer.
Location Displays the name of the closest AP managed
by the UniFi Controller. You can click the name to get
additional details on the AP.
Signal Displays the signal strength level and signal type:
Last Seen Displays the last date and time the AP was
connected.
Past Connections
Name/MAC Address Displays the hostname, alias, or

MAC address of the connected client. You can click the
name to get additional details; see Client Details on
User/Guest Indicates whether the client is/was
connected to a primary or guest network.
Associated Displays the date and time the client first
connected.
Duration Displays the length of time the client was
connected.
by the client.
theclient.
IP Address Displays the last known IP address of the
client.
Last AP/Port Displays the name or MAC address of the
last AP used by the wireless client or the last port used by
the wired client. You can click the device name for more
information; refer to UniFi Access Point Details on
page 95 or UniFi Switch Details on page 85 .
Past Guest Authorizations

increments.

increments.

increments.
All Display all users and guests.
User Only display users.
Guest Only display guests.

increments.
69
Chapter 9: Insights

MAC address of the previous guest.
Package Displays the name of the guest access package.

Amount Displays the amount paid by the guest.
Authorized By Displays the name of the authorizing
body.
Start Displays the start date and time of the session.
Duration Displays the length of time the guest was
connected.
by the guest.
theguest.
IP Displays the last known IP address of the guest.
Last AP/Port Displays the name or MAC address of the
last AP used by the wireless guest or the last port used by
the wired guest. You can click the device name for more
information; refer to UniFi Access Point Details on
page 95 or UniFi Switch Details on page 85 .
Switch Stats
Overview Displays the general status information of
each port.
PoE Displays the specific PoE configuration and status
of each port.
Counters Displays the specific TX and RX rates for
eachport.
You have additional filters:
All Switch Displays the ports of all UniFi Switches or a
specific Switch.
Link Status Displays the ports of the specified status:
-- All Displays all ports.
-- Connected Displays all connected ports.
-- Disconnected Displays all disconnected ports.
Clear Counters Click
following:
CLEAR COUNTERS
and select one of the
You can add or remove columns for display. The Customize

columns option will apply, and the filter options: Overview,
PoE, and Counters will disappear.
columns to ... options.
-- Overview The Switch, Name, PoE, Mode,
Network/VLANs, Link Status, STP, TX, RX, TX Rate, RX
Rate, and Activity columns are displayed.
-- PoE The Switch, Name, PoE, PoE Detection, PD Class,
Power, Voltage, and Current columns are displayed.
-- Counters The Switch, TX Bytes, TX Frames, TX
Multicast, TX Broadcast, TX Errors, RX Bytes, RX Frames,
RX Multicast, RX Broadcast, and RX Errors columns are
displayed.
All Resets all counters to zero.

(switch_name) Resets the counters of the selected
UniFi Switch to zero.
Customize Columns Click
used for display.
70
to customize the columns
Chapter 9: Insights

PoE Displays the PoE setting:
(blank) PoE is disabled.
24V Passive 24V passive PoE is enabled.

PoE+ 802.3at/af devices can be plugged in and
automatically receive PoE.
__W Power output is displayed in watts.
Mode Displays the operation mode:
Switching The default mode.
Mirroring The network traffic of this port will receive
the mirrored traffic from the port selected in Port
Configuration on page 87.
Aggregate This port is part of an aggregate link. A port
channel, also known as a Link Aggregation Group (LAG),
combines multiple links into a single logical link (single
IP address) for load balancing and/or redundancy.
Networks/VLANs Displays the networks/VLANs that the
port belongs to. If the Mode is Aggregate, then it displays
the aggregation detail.
Link Status Displays the connection speed and duplex
mode.
STP Displays the STP (Spanning Tree Protocol) mode.
Overview
TX Displays the amount of data transmitted.

RX Displays the amount of data received.
TX Rate Displays the transmit rate.
RX Rate Displays the receive rate.
Activity Displays the level of activity. The different colors
represent different types of packet activity.
Color
Packet Activity
TX rate
RX rate
You can place your mouse over the Activity icon to display
the specific TX or RX rate.
Port The ports display their status and port number:
Indicates a 10/100 Mbps connection.
Indicates a 1 Gbps (1000 Mbps) connection.
Indicates a 10 Gbps connection.
Indicates 1 Gbps (1000 Mbps) connection with PoE.
Edit Click
to make changes to the port settings.
For more information, see UniFi Switch Details on
page 85.
Indicates the connection is disabled (no network or

VLAN is enabled).
Indicates no connection (the network or VLAN is
enabled, but the port is not in use).
Switch If All Switches is selected, then this displays the
hostname, alias, or MAC address of the UniFi Switch. You
can click the name to get additional details. For more
information, see UniFi Switch Details on page 85.
EDIT
Clear Counters Click CLEAR COUNTERS to clear the port

statistics.
Power Cycle If applicable, click POWER CYCLE to power
cycle the port.
Name Displays the name of the port.

71
Chapter 9: Insights
PoE

Edit Click
page 85.
EDIT

statistics.
cycle the port.
Counters

VLAN is enabled).
PoE Detection Displays the PoE status:
Not detected No 802.3at/af device is detected.
Passive 24V passive PoE is enabled.
Good An 802.3at/af device is plugged in and
automatically receiving PoE.
PD Class Displays the PD (Powered Device) class of the
detected device, if applicable; this indicates its power
requirements.
Power Displays the power output in watts, if applicable.
Voltage Displays the voltage output, if applicable.
Current Displays the current output in amperes, if
applicable.

VLAN is enabled).
TX Bytes Displays the number of bytes transmitted.
TX Frames Displays the number of frames transmitted.
TX Multicast Displays the number of multicast packets
transmitted.
TX Broadcast Displays the number of broadcast packets
transmitted.
TX Errors Displays the number of error packets
transmitted.
RX Bytes Displays the number of bytes received.
RX Frames Displays the number of frames received.
RX Multicast Displays the number of multicast packets
received.
RX Broadcast Displays the number of broadcast packets
received.
RX Errors Displays the number of error packets received.
72
Chapter 9: Insights

Edit Click
page 85.
EDIT

statistics.
cycle the port.
Port Forward Stats

All Displays all port forwarding entries.
User-Defined Displays the user-defined port
forwarding entries.
All
UPnP Displays the UPnP port forwarding entries.

used for display.
Name Displays the name of the port forwarding entry.

From Displays the source IP address, if specified, or
Anywhere.
Protocol Displays the protocol that will be forwarded.
Port Displays the port or ports that will be forwarded to
the LAN. Also known as the external port(s).
You can add or remove columns for display.
-- All The Name, From, Protocol, Port, Forward IP,
Forward Port, Packets, Bytes, and Actions columns are
displayed.
-- User Defined The Name, From, Protocol, Port, Forward
IP, Forward Port, Packets, Bytes, and Actions columns
are displayed.
-- UPnP The Name, Protocol, Port, Forward IP, Forward
Port, Packets, Bytes, and Lease Duration columns are
displayed.
Forward IP Displays the destination IP address that will

receive the forwarded port traffic.
Forward Port Displays the destination port or ports that
will receive the forwarded port traffic. Also known as the
internal port(s).
Packets Displays the number of packets transferred.
Bytes Displays the number of bytes transferred.
Edit Click
to make changes to the UniFi Security
Gateway settings. For more information, see UniFi
Security Gateway Details on page 77.
EDIT
73
Chapter 9: Insights
User-Defined

Forward Port Displays the destination port that will
receive the forwarded port traffic. Also known as the
internal port.
Lease Duration Displays the uptime of the port
forwarding entry.
Dynamic DNS

From Displays the source IP address, if specified, or
Anywhere.
Forward Port Displays the destination port or ports that
will receive the forwarded port traffic. Also known as the
internal port(s).

used for display.

Edit Click
EDIT
UPnP
Service Displays the name of the DDNS service.
Status Displays the status of the latest DDNS update.
Hostname Displays the hostname registered with the
DDNS service.
Username Displays the username of the DDNS account.
Server Displays the IP address or hostname of the DDNS
server that should receive DDNS updates.
IP Displays the WAN (public) IP address of the hostname.
74
Last Updated Displays the duration of time since the

hostname IP address was last updated.
Edit Click
EDIT
Chapter 9: Insights
Remote User VPN

used for display.
AC-EDU Streams

used for display.


Interface Displays the interface being used.
Remote IP Displays the IP address of the remote user.
User Displays the username of the remote user.

-- All The Device, Stream, Ready, Streaming, and
Connected columns are displayed.
Down Pkts Displays the amount of data downloaded as

packets.
Down Bytes Displays the amount of data downloaded as
bytes.
Up Pkts Displays the amount of data uploaded as
packets.
Up Bytes Displays the amount of data uploaded as bytes.
Uptime Displays the duration of time the VPN tunnel has
been active without interruption.
Terminate Click
TERMINATE
to end the VPN tunnel.
Terminate Stream Click TERMINATE and then click the live

stream you want to terminate.
Device Displays the hostname, alias, or MAC address
of the UniFi AC EDU AP. You can click the name to get
additional details. For more information, see UniFi
Access Point Details on page 95.
Stream Displays the unique identifier for this live stream.
Ready Displays the status of the UniFi AC EDU AP, Yes
orNo.
Streaming Displays the duration of the live streaming, Yes
or No.
Connected Displays the status of the connection, Yes
orNo.
75
Chapter 9: Insights
76
Chapter 10: UniFi Security Gateway Details
Chapter 10: UniFi Security

Gateway Details
The UniFi Security Gateway hyperlink opens the UniFi
Security Gateways Details window either in the Properties
panel or as a separate popup window. You can always
dock this window in the Properties panel or detach it as a
separate window.
Name/MAC Address Displays the device name or MAC

address of the device.
Restart Click
Locate Click to flash the LED on the device and the

device icon on the Map tab so you can locate it. The LED
Properties
Upgrade Click to upgrade the device. (This icon

does not appear if an upgrade is not available or there
are pending changes.)
The Properties panel appears on the right side of the

screen. Information about each selected device appears as
a popup within this panel.
Undock from Properties Panel Click to display the

same information in a separate popup screen that can
be moved anywhere within the browser screen.
Close Properties Click
to close the device popup.
to hide the Properties panel

Hide Property Panel Click
but allow the device popups to remain accessible from
this panel. Click the properties icon to re-open it.
The upper part of the detached popup screen has an icon
for each port.
VLAN is enabled).
There are three clickable tabs:
Remove All Click
to close the Properties panel.
Collapse All Click

torows.
to collapse all of the popups
UniFi Security Gateway Networks on page 78

UniFi Security Gateway Configuration on page
79
The top of the popup remains and displays the following:

Display Click
to display the device information.
(icon) Displays the icon of the device (the icon will vary
depending on the model).
(status) Displays to indicate the device status.
-- Pending Approval A solid orange circle
the default state, available for adoption.
-- Connected A solid green circle
managed connection.
indicates
indicates a
-- Managed by Other A solid gray circle indicates

that the device is not in the default state but not
controlled by the current UniFi Controller.
-- Disconnected A red warning icon ! indicates no
connection.
77
UniFi Security Gateway Details

Click Details to display the device specifics, LAN/WAN
connection details, and uptime.
Overview

IP Address Displays the WAN (public) IP address of the
WAN interface.
Speed Displays the connection speed in Mbps.
Duplex Displays the mode, Full Duplex or Half Duplex.
Down Pkts/Bytes Displays the amount of data
downloaded as packets and bytes.
Up Pkts/Bytes Displays the amount of data uploaded as
packets and bytes.
Down Activity Displays the level of download activity in
Bytes per second.
Up Activity Displays the level of upload activity in Bytes
per second.
UniFi Security Gateway Networks

Click Networks to display the network name, IP address,
TX and RX throughput, and number of clients.
MAC Address Displays the MAC address or unique

hardware identifier of the Gateway.
Model Displays the model name of the Gateway.
Version Displays the version number of the Gateways
firmware.
LAN IP Address Displays the local IP address of the
Gateway.
Uptime Displays the duration of time the Gateway has
been running without interruption.
WAN 1
The number of WAN sections will vary depending on the
number of active WAN ports.
Network Displays the name of the network.
IP Displays the local IP address of the network.
TX Displays the outgoing (transmit) throughput.
RX Displays the incoming (receive) throughput.
# Clients Displays the number of clients on the network.
78

Configuration
Click Configuration to configure the alias, WAN
settings, port forwarding, Dynamic DNS, and custom
upgrade entries. You can also remove the Gateway from
management by this UniFi Controller.
General
Static IP The service provider assigns fixed network

settings to your service for manual entry. Enter the
following information:
-- IP Address Enter the Internet IP address of the
Gateway.
-- Subnet Mask Enter the subnet mask of the Gateway.
-- Router Enter the IP address of the service providers
gateway router.
-- Preferred DNS Enter the IP address of the service
providers primary DNS server.
-- Alternate DNS Enter the IP address of the service
providers secondary DNS server.
Alias Displays the customizable name or identifier of the

Gateway. The Alias is also known as the host name.
Save Click Save to apply the change.
WAN 1/2
Connection Type Select the Internet connection type for
your service.
Using DHCP The use of the Dynamic Host
Configuration Protocol (DHCP) is the default. The
Gateway automatically acquires network settings from
the service providers DHCP server.
79

PPPoE Point-to-Point Protocol over Ethernet (PPPoE)
is a virtual private and secure connection between two
systems that enables encapsulated data transport. Enter
the following information:
-- Username Enter the username used to connect to
the PPPoE server.
-- Password Enter the password used to connect to the
PPPoE server.

Smart Queues The Smart Queue feature provides
FQ-CODEL (Fair Queuing with Controlled Delay) + HTB
(Hierarchical Token Bucket) function and supports
dynamic interfaces, even if the dynamic interfaces do
not exist yet (the policy will be applied later when the
interface comes up).
The HTB rate limiting is computation-intensive, so the rate
limiting will not work well (cannot achieve the specified
rate) above a certain threshold rate. The actual threshold
(applied to the sum of the upload and download rates)
depends on the specific Gateway model and conditions of
the actual environment.
It may require some testing to find the actual threshold
in a specific environment, depending on the actual setup,
traffic patterns, and other conditions. You can use the
Pre-Populate option as a starting point for the Up and
Down Rates. The actual rate limits will be set to 95% of
the specified value, so you can experiment with different
values if necessary.
The smart queue policy applies to a single interface. If you
are using more than one WAN interface, then you would
configure a separate smart queue policy for the WAN 2
port in the WAN 2 section.
Pre-Populate Click Pre-Populate to set the Up and
Down Rates to 80% of the last speed test results.
Up Rate Enter the bandwidth limit in Kbits/sec.
Down Rate Enter the bandwidth limit in Kbits/sec.
Disabled If you are not using the WAN 2 port, then

select Disabled.
Pre-Populate Click Pre-Populate to set the Up and

Down Rates to 80% of the last speed test results.
Note: If you enable the Smart Queues option, then
you will not be able to use the DPI feature as traffic
will not be offloaded.
Use VLAN ID To use a VLAN, select Use VLAN ID and

enter the VLAN ID number.
Load Balancing (Available for WAN 2 if Using DHCP, Static
IP, or PPPoE is enabled.) Set up basic load balancing with
two Internet connections from different Internet Service
Providers (ISPs).
Failover only Select this option if you want to use WAN
2 only if WAN 1 fails.
Weighted LB Select this option if you want the load

balanced between the two WAN ports. Then enter a
weight in the field provided; the default is 50.
80

Queue Changes Click Queue Changes to line up the
changes to take effect. This allows you to make multiple
changes to the device and then apply them all at once
so that the device doesnt have to re-provision over and
over again when you change different sections of the
configuration. Each section with pending changes is
highlighted by an ellipsis.
Port Forward
When you are done with your changes, click Apply

Changes at the bottom of the screen. (You can cancel the
changes of any section by clicking X of the appropriate
section.)
Create Click
to add a new entry. Go to Create or
Edit Port Forwarding Entry on page 82.
CREATE

From Displays the source IP address, if specified.
Dest IP/Port Displays the destination IP address and
port(s) that will receive the forwarded port traffic. Also
known as the internal port(s).
Edit Click
Delete Click
to edit the port forwarding entry.

to delete the port forwarding entry.
Pending Changes If you want queue changes for

multiple devices and then apply them later, the Pending
Changes option appears in the Properties panel. Click
to display the devices.
Apply Click
Discard Click
APPLY
to save changes.
DISCARD
to cancel changes.
81
Create or Edit Port Forwarding Entry
Dynamic DNS
Domain Name System (DNS) translates domain names
to IP addresses; Each DNS server on the Internet holds
these mappings in its respective DNS database. Dynamic
Domain Name System (DDNS) is a network service that
notifies the DNS server in real time of any changes in the
devices IP settings. Even if the devices IP address changes,
you can still access the device through its domain name.
Create Click
to add a new entry. Go to the Create or
Edit DDNS Entry section on the next page.
CREATE
Name Enter a name to identify this port forwarding entry.

From The default is Anywhere, which accepts traffic from
any source IP address. To specify a source IP address,
select Limited and enter the source IP address in the field
provided.
Port Enter the port or ports that will be forwarded to the
LAN (also known as the external port or ports). You can
identify the port or ports by name, number, and/or range.
To specify multiple ports, use a comma-separated list
(example: 20-23,554).
Forward IP Enter the LAN IP address that will receive the
forwarded port traffic.
Service Displays the name of your Dynamic DNS (DDNS)

service provider.
Hostname Displays the host name of the device.
Username Displays the user name of the DDNS account.
Password Displays the password of the DDNS account.
Server Displays the address of your DDNS server.
Edit Click
Delete Click
to edit the DDNS entry.

to delete the DDNS entry.
Create or Edit DDNS Entry
Forward Port Enter the port or ports that will receive

the forwarded port traffic (also known as the internal
port). You can identify the port or ports by name, number,
and/or range. If you do not specify this port, then the
original destination port of the traffic will beused.
Protocol Select the protocol that will be forwarded: Both,
TCP, or UDP.
Apply Click Apply to save changes.
Service If available, select your DDNS service provider

from the drop-down list.
Hostname Enter the host name of the device, which has
to be updated on the DDNS server. For example:
sample.ddns.com
Username Enter the user name of the DDNS account.
Password Enter the password of the DDNS account.
Server Enter the address of your DDNS server.
82
Custom Upgrade
For firmware upgrades, the UniFi devices retrieve the latest
firmware from the Ubiquiti website. To specify firmware
saved in a custom location, select this option.
(URL) Enter the location URL of the firmware.

Custom Upgrade Click
to upgrade the
firmware from the location you entered.
Forget This Device
Forget Click Forget to remove the Gateway from

management by the UniFi Controller software and reset it
to factory default settings.
Note: Use caution when clicking Forget. This will
restore the Gateway to factory default settings while
it is in a Connected state.
83
84
Chapter 11: UniFi Switch Details
Chapter 11: UniFi Switch

Details

connection.
A UniFi Switch hyperlink opens the UniFi Switchs Details

window either in the Properties panel or as a separate
popup window. You can always dock this window in the
Properties panel or detach it as a separate window.

Restart Click
Properties




The upper part of the detached popup screen has an icon
for each port.
VLAN is enabled).
Remove All Click
Collapse All Click

torows.

Indicates STP blocking.
Indicates mirroring mode.
Place your cursor over a port to view details.

Display Click
Port Displays the port number.

managed connection.
indicates
indicates a

Status Displays the connection speed and duplex mode.

PoE (Not applicable to the SFP ports.) Displays the PoE
setting:
-- Off PoE is disabled.
-- 24V Passive 24V passive PoE is enabled.
-- __W Power output is displayed in watts.
-- PoE+ 802.3at/af devices can be plugged in and
85

Networks/VLANs Displays the networks/VLANs that
the port belongs to.
Uplink
Uplink/Downlink Displays the name of the uplink or

downlink device.
There are three clickable tabs:
UniFi Switch Ports on page 87
UniFi Switch Configuration on page 89
UniFi Switch Details

Click Overview to display the device specifics, connection
details, and uptime.
Overview

Uplink Displays the name or MAC address of the uplink
device. You can click the name to get additional details.
Up Pkts/Bytes Displays the number of packets and total
bytes uploaded by thedevice.
Activity Displays the level of activity in Bytes per second.
Downlinks
hardware identifier of the Switch.
Model Displays the model name of the Switch.
Version Displays the version number of the Switchs
firmware.
IP Address Displays the IP address of the Switch.
Power Consumption Displays the amount of power used
by the Switch.
Temperature Displays the general temperature of the
Switch.
Fan Level If the Switch has a fan, then the Fan Level, from
0 to 3, is displayed. If the Switch does not have a fan, then
the Fan Level is not displayed.
Uptime Displays the duration of time the Switch has been
running without interruption.
86

Port Displays the number of the connected port.
Device Displays the name or MAC address of the

downlink device. You can click the name to get additional
details.
Off PoE is disabled.
Model Displays the model number of the downlink

device.
UniFi Switch Ports

Click Ports to display the port name, status, TX and RX
throughput, PoE setting, and networks/VLANs.

Networks/VLANs Displays the networks/VLANs that the
port belongs to.
Edit Click to change the port configuration. Proceed
to the following section, Port Configuration.
Powercycle (Available only if the connected devices
uses PoE.) Click
to restart the connected device.
Port Configuration

Port Displays the number of the port.

Name Displays the customizable name or identifier of
the port.

87

PoE All ports are set to auto-sensing PoE+ by default.
-- Off Disable PoE.
-- 24V Passive Select this option to power devices that
support 24V passive PoE.
Note: Before activating 24V passive PoE, ensure
that the connected device supports PoE and the
supplied voltage.
-- PoE+ 802.3at/af devices can be plugged in and
Networks/VLANs Select the appropriate network or
VLAN, or select Disabled to disable this port. The default
is All.
Advanced Options Click the icon to display additional
options.
Operation Select the operation mode for this port.
Switching, Mirroring, or Aggregate. Proceed to the
appropriate section.
Switching

Link Negotiation Keep the default, Auto, or select
Manual to specify the duplex and speed:
Full Duplex (Available for RJ45 ports only.)
Fullduplex transmission is enabled by default.
Link Speed For RJ45 ports, select the appropriate
speed: 1000Mbps, 100Mbps, or 10Mbps. For
SFP+ ports, select the appropriate speed: 10 Gbps
or 1000Mbps. For SFP ports, select 1000Mbps.
-- Isolation Select this option to create a Private VLAN
(Virtual Local Area Network). Isolated ports cannot
communicate directly with each other.
-- Storm Control Monitor the unicast, multicast, and/or
broadcast traffic for this port. If the specified type
of traffic on this port exceeds the threshold rate you
specify, then the UniFi Switch drops the excess traffic.
Unicast Select this option to monitor unicast traffic.
Enter the threshold value in packets per second.
Multicast Select this option to monitor multicast
traffic. Enter the threshold in packets per second.
Broadcast Select this option to monitor broadcast
traffic. Enter the threshold in packets per second.
Mirroring
-- Switching The default mode.

88

-- Mirroring The network traffic of this port will receive
the mirrored traffic from the port listed below for
analysis:
Mirroring Port Enter the number of the port that
will be mirrored.
-- Isolation Select this option to create a Private VLAN
(Virtual Local Area Network). Isolated ports cannot
communicate directly with each other.
Aggregate
Aggregate Ports Enter the end port number of the

LAG. (Two to four ports are permitted per LAG.)
UniFi Switch Configuration

Click Configuration to configure the alias, network/VLANs,
services, and network settings. You can also use this tab
to copy another switchs configuration to this Switch,
perform a custom upgrade, gain terminal access to the
Switch, or remove the Switch from management.
General
Alias Displays the customizable name or identifier of the

Switch. The Alias is also known as the host name.
Save Click Save to apply your change.
-- Aggregate A port channel, also known as a Link
Aggregation Group (LAG), combines multiple links
into a single logical link (single IP address) for load
balancing and/or redundancy. If you select this
option, then this port becomes the start port of the
aggregate link.
89
Networks/VLANs
Select the appropriate native network. (Additional

networks may be created in Settings > Networks on
page 23.)
Tagged Networks For a Switch belonging to a tagged
network, the packets will be tagged in both ingress and
egress directions. For example, the native network is
LAN with VLAN 1 as the PVID. The switch is connected to
an AP with two tagged networks:
Create Click
to add a new entry. Go to the Create
New Network/VLAN on page 90 section below.
CREATE
Name Displays the name of the network/VLAN.

Config Displays the configuration: Native (____) or
Customized. (Networks may be created in Settings >
Networks on page 23.)
VLAN 20: corporate

VLAN 30: guest
This table lists how the packets are handled:
Packet
Type
Ingress
Action
Egress
Untagged
Accepted
Assigned to VLAN 1
VLAN header
removed and sent
out as untagged
Tagged as
VLAN 20
Accepted
Remains tagged
Sent out tagged as

VLAN 20
Tagged as
VLAN 30
Accepted
Remains tagged
Sent out tagged as

VLAN 30

View Click
to view the default network.
Edit Click to edit the network/VLAN entry. (Not

available for the default network.)
Delete Click to delete the network/VLAN entry. (Not
available for the default network.)
Create New Network/VLAN
The proper use of VLANs isolates the traffic of each

VLAN. The guest traffic on VLAN 30 will be kept separate
from the traffic on the corporate network.
Select the appropriate tagged network. (Use Settings >
Networks on page 23 to create more networks.)
Services
Name Enter a name to identify this network/VLAN.

Native Network A native network has a Port VLAN
Identifier (PVID), which identifies the default VLAN. A
switch assigned to a native network participates in the
VLAN of that native network.
The Switch accepts tagged and untagged packets
in the ingress direction, and the untagged packets
are assigned to the VLAN of the native network. For
example, if the PVID is VLAN 30, then all untagged
packets are assigned to VLAN 30. In the egress direction,
the native network packets are stripped of the VLAN 30
header and exit as untagged packets.
This table lists how the packets are handled:
Packet
Type
Ingress
Action
Egress
Tagged
Accepted
Remains tagged
Sent out as tagged
Untagged
Accepted
Assigned to VLAN
of native network
VLAN header
removed and sent
out as untagged
MGMT VLAN A network group defines the management

VLAN for the Switch. Select the appropriate network
group.
Enable Jumbo Frame Disabled by default. The Maximum
Transmission Unit (MTU) is the maximum packet size (in
bytes) that a network interface can transmit. A jumbo
frame is larger than the standard Ethernet frame with an
MTU of 1500. Jumbo frames are typically used for Gigabit
Ethernet connections. If you enable this option, then this
port handles jumbo frames and forwards them.
Each physical port can have multiple networks attached;

however, only one of them can be native (untagged).
90

Enable Flow Control Disabled by default. Flow
Control allows the port to manage data rates in case
the sending and receiving devices use different data
transmissionrates.
Spanning Tree For optimal performance, there should be
a single active path between two networking devices in an
Ethernet network. Spanning Tree Protocol (STP) provides
redundant paths and prevents network loops that can
create excessive traffic and slow down performance. STP
calculates the best path for network traffic; if the best path
fails, STP recalculates and finds the next best path.
Select the appropriate option: RSTP (Rapid Spanning Tree
Protocol), STP (Spanning Tree Protocol), or Disabled. RSTP
is recommended because ports can more quickly progress
to the forwarding state. When STP is selected, the Switch
sends STP packets. The default is RSTP.
Priority STP uses priority values to select a switch as the
root switch of the spanning tree. Specify the Priority value
of the Switch. The default is 32768.
Enable 802.1x control Select this option to use a RADIUS
server for user authentication on a wireless network. The
following options appear.
-- Add Auth Server If you have another authentication

server, click this option and complete the IP Address,
Port, and Password fields.
RADIUS Accounting Server Provide the following
information about the RADIUS server:
-- IP Address Enter the IP address.
-- Port Enter the port number. The default is 1813.
-- Password Enter the password.
-- Delete Click the delete
accounting server.
icon to remove this
-- Add Accounting Server If you have another

accounting server, click this option and complete the
IP Address, Port, and Password fields.
section.)
Enable RADIUS VLAN Allows the RADIUS server to

dynamically assign a VLAN to a wired client.
RADIUS Auth Server Provide the following information
about the RADIUS authentication server:
-- IP Address Enter the IP address.
-- Port Enter the port number. The default is 1812.
-- Password Enter the password.
-- Delete Click the delete
accounting server.
icon to remove this
91


Changes at the bottom of the screen, or click Cancel to
discard changes. (You can cancel the changes of any
section by clicking X of the appropriate section.)
Apply Click
Discard Click
APPLY
to save changes.
DISCARD
to cancel changes.
Network
Configure IP Select the Internet connection type for your
service, Using DHCP or Static IP.

Apply Click APPLY to save changes.

Configuration Protocol (DHCP) is the default. The Switch
Discard Click
Static IP Assign fixed network settings to the Switch.

Enter the following information:
Copy from Select the appropriate Switch whose

configuration will be copied to this Switch. Then click
Confirm to overwrite its current configuration with the
configuration of the selected Switch.
-- IP Address Enter the IP address for the Switch.

-- Subnet Mask Enter the subnet mask of the Switch.
-- Gateway Enter the IP address of the gateway (for
example, the UniFi Security Gateway).
-- Preferred DNS Enter the IP address of the primary
DNS server.
DISCARD
to cancel changes.
Copy Config
If you have settings that you want to apply to multiple
Switches, use this option to copy the configuration.
Custom Upgrade
-- Alternate DNS Enter the IP address of the secondary

DNS server.
-- DNS Suffix Enter the Fully Qualified Domain Name
(FQDN) without the hostname.
(location URL) Enter the UL of the firmwares location.

to upgrade the
92
Debug Terminal
This option uses a WebRTC connection as transport layer.
To use a command-line interface, click Open Terminal.
Open Terminal Click Open Terminal to connect directly

to this Switch. A new window will appear.
help Enter help at the command line for a list of built-in

commands.
Forget This Switch
Forget Click Forget to remove the Switch from

restore the Switch to factory default settings when it
is in a Connected state.
93
94
Chapter 12: UniFi Access Point Details
Chapter 12: UniFi Access Point

Details
A UniFi AP hyperlink opens the UniFi APs Details window
either in the Properties panel or as a separate popup
window. You can always dock this window in the Properties
panel or detach it as a separate window.
Properties
-- Disconnected or Isolated A red warning icon !

indicates no connection. To establish a connection
to the UniFi Controller, perform one of the following
actions:
Reconnect the AP to the gateway or router.
Connect an Ethernet cable from the Secondary
Ethernet Port (if available) of the isolated AP to the
Secondary Ethernet Port (if available) of another UniFi
AP that is connected to the gateway or router.
Establish a wireless uplink to a wired AP.
Restart Click


There are four clickable tabs:
Remove All Click
Collapse All Click

torows.
UniFi Access Point Users on page 99

UniFi Access Point Guests on page 100
UniFi Access Point Configuration on page 100

Display Click
managed connection.
indicates
indicates a

95
UniFi Access Point Details
Uplink (Wired)
Click Overview to display the device specifics, connection

details, uptime, and user statistics.
If your AP has a wired uplink connection, click Uplink

(Wired) to display details about the wired uplink.
Overview

hardware identifier of the AP.
Model Displays the model name of the AP.
Version Displays the version number of the APs firmware.
Uptime Displays the duration of time the AP has been
# Users Displays the number of users connected to the
primary network.
Uplink Displays the name, alias, or MAC address of the

switch or other uplink device being used by the AP. You
can click the name to get additional details on the device.
packets and bytes.
# Guests Displays the number of users connected to the

guest network.
96
Uplink (Wireless)
Downlink
If your AP has a wireless uplink connection, click Uplink

(Wireless) to display details about the wireless uplink.
The wireless APs currently connected to the wired AP are

displayed.
Uplink AP Displays the name, alias, or MAC address of the

uplink AP. You can click the name to get additional details
on the uplink AP.
Signal Displays the percentage of signal strength
between the two APs.
packets and bytes.
Note: Downlinks will only be visible under the Details

tab when a wireless AP is connected.
AP Displays the name, alias, or MAC address of the
downlink AP. You can click the name to get additional
details on the device.
between the two APs.
Remove Click
wired AP.
to remove the wireless AP from the
97
Radio (11N/B/G) or Radio (11N/A/AC)
RF Environment
Click Radio (11N/B/G) or Radio (11N/A/AC) to display the

channel and transmit/receive statistics.
Note: Only the UAPACLITE, UAPACLR,

UAPACPRO, and UAPACEDU support spectral
analysis.
Click RF Environment for spectral analysis to help in
channel selection and planning.
Channel Displays the channel being used.

Transmit Power Displays the EIRP in dBm.
TX Pkts/Bytes Displays the amount of data transmitted
as packets and bytes.
RX Pkts/Bytes Displays the amount of data received as
packets and bytes.
TX Retry/Dropped Displays the percentage of transmit
packets that needed to be re-sent and the percentage of
packets that were dropped.
RX Retry/Dropped Displays the percentage of receive
packets that needed to be re-sent and the percentage of
packets that were dropped.
# Users Displays the number of users connected to the
primary network.
# Guests Displays the number of guests connected to the
guest network.
2G/5G Select the frequency band you want to analyze.

RF Scan Click RF SCAN to scan the RF environment and
then click Confirm to continue.
98

Note: The RF scan may take more than five minutes.
All clients using this AP will be disconnected, and
the AP will be offline for the duration of the scan.
Place your cursor over a channel option to view the

following:
Overview
Radio Displays the radio being used.
Channel Width Displays the width of the channel.
Frequency Range Displays the range of frequencies.
RF Scan Details
Utilization Displays the percentage of the frequency
range already in use.
Interference Displays the level of interference.
Interference Types Displays the type of interference
being detected.
Last scan Displays the duration of time since the last

scan.
UniFi Access Point Users
Each bar graph represent a channel option and its

colorcoded level of interference (from green at -96 dBm
to red at -32dBm).
__ MHz The 2.4 GHz results are displayed in channel
widths of 20 and 40 MHz. The 5 GHz results are displayed
in channel widths of 20, 40, and 80 MHz.
Name Displays the hostname, alias, or MAC address of

the connected client and the name or SSID of the wireless
network in use. You can click the name to get additional
details; see Client Details on page 109 for more
information.
Signal Displays the signal strength between the user
andAP.
__ Displays the corresponding channel number for each

channel width option.
(outlined) The current channel is outlined.
99
UniFi Access Point Guests
Radios
Name/WLAN Displays the hostname, alias, or MAC
address of the connected guest and the name or SSID of
the wireless network in use. You can click the guest name
to get additional details; see Client Details on page
109 for more information.
Signal Displays the signal strength between the guest
and AP.
Channel Select the appropriate settings:
UniFi Access Point Configuration
Auto/(channel number) Select a channel number or

keep the default, Auto.
Change device configuration settings.
HT20/HT40/HT80 (Available for 2.4 GHz only.) Select

HT20 for 20 MHz operation, HT40 for 40 MHz operation,
or HT80 for 80 MHz operation in the 5 GHz band.
General
Note: If the AP is part of a Zero Handoff WLAN

Group, then the Channel settings cannot be
changed.
VHT20/VHT40/VHT80 (Available for 5 GHz only.)
Select VHT20 for 20 MHz operation, VHT40 for 40MHz
operation, or VHT80 for 80 MHz operation in the
5GHzband.
Group, then the Channel settings cannot be
changed.
Transmit Power By default the transmit power is set to
Auto. You can also manually select the following:
High The highest TX power available.
Medium Halfway between High and Low.
Low The lowest TX power available.
Custom Custom setting that you specify in the field
provided.
Alias Enter or edit the customizable name or identifier of
the AP. The Alias is also known as the host name.
Save Click Save to apply the change.
Antenna Gain (Only available for Outdoor models)

Specify the antenna gain.
Minimum RSSI Disabled by default. Select this option
and enter a minimum threshold (we recommend a value in
this range: -70 to -90 dBm). For UniFi, RSSI is synonymous
with SNR. If the client signal falls below the specified
threshold, then the AP kicks out the client, allowing it to
reconnect with a more suitable AP.
Group, the Minimum RSSI setting cannot be changed.
100



section.)
Apply Click
Discard Click
APPLY
to save changes.
DISCARD
to cancel changes.
WLANs
You can deploy multiple wireless networks organized into
WLAN groups on different APs.
WLAN Group Select the appropriate group.

Name Displays the network name or SSID of the available
wireless network.
Overrides Displays the SSID override information applied
to the wireless network.
Edit Click to enable a VLAN (Virtual Local Area
Network), set the VLAN ID, and enter the SSID override
name to apply to the wireless network.
Note: The Override option is not available for a
Zero Handoff WLAN Group.
Queue Changes Click Queue Changes to save changes.
101
Override

Changes at the bottom of the screen. (You can
cancel the changes of any section by clicking X of the
appropriate section.)
Enabled on this AP Select the checkbox to enable the

WLAN for use.
Use VLAN Select the checkbox to enable the VLAN.
with VLAN ID The VLAN ID is a unique value assigned
to each VLAN on a single device. Enter a value between
2 and 4095. For example, in a large deployment where
there are multiple buildings, you can use a different
VLAN ID for each building while all of the VLANs remain
on the same corporate network.
SSID Enter the SSID override name to apply to the
wireless network.
Security Key If the WPA-Personal security option has
been applied to the WLAN under Settings > Wireless
Networks, then the Pre-Shared Key (PSK) for the SSID
specified will automatically appear in this field.
Save Click Save to apply changes.
Reset to Defaults Click Reset to Defaults to remove
any overrides that were applied to the selected wireless
network.
Network
Configure IP Select the Internet connection type for
your service, Using DHCP or Static IP. Proceed to the
appropriate instructions.

-- Apply Click
-- Discard Click
APPLY
to save changes.
DISCARD
to cancel changes.
Static IP
Static IP Assign fixed network settings to the AP. Enter
-- IP Address Enter the IP address for the AP.
-- Subnet Mask Enter the subnet mask of the AP.
DNS server.
DNS server.
Queue Changes Click Queue Changes to save
changes.
Using DHCP
Configuration Protocol (DHCP) is the default. The AP
Static IP Assign fixed network settings to the AP. Enter

-- IP Address Enter the IP address for the AP.
-- Subnet Mask Enter the subnet mask of the AP.
102

DNS server.
DNS server.

If the 5 GHz band is overloaded and the 2.4 GHz band is
not, then clients are steered to the 2.4 GHz band (RSSI is
not a factor). The RSSI thresholds are 30 dBm or better for
the 5GHz band. For example, if the 2.4 GHz network has
low utilization, then the Steer to 5G option does not steer
all clients to 5 GHz.
All APs must use the same SSID for the 2.4 GHz and 5 GHz
bands. For example, if you have multiple WLANs in your
default WLAN group, you cannot override the 5 GHz SSID
name in one of the WLANs and still use band steering on
the other two WLANs. All APs must use band steering or
none of them do.

Changes at the bottom of the screen. (You can
cancel the changes of any section by clicking X of the
appropriate section.)
-- Apply Click
-- Discard Click
APPLY
to save changes.
DISCARD
to cancel changes.
Band Steering
2.4 GHz networks are typically more congested due to
support of legacy clients and multiple sources of 2.4GHz
interference, including Bluetooth devices. Band steering
can help distribute the load on 2.4 GHz and 5GHz
networks by steering dual-band clients to the 5 GHz band
when appropriate.
Some dual-band clients are band-steering unfriendly for
various reasons and are marked as such by the AP. Such
clients are not steered to any band even when conditions
would justify it.
Note: Only the UAP-PRO, UAPACLITE, UAPACLR,
UAPACPRO, and UAPACEDU models support
band steering.
If enabled, the UniFi band steering policy takes two criteria
into account:
channel utilization metrics
signal quality measurements, including RSSI
The AP steers the client to the optimal band during
association (not after association). If both bands or neither
band is overloaded, the AP does not perform band
steering; instead, the client chooses a band.
If the 2.4 GHz band is overloaded, and the RSSI of the
client is above the threshold for association on the 5 GHz
band, then the AP will steer the client to the 5 GHz band
by withholding probe responses.
If the client still attempts to associate on the 2.4 GHz band,
the AP will send auth failure frames in response to auth
requests from the client.
Prefer 5G Select this option to steer clients to the 5GHz

band at a lower channel utilization threshold than the
Balanced option. The threshold is not a single value;
instead it is a function of two values: the 2.4 GHz channel
utilization and 5 GHz channel utilization.
Balanced (Not available for the UAP-PRO.) Select this
option to steer clients to the 5 GHz band channel at a
higher channel utilization threshold than the Steer to 5G
option.
Off Keep the default, Off, if you do not want to use band
steering.
section.)
103
Apply Click

Discard Click
Apply Click
Discard Click
APPLY
to save changes.
DISCARD
to cancel changes.
APPLY
to save changes.
DISCARD
to cancel changes.
Custom Upgrade
Airtime Fairness
Note: Only the UAPACLITE, UAPACLR,
UAPACPRO, and UAPACEDU models support
airtime fairness.
The Airtime Fairness option helps multiple users to share
the bandwidth of a single AP.
(location URL) Enter the UL of the firmwares location.

to upgrade the
Forget This AP
On/Off Disabled by default. Select On to enable this
option.
section.)
104

Forget Click Forget to remove the AP from management
by the UniFi Controller software and reset it to factory
default settings.
restore the AP to factory default settings when it is
in a Connected state. Do not use the Forget option
when the AP is in an Isolated or Disconnected state. If
you do, the only way to make the AP accessible from
the UniFi Controller is to take it down and connect
by wire.
Wireless Uplinks
Access Point - Isolated/Disconnected

When an AP is in an Isolated or Disconnected state, you can
re-establish a connection to the UniFi Controller software
using one of three methods:
Reconnect the AP to the gateway/router.
Connect an Ethernet cable from the Secondary Ethernet
Port (if available) of the isolated AP to the Secondary
Ethernet Port (if available) of another UniFi AP that is
connected to the gateway/router.
Establish a wireless uplink to a wired AP. See the Wireless
Uplinks section to find, select, and connect to a wired AP.
When an AP is not connected by a wire, the Wireless

Uplinks section lists potential uplink APs that can be
selected to establish a wireless connection.
In an Isolated or Disconnected state, the Map tab displays

the AP icon with a red/orange LED and disconnected
icon.
The LED on the actual device will be steady green or blue
with occasional flashing. This AP doesnt provide any
wireless service.
Note: Do not use the Forget this AP option when the
AP is in an Isolated or Disconnected state. If you do,
then the only way to make the AP accessible from
the UniFi Controller is to take it down and connect it
by wire.
Overview
MAC Address Displays the MAC address of the AP.
Model Displays the model number.
Version Displays the version of software used on the AP.
AP Displays the hostname, alias, or MAC address of
the potential Uplink AP. You can click the name to get
additional details.
Last Seen Displays the amount of time that has passed

since the Access Point was last seen.
Channel Displays the channel in use for wireless

communication.
Signal Displays the percentage of signal strength.
Select Click
AP.
to connect the wireless AP to the wired
Remove Click
wired AP.
to disconnect the wireless AP from the
Note: An AP can only uplink to another AP using the

same radio band. For example, the UAP-Outdoor 5G
can only uplink to another UniFi AP using the 5GHz
radio band.
105
Access Point - Managed by Other
Access Point - Pending Approval
The Managed by Other state indicates that the AP is not

in the default state but it is not controlled by the UniFi
Controller.
The Pending Approval state indicates that the Access Point

is in the default state and is available for adoption.
Overview



since the AP was last seen.

since the Access Point was last seen.
If you want to manage this AP using the UniFi Controller

software, then click Adopt on the Devices screen.
Adopt

Port Displays SSH port of the AP.
Username Enter the SSH Username for management
access. This is the Device Username you configured in
Password Enter the SSH Password for management
access. This is the Device Password you configured in
Inform URL This tells the AP where to look for the UniFi
Controller. The URL will be automatically displayed but
you may need to verify its accuracy as the system may
have multiple interfaces.
Adopt Click Adopt to adopt the AP so you can manage it
using the UniFi Controller software.
106
Chapter 13: UniFi VoIP Phone Details
Chapter 13: UniFi VoIP Phone

Details
A UniFi VoIP Phone hyperlink opens the UniFi VoIP Phones
Details window either in the Properties panel or as a
separate popup window. You can always dock this window
in the Properties panel or detach it as a separate window.
Important: For management of the UniFi VoIP
Phones, please download the UniFi VoIP Controller
here: downloads.ubnt.com/unifi
Properties

Restart Click
Locate Click to ring the Phone and flash the Phones

icon on the Map tab so you can locate it. The Phone will
ring until you click Locate again. (The icon on the Map
tab will flash three times and stop.)

There are two clickable tabs:
Details
UniFi VoIP Phone Configuration on page 108
UniFi VoIP Phone Details

The Overview displays the device specifics and uptime.
Overview
Remove All Click
Collapse All Click

torows.

hardware identifier of the Phone.
Display Click
Model Displays the model name of the Phone.
Version Displays the version number of the Phones

firmware.
IP Address Displays the IP address of the Phone.

managed connection.
indicates
Uptime Displays the duration of time the Phone has been

indicates a

connection.
107
Chapter 13: UniFi VoIP Phone Details
UniFi VoIP Phone Configuration

Click Configuration to reset the Phone to its factory
default settings.
Forget This Phone
Forget Click Forget to remove the Phone from

restore the Phone to factory default settings when it
is in a Connected state.
108
Chapter 14: Client Details

A client hyperlink opens the clients Details window either
in the Properties panel or as a separate popup window.
You can always dock this window in the Properties panel or
detach it as a separate window.
The top of the window displays the device icon and name
(or MAC address).
Properties

Click to remove authorization of guest access and
disconnect the guest, or click for guests pending
authorization.


screen. Information about each selected device appears
as a popup within this panel. The information varies
depending on whether the client is wired or wireless:
There are four clickable tabs:
Wireless Client Details
Statistics
Wired Client Details on page 111
History
Details
Configuration
Wireless Client Details
Remove All Click
Collapse All Click

torows.

hardware identifier of the client.
Hostname Displays the customizable name or identifier
of the client.
Device Type Displays the type of device.
IP Address Displays the IP address of the client.

Display Click
(icon) Displays the icon of a wireless or wired device.

MAC address of the device.
Block Click
network.
to block this client from accessing the

connected.
Connected AP Displays the hostname, alias, or MAC
address of the UniFi AP. You can click the name to get
additional details; see UniFi Access Point Details on
ESSID Displays the name of the wireless network.
Reconnect Click
to reconnect a wireless client. You
can click
o kick out a client, which usually reconnects
back quickly; this is useful for troubleshooting or
resolving a problematic wireless connection.
109
Wireless Client Statistics
Overview
The Deep Packet Inspection information is available if the

DPI feature is enabled (refer to Settings > Site on page
20 for more information).
Channel Displays the channel being used.

between the AP and client.
Application Displays the name of the application.
Power Save Displays the status of the power save mode.

Bytes Displays the amount of data uploaded and

downloaded as bytes.

Packets Displays the amount of data uploaded and

downloaded as packets.

packets and bytes.
Wireless Client History
Date/Time Displays the date and time of the connection.

Duration Displays the duration of the connection.
the client.
theclient.
110
Wireless Client Configuration
Wired Client Details
Config

Alias Allows you to change the hostname of the client.
Note Allows you to enter comments about the client.
Once saved, the client will be designated as a Noted
client on the Insights > Known Clients tab.
User Group Allows you to assign the client to a User
Group. User Groups are set up under the Settings tab >
User Groups option (see Settings > User Groups on
page 34 for more information). The default User Group
is Automatic.
IP Config
Hostname Displays the customizable name or identifier

of the client.
Device Type Displays the type of device.
IP Address Displays the local IP address of the client.
connected.
Network Displays the network used by the client.
Port Displays the name and port of the UniFi device
being used by the client. You can click the name to get
additional details on the UniFi device.
Wired Client Statistics

Overview
Fixed IP Select this option to assign a static IP address to

the client, and configure the settings below. If you want
the local DHCP server to assign an IP address to the client,
remove the checkmark.
Network Select the appropriate network from the
drop-down list.

packets and bytes.
IP Address Enter the local IP address.

111
Wired Client Configuration
The Deep Packet Inspection information is available if the

DPI feature is enabled (refer to Settings > Site on page
20 for more information).
Config
Alias Allows you to change the hostname of the client.
Application Displays the name of the application.

Packets Displays the amount of data uploaded and
Bytes Displays the amount of data uploaded and
Wired Client History
Note Allows you to enter comments about the client.

Once saved, the client will be designated as a Noted
client on the Insights > Known Clients tab.
User Group Allows you to assign the client to a User
Group. User Groups are set up under the Settings tab >
User Groups option (see Settings > User Groups on
page 34 for more information). The default User Group
is Automatic.
IP Config
Date/Time Displays the date and time of the connection.

Duration Displays the duration of the connection.
the client.
theclient.
Fixed IP Select this option to assign a static IP address to

the client, and configure the settings below. If you want
the local DHCP server to assign an IP address to the client,
remove the checkmark.
Network Select the appropriate network from the
drop-down list.
IP Address Enter the local IP address.
112
Chapter 15: Hotspot Manager

The Hotspot Manager includes four main tabs when
accessed by the UniFi Controller super admin account. For
details on a specific tab, refer to the appropriate section.
Guests
If you create a bookmark for the Hotspot Manager, ensure

that you include the site name in the URL, which should be
in this format:
https://unifi.yourdomain.com:8443/hotspot/s/site_name
Guests
The Hotspots active guests are displayed.
Payments and Transactions on page 114

Vouchers on page 114
Operator Accounts on page 115
Only admins with read/write access to the UniFi Controller
can create operator accounts for the Hotspot Manager.
Operator accounts are designed for use by hotels or other
businesses to service guests and have no access to other
UniFi administrative features. Operator accounts will
have access to three tabs after login: Guests, Payments,
andVouchers.
per page: 10, 50, 100, or 200.
On any sub-tab, you can click any of the column headers
to change the list order.
To access the Hotspot Manager, go to Settings >
Guest Control, and click Go to Hotspot Manager. See
Hotspot on page 30 for more information.
Show Filter by time duration: last 24hours, 3days,

7days, 2 weeks, 30 days, and 120 days.
Enter keywords in the Search
Search
field to find a specific guest based on Name/MAC Address,
Package, Amount, Authorized By, or Status value.
Name Displays the guests device name or MAC address.
113
Package Displays the description of the package that was

purchased (if applicable).
Status Displays the status of the transaction.
Amount Displays the amount paid for access (if

applicable).
Refund Refund the selected customer if necessary.
Authorized By Displays the authorization method. If

there is no authorization, then None is displayed.
Download Displays the total amount of data
downloaded.
Vouchers
Create vouchers that include distributable codes, duration
values, and use restrictions.
Upload Displays the total amount of data uploaded.

Start Time Displays the start time of the guest access.
Status Displays the remaining session time for the guest.
Displays Expired if there is no remaining session time.
Disconnect Immediately disconnect the selected guest.
Extend Extend a guests session for an additional
24hours. For example, if you click it three times, you will
extend guest access for three more days.
Payments and Transactions

The Hotspots payments and transactions are displayed.
Create Vouchers To create a batch of vouchers, click ??

and complete the following:
Create __ Enter the number of vouchers to create.
One time/Multi-use Select how often the voucher can
be used: One time or for Multi-use.
Expiration Time Select how long the voucher is valid:
8hours, 24hours, 2 days, 3 days, 4 days, 7 days, or
Userdefined. If you select User-defined, enter a number
and specify day, minute, or hour.
Bandwidth Limit (Download) Select to limit the
download bandwidth. Enter the maximum in Kbps.
Bandwidth Limit (Upload) Select to limit the upload
bandwidth. Enter the maximum in Kbps.
Show Filter by time duration: last24hours, 3days,

7days, 2 weeks, 30 days, and 120days.
Enter keywords in the Search field
Search
to find a specific voucher based on Time, Name, Package,
Amount, Extra Info, or Status value.
Byte Quota Select to limit the amount of data transfer

allowed per session. Enter the maximum in megabytes.
Notes Enter any notes specific to this batch of vouchers.
Save Click Save to create the vouchers as specified.
Time Displays the date and time of the transaction.
Last Name Displays the users last name.
First Name Displays the users first name.
Package Displays the description of the package.
Amount Displays the amount of the transaction.
Extra Info If the user paid by credit card, the Extra Info
field will display the type of credit card and the last
four digits of the credit card used. If the user paid by an
alternative method such as PayPal, the Extra Info field may
display information such as the email address associated
with the PayPal account.
114
Search
Enter keywords in the Search box
to find a specific voucher based on Code, Create Time,
Notes, Duration, or Status value.

Account Name Enter a name for the operator. The

Account Name should use A-Z, a-z, or 0-9. Spaces and
symbols are allowed but not recommended.
Print all Unused Vouchers Click PRINT ALL UNUSED VOUCHERS to

send a page to your printer with the codes and durations
of unused vouchers.
Password Enter a password for the operator. The

Password has to start with A-Z, a-z, or 0-9. The other
characters can only be printable ASCII characters.
Print Batch A batch is a group of vouchers created at the

same time. Click PRINT BATCH to display a list of dates with
times. Select the date with time of the batch you want
to retrieve. A tab will open with the vouchers ready for
printing.
Notes (Optional) Enter a note to identify or describe the

operator.
Save Click Save to create the new operator account.
Code Displays each active voucher code.

Create Time Displays the date and time a voucher was
created.
Down Displays the maximum download bandwidth
allowed.
Up Displays the maximum upload bandwidth allowed.
Byte Quota Displays the maximum amount of data
transfer allowed per session.
Notes Displays any notes that were added using the
Notes option during voucher creation.
Open Operator Login Click

operator credentials.
Duration Displays the duration of minutes, hours, or days

that the voucher enables the user to access the Internet.
If you create a bookmark for the Hotspot Manager, ensure

that you include the site name in the URL, which should
be in this format:
https://unifi.yourdomain.com:8443/hotspot/s/site_name
Status Indicates whether the voucher is valid for a single

use or multiple uses. Displays Expired if the voucher is no
longer valid. Displays the number of times used and time
until expiration for multi-use vouchers.
Print Click
PRINT
OPEN OPERATOR LOGIN
to test the
The UniFi Hotspot Manager login screen will appear. Enter

the username and password in the appropriate fields and
click Sign In.
to print an individual voucher.
Revoke Click REVOKE to immediately deactivate the

selected voucher.
Operator Accounts
(Only available for admins with read/write access to the
UniFi Controller). Create Operator Accounts that can log
in to Hotspot Manager to manage guests, payments or
transactions, and vouchers.
Only the Guests, Payments, and Vouchers tabs will appear.

Search
Enter keywords in the Search
field to find a specific operator account based on Name,
Password, or Notes value.
Name Displays the name of the operator.
Password Displays the password.
Create New Operator To create a new operator account,
click
and complete the following:
Notes Displays any descriptive notes.

Delete Click
to remove an operator account.

115
116
Appendix A: Portal
Customization with
LegacyJSP
Appendix A: Portal Customization with LegacyJSP
Configuring Portal Customization

To enable the guest portal with custom Legacy JSP
branding, perform the following steps:
1. Go to Settings and click Guest Control.
Before You Begin

Starting with UniFi v5, you have two options for portal
customization: AngularJS and Legacy JSP.
AngularJS
AngularJS is the new option for client-side rendering. We
recommend AngularJS unless you are using old templates.
Note: AngularJS is not compatible with old
templates because the old templates were
designed to work with JSP (Java Server Pages).
The UniFi Controller offers a built-in editor to customize
AngularJS; however, it is not fully customizable at
thistime.
AngularJS is a single-page app, so it should work more
quickly. However, AngularJS uses JS (JavaScript), which
may not work with some really old web browsers or newer
browsers with JS support disabled.
AngularJS uses responsive design, so it will adapt to the
size of a mobile device, such as a tablet or smartphone.
2. Select Enable Guest Portal to enable it, and then

select an authentication method.
Note: See Settings > Guest Control on page
27 for more information on enabling the
Guest Portal for the following authentication and
landing page options: No authentication, Simple
Password, and Hotspot.
Appendix A: Portal Customization with Legacy JSP is for

Legacy JSP implementation only. See Settings > Guest
Control on page 27 for more information about the
built-in editor for AngularJS.
Legacy JSP
Legacy JSP is the pre-existing option for server-side
rendering. Legacy JSP is fully customizable and uses old
HTML, so it should work with any web browser. You can
customize Legacy JSP only by overriding files. Legacy JSP
works more slowly and is not responsive by default.
Overview
With Legacy JSP, the UniFi Controller software allows
complete branding of a portal implementation, allowing
you to white label your wireless Internet service as if you
had developed it yourself.
3. For the Template Engine setting, keep the default,

Legacy JSP.
4. For the Override Default Templates setting, select
Override templates with custom changes.
In order to provide the maximum flexibility in your

branding effort, the UniFi Controller software provides
total access to the portal directory on the system in which
it is installed.
This open architecture allows you to include unlimited
content while keeping development simple through the
use of plain .html (hand code or use any editor of your
choice). Testing is simple and immediate; simply reload
changes from any browser.
5. Click Apply Changes.

117
Viewing the Default Portal
Mac
Once Guest Portal and Override Default Templates are

enabled, connect to the Guest Network SSID as shown
below, depending on your platform.
1. Navigate to Go > Applications.
Windows
1. Go to Connect to Network.
Windows 8 Go to the Settings menu and click the
Network icon.
Windows 10/7 Right-click the Network
icon.
2. Select the Guest Network SSID and click Connect.

3. Depending on the security type applied to the
network, enter the security key or password. Click OK
or Connect.
2. Control-click the UniFi application and then click Show

Package Contents.
4. Launch your web browser and you will be directed to

the default portal page for the authentication type
configured on the Guest Portal (see Settings > Guest
Control on page 27 for screenshots of default
portal pages by authentication method).
Mac
1. Click the AirPort
icon in the menu bar (top right
side of the screen).
3. Double-click the Contents folder to open it.
2. Select the Guest Network SSID and click Connect.

3. Depending on the security type applied to the
network, enter the security key or password. Click OK.
4. Once connected, the AirPort
icon will change from
gray to solid black. The number of black lines indicates
the signal strength.
5. Launch your web browser and you will be directed to
the default portal page for the authentication type
configured on the Guest Portal (see Settings > Guest
Control on page 27 for screenshots of default
portal pages by authentication method).
4. Double-click the Resources folder to open it.
Setup
The html and css files are located on the system that the
UniFi Controller software has been installed on. The files
are in the following locations:
UniFi Cloud Key

/srv/unifi/data/sites/<site_name>/portal
Mac
/Applications/UniFi.app/Contents/Resources/data/
sites/<site_name>/portal
Windows
<Drive_Letter>:\Users\<Username>\Ubiquiti UniFi\data\
sites\<site_name>\portal
For specific instructions on accessing the files, refer to the
specific operating system:
Mac
Windows on page 120
118

5. Double-click the data folder to open it.

9. You have several files that you can customize in the
portal folder (these are described in the Customizable
Default Files section).
6. Double-click the sites folder to open it.

10. To customize the voucher, doubleclick the bundle
folder to open it.
7. Double-click the folder whose name matches the site

ID (for example: /manage/s/<site_ID>/dashboard).
11. You can customize voucher.css and voucher.html to fit
your needs.
8. Double-click the portal folder to open it.
119
Windows
The Windows files are located in the following location:
<Drive_Letter>:\Users\<Username>\Ubiquiti UniFi\
data\sites\<site_name>\portal
Customizable Default Files

The following default customizable html and css files are
located in the portal folder:
index.html Main landing page that displays pricing to
the guest.
payment.html Used to submit credit card information.
It requires https and also serves as an example of an
additional .html page.
fail.html Displayed when there is an error handling a
guest login.
reset-min.css Standardizes the rendering of HTML
elements across browsers.
styles.css Controls the style of HTML elements.
The following default files are located in the bundle folder:
voucher.html Page for vouchers.
voucher.css Standardizes the rendering of HTML
elements across browsers.
messages.properties You can edit this file using a
text editor such as TextEdit. This file defines package
costs, duration of access, duration of a free trial period,
package titles, and how the charge will appear on a
customers credit card account. Error messages are also
defined by this file.
Additional details on portal customization can be found in

our community site at:
http://ubnt.link/UniFi-Portal-Customization
120
Appendix B: UniFi Discovery Utility
Appendix B: UniFi Discovery

Utility
Overview
UniFi Discovery Utility Interface

Upon launch, the UniFi Discovery Utility listens to Layer-2
broadcast/multicast beacons from UniFi APs in both a
factory default state and an unmanaged state (adopted
but unable to contact the UniFi Controller software).
The Ubiquiti UniFi Discovery Utility includes tools that

allow the discovery and management of UniFi APs. It is
installed automatically as part of the UniFi Controller
software installation process. See Software Installation
on page 1 for more information.
Launching the UniFi Discovery

Utility
Mac Users
From the Finder, click Go > Applications and double-click
the UniFi-Discover.app icon.
MAC Address Displays the MAC address and alias of

the AP. The alias is displayed in parentheses if it has been
specified; see UniFi Access Point Configuration on
page 100 for details.
IP Address Displays the IP address of the AP and the
method used by the AP to obtain an IP address. The
method is displayed as DHCP or Static in parentheses.
Model Displays the model name of the AP.
Version Displays the firmware version installed on the AP.
Status Displays the current status of the AP: Pending,
Managed/Adopted, Login Failed, or IP Unreachable.
PC Users
There are three buttons available:
For most versions of Windows, go to Start > All Programs

> Ubiquiti UniFi and doubleclick the UniFi-Discover icon.
Manage on page 122
Locate on page 122

Reset on page 123
Note: To reboot the AP, click one of the buttons listed
above and proceed to Reboot on page 123.
For Windows 8, go to the Start menu and doubleclick the

UniFi-Discover icon.
121
Locate
Manage
Locate the AP. The following window will appear:
Set the inform URL, allowing the AP to be managed by

the UniFi Controller software running in a NOC or in the
cloud. (See Network Topology Requirements on page
1 for a visual representation of this configuration.) The
following window will appear:
Actions If you clicked the Locate button, then Locate is

automatically selected.
Username If required, enter the device username.
Password If required, enter the device password.
Apply Click Apply to locate the AP. The LED on the AP will
flash so that it can be differentiated from the other APs.
Actions If you clicked the Manage button, then Manage is

automatically selected.
Set Inform URL Enter the URL, port, and path to the UniFi
Apply Click Apply to save the inform URL.
122
Reset
Reboot
Reset the AP to factory default settings. The following

window will appear:
To reboot the AP, click any of the buttons (Locate, Manage,

or Reset) on the UniFi Discovery Utility screen. The following
window will appear:
Actions If you clicked the Reset button, then Restore to

factory default is automatically selected.
Actions Select Reboot from the drop-down menu.
Apply Click Apply to reset the AP to factory default

settings.
Apply Click Apply to reboot the AP.
123
124
Appendix C: UniFi Mobile App

Overview
The UniFi app has two general functions:
You can use a mobile device to provision a UniFi AP
for basic functionality without configuring a UniFi
Controller. Go to the Basic Setup section below.
You can use a mobile device to access the UniFi
Controller. Go to Controller Mode on page 128.
3. Launch the app, and use one of the following options:

Log In Enter the Username and Password of your
Ubiquiti Single Sign-On (SSO) account. Tap Log In.
Register To register for an SSO account, tap
Register.
Continue If you do not want to back up or restore
configurations, you can skip the login and tap
Continue.
Basic Setup
You can set up any UniFi AP.
Requirements
An Ethernet connection from the UniFi AP to the LAN
with DHCP
Firmware version 3.4.4.3231 or higher
A compatible Android or iOS device
The following instructions describe the iOS version of the
app; however, the Android version is similar.
4. The app will search for new devices. Tap the UniFi AP
on the device list and go to step 8.
1. Download the UniFi App from the AppStore (iOS) or

Google Play (Android).
2. Select the functionality you want to use:

Controller mode Use the app to access the UniFi
Controller. Go to Controller Mode on page 128.
I dont have a controller Use the app to manually
provision a UniFi device for basic functionality
without configuring a UniFi Controller. Go to step 3.
5. If a new device is not detected, tap
6. Tap Scan QR Code.
125

7. Scan the QR code on the back of the UniFi AP, or tap
Enter ID Manually to type the casesensitive MAC
address.
Note: For Android, the mobile device
automatically connects to the helper SSID. For
iOS, manually copy and paste the helper SSID
and password.

Connected Clients Displays the number of clients
connected to this UniFi AP.
SSID Displays the wireless network name.
Encryption Displays Encrypted.
Traffic In/Out Displays the amount of upload and
download traffic.
Clients
8. You may be prompted to upgrade the UniFi AP to the

latest firmware. Please proceed with the upgrade.
Go to the Device section below to set up the UniFi AP.
Device
The Device screen displays basic status information:
Connected Clients Displays the number of clients

connected to this UniFi AP. Tap to display additional
details:
Uptime Displays the duration of time the device has
Traffic Displays the total amount of data downloaded
and uploaded by the client.
RSSI Displays the SNR of the connection.
Block this client Tap to block this client from accessing
the network.
Configure To manage the device, go to the Configure

section in the next column.
Overview
IP Address Displays the IP address of the device.
hardware identifier of the device.
Firmware Version Displays the version number of the
devices firmware.
Radio 2G
Blocked Clients Displays the number of blocked clients.

Tap to display a list of blocked clients.
Unblock this client Tap to allow this client access to the
network.

Transmit Power Displays the level of transmit power.
126
Configure
WLAN Settings
Select your country Select the appropriate country

from the list.
Name/SSID Enter the name of the wireless network.

Enabled Enable or disable wireless functionality.
Security Select the security method you want to use.
Security Key Enter the passphrase.
Configure the following settings for each radio:
Radio 2G (11n/b/g)
Radio Settings
Radio 5G (11n/ac)
Channel Select a channel number or keep the default,

Auto.
Radio Settings
(channel width) Select the appropriate channel width.
Channel Select a channel number or keep the default,

Auto.
TX Power The default is Auto. Select High, Medium, or

Low.
(channel width) Select the appropriate channel width.
TX Power The default is Auto. Select High, Medium, or

Low.
127
WLAN Settings
Restore Restore the previously saved configuration.
Same as 2G? Tap to use the same settings as the

2.4GHz configuration.
Change mode Select this option if you want to change

to Controller mode. Go to the Controller Mode section in
the next column.
Name/SSID Enter the name of the wireless network.

Enabled Enable or disable wireless functionality.
Security Select the security method you want to use.
Note: For advanced configuration, switch to

Controller mode.
Security Key Enter the passphrase.
Controller Mode
Apply Settings Tap to save your changes.
You can access the UniFi Controller through the UniFi

mobileapp.
Requirements
An Ethernet connection from the UniFi device to the
LAN with DHCP
Firmware version 3.4.4.3231 or higher
A compatible Android or iOS device
1. Download the UniFi App from the AppStore (iOS) or
Google Play (Android).
Settings
The Settings screen offers the following options:
2. Select the functionality you want to use:

Controller mode Use the app to access the UniFi
Controller. Go to step 3.
I dont have a controller Use the app to manually
provision a UniFi AP for basic functionality without
configuring a UniFi Controller. Go to Basic Setup
on page 125.
Secure Shell (SSH) Login Username Change the

username of the device login.
SSH Login Password Change the password of the
device login.
Country Code Change the country selection.
Single Sign-On (SSO) Username Change the username
of the SSO account.
SSO Password Change the password of the SSO
account.
Automatic Configuration Backup Enable or disable
automatic backup of the current configuration.
Back Up Now Back up the current configuration.
128

3. Enter the following information:
The UniFi app includes four tabs:
(IP address) Enter the IP address of the UniFi

Controller.
Dashboard on page 129
(port) Enter the appropriate port number, which is

typically 8443.
Clients on page 135
Note: If you do not know the IP address, you can

tap Find to detect a UniFi Controller and then
select it.
(username) Enter your username for the UniFi
Controller.
Devices on page 130

Settings on page 137
Dashboard
The Dashboard screen provides an overview of your
networks status.
(password) Enter your password for the UniFi

Controller.
Remember username and password Tap this
option if you want the app to remember your
username and password.
Tap Connect.
WAN
(status) Displays one of the following:
OK The node is active.
Unknown There is no UniFi Security Gateway.
Warning There is a warning; please investigate further.
Error There is an error; please investigate further.
4. You may be prompted to enter a descriptive name for
the Controller if it is currently using an IP address. You
can change it now and then tap OK, or you can tap Not
Now to skip this step.
Inactive Displays the number of Gateway devices

adopted but not active.
Pending Displays the number of Gateway devices
pending adoption.
LAN
Unknown There is no UniFi Switch.
Inactive Displays the number of wired devices adopted
but not active.
Pending Displays the number of wired devices pending
adoption.
WLAN
Unknown There is no UniFi AP.
129

Inactive Displays the number of APs adopted but not
active.
Pending Displays the number of APs pending adoption.
Devices
Devices Displays the total number of devices.
WLAN Displays the number of wireless devices.
WAN Displays the number of Gateway devices.
LAN Displays the number of wired devices.
Scroll down the Dashboard screen to view additional
status information.
Devices
The Devices screen displays a list of UniFi devices
discovered by the UniFi Controller. Details include
the model number, hostname, status, and connection
duration. Tap a device for configuration or details.
All Displays all device types.
GW/Switch Displays Gateway and Switch devices only.
APs Displays UniFi APs only.
Phones Displays UniFi VoIP Phones only.
Clients
Clients Displays the total number of clients.
Users Displays the number of connected users.
Guests Displays the number of connected guests.
Latency and Throughput

Note: The Latency and Throughput values require
a UniFi Security Gateway.
providers gateway. Unknown is displayed if there is no
UniFi Security Gateway.
Throughput Down Displays the amount of current
download traffic. Unknown is displayed if there is no UniFi
Security Gateway.
Throughput Up Displays the amount of current upload
traffic. Unknown is displayed if there is no UniFi Security
Gateway.
Overview
Configure To manage the device, go to Configure on
page 133.
IP Address Displays the IP address of the device.
hardware identifier of the device.
Firmware Version Displays the version number of the
devices firmware.
Uptime Displays the duration of time the device has
130

RF Environment (Available only for UAPACLITE,
UAPACLR, UAPACPRO, and UAPACEDU.) Tap this
option for spectral analysis to help in channel selection
and planning.
-- 2G/5G Select the frequency band you want to

analyze.
-- Scan Tap Scan to trigger an RF scan and then tap
Scan again to continue.
Note: The RF scan may take more than five
minutes. All clients using this AP will be
disconnected, and the AP will be offline for the
duration of the scan.
Connected Clients
Users Displays a list of connected users, including SSID
(wireless network name), Activity level, and connection
duration. Tap a user for details; go to the Overview
section below for more information.
Guests Displays a list of connected guests, including

SSID (wireless network name), Activity level, and
connection duration. Tap a guest for details; go to the
Overview section below for more information.
131
Overview
Connection Displays the hostname, alias, or MAC
address of the UniFi device the client is connected to.
Uptime Displays the duration of time the client has
been connected without interruption.
Statistics Displays additional client information:
-- ESSID (Available for wireless clients.) Displays the

name of the wireless network.
-- Connection Displays the hostname, alias, or MAC
-- Channel (Available for wireless clients.) Displays the
channel being used.

-- Packets Down Displays the amount of data
-- Packets Up Displays the amount of data uploaded as
packets.
-- Bytes Down Displays the amount of data
-- Bytes Up Displays the amount of data uploaded as
bytes.
History Displays the historical usage of a client.
-- (date/time) Displays the date and time of the

connection.
-- (duration) Displays the duration of the connection.
-- (down/up) Displays the total amount of data
downloaded and uploaded by the client.
-- Signal (Available for wireless clients.) Displays the

percentage of signal strength between the AP and
client.
-- TX Rate Displays the transmit rate.
-- RX Rate Displays the receive rate.
-- Power Save Displays the status of the power save
mode.
-- Activity Displays the level of activity in Bytes per
second.
132
Actions
You can locate or restart the device.

-- Channel Select the appropriate channel number and
channel width.
Group, then the Channel setting cannot be
changed.
-- TX Power Select the appropriate transmit power
value. The default is Auto.
Locate Tap to flash the LED on the device. The LED will
flash until Locate is tapped again.
Restart Tap to restart the selected device.
Configure
-- Min. RSSI Disabled by default. Select this option
and enter a minimum threshold (we recommend a
value in this range: -70 to -90 dBm). For UniFi, RSSI
is synonymous with SNR. If the client signal falls
below the specified threshold, then the AP kicks
out the client, allowing it to reconnect with a more
suitableAP.
Alias Also known as the host name. Enter or edit the

customizable name or identifier of the device.
Radios These settings are available only for APs.

Group, the Minimum RSSI setting cannot be
changed.
133

WLAN These settings are available only for APs.

Network Select the appropriate option:
-- Using DHCP The use of the Dynamic Host
Configuration Protocol (DHCP) is the default. The AP
-- Static IP Assign fixed network settings to the AP.
Enter the following information:
IP Address Enter the IP address for the AP.
Subnet Mask Enter the subnet mask of the AP.
Gateway Enter the IP address of the gateway (for
Preferred DNS Enter the IP address of the primary
DNS server.
-- WLAN Group Select the appropriate group.

-- (SSID) Tap to override settings. The WLAN Override
screen appears.
Enabled on This AP Tap to enable the WLAN for

use.
Use VLAN Tap to enable the VLAN. Then enter the
VLAN ID. The VLAN ID is a unique value assigned to
each VLAN on a single device. Enter a value between
2 and 4095. For example, in a large deployment
where there are multiple buildings, you can use a
different VLAN ID for each building while all of the
VLANs remain on the same corporate network.
Alternate DNS Enter the IP address of the

secondary DNS server.
DNS Suffix Enter the Fully Qualified Domain Name
Band Steering (This setting is available only for the

UAPPRO, UAPACLITE, UAPACLR, UAPACPRO, and
UAPACEDU.) 2.4 GHz networks are typically more
congested due to support of legacy clients and multiple
sources of 2.4GHz interference, including Bluetooth
devices. Band steering can help distribute the load on
2.4 GHz and 5GHz networks by steering dual-band
clients to the 5 GHz band when appropriate.
SSID Enter the SSID override name to apply to the

wireless network.
Security Key If the WPA-Personal security option
has been applied to the WLAN under Settings >
Wireless Networks, then the Pre-Shared Key (PSK) for
the SSID specified will automatically appear in this
field.
134

-- Off Keep the default, Off, if you do not want to use
band steering.
-- Prefer 5G Select this option to steer clients to the
5GHz band at a lower channel utilization threshold
than the Balanced option. The threshold is not a
single value; instead it is a function of two values:
the 2.4GHz channel utilization and 5 GHz channel
utilization.
-- Balanced (Not available for the UAP-PRO.) Select this
option to steer clients to the 5 GHz band channel at a
higher channel utilization threshold than the Steer to
5G option.
Clients
The Clients screen displays a list of network clients. Details
include the hostname, SSID (wireless network name),
Activity level, and connection duration. Tap a client for
details.
You can filter by connection type:
All Displays all connection types.
Wireless Displays wireless clients only.
Wired Displays wired clients only.
Airtime Fairness (This setting is available only for

the UAPACLITE, UAPACLR, UAPACPRO, and
UAPACEDU.) This helps multiple users to share the
bandwidth of a single AP. Tap to enable this option.
Overview
Forget Tap Forget to remove the AP from management
by the UniFi Controller software and reset it to factory
default settings.
Connection Displays the hostname, alias, or MAC

Uptime Displays the duration of time the client has
been connected without interruption.
Note: Use caution when tapping Forget. This will

restore the AP to factory default settings when it is
in a Connected state. Do not use the Forget option
when the AP is in an Isolated or Disconnected state. If
you do, the only way to make the AP accessible from
the UniFi Controller is to take it down and connect
by wire.
135

Statistics Displays additional client information:

History Displays the historical usage of a client.
-- ESSID (Available for wireless clients.) Displays the

name of the wireless network.
-- (date/time) Displays the date and time of the

connection.
-- Connection Displays the hostname, alias, or MAC

-- (duration) Displays the duration of the connection.
-- Channel (Available for wireless clients.) Displays the

channel being used.
-- Signal (Available for wireless clients.) Displays the
percentage of signal strength between the AP and
client.
-- (down/up) Displays the total amount of data

downloaded and uploaded by the client.
Actions
You can block or unblock a client device.
-- TX Rate Displays the transmit rate.

-- RX Rate Displays the receive rate.
-- Activity Displays the level of activity in Bytes per
second.
-- Packets Down Displays the amount of data
-- Packets Up Displays the amount of data uploaded as
packets.
-- Bytes Down Displays the amount of data
-- Bytes Up Displays the amount of data uploaded as
bytes.
Block Tap to block this client from accessing the
network.
Unblock Tap to reconnect a blocked client.
Note: Use caution if you block a client and then exit
the Client screen. The blocked client will disappear
from the client list and then you cannot unblock the
client from the UniFi mobile app. Instead, you must
access the browser-based UniFi Controller and then
unblock the client on the Insights screen.
136
Settings
The current site is displayed on this screen.
Site To change a site, tap the current site and then select
a different site.
Log Out To exit the UniFi app or change its mode, tap
Log out.
137
138
Appendix D: UniFi EDU MobileApp
Appendix D: UniFi EDU

MobileApp
Overview
You can use the UAP-AC-EDU to broadcast
announcements with clarity from your mobiledevice.
Use the UniFi EDU app to broadcast announcements from
the UAP-AC-EDU.
Requirements
The UniFi EDU app includes five tabs:

Broadcast (see below)
Schedule on page 137
Recordings on page 142
Volume on page 143
Settings on page 143
Broadcast
You can organize the UniFi AC EDU APs into multiple
broadcast groups.
UniFi Controller software v4.9.5 or higher

UAP-AC-EDU firmware v3.4.18 or higher
A compatible Android or iOS device located on the same
Layer-2 network as the UniFi Controller and UniFi APs
The following instructions describe the iOS version of the
app; however, the Android version is similar.
1. Download the UniFi EDU app from the AppStore (iOS)
or Google Play (Android).
2. Launch the app.

3. Enter the following information:
(IP address) Enter the IP address of the UniFi
Controller.
To create a broadcast group, follow these instructions:

1. Click
2. Enter a descriptive name in the Group Name field.
(port) Enter the appropriate port number, which is

typically 8443.
Note: If you do not know the IP address, you can
click Find to detect a UniFi Controller and then
select it.
(username) Enter your username for the UniFi
Controller.
(password) Enter your password for the UniFi
Controller.
Remember username and password Tap this
option if you want the app to remember your
username and password.
3. Tap the appropriate UniFi AC EDU APs.
Tap Connect.
4. Tap Save to apply your changes, or tap Cancel to

discard your changes.
139
To begin a broadcast, follow these instructions:
To edit a broadcast group, follow these instructions:
1. Tap the broadcast group you want to use.
1. Tap Edit.
2. Tap Start Broadcast to start the announcement.
2. To change the name or members of the group, tap the

broadcast group.
3. Tap Stop Broadcasting to end the announcement.

3. Make your changes.
The speakers will automatically be muted when you stop

broadcasting.
140


To delete a broadcast group, follow these instructions:
To schedule an announcement, follow these instructions:
1. Tap Edit.
1. Tap
2. To remove a broadcast group, tap
2. Configure the following:

(Date and time) Select the appropriate date and
time.
Repeat Select this option to specify how often the
announcement should recur. Then select Never,
Every Day, Every Weekday, or Custom.
If you selected Custom, select the Frequency, Weekly
or Monthly, and then select the appropriate
weekday or date.
Recording/Sample Select the appropriate recording
or sample.
Broadcast Group Select the appropriate group.
3. Tap Done.
Schedule
You can schedule an announcement.

141
To delete an announcement, follow these instructions:
To create a recording, follow these instructions:
1. Click Edit.
1. Tap
2. To remove an announcement, tap
2. Tap to start recording. Tap

to play back the recording.
to stop recording. Tap
3. Tap Done.
Recordings
You can create a recording.

142

To delete a recording, follow these instructions:
1. Click Edit.
2. To remove a recording, tap
Test Sound Tap Test Sound to select a specific sound for

testing. Then tap any sound to select it.
(slider) Use the slider control to adjust the volume for

each speaker.
Test To test the sound of any speaker, tap Test.
Settings
The current site is displayed on this screen.
3. Tap Done.
Volume
You can select a test sound or adjust the volume of any
speaker.
Site To change a site, tap the current site and then select
a different site.
143
Log Out To exit the UniFi app or change its mode, tap
Log out.
144
Appendix E: Controller Scenarios
Appendix E: Controller
Scenarios
A UniFi Cloud Key can be used as a remote controller. For

example, if you have a campus-wide UniFi network and
each building has its own router, then Layer-3 adoption is
required.
Overview
Deployment Options
The UniFi Controller is a software program that sets up,

manages, and monitors UniFi devices, which do not have
individual configuration interfaces (except for the UniFi
Cloud Key); instead, you use the UniFi Controller as a
network management system to configure settings.
There are different scenarios for the deployment of the

UniFi Controller. This chapter describes three examples of
typical deployments:
Local (see below)
Layer-3 Deployment on page 146
For very small installation that dont require a guest

portal or advanced features, you can set up UniFi APs in
standalone mode. Refer to UniFi Mobile App on page
125 for details.
Hybrid Deployment on page 147
Local Deployment
The application diagram below shows an example of a
deployment using local controllers. Each site has a local
instance of the UniFi Controller:
Hosting Controller Software

The UniFi Controller can be hosted on any of the following:
High rise The UniFi Controller is running on a

computer.
a local UniFi Cloud Key (a low-power dedicated network

device)
Hotel The UniFi Controller is running on a UniFi

CloudKey.
a local server running Linux, MacOSX, or Microsoft

Windows 7/8/10
Restaurant The UniFi Controller is running on a UniFi

CloudKey.
a remote server running Linux, MacOSX, or Microsoft

Windows 7/8/10
Remote Access
Note: The remote controller option requires Layer-3

adoption and management.
Cloud access is enabled on the UniFi Controllers, so you

can use unifi.ubnt.com to remotely monitor and access
multiple controllers. Each controller, in turn, can manage
multiplesites.
Only one instance of the UniFi Controller is required. For

example, use either the UniFi Cloud Key or a local server,
not both.
Local Deployment
unifi.ubnt.com
High Rise
Restaurant
Hotel
UniFi Cloud
Key Controller
Local Controller
UniFi Cloud
Key Controller
(150) UAP-AC-PRO
(2) UAP-AC-LR
(10) US-48-500W
(1) USG-PRO-4
(1) US-8-150W
(10) UAP-AC-PRO
(1) UAP-Outdoor+
(1) USG
(10) UAP-AC-LITE
(2) UAP-AC-LR
(1) UAP-Outdoor5
145
Layer-3 Deployment
Here is an overview of a typical example:

deployment using a remote controller.
1. Create a remote controller.
The UniFi Controller is running in the cloud or your NOC

(Network Operating Center).
High rise The UniFi Controller is off-site. Use Layer-3
adoption to manage this site.
2. At the customer site, open a browser to the remote

controller.
3. Use one of the following methods to configure all local
APs so they inform back to the UniFi Controller:
UniFi Mobile App on page 125
Hotel The UniFi Controller is off-site. Use Layer-3

DNS on page 149
Restaurant The UniFi Controller is off-site. Use Layer-3

SSH on page 150
There are multiple methods to carry out Layer-3 adoption.
DHCP Option 43 on page 149

For details about Layer-3 adoption, go to Layer-3
Adoption on page 148.
Layer-3 Deployment
Central Controller
Restaurant
High Rise
UniFi EasySetup
44:d9:e7:fc:ec:4a
10.21.10.31
UniFi AP-AC Lite
Coffee Shop
10.21.10.192
UniFi AP-AC Lite
L3
L3
L3 Adoption
with App*
L3
Hotel
(150) UAP-AC-PRO
(2) UAP-AC-LR
(10) US-48-500W
(1) USG-PRO-4
(1) US-8-150W
(10) UAP-AC-PRO
(1) UAP-Outdoor+
(1) USG
(10) UAP-AC-LITE
(2) UAP-AC-LR
(1) UAP-Outdoor5
* Refer to Layer-3 Adoption on page 148 for other methods that can be used.
146
Hybrid Deployment
For example, in the application diagram below, you can

use unifi.ubnt.com to access three controllers:

deployment using local and remote controllers.
remote controller
UniFi Cloud Key controller for the hotel
Your sites use a mixture of controller types. Some sites

have local instances of the UniFi Controller, while other
sites have a remote UniFi Controller.
UniFi Cloud Key controller for the restaurant

In turn, the remote controller manages three sites:
Sites 1, 2, and 3 The UniFi Controller is off-site. Use

Layer-3 adoption to manage these sites.
Site 1
Site 2
Note: For details about Layer-3 adoption, go to

Layer-3 Adoption on page 148.
Site 3
Hotel The UniFi Controller is running on a UniFi

CloudKey.
Restaurant The UniFi Controller is running on a UniFi
CloudKey.
Remote Access
Cloud access is enabled on the UniFi Controllers, so you
can use unifi.ubnt.com to remotely monitor and access
multiple controllers. Each controller, in turn, can manage
multiplesites.
Hybrid Deployment
unifi.ubnt.com
Site 1
Site 2
USG-PRO-4
Hotel
Restaurant
USG-PRO-4
L3 Controller
Site 3
UniFi Cloud
Key Controller
(240) UAP-AC-PRO
(10) UAP-AC-PRO
(20) US-48-500W
(10) UAP-AC-LITE
(2) UAP-AC-LR
UniFi Cloud
Key Controller
(1) UAP-Outdoor+
(2) UAP-AC-LR
(1) US-8-150W
(1) UAP-Outdoor5
(1) USG
USG-PRO-4
147
Layer-3 Adoption
Here is an overview of a typical example:
1. Create your controller.
2. At the customer site, open a browser to the UniFi
Controller.
3. Every UniFi AP has a default inform URL:
http://unifi:8080/inform
Use one of the following methods to configure all local
APs so they inform back to the UniFi Controller:
UniFi EasySetup App (see below)
UniFi Discovery Utility (see the next column)
DNS on page 149

For more information about the UniFi EasySetup App, refer
to UniFi Mobile App on page 125.
UniFi Discovery Utility

The UniFi Discovery Utility listens to the multicast and
broadcast packets from UniFi APs and allows you to tell
the UniFi AP to inform any URL you want. (Only APs in the
default state or not in contact with any controller will be
displayed).
The UniFi Discovery Utility is installed alongside your
UniFi Controller. Follow the instructions for the operating
system you are using:
Mac Users From the Finder, click Go > Applications and
double-click the UniFi-Discover.app icon.
DHCP Option 43 on page 149

SSH on page 150
UniFi EasySetup App

1. Launch the UniFi EasySetup App from your mobile
device.
2. Tap Settings. If Settings is not displayed, then tap the

overflow icon in the upper-right corner, and then tap
Settings.
PC Users For most versions of Windows, go to Start

> All Programs > Ubiquiti UniFi and doubleclick the
UniFiDiscover icon.
For other versions, including Windows 8, go to the Start

menu and doubleclick the UniFi-Discover icon.
3. Scroll down the Setting screen to view the UniFi
Controller settings:
Controller mode Enable use of the UniFi EasySetup
App with a UniFi Controller.
Address Enter the IP address of the UniFi Controller.
Port Enter the port number of the UniFi Controller.
Linux Users Run the following command:

java -jar <unifi_base>/lib/ace.jar discover
To perform Layer-3 adoption with the UniFi Discovery

Utility:
1. Wait for the UniFi AP to be displayed.
148

2. If the UniFi AP is not in the factory default state, then
click reset. Enter the SSH username and password, and
then click Apply.
DNS
You have a couple of options:
DNS resolution Configure your DNS server to resolve
unifi to the IP address of the UniFi Controller.
Ensure that the UniFi AP can resolve the domain name of
the UniFi Controller. For example, if you have configured
http://<XYZ>:8080/inform, then ping the UniFi Controller
from the UniFi AP to determine if <XYZ> can be resolved
or reached.
FQDN Use FQDN for the inform URL of the UniFi
Controller: http://FQDN:8080/inform
If the UniFi AP (using a static IP address) fails to connect
to the remote UniFi Controller, then ensure that you have
properly configured the IP address of the DNS server when
you changed the UniFi AP from DHCP to static in the UniFi
Controller UI. If not properly configured, then the UniFi
AP cannot contact the DNS server to resolve the domain
name of the UniFi Controller.
3. Click manage.
4. Change the inform URL. The SSH username and
password should be ubnt/ubnt. Click Apply.
If the UniFi AP has been reset to its factory defaults, then

ensure that you have informed the UniFi AP twice (using
the UniFi Discovery Utility) about the location of the UniFi
Controller.
DHCP Option 43
Instructions vary depending on the router you are using.
EdgeMAX If you are using a Ubiquiti EdgeMAX or
EdgePoint router, then follow these instructions:
1. Access the user interface of the EdgeMAX router.
2. Click the Services tab.
3. Go to Actions > View Details for the appropriate DHCP
server.
5. Open a browser to the remote UniFi Controller. The

UniFi AP should be displayed as Pending Approval.
6. Click approve. The UniFi AP will change to an Adopting
state. Eventually it will change to an Adoption Failed or
Disconnected state.
7. Perform step 3 again.
The UniFi AP is now managed by the UniFi Controller.
Once adopted, the UniFi Controller will upgrade these APs
automatically.
For more information about the UniFi Discovery Utility,
refer to UniFi Discovery Utility on page 121.
149
4. In the UniFi Controller field, enter the IP address of the

UniFi Controller. Then click Save.
The DHCP server will return the IP address of the UniFi

Controller to its DHCP clients, so if a client is a UniFi AP, it
will know how to contact the UniFi Controller.
Linux ISC DHCP Server Configure the dhcpd.conf file:
# ...
option space ubnt;
option ubnt.unifi-address code 1 = ip-address;
class ubnt {
match if substring (option vendor-class-identifier,
0, 4) = ubnt;
option vendor-class-identifier ubnt;
vendor-option-space ubnt;
}
subnet 10.10.10.0 netmask 255.255.255.0 {
range 10.10.10.100 10.10.10.160;
option ubnt.unifi-address 201.10.7.31; ### UniFi
Controller IP ###
option routers 10.10.10.2;
option broadcast-address 10.10.10.255;
option domain-name-servers 168.95.1.1, 8.8.8.8;
# ...
}
Note: You can also use the IP address of the UniFi

Controller instead of the domain name in the
informURL.
Instructions for other DHCP servers are available at:
http://ubnt.link/UniFi-Layer3-Adoption
SSH
If you can SSH into the UniFi AP, then you can perform the
layer-3 adoption via CLI command:
1. Use the UniFi Discovery Utility to ensure that the
UniFi AP is running the same firmware as the UniFi
Controller. If it is not, then follow the instructions at:
http://ubnt.link/UniFi-SSH-Firmware-Upgrade
2. Use the UniFi Discovery Utility to ensure that the UniFi
AP is in the factory default state. If it is not, then SSH
into the UniFi AP and run:
syswrapper.sh restore-default
3. SSH into the UniFi AP and enter:

mca-cli
set-inform http://<ip-of-controller>:8080/inform
150
Appendix F: Contact Information
Appendix F: Contact
Information
Ubiquiti Networks Support
Ubiquiti Support Engineers are located around the world
and are dedicated to helping customers resolve software,
hardware compatibility, or field issues as quickly as
possible. We strive to respond to support inquiries within
a 24-hour period.
2580 Orchard Parkway
San Jose, CA 95131
www.ubnt.com
Online Resources
Support: ubnt.link/UniFi-Support
Community: community.ubnt.com/unifi
Downloads: downloads.ubnt.com/unifi
JL061716
151
www.ubnt.com
2011-2016 Ubiquiti Networks, Inc. All rights reserved. Ubiquiti, Ubiquiti Networks, the Ubiquiti U logo, the Ubiquiti beam logo, and UniFi are trademarks or
registered trademarks of Ubiquiti Networks, Inc. in the United States and in other countries. App Store is a service mark of Apple, Inc. Google, Android, and
Google Play are trademarks of Google Inc. All other trademarks are the property of their respectiveowners.

UniFi Controller V5 UG PDF

Uploaded by

Copyright:

Available Formats

UniFi Controller V5 UG PDF

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

UniFi Controller V5 UG PDF

Uploaded by

Copyright:

Available Formats

Enterprise System Controller

Release Version: 5.0.6

UniFi Controller User Guide

Chapter 2: UniFi Cloud. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Chapter 3: Using the UniFi Controller Software. . . . . . . . . . . . . . . . . . . . .

Adding Custom Maps. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .45

Ubiquiti Networks, Inc.

UniFi Controller User Guide

Chapter 10: UniFi Security Gateway Details . . . . . . . . . . . . . . . . . . . . . . . .

Chapter 11: UniFi Switch Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Chapter 12: UniFi Access Point Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Chapter 13: UniFi VoIP Phone Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

Ubiquiti Networks, Inc.

UniFi Controller User Guide

Chapter 14: Client Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

Chapter 15: Hotspot Manager. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

Appendix A: Portal Customization with LegacyJSP. . . . . . . . . . . . . . . . . 117

Appendix B: UniFi Discovery Utility. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

Appendix C: UniFi Mobile App. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125

Appendix D: UniFi EDU MobileApp. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

Ubiquiti Networks, Inc.

UniFi Controller User Guide

Appendix E: Controller Scenarios. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

Appendix F: Contact Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

Ubiquiti Networks, Inc.

UniFi Controller User Guide

Chapter 1: Software Installation

All UniFi devices support off-site management controllers.

Download the latest version of the UniFi Controller

UniFi Cloud Key Users

Linux, MacOSX, or Microsoft Windows 7/8/10

UniFi Cloud Users

Java Runtime Environment 1.6 (1.8 or above

If you have a UniFi cloud account, please refer to UniFi

Web Browser: Mozilla Firefox, Google Chrome, Microsoft

Network Topology Requirements

Please refer to the UniFi blog on our community site at:

One of the following:

2. Click Continue and follow the on-screen instructions to

UniFi Cloud Key

3. Go to Go > Applications and double-click the UniFi

Proceed to Configuring the UniFi Controller Software

Sample Network Diagram

* Requires Layer-3 adoption. For details, refer to:

Ubiquiti Networks, Inc.

Chapter 1: Software Installation

UniFi Controller User Guide

Configuring the UniFi Controller Software

1. The UniFi Controller software startup will begin. Click

2. Select your country and time zone. Alternatively, you

Note: U.S. product versions are locked to the U.S.

5. Ensure that the Start UniFi Controller after installation

Note: The UniFi Controller software can also be

Note: If there is more than one page of entries

Ubiquiti Networks, Inc.

UniFi Controller User Guide

Chapter 1: Software Installation

Perform the following steps:

Congratulations, your wireless network is now configured.