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

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

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

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

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

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

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

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

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

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

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

b. Enter an admin name in the Admin Name field. 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.Chapter 2: UniFi Cloud UniFi Controller User Guide 8. software. In the address field. 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.1. Click Finish to save your settings will try to automatically obtain an IP address.30. Perform the following steps: a. Click Next. future use. type https:// followed by the appropriate IP address. 2. UniFi Controller database and configuration on the e. Note: The default fallback IP address of the UniFi Cloud Key is 192. Press enter (PC) or return (Mac). the browser will be redirected to the DHCP server for its IP address. Ensure 1. your wireless network is now configured.168. The UniFi Cloud Key is set to DHCP by default. management interface. or check the is finished. 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. . Review your settings. 8 Ubiquiti Networks. Create the super admin for your UniFi Controller. Enter the admin name and password that you created and click Login. Confirm your password in the Confirm Password Note: A future feature will enable backup of the field. so it 9. Congratulations. Launch the web browser. 3. included microSD card. Inc. Enter an email address in the Admin Email field. d. A login screen will appear for the UniFi Controller management interface. c. Once the wizard specific IP address to the UniFi Cloud Key. Assign a or click Back to make changes.

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

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

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

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.

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

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

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

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

select a device. The Properties panel is hidden by default. Search   You can enter text that you want to search for. click . Inc. Select Last hour. a popup within this panel. Events click . message. • LAN  Only display recent events for the wired network. • Submit  Click to apply changes. You can apply one of the following filters: • Cancel  Click to discard changes. or 30 days. there is no need to Information about each selected device appears as press Enter. • Password  Enter your current password. • Admin   Enter the admin name. 7 days. Close  Click to close the screen. Maximize/Minimize  Click to maximize the screen size. For more information. • All  Display all of the recent events. The Edit Account screen will appear: The Events tab displays a list of recent events. 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. Simply begin typing. Last 24 hours. 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. device name. The information varies depending on the device type. Last 48 hours. along with the corresponding device icon. To display it. Show  Filter recent events based on the time period you • New Password  Enter the new password. specify. Interface. 19 . Click again to minimize the screen size. Properties • WLAN  Only display recent events for the wireless networks.UniFi Controller User Guide Chapter 3: Using the UniFi Controller Software Edit Account  To change the login name and/or password. Last 8 hours. • 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. and time. 2 weeks. • Confirm Password  Enter the new password again. date.

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

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

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

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

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

