Enterprise System Controller Release Version: 4.8.
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 8: Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 Clients (Total) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 Quick Look. . . . . . . . . . . . . . . . . . . . . . .
UniFi Controller User Guide Chapter 14: Client Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Table of Contents 97 Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97 Wireless Client – Details . . . . . . . . . . . . . . . . . . . .
Table of Contents iv UniFi Controller User Guide Ubiquiti Networks, Inc.
UniFi Controller User Guide Chapter 1: Software Installation Chapter 1: Software Installation All UniFi devices support off-site management controllers. Follow the instructions in this chapter after you install the hardware, which is described in the Quick Start Guide. Software Installation Introduction Thank you for purchasing the Ubiquiti Networks® UniFi® Enterprise System.
Chapter 1: Software Installation UniFi Controller User Guide PC Users Configuring the UniFi Controller Software 1. Launch UniFi-installer.exe. 1. The UniFi Controller software startup will begin. Click Launch a Browser to Manage Wireless Network. 2. Click Install. 2. Select your country and time zone. Alternatively, you can click restore from a previous backup to use a file that contains your backup settings. Click Next. 3. If your computer doesn’t have Java 1.
UniFi Controller User Guide 4. The UniFi Setup Wizard will create a secure primary wireless network for your devices. Perform the following steps: a. Enter the wireless network name (SSID) in the Secure SSID field. b. Enter a passphrase to be used for your primary network in the Security Key field. c. To enable guest access, select Enable Guest Access, and enter a guest network name in the Guest SSID field. Chapter 1: Software Installation 6. Review your settings.
Chapter 1: Software Installation 4 UniFi Controller User Guide 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 Site. 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.
Chapter 2: UniFi Cloud Note: Only the super admin – not any site admin – can view devices that are Pending Approval and then adopt them on the UniFi Controller. Ensure that you save the super admin login information for future use. 9. 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. UniFi Controller User Guide UniFi Cloud Key Configuration Login Instructions 1.
UniFi Controller User Guide Chapter 2: UniFi Cloud Navigation Bar Main The UniFi Cloud Key configuration consists of three primary pages: The Main screen displays basic status information about the UniFi Cloud Key. • “Main” on page 9 • “Configuration” on page 10 • “Maintenance” on page 10 Status Device Name Displays the hostname or alias of the UniFi Cloud Key.
Chapter 2: UniFi Cloud Configuration The Configuration screen allows you to configure the basic and network settings of the UniFi Cloud Key. UniFi Controller User Guide • DHCP The use of the Dynamic Host Configuration Protocol (DHCP) is the default. The UniFi Cloud Key automatically acquires network settings from the network’s DHCP server. -- Fallback IP Address Enter the IP address for the UniFi Cloud Key to use if an external DHCP server is not found.
UniFi Controller User Guide Chapter 2: UniFi Cloud Security You have two options: Password To change the password, click Change Password. The Change Password screen will appear: • upload file If you have the firmware saved in a specific location, then click Select File to browse for the file. • Old password Enter the current password (the default is ubnt). • New password Enter the new password. • Confirm Password Enter the new password again.
Chapter 2: UniFi Cloud UniFi Cloud Account You must be a super admin for initial cloud management. Once cloud access is enabled by the super admin, then any other admin can also enable cloud access. Note: The cloud account is also known as the Single Sign-On (SSO) account. Login Instructions 1. Launch the Chrome web browser and type https:// followed by the appropriate Controller Hostname/IP address as specified in “Settings > Controller” on page 30. Press enter (PC) or return (Mac).
UniFi Controller User Guide There are three pages available: Chapter 2: UniFi Cloud Manage • Profile Access your account settings: -- First Name Enter your first name. -- Last Name Enter your last name. -- Username Enter your login username. -- Email Enter the email address of your cloud account. -- Update Settings Click to apply your changes. • Security Change your account password: -- Create a New Password Enter a new password with at least eight characters.
Chapter 2: UniFi Cloud UniFi Controller User Guide Sites • Search Enter the text you want to search for. Simply begin typing; there is no need to press Enter. • (site_name) Displays the name of the site. You can click the name to get additional details on the right. You can place the mouse over each node icon to display basic status information. -- WWW The basic details of the Internet connection are displayed. • (_ Unread Alerts) Displays the number of unread alerts.
UniFi Controller User Guide Chapter 2: UniFi Cloud -- LAN The basic details of the wired network(s) are displayed. • Gateway Displays the IP address of the service provider’s gateway. • Users Displays the number of clients connected to the wired network. • Guests Displays the number of clients connected to the guest wired network. • Switches Displays the number of UniFi Switches connected to the wired network. • Up Displays the upload rate of the wired network(s).
Chapter 2: UniFi Cloud 16 UniFi Controller User Guide Ubiquiti Networks, Inc.
Chapter 3: Using the UniFi Controller Software UniFi Controller User Guide Chapter 3: Using the UniFi Controller Software 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. Refresh Click the refresh icon to update the on-screen information.
Chapter 3: Using the UniFi Controller Software UniFi Controller User Guide Site Settings 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 tab displays a list of available sub‑tabs: • Site Site-related settings.
UniFi Controller User Guide DPI (Beta) Deep Packet Inspection (DPI) is more advanced than conventional Stateful Packet Inspection (SPI) filtering for traffic analysis. Ubiquiti’s proprietary DPI engine includes the latest application identification signatures to track which applications (and IP addresses) are using the most bandwidth. Chapter 3: Using the UniFi Controller Software Settings > Wireless Networks Configure the wireless networks for each site.
Chapter 3: Using the UniFi Controller Software UniFi Controller User Guide Create or Edit a Wireless Network Configure the following options: -- Radio Select the appropriate radio, 2G or 5G. -- Channel Select the channel that all of the APs will use for Zero Handoff Roaming. Load Balancing (Not available if you enabled the Mobility option.) Select this option to balance the number of clients you specify per radio. Then enter the number of clients in the field provided.
Chapter 3: Using the UniFi Controller Software UniFi Controller User Guide -- WPA-Enterprise WPA Enterprise uses a RADIUS server to authenticate users on the wireless network. • Hide SSID Select this option if you don’t want the wireless network name or SSID to be broadcast. • WPA Mode (Available if WPA security is enabled.) Select the appropriate WPA method: Both, WPA1 Only, or WPA2 Only (default). • Encryption Select the appropriate encryption method: Auto, TKIP Only, or AES/CCMP Only (default).
Chapter 3: Using the UniFi Controller Software Create or Edit a Network UniFi Controller User Guide • DHCP WINS Server Select this option to designate WINS (Windows Internet Naming Service) server(s). -- WINS Server 1/2 Enter the IP address of the WINS server in each field. • DHCP Lease Time The IP addresses assigned by the DHCP server are valid only for the duration specified by the lease time. Increasing the time ensures client operation without interruption, but could introduce potential conflicts.
Chapter 3: Using the UniFi Controller Software UniFi Controller User Guide • Site-to-Site VPN Enabled by default. The remote user can access the site’s resources as well as the resources of any other VPNs connected to the site. If you disable this option, then the remote user can only access the site’s resources. • Save Click • Cancel Click to apply changes. CANCEL to discard changes. Site-to-Site VPN -- Manual Select this option to manually select name servers.
Chapter 3: Using the UniFi Controller Software Settings > Guest Control The Guest Control screen displays the following sections: • Guest Policies (see below) • “Hotspot” on page 25 (for Hotspot authentication) • “Access Control” on page 27 UniFi Controller User Guide Landing Page After accepting the Terms of Use, guests are redirected to the landing page. Select one of the following options: • Redirect to the original URL After accepting the Terms of Use, guests are directed to the URL they requested.
Chapter 3: Using the UniFi Controller Software UniFi Controller User Guide Landing Page After accepting the Terms of Use, guests are redirected to the landing page. Select one of the following options: Landing Page After accepting the Terms of Use, guests are redirected to the landing page. Select one of the following options: • Redirect to the original URL After accepting the Terms of Use, guests are directed to the URL they requested.
Chapter 3: Using the UniFi Controller Software UniFi Controller User Guide Enter the Authorize.Net account details: • API Login ID Enter the API login ID used to identify yourself as an authorized user. • Transaction Key Enter the key used to authenticate transactions. Enter the PayPal account details: • Username Enter the corresponding Username. • Password Enter the corresponding Password. • Signature Enter the corresponding Signature for the PayPal account that will receive payments.
Chapter 3: Using the UniFi Controller Software UniFi Controller User Guide 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. When logging in with payment-based Hotspot authentication, guests will be required to select the package type, click the payment choice, and accept the Terms of Use before gaining access to the Internet.
Chapter 3: Using the UniFi Controller Software Role Displays the permissions level: Admin (read/write access) or Read Only. Actions Click a button to perform the desired action: • Revoke Click Settings > User Groups Configure user groups on this screen. The default user group is named Default and has no bandwidth limits. to remove the selected account. • Re-invite Click pending account. • Edit Click UniFi Controller User Guide RE-INVITE to re-send an invitation to a to make changes.
Chapter 3: Using the UniFi Controller Software UniFi Controller User Guide Settings > VoIP Settings > Extensions Enable the VoIP feature and configure the VoIP settings of the UniFi Controller. The Extensions tab appears if VoIP is enabled. Extension Displays the number of the extension. Global Name Displays the name of the extension. VoIP Select this option to enable the VoIP feature.
Chapter 3: Using the UniFi Controller Software -- SIP Voicemail Enter the URL or IP address of the SIP voicemail server. • Save Click • Cancel Click to apply changes. CANCEL to discard changes. Settings > Controller Configure the system settings of the UniFi Controller. UniFi Controller User Guide • Enable authentication Select this option to enable authentication. -- Username Enter the username required by the mail server. -- Password Enter the password required by the mail server.
Chapter 3: Using the UniFi Controller Software UniFi Controller User Guide Controller Cloud Access Server Information If the login for cloud access is configured, then the Controller Cloud Access screen will appear: Version Displays the software version. Services Log Level You can customize the support information that is collected: • device Select the level of severity required to trigger device log entries: Normal, More, or Debug. The default is Normal.
Chapter 3: Using the UniFi Controller Software Check for Update Click this option 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 the Backup section for more information) before upgrading. 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.
Chapter 4: Dashboard UniFi Controller User Guide Chapter 4: Dashboard After the Speed Test is complete, the following will be displayed: The Dashboard screen provides a visual representation of your network’s status.
Chapter 4: Dashboard UniFi Controller User Guide Gateway/Router Red Red indicates one of the following: • WWW Internet connectivity is down. The basic details of the UniFi Security Gateway are displayed. • WAN The UniFi Security Gateway is offline. • LAN One or more Switches are offline. • WLAN More than half of the APs are offline. www WAN LAN WLAN Orange Orange indicates that half or fewer than half of the APs are offline. Note: Orange is not applicable to the WWW, WAN, and LAN nodes.
UniFi Controller User Guide Click the subcategory to open the Statistics tab of the UniFi Security Gateway screen. For more information, go to “UniFi Security Gateway – Statistics” on page 69. Chapter 4: Dashboard Wireless Local Area Network The basic details of the wireless network(s) are displayed. Local Area Network The basic details of the wired network(s) are displayed: Status Displays the status of the node: Connected and Stable, Devices Down, Unreachable, or No Data Available.
Chapter 4: Dashboard 36 UniFi Controller User Guide Ubiquiti Networks, Inc.
Chapter 5: Map UniFi Controller User Guide Chapter 5: Map Once you’ve created the map, you can upload it to the UniFi Controller software: The UniFi Controller software allows you to upload custom map images of your location(s) or use Google Maps™ for a visual representation of your UniFi network. 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. 1.
Chapter 5: Map 3. 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. UniFi Controller User Guide Adding a Google Map To add a Google Map to the UniFi Controller software Map view: 1. Click the drop-down menu at the top right of the screen and then click . 4. Enter a map name in the field provided and click . Note: If the map is incorrect, click Select a different map and try again. 2. Click . 3.
Chapter 5: Map UniFi Controller User Guide Placing Devices on the Map 5. The default view is Satellite view, which allows the use of labels. 1. Click Unplaced Devices at the lower right. Use the tools to navigate the map or zoom in/out. 2. Drag each device icon from the Unplaced Devices list to the appropriate location on the map. Click Labels to display street and location names. In the Location field, enter an address or the latitude and longitude of a specific location. Then click .
Chapter 5: Map UniFi Controller User Guide Options Click a UniFi icon to reveal options. Click the UniFi icon again to hide them. Lock Lock the device icon to its current location. Details Display the Details screen.
Chapter 5: Map UniFi Controller User Guide Topology Displays a visual representation of the network configuration and connections between any APs. A dashed line will indicate the wireless AP and its uplink to a wired AP. (Map) If multiple maps have been uploaded, you can select which map you want to view using this option. Configure Maps Click edit the current map(s). Setting the Map Scale 1. Click the set map scale button. 2.
Chapter 5: Map 42 UniFi Controller User Guide Ubiquiti Networks, Inc.
Chapter 6: Devices 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. Search Enter the text you want to search for. Simply begin typing; there is no need to press Enter. 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.
Chapter 6: Devices UniFi Controller User Guide If displayed, the LED color of the device icon indicates the device status. • Blue/Green Indicates the device is connected. Gateway/Switches All UniFi Gateway and Switch devices are displayed. • Red/Orange Indicates the device is disconnected or not managed by this site (Pending Approval or Managed by Other). Name/MAC Address Displays the hostname, alias, or MAC address of the UniFi device. You can click the name to get additional details.
Chapter 6: Devices UniFi Controller User Guide Actions Click a button to perform the desired action: • Locate Click to flash the Status LED on the Gateway/Switch and its icon on the Map tab so you can locate it. The LED will flash until the Locate button is clicked again. (The icon on the Map tab will flash three times and stop.) • Restart Click to restart the selected device. • Upgrade If a software upgrade is available for the device, click to install the latest UniFi firmware on the device.
Chapter 6: Devices UniFi Controller User Guide Actions Click a button to perform the desired action: • Locate Click to flash the LED on the AP and the AP’s icon on the Map tab so you can locate it. The LED will flash until the Locate button is clicked again. (The icon on the Map tab will flash three times and stop.) • Restart Click to restart the selected device. • Upgrade If a software upgrade is available for the device, click to install the latest UniFi firmware on the device.
Chapter 6: Devices UniFi Controller User Guide Performance Note: The super admin account was created during the initial installation; for more information, see “Configuring the UniFi Controller Software” on page 2. 2G Clients Displays the number of clients connected to the AP using the 2.4 GHz band. 5G Clients Displays the number of clients connected to the AP using the 5 GHz band. TX Displays the overall TX (transmit) rate. RX Displays the overall RX (receive) rate.
Chapter 6: Devices UniFi Controller User Guide Phones VoIP is available with UniFi Controller version 4.6 or higher. • Upgrade If a software upgrade is available for the device, click to install the latest UniFi firmware 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.
UniFi Controller User Guide Minimize Click popups. Chapter 6: Devices to close and re-open the device Each row displays the following: • (icon) Displays the icon of the device (the icon will vary depending on the model). • Name/MAC Address Displays the hostname, alias, or MAC address of the device. • Display Click to display the device information. • Detach Click to display the same information in a separate popup screen that can be moved anywhere within the browser screen. • Close Click popups.
Chapter 6: Devices 50 UniFi Controller User Guide Ubiquiti Networks, Inc.
Chapter 7: Clients UniFi Controller User Guide Chapter 7: Clients All The Clients screen displays a list of network clients. You can click any of the column headers to change the list order. Enter the text you want to search for. Simply Search begin typing; there is no need to press Enter. IP Address Displays the IP address used by the client. You can apply one of the following primary filters: Name/MAC Address Displays the hostname, alias, or MAC address of the connected client.
Chapter 7: Clients UniFi Controller User Guide Uptime Displays the amount of time the client has been connected for this session. Access Point Displays the name of the connected AP. Signal Displays the signal strength level and signal type: Actions Click a button to perform the desired action: • Block Click the network. to block this client from accessing Icon • Reconnect Click to reconnect a wireless client.
Chapter 7: Clients UniFi Controller User Guide Wired • Unauthorize/Authorize (Available for Guests only.) Click to remove authorization of guest access and disconnect the guest, or click for guests pending authorization. Properties The Properties tab is hidden by default. To display it, click the properties icon. The Properties tab appears on the right side of the Clients screen. Information about each selected client appears as a popup within this tab.
Chapter 7: Clients 54 UniFi Controller User Guide Ubiquiti Networks, Inc.
Chapter 8: Statistics 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. Time and Date At the top right of the screen, you can filter by date and time period. You can also change the duration interval by toggling between 24 Hour and Month. Overview The default view. Clear Current Stats Reset the current statistics to start over.
Chapter 8: Statistics Clients (Total) UniFi Controller User Guide Current Usage - Top Access Points The details of the most active Access Points in current use are displayed. # of Clients A visual pie chart represents the client distribution amongst the APs. Place the mouse cursor over the chart for the number of clients per network. Quick Look # of Clients A pie chart represents the client distribution on the most active Access Points.
UniFi Controller User Guide Chapter 8: Statistics Filter You can view the number of clients and amount of traffic by device. The Filter drop-down list displays managed devices by name or MAC address and amount of traffic. Click the appropriate device from the Filter drop-down list. A second line that is color-coded to the selected device appears in the time period selected.
Chapter 8: Statistics 58 UniFi Controller User Guide Ubiquiti Networks, Inc.
Chapter 9: Insights UniFi Controller User Guide 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 A secondary filter is available: • Blocked Only display blocked clients. • Noted Only display clients whose configurations include notes. (See “Wireless Client – Configuration” on page 99 or “Wired Client – Configuration” on page 101 for more information.) • Static IP Only display clients using static IP addresses. A tertiary filter is available: • All Display all clients, regardless of connection type. • Wireless Display all wireless clients.
Chapter 9: Insights UniFi Controller User Guide Signal Displays the signal strength level and signal type: Icon • Update Click • Cancel Click to apply the new filter. CANCEL to discard changes. Clients Mode 5 GHz (802.11ac) Active 5 GHz (802.11ac) Power Save 5 GHz (802.11n) Active 5 GHz (802.11n) Power Save 2.4 GHz (802.11n) Active Associated Displays the date and time the client first connected. 2.4 GHz (802.11n) Power Save Duration Displays the length of time the client was connected.
Chapter 9: Insights 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. UniFi Controller User Guide The ports display their status: Indicates a 10/100 Mbps connection. Indicates 10/100 Mbps connection with PoE. Start Displays the start date and time of the session. Indicates a 1000 Mbps connection. Duration Displays the length of time the guest was connected.
Chapter 9: Insights UniFi Controller User Guide You can place your mouse over the Activity icon to display the specific TX or RX rate. PoE Mode Displays the PoE setting: • Disabled PoE is disabled. • 24V Passive 24V passive PoE is enabled. • PoE+ 802.3at/af devices can be plugged in and automatically receive PoE. 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 75.
Chapter 9: Insights UniFi Controller User Guide TX Broadcast Displays the number of broadcast packets transmitted. Dynamic DNS TX Errors Displays the number of error packets transmitted. RX Bytes Displays the number of bytes received. RX Frames Displays the number of frames received. RX Multicast Displays the number of multicast packets received. RX Broadcast Displays the number of broadcast packets received. RX Errors Displays the number of error packets received.
Chapter 9: Insights UniFi Controller User Guide Port Displays the port or ports that will be forwarded to the LAN. Also known as the external port(s). UPnP Forward IP Displays the destination IP address that will receive the forwarded port traffic. Forward Port Displays the destination port or ports that will receive the forwarded port traffic. Also known as the internal port(s). Packets Displays the number of packets transferred. Bytes Displays the number of bytes transferred.
Chapter 9: Insights 66 UniFi Controller User Guide Ubiquiti Networks, Inc.
Chapter 10: UniFi Security Gateway Details UniFi Controller User Guide Chapter 10: UniFi Security Gateway Details The UniFi Security Gateway hyperlink opens the UniFi Security Gateway’s Details window either in the Properties tab or as a separate popup window. You can always dock this window in the Properties tab or detach it as a separate window. Close Click popups. to close the Properties tab and device Minimize Click popups.
Chapter 10: UniFi Security Gateway Details UniFi Controller User Guide The bottom of the window has three buttons: WAN • Locate Click to flash the Status LED on the Gateway and the Gateway’s icon on the Map tab so you can locate it. The LED will flash until the Locate button is clicked again. (The icon on the Map tab will flash three times and stop.) The number of WAN sections will vary depending on the number of active WAN ports. • Restart Click to restart the Gateway.
UniFi Controller User Guide UniFi Security Gateway – Statistics Click Statistics to display the bandwidth usage information, which is available if the DPI feature is enabled (refer to “Settings > Site” on page 18 for more information). Chapter 10: UniFi Security Gateway Details You can click the DPI subcategory to view the DPI subcategory usage broken down by client: Total Usage Displays the following: • Name/MAC Address Displays the hostname, alias, or MAC address of the connected client.
Chapter 10: UniFi Security Gateway Details UniFi Security Gateway – Configuration Click Configuration to configure the alias, WAN settings, and port forwarding entries. You can also move the Gateway to another site. Config UniFi Controller User Guide • Using DHCP The use of the Dynamic Host Configuration Protocol (DHCP) is the default. The Gateway automatically acquires network settings from the service provider’s DHCP server.
Chapter 10: UniFi Security Gateway Details UniFi Controller User Guide • Disabled If you are not using the WAN 2 port, then select Disabled. • Apply Click Apply to save your change. • 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: Port Forward -- Username Enter the username used to connect to the PPPoE server.
Chapter 10: UniFi Security Gateway Details Create or Edit Port Forwarding Entry UniFi Controller User Guide Dynamic DNS Create Click to add a new entry. Go to the Create or Edit DDNS Entry section on the next page. Service Displays the name of your Dynamic DNS (DDNS) service provider. Hostname Displays the host name of the device. Name Enter a name to identify this port forwarding entry. Username Displays the user name of the DDNS account.
UniFi Controller User Guide Create or Edit DDNS Entry 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. Custom Upgrade Click firmware from a location you specify. Service If available, select your DDNS service provider from the drop-down list.
Chapter 10: UniFi Security Gateway Details 74 UniFi Controller User Guide Ubiquiti Networks, Inc.
Chapter 11: UniFi Switch Details UniFi Controller User Guide Chapter 11: UniFi Switch Details • Name/MAC Address Displays the hostname, alias, or MAC address of the device. • Display Click to display the device information. • Detach Click to display the same information in a separate popup screen that can be moved anywhere within the browser screen. A UniFi Switch hyperlink opens the UniFi Switch’s Details window either in the Properties tab or as a separate popup window.
Chapter 11: UniFi Switch Details The bottom of the window has three buttons: UniFi Controller User Guide Uplink • Locate Click to flash the System LED on the Switch and the Switch’s icon on the Map tab so you can locate it. The LED will flash until the Locate button is clicked again. (The icon on the Map tab will flash three times and stop.) • Restart Click to restart the Switch. • Upgrade If a software upgrade is available for the Switch, click to install the latest UniFi firmware on the Switch.
Chapter 11: UniFi Switch Details UniFi Controller User Guide Model Displays the model number of the downlink device. Actions Click a button to perform the desired action: Status Displays the connection speed and duplex mode. • Edit Click to change the port configuration. Proceed to the following section, Port Configuration. UniFi Switch – Ports • Powercycle (Available only if the connected devices uses PoE.) Click to restart the connected device.
Chapter 11: UniFi Switch Details • Advanced Options Click the icon to display the following: • Operation Select the operation mode for this port. -- Switching The default mode. • Link Negotiation Keep the default, Auto, or select Manual to specify the duplex and speed: • Full Duplex (Available for RJ45 ports only.) Full‑duplex transmission is enabled by default. • Link Speed For RJ45 ports, select the appropriate speed: 1000 Mbps, 100 Mbps, or 10 Mbps.
Chapter 11: UniFi Switch Details UniFi Controller User Guide Networks/VLANs • Apply Click Apply to save changes. • Cancel Click Cancel to discard changes. UniFi Switch – Configuration Click Configuration to configure the alias, network/VLANs, services, and network settings. You can also move the Switch to another site. Alias Create Click to add a new entry. Go to “Create New Network/VLAN” on page 80. Name Displays the name of the network/VLAN.
Chapter 11: UniFi Switch Details UniFi Controller User Guide Create New Network/VLAN This table lists how the packets are handled: Packet Type Ingress Action Egress Untagged Accepted Assigned to VLAN 1 VLAN header removed and sent out as untagged Tagged as VLAN 20 Accepted Remains tagged Sent out tagged as VLAN 20 Tagged as VLAN 30 Accepted Remains tagged Sent out tagged as VLAN 30 The proper use of VLANs isolates the traffic of each VLAN.
Chapter 11: UniFi Switch Details UniFi Controller User Guide Network Configure IP Select the Internet connection type for your service. • Static IP Assign fixed network settings to the Switch. Enter the following information: -- IP Address Enter the IP address for the Switch. -- Subnet Mask Enter the subnet mask of the Switch. -- Gateway Enter the IP address of the gateway (for example, the UniFi Security Gateway). -- Preferred DNS Enter the IP address of the primary DNS server.
Chapter 11: UniFi Switch Details UniFi Controller User Guide 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. Custom Upgrade Click firmware from a location you specify. to upgrade the Forget This Switch Forget Click to remove the Switch from management by the UniFi Controller software and reset it to factory default settings. Note: Use caution when clicking Forget.
Chapter 12: UniFi Access Point Details UniFi Controller User Guide Chapter 12: UniFi Access Point Details • Name/MAC Address Displays the hostname, alias, or MAC address of the device. • Display Click to display the device information. • Detach Click to display the same information in a separate popup screen that can be moved anywhere within the browser screen. A UniFi AP hyperlink opens the UniFi AP’s Details window either in the Properties tab or as a separate popup window.
Chapter 12: UniFi Access Point Details UniFi Controller User Guide UniFi Access Point – Details Uplink (Wire) Click Overview to display the device specifics, connection details, uptime, and user statistics. If your AP has a wired uplink connection, click Uplink (Wire) to display details about the wired uplink. Overview Speed Displays the connection speed in Mbps. Duplex Displays the mode, Full Duplex or Half Duplex. MAC Address Displays the MAC address or unique hardware identifier of the AP.
Chapter 12: UniFi Access Point Details UniFi Controller User Guide 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 TX Retry/Dropped Displays the percentage of transmit packets that needed to be re-sent and the percentage of packets that were dropped. RX Retry/Dropped Displays the percentage of receive packets that needed to be re-sent and the percentage of packets that were dropped.
UniFi Controller User Guide 2G/5G Select the frequency band you want to analyze. RF Scan Click to scan the RF environment and then click Confirm to continue. RF SCAN 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: • Channel _ Displays the channel number and frequency range.
Chapter 12: UniFi Access Point Details UniFi Access Point – Guests UniFi Controller User Guide Radios Name Displays the hostname, alias, or MAC address of the connected guest. You can click the name to get additional details; see “Client Details” on page 97 for more information. WLAN Displays the name or SSID of the wireless network in use. Signal Displays the percentage of signal strength between the guest and AP. TX Displays the transmit rate.
Chapter 12: UniFi Access Point Details UniFi Controller User Guide • Min. RSSI (Not available for Zero Handoff.) Disabled by default. Select this option and enter a minimum threshold. For UniFi, RSSI is synonymous with SNR. If the client signal falls below the specified threshold, then the AP kicks out the client, allowing it to reconnect with a more suitable AP. Override Note: If the AP is part of a Zero Handoff WLAN Group, the Min. RSSI setting cannot be changed. Apply Click Apply to save your changes.
Chapter 12: UniFi Access Point Details UniFi Controller User Guide Network Configure IP Select the Internet connection type for your service. • Using DHCP Enabled by default. The AP automatically acquires network settings from the network’s Dynamic Host Configuration Protocol (DHCP) server. • Static IP Assign fixed network settings to the AP. Enter the following information: -- IP Address Enter the IP address for the AP. • Apply Click Apply to save changes.
UniFi Controller User Guide If the 2.4 GHz band is overloaded, and the RSSI of the client is above the threshold for association on the 5 GHz band, then the AP will steer the client to the 5 GHz band by withholding probe responses. If the client still attempts to associate on the 2.4 GHz band, the AP will send auth failure frames in response to auth requests from the client.
Chapter 12: UniFi Access Point Details UniFi Controller User Guide 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. 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.
UniFi Controller User Guide Chapter 12: UniFi Access Point Details 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. MAC Address Displays the MAC address of the AP.
Chapter 12: UniFi Access Point Details 94 UniFi Controller User Guide Ubiquiti Networks, Inc.
Chapter 13: UniFi VoIP Phone Details UniFi Controller User Guide Chapter 13: UniFi VoIP Phone Details A UniFi VoIP Phone hyperlink opens the UniFi VoIP Phone’s Details window either in the Properties tab or as a separate popup window. You can always dock this window in the Properties tab or detach it as a separate window. • Detach Click to display the same information in a separate popup screen that can be moved anywhere within the browser screen. • Close Click to close the device popup.
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. To make other changes, go to “Create or Edit an Extension” on page 29 for more information. Forget This Phone Forget Click to remove the Phone from management by the UniFi Controller software and reset it to factory default settings. Note: Use caution when clicking Forget.
Chapter 14: Client Details UniFi Controller User Guide Chapter 14: Client Details Hide Click to hide the Properties tab but allow the client popups to remain accessible from this tab. A client hyperlink opens the client’s Details window either in the Properties tab or as a separate popup window. You can always dock this window in the Properties tab or detach it as a separate window. There are four clickable tabs: The top of the window displays the client icon and name (or MAC address).
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 18 for more information). ESSID Displays the name of the wireless network. Connected AP Displays the name or MAC address of the AP being used by the client. You can click the name to get additional details on the AP. Category Displays the type of device.
Chapter 14: Client Details UniFi Controller User Guide Wireless Client – Configuration IP Config Config Fixed IP Select this option to assign a static IP address to the client, and configure the settings below. If you want the local DHCP server to assign an IP address to the client, remove the checkmark. Alias Allows you to change the hostname of the client. Note Allows you to enter comments about the client.
Chapter 14: Client Details Wired Client – Details UniFi Controller User Guide Deep Packet Inspection The Deep Packet Inspection information is available if the DPI feature is enabled (refer to “Settings > Site” on page 18 for more information). MAC Address Displays the MAC address or unique hardware identifier of the client. Hostname Displays the customizable name or identifier of the client. IP Address Displays the local IP address of the client.
Chapter 14: Client Details UniFi Controller User Guide Wired Client – History IP Config Date/Time Displays the date and time of the connection. Duration Displays the duration of the connection. Down Displays the total amount of data downloaded by the client. Up Displays the total amount of data uploaded by the client. Wired Client – Configuration Config Fixed IP Select this option to assign a static IP address to the client, and configure the settings below.
Chapter 14: Client Details 102 UniFi Controller User Guide Ubiquiti Networks, Inc.
Chapter 15: Hotspot Manager 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 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 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 Vouchers Create vouchers that include distributable codes, duration values, and use restrictions. Upload Displays the total amount of data uploaded. Status Displays the remaining session time for the guest. Displays Expired if there is no remaining session time.
Chapter 15: Hotspot Manager UniFi Controller User Guide • Bandwidth Limit (Download) Select to limit the download bandwidth. Enter the maximum in Kbps. Create New Operator To create a new operator account, click and complete the following: • Bandwidth Limit (Upload) Select to limit the upload bandwidth. Enter the maximum in Kbps. • 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.
Chapter 15: Hotspot Manager 106 UniFi Controller User Guide Ubiquiti Networks, Inc.
Appendix A: Portal Customization UniFi Controller User Guide Appendix A: Portal Customization 3. Select Portal Customization to enable it, and then click . 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.
Appendix A: Portal Customization Setup UniFi Controller User Guide 4. Double-click the Resources folder to open it. The html and css files are located on the system that the UniFi Controller software has been installed on. The files are in the following locations: UniFi Cloud Key /srv/unifi/data/sites//portal Mac /Applications/UniFi.app/Contents/Resources/data/ sites//portal Windows :\Users\\Ubiquiti UniFi\data\ sites\\portal 5.
Appendix A: Portal Customization UniFi Controller User Guide 8. Double-click the portal folder to open it. 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. 9.
Appendix A: Portal Customization 110 UniFi Controller User Guide Ubiquiti Networks, Inc.
Appendix B: UniFi Discovery Utility UniFi Controller User Guide Appendix B: UniFi Discovery Utility Overview 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.
Appendix B: UniFi Discovery Utility UniFi Controller User Guide 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 114 UniFi Controller User Guide Ubiquiti Networks, Inc.
UniFi Controller User Guide Appendix C: Mobile Apps Appendix C: Mobile Apps 3. The app will search for new devices. Tap the UniFi AP on the device list and go to step 5. Overview Ubiquiti Networks offers two UniFi mobile apps: • UniFi EasySetup App You can use a mobile device to provision a UniFi AP for basic functionality without configuring a UniFi Controller. • UniFi EDU App You can use the UAP-AC-EDU to broadcast announcements with clarity from your mobile device.
Appendix C: Mobile Apps 5. Create a device login using the Username and Password fields. Select the appropriate Country Code and tap OK. UniFi Controller User Guide 8. Scroll down the Config screen to access the following: • Firmware Upgrade Install the latest firmware on the UniFi AP. (Not available if the latest firmware is already installed.) • Forget This AP Remove the UniFi AP from management by the UniFi EasySetup App and reset it to factory default settings.
Appendix C: Mobile Apps UniFi Controller User Guide 10. The Settings screen offers the following options: • Secure Shell (SSH) Login Username Change the username of the device login. • SSH Login Password Change the password of the device login. • Country Code Change the country selection. • Single Sign-On (SSO) Username Change the username of the SSO account. • SSO Password Change the password of the SSO account.
Appendix C: Mobile Apps UniFi Controller User Guide 5. Enter the Username and Password, and then tap Log In. 8. After the speakers initialize, begin the announcement. Tap Stop Broadcasting to end the announcement. 6. Tap the site of your UniFi AP AC EDU devices. The speakers will automatically shut down when you stop broadcasting. 7. After the app checks the status of the speakers, select the ones you want to use, and tap Broadcast. Note: Use the slider control to adjust the volume for each speaker.
Appendix D: Controller Scenarios UniFi Controller User Guide Appendix D: 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 D: 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. 2. At the customer site, open a browser to the remote controller. The UniFi Controller is running in the cloud or your NOC (Network Operating Center). 3.
Appendix D: Controller Scenarios UniFi Controller User Guide 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 D: 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.
Appendix D: Controller Scenarios 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. 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 D: 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 E: Contact Information Appendix E: 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. 2580 Orchard Parkway San Jose, CA 95131 www.ubnt.com Online Resources Support: ubnt.
www.ubnt.com © 2011-2016 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.
