You are on page 1of 158

Enterprise System Controller

Release Version: 5.0.6

UniFi Controller User Guide Table of Contents

Table of Contents

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

Chapter 2: UniFi Cloud. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
UniFi Cloud Key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
UniFi Cloud Account. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Chapter 3: Using the UniFi Controller Software. . . . . . . . . . . . . . . . . . . . . 17
Navigation Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Common Interface Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Chapter 4: Dashboard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Latency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Throughput. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
WAN. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
LAN. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
WLAN. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Download Throughput & Latency. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Upload Throughput & Latency. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Devices on 2.4 GHz Channel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Devices on 5 GHz Channel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Deep Packet Inspection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Chapter 5: Map. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Adding Custom Maps. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .45
Adding a Google Map. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Placing Devices on the Map. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Map Display Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Setting the Map Scale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

Chapter 6: Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
All. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Gateway/Switches. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
APs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Phones. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Ubiquiti Networks, Inc. i

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Chapter 2: UniFi Cloud UniFi Controller User Guide

UniFi Cloud Account A secondary filter is available:
You must be a super admin for initial cloud management. • All  Displays all UniFi Controllers.
Once cloud access is enabled by the super admin, then • Online  Only displays online UniFi Controllers.
any other admin can also enable cloud access. • Offline  Only displays offline UniFi Controllers.
Note: The cloud account is also known as the Single Find Cloud Key  Click to discover a UniFi Cloud Key on
Sign-On (SSO) account. your local network.
Search   Enter the text you want to search
Login Instructions for. Simply begin typing; there is no need to press Enter.
1. Launch the Chrome web browser and type
You can click any of the column headers to change the
https:// followed by the appropriate Controller
list order.
Hostname/IP address as specified in “Settings >
Controller” on page 35. Press enter (PC) or return (icon)  Displays the icon corresponding to the device
(Mac). running the UniFi Controller. Green indicates an active
UniFi Controller. Gray indicates an inactive UniFi Controller.

UniFi Cloud Key
Computer
2. Enter the username and password for your UBNT
Controller  Displays the hostname, alias, or MAC address
account. Click Sign In.
of the device running the UniFi Controller. You can click
the name to get additional details at the bottom of the
screen. (Go to “Additional Details” on page 14 for
more information.)
IP Address  Displays the IP address of the device running
the UniFi Controller.
Sites  Displays the total number of sites managed by the
UniFi Controller.
Devices  Displays the total number of devices managed
by the UniFi Controller.
Clients  Displays the total number of clients on the sites
managed by the UniFi Controller.
Version  Displays the software version number of your
UniFi Controller.
Note: If you do not have an account, click
Actions  Click a button to perform the desired action:
Register and follow the on-screen instructions.
• Remove  Click to remove the UniFi Controller
A list of UniFi Controllers will appear. from your cloud account.
Chat  At the lower left of the screen, click to open a
window for online chat support.
Admin
At the top right of the screen, click to display the My
Account and Sign Out options:

You can apply one of the following primary filters:
• All  Displays all UniFi Controllers
• Cloud Key  Only displays UniFi Cloud Keys.
• Software Installation  Only displays instances of
software installations.

12 Ubiquiti Networks, Inc.

UniFi Controller User Guide Chapter 2: UniFi Cloud

My Account  To change your account settings and/or Find Cloud Key
password, click . The Account Settings screen
To add a UniFi Cloud Key, click Find Cloud Key at the top
will appear:
right of the screen. The Find Cloud Key screen will appear:

Adopt
IP address  Displays the IP address of the UniFi Cloud Key.
(status)  Displays the status information: Pending
Adoption.
mac  Displays the MAC address or hardware identifier of
the UniFi Cloud Key.
There are three pages available:
firmware  Displays the firmware version number of the
• Profile  Access your account settings:
UniFi Cloud Key.
-- First Name  Enter your first name.
Adopt  Click to adopt the UniFi Cloud Key. Refer to step
-- Last Name  Enter your last name. 8 of “Chrome Instructions” on page 5 for more
-- Username  Enter your login username. information.
-- Email  Enter the email address of your cloud account. Cancel  Click to exit this screen.
-- Update Settings  Click to apply your changes. Manage
• Security  Change your account password:
-- Create a New Password  Enter a new password with
at least eight characters.
-- Update Settings  Click to apply your changes.