-. • DHCP WINS Server  Select this option to designate WINS (Windows Internet Naming Service) server(s). potential address conflicts. 4009. -.Auto  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. Name servers are Remote User VPN automatically assigned by the DHCP server. Decreasing the lease time avoids • IP/Subnet  Enter the IP address and prefix size. The remote user can access the site’s resources as well as the resources of any other VPNs connected to the site. 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. • WINS Server  Select this option to designate WINS (Windows Internet Naming Service) server(s). Devices option. Every VLAN ID represents a different VLAN. • DHCP Range  Enter the starting and ending IP -. Enter the number of IP/Subnet field.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. -.Manual  Select this option to manually select name • Save  Click to apply changes. unauthorized DHCP servers.Manual  Select this option to manually select name servers. Name servers are -. 25 . • Cancel  Click to discard changes. • Name Server  Configure the name or DNS (Domain • DHCP Guarding  Select this option to detect and block Name System) server setting. Ubiquiti Networks. seconds. -. servers. The local DHCP server • DHCP Guarding  Select this option to detect and block assigns IP addresses to DHCP clients on the network. trusted DHCP server. • Name Server 1/2  Enter the IP address of the name VLAN Only server in each field. they were attached to the same wire. -. • DHCP Server  Enabled by default.Trusted DHCP Server IP  Enter the IP address of the addresses of the range in the fields provided.Trusted DHCP Server IP  Enter the IP address of the automatically assigned by the DHCP server. but could introduce potential conflicts. The UniFi Security Gateway is required for this option. unauthorized DHCP servers. The VLAN ID range is 2 to • Save  Click to apply changes. If you disable this • VLAN  Enter the ID number of the VLAN. • DHCP Name Server  Configure the name or DNS • Save  Click to apply changes. The UniFi Switch is required for this option. • Name Server 1/2  Enter the IP address of the name server in each field.WINS Server 1/2  Enter the IP address of the WINS server in each field. Increasing the time ensures client operation without interruption.WINS Server 1/2  Enter the IP address of the WINS server in each field. -.Auto  Enabled by default. then the remote user can only access the site’s belonging to the same VLAN communicate as if resources. • RADIUS IP  Enter the IP address of the RADIUS server. thereby manage multicast traffic. trusted DHCP server. (Domain Name System) server setting. • Site-to-Site VPN  Enabled by default. • RADIUS Password  Enter the password of the RADIUS server. • Cancel  Click to discard changes. • Cancel  Click to discard changes. Inc. which is used for authentication.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Overall Traffic Applications are organized by category. Download  Displays the total amount of data downloaded by the client. The total amount of traffic is broken down by category. a dashed line displays the number of clients connected during the selected time period. The details of the all-time. 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. Inc. 65 . Place the mouse Client Details screen. Download  Displays the total amount of data downloaded by the client. See “Client Details” on page 109 traffic analysis. Web / Web 2. See “UniFi Access Point Details” on page 95 for additional information.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. Place the mouse cursor over the chart for the number of clients per specified AP. displayed: Traffic  In the graph. 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. Ubiquiti Networks. Current Usage: Top Access Points The details of the most active Access Points in current use are displayed. Traffic  A pie chart represents traffic on the most active Amount of Traffic  A pie chart represents the traffic Access Points. Go to “Settings > Site” on page 20 for more information. Clients  In the graph. Traffic Stats Upload  Displays the total amount of data uploaded by (Available if you have a UniFi Security Gateway with the the client. of data.) The Traffic Stats screen All-Time Top Client describes the network traffic by application usage. connected. Ubiquiti’s proprietary DPI engine includes for additional information. DPI feature enabled. Download  Displays the total amount of data downloaded by the AP. Place the mouse cursor over the chart for distribution by the most popular categories.0. a solid line displays the network Name or MAC address  You can click this link to open the traffic during the selected time period. # of Clients  A pie chart represents the client distribution on the most active Access Points. See “Client Details” on page 109 cursor over an hour or day to display the specific amount for additional information. Place the the amount of traffic per specified AP. mouse cursor over the chart for the amount of traffic per category. 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. and Network Protocols. Upload  Displays the total amount of data uploaded by the AP. Name or MAC address  You can click this link to open the AP Details screen. such as Streaming Media. Upload  Displays the total amount of data uploaded by the client.

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

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

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

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

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

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

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

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

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

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

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

