Ubiquiti UniFi User manual

Enterprise System Controller
Release Version: 5.3.8

i
Table of ContentsUniFi Controller User Guide
Ubiquiti Networks, Inc.
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

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

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

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

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

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

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

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