You are on page 1of 158

Enterprise System Controller

Release Version: 5.0.6

UniFi Controller User Guide Table of Contents

Table of Contents

Chapter 1: Software Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Network Topology Requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Software Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Chapter 2: UniFi Cloud. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
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. i

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 Past Connections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 UniFi Security Gateway – Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74 Remote User VPN. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 Properties. . . . . . . 75 AC-EDU Streams. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 Switch Stats. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 Dynamic DNS . . . . . . 89 Chapter 12: UniFi Access Point Details . . . . . . . 107 Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108 ii Ubiquiti Networks. . . . 61 Chapter 8: Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75 Chapter 10: UniFi Security Gateway Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 Traffic Stats. . . . . . . . . . . . . . 88 UniFi Switch – Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . Inc. . . . . . . . . . . . . . . . . . . 77 UniFi Security Gateway – Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Table of Contents UniFi Controller User Guide Chapter 7: Clients . . . . . 60 Wireless. . . . . . . . . . . 85 UniFi Switch – Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 Chapter 13: UniFi VoIP Phone Details . . . . . . . . . 96 UniFi Access Point – Users . . . . . . . . . . 59 All. . . 95 UniFi Access Point – Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87 Mirroring. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 Wired. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 Port Forward Stats. . . . . . . . . . . . . . . . . . . . 107 UniFi VoIP Phone – Details. . . . . . . . . . . . . . . . . . . . 78 UniFi Security Gateway – Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95 Properties. . . . . . . . . . . . . . . . . . 100 UniFi Access Point – Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107 UniFi VoIP Phone – Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 Chapter 11: UniFi Switch Details. . . . . . 99 UniFi Access Point – Guests. . . . . . . . . . . . . . . 77 Properties. . . . . . . 69 Past Guest Authorizations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 Known Clients. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 Neighboring Access Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 Chapter 9: Insights . . . . . . . . . . . . . . . . . 86 UniFi Switch – Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117 Before You Begin. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125 Controller Mode. . . . . . . . . . . . . . . . . . . . . . . . . . . 143 Settings. . . . . . . . . . 110 Wireless Client – History. . . . . . . . . . . . . . . . . . . . 118 Appendix B: UniFi Discovery Utility. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111 Wired Client – History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125 Overview. . . . . . . . . 118 Setup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128 Appendix D: UniFi EDU Mobile App. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114 Vouchers. . . . . . . . . . . . . 121 Overview. . . . . . . . . . . . 109 Properties. . . . . . . . . . . . . . . . . . . . . . . . . 139 Broadcast. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .UniFi Controller User Guide Table of Contents Chapter 14: Client Details. . . . . . . . . . . . 113 Payments and Transactions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139 Schedule. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139 Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117 Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Inc. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109 Wireless Client – Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121 UniFi Discovery Utility Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113 Guests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117 Configuring Portal Customization. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125 Basic Setup. . . . . . . . . . . . . 121 Launching the UniFi Discovery Utility. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121 Appendix C: UniFi Mobile App. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112 Chapter 15: Hotspot Manager. . . . . . . . . . . . 143 Ubiquiti Networks. 111 Wired Client – Details. . . . . . . . . . . . . . . . . 141 Recordings. . . . . . . . . . . . . . . . . . . 112 Wired Client – Configuration. . . . . . . . . . . . . . . . . . . . . . . . . 142 Volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114 Operator Accounts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110 Wireless Client – Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117 Viewing the Default Portal. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115 Appendix A: Portal Customization with Legacy JSP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iii . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111 Wired Client – Statistics. . . . . . . . . . . . . . . . . . . . . 109 Wireless Client – Statistics . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148 Appendix F: Contact Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151 Ubiquiti Networks Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145 Deployment Options. 151 iv Ubiquiti Networks. . . . . . . . . . . . . . . . . . . . . . . . . . .Table of Contents UniFi Controller User Guide Appendix E: Controller Scenarios. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Inc. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145 Hosting Controller Software. . . . . . . . . . . . . . . . . . . . . . 145 Layer-3 Adoption. . . . . . . . . . . . . . . 145 Overview. . . . . . . . . . . . . . . . .

Follow the instructions in this chapter after you install the Installation hardware.6 (1.ubnt. or Microsoft Windows 7/8/10 UniFi Cloud Users • Java Runtime Environment 1.7 or above of the UniFi Cloud Key Users UniFi Controller software. device type.8. Microsoft Linux Users Edge. UAP‑AC‑EDU: A compatible Android™ or iOS device located on the same Layer-2 network as the UniFi Controller and UniFi APs UniFi Cloud Key (UniFi Controller) UAP-AC-PRO UAP-AC-LR UAP-AC Outdoor 3. located either on-site and connected to the same Layer-2 network. please refer to “UniFi recommended) Cloud Account” on page 12 for more information. which allows you to manage Follow the instructions for your specific computer or your UniFi network using a web browser.UniFi Controller User Guide Chapter 1: Software Installation Chapter 1: Software All UniFi devices support off-site management controllers. This User Guide is for use with version 4. or off-site* in a cloud or NOC 2. Sample Network Diagram * Requires Layer-3 adoption.com/unifi Enterprise System. Go to Go > Applications and double-click the UniFi US-16-150W icon. System Requirements • Linux. Mac OS X.link/UniFi-Layer3-Adoption Ubiquiti Networks. or Microsoft Internet Explorer 11 (or above) Please refer to the UniFi blog on our community site at: Network Topology Requirements http://ubnt.pkg. which is described in the Quick Start Guide. Launch UniFi.link/UniFi-Blog • A DHCP-enabled network (so any device can obtain an Mac Users IP address) 1. refer to: http://ubnt. Inc. Google Chrome. The UniFi devices are bundled with the UniFi Controller software. LAN USG-PRO-4 WAN (DHCP Server) Internet Proceed to “Configuring the UniFi Controller Software” Remote Access to UniFi Controller on page 2. 1 .8 or above If you have a UniFi cloud account. • Web Browser: Mozilla Firefox. For details. If you have the UniFi Cloud Key. Click Continue and follow the on-screen instructions to • For the public address system capability of the install the software. • One of the following: • UniFi Cloud Key • A management station running the UniFi Controller software. please refer to “UniFi Cloud Key” on page 5 for more information. Introduction Software Installation Download the latest version of the UniFi Controller Thank you for purchasing the Ubiquiti Networks® UniFi® software at downloads.

Alternatively. Click Next. Click Install. Note: If there is more than one page of entries to display. Launch UniFi-installer. Country Code to ensure compliance with FCC regulations. product versions are locked to the U. 1. Ensure that the Start UniFi Controller after installation option is checked and click Finish. you will be prompted to install it.exe.S.S. If your computer doesn’t have Java 1. Select the devices that you want to configure and click Next. 2.Chapter 1: Software Installation UniFi Controller User Guide PC Users Configuring the UniFi Controller Software 1. 2 Ubiquiti Networks. Click 2. click the navigation controls or page numbers at the bottom right of the screen to display Note: The UniFi Controller software can also be different pages. 3. Note: U. Click Install to continue. . 5. Click Next. You can click Refresh Now to have the UniFi Controller repeat its device discovery process. you can click restore from a previous backup to use a file that contains your backup settings. launched from Start > All Programs. 3. 4.6 or above installed. Select your country and time zone. Inc. Launch a Browser to Manage Wireless Network. The UniFi Controller software startup will begin.

3 . the browser will be redirected to the management interface. and enter a guest network name in the Guest SSID field. Ubiquiti Networks. or click Back to make changes.UniFi Controller User Guide Chapter 1: Software Installation 4. To enable guest access. Enter the wireless network name (SSID) in the Secure SSID field. management interface. Enter the admin name and password that you created and click Login. 5. your wireless network is now configured. Congratulations. select Enable Guest Access. c. Ensure that you save the super admin login information for future use. Enter a passphrase to be used for your primary A login screen will appear for the UniFi Controller network in the Security Key field. Click Next. Confirm your password in the Confirm Password field. Perform the following steps: a. Click Finish to save your settings wireless network for your devices. Review your settings. b. c. Proceed to “Using the UniFi Controller Software” on page 17 for information on using the UniFi Controller software. b. Enter an admin name in the Admin Name field. Enter an email address in the Admin Email field. The UniFi Setup Wizard will create a secure primary 6. Inc. Create the super admin for your UniFi Controller. 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. Perform the following steps: a. d. Once the wizard is finished. e. Enter a password in the Password field to use when accessing the management interface as a super admin. Click Next. d.

Chapter 1: Software Installation UniFi Controller User Guide 4 Ubiquiti Networks. . Inc.

UniFi Controller User Guide Chapter 2: UniFi Cloud Chapter 2: UniFi Cloud Chrome Instructions 1. Inc. Mozilla Firefox. This chapter describes the (PC) or return (Mac). use one of the following methods to launch the software: • If you are using Chrome.ubnt. go to the Chrome Instructions section (recommended). Software Installation After you follow the hardware installation instructions in the UniFi Cloud Key Quick Start Guide. 5 .com in the address field. System Requirement Web Browser: Google Chrome.com • UniFi Cloud Key • “UniFi Cloud Account” on page 12 UniFi Cloud Key 3. 5. Launch the Chrome web browser and type You can access the UniFi Controller via the UniFi Cloud Key https://unifi. • If you are using a different web browser. Introduction 2. Proceed to step 6. Controller software.1. Click Sign In. you will be prompted to add Sample Network Diagram it.168. If the tool is not installed.ubnt. UAP-AC Outdoor US-16-150W LAN USG-PRO-4 WAN (DHCP Server) Internet Note: The default fallback IP address of the UniFi Cloud Key is 192. Click Find Cloud Key. following: https://unifi. Enter the username and password for your UBNT The UniFi Cloud Key includes the pre-installed UniFi account. go to “Instructions for Other Web Browsers” on page 7. If the Ubiquiti® Device Discovery Tool is already Remote Access to UniFi Controller installed. proceed to step 7. Microsoft Edge. Press enter and/or the UniFi cloud account. 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 UAP-AC-LR 4. Ensure that your host system is on the same Layer-2 network as the UniFi Cloud Key. Ubiquiti Networks.30.

Configure the UniFi Controller: a. and enter a password in the SSH Password field. and then a. Proceed to “Using the UniFi Controller Software” on page 17 for information on using the UniFi Controller software. b. b. Note: A future feature will enable backup of the UniFi Controller database and configuration on the included microSD card. Enter a username in the SSH Username field. Enter the admin name and accessing the management interface. To install the tool: 9. Select it to continue. 10. Select the appropriate time zone.Chapter 2: UniFi Cloud UniFi Controller User Guide 6. c. Inc. 6 Ubiquiti Networks. Wait for the UniFi Controller to be adopted. Confirm your password in the Confirm Password field. Click Install. The Ubiquiti Device Discovery Tool will search for the UniFi Cloud Key. password that you created and click Login. Click Launch Site. Keep the IP address or enter a hostname in the Controller Hostname field. d. f. . 7. Enter an admin name in the Admin Name field A login screen will appear for the UniFi Controller and a password in the Password field to use when management interface. g. Select the appropriate country. e. select it. then select Use non‑default SSH credentials. If you want to set up an SSH login for management access to the UniFi Cloud Key. Click Submit to save your changes. Click Add app to confirm. 8.

The UniFi Setup Wizard will create a secure primary wireless network for your devices. you can click restore from a previous backup to use a d.S. more information). Perform the following steps: a. Press enter (PC) or return (Mac). Select the devices that you want to configure and click Next. and enter a guest network name in the Guest 5. SSID field. so it will try to automatically obtain an IP address. 7.30. 7 . The UniFi Cloud Key is set to DHCP by default. Note: U.UniFi Controller User Guide Chapter 2: UniFi Cloud Instructions for Other Web Browsers 6. Ensure that your host system is on the same Layer-2 network as the UniFi Cloud Key. Ubiquiti Networks. 2. file that contains your backup settings. 4.168.S. Enter the wireless network name (SSID) in the Secure SSID field. To enable guest access. type https:// followed by the appropriate IP address. Click Next. The UniFi Setup Wizard screen appears. Note: You can click Configure to change the settings of the UniFi Cloud Key (refer to “UniFi b. select Enable Guest Access. The default login is ubnt/ubnt c. 1. product versions are locked to the U. or root/ubnt. Launch the web browser. Alternatively. Assign a specific IP address to the UniFi Cloud Key. In the address field. Inc. Note: The default fallback IP address of the UniFi Cloud Key is 192. 3. Country Code to ensure compliance with FCC regulations. Enter a passphrase to be used for your primary Cloud Key Configuration” on page 8 for network in the Security Key field.1. Click Manage to run the UniFi Setup Wizard. or check the DHCP server for its IP address. Click Next.

the browser will be redirected to the DHCP server for its IP address. Enter an email address in the Admin Email field.Chapter 2: UniFi Cloud UniFi Controller User Guide 8. A login screen will appear for the UniFi Controller management interface. Note: The default fallback IP address of the UniFi Cloud Key is 192. future use.168. 8 Ubiquiti Networks. The UniFi Cloud Key is set to DHCP by default. 3. Click Finish to save your settings will try to automatically obtain an IP address. c. d. Confirm your password in the Confirm Password Note: A future feature will enable backup of the field. your wireless network is now configured. software. management interface. Note: Only the super admin – not any site admin – UniFi Cloud Key Configuration can view devices that are Pending Approval and Login Instructions then adopt them on the UniFi Controller. Review your settings. Launch the web browser. Press enter (PC) or return (Mac). 2. UniFi Controller database and configuration on the e. Congratulations. Perform the following steps: a. b. Ensure that your host system is on the same Layer-2 that you save the super admin login information for network as the UniFi Cloud Key. In the address field. . Enter an admin name in the Admin Name field. Enter the admin name and password that you created and click Login. Ensure 1. or check the is finished. type https:// followed by the appropriate IP address. Click Next.1. Create the super admin for your UniFi Controller.30. Enter a password in the Password field to use when Proceed to “Using the UniFi Controller Software” on accessing the management interface as a super page 17 for information on using the UniFi Controller admin. Inc. Assign a or click Back to make changes. included microSD card. so it 9. Once the wizard specific IP address to the UniFi Cloud Key.

• Cancel  Click Cancel to discard changes. Navigation Bar 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. enter the Username and Password (the default login is ubnt/ubnt). • New password  Enter the new password. • Configure  Click Configure to change the settings of the UniFi Cloud Key. Then click Login. The Change Password screen will appear: 5. You have two options: Username • Manage  Click Manage to access the UniFi At the top right of each screen. MAC Address  Displays the MAC address or hardware identifier of the UniFi Cloud Key. Logout  To manually sign out of the UniFi Cloud Key configuration. Inc. 9 . click . Change password  To change the password. Proceed to “Using the UniFi Controller display the Change Password and Logout options: Software” on page 17 for more information. Version  Displays the version number of the UniFi Cloud Key firmware. After you click Configure. The Main screen displays basic status information about the UniFi Cloud Key. • Old password  Enter the current password (the default is ubnt). • Submit  Click Submit to apply changes. click . click the Username to Controller. Main The Main screen will appear. • Confirm Password  Enter the new password again. Ubiquiti Networks.UniFi Controller User Guide Chapter 2: UniFi Cloud 4.

Configuration The Configuration screen allows you to configure the basic • DHCP  The use of the Dynamic Host Configuration and network settings of the UniFi Cloud Key. upgrade the -.Primary DNS  Enter the IP address of the network’s primary DNS server. click to toggle Off. Reset Button  Use of the hardware Reset button on the UniFi Cloud Key is enabled by default. -. Maintenance • Static  The service provider assigns fixed network settings to your service for manual entry. Inc. Protocol (DHCP) is the default. To prevent an accidental reset to default settings. Date  Displays the current date and time. Basic Settings Device Name  Enter a descriptive name or identifier for the UniFi Cloud Key. 10 Ubiquiti Networks.Gateway  Enter the IP address of the network’s gateway router. -. -. for your service: Static or DHCP. The UniFi Cloud Key automatically acquires network settings from the network’s DHCP server. Time Zone  Select the appropriate time zone. Also known as a host name. reset it to factory defaults. Free  Displays the amount of available disk space.Fallback IP Address  Enter the IP address for the UniFi Cloud Key to use if an external DHCP server is not found. Configuration Mode  Select the Internet connection type Discard  Click Discard to cancel changes.Secondary DNS  Enter the IP address of the network’s secondary DNS server.Chapter 2: UniFi Cloud UniFi Controller User Guide Uptime  Displays the duration of time the UniFi Cloud Key has been running. Used  Displays the amount of used disk space. Total  Displays the total amount of disk space.IP address  Enter the Internet IP address of the UniFi UniFi Cloud Key firmware. power it off. following information: so you can change the password. or upgrade the UniFi Controller Cloud Key. -. software.Fallback Netmask  Enter the netmask for the UniFi Cloud Key to use if an external DHCP server is not found. Network Settings Apply Changes  Click Apply Changes to save changes.Netmask  Enter the subnet mask of the UniFi Cloud Key. Disk Space Available  Displays the percentage of available disk space. Enter the The Maintenance screen contains administrative options. -. -. . reboot the UniFi Cloud Key.

Note: Updating the UniFi Cloud Key firmware will Firmware also update the UniFi Controller software. Check for Updates  Click Check for Updates to see if there is a newer software version. 37 for more information) before resetting the • Cancel  Click Cancel to skip the update. Controller software. • Confirm Password  Enter the new password again. click Change • upload file  If you have the firmware saved in a specific Password. • Cancel  Click Cancel to discard changes. We Version  Displays the version number of the UniFi Cloud recommend that you back up your UniFi Controller Key firmware. configuration (refer to “Backup” on page 37 for Check for Updates  Click Check for Updates to see if more information) before updating the UniFi Cloud there is a newer firmware version.UniFi Controller User Guide Chapter 2: UniFi Cloud Security You have two options: Password  To change the password. Reset to Defaults  Click Reset to Defaults to reset the UniFi Cloud Key to its factory default settings. If there is. The Please Confirm Update screen will appear. If there is. • Submit  Click Submit to apply changes. Inc. then you can follow the on-screen instructions to upgrade now. Note: We recommend that you back up your UniFi Controller configuration (refer to “Backup” on page 37 for more information) before upgrading. UniFi Update Manually  Click Update Manually to update the Version  Displays the version number of the UniFi firmware. then click Select File to browse for the file. then you can Key firmware. follow the on-screen instructions to upgrade now. The Change Password screen will appear: location. Ubiquiti Networks. This option will reboot the UniFi Cloud Key. Note: We recommend that you back up your UniFi Controller configuration (refer to “Backup” on page • Update  Click Update to proceed with the update. location. then enter it in the URL field. 11 . Maintenance Reboot  Click Reboot to powercycle the UniFi Cloud Key. • Old password  Enter the current password (the default is ubnt). • get file from URL  If you know the URL of the firmware’s • New password  Enter the new password. and all factory default settings will be restored. Power Off  Click Power Off to turn off the UniFi Cloud Key. UniFi Cloud Key to its defaults.

Chapter 2: UniFi Cloud UniFi Controller User Guide

UniFi Cloud Account A secondary filter is available:
You must be a super admin for initial cloud management. • All  Displays all UniFi Controllers.
Once cloud access is enabled by the super admin, then • Online  Only displays online UniFi Controllers.
any other admin can also enable cloud access. • Offline  Only displays offline UniFi Controllers.
Note: The cloud account is also known as the Single Find Cloud Key  Click to discover a UniFi Cloud Key on
Sign-On (SSO) account. your local network.
Search   Enter the text you want to search
Login Instructions for. Simply begin typing; there is no need to press Enter.
1. Launch the Chrome web browser and type
You can click any of the column headers to change the
https:// followed by the appropriate Controller
list order.
Hostname/IP address as specified in “Settings >
Controller” on page 35. Press enter (PC) or return (icon)  Displays the icon corresponding to the device
(Mac). 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
Controller  Displays the hostname, alias, or MAC address
account. Click Sign In.
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.
Version  Displays the software version number of your
UniFi Controller.
Note: If you do not have an account, click
Actions  Click a button to perform the desired action:
Register and follow the on-screen instructions.
• Remove  Click to remove the UniFi Controller
A list of UniFi Controllers will appear. from your cloud account.
Chat  At the lower left of the screen, click to open a
window for online chat support.
Admin
At the top right of the screen, click to display the My
Account and Sign Out options:

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 Ubiquiti Networks, Inc.

UniFi Controller User Guide Chapter 2: UniFi Cloud

My Account  To change your account settings and/or Find Cloud Key
password, click . The Account Settings screen
To add a UniFi Cloud Key, click Find Cloud Key at the top
will appear:
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.
mac  Displays the MAC address or hardware identifier of
the UniFi Cloud Key.
There are three pages available:
firmware  Displays the firmware version number of the
• Profile  Access your account settings:
UniFi Cloud Key.
-- First Name  Enter your first name.
Adopt  Click to adopt the UniFi Cloud Key. Refer to step
-- Last Name  Enter your last name. 8 of “Chrome Instructions” on page 5 for more
-- Username  Enter your login username. information.
-- Email  Enter the email address of your cloud account. Cancel  Click to exit this screen.
-- Update Settings  Click to apply your changes. Manage
• 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
the UniFi Cloud Key.
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 Cancel  Click to exit this screen.
want to join the beta program.
Sign Out  To manually sign out of the cloud account, click
.

Ubiquiti Networks, Inc. 13

Chapter 2: UniFi Cloud UniFi Controller User Guide

Additional Details (site_name)
Select a UniFi Controller to display more information at • Launch Site  Click Launch Site to access the UniFi
the bottom of the screen. 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
network’s 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
-- Red  Red indicates one of the following:
• (controller_name)  Displays the Controller Hostname/IP
• WWW  Internet connectivity is down.
address as specified in “Settings > Controller” on page
35. • WAN  The UniFi Security Gateway is offline.
• IP Address  Displays the IP address of the device • LAN  One or more Switches are offline.
running the UniFi Controller. • 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 -- Gray  Gray indicates that there is no Internet
managed by the UniFi Controller. connection or there are no devices available for
that node.
• Software Version  Displays the software version
number of your UniFi Controller. You can place the mouse over each node icon to display
basic status information.
• Actions  Click a button to perform the desired action:
-- WWW  The basic details of the Internet connection
-- Remove  Click to remove the UniFi Controller
are displayed.
from your cloud account.
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)   Displays the number of unread
alerts.
• Gateway  Displays the IP address of the service
provider’s 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 Ubiquiti Networks, Inc.

• APs  Displays the number of APs in the primary wireless network(s) and the number of APs in the guest wireless network(s). Gateway. -. • Users  Displays the number of clients connected to the primary wireless network(s). • Guests  Displays the number of clients connected to the guest wired network. • LAN IP  Displays the local IP address of the UniFi Security Gateway. • Down  Displays the download rate of your Internet connection. Ubiquiti Networks. • Switches  Displays the number of UniFi Switches connected to the wired network. -. • Users  Displays the number of clients connected to the wired network. • Down  Displays the download rate of the UniFi Security Gateway.WAN  The basic details of the UniFi Security Gateway connection are displayed. • Gateway  Displays the IP address of the service provider’s gateway. • Up  Displays the upload rate of the wired network(s).LAN  The basic details of the wired network(s) are displayed. the service provider’s gateway. • Up  Displays the upload rate of the wireless • Up  Displays the upload rate of the UniFi Security network(s).UniFi Controller User Guide Chapter 2: UniFi Cloud • Latency  Displays the amount of time it takes a -. Inc. 15 .WLAN  The basic details of the wireless network(s) are packet to travel from the UniFi Security Gateway to displayed. • Down  Displays the download rate of the wired network(s). • Down  Displays the download rate of the wireless network(s). • Up  Displays the upload rate of your Internet connection. • Clients  Displays the total number of local clients. • Guests  Displays the number of clients connected to the guest wireless network(s).

Chapter 2: UniFi Cloud UniFi Controller User Guide 16 Ubiquiti Networks. Inc. .

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

• Cancel  Click to discard changes. When the and wired guests . Top right. The default is MM/DD/YYYY hh:mm a. • Alerts position  Select the position you want alerts to appear: Top left. Green indicates active.WLAN  The icon is color-coded to display the sireless network connection status.Cancel  Click to discard changes. click Username Sites overview .The Sites Overview screen will appear. Top center. want to use.Pending  Displays the number of wired devices pending adoption. -. Green indicates active.Chapter 3: Using the UniFi Controller Software UniFi Controller User Guide • Sites overview  To display a list of available sites. when it is open. click the Username to display the Preferences. adoption.Submit  Click to save changes. When the property panel is not inline. . • Date format  Enter the format you want to use. red indicates inactive. Green indicates active.Active  Displays the number of active wired devices. devices. property panel is inline. The table -.Guests  Displays the number of wireless guests • Inline property panel  Enabled by default. -.Active  Displays the number of active wireless on the Settings screens. • Datetime format  Enter the date and time format you -. -. • Language  Select the appropriate language. click -. -. Bottom center. Click Learn more for more information about date and time format options. when the table columns are not customized. or Bottom right.LAN  The icon is color-coded to display the wired . it compresses the main content • Add new site  To create a new site. If enabled.Pending  Displays the number of wireless devices pen • Responsive tables  Disabled by default. • Condensed view  Enabled by default. default is hh:mm a. • Reset to Defaults  Click to reset to factory defaults.Site Name  Enter a name that describes the site.Inactive  Displays the number of inactive wired devices. and Logout options: Each site is displayed with the following: -. network connection status. it and the Add a New Site screen will appear: opens on top of the content. click Add new site . Preferences  To change the UI settings. the Responsive tables option removes columns on -. fit as much data on the screen as possible. A dark theme is used -. 18 Ubiquiti Networks. -. as a popup. -. -. At the top right of the screen. red indicates inactive. Bottom left. The be used in the Current Site drop-down menu. -. Edit Account.Users  Displays the number of wireless users and smaller‑sized browsers to prevent excessive scrolling wired users . • Dark settings  Enabled by default.WAN  The icon is color-coded to display the WAN connection status. red indicates inactive. -. Inc.Name  Displays the name of the site. The default is MM/DD/YYYY.Inactive  Displays the number of inactive wireless padding is condensed and the font size is minimized to devices. It will • Time format  Enter the format you want to use.

device name. • Admin   Enter the admin name. date. there are four controls: • Events (see the next column) Clicking an Event Device Link • Alerts (see “Alerts” on page 20) The messages have clickable links for client and UniFi devices: • Settings (see “Settings” on page 20) • “UniFi Security Gateway Details” on page 77 • Chat with Us (see “Chat with Us” on page 38) • “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 Ubiquiti Networks. • Email  Enter the email address of the admin account. Logout  To manually sign out of the UniFi Configuration • Admin  Only display recent events for the administrator. Close  Click to close the screen. Select Last hour. Properties • WLAN  Only display recent events for the wireless networks. and time. there is no need to Information about each selected device appears as press Enter. Show  Filter recent events based on the time period you • New Password  Enter the new password. specify. along with the corresponding device icon. • Password  Enter your current password. 19 . To display it. • Confirm Password  Enter the new password again. Last 48 hours. The Edit Account screen will appear: The Events tab displays a list of recent events. Simply begin typing. Interface. Last 8 hours. Search   You can enter text that you want to search for. see Icons the appropriate chapter: The messages use the following icons (not all are shown • “UniFi Security Gateway Details” on page 77 here): • “UniFi Switch Details” on page 85 Scheduled for upgrade • “UniFi Access Point Details” on page 95 UniFi Security Gateway • “UniFi VoIP Phone Details” on page 107 UniFi Switch • “Client Details” on page 109 UniFi Access Point Controls and Live Chat UniFi VoIP Phone At the bottom left of the screen. message. Inc. You can apply one of the following filters: • Cancel  Click to discard changes. • Submit  Click to apply changes. or 30 days. Events click . Maximize/Minimize  Click to maximize the screen size. • LAN  Only display recent events for the wired network. • All  Display all of the recent events.UniFi Controller User Guide Chapter 3: Using the UniFi Controller Software Edit Account  To change the login name and/or password. Last 24 hours. click . select a device. The Properties panel is hidden by default. For more information. 2 weeks. Click again to minimize the screen size. The information varies depending on the device type. a popup within this panel. 7 days.