Gateway Details • Restart  Click to restart the selected device. Hide Property Panel  Click to hide the Properties panel but allow the device popups to remain accessible from this panel. There are three clickable tabs: • “UniFi Security Gateway – Details” on page 78 Remove All  Click to close the Properties panel. 79 The top of the popup remains and displays the following: • Display  Click to display the device information. Information about each selected device appears as same information in a separate popup screen that can a popup within this panel. -. Click the properties icon to re-open it. You can always icon on the Map tab will flash three times and stop. The LED Security Gateway’s Details window either in the Properties will flash until the Locate button is clicked again. • “UniFi Security Gateway – Networks” on page 78 Collapse All  Click to collapse all of the popups • “UniFi Security Gateway – Configuration” on page to rows. but the port is not in use). (This icon does not appear if an upgrade is not available or there Properties are pending changes. • (icon)  Displays the icon of the device (the icon will vary depending on the model). • Close Properties  Click to close the device popup. (The panel or as a separate popup window.Connected  A solid green circle indicates a managed connection.) The Properties panel appears on the right side of the • Undock from Properties Panel  Click to display the screen. Indicates a 1 Gbps (1000 Mbps) connection. Inc. Ubiquiti Networks. -. -. • Upgrade  Click to upgrade the device. Indicates no connection (the network or VLAN is enabled. • (status)  Displays to indicate the device status.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. • 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 upper part of the detached popup screen has an icon for each port.Disconnected  A red warning icon ! indicates no connection.Pending Approval  A solid orange circle indicates the default state. be moved anywhere within the browser screen. 77 . Indicates a 10/100 Mbps connection.) dock this window in the Properties panel or detach it as a separate window. -. available for adoption. Indicates the connection is disabled (no network or VLAN is enabled).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 Security Gateway – Networks Click Networks to display the network name. Up Pkts/Bytes  Displays the amount of data uploaded as packets and bytes. and number of clients. Version  Displays the version number of the Gateway’s firmware. and uptime. LAN/WAN connection details. been running without interruption. Full Duplex or Half Duplex. number of active WAN ports. Duplex  Displays the mode. # Clients  Displays the number of clients on the network. MAC Address  Displays the MAC address or unique hardware identifier of the Gateway. LAN IP Address  Displays the local IP address of the Gateway.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. RX  Displays the incoming (receive) throughput. IP  Displays the local IP address of the network. The selected column displays or to indicate ascending WAN 1 or descending order. IP address. Uptime  Displays the duration of time the Gateway has (sort)  You can click any column to sort the displayed list. Down Activity  Displays the level of download activity in Bytes per second. Up Activity  Displays the level of upload activity in Bytes per second. Model  Displays the model name of the Gateway. Click Details to display the device specifics. TX and RX throughput. Overview Down Pkts/Bytes  Displays the amount of data downloaded as packets and bytes. 78 Ubiquiti Networks. Speed  Displays the connection speed in Mbps. TX  Displays the outgoing (transmit) throughput. The number of WAN sections will vary depending on the Network  Displays the name of the network. Inc.

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

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

Also known as the external port(s). Port  Displays the port or ports that will be forwarded to the LAN. Create  Click to add a new entry. the Pending Changes option appears in the Properties panel. 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.) Cancel  Click Cancel to discard changes. When you are done with your changes. Dest IP/Port  Displays the destination IP address and port(s) that will receive the forwarded port traffic. if specified. • Delete  Click to delete the port forwarding entry. Also known as the internal port(s). From  Displays the source IP address. Actions  Click a button to perform the desired action: • Edit  Click to edit the port forwarding entry.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. 81 . Each section with pending changes is highlighted by an ellipsis. Go to “Create or CREATE Edit Port Forwarding Entry” on page 82. Discard  Click DISCARD to cancel changes. (You can cancel the changes of any section by clicking X of the appropriate section. Name  Displays the name of the port forwarding entry. Ubiquiti Networks. Click to display the devices. Inc. Apply  Click APPLY to save changes. Pending Changes  If you want queue changes for multiple devices and then apply them later. click Apply Changes at the bottom of the screen.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

2G/5G  Select the frequency band you want to analyze. Inc. # Guests  Displays the number of guests connected to the guest network. # Users  Displays the number of users connected to the primary network. Channel  Displays the channel being used. RX Retry/Dropped  Displays the percentage of receive packets that needed to be re-sent and the percentage of packets that were dropped. Transmit Power  Displays the EIRP in dBm.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. UAP‑AC‑LR. TX Retry/Dropped  Displays the percentage of transmit packets that needed to be re-sent and the percentage of packets that were dropped. RF Scan  Click RF SCAN to scan the RF environment and then click Confirm to continue. Click RF Environment for spectral analysis to help in channel selection and planning. channel and transmit/receive statistics. 98 Ubiquiti Networks. . RX Pkts/Bytes  Displays the amount of data received as packets and bytes. TX Pkts/Bytes  Displays the amount of data transmitted as packets and bytes. UAP‑AC‑PRO. and UAP‑AC‑EDU support spectral analysis.

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

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

) Cancel  Click Cancel to discard changes. 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. Queue Changes  Click Queue Changes to save changes. • Discard  Click DISCARD to cancel changes. (You can cancel the changes of any section by clicking X of the appropriate section. WLANs You can deploy multiple wireless networks organized into WLAN groups on different APs. and enter the SSID override name to apply to the wireless network. Cancel  Click Cancel to discard changes. click Apply Changes at the bottom of the screen. over again when you change different sections of the configuration. Overrides  Displays the SSID override information applied to the wireless network. Click so that the device doesn’t have to re-provision over and to display the devices. Ubiquiti Networks. • Apply  Click APPLY to save changes. Inc. 101 . Note: The Override option is not available for a Zero Handoff WLAN Group. When you are done with your changes. Each section with pending changes is highlighted by an ellipsis. set the VLAN ID.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. the Pending changes to the device and then apply them all at once Changes option appears in the Properties panel. Name  Displays the network name or SSID of the available wireless network.

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

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

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

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

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

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

This will restore the Phone to factory default settings when it is in a Connected state.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. . Note: Use caution when clicking Forget. 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. Inc.

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

Duration  Displays the duration of the connection. 110 Ubiquiti Networks. Up  Displays the total amount of data uploaded by the client. Power Save  Displays the status of the power save mode. or descending order. Down Pkts/Bytes  Displays the amount of data Packets  Displays the amount of data uploaded and downloaded as packets and bytes. Down  Displays the total amount of data downloaded by the client. RX Rate  Displays the receive rate. downloaded as packets. Application  Displays the name of the application.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). Date/Time  Displays the date and time of the connection. between the AP and client. Signal  Displays the percentage of signal strength (sort)  You can click any column to sort the displayed list. Channel  Displays the channel being used. Inc. Up Pkts/Bytes  Displays the amount of data uploaded as Wireless Client – History packets and bytes. Bytes  Displays the amount of data uploaded and Activity  Displays the level of activity in Bytes per second. The selected column displays or to indicate ascending TX Rate  Displays the transmit rate. . downloaded as bytes.

