Enterprise WiFi System Controller Release Version: 3.
UniFi® Controller User Guide Table of Contents Table of Contents Chapter 1: System Setup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 Network Topology Requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 Hardware Overview and Installation . . . . . . . . . . . .
UniFi® Controller User Guide Table of Contents Chapter 10: User/Guest Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 History. . . . . . . . . . . . . . . . .
UniFi® Controller User Guide Chapter 1: System Setup UniFi Example Diagram UAP-AC UAP-Outdoor+ Wireless Uplink1 UAP-PRO UAP-PRO Router UAP-PRO or On-Site Management Station Off-Site Cloud/NOC2 1 Please refer to “Wireless Uplinks” on page 39 for setting up wireless-linked APs. 2 All UniFi APs support off-site management controllers. Chapter 1: System Setup System Requirements The UniFi® Controller is a wireless network management software solution from Ubiquiti Networks™.
UniFi® Controller User Guide Chapter 1: System Setup Software Installation PC Users The UniFi Controller software is installed just once when you initially create a UniFi network. UniFi APs can be added at any time through the controller interface but you do not need to go through the software installation process every time you add another UniFi AP. 1. Launch UniFi-installer.exe. 2. Click Install. Download the UniFi Controller software from the Ubiquiti Networks website. 1. Go to downloads.ubnt.
UniFi® Controller User Guide For most versions of Windows, the UniFi Controller software can also be launched from Start > All Programs. Chapter 1: System Setup 4. The UniFi Installation Wizard will create a secure primary wireless network for your devices. Perform the following steps: For Windows 8, the UniFi Controller software can also be launched from the Start menu. Configuring the UniFi Controller Software 1. The UniFi Controller software startup will begin.
UniFi® Controller User Guide Chapter 1: System Setup 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 the next chapter for information on using the UniFi Controller software. Ubiquiti Networks, Inc.
UniFi® Controller User Guide Chapter 2: Using the UniFi Controller Software Chapter 2: Using the UniFi Controller Software Welcome At the top left of the screen, click Welcome to display the Change Password and Logout options: The UniFi Controller software has a browser-based interface for easy configuration and management. To access the interface, perform the following steps: 1. Launch the UniFi Controller application if hasn’t already been started.
UniFi® Controller User Guide Chapter 2: Using the UniFi Controller Software Site Recent Events The UniFi Controller can manage multiple UniFi networks, which are called sites. Each site has its own configurations, maps, statistics, guest portals, and site administrator accounts. The multiple sites are logically separated, and the initial site is named default. The Recent Events tab displays a list of recent events, along with the corresponding date, time, and message.
UniFi® Controller User Guide Clicking an Alert Device Link The messages have clickable links [blue text in gray brackets] for AP (see “Access Point Details” on page 32), User, and Guest (see “User/Guest Details” on page 43). Details vary based on the selection. Settings The Settings tab displays a list of available sub-tabs: Site Site-related settings. Wireless Networks Wireless networks and group setup, including Zero Handoff Roaming. Guest Control Guest portal and policies.
UniFi® Controller User Guide Chapter 2: Using the UniFi Controller Software Settings > Wireless Networks Configure the following options: Configure the wireless networks for each site. You can have up to four wireless network names or SSIDs per WLAN group. -- Radio Select the appropriate radio, 2G or 5G. -- Channel Select the channel that all of the APs will use for Zero Handoff Roaming. -- Create Click Create to save changes. -- Cancel Click Cancel to discard changes.
UniFi® Controller User Guide -- WEP WEP (Wired Equivalent Privacy) is the oldest and least secure security algorithm. WPA™ security methods should be used when possible. Chapter 2: Using the UniFi Controller Software Advanced • VLAN To use a VLAN, select Use VLAN ID and enter the port number. • Hide SSID Select this option if you don’t want the wireless network name or SSID to be broadcast. • WEP Key Enter a WEP encryption key in hexadecimal format.
UniFi® Controller User Guide Settings > Guest Control The Guest Control screen displays the following sections: • Guest Policies (see below) • “Hotspot” on page 11 (for Hotspot authentication) • “Access Control” on page 12 Chapter 2: Using the UniFi Controller Software Portal Customization Select this option to have customized portal pages appear in place of the default login pages. See “Portal Customization” on page 48 for details on setting up custom portal pages.
UniFi® Controller User Guide Portal URL Hostname Enter a hostname for the portal URL in place of the default IP address. Paired with an SSL certificate, this ensures that site certificates are displayed as trusted in the guest browser. Example: www.ubnt.com Chapter 2: Using the UniFi Controller Software Hotspot When Hotspot authentication is selected, the Hotspot section is displayed.
UniFi® Controller User Guide -- Quickpay (Europe) Use your Quickpay account. To manage payments and transactions, use Hotspot Manager and see “Hotspot Manager” on page 45. Chapter 2: Using the UniFi Controller Software When logging in with voucher-based Hotspot authentication, guests will be required to enter the voucher number and accept the Terms of Use before gaining access to the Internet. Enter the QuickPay account details: • Merchant ID Enter the ID for your account.
UniFi® Controller User Guide Chapter 2: Using the UniFi Controller Software Settings > User Groups Settings > Controller Configure user groups on this screen. The default user group is named Default and has no bandwidth limits. Configure the system settings of the UniFi Controller. User Group Settings Name Displays the name of the user group. Bandwidth Limit Displays the upload and download limits. Actions Click a button to perform the desired action: • Edit Make changes to the user group settings.
UniFi® Controller User Guide Chapter 2: Using the UniFi Controller Software Settings > Site Admins Admin You can create administrator accounts that are site‑specific; these site administrators can only see the sites they manage. The Admin tab displays server version information, allows system backups to be created and downloaded, allows system restoration from backup files, and allows configuration information to be downloaded to assist in support issues.
UniFi® Controller User Guide Chapter 3: Map Tab 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 wireless network. When you initially launch the UniFi Controller application, a default map is displayed. The legend at the bottom of the map shows the scale of the map. Chapter 3: Map Tab Once you’ve created the map, you can upload it to the UniFi Controller software by performing the following steps: 1.
UniFi® Controller User Guide Chapter 3: Map Tab Adding a Google Map 2. Click Add a Map. Add a Map To add a Google Map to the UniFi Controller software Map view: 1. Click Configure Maps. Configure Maps button 3. Enter a map name in the Description field and click Upload my own. Click the Browse button to locate the file to use as a map (valid file formats are .jpg, .gif, and .png). Click Continue. 2. Click Add a Map. Add a Map 4. Click Close. 3.
UniFi® Controller User Guide 4. The default view is Map, which looks like a street map. Use the tools on the left to navigate the map or zoom in/out. Chapter 3: Map Tab 5. Click Close. You can adjust the zoom using the slider on the right. In the Search field, you can enter an address or the latitude and longitude of a specific location. Then press the return or enter key. You can also click Satellite for a satellite view, as seen from above.
UniFi® Controller User Guide Wired/Wireless Access Point Each icon indicates the location of the Access Point on the map. Click and hold this icon to drag the Access Point to another location on the map. Click an Access Point icon to reveal additional options. Click a blank area of the map to hide the icons. Note: Not all icons are shown here. Chapter 3: Map Tab Show: Click any of the following options to display Access Point labels, details, wireless coverage, and topology on the map.
UniFi® Controller User Guide Topology Displays a visual representation of the network configuration and connections between Access Points. Any device that is wirelessly connected will have a wireless icon next to it. A path of arrows will indicate the wireless Access Point and its uplink to a wired Access Point. Map: If multiple maps have been uploaded, you can select which map you want to view using this option. Chapter 3: Map Tab Setting the Map Scale 1. Click the Set Map Scale button. 2.
UniFi® Controller User Guide Chapter 4: Statistics Tab The Statistics tab provides a visual representation of the network traffic connected to your managed APs. Charts representing the number of clients and network traffic. An hour-by-hour chart of the usage over the last 24 hours is also displayed on this screen. Chapter 4: Statistics Tab Date At the top right of the screen, you can filter the statistics by date and time period.
UniFi® Controller User Guide Quick Look Chapter 4: Statistics Tab Clear current stats Reset the current statistics to start over. Recent Activities The details of recent network activities are displayed. Most Active AP The details of the most active Access Point are displayed: Name or MAC address You can click this link to open the AP Details screen. See “Access Point Details” on page 32 for additional information. Download Displays the total amount of data downloaded by the AP.
UniFi® Controller User Guide Chapter 5: Access Points Tab Chapter 5: Access Points Tab Overview The Access Points tab displays a list of managed Access Points. Three sub-tabs display different status information: • Overview Displays the number of clients, amount of data downloaded, amount of data uploaded, and channel setting. • Config Displays the WLAN and radio settings for the 2.4 GHz and 5 GHz radio bands. • Performance Displays the number of 2.
UniFi® Controller User Guide Status Displays the connection status. • Connected The Access Point is physically wired to the network. Chapter 5: Access Points Tab Config • Connected (wireless) The Access Point is wirelessly uplinked to a physically wired Access Point. • Disconnected The Access Point is unreachable by the UniFi Controller software. Disconnected Access Points will also appear under Access Points > Disconnected at the top of the interface.
UniFi® Controller User Guide • Adopt Adopt an Access Point that appears under Access Points > Pending at the top of the interface. The Status will appear as Adopting until the Access Point is connected. Chapter 5: Access Points Tab 2G Clients Displays the number of clients connected to the Access Point using the 2.4 GHz band. 5G Clients Displays the number of clients connected to the Access Point using the 5 GHz band. TX Displays the overall TX (transmit) rate. RX Displays the overall RX (receive) rate.
UniFi® Controller User Guide Chapter 6: Users Tab The Users tab displays a list of users that are connected to the primary wireless network(s) of an Access Point. You can click any of the column headers to change the list order. Chapter 6: Users Tab Filter by AP Drop-down menu of all available Access Points. Select one to filter the results and only display users connected to the selected Access Point. Page Size Select how many results are displayed per page: 10, 20, 30, 40, 60, or 100.
UniFi® Controller User Guide Chapter 6: Users Tab Signal Displays the percentage of signal strength and type of signal in use. The leaf symbol indicates power save mode. The device will return to active mode when Down or Up activity resumes. Icon Clients Mode ac 5 GHz (802.11ac) Active ac 5 GHz (802.11ac) Power Save a 5 GHz (802.11a) Active a 5 GHz (802.11a) Power Save n 5 GHz (802.11n) Active n 5 GHz (802.11n) Power Save n 2.4 GHz (802.11n) Active n 2.4 GHz (802.
UniFi® Controller User Guide Chapter 7: Guests Tab The Guests tab displays a list of guests that are connected to the guest network(s) of an Access Point. You can click any of the column headers to change the list order. Chapter 7: Guests Tab Filter by AP Drop-down menu of all available Access Points. Select one to filter the results and only display guests connected to the selected Access Point. Page Size Select how many results are displayed per page: 10, 20, 30, 40, 60, or 100.
UniFi® Controller User Guide Chapter 7: Guests Tab Signal Displays the percentage of signal strength and type of signal in use. The leaf symbol indicates power save mode. The device will return to active mode when Down or Up activity resumes. Icon Clients Mode ac 5 GHz (802.11ac) Active ac 5 GHz (802.11ac) Power Save a 5 GHz (802.11a) Active a 5 GHz (802.11a) Power Save n 5 GHz (802.11n) Active n 5 GHz (802.11n) Power Save n 2.4 GHz (802.11n) Active n 2.4 GHz (802.
UniFi® Controller User Guide Chapter 8: Insight Tab Chapter 8: Insight Tab Known Wireless Clients The Insight tab displays different kinds of status information. Four sub-tabs are available: • Known Wireless Clients Displays information about detected wireless clients. • Rogue Access Points Displays information about APs not managed by the UniFi Controller.
UniFi® Controller User Guide For the User, Guest, and All filters, a secondary filter is available: • Offline Only Only display clients who are currently offline. • All Display all clients, regardless of connection status. Last Seen Filter the results on the page based on the time the client was last seen. Select 1 day, 3 days, 7 days, 2 weeks, 1 month, 2 months, or 1 year. Chapter 8: Insight Tab Location Displays the name of the closest Access Point managed by UniFi.
UniFi® Controller User Guide Chapter 8: Insight Tab Past Guest Authorizations Date Filter by date. Name/MAC Address Displays the hostname, alias, or MAC address of the previous guest. Package Displays the name of the guest access package. Amount Displays the amount paid by the guest. Authorized By Displays the name of the authorizing body. Start Displays the start date and time of guest access. Duration Displays the length of time the guest was connected.
UniFi® Controller User Guide Chapter 9: Access Point Details UniFi Access Points connect to the UniFi Controller software either by Ethernet, indicated as Connected, or by a wireless connection, indicated as Connected (wireless). Based on connection type, options under each tab vary. Note: The UniFi AP-AC and AP-AC Outdoor do not support wireless uplinks for the initial release, but they will with a future firmware upgrade.
UniFi® Controller User Guide Chapter 9: Access Point Details Uplink (Wire) Downlinks Click Uplink (Wire) to display details about the wired uplink. The wireless Access Points currently connected to the wired Access Point are displayed. Speed Displays the connection speed in Mbps. Duplex Displays the mode, Full Duplex or Half Duplex. Down Pkts/Bytes Displays the amount of data downloaded as packets and bytes. Up Pkts/Bytes Displays the amount of data uploaded as packets and bytes.
UniFi® Controller User Guide Chapter 9: Access Point Details Radio 2G (11n/b/g) or Radio 5G (11n/a) Click Radio 2G (11n/b/g) or Radio 5G (11n/a) to display the channel and transmit/receive statistics. Channel Displays the wireless channel in use. Transmit Power Displays the EIRP in dBm. Note: If the device has an external antenna, you can place the mouse over the icon for additional details. TX Pkts / Bytes Displays the amount of data transmitted by the Access Point as packets and bytes.
UniFi® Controller User Guide Users Chapter 9: Access Point Details Guests Name Displays the hostname, alias, or MAC address of the connected guest. You can click the name to get additional details. See “User/Guest Details” on page 43 for more information. WLAN Displays the network name or SSID of the wireless network in use. Signal Displays the percentage of signal strength between the guest and AP. TX Displays the TX (transmit) rate.
UniFi® Controller User Guide Configuration Chapter 9: Access Point Details Radio(s) Change device configuration settings. Click the Apply button to save changes. Config Alias Enter or edit the name of the device. Apply Click Apply to save your change. Radio (11n/b/g) or Radio (11n/a) Channel Select a channel or keep the default setting, Auto. You can also use the default HT20 for 20 MHz operation or HT40 for 40 MHz operation.
UniFi® Controller User Guide Chapter 9: Access Point Details WLANs You can deploy multiple wireless networks organized into WLAN groups on different Access Points. Override Enabled Select the checkbox to enable override settings on the Access Point. VLAN Select the checkbox to enable the VLAN. • VLAN ID The VLAN ID is a unique value assigned to each VLAN on a single device. Enter a value between 2 and 4095.
UniFi® Controller User Guide Chapter 9: Access Point Details Network Configure the Access Point to obtain an IP address automatically or use a static IP address. Configure IP Select Using DHCP or Static IP: • Using DHCP Obtain the IP address, gateway IP address, and DNS (Domain Name Server) addresses dynamically from the external DHCP server. • Static IP Assign fixed network settings to the Access Point. -- IP address Enter the IP address for the Access Point.
UniFi® Controller User Guide Chapter 9: Access Point Details Wireless Uplinks Access Point - Heartbeat Missed When an Access Point is not connected by a wire, the Wireless Uplinks section lists potential uplink Access Points that can be selected to establish a wireless connection. When a wired Access Point is disconnected from the router, its state will initially change to Heartbeat Missed, followed by Isolated, and ending with Disconnected.
UniFi® Controller User Guide Chapter 9: Access Point Details Access Point - Isolated Access Point - Disconnected When an Access Point is in an Isolated state, you can reestablish a connection to the UniFi Controller software using one of three methods: When an Access Point is in a Disconnected state, you can reestablish a connection to the UniFi Controller software using one of three methods: • Reconnect the Access Point to the router. • Reconnect the Access Point to the router.
UniFi® Controller User Guide Access Point - Managed by Other Chapter 9: Access Point Details Advanced Adoption The Managed by Other state indicates that the Access Point is not in the default state but it is not controlled by the UniFi Controller. Overview MAC Address Displays the MAC address of the Access Point. Model Displays the model number. Version Displays the version of software used on the Access Point. Last Seen Displays the amount of time that has passed since the Access Point was last seen.
UniFi® Controller User Guide Access Point - Pending Approval Chapter 9: Access Point Details Forget this AP/Move The Pending Approval state indicates that the Access Point is in the default state and is available for adoption. MAC Address Displays the MAC address of the Access Point. Model Displays the model number. Version Displays the version of software used on the Access Point. Last Seen Displays the amount of time that has passed since the Access Point was last seen.
UniFi® Controller User Guide Chapter 10: User/Guest Details Chapter 10: User/Guest Details Statistics The User and Guest hyperlinks open the User/Guest Details window. Unless otherwise needed to specify differences between the user and guest, this User Guide will refer to both as user in the rest of this chapter.
UniFi® Controller User Guide History Chapter 10: User/Guest Details Configuration Config Date/Time Displays the date and time the user first connected to the Access Point. Duration Displays the length of time the user was connected to the Access Point. Down Displays the amount of data downloaded by the user during the session. Up Displays the amount of data uploaded by the user during the session. Alias Enter a name for the user. Note Enter a description or comments.
UniFi® Controller User Guide Chapter 11: Hotspot Manager Hotspot Manager includes four main tabs when accessed by the UniFi Controller admin account. These tabs include Wireless Guests, Payments/Transactions, Vouchers, and Operator Accounts. The UniFi Controller admin can create operator accounts for the Hotspot Manager. Operator accounts are designed for use by hotels or other businesses to service guests and have no access to other UniFi administrative features.
UniFi® Controller User Guide Chapter 11: Hotspot Manager Payments/Transactions Vouchers The Hotspot’s payments and transactions are displayed. Create vouchers that include distributable codes, duration values, and use restrictions. Search Enter keywords in the Search field to find a specific voucher based on Time, Name, Package, Amount, Extra Info, or Status value. Show guests within Filter by time duration: last 24 hours, 3 days, 7 days, 2 weeks, 30 days, and 120 days.
UniFi® Controller User Guide Chapter 11: Hotspot Manager Operator Accounts Create Operator Accounts that can log in to Hotspot Manager to manage wireless guests, payments or transactions, and vouchers. Search Enter keywords in the Search field to find a specific operator account based on Name, Password, or Notes value. Account Displays the name of the operator. Password Displays the password. Notes Displays any descriptive notes.
UniFi® Controller User Guide Appendix A: Portal Customization Overview With Portal Customization, the UniFi Controller software allows complete branding of a portal implementation, allowing you to “white label” your wireless Internet service as if you had developed it yourself. In order to provide the maximum flexibility in your branding effort, the UniFi Controller software provides total access to the portal directory on the system in which it is installed.
UniFi® Controller User Guide Mac Appendix A: Portal Customization 5. Double-click the data folder to open it. 1. Navigate to Go > Applications. 2. Control-click the UniFi application and then click Show Package Contents. 6. Double-click the sites folder to open it. 3. Double-click the Contents folder to open it. 7. Double-click the folder whose name matches the name of the site you are configuring. 4. Double-click the Resources folder to open it. 8. Double-click the portal folder to open it.
UniFi® Controller User Guide 9. You have several files that you can customize in the portal folder (these are described in the Customizable Default Files section). Appendix A: Portal Customization 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.
UniFi® Controller User Guide Appendix B: UniFi Discovery Utility Overview The Ubiquiti UniFi Discovery Utility includes tools that allow the discovery and management of UniFi Enterprise WiFi System Access Points. It is installed automatically as part of the UniFi Controller software installation process. See “Software Installation” on page 2 for more information.
UniFi® Controller User Guide Appendix B: UniFi Discovery Utility Locate Manage Locate the Access Point. The following window will appear: Set the inform URL, allowing the Access Point to be managed by the UniFi Controller software running in a NOC or in the cloud. (See “Network Topology Requirements” on page 1 for a visual representation of this configuration.) The following window will appear: Actions Locate is automatically selected. Username If required, enter the device username.
UniFi® Controller User Guide Appendix B: UniFi Discovery Utility Reset Reboot Reset the Access Point to factory default settings. The following window will appear: To reboot the Access Point, click any of the buttons (Locate, Manage, or Reset) on the UniFi Discovery Utility screen. The following window will appear: Actions Restore to factory default is automatically selected. Actions Select Reboot from the drop-down menu. Username If required, enter the device username.
UniFi® Controller User Guide Appendix C: Contact Information Appendix C: Contact Information Ubiquiti Networks Support Ubiquiti Support Engineers are located around the world and are dedicated to helping customers resolve software, hardware compatibility, or field issues as quickly as possible. We strive to respond to support inquiries within a 24-hour period. Online Resources Support: support.ubnt.com Community: community.ubnt.com Downloads: downloads.ubnt.