which will • “UniFi Access Point Details” on page 95 be sent to the email addresses of the administrators. you can run a periodic • “Client Details” on page 109 speed test. device name. along with the corresponding device icon. • Maintenance  System configuration backup. • Networks  Wired network setup. • Cloud Access  Cloud login credentials. the LEDs on the UniFi devices will light up. message. system configuration restore. • “UniFi Switch Details” on page 85 Alerts  Select this option to enable alert emails. discovery. To switch sites. Click again to minimize the screen size. UniFi VoIP Phone Services Clicking an Alert Device Link Automatic Upgrade  When enabled. Close  Click to close the screen. • Site  Site-related settings. Show archived alerts  Select this option to display all of the archived alert messages. • Guest Control  Guest portal and policies. and time. . date. Inc.Chapter 3: Using the UniFi Controller Software UniFi Controller User Guide Alerts Settings When there is a new alert. UniFi Access Point Time Zone  Select the appropriate time zone. Simply begin typing. the LEDs will turn off. 20 Ubiquiti Networks. including Zero Handoff Roaming. The Alerts tab displays a list of important events. • Wireless Networks  Wireless network and group setup. • “UniFi VoIP Phone Details” on page 107 Speed Test (Beta)  When enabled. the UniFi Controller The messages have clickable links for client and UniFi will automatically upgrade your firmware when an update devices: is available. • User Groups  User group settings. UniFi Switch Country  Select the appropriate country. and support files. • Admins  Admin accounts and privileges. Archive All  Click Archive All to archives all of the alert messages. select a different site from the Current Site drop-down menu at the top of any screen. there is no need to press Enter. • “UniFi Security Gateway Details” on page 77 LED  When enabled. Archive  Click to archive the selected alert message. When disabled. • Controller  Identity. Maximize/Minimize  Click to maximize the screen size. Search   You can enter text that you want to search for. an orange icon displaying the The Settings tab displays a list of available sub‑tabs: number of new alerts appears. Icons The messages use the following icons (not all are shown here): Site Configuration UniFi Security Gateway Site Name  Change the name of the site. Settings > Site Configure the site-specific settings. and email server settings.

The device supports SNMP v1. either wired or wireless. SNMP is an application layer protocol that facilitates the exchange of management information between network devices. model USG. The server. The default Note: The UAP-AC. The roams from AP to AP – there is no need to re-negotiate. Add or Edit a WLAN Group -. It is required to authenticate access to MIB (Management Information Base) objects and functions • Name  Enter or edit a descriptive name for the WLAN as an embedded password. by checking to see if the gateway/custom IP can be reached. When you enable this option. Ubiquiti’s proprietary have up to four wireless network names or SSIDs per DPI engine includes the latest application identification WLAN group.Uplink IP Address  All managed APs will use the IP address you enter. You can also make domain. then Zero Handoff Apply Changes  Click to save changes. UAP‑AC‑PRO. Go to the Add or Edit a WLAN Group information. They use multicasting to to the UniFi devices. if there • Password  Enter the new password. All devices in the same site share the communicate so they must be wired in the same Layer 2 same SSH username and password. and UAP‑AC‑EDU do not support Zero Handoff Roaming. UAP-AC-Outdoor. It is also not meant for all scenarios. • Custom IP  Click to specify an IP address. changes: Zero Handoff Roaming does not support wireless • Username  Enter the new username. multiple Access Points • Remote IP Address  Enter the IP address of the syslog (APs) act as an AP cluster. is public. except the community strings. • Community String  Specify the SNMP community string. Network administrators use SNMP to monitor network‑attached devices for issues that warrant attention. uplinks and can only be used on a secured network. 21 . Note: The DPI feature requires use of the UniFi Security Gateway. Roaming may not be appropriate for your scenario. but do not have write access. section. The monitor and wireless uplink capability are enabled by default. Reset  Click to cancel changes. For example. appearing as a single AP. Inc. the VOIP port on the UniFi Security Gateway. will be remapped as a WAN2 port. Port Remapping (Beta)  When enabled. Remote Logging  Enable to define a remote syslog server. either by DHCP or Static designation. The APs determine which AP has the best connection Device Authentication  This option protects SSH access and should serve the client. APs will use the gateway of the AP that is providing IP click the button. wireless client detects only one AP. WLAN Group  The Default WLAN group is automatically Uplink Connectivity Monitor  It monitors the uplinks of created. authorized management • Mobility  To enable seamless roaming (Zero Handoff ). stations have read access to all the objects in the MIB select the checkbox. • Default Gateway  Enabled by default. All managed Add a New WLAN Group  To add a new WLAN group. UAP‑AC‑LITE.UniFi Controller User Guide Chapter 3: Using the UniFi Controller Software DPI (Beta)  Deep Packet Inspection (DPI) is more Settings > Wireless Networks advanced than conventional Stateful Packet Inspection Configure the wireless networks for each site. • Clear DPI Counters  Click to delete all collected DPI data. read-only community string. signatures to track which applications (and IP addresses) are using the most bandwidth. the managed APs. is too much load or interference. SNMP  Select this option to activate the SNMP (Simple Network Monitor Protocol) agent. default is 514. so it seamlessly • Port  Enter the port number of the syslog server. UAP‑AC‑LR. Ubiquiti Networks. You can (SPI) filtering for traffic analysis. Click Confirm or Cancel. The device supports a group.