IP address  Displays the IP address of the UniFi Cloud Key.
(status)  Displays the status information: Adopted or
Pending Adoption.
mac  Displays the MAC address or hardware identifier of
the UniFi Cloud Key.
firmware  Displays the firmware version number of the
UniFi Cloud Key.
Manage  Click to configure the UniFi Cloud Key. Refer to
“UniFi Cloud Key Configuration” on page 8 for more
information.
• Beta Program  Follow the on-screen instructions if you Cancel  Click to exit this screen.
want to join the beta program.
Sign Out  To manually sign out of the cloud account, click
.

Ubiquiti Networks, Inc. 13

Chapter 2: UniFi Cloud UniFi Controller User Guide

Additional Details (site_name)
Select a UniFi Controller to display more information at • Launch Site  Click Launch Site to access the UniFi
the bottom of the screen. Controller. Proceed to “Using the UniFi Controller
Software” on page 17 for more information.
Note: If you have an issue accessing the local
Controller, then click force WebRTC.
• (map)  Displays a visual representation of your
network’s status. The status of each dashboard node is
indicated by color:
-- Black  Black indicates that the Internet connection is
active.
-- Green  Green indicates that the node is active and all
devices are online.

• (icon)  Green indicates an active UniFi Controller. Gray
indicates an inactive UniFi Controller.
Overview
-- Red  Red indicates one of the following:
• (controller_name)  Displays the Controller Hostname/IP
• WWW  Internet connectivity is down.
address as specified in “Settings > Controller” on page
35. • WAN  The UniFi Security Gateway is offline.
• IP Address  Displays the IP address of the device • LAN  One or more Switches are offline.
running the UniFi Controller. • WLAN  More than half of the APs are offline.
• Sites  Displays the total number of sites managed by the
UniFi Controller.
• Devices  Displays the total number of devices managed
by the UniFi Controller.
• Clients  Displays the total number of clients on the sites -- Gray  Gray indicates that there is no Internet
managed by the UniFi Controller. connection or there are no devices available for
that node.
• Software Version  Displays the software version
number of your UniFi Controller. You can place the mouse over each node icon to display
basic status information.
• Actions  Click a button to perform the desired action:
-- WWW  The basic details of the Internet connection
-- Remove  Click to remove the UniFi Controller
are displayed.
from your cloud account.
Sites
• Search   Enter the text you want to
search for. Simply begin typing; there is no need to press
Enter.
• (site_name)  Displays the name of the site. You can click
the name to get additional details on the right.
• (Unread Alerts)   Displays the number of unread
alerts.
• Gateway  Displays the IP address of the service
provider’s gateway.
• DNS  Displays the IP addresses of the Domain Name
System (DNS) servers.
• IP  Displays the Internet IP address of the UniFi
Security Gateway.
• Uptime  Displays the length of time the Internet
connection has been active.

14 Ubiquiti Networks, Inc.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Inc.0  Displays the amount of data that is identified as web-related traffic. 43 . 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. Status information  Place your mouse over a specific traffic category to display the traffic category name and amount of data. Web / Web 2. Ubiquiti Networks. Security Update  Displays the amount of data that is identified as part of a security update. Unknown  Displays the amount of data that is unidentified.

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

Click Upload Image. The UniFi Controller software allows you to upload custom map images of your location(s) or use Google Maps™ for a visual representation of your UniFi network. Once you’ve created the map. a default map is displayed. image editing.png file format. Click Add a Map. When you initially launch the UniFi Controller application.gif. . or .UniFi Controller User Guide Chapter 5: Map Chapter 5: Map 2. Ubiquiti Networks. you can upload it to the UniFi Controller software: 1. Click . 45 .jpg. shows the scale of the map. The legend at the bottom of the map 3. Inc. or blueprint application that exports a file in . Adding Custom Maps To add a custom map. you must first create the image using an illustration. The default is Google Maps.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.UniFi Controller User Guide Chapter 10: UniFi Security Gateway Details Custom Upgrade For firmware upgrades. 83 . Ubiquiti Networks. select this option. Custom Upgrade  Click to upgrade the firmware from the location you entered. 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. Inc. Note: Use caution when clicking Forget. (URL)  Enter the location URL of the firmware.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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. 108 Ubiquiti Networks. Note: Use caution when clicking Forget. Inc. Forget This Phone Forget  Click Forget to remove the Phone from management by the UniFi Controller software and reset it to factory default settings. . This will restore the Phone to factory default settings when it is in a Connected state.

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

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

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

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

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

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

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

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

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

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

