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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

A new window will appear. Ubiquiti Networks.UniFi Controller User Guide Chapter 11: UniFi Switch Details Debug Terminal This option uses a WebRTC connection as transport layer. This will restore the Switch to factory default settings when it is in a Connected state. 93 . Inc. Open Terminal  Click Open Terminal to connect directly to this Switch. click Open Terminal. To use a command-line interface. Note: Use caution when clicking Forget. • 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.

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

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

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

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

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

• Interference  Displays the level of interference. The selected column displays or to indicate ascending or descending order. Last scan  Displays the duration of time since the last scan. 40. in channel widths of 20. and 80 MHz. Overview • Radio  Displays the radio being used. Inc. alias. (outlined)  The current channel is outlined. __ MHz  The 2.UniFi Controller User Guide Chapter 12: UniFi Access Point Details Note: The RF scan may take more than five minutes. RF Scan Details • Utilization  Displays the percentage of the frequency range already in use. • Frequency Range  Displays the range of frequencies. Name  Displays the hostname. 99 . Ubiquiti Networks. 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. UniFi Access Point – Users (sort)  You can click any column to sort the displayed list. information. 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. • Interference Types  Displays the type of interference being detected. The 5 GHz results are displayed and AP. see “Client Details” on page 109 for more to red at -32 dBm). • Channel Width  Displays the width of the channel. Place your cursor over a channel option to view the All clients using this AP will be disconnected. __  Displays the corresponding channel number for each channel width option. and following: the AP will be offline for the duration of the scan.

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

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

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

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

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

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

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

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

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

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

downloaded as bytes. Signal  Displays the percentage of signal strength (sort)  You can click any column to sort the displayed list. Power Save  Displays the status of the power save mode. Up  Displays the total amount of data uploaded by the client. 110 Ubiquiti Networks. Date/Time  Displays the date and time of the connection. RX Rate  Displays the receive rate. Channel  Displays the channel being used. Down  Displays the total amount of data downloaded by the client. between the AP and client. . Up Pkts/Bytes  Displays the amount of data uploaded as Wireless Client – History packets and bytes. or descending order. downloaded as packets. Down Pkts/Bytes  Displays the amount of data Packets  Displays the amount of data uploaded and downloaded as packets and bytes. Application  Displays the name of the application. Inc.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). The selected column displays or to indicate ascending TX Rate  Displays the transmit rate. Duration  Displays the duration of the connection. Bytes  Displays the amount of data uploaded and 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. client on the Insights > Known Clients tab. IP Address  Displays the local IP address of the client. Ubiquiti Networks. You can click the name to get Save  Click Save to apply changes. Hostname  Displays the customizable name or identifier of the client. Up Pkts/Bytes  Displays the amount of data uploaded as • Network  Select the appropriate network from the packets and bytes. Note  Allows you to enter comments about the client.UniFi Controller User Guide Chapter 14: Client Details Wireless Client – Configuration Wired Client – Details Config MAC Address  Displays the MAC address or unique hardware identifier of the client. • IP Address  Enter the local IP address. and configure the settings below. 111 . Alias  Allows you to change the hostname of the client. Port  Displays the name and port of the UniFi device being used by the client. downloaded as packets and bytes. page 34 for more information). If you want Down Pkts/Bytes  Displays the amount of data the local DHCP server to assign an IP address to the client. Inc. User Groups option (see “Settings > User Groups” on Network  Displays the network used by the client. additional details on the UniFi device. the client will be designated as a “Noted” Device Type  Displays the type of device. User Groups are set up under the Settings tab > connected. Once saved. drop-down list. IP Config Wired Client – Statistics Overview Activity  Displays the level of activity in Bytes per second. remove the checkmark. The default User Group is Automatic. Fixed IP  Select this option to assign a static IP address to the client. Apply  Click Apply to save changes.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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

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

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

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

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

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