WPA-Personal requires a passphrase to connect Create Wireless Network  Click to add to the wireless network. are excluded. such as 802. select the WLAN group from Note: You can use 5 printable characters. hexadecimal format. -.Radio  Select the appropriate radio. 2. You can enter a 64-bit or select it from the drop-down menu. . or a-f ) Example: 00112233AA • Options  To make changes. • Name/SSID  Enter or edit the wireless network name -. and least secure security algorithm. • Enabled  Select this option to make this network active. • Key Index  Specify which Index of the WEP Key to use. 2G or 5G. When enabled. Select the • Edit  Click to make changes to the wireless EDIT effective key: 1. For each WLAN group. 22 Ubiquiti Networks. Wireless Networks 128-bit 26 Hexadecimal Characters (0-9. but only one is used. Inc. Four different WEP keys can be configured Actions  Click a button to perform the desired action: at the same time. for Zero Handoff Roaming. A-F. and then click the 128‑bit key: delete button. the drop‑down menu. Go to the Create or Edit a Wireless Network section in the next column.) Select this option to balance the number of wireless network. Type Hex 64-bit 10 Hexadecimal Characters (0-9. which will be translated to the corresponding HEX code. A-F. and then click the edit button. Cancel  Click to discard changes. which will be translated to the Go to “Add or Edit a WLAN Group” on page 21.WPA-Personal  WPA or Wi-Fi Protected Access was Network section in the next column. characters. • Security Key  Enter the passphrase that users will use to connect to the wireless network. wireless network access is Legacy Support  (Not available if you enabled the Mobility open to anyone without requiring a password. or 4. WPA™ security methods should be used when possible.Chapter 3: Using the UniFi Controller Software UniFi Controller User Guide Create or Edit a Wireless Network Configure the following options: -. developed as an encryption method stronger than • Delete  Click to remove the wireless network. Example: 00112233445566778899AABBCC Security  Displays the type of security being used on your Note: You can use 13 printable wireless network. which cannot be removed).Open  This option is typically only used on the guest network. Select this option if you want to -.11b devices. clients you specify per radio. option.WEP  WEP (Wired Equivalent Privacy) is the oldest support legacy devices. Save  Click to apply changes. or a-f ) Name/SSID  Displays the wireless network name or SSID. WEP. you have the following: • Remove a WLAN Group  To remove a WLAN group • WEP Key  Enter a WEP encryption key in (except for the Default. a wireless network. legacy devices. Guest Network  Indicates whether or not the network is a guest network. Load Balancing  (Not available if you enabled the Mobility • Security  Select the type of security to use on your option.) By default. Then enter the number of clients in the field provided.Channel  Select the channel that all of the APs will use or SSID. corresponding HEX code. network settings. 3. Go to the Create or Edit a Wireless -.

and Password fields. • Add Auth Server  If you have another • Encryption  Select the appropriate encryption method: authentication server. • WPA Mode  (Available if WPA security is enabled. -. Settings > Networks Configure the networks for each site. 23 . The default is 1812. • Password  Enter the password. Ubiquiti Networks. click this option and complete the IP Address. wireless network name or SSID to be broadcast. complete the IP Address. • IP Address  Enter the IP address. For information about the RADIUS authentication example. • Password  Enter the password. VLAN  Displays the VLAN ID. Port. Power Save Delivery. then you cannot re‑use the same • RADIUS Auth Server   Provide the following VLAN ID for the RADIUS-assigned (dynamic) VLAN. accounting server. you have another option: -. Subnet  Displays the IP address and prefix size. • User Group  Assign wireless users to a specific user • RADIUS Accounting Server   Provide the following group. or authentication server. if you have a VLAN set to VLAN 10.Monday-Sunday  Select the days you want to • Add Accounting Server  If you have another schedule. • Guest Policy  Select this option to enable guest access policies on this wireless network.Hours  Use the sliders to select the start and end times of the day’s wireless access.WPA-Enterprise  WPA Enterprise uses a RADIUS • VLAN  To use a VLAN. Select this option to enable the power save mode of Wi-Fi devices. VLAN ID number. • UAPSD  Disabled by default. if applicable. Click to display options for advanced users. If you enable WPA Enterprise. • Scheduled  Select Enable WLAN Schedule to restrict • Delete  Click the delete icon to remove this wireless access to the schedule you set. Advanced Options • Cancel  Click to discard changes. click this option and Auto. and Password fields. • Save  Click to apply changes. Port. Unscheduled Automatic • Port  Enter the port number. • Hide SSID  Select this option if you don’t want the • Port  Enter the port number. WPA2 Only (default). Inc. -. then you server: cannot use VLAN ID 10 for RADIUS‑controlled VLAN users as those users will not be assigned an IP address. see information about the RADIUS server: “Settings > User Groups” on page 34. • IP Address  Enter the IP address. TKIP Only. Purpose  Displays a description of this network. The default is 1813.UniFi Controller User Guide Chapter 3: Using the UniFi Controller Software -. For more information about user groups. WPA1 Only.) Select • Delete  Click the delete icon to remove this the appropriate WPA method: Both. select Use VLAN ID and enter the server to authenticate users on the wireless network. If you set a VLAN ID as a static value for another SSID on the same AP. Networks Name  Displays the network name.Enable RADIUS assigned VLAN (beta)  Select this option to allow the RADIUS server to dynamically assign a VLAN to a wireless client. or AES/CCMP Only (default). accounting server.

Network Broadcast IP.Auto  Enabled by default. Create or Edit a Network -. • Purpose  Select the most appropriate description: • DHCP Guarding  Disabled by default.) Enter the VLAN ID. or VPN Client. automatically assigned by the DHCP server. but could introduce potential conflicts. 24 Ubiquiti Networks.Trusted DHCP Server IP  Enter the IP address of the instructions for your selection: trusted DHCP server. • DHCP WINS Server  Select this option to designate WINS (Windows Internet Naming Service) server(s). • IP/Subnet  Enter the IP address and prefix size. • Delete  (Not available for the default network. Voice • Network Group (Beta)  Select the appropriate option. seconds. Decreasing the lease time avoids potential address conflicts. and Network Subnet Mask are • IGMP Snooping  Select this option to monitor IGMP displayed. Remote User to detect and block unauthorized DHCP servers. but might cause more slight interruptions to the client while it acquires a new IP address from the DHCP server. addresses of the range in the fields provided. . Increasing the time ensures client operation without interruption.Manual  Select this option to manually select name servers. Enter the number of • Name  Enter or edit the network name. The local DHCP server • Edit  Click EDIT to make changes to the network assigns IP addresses to DHCP clients on the network.WINS Server 1/2  Enter the IP address of the WINS server in each field. -. Then follow the -. Create New Network  Click to add a network. Name servers are Go to “Create or Edit a Network” on page 24. • IP/Subnet  Enter the IP address and prefix size. Network IP Count. • DHCP Lease Time  The IP addresses assigned by the DHCP server are valid only for the duration specified by the lease time. • Name Server 1/2  Enter the IP address of the name server in each field. settings. Voice. Network IP Range. VPN. Site-to-Site VPN. If you previously enabled VoIP. LAN or LAN2. Go to “Create or Edit a Network” on page • DHCP Range  Enter the starting and ending IP 24. Inc.) Click • DHCP Name Server  Configure the name or DNS to remove the network. Guest. (Internet Group Management Protocol) traffic and thereby manage multicast traffic. (Domain Name System) server setting. Gateway IP. -. • Cancel  Click to discard changes. otherwise this network option is not available. The • VLAN  (Not available for the default Corporate network.Chapter 3: Using the UniFi Controller Software UniFi Controller User Guide Actions  Click a button to perform the desired action: • DHCP Server  Enabled by default. then there is a Voice network. VLAN Only. Select this option Corporate. LAN. Corporate or Guest Network • Save  Click to apply changes.

4009. they were attached to the same wire.WINS Server 1/2  Enter the IP address of the WINS server in each field. -.Auto  Enabled by default. -. servers. 25 . -. Decreasing the lease time avoids • IP/Subnet  Enter the IP address and prefix size. • Site-to-Site VPN  Enabled by default. • Cancel  Click to discard changes. The local DHCP server • DHCP Guarding  Select this option to detect and block assigns IP addresses to DHCP clients on the network. Every VLAN ID represents a different VLAN. but might cause more slight • IP Pool  The starting and ending IP addresses of the interruptions to the client while it acquires a new IP pool automatically appear after you complete the address from the DHCP server. Ubiquiti Networks. • Cancel  Click to discard changes. • DHCP Range  Enter the starting and ending IP -.Trusted DHCP Server IP  Enter the IP address of the automatically assigned by the DHCP server. Enter the number of IP/Subnet field. unauthorized DHCP servers. trusted DHCP server.WINS Server 1/2  Enter the IP address of the WINS server in each field. • Cancel  Click to discard changes. thereby manage multicast traffic. • Name Server 1/2  Enter the IP address of the name server in each field. Increasing the time ensures client operation without interruption. which is used for authentication. • DHCP Server  Enabled by default. • DHCP Lease Time  The IP addresses assigned by the DHCP server are valid only for the duration specified by the lease time. Devices option. (Domain Name System) server setting. Name servers are Remote User VPN automatically assigned by the DHCP server. • RADIUS Password  Enter the password of the RADIUS server. unauthorized DHCP servers. -. trusted DHCP server. • Name Server 1/2  Enter the IP address of the name VLAN Only server in each field. • Name Server  Configure the name or DNS (Domain • DHCP Guarding  Select this option to detect and block Name System) server setting. then the remote user can only access the site’s belonging to the same VLAN communicate as if resources. -. but could introduce potential conflicts. Name servers are -.Manual  Select this option to manually select name • Save  Click to apply changes.Manual  Select this option to manually select name servers. Inc.Trusted DHCP Server IP  Enter the IP address of the addresses of the range in the fields provided. The VLAN ID range is 2 to • Save  Click to apply changes. • WINS Server  Select this option to designate WINS (Windows Internet Naming Service) server(s). • DHCP WINS Server  Select this option to designate WINS (Windows Internet Naming Service) server(s). seconds. • RADIUS IP  Enter the IP address of the RADIUS server. • DHCP Name Server  Configure the name or DNS • Save  Click to apply changes. The UniFi Security Gateway is required for this option.Auto  Enabled by default. The remote user can access the site’s resources as well as the resources of any other VPNs connected to the site.UniFi Controller User Guide Chapter 3: Using the UniFi Controller Software • IGMP Snooping  Select this option to monitor IGMP • IGMP Snooping  Select this option to monitor IGMP (Internet Group Management Protocol) traffic and (Internet Group Management Protocol) traffic and thereby manage multicast traffic. The UniFi Switch is required for this option. potential address conflicts. If you disable this • VLAN  Enter the ID number of the VLAN. -.

• Azure static routing  Select this option if you are using Microsoft Azure with static routing for a policy-based VPN. Select the appropriate DH group: 2. • Advanced Options  Click to access the advanced configuration. • Enabled  Select this option to create an OpenVPN • Pre-Shared Key  Enter the pre-shared secret key. Inc. click this option and enter its network address. • VPN Client (Beta)  Select the appropriate option: • Encryption  Both peer routers must use the -. Both peer routers must use the same pre-shared (The UniFi Security Gateway is the local peer router.Auto  Auto is the default. then the defaults of the Advanced Options will also change accordingly. 20. • Key Exchange Version  Both peer routers must use the same Internet Key Exchange (IKE) version. 25. • PFS  Select this option to enable PFS (Perfect Forward Secrecy). • Enabled  Select this option to create an IPsec VPN tunnel over the Internet between two peer routers. or 26. (The UniFi Security Gateway is the local peer router. then you can view and select sites. -. -. 5. UniFi Security Gateway. 26 Ubiquiti Networks. • Customized  Select this option to customize your • Add Subnet  If you have another remote subnet. Select the appropriate encryption method: AES-128.) secret key for authentication. Both peer routers must use the same DH group. AES-256.Chapter 3: Using the UniFi Controller Software UniFi Controller User Guide Site-to-Site VPN • Azure dynamic routing  Select this option if you The UniFi Security Gateway is required for this option. • Remote Subnets  Click Add Subnet to add an • IPsec Profile  Select the appropriate option: address for a remote network. 16. Select the appropriate version: IKEv1 or IKEv2. 21. The default is 14. Note: If you selected Azure dynamic routing or Azure static routing. click this option and enter its network address. • Dynamic Routing  Select this option to enable dynamic routing over the VPN tunnel. • Add Subnet  If you have another remote subnet. • Hash  Both peer routers must use the same hash algorithm. 15. . settings.) • Remote Subnets  Click Add Subnet to add an address for a remote network. • Remote Site  Select the appropriate site from the drop‑down list. 19. remote sites. Select the appropriate hash algorithm: Note: If you have admin privileges for the local and SHA1 or MD5. tunnel over the Internet between two peer routers. are using Microsoft Azure with dynamic routing for a route-based VPN. uses the OpenSSL (Secure Sockets Layer) library and • Local WAN IP  Enter the Internet IP address of the SSL/TLS (Transport Layer Security) protocols. • DH Group  The DH (Diffie-Hellman) group specifies the strength of the DH encryption key for the key exchange.OpenVPN  Select this option to create a VPN that • Peer IP  Enter the IP address of the peer router. 14.IPsec VPN  Select this option create a VPN that uses IPsec (IP security protocol). which helps enhance the security of keys. or 3DES. same encryption method.

• Save  Click to apply changes. click this option and enter its network address. • Shared Secret Key  Enter the pre-shared secret key. 2 days. • MPPE  Select this option to require MPPE (Microsoft Point-to-Point Encryption). and days. 4 days. hours. Inc. Both peer routers must use the same pre-shared secret key for authentication. which can be designated in minutes. 3 days. • Local Address  Enter the Internet IP address and port number of the UniFi Security Gateway. • Server IP  Enter the IP address of the VPN server. can choose to require the terms of service). you can control the Guest Portal. • Remote Address  Enter the Internet IP address and port number of the remote router. Authentication  When the Guest Portal is enabled. 7 days. When this option is enabled. • Save  Click to apply changes. -. 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. When disabled. 27 .UniFi Controller User Guide Chapter 3: Using the UniFi Controller Software • Remote Host  Enter the hostname of the remote router. VPN Client The UniFi Security Gateway is required for this option. • Cancel  Click to discard changes. the authentication options will appear: • Authentication > No Authentication (see below) • “Authentication > Simple Password” on page 28 • VPN Client (Beta)  PPTP Client is automatically • “Authentication > Hotspot” on page 28 selected.Add Subnet  If you have another remote subnet. • Cancel  Click to discard changes. • Password  Enter the VPN password. guests can access the Internet without entering a password or accepting the terms of service. 24 hours. • Username  Enter the VPN username. Authentication > No Authentication • Remote Subnets  Enter the network address of the Select this option if guests are not required to log in (you remote network. or User‑defined. • “Authentication > External Portal Server” on page 33 • Enabled  Select this option to enable the VPN client. Guest Policies Enable Guest Portal  Disabled by default. Ubiquiti Networks.

guests Redirect Using Hostname  Select this option to enter and are directed to the URL they requested.ubnt.ubnt. Inc. guests are redirected to redirected to the URL that you specify. Select one of the following options: URL begins with http://. or User‑defined. Guest Password  Enter a password that guests must enter before connecting to the Internet. and selection of the terms of service by the guest. Ensure that the that site certificates are displayed as trusted in the guest URL begins with http://. 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. this ensures redirected to the URL that you specify. then guests will be gaining access to the Internet. IP address. Authentication > Simple Password Select this option if guests are required to enter a simple password (you can choose to require the terms of service).ubnt. Guest Control > Portal Customization to enforce selection of the terms of service by the guest. 28 Ubiquiti Networks. See “Guest Policy” on page 23 for more information. guests will be required to enter the Guest Password before If you enable the terms of service. guests 4 days. which can be designated in are directed to the URL they requested. Authentication > Hotspot Select this option to enable Hotspot functionality. You must also select Enable Guest Portal under Settings > Guest Control to enforce voucher entry. 24 hours. and days. minutes. 3 days.Chapter 3: Using the UniFi Controller Software UniFi Controller User Guide Landing Page  After connecting. including the ability to customize portal login pages and bill customers using major credit cards or other supported methods. Paired with an SSL certificate. . 7 days. See “Access Control” on page 33 for more information. Paired with an SSL certificate. Example: http://www. required to accept the terms of use before gaining access to the Internet. hours. If you enable the terms of service. Example: www. use a hostname for the portal URL in place of the default • Promotional URL  After connecting. See “Access Control” on page 33 for more information. guests are IP address. 2 days. Ensure that the the landing page. You can select Enable terms of service under Settings > See “Guest Policy” on page 23 for more information. • Redirect to the original URL  After connecting. Example: www. guests are redirected to Expiration  Specify the guest login expiration after a the landing page. Example: http://www.ubnt.com • Redirect to the original URL  After connecting. • Promotional URL  After connecting.com When logging in with Simple Password authentication.com Redirect Using Hostname  Select this option to enter and When logging in with No authentication. Select one of the following options: designated period of time: 8 hours.com browser. this ensures that site certificates are displayed as trusted in the guest browser. guests can click use a hostname for the portal URL in place of the default Connect for immediate access. payment. guests are Landing Page  After connecting.

Inc. You can customize Legacy JSP only by overriding files. guests are redirected to the landing page.com Redirect Using Hostname  Select this option to enter and use a hostname for the portal URL in place of the default IP address.Text position  Select the appropriate location for the AngularJS. so it should work more quickly. Legacy JSP is fully customizable and uses old HTML. After you have added your welcome text. AngularJS uses responsive design. Note: AngularJS is not compatible with old templates because the old templates were Once you have welcome text.ubnt. 29 . (This option is not available if you are using an external portal server. The default is Hotspot portal. Example: http://www. click Submit to save your changes or click Cancel. Ubiquiti Networks. so it should work with any web browser. such as a tablet or smartphone.) • Title  Enter the title of your portal. Template Engine  Select AngularJS for client-side rendering or Legacy JSP for server-side rendering. Example: www.com Portal Customization Select this option to have customized portal pages appear in place of the default login pages. then you can click EDIT to designed to work with JSP (Java Server Pages). Paired with an SSL certificate. Legacy JSP works more slowly and is not responsive by default. guests are directed to the URL they requested. Under the logo or Above boxes. We recommend AngularJS unless you are using old templates. AngularJS  Select AngularJS for client-side rendering. Landing Page  After connecting. • Welcome Text  Select Enable welcome text to add a welcome message. this time. make changes.UniFi Controller User Guide Chapter 3: Using the UniFi Controller Software AngularJS is a single-page app. The UniFi Controller offers a built-in editor to customize -. AngularJS uses JS (JavaScript). however. guests are redirected to the URL that you specify. which may not work with some really old web browsers or newer browsers with JS support disabled. so it will adapt to the size of a mobile device. this ensures that site certificates are displayed as trusted in the guest browser. Select one of the following options: • Redirect to the original URL  After connecting. Ensure that the URL begins with http://. it is not fully customizable at welcome text. • Promotional URL  After connecting.ubnt. However.

you can customize vouchers using the voucher. or enter the hexadecimal HTML color value you want to use.png format.Button text color  Click Button text color to select the appropriate color. See “Portal -. Preview previews the portal in the desktop view. however. The default is #1379b7. or enter the hexadecimal HTML color value you want to use.html and voucher. -. -. color value you want to use. then you can click to make changes. Click Submit to save your changes or click Cancel.Box opacity  You can change the opacity of the box background color. Once you have the terms of service. The default is #cccccc.Box color  Click Box color to select the appropriate color.) Then click Open. Note: At this time AngularJS does not support voucher customization. or enter the hexadecimal HTML color value you want to use.Button color  Click Button color to select the appropriate color. or enter the hexadecimal HTML more information.Link color in box  Click Link color in box to select the appropriate color. The default is #ffffff. The default is #000000. EDIT • Portal Customization  You can make the following formatting changes: -.Text color  Click Button color to select the appropriate color.Text color in box  Click Link color in box to select the appropriate color. The default is #1379b7.Background color  Click Button color to select the Customization with Legacy JSP” on page 117 for appropriate color. -. or enter the hexadecimal HTML When Hotspot authentication is selected. -.jpg format. -.Link color  Click Link color in box to select the appropriate color. (We recommend the use of the . or enter the hexadecimal HTML color value you want to use. -.Background image  Click Upload image and select the image you want to use. The default is 90. or enter the hexadecimal HTML color value you want to use. (We recommend the use of the . Legacy JSP  Server-side rendering is enabled by default. . Hotspot -. or enter the hexadecimal HTML color value you want to use.css files. you want to manually edit templates. -. • Tile background image  Select this option if you want to repeat the background image in a tile • Override Default Templates  Select this option if pattern. The default is #ffffff.Customize logo  Click Upload image and select the logo you want to use. • Reset Style  Reset Portal Customization changes to the factory defaults. Inc.) Then click Open. section is displayed. • Mobile Preview  Click Mobile Preview to preview the portal in the mobile view.Chapter 3: Using the UniFi Controller Software UniFi Controller User Guide • Terms of Service  Select Enable terms of service to add • Desktop Preview  Enabled by default. Refer to “Customizable Default Files” on page 120 for more information. the Hotspot color value you want to use. The default is #1379b7. -. The Desktop any terms of service you want hotspot users to accept. The default is #1379b7. 30 Ubiquiti Networks.

Add or Edit a Package • Required  Select this option if you want to make this field mandatory.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. -.Delete  Click to delete the package. 31 . -.Enable address field  Select this option to create a -. this field mandatory. • Add Another Package  Click ADD ANOTHER PACKAGE to create -.99). (Only • Default value  Select the appropriate default one free package is allowed. duration values. See “Hotspot Manager” on page 113.Edit  Click to make changes to the package EDIT field for an address. for a city. -.Submit  Click to apply changes.Charged as  Enter the text that will be shown on the credit card statement. this field mandatory. Go to the Add or Edit a Package section. Go to the Add or Edit a Package section. settings. so unless you delete it.Limit Download  Enter the maximum download (including distributable code. and use bandwidth in Kbps. authentication. Inc. -. • Required  Select this option if you want to make this field mandatory.Cancel  Click to discard changes.) -. and Free Trial. Ubiquiti Networks.) There are three packages by default: • Required  Select this option if you want to make Basic 8HR ($5.Hours  Enter the number of access hours the package authorization: allows.Enable city field  Select this option to create a field a new package.99).Limit Upload  Enter the maximum upload bandwidth • Payments  Set up payment-based authentication. -. • Required  Select this option if you want to make -.Enable first name field  Select this option to create a field for a first name.Overwrite Limit  Select this option if you want to overwrite the user group policy per WLAN/user. • Required  Select this option if you want to make -. -. this field mandatory. -. -. restrictions). • Required  Select this option if you want to make this field mandatory.UniFi Controller User Guide Chapter 3: Using the UniFi Controller Software Select the Voucher and/or Payment method of -. by default.Payment  Select Free package if appropriate.) -. There is a free package country from the drop-down menu. • Required  Select this option if you want to make this field mandatory.Name  Enter or edit the name of the package. -. in Kbps.Actions  Click a button to perform the desired action: -. • Payment Field Options  (Available only for payment- based authentication. -.Price  Select the appropriate currency from the drop‑down menu. then this option is not available. -.Enable last name field  Select this option to create a • Payment Packages  (Available only for payment-based field for a last name.Enable country field  Select this option to create a field for a country. Premium Daypass ($8. • Vouchers  Use Hotspot Manager to create vouchers -. -. and then enter the price.Limit Quota  Enter the maximum amount (in megabytes) of data transfer allowed per session.

purposes. click Go to To manage payments and transactions. -. or access your IPpay test account. and see “Hotspot Manager” on page 113. Enter the Stripe account detail: • Use test account  For Merchant Warrior testing • API Key  Enter the live secret API key.PayPal™ Website Payment Pro (US.) You have multiple options: -. • Merchant ID  Enter the ID for your merchant account. New Zealand)  Use • Password  Enter the corresponding Password. select this option. manage payments and transactions. To manage payments and transactions. Then click Apply Sandbox Account to set up or access your PayPal Sandbox Test Environment. -. and see “Hotspot Manager” on page the PayPal account that will receive payments.Net Enter the PayPal account details: test account. • API Key  Enter the API key. -. To -. Inc. and see “Hotspot Manager” on page 113. select this option. select this option. • Use test account  For Authorize. Then click Apply Test Account to set up • MD5 Secret  Enter the MD5 secret key. . Canada. Canada)  Use your IPpay account.Net account details: • API Login ID  Enter the API login ID used to identify yourself as an authorized user.Merchant Warrior (Australia. • Use sandbox account  For PayPal testing purposes. • Username  Enter the corresponding Username. and see “Hotspot Manager” on page GO TO HOTSPOT MANAGER 113. and see “Hotspot Manager” on page 113. • Transaction Key  Enter the key used to authenticate transactions. Then click Apply Test Note: We recommend that you perform a test Account to set up or access your Merchant Warrior transaction with the test secret API key first before test account. click Go to Hotspot Manager.Quickpay (Europe)  Use your Quickpay account. -. 113. click Go to Hotspot Manager.Chapter 3: Using the UniFi Controller Software UniFi Controller User Guide • Gateway  (Available only for payment-based authentication. and see “Hotspot Manager” on Hotspot Manager. using the live secret API key. • API Passphrase  Enter the API passphrase. Enter the Authorize.Stripe (US. Enter the IPpay account details: Enter the Quickpay account details: • Terminal ID  Enter the terminal number for your merchant account. 32 Ubiquiti Networks.Net testing purposes.Net account. Enter the Merchant Warrior account details: • Merchant UUID  Enter the ID for your merchant account. Canada)  Use your Authorize. click Go to Hotspot Manager. page 113. click Go to Hotspot • Signature  Enter the corresponding Signature for Manager.Net® (US.Authorize. Then click Apply Test Account to set up or access your Authorize. Canada)  Use your Stripe account. • Use test account  For IPpay testing purposes.IPpay™ (US. To manage payments and transactions. select this option. your Merchant Warrior account. click . UK)  Use your PayPal Website Payments Pro account. To manage payments and transactions. To manage payments and transactions.

guests will be required to select the browser. Pre-Authorization Access  Enter any subnets that you want guests to be able to access. guests will be required to enter the voucher number before gaining access to the Internet.ubnt.com package type and click the payment choice before gaining access to the Internet. Paired with an SSL certificate. Payments/Transactions. Click the delete information. See “Hotspot host a custom guest portal. even if they have not been authenticated. See “Portal Post-Authorization Restrictions  Enter any subnets that Customization with Legacy JSP” on page 117 for more you don’t want guests to be able to access. 33 . Access Control If you enable the terms of service. Custom Portal  Enter the IP address in the IP Address field. Apply Changes  Click to save changes. Manager” on page 113. Select this option if you are using an external server to Vouchers. If you enable the terms of service. selection of the terms of service by the guest. Reset  Click to cancel changes. Click the delete icon to remove a subnet from this list. this ensures When logging in with payment-based Hotspot that site certificates are displayed as trusted in the guest authentication. then guests will be required to accept the terms of use before gaining access to the Internet. then guests will be required to accept the terms of use before gaining access to the Internet.UniFi Controller User Guide Chapter 3: Using the UniFi Controller Software • Hotspot Operator  Click Go to Hotspot Manager Authentication > External Portal Server to manage Wireless Guests. icon to remove a subnet from this list. Example: www. Redirect Using Hostname  Select this option to enter and use a hostname for the portal URL in place of the default IP address. • Add Subnet  Click Add Subnet to add more restricted subnets. When logging in with voucher-based Hotspot authentication. Ubiquiti Networks. You can select Enable terms of service under Settings • Add Subnet  Click Add Subnet to add more allowed > Guest Control > Portal Customization to enforce subnets. Inc. and Operator Accounts.

Controller. Go to the Create or Edit an Admin section. User Group Settings Email  Displays the email address of the administrator. Settings > User Groups To create operator accounts for the Hotspot Manager. The new administrator must use Pending Approval. (The • Edit  Click EDIT to make changes.) Create New Admin  Click to add a new site Create New User Group  Click to create admin. The admin The super admin account is created during the Setup who issued the invitation can select which role the Wizard and has global admin (read/write) access. Note: Ensure that you save the super admin login • Invite  Click to send an email invitation. his or her own cloud account (linked to the same email address) to manage the UniFi Controller. Default user group cannot be deleted. see section. new  wired devices. including the adoption of • Cancel  Click to discard changes. • Delete  Click to delete the user group. pending account. Configure user groups on this screen. You can create administrator accounts that are • Invite to SDN  Select this option to allow the new site‑specific.Chapter 3: Using the UniFi Controller Software UniFi Controller User Guide Settings > Admins • Name  Enter the name of the new administrator. Go to the Create or Edit a User Group To create operator accounts for the Hotspot Manager. this new administrator will have with respect to the UniFi super admin account cannot be revoked or re-invited. information for future use. 34 Ubiquiti Networks. Go to the “Create or Edit a User Group” on • Re-invite  Click to re-send an invitation to a page 34 section below. • Email  Enter the email address of the new administrator. Role  Displays the permissions level: Admin (read/write access) or Read Only. Name  Displays the name of the user group. Bandwidth Limit (Download)  Displays the download limit. The default user group is named Default and has no bandwidth limits. Create or Edit a User Group Create or Edit an Admin • Name  Enter or edit the name of the user group. Actions  Click a button to perform the desired action: Actions  Click a button to perform the desired action: • Revoke  Click REVOKE to remove the selected account. Username  Displays the name of the administrator. these site administrators can only see the administrator access to SDN (Software-Defined sites they manage and cannot see any devices that are Networking) settings. • Edit  Click EDIT to make changes to the user group settings. a new user group. Inc. Read Only. see “Operator Accounts” on page 115. . “Operator Accounts” on page 115. Verified  Displays a checkmark to indicate that an admin is verified after he or she responds to an email invitation. Only the super admin – not any site admin – can view wired devices that are Pending Approval and then adopt • Role  Select Administrator (read/write access) or them on the UniFi Controller. Bandwidth Limit (Upload)  Displays the upload limit.

-. Mail Server • Email or Username  Enter the email address or When enabled. communications over the Internet. Inc.) Configure the system the sender email address.ubnt. this option allows UniFi to be discoverable via UPnP on the Layer-2 network. • Enable Cloud Access  Click to save changes. Ubiquiti Networks. is enabled. Then enter Cloud Login Credentials the appropriate hostname or IP address. this option to override the inform host URL. email address when you create an account under • No account? Register now.Username  Enter the username required by the for information on how to assign a user or guest to a mail server. • Override inform host with Controller Hostname/IP  An inform host URL is used for layer-3 Enable Cloud Access  Click to configure the login. disconnected UniFi devices. https://account. the Controller Hostname/IP will be specified in the Controller URL at the bottom of every message. will appear as the sender of the email alert. Note: The default inform port is 8080. or Disable Live Chat for all users.) Network Discovery  When enabled. user group. See “Wireless Client – Configuration” on page 111 or “Wired Client – Configuration” on page 112 -. Apply Changes  Click to save changes. then the port number will automatically • Bandwidth Limit (Upload)  Select to limit the upload change to 465. Enter the maximum in Kbps. If Secure Sockets Layer (SSL) download bandwidth.UniFi Controller User Guide Chapter 3: Using the UniFi Controller Software • Bandwidth Limit (Download)  Select to limit the • Port  The default is 25. UniFi will send email alerts triggered by username of your UBNT account. Enter the maximum in Kbps. Controller Settings Controller Hostname/IP  Enter the hostname or IP address of the UniFi Controller. Settings > Controller • Specify sender address  Select this option to specify (Available for the superadmin only. • Test SMTP Server  Enter an email address and click Send to test the mail server setup. This option is disabled by default. Specify the administrator • Password  Enter the password of your UBNT account. 35 . Settings > Cloud Access Set up the login for cloud access. Support Messaging  Select the appropriate option: Enable Live Chat for the Super Admin only.properties. bandwidth. Enter the email address that settings of the UniFi Controller. • Enable SSL  You can enable SSL to enhance secure • Save  Click to apply changes. Enable Live Chat for all users. • Enable authentication  Select this option to enable authentication. name. (You can customize this in system. • Cancel  Click to discard changes.  If you do not have a UBNT “Settings > Admins” on page 34. The device adoption using the UniFi Discovery Utility. Select Cloud Login Credentials screen will appear.Password  Enter the password required by the mail server. account. Reset  Click to cancel changes. • Cancel  Click to discard changes.com/register • Hostname  Enter the outgoing (SMTP) mail server Follow the on-screen instructions to set up an account. click here to visit this link: SMTP Server  Select this option to enable emails. Note: When alert emails are sent out.

) Click to disable cloud access and remove the cloud login credentials. Apply Changes  Click to save changes. or Debug. power it off. Services Log Level  You can customize the support information Note: Enabling or disabling cloud access will affect that is collected: cloud access for all admins on that UniFi Controller. 365 days. Inc. • Compact Database  Click to optimize disk usage by freeing up pre-allocated disk space. or Disabled. If your UniFi Controller is running on a UniFi Cloud Key.) Click to disable cloud access and remove the cloud login credentials. • Device  Select the level of severity required to trigger device log entries: Normal. The default is Normal. Server Information Disable and Remove Cloud Access  (Available if you are Current Version  Displays the software version.Chapter 3: Using the UniFi Controller Software UniFi Controller User Guide Cloud Access Settings > Maintenance If the login for cloud access is configured. or Debug. Then click Apply. Enable Cloud Access  Click to enable or disable cloud access. Click Confirm to continue. . 90 days. 60 days. 30 days. you can use the Maintenance tab to upgrade the UniFi Cloud Key firmware. then the Cloud (Available for the superadmin only. More. 36 Ubiquiti Networks. Disable User Cloud Access  (Available if you are a site admin. More. and download configuration information to assist in support issues. Historical Data Retention  Select the time duration of the historical data retention: 7 days. Disabled. • System  Select the level of severity required to trigger system log entries: Normal. manage system backups. reboot the UniFi Cloud Key.) The Maintenance Access screen will appear: screen contains administrative options. 180 days. More. so you can customize logs. a super-admin. or Debug. The default is Normal. or reset it to factory defaults. There may be service interruptions during the process. The default is Normal. • Mgmt  Select the level of severity required to trigger management log entries: Normal. The default is Reset  Click to cancel changes. Status  Displays “Connected” if cloud access is active. Configured for  Displays the username or email address of your UBNT account. upgrade the UniFi Controller software located on the UniFi Cloud Key.

which configured in “Settings > Guest Backup Data Retention  Select the time duration of the Control” on page 27. computer with information about your configuration. • Cloud Access  Displays the status of the Cloud Access feature. • DHCP WINS Server  Displays the IP address of the WINS • Network Config  Click Network Config to view the server.UniFi Controller User Guide Chapter 3: Using the UniFi Controller Software • Conn Monitor  Displays the status of the Uplink Connectivity Monitor feature. • Close  Click Close to exit this screen.png format. or All time. which configured in “Portal Download Backup  Click this option to download a file Customization” on page 29. network configuration settings. which configured in “Settings > Guest Control” on page 27. Follow the on-screen instructions to restore settings from the selected file. System Config • DHCP Server  Displays the status of the DHCP server feature. • DHCP Range  Displays the range of available IP addresses. which configured in “Settings > Guest Control” on page 27. which is configured in “Settings > Site” on page 20. so you can restore them later if you • Close  Click Close to exit this screen. 180 days. which is configured in “Settings > Snooping feature. 60 days. backup data retention: 7 days. 90 days. • Networks  Displays the name(s) of the current network(s). • Current Site  Displays the name of the current site. • Download  Click Download to download a screenshot in . The System Config screen appears. that contains all of your settings and data retained for the duration you specify. Browse  Click Choose File to select a backup file that Network Config you’ve already downloaded. Ubiquiti Networks. System Config  Click Show System Config to view configuration settings.png format. • Download  Click Download to download a screenshot Restore in . • Expiration  Displays the period of time before a guest login expires. 37 . Support Info • Name  Displays the name of the local wired network. 365 days. • DHCP Name Server  Displays the IP address of the DNS server. The default is 7 days. Backup • Landing Page  Displays the type of landing page for guest access. • DPI  Displays the status of the DPI (Deep Packet • IGMP Snooping  Displays the status of the IGMP Inspection) feature. choose. • Wireless Networks  Displays the name(s) of the current wireless networks. 30 days. which configured in “Settings > Guest Control” on page 27. • Subnet  Displays the IP address and prefix size. • Guest Portal  Displays the status of the Guest Portal feature. assigned IP address. Inc. Site” on page 20. You can email this file to our support team. • DHCP Lease Time  Displays the lease time for any • Version  Displays the software version. • Authentication  Displays the type of authentication required for guest access. • Portal Customization  Displays the status of the Portal Customization feature. Download  Click this option to download a file to your • Purpose  Displays a description of this network.

Current Version  Displays the version number of the UniFi Cloud Key firmware. Chat with Us Click to open a window for online chat suport. 38 Ubiquiti Networks. Shut Down Cloud Key  Click this option to turn off the UniFi Cloud Key. Status  Displays the current status. . 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. then you can follow the on-screen instructions to upgrade now. Note: We recommend that you back up your UniFi Controller configuration (refer to “Backup” on page 37 for more information) before upgrading. Cloud Key Controller The Cloud Key Controller section is available if you are using a UniFi Cloud Key. If there is. This option will reboot the UniFi Cloud Key. Click Apply Update to upgrade the firmware. Click Check for Update to see if there is a newer software version. Status  Displays the current status. Note: We recommend that you back up your UniFi Controller configuration (refer to “Backup” on page 37 for more information) before upgrading. Reset Cloud Key  Click this option to reset the UniFi Cloud Key to its factory default settings. and all factory default settings will be restored. UniFi Cloud Key. Inc. Available Version  If there is an available update. then the available firmware version number is displayed. Available Update  If there is an available update. Up to Date or Update Available. Click Check for Update to see if there is a newer firmware version. Up to Date or Update Available. If there is.Chapter 3: Using the UniFi Controller Software UniFi Controller User Guide Cloud Key Firmware Cloud Key Operations The Cloud Key Firmware section is available if you are using Restart Cloud Key  Click this option to powercycle the a UniFi Cloud Key. Click Apply Update to upgrade the software. then the available software version number is displayed. then you can follow the on-screen instructions to upgrade now. Current Version  Displays the version number of the UniFi Controller software.

UniFi Controller User Guide Chapter 4: Dashboard

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 Status information  Place your mouse over the Latency or
your network’s status. Basic information is provided for Throughput monitor to display the following:
each node:
WWW
• Latency
Current status information is displayed.
• Throughput
• Gateway  Displays the IP address of the service
• “WAN” on page 40 provider’s gateway.
• “LAN” on page 40 • DNS  Displays the IP addresses of the Domain Name
• “WLAN” on page 41 System (DNS) servers.
• IP  Displays the Internet IP address of the UniFi Security
Latency Gateway.
The latency value from the latest Speed Test is displayed. • Uptime  Displays the length of time the Internet
The monitor is color-coded to indicate status: connection has been active.
Black  A UniFi Security Gateway is active, and the Speed • Latency  Displays the amount of time it takes a packet
Test is available. to travel from the UniFi Security Gateway to the service
Red  The Speed Test is not available because it requires an provider’s gateway.
active UniFi Security Gateway. • Up  Displays the upload rate of your Internet
Throughput connection.

The throughput value from the latest Speed Test is • Down  Displays the download rate of your Internet
displayed. The monitor is color-coded to indicate status: connection.

Black  A UniFi Security Gateway is active, and the Speed
Test is available.

Ubiquiti Networks, Inc. 39

Chapter 4: Dashboard UniFi Controller User Guide

Speed Test WAN
Results from the latest Speed Test are displayed. The basic details of the UniFi Security Gateway are
• Last Run  Displays the duration of time since the last displayed.
Speed Test.
• Latency  Displays the amount of time it takes a packet
to travel from the UniFi Security Gateway to the service
provider’s gateway.
• Up  Displays the upload speed.
• Down  Displays the download speed.
The monitor is color-coded to indicate status:
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:
• LAN IP  Displays the local IP address of the UniFi
Security Gateway.
Speed Test  Click the monitor to run the Speed Test.
• Clients  Displays the total number of local clients.
• Up  Displays the upload rate of your Internet
connection.
• Down  Displays the download rate of your Internet
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.

The monitor is color-coded to indicate status:
Green The wired network is active.
• Run Speed Test  Click to run the test again. Red The wired network is inactive.
• Close  Click to exit the Speed Test. Active Devices Displays the number of wired devices
adopted and active.
Inactive Displays the number of wired devices adopted
but not active.

40 Ubiquiti Networks, Inc.

UniFi Controller User Guide Chapter 4: Dashboard

Pending  Displays the number of wired devices pending
adoption.
Status information  Place your mouse over the monitor
to display the following:
• Gateway  Displays the Internet IP address of the UniFi
Security Gateway.
• Users  Displays the number of clients connected to the
wired network. Download Throughput & Latency
• Guests  Displays the number of clients connected to the The historical chart displays the download traffic in terms
guest wired network. of throughput and latency over a 24-hour period.
• Switches  Displays the number of UniFi Switches
Note: A UniFi Security Gateway must be active to
managed on this site.
enable this chart.
• Down  Displays the download rate of the wired
network(s).
• 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.
Status information  Place your mouse over a specific
point to display the following about a date and time:
WLAN • Avg/Max Throughput  Displays the average and
The basic details of the wireless network(s) are displayed. 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.
The monitor is color-coded to indicate status:
Green The wireless network is active.
Red The wireless network is inactive.
Active Devices Displays the number of APs adopted and
active.
Inactive Displays the number of APs adopted but not
Avg/Max Throughput  Average throughput is displayed
active.
as a dark gray bar. Maximum throughput is displayed as a
Pending Displays the number of APs pending adoption. light gray bar.
Status information Place your mouse over the monitor Latency  Latency is displayed as a blue line.
to display the following:
Status information  Place your mouse over a specific
• Users  Displays the number of clients connected to the point to display the following about a date and time:
primary wireless network(s).
• Avg/Max Throughput  Displays the average and
• Guests  Displays the number of clients connected to the maximum throughput values.
guest wireless network(s).
• Latency  Displays the latency value.
• APs  Displays the number of APs managed on this site.
• Down  Displays the download rate of the wireless
network(s).
• Up  Displays the upload rate of the wireless network(s).

Ubiquiti Networks, Inc. 41

4 GHz Channel Occupancy Chart displays the Status information  Place your mouse over a specific channel use of the 2. (Various)  Displays the number of clients that belong in each of the remaining client categories. Status information  Place your mouse over a specific client category to display the client category name. Inc. LAN  Displays the number of wired devices. color‑coded breakdown of the device types. Devices on 5 GHz Channel The 5 GHz Channel Occupancy Chart displays the channel Traffic  Displays the total number devices and a use of the 5 GHz devices. Devices • DPI must enabled on the Settings > Site screen. • A UniFi Security Gateway must be active to enable this feature. Ubiquiti’s proprietary DPI engine includes (Channels)  Each device is displayed as a blue square in its the latest application identification signatures to track channel. which applications (and IP addresses) are using the most bandwidth. Ubiquiti  Displays the number of Ubiquiti clients. color‑coded breakdown of the device types. Streaming Media  Displays the amount of data that is WAN  Displays the number of gateway devices. Note: The DPI feature must be enabled to display client information. Clients Network clients are displayed. Other  Displays the number of clients that don’t belong in the aforementioned categories. 1-11  Each device is displayed as a blue square in its channel.4 GHz UniFi AP must be active to enable this chart. device category to display the device models and their quantities. See UniFi devices are displayed. Note: At least one 2.4 GHz devices. Deep Packet Inspection Deep Packet Inspection (DPI) is more advanced than conventional Stateful Packet Inspection (SPI) filtering for traffic analysis. “Settings > Site” on page 20 for more information. identified as streaming media. . Status information  Place your mouse over a specific channel to display the number of devices using that The DPI feature requires the following: channel. Traffic  Displays the total amount of traffic and a color- Traffic  Displays the total number devices and a coded breakdown of the traffic types. Status information  Place your mouse over a specific channel to display the number of devices using that channel. Note: At least one 5 GHz UniFi AP must be active to enable this chart. The 2.Chapter 4: Dashboard UniFi Controller User Guide Devices on 2.4 GHz Channel WLAN  Displays the number of wireless devices. 42 Ubiquiti Networks.

Unknown  Displays the amount of data that is unidentified.0  Displays the amount of data that is identified as web-related traffic. Web / Web 2. Inc.UniFi Controller User Guide Chapter 4: Dashboard Network Protocols  Displays the amount of data that is identified as network protocol traffic. Status information  Place your mouse over a specific traffic category to display the traffic category name and amount of data. Other  Displays the amount of data that doesn’t belong in the aforementioned categories. 43 . Security Update  Displays the amount of data that is identified as part of a security update. Ubiquiti Networks.

Chapter 4: Dashboard UniFi Controller User Guide 44 Ubiquiti Networks. Inc. .

png file format. you can upload it to the UniFi Controller software: 1. . The legend at the bottom of the map 3. 45 . a default map is displayed. The default is Google Maps. shows the scale of the map. When you initially launch the UniFi Controller application. Inc. Click Upload Image. 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. Adding Custom Maps To add a custom map. or . you must first create the image using an illustration. Click Add a Map. image editing.jpg. Once you’ve created the map.gif. Click .UniFi Controller User Guide Chapter 5: Map Chapter 5: Map 2. or blueprint application that exports a file in . Ubiquiti Networks.

Click Terrain to display geographic markers. 6. . . Adding a Google Map To add a Google Map to the UniFi Controller software Map view: 1. 46 Ubiquiti Networks. which looks like a street map. Click Add a Map. Inc. In the field provided. Click Done.Chapter 5: Map UniFi Controller User Guide 4. Locate the file to use as a map (valid file formats are . If you do not want to upload a file. 5.jpg. Click . and . 3. map and try again. 7. click Select a different or Return. Then press Enter Note: If the map is incorrect.gif.png) and then click Open. Click Choose map image. 2. click Cancel. Enter a map name in the field provided and click Save. enter an address or the latitude and longitude of a specific location. Use the tools to navigate the map or adjust the zoom using the zoom control. The default view is Map view.

Click at the lower right. UAP‑AC‑LR. Click Done. A disconnected icon also marks the device icon. • Blue/Green  Indicates the device is connected.UniFi Controller User Guide Chapter 5: Map You can also click Satellite for a bird’s-eye view. • Red/Orange  Indicates the device is disconnected. UAP‑AC‑PRO. Click the UniFi icon again to hide them. UniFi Security Gateway You can adjust UniFi Security Gateway Pro 4. The device icon indicates the UniFi model (not all icons are shown below): UniFi AP Pro. Lock  Lock the device icon to its current location. go to “RF Environment” on page 98. 47 . Drag each device icon from the Unplaced Devices list to the appropriate location on the map. Details  Display the Details screen. Inc. UniFi VoIP Phone/Pro 2. For more information. Click Status Labels to display street and location names. UniFi VoIP Phone Executive The LED color of the icon indicates the device status. go to the appropriate chapter: The device icon will appear in the area that you placed it. UniFi 24-Port Switch Placing Devices on the Map UniFi 48-Port Switch 1. and UAP‑AC‑EDU only. • “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 Statistics  (Available for the UAP‑AC‑LITE. 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. Device Options Click a UniFi icon to reveal options. Ubiquiti Networks.) Displays the RF Environment screen. For more information. Remove  Remove the device icon from its location.

The default is -90 dBm. Inc. select which map you want to view using this option. To change a name applied to a device. You can apply one of the following filters: • 2G Coverage  Displays the coverage by 2. transmit/receive channel(s). Each device is displayed with its name. even if the wirelessly connected AP is isolated. number of users (Map)  If multiple maps have been uploaded. You can apply one of the following filters: • 2G Devices  Displays the 2.__ dBm  You can change the receiver sensitivity value for more accurate coverage results. 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 Topology  Displays a visual representation of the network • Coverage configuration and connections between any APs. A • Topology dashed line will indicate the wirelessly connected AP and its uplink to a wired AP. 48 Ubiquiti Networks. the device’s MAC address will be displayed. If no custom label is applied.4 GHz devices.Chapter 5: Map UniFi Controller User Guide Map Display Options Details  Displays the applicable information: MAC address. you can connected. and number of guests connected. • 5G Coverage  Displays the coverage by 5 GHz devices. Coverage  Displays a visual representation of the wireless range covered by any APs. . • 5G Devices  Displays the 5 GHz devices. -.4 GHz devices.

2. Inc. Click and hold to draw a line in the area that you want to use to set the scale of the map. The left side of the map offers the following options: Zoom Slider  Use to zoom the map detail in and out. Enter the distance that the line represents in the Distance field. Setting the Map Scale 1.UniFi Controller User Guide Chapter 5: Map Configure Maps  Click to add maps or edit the current map(s). Click Set Scale. If you need to redraw the line. 49 . just click and hold again to draw a new line. Ubiquiti Networks. Click the set map scale button. the distance is specified in meters but you can switch to feet using the drop-down menu on the right. Set Map Scale  Use this option to define the scale of the map. Unplaced Devices  Drag each device icon from the Unplaced Devices list to the appropriate location on the map. The legend at the bottom of the map shows the new scale of the map. You will draw a line and define the distance that the line represents. 3. By default.

.Chapter 5: Map UniFi Controller User Guide 50 Ubiquiti Networks. Inc.

then the primary filter no longer changes the columns. • All  Displays all UniFi devices. • Any device that is pending • Performance  Displays the number of 2. there is no need to press Enter. Gateway/Switches. overall receive rate. and • Connected Phone channel setting. Inc. discovered by the UniFi Controller. amount of data uploaded. or Phones applies a default set of columns to display. • Gateway/Switches  Displays all UniFi Security Gateways and Switches. • Connected Gateway • Phones  Displays all UniFi VoIP Phones. channel setting. The selected column displays or to indicate ascending or descending order. amount of data downloaded. If you enable the Customize Columns option.UniFi Controller User Guide Chapter 6: Devices Chapter 6: Devices If there is more than one page of entries to display. or 200. 50. and for connected devices it also sorts by device type. for. then another filter is available: • Connected AP • Overview  Displays the number of clients. The icon column sorts by state. click the navigation controls or page numbers at the bottom The Devices screen displays a list of UniFi devices right of the screen to display different pages. You can apply one of the following primary filters: (sort)  You can click any column to sort the displayed list. APs. 51 .4 GHz and 5 GHz radio bands. per page: 10.4 GHz and 5 GHz radio bands. You can click any of the Search   Enter the text you want to search column headers to change the list order. Ubiquiti Networks. 100. • Any device that is being upgraded or provisioned • Config  Displays the WLAN and radio settings for the • Any device that is being adopted or is restarting 2. Items per page  Select how many results are displayed Customize Columns  Each primary filter: All. After this sorting is applied. This is the order: • APs  Displays all UniFi APs. Simply begin typing. the sort order uses transmit rates in the 2. overall transmit rate.4 GHz and • Any device that is disconnected or in an error state 5 GHz clients. and alphabetical order according to the device name. • Connected Switch If the APs filter is applied.

and Channel columns are displayed. Status.AP Overview  The Device Name. 4. or Phones you select. option. This resets the columns but UniFi AP AC the UniFi Controller software will not remember your UniFi AP AC Outdoor selection. and Channel columns are UniFi 24-Port Switch displayed. Radio5G. MAC Address. and Channel columns are currently visible and remember your columns are displayed. The option you select will apply UniFi AP/AP LR no matter which primary filter: All. Select Customize columns. Clients. IP Address. UniFi Security Gateway Status. Status. Clients. UniFi Security Gateway Pro -. 5G 2. UniFi AP Outdoor+ -. and Up columns are displayed. WLAN2G. APs. Model. 3. TX. selection. (icon)  Displays the icon corresponding to the UniFi device (not all icons are shown below): UniFi AP Pro. Inc.. Up. UniFi VoIP Phone Executive 52 Ubiquiti Networks. WLAN5G. Uptime. . Gateway/Switches.Gateway/Switches  The Device Name. Down. options. Model. TX 5G. All All UniFi device types are displayed. Click to customize the columns used for display. Status. Down. Apply the Gateway/Switches filter.AP Config  The Device Name. Down. 5. TX 2G. TX 5G..Default  The Device Name. UniFi AP Outdoor5 -. Enable the Customize Columns option on the APs > Address. 2G Clients.All columns  The Device Name. Enable the Customize Columns option again. Version. the UniFi Controller software will detect which 2G Clients. Radio2G. Version. RX. Version. Performance screen. Radio2G. TX 2G. and Radio5G columns are UniFi VoIP Phone/Pro displayed. Status. For example: -. WLAN2G. Clients. Status. 5G Clients. IP 1. The columns of the APs > Performance screen will be displayed. IP Address. RX.AP Performance  The Device Name. IP Address. Disable customization. WLAN5G. UniFi AP AC EDU • Reset columns to  Click the drop-down at the bottom of the Customize columns screen to display the Reset UniFi AP In-Wall columns to .Chapter 6: Devices UniFi Controller User Guide The very first time you enable the Customize Columns -. UniFi AP AC Lite/LR/Pro You can select additional columns for display. and Uptime columns are displayed. TX. UniFi 48-Port Switch -. IP Address. Model. Model.

(The icon on the Map tab IP Address  Displays the IP address used by the UniFi will flash three times and stop. or MAC been running. 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 IP Address  Displays the IP address used by the UniFi (icon)  Displays the icon corresponding to the UniFi device device. Pending Approval. Adopting. for more information. For more information. Ubiquiti Networks. Other). then click to ring the Status  Indicates the device status: Connected. page 2. The Status will appear as Down  Displays the total amount of data downloaded by Adopting until the device is connected. or can locate it. the UniFi device. UniFi Security Gateway Disconnected. UniFi 48-Port Switch Note: The super admin account was created during The LED color of the device icon indicates the device the initial installation. (The icon on the Map tab will flash three times and stop. see status. • Red/Orange  Indicates the device is disconnected or not managed by this site (Pending Approval or Managed by Other). the LED color of the device icon indicates the Gateway/Switches device status. Model  Displays the model name of the UniFi device. address of the UniFi device. The LED will flash until the • “UniFi Switch Details” on page 85 Locate button is clicked again. The Phone will ring until you click Locate Managed by Other. • Red  Indicates the device is disconnected or not Version  Displays the version number of the UniFi device’s managed by this site (Pending Approval or Managed by firmware. see the process is complete and the device reconnects to “Configuring the UniFi Controller Software” on the UniFi Controller software. click to flash the LED on the physical device and the device’s icon on the • “UniFi Security Gateway Details” on page 77 Map tab so you can locate it. or Isolated (APs only). • Gray  Indicates the device is pending approval. or MAC address of the UniFi device. Device Name  Displays the hostname. • Gray  Indicates the device is pending approval. Upgrading. Adopting. (not all icons are shown below): Status  Indicates the device status: Connected.) Only the super admin – not any site admin – can view devices that are Pending Approval and then adopt them on • Restart  Click to restart the selected device. • Adopt  Click to adopt a device that appears as Pending Approval for its status.) device. UniFi Security Gateway Pro Only the super admin – not any site admin – can view UniFi 24-Port Switch devices that are Pending Approval and then adopt them on the UniFi Controller. Upgrading. • Blue/Green  Indicates the device is connected. 53 . page 2. Uptime  Displays the duration of time the UniFi device has Device Name  Displays the hostname. If the device is a Phone. All UniFi Gateway and Switch devices are displayed. see the appropriate chapter: • Locate  For most devices. For more information. “Configuring the UniFi Controller Software” on • Blue  Indicates the device is connected. The Status will appear as Upgrading until the initial installation.UniFi Controller User Guide Chapter 6: Devices If displayed. alias. Managed by Other. • Upgrade  If a software upgrade is available for the device. Pending Approval. You can click the name to get additional details. alias. Phone and flash the Phone’s icon on the Map tab so you Disconnected. again. click to install the latest UniFi firmware Note: The super admin account was created during on the device. Model  Displays the model name of the UniFi device. You can click the name to Actions  Click a button to perform the desired action: get additional details. Inc. for more information. the UniFi Controller.

• Managed by Other  The AP is not in the default state Overview but it is not controlled by the UniFi Controller. which are intentionally excluded • Isolated  A managed AP is unable to locate its uplink. Down  Displays the total amount of data downloaded by the AP.) Click START ROLLING UPGRADE to begin • Disconnected  The AP is unreachable by the UniFi automatically upgrading APs. The LED color of the icon indicates the device status. . alias.) UniFi AP/AP LR • Restart  Click to restart the selected device. UniFi AP AC • Upgrade  If a software upgrade is available for the UniFi AP AC Outdoor device. • Gray  Indicates the device is pending approval. (not all icons are shown below): Actions  Click a button to perform the desired action: UniFi AP Pro. clients. Status  Displays the connection status. and details. Inc. • Connected (wireless)  The AP is wirelessly uplinked to a Start Rolling Upgrade  (Available if any AP has an physically wired AP. you can initiate a rolling upgrade of the network at 100 Mbps in full-duplex mode.4 and 5 GHz IP Address  Displays the IP address of the AP. • Connected (100 FDX)  The AP is physically wired to the On any sub-tab. Only the super admin – not any site admin – can view devices that are Pending Approval and then adopt them on the UniFi Controller. • Config  Displays the WLAN and radio settings for the • Connected  The AP is physically wired to the network. upgrade available. click to install the latest UniFi firmware on the device. The LED will flash until the Locate button is UniFi AP In-Wall clicked again. from upgrading. amount of data uploaded. wirelessly uplinked APs. 2. firmware for all APs. amount address of the AP. different status information: Device Name  Displays the hostname. 2. except for Controller software. overall transmit rate. for more information. overall receive rate. Clients  Displays the number of clients connected to the AP. • Performance  Displays the number of 2. one by one. The Status will appear as • Blue/Green  Indicates the device is connected. see “Configuring the UniFi Controller Software” on page 2.Chapter 6: Devices UniFi Controller User Guide Up  Displays the total amount of data uploaded by (icon)  Displays the icon corresponding to the AP model the UniFi device. for more information. APs • Red/Orange  Indicates the device is disconnected or not managed by this site (Pending Approval or Managed You can apply one of the following filters to display by Other).4 GHz and 5 GHz radio bands. • Pending Approval  The AP is in the default state and is available for adoption. or MAC • Overview  Displays the number of clients. see “UniFi Access Point Details” on page 95 channel setting. and channel setting. Model  Displays the model name of the UniFi device. 54 Ubiquiti Networks. Adopting until the device is connected.4 and 5 GHz transmit rates. UniFi AP AC Lite/LR/Pro • Locate  Click to flash the Status LED on the Gateway/Switch and its icon on the Map tab so you can UniFi AP AC EDU locate it. (The icon on the Map tab will flash three times and stop. Note: The super admin account was created during the initial installation. The Status will appear as Upgrading until UniFi AP Outdoor+ the process is complete and the device reconnects to UniFi AP Outdoor5 the UniFi Controller software. You can click the name to get additional of data downloaded. • Adopt  Click to adopt a device that appears as Pending Approval for its status.

The Status will appear as Upgrading until Controller software. for more information. • Pending Approval  The AP is in the default state and is available for adoption. Note: The super admin account was created during the initial installation. alias. Packets sent Packets retried • Gray  Indicates the device is pending approval. Actions  Click a button to perform the desired action: IP Address  Displays the IP address of the AP. The radio band is represented as (ng) for details. The different colors represent different types of UniFi AP Pro. (The • Connected (100 FDX)  The AP is physically wired to the icon on the Map tab will flash three times and stop. device. (not all icons are shown below): TX 2G  Displays the overall TX rate for the 2. for more information. Packets not sent due to likely interference • Red/Orange  Indicates the device is disconnected or not managed by this site (Pending Approval or Managed by Other). will flash until the Locate button is clicked again. • Isolated  A managed AP is unable to locate its uplink. • Connected (wireless)  The AP is wirelessly uplinked to a • Upgrade  If a software upgrade is available for the physically wired AP. 5G Clients  Displays the number of clients connected to the AP using the 5 GHz band. 2G Clients  Displays the number of clients connected to the AP using the 2.4 GHz band. Color Packet Activity • Blue/Green  Indicates the device is connected. Adopting until the device is connected. the process is complete and the device reconnects to the UniFi Controller software. • Adopt  Click to adopt a device that appears as • Managed by Other  The AP is not in the default state Pending Approval for its status.4 GHz radio band. Ubiquiti Networks. Performance Only the super admin – not any site admin – can view devices that are Pending Approval and then adopt them on the UniFi Controller. The LED • Connected  The AP is physically wired to the network. • Restart  Click to restart the selected device. 55 . The different colors represent different types of packet activity: UniFi AP Outdoor5 The LED color of the icon indicates the device status.4 GHz and (na)/(ac) for 5 GHz. • Locate  Click to flash the LED on the AP and the Status  Displays the connection status. The Status will appear as but it is not controlled by the UniFi Controller. or MAC Channel  Displays the transmit/receive channel being address of the AP. (icon)  Displays the icon corresponding to the AP model RX  Displays the overall RX (receive) rate. Device Name  Displays the hostname. UniFi AP AC Lite/LR/Pro packet activity: UniFi AP AC EDU Color Packet Activity UniFi AP In-Wall Packets sent UniFi AP/AP LR Packets retried UniFi AP AC Packets not sent due to likely interference UniFi AP AC Outdoor TX 5G  Displays the overall TX rate for the 5 GHz radio UniFi AP Outdoor+ band. Inc. see “UniFi Access Point Details” on page 95 2. AP’s icon on the Map tab so you can locate it.) network at 100 Mbps in full-duplex mode. You can click the name to get additional used by the AP. see “Configuring the UniFi Controller Software” on page 2. TX  Displays the overall TX (transmit) rate.UniFi Controller User Guide Chapter 6: Devices Up  Displays the total amount of data uploaded by the AP. click to install the latest UniFi firmware • Disconnected  The AP is unreachable by the UniFi on the device.

click to install the latest UniFi firmware on the device. The LED UniFi AP AC will flash until the Locate button is clicked again. • Pending Approval  The AP is in the default state and is available for adoption. by Other). • Connected (wireless)  The AP is wirelessly uplinked to a • Upgrade  If a software upgrade is available for the physically wired AP. • Adopt  Click to adopt a device that appears as • Managed by Other  The AP is not in the default state Pending Approval for its status. • Restart  Click to restart the selected device. or MAC used by the AP. alias. (The • Connected (100 FDX)  The AP is physically wired to the icon on the Map tab will flash three times and stop. • Adopt  Click to adopt a device that appears as • Red/Orange  Indicates the device is disconnected or Pending Approval for its status. the process is complete and the device reconnects to • Blue/Green  Indicates the device is connected. see “Configuring the UniFi Controller Software” on page 2. details. The Status will appear as Upgrading until The LED color of the icon indicates the device status. • Isolated  A managed AP is unable to locate its uplink. (icon)  Displays the icon corresponding to the AP model (not all icons are shown below): Radio 2G  Displays the channel and TX power settings used in the 2. The LED • Connected  The AP is physically wired to the network. The radio band is represented as (ng) for address of the AP. 56 Ubiquiti Networks. The Status will appear as Upgrading until Controller software. Inc. UniFi AP Outdoor+ • Upgrade  If a software upgrade is available for the UniFi AP Outdoor5 device. • Locate  Click to flash the LED on the AP and the Status  Displays the connection status. UniFi AP AC Lite/LR/Pro Radio 5G  Displays the channel and TX power settings UniFi AP AC EDU used in the 5 GHz radio band.4 GHz radio band.) network at 100 Mbps in full-duplex mode. Note: The super admin account was created during the initial installation. device.) UniFi AP AC Outdoor • Restart  Click to restart the selected device. You can click the name to get additional 2. Actions  Click a button to perform the desired action: UniFi AP In-Wall • Locate  Click to flash the LED on the AP and the UniFi AP/AP LR AP’s icon on the Map tab so you can locate it. Version  Displays the version number of the UniFi AP’s firmware. WLAN 2G  Displays the name of the WLAN group using the 2. the process is complete and the device reconnects to the UniFi Controller software. click to install the latest UniFi firmware • Disconnected  The AP is unreachable by the UniFi on the device. The Status will appear as not managed by this site (Pending Approval or Managed Adopting until the device is connected.4 GHz radio band.Chapter 6: Devices UniFi Controller User Guide Channel  Displays the transmit/receive channel being Device Name  Displays the hostname. Config Only the super admin – not any site admin – can view devices that are Pending Approval and then adopt them on the UniFi Controller. see “UniFi Access Point Details” on page 95 Actions  Click a button to perform the desired action: for more information. will flash until the Locate button is clicked again. • Gray  Indicates the device is pending approval.4 GHz and (na)/(ac) for 5 GHz. . (The icon on the Map tab will flash three times and stop. Adopting until the device is connected. WLAN 5G  Displays the name of the WLAN group using the 5 GHz radio band. UniFi AP Pro. for more information. AP’s icon on the Map tab so you can locate it. the UniFi Controller software. The Status will appear as but it is not controlled by the UniFi Controller.

IP Address  Displays the IP address used by the Phone. You can click the name to get additional details. Inc. Version  Displays the version number of the Phone’s firmware. Model  Displays the model name of the Phone.) • Restart  Click to restart the selected device. Uptime  Displays the duration of time the Phone has been running. alias. Phones.UniFi Controller User Guide Chapter 6: Devices Phones • Adopt  Click to adopt a device that appears as Pending Approval for its status. Pending Approval. Actions  Click a button to perform the desired action: • Locate  Click to ring the Phone and flash the Phone’s icon on the Map tab so you can locate it. Disconnected.com/unifi (icon)  Displays the icon corresponding to the Phone (not all icons are shown below): UniFi VoIP Phone/Pro UniFi VoIP Phone Executive Device Name  Displays the hostname. The Status will appear as Important: For management of the UniFi VoIP Adopting until the device is connected. click to install the latest UniFi firmware on the device. Adopting. or MAC address of the Phone. Note: The super admin account was created during the initial installation. The Phone will ring until you click Locate again. • Upgrade  If a software upgrade is available for the device.ubnt. see “Configuring the UniFi Controller Software” on page 2. The Status will appear as Upgrading until the process is complete and the device reconnects to the UniFi Controller software. Only the super admin – not any site admin – can view devices that are Pending Approval and then adopt them on the UniFi Controller. Ubiquiti Networks. for more information. 57 . or Managed by Other. Status  Indicates the device status: Connected. (The icon on the Map tab will flash three times and stop. please download the UniFi VoIP Controller here: downloads. Upgrading. see “UniFi VoIP Phone Details” on page 107 for more information.

.Chapter 6: Devices UniFi Controller User Guide 58 Ubiquiti Networks. Inc.

If you Items per page  Select how many results are displayed enable the Customize Columns option. • Users  Only displays users. regardless of connection type. alphabetical order according to the client name. Wireless. click the navigation controls or page numbers at the bottom right of the screen to display different pages. or 200. The icon column sorts by state. Wired applies a default set of columns to display.UniFi Controller User Guide Chapter 7: Clients Chapter 7: Clients (sort)  You can click any column to sort the displayed list. then the primary per page: 10. • Connected wired guest A secondary filter is available: After this sorting is applied. Simply begin typing. Wireless. Inc. You can click any of the column headers to change the list order. Customize Columns  Each primary filter: All. If there is more than one page of entries to display. 59 . primary filter (All. This is the order: You can apply one of the following primary filters: • Connected wireless user • All  Displays all clients. • Connected wired user • Wired  Displays all wired clients. there is no need to press Enter. • Connected wireless guest • Wireless  Displays all wireless clients. and for connected devices it also sorts by device type. or • Guests  Only displays guests. Ubiquiti Networks. The selected column displays or to indicate ascending or descending order. Search   Enter the text you want to search for. 50. Select Customize columns. or Wired) is applied. 100. filter no longer changes the columns. The Clients screen displays a list of network clients. The columns of information vary depending on which Click to customize the columns used for display. the sort order uses • All  Displays all users and guests.

displays the name of the network device and port number used by the client. You can click RECONNECT to kick out a client. • 802. client. • Up  Displays the total amount of data uploaded by the client. alias. You can Uptime  Displays the amount of time the client has been click the name to get additional details. If • 802. refer to “UniFi connected for this session. Up  Displays the total amount of data uploaded by the client. alias. Click UNBLOCK to unblock this client. Displays a leaf • Reconnect  Click RECONNECT to reconnect a wireless icon if the device uses power save mode. or click AUTHORIZE for guests pending authorization.1x VLAN  Displays the VLAN (Virtual Local Area the connection is wireless. displays the name of the Down  Displays the total amount of data downloaded by connected AP or port. All You can select additional columns for display. Activity  Displays the relative level of activity for each • Network  Indicates which local network is used.1x authentication.Chapter 7: Clients UniFi Controller User Guide • Signal  Displays the signal strength level and signal type: • TX Rate  Displays the overall TX (transmit) rate. • 11ng (2. • AP/Port  For wireless clients. • Block  Click BLOCK to block this client from accessing • PHY Mode  Displays the wireless standard and the network. Switch Details” on page 85 for more information. client. • Uptime  Displays the amount of time the client has been connected for this session. wired user • Hostname  Displays the hostname of the connected wired guest client.4 GHz) • Unauthorize/Authorize  (Available for Guests only. this is useful for troubleshooting or resolving a problematic wireless • 11ac (5 GHz) connection. refer to “Client Details” on page 109 for more • IP Address  Displays the IP address used by the client. frequency band used by the signal. Inc. Actions  Click a button to perform the desired action: • Channel  Displays the channel used. authentication. You can click the name to get the client. For wired clients.) • 11b (2. You can click the name to get additional details. • Down  Displays the total amount of data downloaded by the client. refer to “UniFi Access Point Details” on page 95 for more information. 60 Ubiquiti Networks. additional details. • Activity  Displays the relative level of activity for each client. information. • RX Rate  Displays the overall RX (receive) rate. or MAC address of the connected client.1x IP Address  Displays the IP address used by the client. network name or SSID. • 11na (5 GHz) which usually reconnects back quickly. Pending for guests pending authorization. • Status  Displays Authorized for all authorized guests or AP/Port  Indicates which AP or switch port is used.4 GHz) Click UNAUTHORIZE to remove authorization of guest access and disconnect the guest. then this displays the wireless Network) used for 802. . refer to “Chapter 7: Clients” on page wireless guest 59 for more information. connected client. Connection  Indicates which local network is used. or MAC address wireless user of the connected client. You can click the name to get additional details. Options (icon)  Displays the icon corresponding to a wireless or include the following: wired client: • Name  Displays the hostname. • MAC Address  Displays the MAC address of the Name  Displays the hostname.1x Identity  Displays the identity used for 802.

You • (name)  Select the network whose clients you want can click the name to get additional details. • Reconnect  Click RECONNECT to reconnect a wireless client. wired user Phy Mode  Displays the wireless standard and frequency wired guest band used by the signal. pending authorization. AP/Port  Displays the name of the connected AP. Status  (Displayed when the Guests filter is applied. or MAC address of the connected client. Frequency band  If the Wireless filter is applied. “UniFi Access Point Details” on page 95 for more (icon)  Displays the icon corresponding to a wired client: information. Click UNBLOCK to unblock this client. Ubiquiti Networks. • All  Displays all wired clients. or MAC address of the connected client. You can click the name to client. refer to “UniFi Switch Details” on page 85 for more information. alias. Uptime  Displays the amount of time the client has been connected for this session. or click AUTHORIZE for guests • 2G  Only displays 2. • 11b (2. which usually reconnects back quickly. IP Address  Displays the IP address used by the client. alias. • 11ng (2. then the Network Displays Authorized for all authorized guests or Pending for filter is available. refer to “Client Details” on page 109 for more • 11ac (5 GHz) information.UniFi Controller User Guide Chapter 7: Clients Wireless Down  Displays the total amount of data downloaded by the client. refer to displayed. get additional details.4 GHz) IP Address  Displays the IP address used by the client. (icon)  Displays the icon corresponding to a wireless client: wireless user wireless guest Name  Displays the hostname.) Network  If the Wired filter is applied. WLAN  Displays the name of the wireless network. 61 . Up  Displays the total amount of data uploaded by the client. • 5G  Only displays 5 GHz clients. Name  Displays the hostname. Wired AP  Select the AP whose clients you want displayed. Signal  Displays the signal strength level and signal type: AP/Port  Displays the name of the network device and Activity  Displays the relative level of activity for each port number used by the client. then the Frequency band filter is available: • Unauthorize/Authorize  (Available for Guests only. Inc. this is useful for troubleshooting or resolving a problematic wireless connection. Each option in the drop-down list also indicates the number of wireless clients in parentheses. refer to “Client Details” on page 109 for more information. and disconnect the guest. You can click the name to get additional • 11na (5 GHz) details.4 GHz) Network  Indicates which local network is used. indicates the number of wired clients in parentheses.) Click UNAUTHORIZE to remove authorization of guest access • All  Displays all wireless clients. You can click RECONNECT to kick out a client. Channel  Displays the channel used. You can click the name to get additional details. Displays a leaf icon if the device uses power save mode. Actions  Click a button to perform the desired action: • Block  Click BLOCK to block this client from accessing the network.4 GHz clients. Each option in the drop-down list also guests pending authorization.

Uptime  Displays the amount of time the client has been connected for this session. Up  Displays the total amount of data uploaded by the client.Chapter 7: Clients UniFi Controller User Guide Activity  Displays the relative level of activity for each client. Click UNBLOCK to unblock this client. • Unauthorize/Authorize  (Available for Guests only. Down  Displays the total amount of data downloaded by the client.) Click UNAUTHORIZE to remove authorization of guest access and disconnect the guest. Inc. or click AUTHORIZE for guests pending authorization. 62 Ubiquiti Networks. Actions  Click a button to perform the desired action: • Block  Click BLOCK to block this client from accessing the network. .

UniFi Controller User Guide Chapter 8: Statistics Chapter 8: Statistics Overview The Overview screen describes the usage by wireless The Statistics screen provides a visual representation clients and UniFi Access Points. • Traffic Stats  (Available if you have a UniFi Security Gateway with the DPI feature enabled. 24 Hours  The default view. 63 . Ubiquiti Networks. of the clients and network traffic connected to your managed UniFi network. Inc.) The Traffic Stats screen describes the network traffic by application usage. Select Week or Month to change the duration interval. Please refer to the next column for more information. Date  Click either arrow to change the date in one-day increments. There are two views available: • Overview  The default view describes the wireless clients and network traffic. Go to “Traffic Stats” on page 65 for more information.

Inc. The Filter drop-down list displays managed UniFi APs by name or MAC address. increments. Place the mouse cursor over the chart for the number of clients per network. Clients (Total) You can place your mouse over an hour or day to display # of Clients  A visual pie chart represents the client the number of clients and amount of data. Filter  You can view the number of clients and amount of traffic by UniFi AP. Quick Look 64 Ubiquiti Networks. Click to view the drop-down list.Chapter 8: Statistics UniFi Controller User Guide Click the date to display the calendar. For example. Clear Current Stats  Reset the current statistics to A second graph that is color-coded to the selected AP start over. You can select multiple APs for filtering. Then click the appropriate AP. A third graph that is color-coded to the additional AP Click either arrow to change the calendar in one-month appears. . if you select a second AP: • Calendar  Click a specific date to display its statistics. appears. distribution amongst the APs.

connected. Download  Displays the total amount of data downloaded by the AP. Traffic Stats Upload  Displays the total amount of data uploaded by (Available if you have a UniFi Security Gateway with the the client. Go to “Settings > Site” on page 20 for more information. See “Client Details” on page 109 cursor over an hour or day to display the specific amount for additional information. Upload  Displays the total amount of data uploaded by the AP. Place the mouse Client Details screen. Traffic  A pie chart represents traffic on the most active Amount of Traffic  A pie chart represents the traffic Access Points. Current Usage: Top Access Points The details of the most active Access Points in current use are displayed. 65 . and Network Protocols. Clients  In the graph. Ubiquiti’s proprietary DPI engine includes for additional information. mouse cursor over the chart for the amount of traffic per category. a dashed line displays the number of clients connected during the selected time period. Place the the amount of traffic per specified AP. DPI feature enabled.) The Traffic Stats screen All-Time Top Client describes the network traffic by application usage. Ubiquiti Networks. The total amount of traffic is broken down by category. # of Clients  A pie chart represents the client distribution on the most active Access Points. Place Most Active Client the mouse cursor over an hour or day to display the exact The details of the most active client in current use are number. Place the mouse cursor over the chart for the number of clients per specified AP. displayed: Traffic  In the graph. Download  Displays the total amount of data downloaded by the client. See “Client Details” on page 109 traffic analysis. Name or MAC address  You can click this link to open the AP Details screen. Upload  Displays the total amount of data uploaded by the client. a solid line displays the network Name or MAC address  You can click this link to open the traffic during the selected time period. the latest application identification signatures to track which applications (and IP addresses) are using the most Uptime  Displays the duration of time the client has been bandwidth. Place the mouse cursor over the chart for distribution by the most popular categories. Inc. most active client are displayed: Deep Packet Inspection (DPI) is more advanced than Name or MAC address  You can click this link to open the conventional Stateful Packet Inspection (SPI) filtering for Client Details screen. Overall Traffic Applications are organized by category. The details of the all-time. of data.0. Download  Displays the total amount of data downloaded by the client. See “UniFi Access Point Details” on page 95 for additional information. Web / Web 2.UniFi Controller User Guide Chapter 8: Statistics Most Active AP Recent Activities The details of the most active Access Point are displayed: The details of recent network activities are displayed. such as Streaming Media.

A list displays a comprehensive breakdown of the traffic by application. there is no need to with a detailed breakdown of the application usage within press Enter. Add Category To add a new category for display. Select a category. 3. Click Save. . Amount of Traffic  A pie chart represents the traffic distribution by the most popular applications. 66 Ubiquiti Networks. that category. simply begin typing.Chapter 8: Statistics UniFi Controller User Guide A list displays a comprehensive breakdown of the traffic by 2. You can click to remove a category from display. (Category) The most popular categories are displayed with the amount of traffic broken down further by application. Inc. You can also enter a keyword in the category. Place the mouse cursor over the chart for the amount of traffic per application. follow these steps: 1. You can click any category to have it displayed Filter field. Click Add Category or the sign.

a client can or descending order.UniFi Controller User Guide Chapter 9: Insights Chapter 9: Insights On any sub-tab. Search   Enter the text you want to search • Neighboring Access Points  Displays information about for. have multiple sessions from different days). The Insights screen displays different kinds of status If there is more than one page of entries to display. AC‑EDU Streams. • Past Guest Authorizations  Displays information about Port Forward Stats. PoE. applies a default set of columns to display. DDNS services. Customize Columns  Each of these filters: Switch Stats. you can click any of the column headers to change the list order. They • Remote User VPN  Displays information about the are described further in the following sections: remote user VPN connections. (sort)  You can click any column to sort the displayed list. Inc. Remote User VPN. Simply begin typing. Click to customize the columns used for display. and traffic activity of the UniFi Switches. then the selected columns are displayed. 50. • “AC-EDU Streams” on page 75 Ubiquiti Networks. If you enable the Customize Columns option. • Switch Stats  Displays information about the status. • Dynamic DNS  Displays information about the use of Select Customize columns. • Past Connections  Displays information about previous The selected column displays or to indicate ascending client connection sessions (for example. Eight filters are available: the navigation controls or page numbers at the bottom • Known Clients  Displays information about detected right of the screen to display different pages. wireless devices not managed by the UniFi Controller. Dynamic DNS. ports. • “Dynamic DNS” on page 74 These sub-tabs share common options: • “Remote User VPN” on page 75 Items per page  Select how many results are displayed per page: 10. there is no need to press Enter. and the authorization of previous guest connections. or 200. • Port Forward Stats  Displays information about the port forwarding entries used by the UniFi Security Gateway. The column options will vary depending on the filter. clients. 100. • “Switch Stats” on page 70 • AC-EDU Streams  Displays information about the • “Port Forward Stats” on page 73 streaming by the UniFi AC EDU Access Points. click information. 67 .

7 days. You can apply one of the following filters: • All  Displays all wireless APs. Manufacturer  Displays the name of the device manufacturer. or All. or click AUTHORIZE for guests • Wired  Display all wired clients. alias. 3 days. • 2G  Only displays 2. 7 days. 120 days. 68 Ubiquiti Networks. this is useful for troubleshooting or resolving a problematic wireless connection. You can click RECONNECT to kick out a client. which usually reconnects back quickly. 3 days. Inc. (See “Wireless Client – Configuration” on page 111 or “Wired Client – Configuration” on page 112 for more information. Show  Filter the results on the page based on the date the User/Guest  Indicates whether the client is/was client was last seen. • Noted  Only display clients whose configurations include notes. pending authorization. the AP was last seen. Up  Displays the total amount of data uploaded by the client.Chapter 9: Insights UniFi Controller User Guide Known Clients An additional filter is available: • Blocked  Only display blocked clients. 120 days.4 GHz APs. 2 weeks.) • Static IP  Only display clients using static IP addresses. Actions  Click a button to perform the desired action: • Block  Click BLOCK to block this client from accessing the network.) Click UNAUTHORIZE to remove authorization of guest access and disconnect the guest. • Wireless  Display all wireless clients. Select last 24 hours. • Reconnect  Click RECONNECT to reconnect a wireless client. Down  Displays the total amount of data downloaded by You can apply one of the following filters: the client. . • Guest  Only display guests. see “Client Details” on page 109 for more information. You can click the name to get additional details. • Unauthorize/Authorize  (Available for Guests only. Name  Displays the hostname. connected to a primary or guest network. regardless of connection type. or MAC address of the connected client. Select last 24 hours. Click UNBLOCK to unblock this client. • All  Display all clients. or All. 30 days. 30 days. Neighboring Access Points You can also apply one of the following filters: • All  Display all users and guests. Last Seen  Displays the last date and time the client was connected. 2 weeks. Show  Filter the results on the page based on the time • User  Only display users.

refer to “UniFi Access Point Details” on page 95 or “UniFi Switch Details” on page 85 . Name/MAC Address  Displays the hostname.UniFi Controller User Guide Chapter 9: Insights • 5G  Only displays 5 GHz APs. You can click the name to get additional details. Past Guest Authorizations 24 Hours  The default view. additional details on the AP. • Calendar  Click a specific date to display its statistics. Select Week or Month to Click the date to display the calendar. increments. Click either arrow to change the calendar in one-month • Guest  Only display guests. interface. connected. You can click the device name for more information. MAC address of the connected client. You can click the name to get by the client. Past Connections 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. 69 . Click the date to display the calendar. encryption is used. Location  Displays the name of the closest AP managed Download  Displays the total amount of data downloaded by the UniFi Controller. 24 Hours  The default view. Inc. Ubiquiti Networks. change the duration interval. Date  Click either arrow to change the date in one-day increments. Date  Click either arrow to change the date in one-day increments. • Calendar  Click a specific date to display its statistics. or Name/SSID  Displays the name of the wireless network. alias. client. detected on. Associated  Displays the date and time the client first Security  Displays the security status indicating whether connected. Upload  Displays the total amount of data uploaded by Signal  Displays the signal strength level and signal type: the client. see “Client Details” on BSSID  Displays the MAC address of the AP’s wireless page 109 for more information. Duration  Displays the length of time the client was Manufacturer  Displays the name of the AP manufacturer. User/Guest  Indicates whether the client is/was Channel  Displays the channel setting that the AP was connected to a primary or guest network. You can apply one of the following filters: • All  Display all users and guests. • User  Only display users. Click either arrow to change the calendar in one-month increments. Select Week or Month to change the duration interval. Last Seen  Displays the last date and time the AP was IP Address  Displays the last known IP address of the connected.

RX Frames. Start  Displays the start date and time of the session. TX -. Upload  Displays the total amount of data uploaded by the guest. • Link Status  Displays the ports of the specified status: Power. following: • All  Resets all counters to zero. Network/VLANs. 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.All  Displays all ports. TX Broadcast. and Current columns are displayed. You can click the device name for more information. -. RX • All Switch  Displays the ports of all UniFi Switches or a Rate. RX. Multicast. TX Errors. TX. Customize Columns  Click to customize the columns used for display. 70 Ubiquiti Networks. TX Rate.Overview  The Switch. and RX Errors columns are Clear Counters  Click CLEAR COUNTERS and select one of the displayed.Counters  The Switch. -. -. and the filter options: Overview. RX Broadcast. MAC address of the previous guest. TX Frames. Name. . refer to “UniFi Access Point Details” on page 95 or “UniFi Switch Details” on page 85 .. STP. Authorized By  Displays the name of the authorizing body. Download  Displays the total amount of data downloaded by the guest. Link Status. PD Class. PoE. Switch Stats You can apply one of the following filters: • Overview  Displays the general status information of You can add or remove columns for display. columns to . Duration  Displays the length of time the guest was connected. PoE.Chapter 9: Insights UniFi Controller User Guide Name/MAC Address  Displays the hostname. RX Bytes. • PoE  Displays the specific PoE configuration and status PoE.Connected  Displays all connected ports. alias. Inc. • (switch_name)  Resets the counters of the selected UniFi Switch to zero. of each port. specific Switch. Package  Displays the name of the guest access package.. IP  Displays the last known IP address of the guest. You have additional filters: -. Amount  Displays the amount paid by the guest. and Counters will disappear. Name. columns option will apply. • Reset columns to  Click the drop-down at the bottom • Counters  Displays the specific TX and RX rates for of the Customize columns screen to display the Reset each port.PoE  The Switch. The Customize each port. Voltage. TX Bytes. PoE Detection. or Select Customize columns. and Activity columns are displayed. options. RX Multicast. -. Mode.Disconnected  Displays all disconnected ports.

If the Mode is Aggregate. Inc. see “UniFi Switch Details” on VLAN is enabled). click POWER CYCLE to power Switch  If All Switches is selected. Indicates a 1 Gbps (1000 Mbps) connection. or MAC address of the UniFi Switch.3at/af devices can be plugged in and automatically receive PoE. page 85. For more information. but the port is not in use). • PoE+  802. statistics. A port channel. Mode  Displays the operation mode: • Switching  The default mode. Actions  Click a button to perform the desired action: Indicates 1 Gbps (1000 Mbps) connection with PoE. 71 . then it displays the aggregation detail. also known as a Link Aggregation Group (LAG). • Aggregate  This port is part of an aggregate link. 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. • __W  Power output is displayed in watts.UniFi Controller User Guide Chapter 9: Insights PoE  Displays the PoE setting: • (blank)  PoE is disabled. TX  Displays the amount of data transmitted. then this displays the cycle the port. Name  Displays the name of the port. TX Rate  Displays the transmit rate. RX Rate  Displays the receive rate. EDIT Indicates the connection is disabled (no network or For more information. STP  Displays the STP (Spanning Tree Protocol) mode. hostname. Overview RX  Displays the amount of data received. Networks/VLANs  Displays the networks/VLANs that the port belongs to. see “UniFi Switch Details” on page 85. Link Status  Displays the connection speed and duplex mode. • Edit  Click to make changes to the port settings. The different colors represent different types of packet activity. Indicates no connection (the network or VLAN is • Clear Counters  Click CLEAR COUNTERS to clear the port enabled. • 24V Passive  24V passive PoE is enabled. Ubiquiti Networks. alias. combines multiple links into a single logical link (single IP address) for load balancing and/or redundancy. You can click the name to get additional details. • Mirroring  The network traffic of this port will receive the mirrored traffic from the port selected in ”Port Configuration” on page 87. • Power Cycle  If applicable. Activity  Displays the level of activity. Indicates a 10 Gbps connection.

see “UniFi Switch Details” on page 85. if applicable. • Clear Counters  Click CLEAR COUNTERS to clear the port statistics. can click the name to get additional details. You Indicates a 10 Gbps connection. TX Multicast  Displays the number of multicast packets transmitted. or MAC address of the UniFi Switch. PoE Detection  Displays the PoE status: TX Bytes  Displays the number of bytes transmitted. information. For more • __W  Power output is displayed in watts. but the port is not in use). • (blank)  PoE is disabled. RX Multicast  Displays the number of multicast packets received. if applicable.Chapter 9: Insights UniFi Controller User Guide PoE Actions  Click a button to perform the desired action: • Edit  Click to make changes to the port settings. 72 Ubiquiti Networks. Power  Displays the power output in watts. EDIT For more information. TX Frames  Displays the number of frames transmitted. Indicates 1 Gbps (1000 Mbps) connection with PoE. Indicates a 1 Gbps (1000 Mbps) connection. PoE  Displays the PoE setting: Indicates no connection (the network or VLAN is • (blank)  PoE is disabled. • Passive  24V passive PoE is enabled. TX Broadcast  Displays the number of broadcast packets • Good  An 802. Switch  If All Switches is selected. . TX Errors  Displays the number of error packets PD Class  Displays the PD (Powered Device) class of the transmitted. detected device. For more Indicates 1 Gbps (1000 Mbps) connection with PoE. alias. but the port is not in use). see “UniFi Switch Details” on page 85. • 24V Passive  24V passive PoE is enabled. Current  Displays the current output in amperes. Inc. You automatically receive PoE. automatically receiving PoE. then this displays the hostname. RX Errors  Displays the number of error packets received. Indicates a 1 Gbps (1000 Mbps) connection. Indicates the connection is disabled (no network or Name  Displays the name of the port. this indicates its power requirements. if applicable. if applicable. enabled. see “UniFi Switch Details” on page 85. click POWER CYCLE to power cycle the port. Indicates the connection is disabled (no network or VLAN is enabled). then this displays the • PoE+  802.3at/af device is detected.3at/af devices can be plugged in and hostname. information. can click the name to get additional details. Voltage  Displays the voltage output. • Power Cycle  If applicable. Counters Port  The ports display their status and port number: Indicates a 10/100 Mbps connection. alias.3at/af device is plugged in and transmitted. RX Bytes  Displays the number of bytes received. or MAC address of the UniFi Switch. Port  The ports display their status and port number: Indicates no connection (the network or VLAN is Indicates a 10/100 Mbps connection. Indicates a 10 Gbps connection. • Not detected  No 802. VLAN is enabled). enabled. RX Broadcast  Displays the number of broadcast packets received. Switch  If All Switches is selected. RX Frames  Displays the number of frames received.

or Anywhere.User Defined  The Name.. Protocol  Displays the protocol that will be forwarded. For more information. From  Displays the source IP address. Select Customize columns. Packets. Port  Displays the port or ports that will be forwarded to the LAN. • Power Cycle  If applicable. Bytes. click POWER CYCLE to power cycle the port. see “UniFi -. Customize Columns  Click to customize the columns used for display. Forward Actions  Click a button to perform the desired action: IP. Packets. Port. Port.UPnP  The Name. • UPnP  Displays the UPnP port forwarding entries. receive the forwarded port traffic. and Actions columns are displayed. From. Forward Security Gateway Details” on page 77. EDIT For more information. Port Forward Stats You can apply one of the following primary filters: • All  Displays all port forwarding entries. Ubiquiti Networks. 73 . Port. Gateway settings. see “UniFi Switch Details” on page 85. and Lease Duration columns are displayed. Bytes. options. if specified. Inc. Name  Displays the name of the port forwarding entry. Packets  Displays the number of packets transferred. and Actions columns • Edit  Click to make changes to the UniFi Security EDIT are displayed. Forward Port. From. Forward IP  Displays the destination IP address that will You can add or remove columns for display. Protocol. • Clear Counters  Click CLEAR COUNTERS to clear the port statistics.All  The Name. Forward IP. Protocol. internal port(s). -. Bytes  Displays the number of bytes transferred. Forward IP. -. Bytes. Also known as the external port(s). Also known as the columns to . Packets.UniFi Controller User Guide Chapter 9: Insights Actions  Click a button to perform the desired action: • Edit  Click to make changes to the port settings.. Forward Port. Port. All • User-Defined  Displays the user-defined port forwarding entries. • Reset columns to  Click the drop-down at the bottom Forward Port  Displays the destination port or ports that of the Customize columns screen to display the Reset will receive the forwarded port traffic. Protocol.

Name  Displays the name of the port forwarding entry. Status  Displays the status of the latest DDNS update. Packets  Displays the number of packets transferred. or Anywhere. receive the forwarded port traffic. From  Displays the source IP address. Also known as the external port(s). Actions  Click a button to perform the desired action: • Edit  Click to make changes to the UniFi Security EDIT Gateway settings. 74 Ubiquiti Networks. Protocol  Displays the protocol that will be forwarded. Protocol  Displays the protocol that will be forwarded. UPnP You can add or remove columns for display.Chapter 9: Insights UniFi Controller User Guide User-Defined Forward Port  Displays the destination port that will receive the forwarded port traffic. Last Updated  Displays the duration of time since the hostname IP address was last updated. Also known as the internal port. Lease Duration  Displays the uptime of the port forwarding entry. if specified. For more information. IP  Displays the WAN (public) IP address of the hostname. Username  Displays the username of the DDNS account. Also known as the internal port(s). For more information. Bytes  Displays the number of bytes transferred. Select Customize columns. • Edit  Click to make changes to the UniFi Security EDIT Gateway settings. Also known as the external port(s). see “UniFi Forward IP  Displays the destination IP address that will Security Gateway Details” on page 77. will receive the forwarded port traffic. Server  Displays the IP address or hostname of the DDNS server that should receive DDNS updates. . Actions  Click a button to perform the desired action: Port  Displays the port or ports that will be forwarded to the LAN. Forward IP  Displays the destination IP address that will receive the forwarded port traffic. Service  Displays the name of the DDNS service. Bytes  Displays the number of bytes transferred. Port  Displays the port or ports that will be forwarded to the LAN. Packets  Displays the number of packets transferred. Inc. Hostname  Displays the hostname registered with the DDNS service. Dynamic DNS Name  Displays the name of the port forwarding entry. see “UniFi Security Gateway Details” on page 77. Customize Columns  Click to customize the columns Forward Port  Displays the destination port or ports that used for display.

Interface  Displays the interface being used. options. used for display. of the Customize columns screen to display the Reset columns to . Connected  Displays the status of the connection. Select Customize columns. Up Bytes  Displays the amount of data uploaded as bytes. Ubiquiti Networks. • Reset columns to  Click the drop-down at the bottom You can add or remove columns for display. Select Customize columns. Streaming  Displays the duration of the live streaming. Device  Displays the hostname. Connected columns are displayed. -. and Remote IP  Displays the IP address of the remote user. Down Bytes  Displays the amount of data downloaded as bytes. Down Pkts  Displays the amount of data downloaded as packets. You can add or remove columns for display. see “UniFi Access Point Details” on page 95. Yes or No. Yes or No. User  Displays the username of the remote user. Streaming. Yes or No. Ready  Displays the status of the UniFi AC EDU AP. 75 . Up Pkts  Displays the amount of data uploaded as packets. or MAC address Actions  Click a button to perform the desired action: of the UniFi AC EDU AP. Stream. additional details.. alias. Terminate Stream  Click TERMINATE and then click the live Uptime  Displays the duration of time the VPN tunnel has stream you want to terminate..All  The Device. Stream  Displays the unique identifier for this live stream. been active without interruption.UniFi Controller User Guide Chapter 9: Insights Remote User VPN AC-EDU Streams Customize Columns  Click to customize the columns Customize Columns  Click to customize the columns used for display. You can click the name to get • Terminate  Click TERMINATE to end the VPN tunnel. Ready. Inc. For more information.

. Inc.Chapter 9: Insights UniFi Controller User Guide 76 Ubiquiti Networks.

-.) dock this window in the Properties panel or detach it as a separate window. -. • “UniFi Security Gateway – Networks” on page 78 Collapse All  Click to collapse all of the popups • “UniFi Security Gateway – Configuration” on page to rows. available for adoption. be moved anywhere within the browser screen. (This icon does not appear if an upgrade is not available or there Properties are pending changes. Hide Property Panel  Click to hide the Properties panel but allow the device popups to remain accessible from this panel. • Locate  Click to flash the LED on the device and the The UniFi Security Gateway hyperlink opens the UniFi device icon on the Map tab so you can locate it. (The panel or as a separate popup window. • Upgrade  Click to upgrade the device.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. You can always icon on the Map tab will flash three times and stop. 79 The top of the popup remains and displays the following: • Display  Click to display the device information. Indicates the connection is disabled (no network or VLAN is enabled). • (status)  Displays to indicate the device status. but the port is not in use). There are three clickable tabs: • “UniFi Security Gateway – Details” on page 78 Remove All  Click to close the Properties panel.Pending Approval  A solid orange circle indicates the default state. Gateway Details • Restart  Click to restart the selected device. The upper part of the detached popup screen has an icon for each port. Indicates a 10/100 Mbps connection.) The Properties panel appears on the right side of the • Undock from Properties Panel  Click to display the screen. • (icon)  Displays the icon of the device (the icon will vary depending on the model). Click the properties icon to re-open it. Information about each selected device appears as same information in a separate popup screen that can a popup within this panel. 77 . -.Disconnected  A red warning icon ! indicates no connection. The LED Security Gateway’s Details window either in the Properties will flash until the Locate button is clicked again. Ubiquiti Networks. Indicates a 1 Gbps (1000 Mbps) connection. -. • Close Properties  Click to close the device popup.UniFi Controller User Guide Chapter 10: UniFi Security Gateway Details Chapter 10: UniFi Security • Name/MAC Address  Displays the device name or MAC address of the device. Indicates no connection (the network or VLAN is enabled.Connected  A solid green circle indicates a managed connection. Inc.

Up Activity  Displays the level of upload activity in Bytes per second. Click Details to display the device specifics. RX  Displays the incoming (receive) throughput. TX  Displays the outgoing (transmit) throughput. . been running without interruption. Version  Displays the version number of the Gateway’s firmware. Uptime  Displays the duration of time the Gateway has (sort)  You can click any column to sort the displayed list. UniFi Security Gateway – Networks Click Networks to display the network name. and number of clients. Inc. Speed  Displays the connection speed in Mbps. The number of WAN sections will vary depending on the Network  Displays the name of the network. The selected column displays or to indicate ascending WAN 1 or descending order. number of active WAN ports. Full Duplex or Half Duplex. MAC Address  Displays the MAC address or unique hardware identifier of the Gateway. # Clients  Displays the number of clients on the network. Up Pkts/Bytes  Displays the amount of data uploaded as packets and bytes.Chapter 10: UniFi Security Gateway Details UniFi Controller User Guide UniFi Security Gateway – Details IP Address  Displays the WAN (public) IP address of the WAN interface. Model  Displays the model name of the Gateway. IP address. Overview Down Pkts/Bytes  Displays the amount of data downloaded as packets and bytes. and uptime. 78 Ubiquiti Networks. LAN IP Address  Displays the local IP address of the Gateway. TX and RX throughput. Duplex  Displays the mode. IP  Displays the local IP address of the network. LAN/WAN connection details. Down Activity  Displays the level of download activity in Bytes per second.

Save  Click Save to apply the change. -. 79 .Router  Enter the IP address of the service provider’s gateway router. -. -.IP Address  Enter the Internet IP address of the Gateway. • Using DHCP  The use of the Dynamic Host Configuration Protocol (DHCP) is the default. The Alias is also known as the host name. WAN 1/2 Connection Type  Select the Internet connection type for your service.UniFi Controller User Guide Chapter 10: UniFi Security Gateway Details UniFi Security Gateway – Configuration Click Configuration to configure the alias. -. port forwarding.Preferred DNS  Enter the IP address of the service provider’s primary DNS server.Alternate DNS  Enter the IP address of the service provider’s secondary DNS server. Ubiquiti Networks. Enter the following information: -. -. You can also remove the Gateway from management by this UniFi Controller.Subnet Mask  Enter the subnet mask of the Gateway. WAN settings. Alias  Displays the customizable name or identifier of the Gateway. Inc. -. Dynamic DNS.Alternate DNS  Enter the IP address of the service provider’s secondary DNS server. and custom upgrade entries. General • Static IP  The service provider assigns fixed network settings to your service for manual entry.Preferred DNS  Enter the IP address of the service provider’s primary DNS server. The Gateway automatically acquires network settings from the service provider’s DHCP server.

The actual rate limits will be set to 95% of the specified value. select Disabled. Load Balancing  (Available for WAN 2 if Using DHCP. It may require some testing to find the actual threshold in a specific environment. • Down Rate  Enter the bandwidth limit in Kbits/sec. Use VLAN ID  To use a VLAN. and other conditions. provider’s secondary DNS server. Inc. depends on the specific Gateway model and conditions of -. 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. The smart queue policy applies to a single interface. If you are using more than one WAN interface. • Pre-Populate  Click Pre-Populate to set the Up and • Disabled  If you are not using the WAN 2 port. depending on the actual setup. limiting will not work well (cannot achieve the specified rate) above a certain threshold rate. interface comes up). Static IP.Chapter 10: UniFi Security Gateway Details UniFi Controller User Guide • PPPoE  Point-to-Point Protocol over Ethernet (PPPoE) Smart Queues  The Smart Queue feature provides is a virtual private and secure connection between two FQ-CODEL (Fair Queuing with Controlled Delay) + HTB systems that enables encapsulated data transport. Note: If you enable the Smart Queues option. 80 Ubiquiti Networks. select Use VLAN ID and enter the VLAN ID number. -. then Down Rates to 80% of the last speed test results.Username  Enter the username used to connect to not exist yet (the policy will be applied later when the the PPPoE server.Alternate DNS  Enter the IP address of the service the actual environment.Preferred DNS  Enter the IP address of the service (applied to the sum of the upload and download rates) provider’s primary DNS server. • Failover only  Select this option if you want to use WAN 2 only if WAN 1 fails. .) Set up basic load balancing with two Internet connections from different Internet Service Providers (ISPs). so the rate PPPoE server. or PPPoE is enabled. Enter (Hierarchical Token Bucket) function and supports the following information: dynamic interfaces. traffic patterns. The actual threshold -. even if the dynamic interfaces do -. the default is 50. Then enter a weight in the field provided. • Weighted LB  Select this option if you want the load balanced between the two WAN ports. so you can experiment with different values if necessary. • Up Rate  Enter the bandwidth limit in Kbits/sec.Password  Enter the password used to connect to the The HTB rate limiting is computation-intensive. then you will not be able to use the DPI feature as traffic will not be offloaded. You can use the Pre-Populate option as a starting point for the Up and Down Rates.

When you are done with your changes. Inc. (You can cancel the changes of any section by clicking X of the appropriate section. click Apply Changes at the bottom of the screen. • Delete  Click to delete the port forwarding entry. Discard  Click DISCARD to cancel changes. Each section with pending changes is highlighted by an ellipsis. Apply  Click APPLY to save changes. Click to display the devices. 81 . Also known as the external port(s). Port  Displays the port or ports that will be forwarded to the LAN.UniFi Controller User Guide Chapter 10: UniFi Security Gateway Details Queue Changes  Click Queue Changes to line up the Port Forward changes to take effect. Go to “Create or CREATE Edit Port Forwarding Entry” on page 82. if specified. Actions  Click a button to perform the desired action: • Edit  Click to edit the port forwarding entry. Dest IP/Port  Displays the destination IP address and port(s) that will receive the forwarded port traffic. Create  Click to add a new entry. From  Displays the source IP address. Name  Displays the name of the port forwarding entry. This allows you to make multiple changes to the device and then apply them all at once so that the device doesn’t have to re-provision over and over again when you change different sections of the configuration. the Pending Changes option appears in the Properties panel. Pending Changes  If you want queue changes for multiple devices and then apply them later. Ubiquiti Networks.) Cancel  Click Cancel to discard changes. Also known as the internal port(s).

Cancel  Click Cancel to discard changes. or UDP. Each DNS server on the Internet holds these mappings in its respective DNS database. Apply  Click Apply to save changes. Cancel  Click Cancel to discard changes. TCP. forwarded port traffic. Hostname  Enter the host name of the device. • Edit  Click to edit the DDNS entry. which has to be updated on the DDNS server. which accepts traffic from service provider.Chapter 10: UniFi Security Gateway Details UniFi Controller User Guide Create or Edit Port Forwarding Entry Dynamic DNS Domain Name System (DNS) translates domain names to IP addresses. 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). Protocol  Select the protocol that will be forwarded: Both.554). Service  If available. You can identify the port or ports by name. Hostname  Displays the host name of the device. 82 Ubiquiti Networks. and/or range. number. Password  Enter the password of the DDNS account. If you do not specify this port. Port  Enter the port or ports that will be forwarded to the Password  Displays the password of the DDNS account. and/or range.com Username  Enter the user name of the DDNS account. Username  Displays the user name of the DDNS account. you can still access the device through its domain name. Even if the device’s IP address changes. Inc. Dynamic Domain Name System (DDNS) is a network service that notifies the DNS server in real time of any changes in the device’s IP settings. You can Server  Displays the address of your DDNS server. Service  Displays the name of your Dynamic DNS (DDNS) From  The default is Anywhere. LAN (also known as the external port or ports). Server  Enter the address of your DDNS server.ddns. To specify a source IP address. . select Limited and enter the source IP address in the field provided. select your DDNS service provider from the drop-down list. identify the port or ports by name. Create  Click to add a new entry. Go to the Create or CREATE Edit DDNS Entry section on the next page. For example: sample. use a comma-separated list (example: 20-23. number. Name  Enter a name to identify this port forwarding entry. Actions  Click a button to perform the desired action: To specify multiple ports. Apply  Click Apply to save changes. then the original destination port of the traffic will be used. Forward IP  Enter the LAN IP address that will receive the • Delete  Click to delete the DDNS entry. any source IP address.

Inc. 83 . To specify firmware saved in a custom location. This will restore the Gateway to factory default settings while it is in a Connected state. Forget This Device Forget  Click Forget to remove the Gateway from management by the UniFi Controller software and reset it to factory default settings.UniFi Controller User Guide Chapter 10: UniFi Security Gateway Details Custom Upgrade For firmware upgrades. the UniFi devices retrieve the latest firmware from the Ubiquiti website. Custom Upgrade  Click to upgrade the firmware from the location you entered. Ubiquiti Networks. Note: Use caution when clicking Forget. (URL)  Enter the location URL of the firmware. select this option.

Inc. .Chapter 10: UniFi Security Gateway Details UniFi Controller User Guide 84 Ubiquiti Networks.

the default state. • TX  Displays the amount of data transmitted. depending on the model).Connected  A solid green circle indicates a setting: managed connection. Indicates 1 Gbps (1000 Mbps) connection with PoE. Indicates mirroring mode.) The Properties panel appears on the right side of the • Upgrade  Click to upgrade the device. (This icon screen.3at/af devices can be plugged in and automatically receive PoE. -. Collapse All  Click to collapse all of the popups Indicates STP blocking. device icon on the Map tab so you can locate it. The top of the popup remains and displays the following: • Display  Click to display the device information. (The Properties icon on the Map tab will flash three times and stop. -. Information about each selected device appears as does not appear if an upgrade is not available or there a popup within this panel.) Displays the PoE -. to rows. You can always dock this window in the • Locate  Click to flash the LED on the device and the Properties panel or detach it as a separate window. • (status)  Displays to indicate the device status. The LED will flash until the Locate button is clicked again. Indicates a 10 Gbps connection. A UniFi Switch hyperlink opens the UniFi Switch’s Details window either in the Properties panel or as a separate • Restart  Click to restart the selected device. Ubiquiti Networks. 85 .24V Passive  24V passive PoE is enabled.Disconnected  A red warning icon ! indicates no connection. -. available for adoption. Details • Name/MAC Address  Displays the device name or MAC address of the device. • Port  Displays the port number. Indicates a 1 Gbps (1000 Mbps) connection.Managed by Other  A solid gray circle indicates -. popup window. Indicates a 10/100 Mbps connection.PoE+  802.__W  Power output is displayed in watts. • PoE  (Not applicable to the SFP ports. are pending changes. Indicates no connection (the network or VLAN is Remove All  Click to close the Properties panel. Inc. that the device is not in the default state but not controlled by the current UniFi Controller. The upper part of the detached popup screen has an icon for each port.UniFi Controller User Guide Chapter 11: UniFi Switch Details Chapter 11: UniFi Switch -.Off  PoE is disabled. • Close Properties  Click to close the device popup. Place your cursor over a port to view details. Indicates the connection is disabled (no network or VLAN is enabled).) • Undock from Properties Panel  Click to display the same information in a separate popup screen that can be moved anywhere within the browser screen. Hide Property Panel  Click to hide the Properties panel but allow the device popups to remain accessible from this panel.Pending Approval  A solid orange circle indicates • RX  Displays the amount of data received. -. but the port is not in use). -. enabled. Click the properties icon to re-open it. • (icon)  Displays the icon of the device (the icon will vary • Name  Displays the name of the port. • Status  Displays the connection speed and duplex mode.

(sort)  You can click any column to sort the displayed list. and uptime. Activity  Displays the level of activity in Bytes per second. Down Pkts/Bytes  Displays the amount of data downloaded as packets and bytes. 86 Ubiquiti Networks. Speed  Displays the connection speed in Mbps. The selected column displays or to indicate ascending or descending order.Chapter 11: UniFi Switch Details UniFi Controller User Guide • Networks/VLANs  Displays the networks/VLANs that Uplink the port belongs to. You can click the name to get additional details. Uptime  Displays the duration of time the Switch has been running without interruption. Temperature  Displays the general temperature of the Switch. then the Fan Level is not displayed. Uplink  Displays the name or MAC address of the uplink device. Up Pkts/Bytes  Displays the number of packets and total bytes uploaded by the device. IP Address  Displays the IP address of the Switch. Overview Port  Displays the port number. Version  Displays the version number of the Switch’s firmware. connection details. • Uplink/Downlink  Displays the name of the uplink or downlink device. . Power Consumption  Displays the amount of power used by the Switch. from 0 to 3. Downlinks MAC Address  Displays the MAC address or unique hardware identifier of the Switch. Model  Displays the model name of the Switch. is displayed. then the Fan Level. If the Switch does not have a fan. Full Duplex or Half Duplex. Duplex  Displays the mode. Inc. There are three clickable tabs: • “UniFi Switch – Details” on page 86 • “UniFi Switch – Ports” on page 87 • “UniFi Switch – Configuration” on page 89 UniFi Switch – Details Click Overview to display the device specifics. Fan Level  If the Switch has a fan.

the port. and networks/VLANs. downlink device. Proceed to the following section. 87 . TX  Displays the amount of data transmitted. TX and RX Actions  Click a button to perform the desired action: throughput. PoE  Displays the PoE setting: Device  Displays the name or MAC address of the • Off  PoE is disabled. Status  Displays the connection speed and duplex mode. Inc. details. Model  Displays the model number of the downlink device.3at/af devices can be plugged in and automatically receive PoE. • Name  Displays the customizable name or identifier of Name  Displays the name of the port.UniFi Controller User Guide Chapter 11: UniFi Switch Details Port  Displays the number of the connected port. Status  Displays the connection speed and duplex mode. • __W  Power output is displayed in watts. You can click the name to get additional • 24V Passive  24V passive PoE is enabled. RX  Displays the amount of data received. Ubiquiti Networks. • Edit  Click to change the port configuration. Port  Displays the port number. PoE setting. • PoE+  802. Port Configuration.) Click to restart the connected device. Click Ports to display the port name. status. Port Configuration • Port  Displays the number of the port. • Powercycle  (Available only if the connected devices uses PoE. Networks/VLANs  Displays the networks/VLANs that the UniFi Switch – Ports port belongs to.

Auto.Storm Control  Monitor the unicast. Full‑duplex transmission is enabled by default. Mirroring -. Enter the threshold in packets per second. Enter the threshold in packets per second. multicast. VLAN. • Operation  Select the operation mode for this port. • Link Negotiation  Keep the default. select 1000 Mbps. Isolated ports cannot • Networks/VLANs  Select the appropriate network or communicate directly with each other. 88 Ubiquiti Networks. then the UniFi Switch drops the excess traffic. Inc. or 10 Mbps. . For SFP ports. -. • Apply  Click Apply to save changes.Switching  The default mode.3at/af devices can be plugged in and automatically receive PoE. -. Switching. For that the connected device supports PoE and the SFP+ ports. If the specified type • Advanced Options  Click the icon to display additional of traffic on this port exceeds the threshold rate you options. • Multicast  Select this option to monitor multicast Switching traffic. or select Disabled to disable this port.Isolation  Select this option to create a Private VLAN (Virtual Local Area Network). or select -. select the appropriate speed: 10 Gbps supplied voltage. Proceed to the Enter the threshold value in packets per second. select the appropriate Note: Before activating 24V passive PoE. and/or broadcast traffic for this port.) support 24V passive PoE. specify. appropriate section. Mirroring.Chapter 11: UniFi Switch Details UniFi Controller User Guide • PoE  All ports are set to auto-sensing PoE+ by default. or 1000 Mbps. -. ensure speed: 1000 Mbps. Manual to specify the duplex and speed: -. • Link Speed  For RJ45 ports.PoE+  802. • Broadcast  Select this option to monitor broadcast traffic.Off  Disable PoE. The default is All.24V Passive  Select this option to power devices that • Full Duplex  (Available for RJ45 ports only. or Aggregate. 100 Mbps. • Unicast  Select this option to monitor unicast traffic. • Cancel  Click Cancel to discard changes.

If you select this option. For SFP ports. or 10 Mbps. Ubiquiti Networks. combines multiple links into a single logical link (single IP address) for load balancing and/or redundancy. Aggregate General Alias  Displays the customizable name or identifier of the Switch. For • Apply  Click Apply to save changes. perform a custom upgrade.) • Link Negotiation  Keep the default. Isolated ports cannot Click Configuration to configure the alias. and network settings. 100 Mbps. You can also use this tab • Apply  Click Apply to save changes. SFP+ ports.UniFi Controller User Guide Chapter 11: UniFi Switch Details -. -. Save  Click Save to apply your change. or select Full‑duplex transmission is enabled by default. services. select the appropriate • Full Duplex  (Available for RJ45 ports only. select 1000 Mbps. • Full Duplex  (Available for RJ45 ports only. select the appropriate speed: 10 Gbps • Link Speed  For RJ45 ports. or 1000 Mbps. Inc. Manual to specify the duplex and speed: • Link Speed  For RJ45 ports. The Alias is also known as the host name. SFP+ ports. to copy another switch’s configuration to this Switch. -. speed: 1000 Mbps.Mirroring  The network traffic of this port will receive • Aggregate Ports  Enter the end port number of the the mirrored traffic from the port listed below for LAG.Isolation  Select this option to create a Private VLAN UniFi Switch – Configuration (Virtual Local Area Network). then this port becomes the start port of the aggregate link. or 10 Mbps. or remove the Switch from management.Aggregate  A port channel. gain terminal access to the • Cancel  Click Cancel to discard changes. select the appropriate speed: 10 Gbps • Cancel  Click Cancel to discard changes. 100 Mbps. select the appropriate or 1000 Mbps. select 1000 Mbps. 89 . also known as a Link Cancel  Click Cancel to discard changes. network/VLANs. For Full‑duplex transmission is enabled by default. Aggregation Group (LAG). Auto. Auto.) analysis: • Link Negotiation  Keep the default. (Two to four ports are permitted per LAG. communicate directly with each other. or select • Mirroring Port  Enter the number of the port that Manual to specify the duplex and speed: will be mirrored.) speed: 1000 Mbps. For SFP ports. Switch.

MGMT VLAN  A network group defines the management the native network packets are stripped of the VLAN 30 VLAN for the Switch. Each physical port can have multiple networks attached. Select the appropriate tagged network. The Switch accepts tagged and untagged packets in the ingress direction. In the egress direction.) • Apply  Click Apply to save changes. and the untagged packets are assigned to the VLAN of the native network. only one of them can be native (untagged).) Untagged Accepted Assigned to VLAN 1 VLAN header removed and sent Actions  Click a button to perform the desired action: out as untagged • View  Click to view the default network.Chapter 11: UniFi Switch Details UniFi Controller User Guide Networks/VLANs Select the appropriate native network. (Not Tagged as Accepted Remains tagged Sent out tagged as available for the default network. A switch assigned to a native network participates in the VLAN of that native network. For example. which identifies the default VLAN. Select the appropriate network header and exit as untagged packets.) VLAN. the packets will be tagged in both ingress and egress directions. This table lists how the packets are handled: Enable Jumbo Frame  Disabled by default. group. (Use “Settings > Networks” on page 23 to create more networks. Tagged as Accepted Remains tagged Sent out tagged as VLAN 20 VLAN 20 • Edit  Click to edit the network/VLAN entry. Go to the “Create CREATE New Network/VLAN” on page 90 section below. (Networks may be created in “Settings > Networks” on page 23. Jumbo frames are typically used for Gigabit Untagged Accepted Assigned to VLAN VLAN header Ethernet connections. The Maximum Transmission Unit (MTU) is the maximum packet size (in Packet Ingress Action Egress Type bytes) that a network interface can transmit. 90 Ubiquiti Networks. if the PVID is VLAN 30. The switch is connected to an AP with two tagged networks: • VLAN 20: corporate Create  Click to add a new entry. • VLAN 30: guest Name  Displays the name of the network/VLAN. Services • Name  Enter a name to identify this network/VLAN. For example. the native network is LAN with VLAN 1 as the PVID. (Additional networks may be created in “Settings > Networks” on page 23.) • Tagged Networks  For a Switch belonging to a tagged network. A jumbo frame is larger than the standard Ethernet frame with an Tagged Accepted Remains tagged Sent out as tagged MTU of 1500.) VLAN 30 VLAN 30 • Delete  Click to delete the network/VLAN entry. Inc. This table lists how the packets are handled: Config  Displays the configuration: Native (____) or Packet Ingress Action Egress Type Customized. If you enable this option. • Cancel  Click Cancel to discard changes. however. (Not The proper use of VLANs isolates the traffic of each available for the default network. • Native Network  A native network has a Port VLAN Identifier (PVID). then this of native network removed and sent out as untagged port handles jumbo frames and forwards them. The guest traffic on VLAN 30 will be kept separate Create New Network/VLAN from the traffic on the corporate network. . then all untagged packets are assigned to VLAN 30.

IP Address  Enter the IP address. The default is 1813.Port  Enter the port number. -.Add Auth Server  If you have another authentication Control allows the port to manage data rates in case server. click this option and complete the is recommended because ports can more quickly progress IP Address.UniFi Controller User Guide Chapter 11: UniFi Switch Details Enable Flow Control  Disabled by default. • Enable RADIUS VLAN  Allows the RADIUS server to dynamically assign a VLAN to a wired client. or Disabled. -.Port  Enter the port number. create excessive traffic and slow down performance. click this option and complete the IP Address. following options appear. When STP is selected.Password  Enter the password. RSTP accounting server. the Switch Queue Changes  Click Queue Changes to line up the sends STP packets. Port. Spanning Tree Protocol (STP) provides redundant paths and prevents network loops that can -. Each section with pending changes is server for user authentication on a wireless network. over again when you change different sections of the Enable 802. transmission rates.IP Address  Enter the IP address. The highlighted by an ellipsis. the sending and receiving devices use different data Port. When you are done with your changes. there should be information about the RADIUS server: a single active path between two networking devices in an -. click Apply Changes at the bottom of the screen. The default is 32768. 91 . STP -. Specify the Priority value so that the device doesn’t have to re-provision over and of the Switch.Delete  Click the delete icon to remove this accounting server. and Password fields. Inc. to the forwarding state.Add Accounting Server  If you have another Protocol).Delete  Click the delete icon to remove this fails. Select the appropriate option: RSTP (Rapid Spanning Tree -. calculates the best path for network traffic. Ethernet network. The default is 1812.1x control  Select this option to use a RADIUS configuration. Ubiquiti Networks. (You can cancel the changes of any section by clicking X of the appropriate section. Flow -. • RADIUS Auth Server  Provide the following information about the RADIUS authentication server: -. if the best path -. STP recalculates and finds the next best path. • RADIUS Accounting Server  Provide the following Spanning Tree  For optimal performance. accounting server. The default is RSTP.Password  Enter the password. STP (Spanning Tree Protocol). and Password fields.) Cancel  Click Cancel to discard changes. changes to take effect. -. This allows you to make multiple Priority  STP uses priority values to select a switch as the changes to the device and then apply them all at once root switch of the spanning tree.

• Using DHCP  The use of the Dynamic Host • Discard  Click DISCARD to cancel changes. 92 Ubiquiti Networks.Preferred DNS  Enter the IP address of the primary saved in a custom location. (location URL)  Enter the UL of the firmware’s location. . Click changes to the device and then apply them all at once to display the devices. Each section with pending changes is highlighted by an ellipsis. or click Cancel to discard changes. configuration of the selected Switch. the UniFi devices retrieve the latest firmware from the Ubiquiti website. the Pending changes to take effect. the UniFi Security Gateway).Subnet Mask  Enter the subnet mask of the Switch. click Apply Changes at the bottom of the screen. multiple devices and then apply them later.Chapter 11: UniFi Switch Details UniFi Controller User Guide Pending Changes  If you want queue changes for Queue Changes  Click Queue Changes to line up the multiple devices and then apply them later. This allows you to make multiple Changes option appears in the Properties panel. Then click Confirm to overwrite its current configuration with the -. When you are done with your changes. use this option to copy the configuration. -.DNS Suffix  Enter the Fully Qualified Domain Name (FQDN) without the hostname. (You can cancel the changes of any section by clicking X of the appropriate section. DNS server. Custom Upgrade  Click to upgrade the firmware from the location you entered.Gateway  Enter the IP address of the gateway (for example. • Apply  Click APPLY to save changes. Switches.) Cancel  Click Cancel to discard changes. so that the device doesn’t have to re-provision over and over again when you change different sections of the configuration. Custom Upgrade -. Using DHCP or Static IP. For firmware upgrades. • Apply  Click APPLY to save changes. Copy from  Select the appropriate Switch whose Enter the following information: configuration will be copied to this Switch. • Static IP  Assign fixed network settings to the Switch. select this option. -. The Switch Copy Config automatically acquires network settings from the If you have settings that you want to apply to multiple network’s DHCP server.Alternate DNS  Enter the IP address of the secondary DNS server. the Pending Network Changes option appears in the Properties panel. Pending Changes  If you want queue changes for • Discard  Click DISCARD to cancel changes. Inc. Click to display the devices. Configuration Protocol (DHCP) is the default.IP Address  Enter the IP address for the Switch. -. To specify firmware -. Configure IP  Select the Internet connection type for your service.

Open Terminal  Click Open Terminal to connect directly to this Switch. This will restore the Switch to factory default settings when it is in a Connected state. 93 . To use a command-line interface. • help  Enter help at the command line for a list of built-in commands. Note: Use caution when clicking Forget. A new window will appear. Inc.UniFi Controller User Guide Chapter 11: UniFi Switch Details Debug Terminal This option uses a WebRTC connection as transport layer. click Open Terminal. Ubiquiti Networks. Forget This Switch Forget  Click Forget to remove the Switch from management by the UniFi Controller software and reset it to factory default settings.

. Inc.Chapter 11: UniFi Switch Details UniFi Controller User Guide 94 Ubiquiti Networks.

You can always dock this window in the Properties Ethernet Port (if available) of the isolated AP to the panel or detach it as a separate window. screen. • ”UniFi Access Point – Configuration” on page 100 The top of the popup remains and displays the following: • Display  Click to display the device information. (The icon on the Map tab will flash three times and stop.Disconnected or Isolated  A red warning icon ! indicates no connection. -. Inc. The LED will flash until the Locate button is clicked again. address of the device. -.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.Connected  A solid green circle indicates a managed connection. • Locate  Click to flash the LED on the device and the device icon on the Map tab so you can locate it.UniFi Controller User Guide Chapter 12: UniFi Access Point Details Chapter 12: UniFi Access Point -. Information about each selected device appears as • Name/MAC Address  Displays the device name or MAC a popup within this panel. Click the properties icon to re-open it. perform one of the following actions: A UniFi AP hyperlink opens the UniFi AP’s Details window • Reconnect the AP to the gateway or router.) • Upgrade  Click to upgrade the device. The Properties panel appears on the right side of the • Establish a wireless uplink to a wired AP.Pending Approval  A solid orange circle indicates the default state. either in the Properties panel or as a separate popup • Connect an Ethernet cable from the Secondary window. To establish a connection Details to the UniFi Controller. • Close Properties  Click to close the device popup. -. Ubiquiti Networks.) • Undock from Properties Panel  Click to display the same information in a separate popup screen that can be moved anywhere within the browser screen. Secondary Ethernet Port (if available) of another UniFi Properties AP that is connected to the gateway or router. available for adoption. • “UniFi Access Point – Guests” on page 100 Collapse All  Click to collapse all of the popups to rows. (This icon does not appear if an upgrade is not available or there are pending changes. • Restart  Click to restart the selected device. • (icon)  Displays the icon of the device (the icon will vary depending on the model). Hide Property Panel  Click to hide the Properties panel but allow the device popups to remain accessible from this panel. There are four clickable tabs: • “UniFi Access Point – Details” on page 96 • “UniFi Access Point – Users” on page 99 Remove All  Click to close the Properties panel. 95 . • (status)  Displays to indicate the device status.

Duplex  Displays the mode. Activity  Displays the level of activity in Bytes per second. (Wired) to display details about the wired uplink. Up Pkts/Bytes  Displays the amount of data uploaded as Uptime  Displays the duration of time the AP has been packets and bytes. Down Pkts/Bytes  Displays the amount of data downloaded as packets and bytes.Chapter 12: UniFi Access Point Details UniFi Controller User Guide UniFi Access Point – Details Uplink (Wired) Click Overview to display the device specifics. # Guests  Displays the number of users connected to the guest network. connection If your AP has a wired uplink connection. uptime. You can click the name to get additional details on the device. or MAC address of the switch or other uplink device being used by the AP. Speed  Displays the connection speed in Mbps. running without interruption. Full Duplex or Half Duplex. IP Address  Displays the IP address of the AP. click Uplink details. Overview Uplink  Displays the name. MAC Address  Displays the MAC address or unique hardware identifier of the AP. Inc. alias. Version  Displays the version number of the AP’s firmware. Model  Displays the model name of the AP. # Users  Displays the number of users connected to the primary network. 96 Ubiquiti Networks. . and user statistics.

or MAC address of the uplink AP. You can click the name to get additional Down Pkts/Bytes  Displays the amount of data details on the device. • Remove  Click to remove the wireless AP from the wired AP. or MAC address of the RX Rate  Displays the receive rate. TX Rate  Displays the transmit rate. You can click the name to get additional details on the uplink AP. Ubiquiti Networks.UniFi Controller User Guide Chapter 12: UniFi Access Point Details Uplink (Wireless) Downlink If your AP has a wireless uplink connection. click Uplink The wireless APs currently connected to the wired AP are (Wireless) to display details about the wireless uplink. alias. Signal  Displays the percentage of signal strength Up Pkts/Bytes  Displays the amount of data uploaded as between the two APs. Inc. tab when a wireless AP is connected. AP  Displays the name. Actions  Click a button to perform the desired action: Activity  Displays the level of activity in Bytes per second. displayed. alias. 97 . Signal  Displays the percentage of signal strength Note: Downlinks will only be visible under the Details between the two APs. Uplink AP  Displays the name. packets and bytes. downlink AP. downloaded as packets and bytes.

TX Pkts/Bytes  Displays the amount of data transmitted as packets and bytes.Chapter 12: UniFi Access Point Details UniFi Controller User Guide Radio (11N/B/G) or Radio (11N/A/AC) RF Environment Click Radio (11N/B/G) or Radio (11N/A/AC) to display the Note: Only the UAP‑AC‑LITE. channel and transmit/receive statistics. UAP‑AC‑LR. # Guests  Displays the number of guests connected to the guest network. 2G/5G  Select the frequency band you want to analyze. RX Pkts/Bytes  Displays the amount of data received as packets and bytes. and UAP‑AC‑EDU support spectral analysis. RF Scan  Click RF SCAN to scan the RF environment and then click Confirm to continue. UAP‑AC‑PRO. Click RF Environment for spectral analysis to help in channel selection and planning. Channel  Displays the channel being used. 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. Inc. # Users  Displays the number of users connected to the primary network. . Transmit Power  Displays the EIRP in dBm. 98 Ubiquiti Networks.

40. The selected column displays or to indicate ascending or descending order.UniFi Controller User Guide Chapter 12: UniFi Access Point Details Note: The RF scan may take more than five minutes. The 5 GHz results are displayed and AP. • Interference Types  Displays the type of interference being detected. in channel widths of 20. • Frequency Range  Displays the range of frequencies. alias. Inc. and following: the AP will be offline for the duration of the scan. You can click the name to get additional color‑coded level of interference (from green at -96 dBm details. UniFi Access Point – Users (sort)  You can click any column to sort the displayed list. Overview • Radio  Displays the radio being used. see “Client Details” on page 109 for more to red at -32 dBm). __  Displays the corresponding channel number for each channel width option. information. Name  Displays the hostname.4 GHz results are displayed in channel Signal  Displays the signal strength between the user widths of 20 and 40 MHz. TX Rate  Displays the transmit rate. (outlined)  The current channel is outlined. Last scan  Displays the duration of time since the last scan. Place your cursor over a channel option to view the All clients using this AP will be disconnected. • Interference  Displays the level of interference. or MAC address of the connected client and the name or SSID of the wireless Each bar graph represent a channel option and its network in use. __ MHz  The 2. 99 . RF Scan Details • Utilization  Displays the percentage of the frequency range already in use. • Channel Width  Displays the width of the channel. and 80 MHz. Ubiquiti Networks.

Name/WLAN  Displays the hostname. this range: -70 to -90 dBm). Transmit Power  By default the transmit power is set to Auto. Minimum RSSI  Disabled by default. the Minimum RSSI setting cannot be changed.Chapter 12: UniFi Access Point Details UniFi Controller User Guide UniFi Access Point – Guests Radios (sort)  You can click any column to sort the displayed list. • Medium  Halfway between High and Low. Auto. allowing it to reconnect with a more suitable AP. Inc. Select this option and enter a minimum threshold (we recommend a value in Save  Click Save to apply the change. You can click the guest name to get additional details. with SNR. You can also manually select the following: • High  The highest TX power available. Channel  Select the appropriate settings: • Auto/(channel number)  Select a channel number or UniFi Access Point – Configuration keep the default. Note: If the AP is part of a Zero Handoff WLAN Group. alias. Signal  Displays the signal strength between the guest and AP.) Select VHT20 for 20 MHz operation. If the client signal falls below the specified threshold. The Alias is also known as the host name.4 GHz only.) Select General HT20 for 20 MHz operation. then the Channel settings cannot be changed. • Low  The lowest TX power available. then the Channel settings cannot be changed. or VHT80 for 80 MHz operation in the 5 GHz band. Note: If the AP is part of a Zero Handoff WLAN Group. RSSI is synonymous Cancel  Click Cancel to discard changes. or MAC address of the connected guest and the name or SSID of the wireless network in use. Alias  Enter or edit the customizable name or identifier of the AP. Change device configuration settings. The selected column displays or to indicate ascending or descending order. or HT80 for 80 MHz operation in the 5 GHz band. then the AP kicks out the client. Note: If the AP is part of a Zero Handoff WLAN Group. • Custom  Custom setting that you specify in the field provided. • HT20/HT40/HT80  (Available for 2. For UniFi. • VHT20/VHT40/VHT80  (Available for 5 GHz only. . TX Rate  Displays the transmit rate. 100 Ubiquiti Networks. see “Client Details” on page 109 for more information. • Antenna Gain  (Only available for Outdoor models) Specify the antenna gain. HT40 for 40 MHz operation. VHT40 for 40 MHz operation.

Ubiquiti Networks. (You can cancel the changes of any section by clicking X of the appropriate section. Note: The Override option is not available for a Zero Handoff WLAN Group. Queue Changes  Click Queue Changes to save changes. WLANs You can deploy multiple wireless networks organized into WLAN groups on different APs. the Pending changes to the device and then apply them all at once Changes option appears in the Properties panel. over again when you change different sections of the configuration.) Cancel  Click Cancel to discard changes. Cancel  Click Cancel to discard changes. • Apply  Click APPLY to save changes. Overrides  Displays the SSID override information applied to the wireless network. Each section with pending changes is highlighted by an ellipsis. set the VLAN ID. 101 . click Apply Changes at the bottom of the screen. Inc. Click so that the device doesn’t have to re-provision over and to display the devices. When you are done with your changes. and enter the SSID override name to apply to the wireless network. Actions  Click a button to perform the desired action: • Edit  Click to enable a VLAN (Virtual Local Area Network). This allows you to make multiple multiple devices and then apply them later. • Discard  Click DISCARD to cancel changes. Name  Displays the network name or SSID of the available wireless network.UniFi Controller User Guide Chapter 12: UniFi Access Point Details Queue Changes  Click Queue Changes to line up the Pending Changes  If you want queue changes for changes to take effect. WLAN Group  Select the appropriate group.

specified will automatically appear in this field. Using DHCP • Using DHCP  The use of the Dynamic Host Configuration Protocol (DHCP) is the default. (You can cancel the changes of any section by clicking X of the appropriate section. the Pending Changes option appears in the Properties panel. Inc. The AP automatically acquires network settings from the network’s DHCP server. This allows you to make multiple changes to the device and then apply them all at once so that the device doesn’t have to re-provision over and over again when you change different sections of the configuration. (FQDN) without the hostname. Using DHCP or Static IP. • with VLAN ID  The VLAN ID is a unique value assigned -. Proceed to the appropriate instructions. Security Key  If the WPA-Personal security option has been applied to the WLAN under Settings > Wireless -. Each section with pending changes is highlighted by an ellipsis. -.Gateway  Enter the IP address of the gateway (for example. multiple devices and then apply them later. then the Pre-Shared Key (PSK) for the SSID example. • Reset to Defaults  Click Reset to Defaults to remove any overrides that were applied to the selected wireless -. to each VLAN on a single device.Apply  Click APPLY to save changes. Enter on the same corporate network. click Apply Changes at the bottom of the screen. For example.DNS Suffix  Enter the Fully Qualified Domain Name network. the following information: SSID  Enter the SSID override name to apply to the -.Discard  Click DISCARD to cancel changes. • Static IP  Assign fixed network settings to the AP.IP Address  Enter the IP address for the AP. When you are done with your changes. wireless network.) • Cancel  Click Cancel to discard changes. to display the devices.IP Address  Enter the IP address for the AP. you can use a different Static IP VLAN ID for each building while all of the VLANs remain • Static IP  Assign fixed network settings to the AP. Enter a value between 2 and 4095.Chapter 12: UniFi Access Point Details UniFi Controller User Guide Override • Queue Changes  Click Queue Changes to line up the changes to take effect. there are multiple buildings.Alternate DNS  Enter the IP address of the secondary DNS server. Enabled on this AP  Select the checkbox to enable the • Pending Changes  If you want queue changes for WLAN for use. in a large deployment where -.Gateway  Enter the IP address of the gateway (for Networks. -.Preferred DNS  Enter the IP address of the primary Actions  Click a button to perform the desired action: DNS server. Network • Cancel  Click Cancel to discard changes. -. -. • Queue Changes  Click Queue Changes to save changes. • Cancel  Click Cancel to discard changes. the UniFi Security Gateway). .Subnet Mask  Enter the subnet mask of the AP. Enter the following information: -. • Save  Click Save to apply changes. Configure IP  Select the Internet connection type for your service. -. Click Use VLAN  Select the checkbox to enable the VLAN.Subnet Mask  Enter the subnet mask of the AP. 102 Ubiquiti Networks. the UniFi Security Gateway).

This allows you to make multiple default WLAN group. you cannot override the 5 GHz SSID changes to the device and then apply them all at once name in one of the WLANs and still use band steering on so that the device doesn’t have to re-provision over and the other two WLANs. When you are done with your changes. so that the device doesn’t have to re-provision over and If the 2. • channel utilization metrics Off  Keep the default.4 GHz interference. if you have multiple WLANs in your changes to take effect.4 GHz band is DNS server. the UniFi band steering policy takes two criteria higher channel utilization threshold than the Steer to 5G into account: option.UniFi Controller User Guide Chapter 12: UniFi Access Point Details -. instead it is a function of two values: the 2. Each section with pending changes is band.4 GHz networks are typically more congested due to support of legacy clients and multiple sources of 2. section. This allows you to make multiple band is overloaded. Some dual-band clients are band-steering unfriendly for Prefer 5G  Select this option to steer clients to the 5 GHz various reasons and are marked as such by the AP. • Pending Changes  If you want queue changes for multiple devices and then apply them later. if you do not want to use band • signal quality measurements. The threshold is not a single value. by withholding probe responses. Off.4 GHz band is overloaded.4 GHz and 5 GHz • Queue Changes  Click Queue Changes to line up the bands. -. the client chooses a band. (You can cancel the the AP will send auth failure frames in response to auth changes of any section by clicking X of the appropriate requests from the client. the AP does not perform band changes to the device and then apply them all at once steering.Preferred DNS  Enter the IP address of the primary If the 5 GHz band is overloaded and the 2. configuration. Each section with pending changes is highlighted by an ellipsis.Alternate DNS  Enter the IP address of the secondary not a factor). Inc.DNS Suffix  Enter the Fully Qualified Domain Name all clients to 5 GHz. and UAP‑AC‑EDU models support band steering. The RSSI thresholds are 30 dBm or better for DNS server. Such band at a lower channel utilization threshold than the clients are not steered to any band even when conditions Balanced option.4 GHz channel Note: Only the UAP-PRO.4 GHz band (RSSI is -. UAP‑AC‑PRO. Band Steering 2. utilization and 5 GHz channel utilization. For example. not. instead. and the RSSI of the over again when you change different sections of the client is above the threshold for association on the 5 GHz configuration. -. The AP steers the client to the optimal band during Queue Changes  Click Queue Changes to line up the association (not after association). then the AP will steer the client to the 5 GHz band highlighted by an ellipsis. 103 . For example. UAP‑AC‑LITE. Band steering can help distribute the load on 2. All APs must use the same SSID for the 2.) Select this option to steer clients to the 5 GHz band channel at a If enabled. When you are done with your changes.4 GHz network has low utilization.) Ubiquiti Networks. (FQDN) without the hostname. would justify it. Balanced  (Not available for the UAP-PRO. click Apply If the client still attempts to associate on the 2.4 GHz and 5 GHz networks by steering dual-band clients to the 5 GHz band when appropriate.Apply  Click APPLY to save changes. click Apply Changes at the bottom of the screen. then the Steer to 5G option does not steer -. including RSSI steering.Discard  Click DISCARD to cancel changes.4 GHz band. the 5 GHz band. Click to display the devices. then clients are steered to the 2. All APs must use band steering – or over again when you change different sections of the none of them do. if the 2.) • Cancel  Click Cancel to discard changes. UAP‑AC‑LR. including Bluetooth devices. Changes at the bottom of the screen. (You can cancel the changes of any section by clicking X of the appropriate section. the Pending Changes option appears in the Properties panel. If both bands or neither changes to take effect.

Custom Upgrade  Click to upgrade the firmware from the location you entered. the Pending Changes option appears in the Properties panel. UAP‑AC‑PRO.Chapter 12: UniFi Access Point Details UniFi Controller User Guide Cancel  Click Cancel to discard changes. Inc. Each section with pending changes is highlighted by an ellipsis. 104 Ubiquiti Networks. To specify firmware saved in a custom location. firmware from the Ubiquiti website. This allows you to make multiple changes to the device and then apply them all at once so that the device doesn’t have to re-provision over and over again when you change different sections of the configuration. Forget This AP On/Off  Disabled by default. When you are done with your changes. Airtime Fairness Note: Only the UAP‑AC‑LITE. UAP‑AC‑LR. Click to display the devices. and UAP‑AC‑EDU models support airtime fairness. For firmware upgrades. Pending Changes  If you want queue changes for • Discard  Click DISCARD to cancel changes. • Apply  Click APPLY to save changes. click Apply Changes at the bottom of the screen. the UniFi devices retrieve the latest • Apply  Click APPLY to save changes. Queue Changes  Click Queue Changes to line up the changes to take effect. The Airtime Fairness option helps multiple users to share the bandwidth of a single AP.) Cancel  Click Cancel to discard changes. (You can cancel the changes of any section by clicking X of the appropriate section. the Pending Changes option appears in the Properties panel. Select On to enable this option. Pending Changes  If you want queue changes for multiple devices and then apply them later. . select this option. • Discard  Click DISCARD to cancel changes. multiple devices and then apply them later. (location URL)  Enter the UL of the firmware’s location. Click Custom Upgrade to display the devices.

in a Connected state. This AP doesn’t provide any wireless service. In an Isolated or Disconnected state. Note: Do not use the Forget this AP option when the AP is in an Isolated or Disconnected state. Version  Displays the version of software used on the AP. by wire. the Map tab displays the AP icon with a red/orange LED and disconnected  icon. When an AP is not connected by a wire. See the Wireless Wireless Uplinks Uplinks section to find. You can click the name to get additional details. Note: An AP can only uplink to another AP using the same radio band. and connect to a wired AP.UniFi Controller User Guide Chapter 12: UniFi Access Point Details Forget  Click Forget to remove the AP from management Access Point . Do not use the Forget option • Connect an Ethernet cable from the Secondary Ethernet when the AP is in an Isolated or Disconnected state. the potential Uplink AP. Channel  Displays the channel in use for wireless communication. Inc. If Port (if available) of the isolated AP to the Secondary you do. For example. The LED on the actual device will be steady green or blue with occasional flashing. Model  Displays the model number. alias. Last Seen  Displays the amount of time that has passed AP  Displays the hostname. the Wireless Uplinks section lists potential uplink APs that can be selected to establish a wireless connection. This will using one of three methods: restore the AP to factory default settings when it is • Reconnect the AP to the gateway/router. Overview MAC Address  Displays the MAC address of the AP. If you do. the only way to make the AP accessible from Ethernet Port (if available) of another UniFi AP that is the UniFi Controller is to take it down and connect connected to the gateway/router. or MAC address of since the Access Point was last seen. Ubiquiti Networks. Actions  Click a button to perform the desired action: • Select  Click to connect the wireless AP to the wired AP. Signal  Displays the percentage of signal strength. • Remove  Click to disconnect the wireless AP from the wired AP. • Establish a wireless uplink to a wired AP. you can default settings. 105 . the UAP-Outdoor 5G can only uplink to another UniFi AP using the 5 GHz radio band.Isolated/Disconnected by the UniFi Controller software and reset it to factory When an AP is in an Isolated or Disconnected state. re-establish a connection to the UniFi Controller software Note: Use caution when clicking Forget. then the only way to make the AP accessible from the UniFi Controller is to take it down and connect it by wire. select.

Model  Displays the model number. Last Seen  Displays the amount of time that has passed If you want to manage this AP using the UniFi Controller since the Access Point was last seen. Port  Displays SSH port of the AP. Adopt IP Address  Displays the IP address of the AP. 106 Ubiquiti Networks.Chapter 12: UniFi Access Point Details UniFi Controller User Guide Access Point . software. Inform URL  This tells the AP where to look for the UniFi Controller. Overview MAC Address  Displays the MAC address of the AP. then click Adopt on the Devices screen. Username  Enter the SSH Username for management access. MAC Address  Displays the MAC address of the AP. Inc. Adopt  Click Adopt to adopt the AP so you can manage it using the UniFi Controller software. This is the Device Password you configured in “Settings > Site” on page 20. Model  Displays the model number.Managed by Other Access Point . Last Seen  Displays the amount of time that has passed Version  Displays the version of software used on the AP. The URL will be automatically displayed but you may need to verify its accuracy as the system may have multiple interfaces. Version  Displays the version of software used on the AP. Controller. since the AP was last seen. Password  Enter the SSH Password for management access. This is the Device Username you configured in “Settings > Site” on page 20. .Pending Approval The Managed by Other state indicates that the AP is not The Pending Approval state indicates that the Access Point in the default state but it is not controlled by the UniFi is in the default state and is available for adoption. Cancel  Click Cancel to discard changes.

Model  Displays the model name of the Phone. -. Overview Remove All  Click to close the Properties panel. -. (The icon on the Map separate popup window. The Phone will Details window either in the Properties panel or as a ring until you click Locate again. a popup within this panel.) in the Properties panel or detach it as a separate window. running without interruption. Click the properties icon to re-open it. available for adoption. 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. Ubiquiti Networks. Information about each selected device appears as • Close Properties  Click to close the device popup. please download the UniFi VoIP Controller are pending changes. (This icon Important: For management of the UniFi VoIP does not appear if an upgrade is not available or there Phones. • Upgrade  Click to upgrade the device. 107 . Hide Property Panel  Click to hide the Properties panel but allow the device popups to remain accessible from this panel.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.UniFi Controller User Guide Chapter 13: UniFi VoIP Phone Details Chapter 13: UniFi VoIP Phone • Name/MAC Address  Displays the device name or MAC address of the device. • (icon)  Displays the icon of the device (the icon will vary Version  Displays the version number of the Phone’s depending on the model). -. screen. • Locate  Click to ring the Phone and flash the Phone’s A UniFi VoIP Phone hyperlink opens the UniFi VoIP Phone’s icon on the Map tab so you can locate it. IP Address  Displays the IP address of the Phone. -. You can always dock this window tab will flash three times and stop.Pending Approval  A solid orange circle indicates Uptime  Displays the duration of time the Phone has been the default state.com/unifi • Undock from Properties Panel  Click to display the Properties same information in a separate popup screen that can The Properties panel appears on the right side of the be moved anywhere within the browser screen. • (status)  Displays to indicate the device status.ubnt. firmware.Disconnected  A red warning icon ! indicates no connection. Collapse All  Click to collapse all of the popups to rows. Inc. • Display  Click to display the device information. MAC Address  Displays the MAC address or unique The top of the popup remains and displays the following: hardware identifier of the Phone. Details • Restart  Click to restart the selected device.Connected  A solid green circle indicates a managed connection.) here: downloads.

Inc. 108 Ubiquiti Networks. Forget This Phone Forget  Click Forget to remove the Phone from management by the UniFi Controller software and reset it to factory default settings.Chapter 13: UniFi VoIP Phone Details UniFi Controller User Guide UniFi VoIP Phone – Configuration Click Configuration to reset the Phone to its factory default settings. . This will restore the Phone to factory default settings when it is in a Connected state. Note: Use caution when clicking Forget.

You can click o kick out a client. which usually reconnects back quickly. Uptime  Displays the duration of time the client has been The top of the popup remains and displays the following: connected. • Close Properties  Click to close the device popup. MAC Address  Displays the MAC address or unique hardware identifier of the client. or click for guests pending in the Properties panel or as a separate popup window. You can click the name to get • Name/MAC Address  Displays the hostname. network. this is useful for troubleshooting or resolving a problematic wireless connection. authorization. Device Type  Displays the type of device. same information in a separate popup screen that can The top of the window displays the device icon and name be moved anywhere within the browser screen. Hostname  Displays the customizable name or identifier of the client. alias. Collapse All  Click to collapse all of the popups to rows. Information about each selected device appears There are four clickable tabs: as a popup within this panel. Click the properties icon to re-open it. address of the UniFi AP. You can always dock this window in the Properties panel or • Undock from Properties Panel  Click to display the detach it as a separate window. • Display  Click to display the device information. 109 . The information varies depending on whether the client is wired or wireless: • Details • Wireless Client – Details • Statistics • “Wired Client – Details” on page 111 • History • Configuration Wireless Client – Details Remove All  Click to close the Properties panel. or MAC • (icon)  Displays the icon of a wireless or wired device. or additional details. Ubiquiti Networks. • Reconnect  Click to reconnect a wireless client.) Click to remove authorization of guest access and A client hyperlink opens the client’s Details window either disconnect the guest. page 95 for more information. (or MAC address). alias. IP Address  Displays the IP address of the client. Hide Property Panel  Click to hide the Properties panel Properties but allow the device popups to remain accessible from The Properties panel appears on the right side of the this panel. • Block  Click to block this client from accessing the ESSID  Displays the name of the wireless network. Connected AP  Displays the hostname. screen. Inc.UniFi Controller User Guide Chapter 14: Client Details Chapter 14: Client Details • Unauthorize/Authorize  (Available for Guests only. see “UniFi Access Point Details” on MAC address of the device.

downloaded as packets. Channel  Displays the channel being used. downloaded as bytes. 110 Ubiquiti Networks. or descending order. Up Pkts/Bytes  Displays the amount of data uploaded as Wireless Client – History packets and bytes. RX Rate  Displays the receive rate. Date/Time  Displays the date and time of the connection.Chapter 14: Client Details UniFi Controller User Guide Wireless Client – Statistics Deep Packet Inspection The Deep Packet Inspection information is available if the Overview DPI feature is enabled (refer to “Settings > Site” on page 20 for more information). Down Pkts/Bytes  Displays the amount of data Packets  Displays the amount of data uploaded and downloaded as packets and bytes. Inc. Down  Displays the total amount of data downloaded by the client. The selected column displays or to indicate ascending TX Rate  Displays the transmit rate. Up  Displays the total amount of data uploaded by the client. Power Save  Displays the status of the power save mode. . Bytes  Displays the amount of data uploaded and Activity  Displays the level of activity in Bytes per second. Signal  Displays the percentage of signal strength (sort)  You can click any column to sort the displayed list. Duration  Displays the duration of the connection. between the AP and client. Application  Displays the name of the application.

If you want Down Pkts/Bytes  Displays the amount of data the local DHCP server to assign an IP address to the client.UniFi Controller User Guide Chapter 14: Client Details Wireless Client – Configuration Wired Client – Details Config MAC Address  Displays the MAC address or unique hardware identifier of the client. • IP Address  Enter the local IP address. Fixed IP  Select this option to assign a static IP address to the client. Ubiquiti Networks. Once saved. Alias  Allows you to change the hostname of the client. remove the checkmark. Hostname  Displays the customizable name or identifier of the client. page 34 for more information). drop-down list. downloaded as packets and bytes. Apply  Click Apply to save changes. client on the Insights > Known Clients tab. the client will be designated as a “Noted” Device Type  Displays the type of device. Up Pkts/Bytes  Displays the amount of data uploaded as • Network  Select the appropriate network from the packets and bytes. IP Address  Displays the local IP address of the client. The default User Group is Automatic. Note  Allows you to enter comments about the client. Port  Displays the name and port of the UniFi device being used by the client. 111 . User Groups are set up under the Settings tab > connected. additional details on the UniFi device. IP Config Wired Client – Statistics Overview Activity  Displays the level of activity in Bytes per second. User Group  Allows you to assign the client to a User Uptime  Displays the duration of time the client has been Group. You can click the name to get Save  Click Save to apply changes. Inc. User Groups option (see “Settings > User Groups” on Network  Displays the network used by the client. and configure the settings below.

remove the checkmark. • Network  Select the appropriate network from the drop-down list. Alias  Allows you to change the hostname of the client. Up  Displays the total amount of data uploaded by the client. Once saved. 112 Ubiquiti Networks. Apply  Click Apply to save changes. Duration  Displays the duration of the connection. (sort)  You can click any column to sort the displayed list. the client will be designated as a “Noted” Application  Displays the name of the application. User Groups are set up under the Settings tab > Bytes  Displays the amount of data uploaded and User Groups option (see “Settings > User Groups” on downloaded as bytes. Note  Allows you to enter comments about the client. • IP Address  Enter the local IP address. and configure the settings below. . Wired Client – History Save  Click Save to apply changes. Packets  Displays the amount of data uploaded and User Group  Allows you to assign the client to a User downloaded as packets. Down  Displays the total amount of data downloaded by the client. Group. Inc. client on the Insights > Known Clients tab. Fixed IP  Select this option to assign a static IP address to the client. page 34 for more information). The default User Group is Automatic. IP Config Date/Time  Displays the date and time of the connection. If you want the local DHCP server to assign an IP address to the client.Chapter 14: Client Details UniFi Controller User Guide Deep Packet Inspection Wired Client – Configuration The Deep Packet Inspection information is available if the Config DPI feature is enabled (refer to “Settings > Site” on page 20 for more information). The selected column displays or to indicate ascending or descending order.

Authorized By. 30 days. 2 weeks. Amount. and click Go to Hotspot Manager. To access the Hotspot Manager. or Status value. Search   Enter keywords in the Search If there is more than one page of entries to display. For https://unifi. Ubiquiti Networks. Guests Guests The Hotspot’s active guests are displayed. and 120 days. Name  Displays the guest’s device name or MAC address.UniFi Controller User Guide Chapter 15: Hotspot Manager Chapter 15: Hotspot Manager If you create a bookmark for the Hotspot Manager. right of the screen to display different pages. you can click any of the column headers 7 days. ensure that you include the site name in the URL. 113 .yourdomain. or 200. On any sub-tab. Show  Filter by time duration: last 24 hours. Operator accounts will have access to three tabs after login: Guests. 50. and Vouchers. “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. See or descending order. (sort)  You can click any column to sort the displayed list. Operator accounts are designed for use by hotels or other businesses to service guests and have no access to other UniFi administrative features. to change the list order. 100.com:8443/hotspot/s/site_name details on a specific tab. go to Settings > The selected column displays or to indicate ascending Guest Control. Inc. which should be The Hotspot Manager includes four main tabs when in this format: accessed by the UniFi Controller super admin account. the navigation controls or page numbers at the bottom Package. “Hotspot” on page 30 for more information. refer to the appropriate section. Items per page  Select how many results are displayed   per page: 10. click field to find a specific guest based on Name/MAC Address. 3 days. Payments.

Create Vouchers  To create a batch of vouchers. If the user paid by an Notes. Actions  Click a button to perform the desired action: • Disconnect  Immediately disconnect the selected guest. Duration. Authorized By  Displays the authorization method. downloaded. If you select User-defined. The selected column displays or to indicate ascending or descending order. alternative method such as PayPal. enter a number and specify day. Enter the maximum in megabytes. 7 days. • Bandwidth Limit (Download)  Select to limit the download bandwidth. Extra Info. or Status value. Amount. four digits of the credit card used. minute. Search   Enter keywords in the Search field to find a specific voucher based on Time. and use restrictions. if you click it three times. Package  Displays the description of the package. 24 hours. or hour. . 30 days. (sort)  You can click any column to sort the displayed list. or Status value. Time  Displays the date and time of the transaction. Name. Actions  Click a button to perform the desired action: Amount  Displays the amount paid for access (if • Refund  Refund the selected customer if necessary. purchased (if applicable). For example. Create vouchers that include distributable codes. • One time/Multi-use  Select how often the voucher can be used: One time or for Multi-use. Displays Expired if there is no remaining session time. If Vouchers there is no authorization. • Save  Click Save to create the vouchers as specified. or User‑defined. 4 days. • Expiration Time  Select how long the voucher is valid: 8 hours. 3 days. you will extend guest access for three more days. Inc. then None is displayed. applicable). Enter the maximum in Kbps. 2 days. • Bandwidth Limit (Upload)  Select to limit the upload bandwidth. the Extra Info field may display information such as the email address associated with the PayPal account. Last Name  Displays the user’s last name. First Name  Displays the user’s first name. Payments and Transactions The Hotspot’s payments and transactions are displayed.Chapter 15: Hotspot Manager UniFi Controller User Guide Package  Displays the description of the package that was Status  Displays the status of the transaction. Upload  Displays the total amount of data uploaded. duration Download  Displays the total amount of data values. Amount  Displays the amount of the transaction. Extra Info  If the user paid by credit card. • Extend  Extend a guest’s session for an additional 24 hours. the Extra Info Search   Enter keywords in the Search box field will display the type of credit card and the last to find a specific voucher based on Code. • Byte Quota  Select to limit the amount of data transfer Show  Filter by time duration: last 24 hours. allowed per session. Start Time  Displays the start time of the guest access. Enter the maximum in Kbps. 114 Ubiquiti Networks. Create Time. 7 days. Status  Displays the remaining session time for the guest. • Notes  Enter any notes specific to this batch of vouchers. Package. 2 weeks. 3 days. and 120 days. • Cancel  Click Cancel to discard changes. click ?? and complete the following: • Create __  Enter the number of vouchers to create.

115 . • Account Name  Enter a name for the operator. Password  Displays the password. the username and password in the appropriate fields and click Sign In. hours. Byte Quota  Displays the maximum amount of data transfer allowed per session. or 0-9. a-z. Enter until expiration for multi-use vouchers. characters can only be printable ASCII characters. Search   Enter keywords in the Search field to find a specific operator account based on Name. Spaces and or descending order. Payments. Duration  Displays the duration of minutes. operator credentials. Displays the number of times used and time The UniFi Hotspot Manager login screen will appear. Create Time  Displays the date and time a voucher was created. (sort)  You can click any column to sort the displayed list.yourdomain. Down  Displays the maximum download bandwidth allowed. Inc. Operator Accounts (Only available for admins with read/write access to the UniFi Controller). Name  Displays the name of the operator. The other of unused vouchers. Code  Displays each active voucher code.UniFi Controller User Guide Chapter 15: Hotspot Manager (sort)  You can click any column to sort the displayed list. A tab will open with the vouchers ready for printing. to retrieve. ensure that the voucher enables the user to access the Internet. Actions  Click a button to perform the desired action: • Print  Click PRINT to print an individual voucher. that you include the site name in the URL. symbols are allowed but not recommended. Select the date with time of the batch you want • Save  Click Save to create the new operator account. Print all Unused Vouchers  Click PRINT ALL UNUSED VOUCHERS to • Password  Enter a password for the operator. and Vouchers tabs will appear. Notes  Displays any notes that were added using the Open Operator Login  Click OPEN OPERATOR LOGIN to test the Notes option during voucher creation. Up  Displays the maximum upload bandwidth allowed. • Revoke  Click REVOKE to immediately deactivate the selected voucher. Displays Expired if the voucher is no longer valid.com:8443/hotspot/s/site_name use or multiple uses. and vouchers. payments or transactions. a-z. Notes  Displays any descriptive notes. The The selected column displays or to indicate ascending Account Name should use A-Z. Print Batch  A batch is a group of vouchers created at the • Notes  (Optional) Enter a note to identify or describe the same time. or Notes value. Click PRINT BATCH to display a list of dates with operator. The selected column displays or to indicate ascending or descending order. click and complete the following: Actions  Click a button to perform the desired action: • Delete  Click to remove an operator account. • Cancel  Click Cancel to discard changes. Ubiquiti Networks. Create Operator Accounts that can log in to Hotspot Manager to manage guests. Password. The send a page to your printer with the codes and durations Password has to start with A-Z. Only the Guests. or 0-9. or days If you create a bookmark for the Hotspot Manager. which should be in this format: Status  Indicates whether the voucher is valid for a single https://unifi. Create New Operator  To create a new operator account. times.

.Chapter 15: Hotspot Manager UniFi Controller User Guide 116 Ubiquiti Networks. Inc.

landing page options: No authentication. Legacy JSP is fully customizable and uses old HTML. Click Apply Changes. However. the UniFi Controller software allows Legacy JSP. Note: AngularJS is not compatible with old templates because the old templates were designed to work with JSP (Java Server Pages). AngularJS AngularJS is the new option for client-side rendering. keep the default. Legacy JSP Legacy JSP is the pre-existing option for server-side rendering. so it should work with any web browser. Ubiquiti Networks. complete branding of a portal implementation. Legacy JSP works more slowly and is not responsive by default. We recommend AngularJS unless you are using old templates. simply reload changes from any browser. perform the following steps: Legacy JSP 1. select an authentication method. you have two options for portal customization: AngularJS and Legacy JSP. and Hotspot. You can customize Legacy JSP only by overriding files. For the Override Default Templates setting. 117 . Simple Password. Testing is simple and immediate. AngularJS uses responsive design. The UniFi Controller offers a built-in editor to customize AngularJS. In order to provide the maximum flexibility in your branding effort. Select Enable Guest Portal to enable it. so it will adapt to the size of a mobile device. and then this time. which 27 for more information on enabling the may not work with some really old web browsers or newer Guest Portal for the following authentication and browsers with JS support disabled. allowing 4. Go to Settings and click Guest Control. had developed it yourself. Appendix A: Portal Customization with Legacy JSP is for Legacy JSP implementation only.UniFi Controller User Guide Appendix A: Portal Customization with Legacy JSP Appendix A: Portal Configuring Portal Customization To enable the guest portal with custom Legacy JSP Customization with branding. With Legacy JSP. Overview 3. the UniFi Controller software provides total access to the portal directory on the system in which it is installed. it is not fully customizable at 2. AngularJS uses JS (JavaScript). Before You Begin Starting with UniFi v5. 5. select you to “white label” your wireless Internet service as if you Override templates with custom changes. AngularJS is a single-page app. For the Template Engine setting. This open architecture allows you to include unlimited content while keeping development simple through the use of plain . See “Settings > Guest Control” on page 27 for more information about the built-in editor for AngularJS.html (hand code or use any editor of your choice). however. Inc. such as a tablet or smartphone. so it should work more Note: See “Settings > Guest Control” on page quickly.

Appendix A: Portal Customization with Legacy JSP UniFi Controller User Guide

Viewing the Default Portal Mac
Once Guest Portal and Override Default Templates are 1. Navigate to Go > Applications.
enabled, connect to the Guest Network SSID as shown
below, depending on your platform.
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. 2. Control-click the UniFi application and then click Show
3. Depending on the security type applied to the Package Contents.
network, enter the security key or password. Click OK
or Connect.
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 3. Double-click the Contents folder to open it.
side of the screen).
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 4. Double-click the Resources folder to open it.
portal pages by authentication method).

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 Ubiquiti Networks, Inc.