Viewing the Default Portal Mac
Once Guest Portal and Override Default Templates are 1. Navigate to Go > Applications.
enabled, connect to the Guest Network SSID as shown
below, depending on your platform.
Windows
1. Go to Connect to Network.
• Windows 8  Go to the Settings menu and click the
Network icon.
• Windows 10/7  Right-click the Network icon.
2. Select the Guest Network SSID and click Connect. 2. Control-click the UniFi application and then click Show
3. Depending on the security type applied to the Package Contents.
network, enter the security key or password. Click OK
or Connect.
4. Launch your web browser and you will be directed to
the default portal page for the authentication type
configured on the Guest Portal (see “Settings > Guest
Control” on page 27 for screenshots of default
portal pages by authentication method).
Mac
1. Click the AirPort icon in the menu bar (top right 3. Double-click the Contents folder to open it.
side of the screen).
2. Select the Guest Network SSID and click Connect.
3. Depending on the security type applied to the
network, enter the security key or password. Click OK.
4. Once connected, the AirPort icon will change from
gray to solid black. The number of black lines indicates
the signal strength.
5. Launch your web browser and you will be directed to
the default portal page for the authentication type
configured on the Guest Portal (see “Settings > Guest
Control” on page 27 for screenshots of default 4. Double-click the Resources folder to open it.
portal pages by authentication method).

Setup
The html and css files are located on the system that the
UniFi Controller software has been installed on. The files
are in the following locations:
UniFi Cloud Key
/srv/unifi/data/sites/<site_name>/portal
Mac
/Applications/UniFi.app/Contents/Resources/data/
sites/<site_name>/portal
Windows
<Drive_Letter>:\Users\<Username>\Ubiquiti UniFi\data\
sites\<site_name>\portal
For specific instructions on accessing the files, refer to the
specific operating system:
• Mac
• “Windows” on page 120

118 Ubiquiti Networks, Inc.

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

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

6. Double-click the sites folder to open it.

10. To customize the voucher, double‑click the bundle
folder to open it.

7. Double-click the folder whose name matches the site
ID (for example: /manage/s/<site_ID>/dashboard).

11. You can customize voucher.css and voucher.html to fit
your needs.

8. Double-click the portal folder to open it.

Ubiquiti Networks, Inc. 119

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

Windows
The Windows files are located in the following location:
<Drive_Letter>:\Users\<Username>\Ubiquiti UniFi\
data\sites\<site_name>\portal
Customizable Default Files
The following default customizable html and css files are
located in the portal folder:
• index.html  Main landing page that displays pricing to
the guest.
• payment.html  Used to submit credit card information.
It requires https and also serves as an example of an
additional .html page.
• fail.html  Displayed when there is an error handling a
guest login.
• reset-min.css  Standardizes the rendering of HTML
elements across browsers.
• styles.css  Controls the style of HTML elements.
The following default files are located in the bundle folder:
• voucher.html  Page for vouchers.
• voucher.css  Standardizes the rendering of HTML
elements across browsers.
• messages.properties  You can edit this file using a
text editor such as TextEdit. This file defines package
costs, duration of access, duration of a free trial period,
package titles, and how the charge will appear on a
customer’s credit card account. Error messages are also
defined by this file.

Additional details on portal customization can be found in
our community site at:
http://ubnt.link/UniFi-Portal-Customization

120 Ubiquiti Networks, Inc.

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

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

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

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

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

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

127 . • TX Power  The default is Auto. Inc. • Channel  Select a channel number or keep the default. or Low. Medium. Auto. • Enabled  Enable or disable wireless functionality. • Security Key  Enter the passphrase. Select High. Configure the following settings for each radio: Radio 2G (11n/b/g) Radio Settings Radio 5G (11n/ac) • Channel  Select a channel number or keep the default. • Security  Select the security method you want to use. Ubiquiti Networks. • TX Power  The default is Auto. Radio Settings Auto. Select High. • (channel width)  Select the appropriate channel width. Medium. Low. or • (channel width)  Select the appropriate channel width. from the list.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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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

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

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

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

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

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