Enterprise System Controller Release Version: 5.4.
UniFi Controller User Guide Table of Contents Table of Contents Chapter 1: Software Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Table of Contents UniFi Controller User Guide Chapter 7: Clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 All. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 Wireless. . . . . . . . . . . . . . .
UniFi Controller User Guide Table of Contents Chapter 14: Client Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117 Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117 Wireless Client – Details . . . . . . . . . . . . . . . . . . . . .
Table of Contents UniFi Controller User Guide Appendix E: Controller Scenarios. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153 Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153 Hosting Controller Software. . . . . . . . . . . . . . . . . . . . . . . . . .
UniFi Controller User Guide Chapter 1: Software Installation Chapter 1: Software Installation 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. Introduction Thank you for purchasing the Ubiquiti Networks® UniFi® Enterprise System.
Chapter 1: Software Installation UniFi Controller User Guide on page 2. PC Users 1. Launch UniFi-installer.exe. 2. Click Install. Configuring the UniFi Controller Software 1. The UniFi Controller software startup will begin. Click Launch a Browser to Manage Wireless Network. 3. If your computer doesn’t have Java 1.6 or above installed, you will be prompted to install it. Click Install to continue. Note: The above applies to Windows and OS X only.
UniFi Controller User Guide 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. 4. The UniFi Setup Wizard will create a secure primary wireless network for your devices. Chapter 1: Software Installation 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.
Chapter 1: Software Installation UniFi Controller User Guide Proceed to “Using the UniFi Controller Software” on page 17 for information on using the UniFi Controller software. 4 Ubiquiti Networks, Inc.
UniFi Controller User Guide Chapter 2: UniFi Cloud Chapter 2: UniFi Cloud Chrome Instructions 1. Ensure that your host system is on the same Layer-2 network as the UniFi Cloud Key. Introduction You can access the UniFi Controller via the UniFi Cloud Key and/or the UniFi cloud account. This chapter describes the following: • UniFi Cloud Key 2. Launch the Chrome web browser and type https://unifi.ubnt.com in the address field. Press enter (PC) or return (Mac). https://unifi.ubnt.
Chapter 2: UniFi Cloud 6. To install the tool: a. Click Install. UniFi Controller User Guide 9. Wait for the UniFi Controller to be adopted, and then select it. b. Click Add app to confirm. 10. Click Launch. 7. The Ubiquiti Device Discovery Tool will search for the UniFi Cloud Key. Select it to continue. 8. Configure the UniFi Controller: a. Select the appropriate country. b. Select the appropriate time zone. c.
UniFi Controller User Guide Instructions for Other Web Browsers 1. Ensure that your host system is on the same Layer-2 network as the UniFi Cloud Key. Chapter 2: UniFi Cloud 6. Select the devices that you want to configure and click Next. 2. The UniFi Cloud Key is set to DHCP by default, so it will try to automatically obtain an IP address. Assign a specific IP address to the UniFi Cloud Key, or check the DHCP server for its IP address. Note: The default fallback IP address of the UniFi Cloud Key is 192.
Chapter 2: UniFi Cloud 8. Create the super admin for your UniFi Controller. UniFi Controller User Guide 10. 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. 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.
UniFi Controller User Guide 3. Launch the web browser. In the address field, type https:// followed by the appropriate IP address. Press enter (PC) or return (Mac). Chapter 2: UniFi Cloud Navigation Bar The UniFi Cloud Key configuration consists of three primary pages: • Main (see next column) • “Configuration” on page 10 4. You have two options: • “Maintenance” on page 11 • Manage Click Manage to access the UniFi Controller.
Chapter 2: UniFi Cloud UniFi Controller User Guide Main Network Settings The Main screen displays basic status information about the UniFi Cloud Key. Configuration Mode Select the Internet connection type for your service: Static or DHCP. • Static The service provider assigns fixed network settings to your service for manual entry. Enter the following information: -- IP address Enter the Internet IP address of the UniFi Cloud Key. -- Netmask Enter the subnet mask of the UniFi Cloud Key.
UniFi Controller User Guide Chapter 2: UniFi Cloud Maintenance Firmware The Maintenance screen contains administrative options, so you can change the password, reboot the UniFi Cloud Key, power it off, reset it to factory defaults, upgrade the UniFi Cloud Key firmware, or upgrade the UniFi Controller software. Version Displays the version number of the UniFi Cloud Key firmware. Check for Updates Click Check for Updates to see if there is a newer firmware version.
Chapter 2: UniFi Cloud UniFi Controller User Guide UniFi Version Displays the version number of the UniFi Controller software. Check for Updates Click Check for Updates to see if there is a newer software version. If there is, 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 43 for more information) before upgrading the Unii Controller software.
UniFi Controller User Guide Chapter 2: UniFi Cloud Version Displays the software version number of your UniFi Controller. Actions Click a button to perform the desired action: My Account To change your account settings and/or password, click . The Account Settings screen will appear: • Forget Click FORGET to remove the UniFi Controller from your cloud account. • Manage Click MANAGE to manage the UniFi Controller or the UniFi cloud key.
Chapter 2: UniFi Cloud UniFi Controller User Guide Find Cloud Key Additional Details To add a UniFi Cloud Key, click Find Cloud Key at the top right of the screen. The Find Cloud Key screen will appear: Select a UniFi Controller to display more information at the bottom of the screen. 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.
UniFi Controller User Guide • (map) Displays a visual representation of your network’s status. The status of each dashboard node is indicated by color: Chapter 2: UniFi Cloud -- WAN The basic details of the UniFi Security Gateway connection are displayed. -- Black Black indicates that the Internet connection is active. -- Green Green indicates that the node is active and all devices are online. • LAN IP Displays the local IP address of the UniFi Security Gateway.
Chapter 2: UniFi Cloud UniFi Controller User Guide • APs Displays the number of APs in the primary wireless network(s) and the number of APs in the guest wireless network(s). • Down Displays the download rate of the wireless network(s). • Up Displays the upload rate of the wireless network(s). 16 Ubiquiti Networks, Inc.
UniFi Controller User Guide Chapter 3: Using the UniFi Controller Software Chapter 3: Using the UniFi Controller Software Common Interface Options The common interface options are accessible from all tabs in the UniFi interface. 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.
Chapter 3: Using the UniFi Controller Software UniFi Controller User Guide -- WAN The icon is color-coded to display the WAN connection status. Green indicates active; red indicates inactive. Username At the top right of the screen, click the Username to display the Preferences, Edit Account, and Logout options: -- LAN The icon is color-coded to display the wired network connection status. Green indicates active; red indicates inactive. -- Active Displays the number of active wired devices.
UniFi Controller User Guide Chapter 3: Using the UniFi Controller Software • Cancel Click to discard changes. Controls and Live Chat • Reset to Defaults Click to reset to factory defaults. At the bottom left of the screen, there are four controls: Edit Account To change the login name and/or password, click .
Chapter 3: Using the UniFi Controller Software UniFi Controller User Guide Clicking an Event Device Link Clicking an Alert Device Link The messages have clickable links for client and UniFi devices: The messages have clickable links for client and UniFi devices: • “UniFi Security Gateway Details” on page 85 • “UniFi Security Gateway Details” on page 85 • “UniFi Switch Details” on page 93 • “UniFi Switch Details” on page 93 • “UniFi Access Point Details” on page 103 • “UniFi Access Point Details”
UniFi Controller User Guide Chapter 3: Using the UniFi Controller Software Site Configuration Remote Logging Enable to define a remote syslog server. Site Name Change the name of the site. • Remote IP Address Enter the IP address of the syslog server. Country Select the appropriate country. Time Zone Select the appropriate time zone. Services Advanced Features When enabled, airtime fairness, bandsteering, minimum RSSI, and load balancing features become available.
Chapter 3: Using the UniFi Controller Software • Mobility To enable seamless roaming (Zero Handoff ), select the checkbox. Note: The UAP-AC, UAP-AC-Outdoor, UAP‑AC‑LITE, UAP‑AC‑LR, UAP‑AC‑PRO, and UAP‑AC‑EDU do not support Zero Handoff Roaming. When you enable this option, multiple Access Points (APs) act as an AP cluster, appearing as a single AP. The wireless client detects only one AP, so it seamlessly roams from AP to AP – there is no need to re-negotiate.
UniFi Controller User Guide • Key Index Specify which Index of the WEP Key to use. Four different WEP keys can be configured at the same time, but only one is used. Select the effective key: 1, 2, 3, or 4. -- WPA-Personal WPA or Wi-Fi Protected Access was developed as an encryption method stronger than WEP. WPA-Personal requires a passphrase to connect to the wireless network.
Chapter 3: Using the UniFi Controller Software Create or Edit a Hotspot 2.
UniFi Controller User Guide Chapter 3: Using the UniFi Controller Software Roaming Consortium List Add or Edit a NAI Realm (List of roaming consortiums) Displays a list of roaming consortiums that have been defined for this NAI realm list entry: • Name Displays the name of the roaming consortium. Name Enter the name of the NAI realm. Realm Enabled Check the box to enable the NAI realm. This option is disabled by default.
Chapter 3: Using the UniFi Controller Software Actions Click a button to perform the desired action: • Edit Click to make changes to the network settings. Go to “Create or Edit a Network” on page 26. EDIT • Delete (Not available for the default network.) Click to remove the network. Create New Network Click to add a network. Go to “Create or Edit a Network” on page 26.
UniFi Controller User Guide • DHCP Lease Time Enter the DHCP lease time in seconds. The IP addresses assigned by the DHCP server are valid only for the duration specified by the lease time. Increasing the lease time will extend the time clients retain their IP address in absence of the DHCP server. However, any network changes will take just over half the lease length to apply to all clients.
Chapter 3: Using the UniFi Controller Software Site-to-Site VPN The UniFi Security Gateway is required for this option. UniFi Controller User Guide • Pre-Shared Key Enter the pre-shared secret key. Both peer routers must use the same pre-shared secret key for authentication. • IPsec Profile Select the appropriate option: • Customized Select this option to customize your settings. • Azure dynamic routing Select this option if you are using Microsoft Azure with dynamic routing for a route-based VPN.
UniFi Controller User Guide -- OpenVPN Select this option to create a VPN that uses the OpenSSL (Secure Sockets Layer) library and SSL/TLS (Transport Layer Security) protocols. • Enabled Select this option to create an OpenVPN tunnel over the Internet between two peer routers. (The UniFi Security Gateway is the local peer router.) • Remote Subnets Click Add Subnet to add an address for a remote network. • Add Subnet If you have another remote subnet, click this option and enter its network address.
Chapter 3: Using the UniFi Controller Software UniFi Controller User Guide Firewall Tab Predefined Firewall Rules The Firewall tab displays user-defined firewall information, organized into two sub-tabs: Rules and Groups. The following firewall rules are predefined (cannot be edited or deleted): Firewall > Rules The Rules sub-tab displays existing firewall rules. There are three instances per network type: In, Out, and Local. The interfaces currently are defined as WAN, LAN, and GUEST.
UniFi Controller User Guide Create or Edit a Static Route Chapter 3: Using the UniFi Controller Software Create or Edit a Firewall Rule Name Enter a name for the static route. Enabled Check this box checked to enable the route. The route is enabled by default. Type This read-only field displays the route type: Static. Network Enter the IP address and subnet mask using CIDR or slash notation: / (example: 192.0.2.0/24).
Chapter 3: Using the UniFi Controller Software Advanced Logging Check the box to enable logging (disabled by default). States Select each state that will apply to the rule (none are selected by default): [Please verify this all descriptions below; they are based on info found online] • New The packet is the first packet seen in a new connection. UniFi Controller User Guide To create a new port group, click Create Port Group, and then fill in the Name and Port fields.
UniFi Controller User Guide Guest Policies Enable Guest Portal Disabled by default. When disabled, guests can access the Internet without entering a password or accepting the terms of service. When this option is enabled, you can control the Guest Portal. Chapter 3: Using the UniFi Controller Software If you enable the terms of service, then guests will be required to accept the terms of use before gaining access to the Internet.
Chapter 3: Using the UniFi Controller Software UniFi Controller User Guide Redirect Using Hostname Select this option to enter and use 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 • Redirect to the original URL After connecting, guests are directed to the URL they requested.
UniFi Controller User Guide Chapter 3: Using the UniFi Controller Software AngularJS Select AngularJS for client-side rendering. Once you have the terms of service, then you can click to make changes. EDIT • Portal Customization You can make the following formatting changes: -- Customize logo Click Upload image and select the logo you want to use. (We recommend the use of the .png format.) Then click Open. -- Background image Click Upload image and select the image you want to use.
Chapter 3: Using the UniFi Controller Software Legacy JSP Server-side rendering is enabled by default. UniFi Controller User Guide • Payment Packages (Available only for payment-based authentication.) There are three packages by default: Basic 8HR ($5.99), Premium Daypass ($8.99), and Free Trial. -- Actions Click a button to perform the desired action: -- Edit Click to make changes to the package settings. Go to the Add or Edit a Package section. EDIT -- Delete Click to delete the package.
UniFi Controller User Guide Chapter 3: Using the UniFi Controller Software • Required Select this option if you want to make this field mandatory. -- Enable address field Select this option to create a field for an address. • Required Select this option if you want to make this field mandatory. -- Enable city field Select this option to create a field for a city. • Required Select this option if you want to make this field mandatory. -- Enable state field Select this option to create a field for a state.
Chapter 3: Using the UniFi Controller Software UniFi Controller User Guide Enter the Merchant Warrior account details: • Merchant UUID Enter the ID for your merchant account. • API Key Enter the API key. • API Passphrase Enter the API passphrase. • Use test account For Merchant Warrior testing purposes, select this option. Then click Apply Test Account to set up or access your Merchant Warrior test account.
UniFi Controller User Guide Access Control Chapter 3: Using the UniFi Controller Software Actions Click a button to perform the desired action: • Edit Click • Delete Click EDIT to make changes. to delete the profile. Add New RADIUS Profile Click to create a new RADIUS profile. The Create New Radius Profile screen appears. CREATE NEW RADIUS PROFILE Create New RADIUS Profile Pre-Authorization Access Enter any subnets that you want guests to be able to access, even if they have not been authenticated.
Chapter 3: Using the UniFi Controller Software Settings > Admins You can create administrator accounts that are site‑specific; these site administrators can only see the sites they manage and cannot see any devices that are Pending Approval. The super admin account is created during the Setup Wizard and has global admin (read/write) access; this super admin account cannot be revoked or re-invited.
UniFi Controller User Guide • Bandwidth Limit (Upload) Select to limit the upload bandwidth. Enter the maximum in Kbps. • Save Click to apply changes. • Cancel Click to discard changes. See “Wireless Client – Configuration” on page 119 or “Wired Client – Configuration” on page 120 for information on how to assign a user or guest to a user group. Settings > DPI Configure the Deep Packet Inspection (DPI) settings of the UniFi Controller.
Chapter 3: Using the UniFi Controller Software UniFi Controller User Guide Settings > Cloud Access Cloud Access Set up the login for cloud access. If the login for cloud access is configured, then the Cloud Access screen will appear: Enable Cloud Access Click to configure the login. The Cloud Login Credentials screen will appear. Enable Cloud Access Click to enable or disable cloud access. Cloud Login Credentials Status Displays “Connected” if cloud access is active.
UniFi Controller User Guide Chapter 3: Using the UniFi Controller Software Settings > Maintenance (Available for the superadmin only.) The Maintenance screen contains administrative options, so you can customize logs, manage system backups, and download configuration information to assist in support issues.
Chapter 3: Using the UniFi Controller Software • Version Displays the software version. • DPI Displays the status of the DPI (Deep Packet Inspection) feature, which is configured in “Settings > Site” on page 20. • Conn Monitor Displays the status of the Uplink Connectivity Monitor feature, which is configured in “Settings > Site” on page 20. • Cloud Access Displays the status of the Cloud Access feature. UniFi Controller User Guide • IGMP Snooping Displays the status of the IGMP Snooping feature.
UniFi Controller User Guide Chapter 3: Using the UniFi Controller Software Status Displays the current status, Up to Date or Update Available. Cloud Key Operations Restart Cloud Key Click this option to powercycle the UniFi Cloud Key. Shut Down Cloud Key Click this option to turn off the UniFi Cloud Key. Reset Cloud Key Click this option to reset the UniFi Cloud Key to its factory default settings. This option will reboot the UniFi Cloud Key, and all factory default settings will be restored.
Chapter 3: Using the UniFi Controller Software 46 UniFi Controller User Guide Ubiquiti Networks, Inc.
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 your network’s status.
Chapter 4: Dashboard UniFi Controller User Guide 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: • WAN IP Displays the IP address of the WAN interface. • Subnet Mask Displays the subnet mask of the WAN interface. Speed Test Click the monitor to run the Speed Test. • Gateway Displays the Internet IP address of the UniFi Security Gateway.
UniFi Controller User Guide • Guests Displays the number of clients connected to the guest wired network. • Switches Displays the number of UniFi Switches managed on this site. • Down Displays the download rate of the wired network(s). Chapter 4: Dashboard Download Throughput & Latency The historical chart displays the download traffic in terms of throughput and latency over a 24-hour period. Note: A UniFi Security Gateway must be active to enable this chart.
Chapter 4: Dashboard Devices on 2.4 GHz Channel The 2.4 GHz Channel Occupancy Chart displays the channel use of the 2.4 GHz devices. Note: At least one 2.4 GHz UniFi AP must be active to enable this chart. UniFi Controller User Guide LAN Displays the number of wired devices. WAN Displays the number of gateway devices. Status information Place your mouse over a specific device category to display the device models and their quantities. Clients Network clients are displayed.
UniFi Controller User Guide Chapter 4: Dashboard Network Protocols Displays the amount of data that is identified as network protocol traffic. Web / Web 2.0 Displays the amount of data that is identified as web-related traffic. Security Update Displays the amount of data that is identified as part of a security update. Unknown Displays the amount of data that is unidentified. Other Displays the amount of data that doesn’t belong in the aforementioned categories.
Chapter 4: Dashboard 52 UniFi Controller User Guide Ubiquiti Networks, Inc.
UniFi Controller User Guide Chapter 5: Map The Map screen allows you to upload custom map images of your location(s) or use Google Maps™ for a visual representation of your UniFi network. You can also view the system topology. When you initially launch the UniFi Controller application, a default map is displayed. The map scale is shown in the legend at the bottom of the map. Chapter 5: Map 2. Click Add a Map. 3. The default is Google Maps. Click Upload Image.
Chapter 5: Map 4. Click Choose map image. UniFi Controller User Guide Adding a Google Map To add a Google Map to the UniFi Controller software Map view: 1. Click . 5. Locate the file to use as a map (valid file formats are .jpg, .gif, and .png) and then click Open. If you do not want to upload a file, click Cancel. 2. Click Add a Map. 3. Enable this feature by following the provided guide on how to obtain a valid Google Maps API key. 6. Enter a map name in the field provided and click Save.
UniFi Controller User Guide Map View Terrain View Use the tools to navigate the map or adjust the zoom using the zoom control. In the field provided, enter an address or the latitude and longitude of a specific location. Then press Enter or Return. You can also click Satellite for a bird’s-eye view. Click Labels to display street and location names. Chapter 5: Map The device icon will appear in the area that you placed it. Once all devices have been placed the from black to gray.
Chapter 5: Map UniFi Controller User Guide Device Options You can apply one of the following display options: Click a UniFi icon to reveal options. Click the UniFi icon again to hide them. • Labels (None/Simple/Detailed) Lock Lock the device icon to its current location. Details Display the Details screen.
UniFi Controller User Guide Chapter 5: Map Configure Maps Click the current map(s). to add maps or edit The left side of the map offers the following options: Zoom Slider Use to zoom the map detail in and out. Devices Click to toggle the size of devices and their labels between normal (default) and large. Unplaced Devices Drag each device icon from the Unplaced Devices list to the appropriate location on the map. The legend at the bottom of the map shows the new scale of the map. System Topology 1.
Chapter 5: Map UniFi Controller User Guide 4. Click Link Labels to display labels on each link: The labels provide the following information: Wired links • Data rate in Mbps • Duplex type: FDX for full duplex, HDX for half duplex • Port number to which the device is physically connected • Wireless links • RSSI expressed as a percentage • RSSI displayed in dBm Note: The displayed RSSI value is from the AP side of the link; i.e., it is how the AP hears the client.
UniFi Controller User Guide Chapter 6: Devices The Devices screen displays a list of UniFi devices discovered by the UniFi Controller. You can click any of the column headers to change the list order. You can apply one of the following primary filters: • All Displays all UniFi devices. • Gateway/Switches Displays all UniFi Security Gateways and Switches. • APs Displays all UniFi APs. • Phones Displays all UniFi VoIP Phones.
Chapter 6: Devices The very first time you enable the Customize Columns option, the UniFi Controller software will detect which columns are currently visible and remember your selection. For example: 1. Enable the Customize Columns option on the APs > Performance screen. 2. Disable customization. 3. Apply the Gateway/Switches filter. 4. Enable the Customize Columns option again. 5. The columns of the APs > Performance screen will be displayed.
UniFi Controller User Guide UniFi 24-Port Switch UniFi 48-Port Switch UniFi VoIP Phone/Pro UniFi VoIP Phone Executive Chapter 6: Devices on the device. The Status will appear as Upgrading until the process is complete and the device reconnects to the UniFi Controller software. • Adopt Click to adopt a device that appears as Pending Approval for its status. The Status will appear as Adopting until the device is connected. If displayed, the LED color of the device icon indicates the device status.
Chapter 6: Devices UniFi Controller User Guide Note: The super admin account was created during the initial installation; for more information, see “Configuring the UniFi Controller Software” on page 2. Model Displays the model name of the UniFi device. Overview Down Displays the total amount of data downloaded by the UniFi device. Up Displays the total amount of data uploaded by the UniFi device.
UniFi Controller User Guide 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; for more information, see “Configuring the UniFi Controller Software” on page 2. Model Displays the model name of the UniFi device. Clients Displays the number of clients connected to the AP. Down Displays the total amount of data downloaded by the AP.
Chapter 6: Devices UniFi Controller User Guide TX 5G Displays the overall TX rate for the 5 GHz radio band. The different colors represent different types of packet activity: Color Packet Activity Packets sent Packets retried Packets not sent due to likely interference Channel Displays the transmit/receive channel being used by the AP. The radio band is represented as (ng) for 2.4 GHz and (na)/(ac) for 5 GHz. The LED color of the icon indicates the device status.
UniFi Controller User Guide • Adopt Click to adopt a device that appears as Pending Approval for its status. The Status will appear as Adopting until the device is connected. Phones Important: For management of the UniFi VoIP Phones, please download the UniFi VoIP Controller here: downloads.ubnt.com/unifi Chapter 6: Devices • Upgrade If a software upgrade is available for the device, click to install the latest UniFi firmware on the device.
66 UniFi Controller User Guide Ubiquiti Networks, Inc.
UniFi Controller User Guide Chapter 7: Clients The Clients screen displays a list of network clients. You can click any of the column headers to change the list order. You can apply one of the following primary filters: • All Displays all clients, regardless of connection type. • Wireless Displays all wireless clients. • Wired Displays all wired clients. A secondary filter is available: • All Displays all users and guests. • Users Only displays users. • Guests Only displays guests.
Chapter 7: Clients UniFi Controller User Guide • Signal Displays the signal strength level and signal type. • TX Rate Displays the overall TX (transmit) rate. • RX Rate Displays the overall RX (receive) rate. • Activity Displays the relative level of activity for each client. • Down Displays the total amount of data downloaded by the client. • Up Displays the total amount of data uploaded by the client. • Uptime Displays the amount of time the client has been connected for this session.
UniFi Controller User Guide Wireless Chapter 7: Clients • Unauthorize/Authorize (Available for Guests only.) Click UNAUTHORIZE to remove authorization of guest access and disconnect the guest, or click AUTHORIZE for guests pending authorization. Wired Frequency band If the Wireless filter is applied, then the Frequency band filter is available: • All Displays all wireless clients. • 2G Only displays 2.4 GHz clients. • 5G Only displays 5 GHz clients. AP Select the AP whose clients you want displayed.
Chapter 7: Clients 70 UniFi Controller User Guide Ubiquiti Networks, Inc.
UniFi Controller User Guide Chapter 8: Statistics The Statistics screen provides a visual representation of the clients and network traffic connected to your managed UniFi network. Chapter 8: Statistics Overview The Overview screen describes the usage by wireless clients and UniFi Access Points. There are two views available: • Overview The default view describes the wireless clients and network traffic. Please refer to the next column for more information.
Chapter 8: Statistics UniFi Controller User Guide Click the date to display the calendar. You can select multiple APs for filtering. For example, if you select a second AP: • Calendar Click a specific date to display its statistics. Click either arrow to change the calendar in one-month increments. A third graph that is color-coded to the additional AP appears. Filter You can view the number of clients and amount of traffic by UniFi AP.
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. Name or MAC address You can click this link to open the AP Details screen. See “UniFi Access Point Details” on page 103 for additional information. Download Displays the total amount of data downloaded by the AP. Upload Displays the total amount of data uploaded by the AP.
Chapter 8: Statistics UniFi Controller User Guide A list displays a comprehensive breakdown of the traffic by category. You can click any category to have it displayed with a detailed breakdown of the application usage within that category. 2. Select a category. You can also enter a keyword in the Filter field; simply begin typing; there is no need to press Enter. (Category) The most popular categories are displayed with the amount of traffic broken down further by application.
UniFi Controller User Guide Chapter 9: Insights Chapter 9: Insights On any sub-tab, you can click any of the column headers to change the list order. The Insights screen displays different kinds of status information. Eight filters are available: 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. • Known Clients Displays information about detected clients.
Chapter 9: Insights Known Clients UniFi Controller User Guide An additional filter is available: • Blocked Only display blocked clients. • Noted Only display clients whose configurations include notes. (See “Wireless Client – Configuration” on page 119 or “Wired Client – Configuration” on page 120 for more information.) • Static IP Only display clients using static IP addresses. Name Displays the hostname, alias, or MAC address of the connected client.
UniFi Controller User Guide Name/SSID Displays the name of the wireless network. BSSID Displays the MAC address of the AP’s wireless interface. Channel Displays the channel setting that the AP was detected on. Security Displays the security status indicating whether encryption is used. Manufacturer Displays the name of the AP manufacturer. Location Displays the name of the closest AP managed by the UniFi Controller. You can click the name to get additional details on the AP.
Chapter 9: Insights UniFi Controller User Guide Name/MAC Address Displays the hostname, alias, or MAC address of the previous guest. Select Customize columns. 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 the session. Duration Displays the length of time the guest was connected. Download Displays the total amount of data downloaded by the guest.
UniFi Controller User Guide Chapter 9: Insights PoE Displays the PoE setting: • (blank) PoE is disabled. • 24V Passive 24V passive PoE is enabled. • PoE+ 802.3at/af devices can be plugged in and automatically receive PoE. • __W Power output is displayed in watts. Mode Displays the operation mode: • Switching The default mode. • Mirroring The network traffic of this port will receive the mirrored traffic from the port selected in ”Port Configuration” on page 95.
Chapter 9: Insights PoE UniFi Controller User Guide Actions Click a button to perform the desired action: • Edit Click to make changes to the port settings. For more information, see “UniFi Switch Details” on page 93. EDIT • Clear Counters Click CLEAR COUNTERS to clear the port statistics. • Power Cycle If applicable, click POWER CYCLE to power cycle the port. Counters Port The ports display their status and port number: Indicates a 10/100 Mbps connection. Indicates a 1 Gbps (1000 Mbps) connection.
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. For more information, see “UniFi Switch Details” on page 93. EDIT • Clear Counters Click CLEAR COUNTERS to clear the port statistics. • Power Cycle If applicable, click POWER CYCLE to power cycle the port. Port Forward Stats You can apply one of the following primary filters: • All Displays all port forwarding entries.
Chapter 9: Insights User-Defined UniFi Controller User Guide Forward Port Displays the destination port that will receive the forwarded port traffic. Also known as the internal port. Packets Displays the number of packets transferred. Bytes Displays the number of bytes transferred. Lease Duration Displays the uptime of the port forwarding entry. Dynamic DNS Name Displays the name of the port forwarding entry. From Displays the source IP address, if specified, or Anywhere.
UniFi Controller User Guide Chapter 9: Insights Remote User VPN Customize Columns Click used for display. AC-EDU Streams to customize the columns Customize Columns Click used for display. to customize the columns Select Customize columns. Select Customize columns. You can add or remove columns for display. You can add or remove columns for display. Interface Displays the interface being used. Remote IP Displays the IP address of the remote user. User Displays the username of the remote user.
Chapter 9: Insights 84 UniFi Controller User Guide Ubiquiti Networks, Inc.
UniFi Controller User Guide Chapter 10: UniFi Security Gateway Details Chapter 10: UniFi Security Gateway Details The UniFi Security Gateway hyperlink opens the UniFi Security Gateway’s Details window either in the Properties panel or as a separate popup window. You can always dock this window in the Properties panel or detach it as a separate window. • Name/MAC Address Displays the device name or MAC address of the device. • Restart Click to restart the selected device.
Chapter 10: UniFi Security Gateway Details UniFi Security Gateway – Details Click Details to display the device specifics, LAN/WAN connection details, and uptime. Overview UniFi Controller User Guide IP Address Displays the WAN (public) IP address of the WAN interface. 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.
UniFi Controller User Guide Chapter 10: UniFi Security Gateway Details UniFi Security Gateway – Configuration Click Configuration to configure the alias, WAN settings, port forwarding, Dynamic DNS, and custom upgrade entries. You can also remove the Gateway from management by this UniFi Controller. General • Static IP The service provider assigns fixed network settings to your service for manual entry. Enter the following information: -- IP Address Enter the Internet IP address of the Gateway.
Chapter 10: UniFi Security Gateway Details • PPPoE Point-to-Point Protocol over Ethernet (PPPoE) is a virtual private and secure connection between two systems that enables encapsulated data transport. Enter the following information: -- Username Enter the username used to connect to the PPPoE server. -- Password Enter the password used to connect to the PPPoE server. -- Preferred DNS Enter the IP address of the service provider’s primary DNS server.
UniFi Controller User Guide Queue Changes Click Queue Changes to line up the changes to take effect. 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. Each section with pending changes is highlighted by an ellipsis.
Chapter 10: UniFi Security Gateway Details Create or Edit Port Forwarding Entry UniFi Controller User Guide Dynamic DNS Domain Name System (DNS) translates domain names to IP addresses; Each DNS server on the Internet holds these mappings in its respective DNS database. 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. Even if the device’s IP address changes, you can still access the device through its domain name.
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. To specify firmware saved in a custom location, select this option. (URL) Enter the location URL of the firmware. Custom Upgrade Click to upgrade the firmware from the location you entered.
Chapter 10: UniFi Security Gateway Details 92 UniFi Controller User Guide Ubiquiti Networks, Inc.
UniFi Controller User Guide Chapter 11: UniFi Switch Details Chapter 11: UniFi Switch Details -- Disconnected A red warning icon ! indicates no connection. A UniFi Switch hyperlink opens the UniFi Switch’s Details window either in the Properties panel or as a separate popup window. You can always dock this window in the Properties panel or detach it as a separate window. • Name/MAC Address Displays the device name or MAC address of the device. • Restart Click to restart the selected device.
Chapter 11: UniFi Switch Details • Networks/VLANs Displays the networks/VLANs that the port belongs to. UniFi Controller User Guide Uplink • Uplink/Downlink Displays the name of the uplink or downlink device. There are three clickable tabs: • “UniFi Switch – Details” on page 94 • “UniFi Switch – Ports” on page 95 • “UniFi Switch – Configuration” on page 98 UniFi Switch – Details Click Overview to display the device specifics, connection details, and uptime. Overview Port Displays the port number.
UniFi Controller User Guide Chapter 11: UniFi Switch Details Port Displays the number of the connected port. PoE Displays the PoE setting: Device Displays the name or MAC address of the downlink device. You can click the name to get additional details. • Off PoE is disabled. Model Displays the model number of the downlink device. Status Displays the connection speed and duplex mode.
Chapter 11: UniFi Switch Details • PoE All ports are set to auto-sensing PoE+ by default. -- Off Disable PoE. -- 24V Passive Select this option to power devices that support 24V passive PoE. Note: Before activating 24V passive PoE, ensure that the connected device supports PoE and the supplied voltage. -- PoE+ 802.3at/af devices can be plugged in and automatically receive PoE. • Networks/VLANs Select the appropriate network or VLAN, or select Disabled to disable this port. The default is All.
UniFi Controller User Guide Mirroring -- Mirroring This port’s network traffic will receive the mirrored traffic from the port listed below for analysis: • Mirroring Port Enter the number of the port that will be mirrored. • Link Negotiation The default is Auto, enabling Ethernet autonegotiation. This is the appropriate configuration for almost all circumstances.
Chapter 11: UniFi Switch Details UniFi Switch – Configuration Click Configuration to configure the alias, network/VLANs, services, and network settings. You can also use this tab to copy another switch’s configuration to this Switch, perform a custom upgrade, gain terminal access to the Switch, or remove the Switch from management. General UniFi Controller User Guide Create Click to add a new entry. Go to the “Create New Network/VLAN” on page 98 section below.
UniFi Controller User Guide Chapter 11: UniFi Switch Details • Tagged Networks The VLANs chosen here will be permitted as tagged on switch ports configured with this grouping. This permits ingress and egress traffic with the applicable VLAN tag. Any VLAN tags other than those chosen here will be dropped. As an example, the following illustrates how an access point’s switch port functions with one native network and two tagged VLANs used for additional wireless SSIDs.
Chapter 11: UniFi Switch Details UniFi Controller User Guide • Enable RADIUS VLAN Allows the RADIUS server to dynamically assign a VLAN to a wired client. • RADIUS Auth Server Provide the following information about the RADIUS authentication server: -- IP Address Enter the IP address. -- Port Enter the port number. The default is 1812. -- Password Enter the password. -- Delete Click the delete accounting server.
UniFi Controller User Guide Network Configure IP Select the management IP configuration of the switch, Using DHCP or Static IP. Chapter 11: UniFi Switch Details Changes option appears in the Properties panel. Click to display the devices. • Apply Click APPLY to save changes. • Using DHCP The use of the Dynamic Host Configuration Protocol (DHCP) is the default. The Switch automatically acquires network settings from the network’s DHCP server.
Chapter 11: UniFi Switch Details UniFi Controller User Guide • 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. Note: Use caution when clicking Forget. This will restore the Switch to factory default settings when it is in a Connected state. 102 Ubiquiti Networks, Inc.
UniFi Controller User Guide Chapter 12: UniFi Access Point Details Chapter 12: UniFi Access Point Details A UniFi AP hyperlink opens the UniFi AP’s Details window either in the Properties panel or as a separate popup window. You can always dock this window in the Properties panel or detach it as a separate window. Properties The Properties panel appears on the right side of the screen. Information about each selected device appears as a popup within this panel.
Chapter 12: UniFi Access Point Details UniFi Controller User Guide UniFi Access Point – Details Uplink (Wired) Click Overview to display the device specifics, connection details, uptime, and user statistics. If your AP has a wired uplink connection, click Uplink (Wired) to display details about the wired uplink. Overview MAC Address Displays the MAC address or unique hardware identifier of the AP. Model Displays the model name of the AP. Version Displays the version number of the AP’s firmware.
UniFi Controller User Guide Chapter 12: UniFi Access Point Details Uplink (Wireless) Downlink If your AP has a wireless uplink connection, click Uplink (Wireless) to display details about the wireless uplink. The wireless APs currently connected to the wired AP are displayed. Uplink AP Displays the name, alias, or MAC address of the uplink AP. You can click the name to get additional details on the uplink AP. Signal Displays the percentage of signal strength between the two APs.
Chapter 12: UniFi Access Point Details Radio (11N/B/G) or Radio (11N/A/AC) Click Radio (11N/B/G) or Radio (11N/A/AC) to display the channel and transmit/receive statistics. UniFi Controller User Guide # Guests Displays the number of guests connected to the guest network. RF Environment Note: Only the UAP‑AC‑LITE, UAP‑AC‑LR, UAP‑AC‑PRO, and UAP‑AC‑EDU support spectral analysis. Click RF Environment for spectral analysis to help in channel selection and planning. Channel Displays the channel being used.
UniFi Controller User Guide Note: The RF scan may take more than five minutes. All clients using this AP will be disconnected, and the AP will be offline for the duration of the scan. Chapter 12: UniFi Access Point Details Place your cursor over a channel option to view the following: Overview • Radio Displays the radio being used. • Channel Width Displays the width of the channel. • Frequency Range Displays the range of frequencies.
Chapter 12: UniFi Access Point Details UniFi Access Point – Guests UniFi Controller User Guide Radios (sort) You can click any column to sort the displayed list. The selected column displays or to indicate ascending or descending order. Name/WLAN Displays the hostname, alias, or MAC address of the connected guest and the name or SSID of the wireless network in use. You can click the guest name to get additional details; see “Client Details” on page 117 for more information.
UniFi Controller User Guide Queue Changes Click Queue Changes to line up the changes to take effect. 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. Each section with pending changes is highlighted by an ellipsis.
Chapter 12: UniFi Access Point Details Override UniFi Controller User Guide • Queue Changes Click Queue Changes to line up the changes to take effect. 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. Each section with pending changes is highlighted by an ellipsis.
UniFi Controller User Guide -- Preferred DNS Enter the IP address of the primary DNS server. -- Alternate DNS Enter the IP address of the secondary DNS server. -- DNS Suffix Enter the Fully Qualified Domain Name (FQDN) without the hostname. • Queue Changes Click Queue Changes to line up the changes to take effect.
Chapter 12: UniFi Access Point Details UniFi Controller User Guide Cancel Click Cancel to discard changes. • Apply Click Pending Changes If you want queue changes for multiple devices and then apply them later, the Pending Changes option appears in the Properties panel. Click to display the devices. • Discard Click • Apply Click • Discard Click APPLY to save changes. DISCARD to cancel changes. APPLY to save changes. DISCARD to cancel changes.
UniFi Controller User Guide Forget Click Forget to remove the AP from management by the UniFi Controller software and reset it to factory default settings. Note: Use caution when clicking Forget. This will restore the AP to factory default settings when it is in a Connected state. Do not use the Forget option when the AP is in an Isolated or Disconnected state. If you do, the only way to make the AP accessible from the UniFi Controller is to take it down and connect by wire.
Chapter 12: UniFi Access Point Details UniFi Controller User Guide Access Point - Managed by Other Access Point - Pending Approval The Managed by Other state indicates that the AP is not in the default state but it is not controlled by the UniFi Controller. The Pending Approval state indicates that the Access Point is in the default state and is available for adoption. Overview MAC Address Displays the MAC address of the AP. Model Displays the model number.
UniFi Controller User Guide Chapter 13: UniFi VoIP Phone Details Chapter 13: UniFi VoIP Phone Details A UniFi VoIP Phone hyperlink opens the UniFi VoIP Phone’s Details window either in the Properties panel or as a separate popup window. You can always dock this window in the Properties panel or detach it as a separate window. Important: For management of the UniFi VoIP Phones, please download the UniFi VoIP Controller here: downloads.ubnt.
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. Forget This Phone Forget Click Forget to remove the Phone from management by the UniFi Controller software and reset it to factory default settings. Note: Use caution when clicking Forget. This will restore the Phone to factory default settings when it is in a Connected state. 116 Ubiquiti Networks, Inc.
UniFi Controller User Guide Chapter 14: Client Details A client hyperlink opens the client’s Details window either in the Properties panel or as a separate popup window. You can always dock this window in the Properties panel or detach it as a separate window. The top of the window displays the device icon and name (or MAC address). Properties The Properties panel appears on the right side of the screen. Information about each selected device appears as a popup within this panel.
Chapter 14: Client Details UniFi Controller User Guide Wireless Client – Statistics Deep Packet Inspection Overview The Deep Packet Inspection information is available if the DPI feature is enabled (refer to “Settings > Site” on page 20 for more information). Channel Displays the channel being used. Signal Displays the percentage of signal strength between the AP and client. TX Rate Displays the transmit rate. (sort) You can click any column to sort the displayed list.
UniFi Controller User Guide Wireless Client – Configuration Chapter 14: Client Details Wired Client – Details Config MAC Address Displays the MAC address or unique hardware identifier of the client. Alias Allows you to change the hostname of the client. Note Allows you to enter comments about the client. Once saved, the client will be designated as a “Noted” client on the Insights > Known Clients tab. User Group Allows you to assign the client to a User Group.
Chapter 14: Client Details UniFi Controller User Guide Deep Packet Inspection Wired Client – Configuration The Deep Packet Inspection information is available if the DPI feature is enabled (refer to “Settings > Site” on page 20 for more information). Config (sort) You can click any column to sort the displayed list. The selected column displays or to indicate ascending or descending order. Alias Allows you to change the hostname of the client. Application Displays the name of the application.
UniFi Controller User Guide Chapter 15: Hotspot Manager The Hotspot Manager includes four main tabs when accessed by the UniFi Controller super admin account. For details on a specific tab, refer to the appropriate section. Guests Chapter 15: Hotspot Manager If you create a bookmark for the Hotspot Manager, ensure that you include the site name in the URL, which should be in this format: https://unifi.yourdomain.com:8443/hotspot/s/site_name Guests The Hotspot’s active guests are displayed.
Chapter 15: Hotspot Manager UniFi Controller User Guide Package Displays the description of the package that was purchased (if applicable). Status Displays the status of the transaction. Amount Displays the amount paid for access (if applicable). • Refund Refund the selected customer if necessary. Authorized By Displays the authorization method. If there is no authorization, then None is displayed. Download Displays the total amount of data downloaded.
UniFi Controller User Guide Chapter 15: Hotspot Manager (sort) You can click any column to sort the displayed list. The selected column displays or to indicate ascending or descending order. • Account Name Enter a name for the operator. The Account Name should use A-Z, a-z, or 0-9. Spaces and symbols are allowed but not recommended. Print all Unused Vouchers Click PRINT ALL UNUSED VOUCHERS to send a page to your printer with the codes and durations of unused vouchers.
Chapter 15: Hotspot Manager 124 UniFi Controller User Guide Ubiquiti Networks, Inc.
UniFi Controller User Guide Appendix A: Portal Customization with Legacy JSP Appendix A: Portal Customization with Legacy JSP Configuring Portal Customization To enable the guest portal with custom Legacy JSP branding, perform the following steps: 1. Go to Settings and click Guest Control. Before You Begin Starting with UniFi v5, you have two options for portal customization: AngularJS and Legacy JSP. AngularJS AngularJS is the new option for client-side rendering.
Appendix A: Portal Customization with Legacy JSP UniFi Controller User Guide Viewing the Default Portal Mac Once Guest Portal and Override Default Templates are enabled, connect to the Guest Network SSID as shown below, depending on your platform. 1. Navigate to Go > Applications. 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. 3.
UniFi Controller User Guide 5. Double-click the data folder to open it. Appendix A: Portal Customization with Legacy JSP 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//dashboard). 11. You can customize voucher.
Appendix A: Portal Customization with Legacy JSP UniFi Controller User Guide Windows The Windows files are located in the following location: :\Users\\Ubiquiti UniFi\ data\sites\\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.
UniFi Controller User Guide Appendix B: UniFi Discovery Utility Overview Appendix B: UniFi Discovery Utility UniFi Discovery Utility Interface Upon launch, the UniFi Discovery Utility listens to Layer-2 broadcast/multicast beacons from UniFi APs in both a factory default state and an unmanaged state (adopted but unable to contact the UniFi Controller software). The Ubiquiti UniFi Discovery Utility includes tools that allow the discovery and management of UniFi APs.
Appendix B: UniFi Discovery Utility UniFi Controller User Guide Locate Manage Locate the AP. The following window will appear: Set the inform URL, allowing the AP 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 If you clicked the Locate button, then Locate is automatically selected. Username If required, enter the device username.
UniFi Controller User Guide Appendix B: UniFi Discovery Utility Reset Reboot Reset the AP to factory default settings. The following window will appear: To reboot the AP, click any of the buttons (Locate, Manage, or Reset) on the UniFi Discovery Utility screen. The following window will appear: Actions If you clicked the Reset button, then Restore to factory default is automatically selected. Actions Select Reboot from the drop-down menu. Username If required, enter the device username.
Appendix B: UniFi Discovery Utility 132 UniFi Controller User Guide Ubiquiti Networks, Inc.
UniFi Controller User Guide Appendix C: UniFi Mobile App Overview The UniFi app has two general functions: • You can use a mobile device to provision a UniFi AP for basic functionality without configuring a UniFi Controller. Go to the Basic Setup section below. • You can use a mobile device to access the UniFi Controller. Go to “Controller Mode” on page 136. Appendix C: UniFi Mobile App 3.
Appendix C: UniFi Mobile App 7. Scan the QR code on the back of the UniFi AP, or tap Enter ID Manually to type the case‑sensitive MAC address. Note: For Android, the mobile device automatically connects to the helper SSID. For iOS, manually copy and paste the helper SSID and password. UniFi Controller User Guide Connected Clients Displays the number of clients connected to this UniFi AP. SSID Displays the wireless network name. Encryption Displays Encrypted.
UniFi Controller User Guide Appendix C: UniFi Mobile App Configure WLAN Settings • Select your country Select the appropriate country from the list. • Name/SSID Enter the name of the wireless network. • Enabled Enable or disable wireless functionality. • Security Select the security method you want to use. • Security Key Enter the passphrase.
Appendix C: UniFi Mobile App UniFi Controller User Guide WLAN Settings • Restore Restore the previously saved configuration. • Same as 2G? Tap to use the same settings as the 2.4 GHz configuration. • Change mode Select this option if you want to change to Controller mode. Go to the Controller Mode section in the next column. • Name/SSID Enter the name of the wireless network. • Enabled Enable or disable wireless functionality. • Security Select the security method you want to use.
UniFi Controller User Guide 3. Enter the following information: Appendix C: UniFi Mobile App The UniFi app includes four tabs: • (IP address) Enter the IP address of the UniFi Controller. • “Dashboard” on page 137 • (port) Enter the appropriate port number, which is typically 8443. • “Clients” on page 143 Note: If you do not know the IP address, you can tap Find to detect a UniFi Controller and then select it. • (username) Enter your username for the UniFi Controller.
Appendix C: UniFi Mobile App Inactive Displays the number of APs adopted but not active. Pending Displays the number of APs pending adoption. Devices Devices Displays the total number of devices. WLAN Displays the number of wireless devices. WAN Displays the number of Gateway devices. LAN Displays the number of wired devices. Scroll down the Dashboard screen to view additional status information.
UniFi Controller User Guide • RF Environment (Available only for UAP‑AC‑LITE, UAP‑AC‑LR, UAP‑AC‑PRO, and UAP‑AC‑EDU.) Tap this option for spectral analysis to help in channel selection and planning. -- 2G/5G Select the frequency band you want to analyze. -- Scan Tap Scan to trigger an RF scan and then tap Scan again to continue. Note: The RF scan may take more than five minutes. All clients using this AP will be disconnected, and the AP will be offline for the duration of the scan. Ubiquiti Networks, Inc.
Appendix C: UniFi Mobile App Overview • IP Address Displays the IP address of the client. • MAC Address Displays the MAC address or unique hardware identifier of the client. • Connection Displays the hostname, alias, or MAC address of the UniFi device the client is connected to. • Uptime Displays the duration of time the client has been connected without interruption. • Statistics Displays additional client information: -- ESSID (Available for wireless clients.) Displays the name of the wireless network.
UniFi Controller User Guide Actions You can locate or restart the device. Appendix C: UniFi Mobile App -- Channel Select the appropriate channel number and channel width. Note: If the AP is part of a Zero Handoff WLAN Group, then the Channel setting cannot be changed. -- TX Power Select the appropriate transmit power value. The default is Auto. • Locate Tap to flash the LED on the device. The LED will flash until Locate is tapped again. • Restart Tap to restart the selected device. Configure -- Min.
Appendix C: UniFi Mobile App • WLAN These settings are available only for APs. UniFi Controller User Guide • Network Select the appropriate option: -- Using DHCP The use of the Dynamic Host Configuration Protocol (DHCP) is the default. The AP automatically acquires network settings from the network’s DHCP server. -- Static IP Assign fixed network settings to the AP. Enter the following information: • IP Address Enter the IP address for the AP. • Subnet Mask Enter the subnet mask of the AP.
UniFi Controller User Guide -- Off Keep the default, Off, if you do not want to use band steering. -- Prefer 5G Select this option to steer clients to the 5 GHz band at a lower channel utilization threshold than the Balanced option. The threshold is not a single value; instead it is a function of two values: the 2.4 GHz channel utilization and 5 GHz channel utilization. -- Balanced (Not available for the UAP-PRO.
Appendix C: UniFi Mobile App • Statistics Displays additional client information: UniFi Controller User Guide • History Displays the historical usage of a client. -- ESSID (Available for wireless clients.) Displays the name of the wireless network. -- (date/time) Displays the date and time of the connection. -- Connection Displays the hostname, alias, or MAC address of the UniFi device the client is connected to. -- (duration) Displays the duration of the connection.
UniFi Controller User Guide Appendix C: UniFi Mobile App Settings The current site is displayed on this screen. Site To change a site, tap the current site and then select a different site. Log Out To exit the UniFi app or change its mode, tap Log out. Ubiquiti Networks, Inc.
Appendix C: UniFi Mobile App 146 UniFi Controller User Guide Ubiquiti Networks, Inc.
UniFi Controller User Guide Appendix D: UniFi EDU Mobile App Overview You can use the UAP-AC-EDU to broadcast announcements with clarity from your mobile device. Use the UniFi EDU app to broadcast announcements from the UAP-AC-EDU.
Appendix D: UniFi EDU Mobile App UniFi Controller User Guide To begin a broadcast, follow these instructions: To edit a broadcast group, follow these instructions: 1. Tap the broadcast group you want to use. 1. Tap Edit. 2. Tap Start Broadcast to start the announcement. 2. To change the name or members of the group, tap the broadcast group. 3. Tap Stop Broadcasting to end the announcement. 3. Make your changes. The speakers will automatically be muted when you stop broadcasting. 148 4.
UniFi Controller User Guide Appendix D: UniFi EDU Mobile App To delete a broadcast group, follow these instructions: To schedule an announcement, follow these instructions: 1. Tap Edit. 1. Tap 2. To remove a broadcast group, tap . . 2. Configure the following: • (Date and time) Select the appropriate date and time. • Repeat Select this option to specify how often the announcement should recur. Then select Never, Every Day, Every Weekday, or Custom.
Appendix D: UniFi EDU Mobile App UniFi Controller User Guide To delete an announcement, follow these instructions: To create a recording, follow these instructions: 1. Click Edit. 1. Tap 2. To remove an announcement, tap . . 2. Tap to start recording. Tap to play back the recording. to stop recording. Tap 3. Tap Done. Recordings You can create a recording. 3. Tap Save to apply your changes, or tap Cancel to discard your changes. 150 Ubiquiti Networks, Inc.
UniFi Controller User Guide Appendix D: UniFi EDU Mobile App To delete a recording, follow these instructions: 1. Click Edit. 2. To remove a recording, tap . Test Sound Tap Test Sound to select a specific sound for testing. Then tap any sound to select it. (slider) Use the slider control to adjust the volume for each speaker. Test To test the sound of any speaker, tap Test. Settings The current site is displayed on this screen. 3. Tap Done.
Appendix D: UniFi EDU Mobile App UniFi Controller User Guide Log Out To exit the UniFi app or change its mode, tap Log out. 152 Ubiquiti Networks, Inc.
UniFi Controller User Guide Appendix E: Controller Scenarios Appendix E: Controller Scenarios A UniFi Cloud Key can be used as a remote controller. For example, if you have a campus-wide UniFi network and each building has its own router, then Layer-3 adoption is required.
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 deployment using a remote controller. 1. Create a remote controller. The UniFi Controller is running in the cloud or your NOC (Network Operating Center). • High rise The UniFi Controller is off-site. Use Layer-3 adoption to manage this site. 2. At the customer site, open a browser to the remote controller. 3.
UniFi Controller User Guide Appendix E: Controller Scenarios Hybrid Deployment For example, in the application diagram below, you can use unifi.ubnt.com to access three controllers: The application diagram below shows an example of a deployment using local and remote controllers. • remote controller • UniFi Cloud Key controller for the hotel Your sites use a mixture of controller types. Some sites have local instances of the UniFi Controller, while other sites have a remote UniFi Controller.
Appendix E: Controller Scenarios Layer-3 Adoption Here is an overview of a typical example: 1. Create your controller. 2. At the customer site, open a browser to the UniFi Controller. 3.
UniFi Controller User Guide 2. If the UniFi AP is not in the factory default state, then click reset. Enter the SSH username and password, and then click Apply. Appendix E: Controller Scenarios DNS You have a couple of options: DNS resolution Configure your DNS server to resolve unifi to the IP address of the UniFi Controller. Ensure that the UniFi AP can resolve the domain name of the UniFi Controller.
Appendix E: Controller Scenarios UniFi Controller User Guide 4. In the UniFi Controller field, enter the IP address of the UniFi Controller. Then click Save. The DHCP server will return the IP address of the UniFi Controller to its DHCP clients, so if a client is a UniFi AP, it will know how to contact the UniFi Controller. Linux ISC DHCP Server Configure the dhcpd.conf file: # ... option space ubnt; option ubnt.
UniFi Controller User Guide Appendix F: Contact Information Appendix F: Contact Information Ubiquiti Networks Support Ubiquiti Support Engineers are located around the world and are dedicated to helping customers resolve software, hardware compatibility, or field issues as quickly as possible. We strive to respond to support inquiries within a 24-hour period. Ubiquiti Networks, Inc. 685 Third Avenue, 27th Floor New York, New York 10017 www.ubnt.com Online Resources Support: ubnt.
www.ubnt.com © 2011-2017 Ubiquiti Networks, Inc. All rights reserved. Ubiquiti, Ubiquiti Networks, the Ubiquiti U logo, the Ubiquiti beam logo, and UniFi are trademarks or registered trademarks of Ubiquiti Networks, Inc. in the United States and in other countries. App Store is a service mark of Apple, Inc. Google, Android, and Google Play are trademarks of Google Inc. All other trademarks are the property of their respective owners.