UniFi Controller User Guide Appendix A: Portal Customization with Legacy JSP

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, double‑click 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.

Ubiquiti Networks, Inc. 119

Appendix A: Portal Customization with Legacy JSP UniFi Controller User Guide

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
customer’s 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 Ubiquiti Networks, Inc.

UniFi Controller User Guide Appendix B: UniFi Discovery Utility Appendix B: UniFi Discovery UniFi Discovery Utility Interface Upon launch. Model  Displays the model name of the AP. It is installed automatically as part of the UniFi Controller software installation process. Status  Displays the current status of the AP: Pending. specified. Version  Displays the firmware version installed on the AP. 121 . click one of the buttons listed above and proceed to “Reboot” on page 123. or IP Unreachable. Managed/Adopted. There are three buttons available: PC Users • “Locate” on page 122 For most versions of Windows. the UniFi Discovery Utility listens to Layer-2 Utility broadcast/multicast beacons from UniFi APs in both a factory default state and an unmanaged state (adopted Overview but unable to contact the UniFi Controller software). See “Software Installation” on page 1 for more information. see “UniFi Access Point – Configuration” on page 100 for details. For Windows 8.app icon. The Ubiquiti UniFi Discovery Utility includes tools that allow the discovery and management of UniFi APs. • “Manage” on page 122 • “Reset” on page 123 Note: To reboot the AP. go to Start > All Programs > Ubiquiti UniFi and double‑click the UniFi-Discover icon. Inc. click Go > Applications and double-click the AP. Ubiquiti Networks. 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. Login Failed. The alias is displayed in parentheses if it has been the UniFi-Discover. Launching the UniFi Discovery Utility Mac Users MAC Address  Displays the MAC address and alias of From the Finder. go to the Start menu and double‑click the UniFi-Discover icon.

