Enterprise System Controller

Release Version: 5.0.6

UniFi Controller User Guide Table of Contents

Table of Contents

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

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

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

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

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

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

Ubiquiti Networks, Inc. i

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

UniFi Controller User Guide Chapter 4: Dashboard

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

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

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

Ubiquiti Networks, Inc. 39

Chapter 4: Dashboard UniFi Controller User Guide

Speed Test WAN
Results from the latest Speed Test are displayed. The basic details of the UniFi Security Gateway are
• Last Run  Displays the duration of time since the last displayed.
Speed Test.
• Latency  Displays the amount of time it takes a packet
to travel from the UniFi Security Gateway to the service
provider’s gateway.
• Up  Displays the upload speed.
• Down  Displays the download speed.
The monitor is color-coded to indicate status:
Green  The WAN connection is active.
Red  The WAN connection is inactive.
Active Devices  Displays the number of Gateway devices
adopted and active.
Inactive  Displays the number of Gateway devices
adopted but not active.
Pending  Displays the number of Gateway devices
pending adoption.
Status information  Place your mouse over the monitor
to display the following:
• LAN IP  Displays the local IP address of the UniFi
Security Gateway.
Speed Test  Click the monitor to run the Speed Test.
• Clients  Displays the total number of local clients.
• Up  Displays the upload rate of your Internet
connection.
• Down  Displays the download rate of your Internet
connection.

After the Speed Test is complete, the following will be
displayed:
• Latency, duration of the average Ping round-trip time
• Download speed
• Upload speed
LAN
The basic details of the wired network(s) are displayed.

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

40 Ubiquiti Networks, Inc.

UniFi Controller User Guide Chapter 4: Dashboard

Pending  Displays the number of wired devices pending
adoption.
Status information  Place your mouse over the monitor
to display the following:
• Gateway  Displays the Internet IP address of the UniFi
Security Gateway.
• Users  Displays the number of clients connected to the
wired network. Download Throughput & Latency
• Guests  Displays the number of clients connected to the The historical chart displays the download traffic in terms
guest wired network. of throughput and latency over a 24-hour period.
• Switches  Displays the number of UniFi Switches
Note: A UniFi Security Gateway must be active to
managed on this site.
enable this chart.
• Down  Displays the download rate of the wired
network(s).
• Up  Displays the upload rate of the wired network(s).

Avg/Max Throughput  Average throughput is displayed
as a dark gray bar. Maximum throughput is displayed as a
light gray bar.
Latency  Latency is displayed as a blue line.
Status information  Place your mouse over a specific
point to display the following about a date and time:
WLAN • Avg/Max Throughput  Displays the average and
The basic details of the wireless network(s) are displayed. maximum throughput values.
• Latency  Displays the latency value.

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

Ubiquiti Networks, Inc. 41

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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

then Locate is automatically selected. Apply  Click Apply to save the inform URL. enter the device username. Actions  If you clicked the Manage button. enter the device password. flash so that it can be differentiated from the other APs. 122 Ubiquiti Networks.) The following window will appear: Actions  If you clicked the Locate button. The following window will appear: Set the inform URL. The LED on the AP will automatically selected. enter the device password. Username  If required.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. . Username  If required. Inc. port. Password  If required. Password  If required. allowing the AP to be managed by the UniFi Controller software running in a NOC or in the cloud. enter the device username. Set Inform URL  Enter the URL. then Manage is Apply  Click Apply to locate the AP. and path to the UniFi Controller software.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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

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

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

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

2580 Orchard Parkway San Jose. Inc.com/unifi Downloads: downloads.UniFi Controller User Guide Appendix F: Contact Information Appendix F: Contact Information Ubiquiti Networks Support Ubiquiti Support Engineers are located around the world and are dedicated to helping customers resolve software.ubnt. hardware compatibility. Ubiquiti Networks. CA 95131 www.com Online Resources Support: ubnt. or field issues as quickly as possible.ubnt. We strive to respond to support inquiries within a 24-hour period. 151 .com/unifi JL061716 Ubiquiti Networks.ubnt. Inc.link/UniFi-Support Community: community.

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