Ubiquiti Networks.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. downloaded as packets and bytes. Apply  Click Apply to save changes. 111 . Inc. Note  Allows you to enter comments about the client. client on the Insights > Known Clients tab. Up Pkts/Bytes  Displays the amount of data uploaded as • Network  Select the appropriate network from the packets and bytes. User Groups option (see “Settings > User Groups” on Network  Displays the network used by the client. the client will be designated as a “Noted” Device Type  Displays the type of device. If you want Down Pkts/Bytes  Displays the amount of data the local DHCP server to assign an IP address to the client. User Groups are set up under the Settings tab > connected. The default User Group is Automatic. Port  Displays the name and port of the UniFi device being used by the client. Hostname  Displays the customizable name or identifier of the client. 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. IP Address  Displays the local IP address of the client. drop-down list. You can click the name to get Save  Click Save to apply changes. and configure the settings below. page 34 for more information). additional details on the UniFi device. Alias  Allows you to change the hostname of the client. remove the checkmark. Once saved. • IP Address  Enter the local IP address. Fixed IP  Select this option to assign a static IP address to the client.

Down  Displays the total amount of data downloaded by the client. • Network  Select the appropriate network from the drop-down list. and configure the settings below. the client will be designated as a “Noted” Application  Displays the name of the application. (sort)  You can click any column to sort the displayed list. Duration  Displays the duration of the connection. 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. client on the Insights > Known Clients tab. . remove the checkmark. • IP Address  Enter the local IP address.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). Fixed IP  Select this option to assign a static IP address to the client. Alias  Allows you to change the hostname of the client. IP Config Date/Time  Displays the date and time of the connection. The default User Group is Automatic. Wired Client – History Save  Click Save to apply changes. Group. Packets  Displays the amount of data uploaded and User Group  Allows you to assign the client to a User downloaded as packets. Note  Allows you to enter comments about the client. 112 Ubiquiti Networks. The selected column displays or to indicate ascending or descending order. If you want the local DHCP server to assign an IP address to the client. Once saved. Up  Displays the total amount of data uploaded by the client. Inc. page 34 for more information). Apply  Click Apply to save changes.

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

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

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

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

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

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.

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