enter the device username. Apply  Click Apply to save the inform URL. Set Inform URL  Enter the URL. enter the device password. enter the device username.Appendix B: UniFi Discovery Utility UniFi Controller User Guide Locate Manage Locate the AP. enter the device password. allowing the AP to be managed by the UniFi Controller software running in a NOC or in the cloud. flash so that it can be differentiated from the other APs. Username  If required. Actions  If you clicked the Manage button. and path to the UniFi Controller software. Password  If required. (See “Network Topology Requirements” on page 1 for a visual representation of this configuration. The LED on the AP will automatically selected. port. . Username  If required. then Locate is automatically selected. The following window will appear: Set the inform URL.) The following window will appear: Actions  If you clicked the Locate button. Password  If required. Inc. then Manage is Apply  Click Apply to locate the AP. 122 Ubiquiti Networks.

click any of the buttons (Locate. enter the device password. Password  If required. Username  If required. enter the device password. settings. The following window will appear: Actions  If you clicked the Reset button. window will appear: or Reset) on the UniFi Discovery Utility screen. The following To reboot the AP. Manage. Ubiquiti Networks.UniFi Controller User Guide Appendix B: UniFi Discovery Utility Reset Reboot Reset the AP to factory default settings. Username  If required. Actions  Select Reboot from the drop-down menu. enter the device username. Password  If required. Apply  Click Apply to reset the AP to factory default Apply  Click Apply to reboot the AP. then Restore to factory default is automatically selected. enter the device username. Inc. 123 .

Inc.Appendix B: UniFi Discovery Utility UniFi Controller User Guide 124 Ubiquiti Networks. .

Go to “Controller Mode” on page 128.3231 or higher • A compatible Android or iOS device The following instructions describe the iOS version of the 4. tap . 125 . Tap the UniFi AP app. Select the functionality you want to use: • Controller mode  Use the app to access the UniFi Controller. 5. The app will search for new devices. Go to step 3. Download the UniFi App from the App Store (iOS) or Google Play™ (Android). Basic Setup You can set up any UniFi AP. • I don’t have a controller  Use the app to manually provision a UniFi device for basic functionality without configuring a UniFi Controller. • You can use a mobile device to provision a UniFi AP • Continue  If you do not want to back up or restore for basic functionality without configuring a UniFi configurations. however. tap The UniFi app has two general functions: Register.4. Tap Log In. Overview • Register  To register for an SSO account. Continue. Requirements • An Ethernet connection from the UniFi AP to the LAN with DHCP • Firmware version 3.UniFi Controller User Guide Appendix C: UniFi Mobile App Appendix C: UniFi Mobile App 3. Ubiquiti Networks. 6. 1. you can skip the login and tap Controller. Go to the Basic Setup section below. the Android version is similar. and use one of the following options: • Log In  Enter the Username and Password of your Ubiquiti Single Sign-On (SSO) account. Tap Scan QR Code. 2. on the device list and go to step 8.4. Go to “Controller Mode” on page 128. Inc. Launch the app. If a new device is not detected. • You can use a mobile device to access the UniFi Controller.