The LED on the AP will automatically selected. Username  If required. 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. enter the device username. enter the device password. Password  If required. Username  If required. The following window will appear: Set the inform URL. enter the device password. (See “Network Topology Requirements” on page 1 for a visual representation of this configuration. enter the device username. then Manage is Apply  Click Apply to locate the AP. . 122 Ubiquiti Networks. port. and path to the UniFi Controller software. Apply  Click Apply to save the inform URL. Password  If required. Set Inform URL  Enter the URL. Inc. then Locate is automatically selected.Appendix B: UniFi Discovery Utility UniFi Controller User Guide Locate Manage Locate the AP.) The following window will appear: Actions  If you clicked the Locate button. Actions  If you clicked the Manage button.

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

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

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

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

• (channel width)  Select the appropriate channel width. • Enabled  Enable or disable wireless functionality. • Security Key  Enter the passphrase. or • (channel width)  Select the appropriate channel width. Medium. • Channel  Select a channel number or keep the default. Radio Settings Auto. Select High. Medium. or Low. from the list. Low. Inc. • TX Power  The default is Auto. Select High. 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. Ubiquiti Networks. 127 . Auto.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. • TX Power  The default is Auto. • Security  Select the security method you want to use.

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

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

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

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

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

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

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

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

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

Ubiquiti Networks. tap Log out. 137 . Log Out  To exit the UniFi app or change its mode. Site  To change a site. Inc. 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.

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

Enter a descriptive name in the Group Name field. Use the UniFi EDU app to broadcast announcements from Broadcast the UAP-AC-EDU. 2.9. 1. Enter the following information: 1. which is typically 8443. • (password)  Enter your password for the UniFi Controller. • Remember username and password  Tap this option if you want the app to remember your 3. Note: If you do not know the IP address. • UniFi Controller software v4. Ubiquiti Networks. Tap Connect. username and password.18 or higher • A compatible Android or iOS device located on the same Layer-2 network as the UniFi Controller and UniFi APs The following instructions describe the iOS version of the app. however. To create a broadcast group. Download the UniFi EDU app from the App Store (iOS) or Google Play (Android). you can click Find to detect a UniFi Controller and then select it. Launch the app.4. the Android version is similar.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. • (port)  Enter the appropriate port number. You can organize the UniFi AC EDU APs into multiple Requirements broadcast groups. • (IP address)  Enter the IP address of the UniFi 2. Tap the appropriate UniFi AC EDU APs. Controller. Tap Save to apply your changes. Inc. 4.5 or higher • UAP-AC-EDU firmware v3. 139 . Click . or tap Cancel to discard your changes. • (username)  Enter your username for the UniFi Controller. follow these instructions: 3.

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

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

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

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

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.

2. • remote controller Your sites use a mixture of controller types. Remote Access Cloud access is enabled on the UniFi Controllers. In turn. • Restaurant  The UniFi Controller is running on a UniFi Cloud Key. the remote controller manages three sites: • Sites 1.ubnt. in turn. go to “Layer-3 Adoption” on page 148. you can use unifi. can manage multiple sites. Use • Site 1 Layer-3 adoption to manage these sites.com to remotely monitor and access multiple controllers. Inc. • Site 2 Note: For details about Layer-3 adoption.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. while other • UniFi Cloud Key controller for the restaurant sites have a remote UniFi Controller. so you can use unifi. Some sites • UniFi Cloud Key controller for the hotel have local instances of the UniFi Controller.ubnt.UniFi Controller User Guide Appendix E: Controller Scenarios Hybrid Deployment For example.com to access three controllers: The application diagram below shows an example of a deployment using local and remote controllers. in the application diagram below. • Site 3 • Hotel  The UniFi Controller is running on a UniFi Cloud Key. 147 . Hybrid Deployment unifi.ubnt. Each controller. and 3  The UniFi Controller is off-site.

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

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

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

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

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