or tap Connected Clients  Displays the number of clients Enter ID Manually to type the case‑sensitive MAC connected to this UniFi AP. connected to this UniFi AP. device’s firmware. For iOS. • Traffic  Displays the total amount of data downloaded and uploaded by the client. automatically connects to the helper SSID. Configure  To manage the device. Tap to display additional details: Device • Uptime  Displays the duration of time the device has The Device screen displays basic status information: been running without interruption. MAC Address  Displays the MAC address or unique hardware identifier of the device. download traffic. Transmit Power  Displays the level of transmit power. SSID  Displays the wireless network name. Blocked Clients  Displays the number of blocked clients. manually copy and paste the helper SSID Traffic In/Out  Displays the amount of upload and and password. • RSSI  Displays the SNR of the connection. Note: For Android. Connected Clients  Displays the number of clients Go to the Device section below to set up the UniFi AP. Overview IP Address  Displays the IP address of the device. Inc. address. Scan the QR code on the back of the UniFi AP. Clients 8.Appendix C: UniFi Mobile App UniFi Controller User Guide 7. Please proceed with the upgrade. 126 Ubiquiti Networks. . Channel  Displays the channel used. the mobile device Encryption  Displays Encrypted. • Unblock this client  Tap to allow this client access to the Radio 2G network. go to the Configure section in the next column. You may be prompted to upgrade the UniFi AP to the latest firmware. • Block this client  Tap to block this client from accessing the network. Firmware Version  Displays the version number of the Tap to display a list of blocked clients.

from the list. • TX Power  The default is Auto. • Channel  Select a channel number or keep the default. Medium. Low. or • (channel width)  Select the appropriate channel width. • TX Power  The default is Auto. • Enabled  Enable or disable wireless functionality. Radio Settings Auto. Medium. • (channel width)  Select the appropriate channel width.UniFi Controller User Guide Appendix C: UniFi Mobile App Configure WLAN Settings • Select your country  Select the appropriate country • Name/SSID  Enter the name of the wireless network. or Low. Select High. Auto. Select High. • Security Key  Enter the passphrase. 127 . • Security  Select the security method you want to use. 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. Inc. Ubiquiti Networks.

You can access the UniFi Controller through the UniFi mobile app. • I don’t have a controller  Use the app to manually provision a UniFi AP for basic functionality without configuring a UniFi Controller. the next column. Note: For advanced configuration. • Secure Shell (SSH) Login Username  Change the username of the device login. • Automatic Configuration Backup  Enable or disable automatic backup of the current configuration. Download the UniFi App from the App Store (iOS) or Google Play (Android).Appendix C: UniFi Mobile App UniFi Controller User Guide WLAN Settings • Restore  Restore the previously saved configuration. • Security  Select the security method you want to use. • Same as 2G?  Tap to use the same settings as the • Change mode  Select this option if you want to change 2.4 GHz configuration. switch to Controller mode. Controller Mode • Apply Settings  Tap to save your changes. • Security Key  Enter the passphrase. to Controller mode.4. • Enabled  Enable or disable wireless functionality. • SSH Login Password  Change the password of the device login. . Requirements • An Ethernet connection from the UniFi device to the LAN with DHCP • Firmware version 3. Select the functionality you want to use: Settings • Controller mode  Use the app to access the UniFi The Settings screen offers the following options: Controller. • SSO Password  Change the password of the SSO account.4. • Country Code  Change the country selection. Go to step 3. 128 Ubiquiti Networks. 2. • Single Sign-On (SSO) Username  Change the username of the SSO account. Go to “Basic Setup” on page 125. • Back Up Now  Back up the current configuration. Go to the Controller Mode section in • Name/SSID  Enter the name of the wireless network. Inc.3231 or higher • A compatible Android or iOS device 1.

• Remember username and password  Tap this option if you want the app to remember your username and password. LAN (status)  Displays one of the following: • OK  The node is active. • Unknown  There is no UniFi Security Gateway. • Error  There is an error. • Error  There is an error. Controller. Enter the following information: The UniFi app includes four tabs: • (IP address)  Enter the IP address of the UniFi • “Dashboard” on page 129 Controller. You adopted but not active. Tap Connect. can change it now and then tap OK.UniFi Controller User Guide Appendix C: UniFi Mobile App 3. please investigate further. please investigate further. 4. or you can tap Not Pending  Displays the number of Gateway devices Now to skip this step. • Warning  There is a warning. 129 . • “Devices” on page 130 • (port)  Enter the appropriate port number. • Warning  There is a warning. Inc. Ubiquiti Networks. please investigate further. which is • “Clients” on page 135 typically 8443. • (password)  Enter your password for the UniFi Controller. Pending  Displays the number of wired devices pending adoption. pending adoption. • Unknown  There is no UniFi AP. The Dashboard screen provides an overview of your • (username)  Enter your username for the UniFi network’s status. • Error  There is an error. • Warning  There is a warning. • “Settings” on page 137 Note: If you do not know the IP address. WAN (status)  Displays one of the following: • OK  The node is active. please investigate further. WLAN (status)  Displays one of the following: • OK  The node is active. please investigate further. you can tap Find to detect a UniFi Controller and then Dashboard select it. • Unknown  There is no UniFi Switch. You may be prompted to enter a descriptive name for Inactive  Displays the number of Gateway devices the Controller if it is currently using an IP address. please investigate further. Inactive  Displays the number of wired devices adopted but not active.

Unknown is displayed if there is no UniFi Security Gateway. • MAC Address  Displays the MAC address or unique hardware identifier of the device. Tap a device for configuration or details. WLAN  Displays the number of wireless devices. status. page 133. go to “Configure” on Security Gateway. hostname. Users  Displays the number of connected users. Phones  Displays UniFi VoIP Phones only. APs  Displays UniFi APs only. Unknown is displayed if there is no UniFi • Configure  To manage the device. • Firmware Version  Displays the version number of the device’s firmware. • Uptime  Displays the duration of time the device has been running without interruption. . GW/Switch  Displays Gateway and Switch devices only. The Devices screen displays a list of UniFi devices Pending  Displays the number of APs pending adoption. Throughput Up  Displays the amount of current upload • IP Address  Displays the IP address of the device. Scroll down the Dashboard screen to view additional status information. WAN  Displays the number of Gateway devices. Guests  Displays the number of connected guests.Appendix C: UniFi Mobile App UniFi Controller User Guide Inactive  Displays the number of APs adopted but not Devices active. All  Displays all device types. Details include Devices the model number. and connection duration. Throughput Down  Displays the amount of current Overview download traffic. Clients Clients  Displays the total number of clients. Devices  Displays the total number of devices. traffic. 130 Ubiquiti Networks. Inc. Unknown is displayed if there is no UniFi Security Gateway. LAN  Displays the number of wired devices. discovered by the UniFi Controller. Latency and Throughput Note: The Latency and Throughput values require a UniFi Security Gateway. Latency  Displays the amount of time it takes a packet to travel from the UniFi Security Gateway to the service provider’s gateway.

Activity level. Inc. go to the Overview section below for more information. and the AP will be offline for the duration of the scan. 131 . connection duration.) Tap this • Users  Displays a list of connected users. go to the Note: The RF scan may take more than five Overview section below for more information. • Guests  Displays a list of connected guests. and Scan again to continue. Activity level. Ubiquiti Networks. including -. Tap a guest for details. minutes. -. and connection and planning.2G/5G  Select the frequency band you want to analyze. duration. including SSID option for spectral analysis to help in channel selection (wireless network name).UniFi Controller User Guide Appendix C: UniFi Mobile App • RF Environment  (Available only for UAP‑AC‑LITE. and UAP‑AC‑EDU.Scan  Tap Scan to trigger an RF scan and then tap SSID (wireless network name). Connected Clients UAP‑AC‑LR. UAP‑AC‑PRO. Tap a user for details. All clients using this AP will be disconnected.

-. -. • Uptime  Displays the duration of time the client has -. channel being used. alias. -. Inc.) Displays the -. connection. -. downloaded as bytes.Signal  (Available for wireless clients.Bytes Up  Displays the amount of data uploaded as been connected without interruption. • MAC Address  Displays the MAC address or unique -. 132 Ubiquiti Networks.Connection  Displays the hostname. alias.(down/up)  Displays the total amount of data -.Bytes Down  Displays the amount of data address of the UniFi device the client is connected to. bytes.RX Rate  Displays the receive rate. • Connection  Displays the hostname. . or MAC -.) Displays the percentage of signal strength between the AP and client. -.Activity  Displays the level of activity in Bytes per second.ESSID  (Available for wireless clients. -.TX Rate  Displays the transmit rate. -.(date/time)  Displays the date and time of the name of the wireless network.Power Save  Displays the status of the power save mode. or MAC -.Channel  (Available for wireless clients.(duration)  Displays the duration of the connection.Packets Down  Displays the amount of data • IP Address  Displays the IP address of the client. -.Appendix C: UniFi Mobile App UniFi Controller User Guide Overview -.Packets Up  Displays the amount of data uploaded as hardware identifier of the client.) Displays the downloaded and uploaded by the client. downloaded as packets. • Statistics  Displays additional client information: • History  Displays the historical usage of a client. address of the UniFi device the client is connected to. packets.

Note: If the AP is part of a Zero Handoff WLAN Group.UniFi Controller User Guide Appendix C: UniFi Mobile App Actions -. For UniFi. If the client signal falls below the specified threshold. • Restart  Tap to restart the selected device. then the AP kicks out the client. then the Channel setting cannot be changed. Inc. The LED will flash until Locate is tapped again. allowing it to reconnect with a more suitable AP. 133 . RSSI is synonymous with SNR. Ubiquiti Networks. Note: If the AP is part of a Zero Handoff WLAN Group. • Alias  Also known as the host name. • Radios  These settings are available only for APs. the Minimum RSSI setting cannot be changed. You can locate or restart the device. -. Configure -. Enter or edit the customizable name or identifier of the device.TX Power  Select the appropriate transmit power value. The default is Auto. Select this option and enter a minimum threshold (we recommend a value in this range: -70 to -90 dBm). RSSI  Disabled by default.Channel  Select the appropriate channel number and channel width. • Locate  Tap to flash the LED on the device.Min.

• DNS Suffix  Enter the Fully Qualified Domain Name -. • Security Key  If the WPA-Personal security option has been applied to the WLAN under Settings > Wireless Networks. Inc. screen appears. you can use a clients to the 5 GHz band when appropriate.4 GHz networks are typically more • Use VLAN  Tap to enable the VLAN. The VLAN ID is a unique value assigned to sources of 2.4 GHz interference. -. • Gateway  Enter the IP address of the gateway (for example. UAP‑AC‑LITE. Then enter the congested due to support of legacy clients and multiple VLAN ID.Using DHCP  The use of the Dynamic Host Configuration Protocol (DHCP) is the default.Appendix C: UniFi Mobile App UniFi Controller User Guide • WLAN  These settings are available only for APs. The WLAN Override (FQDN) without the hostname. The AP automatically acquires network settings from the network’s DHCP server. 134 Ubiquiti Networks. Band steering can help distribute the load on 2 and 4095. .) 2. UAP‑AC‑PRO. For example.Static IP  Assign fixed network settings to the AP. Enter a value between devices. different VLAN ID for each building while all of the VLANs remain on the same corporate network. UAP‑AC‑LR.WLAN Group  Select the appropriate group. in a large deployment 2. • Alternate DNS  Enter the IP address of the secondary DNS server. including Bluetooth each VLAN on a single device. • Subnet Mask  Enter the subnet mask of the AP. Enter the following information: • IP Address  Enter the IP address for the AP. UAP‑AC‑EDU. then the Pre-Shared Key (PSK) for the SSID specified will automatically appear in this field. • Band Steering  (This setting is available only for the • Enabled on This AP  Tap to enable the WLAN for UAP‑PRO. • SSID  Enter the SSID override name to apply to the wireless network. • Network  Select the appropriate option: -. and use.(SSID)  Tap to override settings. the UniFi Security Gateway).4 GHz and 5 GHz networks by steering dual-band where there are multiple buildings. -. • Preferred DNS  Enter the IP address of the primary DNS server.

Tap a client for than the Balanced option. the only way to make the AP accessible from the UniFi Controller is to take it down and connect by wire. If you do. or MAC • Forget  Tap Forget to remove the AP from management address of the UniFi device the client is connected to.Balanced  (Not available for the UAP-PRO. Note: Use caution when tapping Forget. and connection duration. alias.) This helps multiple users to share the bandwidth of a single AP. 135 .Prefer 5G  Select this option to steer clients to the include the hostname. and UAP‑AC‑EDU. if you do not want to use Clients band steering. • Airtime Fairness  (This setting is available only for the UAP‑AC‑LITE.Off  Keep the default. instead it is a function of two values: You can filter by connection type: the 2. SSID (wireless network name). 5 GHz band at a lower channel utilization threshold Activity level. been connected without interruption. Tap to enable this option.UniFi Controller User Guide Appendix C: UniFi Mobile App -. • MAC Address  Displays the MAC address or unique hardware identifier of the client. UAP‑AC‑PRO. option to steer clients to the 5 GHz band channel at a Wired  Displays wired clients only. All  Displays all connection types. by the UniFi Controller software and reset it to factory • Uptime  Displays the duration of time the client has default settings. Overview • IP Address  Displays the IP address of the client. Details -. Do not use the Forget option when the AP is in an Isolated or Disconnected state. This will restore the AP to factory default settings when it is in a Connected state. higher channel utilization threshold than the Steer to 5G option. -. Inc.4 GHz channel utilization and 5 GHz channel utilization. UAP‑AC‑LR. The Clients screen displays a list of network clients. • Connection  Displays the hostname. Off. single value. The threshold is not a details. Ubiquiti Networks.) Select this Wireless  Displays wireless clients only.

The blocked client will disappear from the client list and then you cannot unblock the client from the UniFi mobile app.Signal  (Available for wireless clients. -.(date/time)  Displays the date and time of the name of the wireless network.ESSID  (Available for wireless clients. Inc.Connection  Displays the hostname.) Displays the downloaded and uploaded by the client.Packets Down  Displays the amount of data downloaded as packets. Actions -. -. or MAC -. -. -. 136 Ubiquiti Networks. -. • Unblock  Tap to reconnect a blocked client. Note: Use caution if you block a client and then exit the Client screen. address of the UniFi device the client is connected to. percentage of signal strength between the AP and client.Channel  (Available for wireless clients.(down/up)  Displays the total amount of data -.Appendix C: UniFi Mobile App UniFi Controller User Guide • Statistics  Displays additional client information: • History  Displays the historical usage of a client.Bytes Down  Displays the amount of data downloaded as bytes. • Block  Tap to block this client from accessing the network.(duration)  Displays the duration of the connection. -. -.RX Rate  Displays the receive rate.) Displays the -. connection.Packets Up  Displays the amount of data uploaded as packets.Activity  Displays the level of activity in Bytes per second. you must access the browser-based UniFi Controller and then unblock the client on the Insights screen. Instead. -.) Displays the You can block or unblock a client device. -.Bytes Up  Displays the amount of data uploaded as bytes. . alias. channel being used.TX Rate  Displays the transmit rate. -.

tap Log out. 137 . Log Out  To exit the UniFi app or change its mode. Ubiquiti Networks. tap the current site and then select a different site.UniFi Controller User Guide Appendix C: UniFi Mobile App Settings The current site is displayed on this screen. Site  To change a site. Inc.

Inc. .Appendix C: UniFi Mobile App UniFi Controller User Guide 138 Ubiquiti Networks.

4.UniFi Controller User Guide Appendix D: UniFi EDU Mobile App Appendix D: UniFi EDU The UniFi EDU app includes five tabs: • Broadcast (see below) Mobile App • “Schedule” on page 137 • “Recordings” on page 142 Overview • “Volume” on page 143 You can use the UAP-AC-EDU to broadcast • “Settings” on page 143 announcements with clarity from your mobile device. the Android version is similar.5 or higher • UAP-AC-EDU firmware v3. Ubiquiti Networks. • UniFi Controller software v4. Download the UniFi EDU app from the App Store (iOS) or Google Play (Android).9. follow these instructions: 3. • Remember username and password  Tap this option if you want the app to remember your 3. username and password. You can organize the UniFi AC EDU APs into multiple Requirements broadcast groups. 1. • (username)  Enter your username for the UniFi Controller. Use the UniFi EDU app to broadcast announcements from Broadcast the UAP-AC-EDU. Note: If you do not know the IP address. Launch the app. however. Tap Save to apply your changes. 4. Tap the appropriate UniFi AC EDU APs. Enter the following information: 1. which is typically 8443.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. 2. or tap Cancel to discard your changes. • (password)  Enter your password for the UniFi Controller. • (port)  Enter the appropriate port number. Click . Controller. Tap Connect. To create a broadcast group. Enter a descriptive name in the Group Name field. 139 . Inc. you can click Find to detect a UniFi Controller and then select it. • (IP address)  Enter the IP address of the UniFi 2.

Appendix D: UniFi EDU Mobile App UniFi Controller User Guide To begin a broadcast. Tap the broadcast group you want to use. Tap Start Broadcast to start the announcement. 4. Tap Edit. tap the broadcast group. follow these instructions: To edit a broadcast group. . Tap Stop Broadcasting to end the announcement. Inc. 1. To change the name or members of the group. Make your changes. 2. 2. Tap Save to apply your changes. or tap Cancel to discard your changes. 3. 3. 140 Ubiquiti Networks. follow these instructions: 1. The speakers will automatically be muted when you stop broadcasting.

Weekly or Monthly. Tap Done. Tap Edit. • Broadcast Group  Select the appropriate group. Ubiquiti Networks. 2. 1. follow these instructions: To schedule an announcement. follow these instructions: 1. Every Day. Then select Never. 141 . If you selected Custom. tap . 2. Schedule You can schedule an announcement. • Repeat  Select this option to specify how often the announcement should recur. select the Frequency. and then select the appropriate weekday or date. 3. Tap . 3. or Custom. To remove a broadcast group. Every Weekday. Inc. or tap Cancel to discard your changes. Configure the following: • (Date and time)  Select the appropriate date and time.UniFi Controller User Guide Appendix D: UniFi EDU Mobile App To delete a broadcast group. • Recording/Sample  Select the appropriate recording or sample. Tap Save to apply your changes.

tap . follow these instructions: To create a recording. . Tap to stop recording. 3. Tap Done. follow these instructions: 1. 2. Inc. 1. Tap . Tap Save to apply your changes. Click Edit. Recordings You can create a recording. To remove an announcement.Appendix D: UniFi EDU Mobile App UniFi Controller User Guide To delete an announcement. or tap Cancel to discard your changes. Tap to start recording. 142 Ubiquiti Networks. 2. Tap to play back the recording. 3.

tap the current site and then select a different site. 3. (slider)  Use the slider control to adjust the volume for each speaker. Test  To test the sound of any speaker. tap Test. Site  To change a site. tap . Then tap any sound to select it.UniFi Controller User Guide Appendix D: UniFi EDU Mobile App To delete a recording. To remove a recording. Tap Done. follow these instructions: Test Sound  Tap Test Sound to select a specific sound for 1. Inc. Click Edit. Volume You can select a test sound or adjust the volume of any speaker. Ubiquiti Networks. Settings The current site is displayed on this screen. 2. 143 . testing.

Appendix D: UniFi EDU Mobile App UniFi Controller User Guide

Log Out  To exit the UniFi app or change its mode, tap
Log out.

144 Ubiquiti Networks, Inc.

UniFi Controller User Guide Appendix E: Controller Scenarios

Appendix E: Controller A UniFi Cloud Key can be used as a remote controller. For
example, if you have a campus-wide UniFi network and
Scenarios 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, There are different scenarios for the deployment of the
manages, and monitors UniFi devices, which do not have UniFi Controller. This chapter describes three examples of
individual configuration interfaces (except for the UniFi typical deployments:
Cloud Key); instead, you use the UniFi Controller as a • Local (see below)
network management system to configure settings.
• “Layer-3 Deployment” on page 146
For very small installation that don’t require a guest
portal or advanced features, you can set up UniFi APs in • “Hybrid Deployment” on page 147
stand‑alone mode. Refer to “UniFi Mobile App” on page Local Deployment
125 for details.
The application diagram below shows an example of a
Hosting Controller Software deployment using local controllers. Each site has a local
instance of the UniFi Controller:
The UniFi Controller can be hosted on any of the following:
• High rise  The UniFi Controller is running on a
• a local UniFi Cloud Key (a low-power dedicated network
computer.
device)
• Hotel  The UniFi Controller is running on a UniFi
• a local server running Linux, Mac OS X, or Microsoft
Cloud Key.
Windows 7/8/10
• Restaurant  The UniFi Controller is running on a UniFi
• a remote server running Linux, Mac OS X, or Microsoft
Cloud Key.
Windows 7/8/10
Note: The remote controller option requires Layer-3 Remote Access
adoption and management. Cloud access is enabled on the UniFi Controllers, so you
can use unifi.ubnt.com to remotely monitor and access
Only one instance of the UniFi Controller is required. For
multiple controllers. Each controller, in turn, can manage
example, use either the UniFi Cloud Key or a local server,
multiple sites.
not both.

Local Deployment
unifi.ubnt.com

High Rise Restaurant

Hotel

Local Controller UniFi Cloud
Key Controller

UniFi Cloud
Key Controller
(150) UAP-AC-PRO (2) UAP-AC-LR

(10) US-48-500W
(1) US-8-150W
(1) USG-PRO-4 (10) UAP-AC-PRO (1) UAP-Outdoor+
(1) USG
(10) UAP-AC-LITE

(2) UAP-AC-LR (1) UAP-Outdoor5

Ubiquiti Networks, Inc. 145

Appendix E: Controller Scenarios UniFi Controller User Guide

Layer-3 Deployment Here is an overview of a typical example:
The application diagram below shows an example of a 1. Create a remote controller.
deployment using a remote controller. 2. At the customer site, open a browser to the remote
The UniFi Controller is running in the cloud or your NOC controller.
(Network Operating Center). 3. Use one of the following methods to configure all local
• High rise  The UniFi Controller is off-site. Use Layer-3 APs so they inform back to the UniFi Controller:
adoption to manage this site. • “UniFi Mobile App” on page 125
• Hotel  The UniFi Controller is off-site. Use Layer-3 • “DNS” on page 149
adoption to manage this site. • “DHCP Option 43” on page 149
• Restaurant  The UniFi Controller is off-site. Use Layer-3 • “SSH” on page 150
adoption to manage this site.
For details about Layer-3 adoption, go to “Layer-3
There are multiple methods to carry out Layer-3 adoption. Adoption” on page 148.

Layer-3 Deployment
Central Controller

High Rise UniFi EasySetup
Restaurant
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
L3 Adoption Hotel
with App*

(150) UAP-AC-PRO
(2) UAP-AC-LR

(10) US-48-500W
(1) US-8-150W

(1) USG-PRO-4 (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 Ubiquiti Networks, Inc.

and 3  The UniFi Controller is off-site. the remote controller manages three sites: • Sites 1. so you can use unifi.ubnt. • Site 3 • Hotel  The UniFi Controller is running on a UniFi Cloud Key. • Restaurant  The UniFi Controller is running on a UniFi Cloud Key. • Site 2 Note: For details about Layer-3 adoption. in the application diagram below.UniFi Controller User Guide Appendix E: Controller Scenarios Hybrid Deployment For example. 147 .com Site 1 Site 2 Hotel Restaurant USG-PRO-4 USG-PRO-4 L3 Controller UniFi Cloud UniFi Cloud Key Controller Key Controller Site 3 (240) UAP-AC-PRO (10) UAP-AC-PRO (1) UAP-Outdoor+ (2) UAP-AC-LR (20) US-48-500W (10) UAP-AC-LITE (1) US-8-150W (2) UAP-AC-LR (1) UAP-Outdoor5 (1) USG USG-PRO-4 Ubiquiti Networks. Inc. in turn. 2. Some sites • UniFi Cloud Key controller for the hotel have local instances of the UniFi Controller. you can use unifi. Remote Access Cloud access is enabled on the UniFi Controllers.com to access three controllers: The application diagram below shows an example of a deployment using local and remote controllers. In turn.com to remotely monitor and access multiple controllers. Each controller.ubnt. go to “Layer-3 Adoption” on page 148. can manage multiple sites. Use • Site 1 Layer-3 adoption to manage these sites.ubnt. • remote controller Your sites use a mixture of controller types. while other • UniFi Cloud Key controller for the restaurant sites have a remote UniFi Controller. Hybrid Deployment unifi.

then tap the UniFi‑Discover icon. Here is an overview of a typical example: 1. including Windows 8. • “DHCP Option 43” on page 149 • ”SSH” on page 150 UniFi EasySetup App 1. Linux Users  Run the following command: java -jar <unifi_base>/lib/ace. Every UniFi AP has a default inform URL: default state or not in contact with any controller will be http://unifi:8080/inform displayed). . Launch the UniFi EasySetup App from your mobile device. open a browser to the UniFi The UniFi Discovery Utility listens to the multicast and Controller. (Only APs in the 3. • Address  Enter the IP address of the UniFi Controller. PC Users  For most versions of Windows. For other versions. go to the Start menu and double‑click the UniFi-Discover icon.app icon. overflow icon in the upper-right corner. and then tap Settings. Wait for the UniFi AP to be displayed. Use one of the following methods to configure all local The UniFi Discovery Utility is installed alongside your APs so they inform back to the UniFi Controller: UniFi Controller. UniFi Discovery Utility 2. 3. Tap Settings. go to Start > All Programs > Ubiquiti UniFi and double‑click the 2. At the customer site. refer to “UniFi Mobile App” on page 125. • Port  Enter the port number of the UniFi Controller. 148 Ubiquiti Networks. Create your controller. broadcast packets from UniFi APs and allows you to tell the UniFi AP to inform any URL you want.Appendix E: Controller Scenarios UniFi Controller User Guide Layer-3 Adoption For more information about the UniFi EasySetup App. Follow the instructions for the operating • UniFi EasySetup App (see below) system you are using: • UniFi Discovery Utility (see the next column) Mac Users  From the Finder. Inc. If Settings is not displayed. click Go > Applications and • “DNS” on page 149 double-click the UniFi-Discover. Scroll down the Setting screen to view the UniFi Controller settings: • Controller mode  Enable use of the UniFi EasySetup App with a UniFi Controller.jar discover To perform Layer-3 adoption with the UniFi Discovery Utility: 1.

The UniFi AP will change to an Adopting state. 7. refer to “UniFi Discovery Utility” on page 121. 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 the UniFi AP is not in the factory default state. Open a browser to the remote UniFi Controller. EdgeMAX  If you are using a Ubiquiti® EdgeMAX® or EdgePoint™ router. Perform step 3 again. 3. the UniFi Controller will upgrade these APs automatically. then the UniFi AP cannot contact the DNS server to resolve the domain name of the UniFi Controller. If not properly configured. Access the user interface of the EdgeMAX router. The UniFi AP should be displayed as Pending Approval. If the UniFi AP has been reset to its factory defaults. 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. The SSH username and the UniFi Discovery Utility) about the location of the UniFi password should be ubnt/ubnt. Go to Actions > View Details for the appropriate DHCP server. Click the Services tab. DNS resolution  Configure your DNS server to resolve unifi to the IP address of the UniFi Controller. The UniFi AP is now managed by the UniFi Controller. Click approve. For more information about the UniFi Discovery Utility. ensure that you have informed the UniFi AP twice (using 4. then follow these instructions: 1. For example. 5. Ubiquiti Networks. then ping the UniFi Controller from the UniFi AP to determine if <XYZ> can be resolved or reached. Change the inform URL. 149 . Inc. Click manage. then 3. 2. DHCP Option 43 Instructions vary depending on the router you are using. 6. Click Apply. Enter the SSH username and password.UniFi Controller User Guide Appendix E: Controller Scenarios 2. Once adopted. Ensure that the UniFi AP can resolve the domain name of the UniFi Controller. Controller. and You have a couple of options: then click Apply. Eventually it will change to an Adoption Failed or Disconnected state. then DNS click reset. if you have configured http://<XYZ>:8080/inform.

1. option vendor-class-identifier “ubnt”.link/UniFi-Layer3-Adoption SSH If you can SSH into the UniFi AP. # . option domain-name-servers 168.. Instructions for other DHCP servers are available at: http://ubnt.10. Use the UniFi Discovery Utility to ensure that the UniFi AP is running the same firmware as the UniFi Controller.unifi-address 201.unifi-address code 1 = ip-address.1. vendor-option-space ubnt. option ubnt.Appendix E: Controller Scenarios UniFi Controller User Guide 4. In the UniFi Controller field.0 { range 10. If it is not.255.conf file: # . 4) = “ubnt”. SSH into the UniFi AP and enter: mca-cli set-inform http://<ip-of-controller>:8080/inform 150 Ubiquiti Networks.10.. Linux ISC DHCP Server  Configure the dhcpd. 0.8.255.10. 8.. The DHCP server will return the IP address of the UniFi Controller to its DHCP clients. then SSH into the UniFi AP and run: syswrapper.160. option broadcast-address 10. ### UniFi Controller IP ### option routers 10..7. option space ubnt.link/UniFi-SSH-Firmware-Upgrade 2. so if a client is a UniFi AP.10.31.10.10.10.10. enter the IP address of the UniFi Controller.10.0 netmask 255. Use the UniFi Discovery Utility to ensure that the UniFi AP is in the factory default state.8. it will know how to contact the UniFi Controller. Inc. } Note: You can also use the IP address of the UniFi Controller instead of the domain name in the inform URL. class “ubnt” { match if substring (option vendor-class-identifier.100 10.2.10. then you can perform the layer-3 adoption via CLI command: 1.10.8. .sh restore-default 3. } subnet 10. Then click Save. If it is not.255. option ubnt.95. then follow the instructions at: http://ubnt.

hardware compatibility.com/unifi Downloads: downloads.com/unifi JL061716 Ubiquiti Networks.com Online Resources Support: ubnt. 2580 Orchard Parkway San Jose.link/UniFi-Support Community: community. Inc. CA 95131 www. We strive to respond to support inquiries within a 24-hour period.UniFi Controller User Guide 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. Ubiquiti Networks. 151 . Inc.ubnt.ubnt. or field issues as quickly as possible.ubnt.

Inc. the Ubiquiti beam logo. Google. App Store is a service mark of Apple.ubnt. and UniFi are trademarks or registered trademarks of Ubiquiti Networks. in the United States and in other countries. the Ubiquiti U logo. Inc. Ubiquiti. . Android. All rights reserved. All other trademarks are the property of their respective owners. www. Inc. Ubiquiti Networks. and Google Play are trademarks of Google Inc.com © 2011-2016 Ubiquiti Networks.