Enterprise System Controller Release Version: 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 8: Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 Clients (Total) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 Quick Look. . . . . . . . . . . . . . . . . . . . . . .
UniFi® Controller User Guide Chapter 14: Client Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Table of Contents 79 Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 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 Software Installation Introduction Follow the instructions for your specific computer type. Download the latest version of the UniFi Controller software at downloads.ubnt.com/unifi Thank you for purchasing the Ubiquiti Networks® UniFi® Enterprise System. The UniFi devices are bundled with the UniFi Controller software, which allows you to manage your UniFi network using a web browser. Mac Users 1.
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. 3. If your computer doesn’t have Java 1.6 or above installed, you will be prompted to install it. Click Install to continue. 2. By default, the preferred language is English. Select your country and time zone.
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.
Chapter 2: Using the UniFi Controller Software UniFi® Controller User Guide Chapter 2: 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 2: 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 Chapter 2: Using the UniFi Controller Software • Default Gateway Enabled by default. All managed APs will use the gateway of the AP that is providing IP information, either by DHCP or Static designation. Add a New WLAN Group To add a new WLAN group, click the button. Go to the Add or Edit a WLAN Group section. • Custom IP Click Use custom IP to specify an IP address; Add or Edit a WLAN Group -- Uplink IP Address All managed APs will use the IP address you enter.
Chapter 2: Using the UniFi Controller Software Save Click Cancel Click to apply changes. CANCEL to discard changes. UniFi® Controller User Guide -- WEP WEP (Wired Equivalent Privacy) is the oldest and least secure security algorithm. WPA™ security methods should be used when possible. For each WLAN group, you have the following: • Remove a WLAN Group To remove a WLAN group, select it from the drop-down menu, and then click the button. • WEP Key Enter a WEP encryption key in hexadecimal format.
Chapter 2: Using the UniFi Controller Software UniFi® Controller User Guide Networks Advanced Options Name Displays the network name. Purpose Displays a description of this network. Subnet Displays the IP address and prefix size. VLAN Displays the VLAN ID, if applicable. Actions Click a button to perform the desired action: • Edit Click to make changes to the network settings. Go to the Create or Edit a Network section below. to add a • Create New Network Click wireless network.
Chapter 2: Using the UniFi Controller Software Remote User VPN UniFi® Controller User Guide Voice • IP/Subnet Enter the IP address and prefix size. • IP Pool The starting and ending IP addresses of the pool automatically appear after you complete the IP/Subnet field. In most cases the Voice network is automatically created when you enable VoIP (refer to “Settings > VoIP” on page 16).
UniFi® Controller User Guide Settings > Guest Control The Guest Control screen displays the following sections: • Guest Policies (see below) • “Hotspot” on page 13 (for Hotspot authentication) • “Access Control” on page 15 Chapter 2: Using the UniFi Controller Software Expiration Specify the guest login expiration after a designated period of time: 8 hours, 24 hours, 2 days, 3 days, 4 days, 7 days, or User‑defined, which can be designated in minutes, hours, and days.
Chapter 2: Using the UniFi Controller Software Expiration Specify the guest login expiration after a designated period of time: 8 hours, 24 hours, 2 days, 3 days, 4 days, 7 days, or User‑defined, which can be designated in minutes, hours, and days. 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.
UniFi® Controller User Guide Hotspot When Hotspot authentication is selected, the Hotspot section is displayed. Chapter 2: Using the UniFi Controller Software -- Stripe (US, Canada) Use your Stripe account. To manage payments and transactions, use Hotspot Manager and see “Hotspot Manager” on page 83. Enter the Stripe account detail: • API Key Enter the live secret API key. Note: We recommend that you perform a test transaction with the test secret API key first before using the live secret API key.
Chapter 2: Using the UniFi Controller Software -- Merchant Warrior (Australia, New Zealand) Use your Merchant Warrior account. To manage payments and transactions, use Hotspot Manager and see “Hotspot Manager” on page 83. 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.
UniFi® Controller User Guide Access Control Chapter 2: Using the UniFi Controller Software Create or Edit an Admin • Email Enter the email address of the new administrator. • Admin Name Enter the name of the new administrator. Restricted Subnets Enter any subnets that you don’t want guests to be able to access. Click the delete icon to remove a subnet from this list. Add New Click Add New to add more restricted subnets. Allowed Subnets Enter any subnets that you want guests to be able to access.
Chapter 2: Using the UniFi Controller Software Create or Edit a User Group UniFi® Controller User Guide Setup Click this option to set up the SIP provider. The Provider Setup screen appears: • Name Enter or edit the name of the user group. • Bandwidth Limit (Download) Select to limit the download bandwidth. Enter the maximum in Kbps. • Bandwidth Limit (Upload) Select to limit the upload bandwidth. Enter the maximum in Kbps. • Save Click • Cancel Click to apply changes.
Chapter 2: Using the UniFi Controller Software UniFi® Controller User Guide • Advanced Options Click the following: arrow to display the -- SIP Voicemail Enter the URL or IP address of the SIP voicemail server. • Apply Click • Cancel Click to save changes. CANCEL to discard changes. None Select this option for local testing only. -- IP-Based If your VoIP system uses a static IP address, then select this option.
Chapter 2: Using the UniFi Controller Software The new phone numbers you create will appear on the VoIP screen: UniFi® Controller User Guide Create New Conference Click to add a new conference. Go to “Create or Edit a Conference” on page 19. Create or Edit an Extension Number The phone number is displayed. Extension The extension number is displayed. You can select a different extension number from the drop-down menu.
Chapter 2: Using the UniFi Controller Software UniFi® Controller User Guide • Remove To remove a member from the group, click the of that member in the group list. After Hours When selected, configure the Auto‑Responder settings for non-business hours. Edit Business Hours To change the business hours (the defaults are Monday-Friday, 9:00 am-5:00 pm), click this option. The Auto-Responder > Edit Business Hours screen appears: • Save Click • Cancel Click to apply changes.
Chapter 2: Using the UniFi Controller Software Upload Audio Upload an audio file (.mp3 or .wav) to use as your greeting. • Choose Click Choose to select the appropriate audio file, and then click Open. • Cancel Click Cancel to discard changes. Menu Add Option When a call is answered, you can have to set multiple menu options available. Click up menu options for the Auto‑Responder. Then configure the following: • Press Select the appropriate keypad number.
Chapter 2: Using the UniFi Controller Software UniFi® Controller User Guide Settings > Maintenance Alerts The Maintenance tab displays server version information, allows system backups to be created and downloaded, allows system restoration from backup files, and allows configuration information to be downloaded to assist in support issues. The Alerts tab displays a list of important events, along with the corresponding date, time, and message.
Chapter 2: Using the UniFi Controller Software UniFi® Controller User Guide Clicking an Event Device Link The messages have clickable links (white text on a gray background) for client and UniFi devices: • “UniFi Security Gateway Details” on page 55 • “UniFi Switch Details” on page 61 • “UniFi Access Point Details” on page 67 • “UniFi VoIP Phone Details” on page 77 • “Client Details” on page 79 22 Ubiquiti Networks, Inc.
UniFi® Controller User Guide Chapter 3: Dashboard The Dashboard screen provides a visual representation of your network’s status. Basic information is provided for each network segment: Chapter 3: Dashboard • Speed Test If your WAN connection is active, then you can mouse over the WWW icon to display the test. -- Start Now Click Start Now to run the test.
Chapter 3: Dashboard Red Red indicates one of the following: • WWW Internet connectivity is down. • WAN The gateway/router is offline. UniFi® Controller User Guide Gateway/Router The basic details of the UniFi Security Gateway are displayed. • LAN One or more Switches are offline. • WLAN More than half of the APs are offline. • VoIP More than half of the Phones are offline. Orange Orange indicates one of the following: • WLAN Half or fewer than half of the APs are offline.
UniFi® Controller User Guide Chapter 3: Dashboard Configuration Click the configuration icon to edit the configuration. Go to “Settings > Networks” on page 9 for more information. Wireless Local Area Network The basic details of the wireless network(s) are displayed. Status Displays the status of the network segment: Connected and Stable, Devices Down, Unreachable, or No Data Available. APs Displays the number of APs in the wireless network(s).
Chapter 3: Dashboard 26 UniFi® Controller User Guide Ubiquiti Networks, Inc.
Chapter 4: Map UniFi® Controller User Guide Chapter 4: 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 4: Map UniFi® Controller User Guide 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. 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 . 2. Click . 3. Click Cancel. 5. Click . 4.
Chapter 4: Map UniFi® Controller User Guide Placing Devices on the Map 5. The default view is Satellite view, as seen from above. Use the tools to navigate the map or zoom in/out. 1. Click Unplaced Devices at the lower right. 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 2. Drag each device icon from the Unplaced Devices list to the appropriate location on the map. .
Chapter 4: Map Options Click a UniFi icon to reveal options. Click a blank area of the map to hide them. UniFi® Controller User Guide Details Displays the device name, MAC address, transmit/ receive channel, number of users connected, and number of guests connected. Lock Lock the device icon to its current location. Details Display the Details screen.
Chapter 4: Map UniFi® Controller User Guide (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). 3. Enter the distance that the line represents in the Distance field. By default, the distance is specified in meters but you can switch to feet using the drop-down menu on the right. Click . to add maps or Zoom Slider Use to zoom the map detail in and out.
Chapter 4: Map 32 UniFi® Controller User Guide Ubiquiti Networks, Inc.
Chapter 5: Devices UniFi® Controller User Guide Chapter 5: 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.
Chapter 5: 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. Name/MAC Address Displays the hostname, alias, or MAC address of the UniFi device. You can click the name to get additional details.
Chapter 5: Devices UniFi® Controller User Guide • 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. APs The LED color of the device icon indicates the device status.
Chapter 5: Devices Config UniFi® Controller User Guide Radio 2G Displays the channel and TX power settings used in the 2.4 GHz radio band. Radio 5G Displays the channel and TX power settings used in the 5 GHz radio band. 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.
Chapter 5: Devices UniFi® Controller User Guide Status Displays the connection status. • Connected The AP is physically wired to the network. Phones VoIP is available with UniFi Controller version 4.6 or higher. • Connected (wireless) The AP is wirelessly uplinked to a physically wired AP. • Disconnected The AP is unreachable by the UniFi Controller software. • Isolated A managed AP is unable to locate its uplink.
Chapter 5: Devices UniFi® Controller User Guide 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 Devices screen. Information about each selected device appears as a popup within this tab. The information varies depending on the device type.
Chapter 6: Clients UniFi® Controller User Guide Chapter 6: Clients IP Address Displays the IP address used by the client. The Clients screen displays a list of network clients. 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. AP/Port Indicates which AP or switch port is used. Connection Indicates which local network is used.
Chapter 6: Clients UniFi® Controller User Guide • Unauthorize (Available for Guests only.) Click to remove authorization of wireless guest access and disconnect the client. Wireless Down Displays the total amount of data downloaded by the client. Up Displays the total amount of data uploaded by the client. Activity Displays the level of activity for each client.
Chapter 6: Clients UniFi® Controller User Guide Port Displays the name of the network device and port number used by the client. You can click the name to get additional details; refer to “UniFi Switch Details” on page 61 for more information. Down Displays the total amount of data downloaded by the client. Close Click popups. to close the Properties tab and client Minimize Click rows. to display the clients as drop-down Up Displays the total amount of data uploaded by the client.
Chapter 6: Clients 42 UniFi® Controller User Guide Ubiquiti Networks, Inc.
Chapter 7: Calls UniFi® Controller User Guide Chapter 7: Calls The Calls screen displays a list of VoIP calls. You can click any of the column headers to change the list order. Time Duration Filter the results on the page based on the time duration. Select 1 hour, 8 hours, 24 hours, 2 days, 7 days, 2 weeks, or 1 month. Items per page Select how many results are displayed per page: 10, 50, 100, or 200.
Chapter 7: Calls UniFi® Controller User Guide Incoming Internal Direction Displays Incoming. Direction Displays whether the call is Incoming or Outgoing. Origin Displays the extension or phone number of the caller, if known. Recipient Displays the extension or phone number of the call recipient. Status Displays the current status of the call: Ongoing, Successful, Voicemail, Transferred, or Terminated. Origin Displays the extension or phone number of the caller, if known.
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 48 UniFi® Controller User Guide Ubiquiti Networks, Inc.
Chapter 9: Insights UniFi® Controller User Guide Chapter 9: Insights Known Clients The Insights screen displays different kinds of status information. Four filters are available: • Known Clients Displays information about detected clients. • Rogue Access Points Displays information about wireless devices not managed by the UniFi Controller. • Past Connections Displays information about previous client connection sessions (for example, a client can have multiple sessions from different days).
Chapter 9: Insights UniFi® Controller User Guide A secondary filter is available: • All Display all clients, regardless of connection type. Rogue Access Points • Wireless Display all wireless clients. • Wired Display all wired clients. Last Seen Filter the results on the page based on the time the AP was last seen. Select 1 Day, 3 Days, 7 Days, 2 Weeks, 1 Month, 2 Months, or 1 Year. Name/SSID Displays the name of the wireless network.
Chapter 9: Insights UniFi® Controller User Guide Past Connections Past Guest Authorizations You can apply one of the following filters: Time and Date You can filter by time and date period. You can also change the duration interval by toggling between 1 Hour, 24 Hour, and 7 Days. • All Display all users and guests. • User Only display users. • Guest Only display guests. Time and Date You can filter by time and date period.
Chapter 9: Insights Switch Stats UniFi® Controller User Guide Mode Displays the operation mode: You can apply one of the following primary filters: • Switching The default mode. • Switch Displays the ports of all UniFi Switches or a specific Switch. • Mirroring The network traffic of this port will receive the mirrored traffic from the port selected in ”Port Configuration” on page 63. • Link Status Displays the ports of the specified status: -- Disconnected Displays all disconnected ports.
Chapter 9: Insights UniFi® Controller User Guide PoE You can apply the PoE Mode filter: • All Displays all ports using any PoE Mode setting. • Enabled Displays all ports set to PoE+ or 24V Passive. • Power On Displays all ports with active PoE output. • Passive Displays all ports set to 24V passive PoE. • Disabled Displays all ports with PoE disabled. Current Displays the current output in amperes, if applicable.
Chapter 9: Insights 54 UniFi® Controller User Guide Ubiquiti Networks, Inc.
Chapter 10: UniFi Security Gateway Details UniFi® Controller User Guide Chapter 10: UniFi Security Gateway Details Minimize Click rows. to display the clients as drop-down 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. The top of the window displays the device icon and name (or MAC address).
Chapter 10: UniFi Security Gateway Details UniFi Security Gateway – Details UniFi® Controller User Guide WAN Click Details to display the device specifics, LAN/WAN connection details, and uptime. Overview Overview IP Address Displays the WAN (public) IP address of the WAN interface. Speed Displays the connection speed in Mbps. Overview MAC Address Displays the MAC address or unique hardware identifier of the Gateway. Model Displays the model name of the Gateway.
UniFi® Controller User Guide 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 Chapter 10: UniFi Security Gateway Details • 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 Port Displays the port or ports that will be forwarded to the LAN. Dest IP/Port Displays the destination IP address and/or port, which will receive the forwarded port traffic. Actions Click a button to perform the desired action: • Edit Click • Delete Click to edit the port forwarding entry. to delete the port forwarding entry.
UniFi® Controller User Guide Chapter 10: UniFi Security Gateway Details Forget This Gateway Forget Click to remove the Gateway from management by the UniFi Controller software and reset it to factory default settings. Note: Use caution when clicking Forget. This will restore the Gateway to factory default settings while it is in a Connected state. Move to To move the Gateway, select another site from the drop-down menu. Ubiquiti Networks, Inc.
Chapter 10: UniFi Security Gateway Details 60 UniFi® Controller User Guide Ubiquiti Networks, Inc.
Chapter 11: UniFi Switch Details UniFi® Controller User Guide Chapter 11: UniFi Switch Details A UniFi Switch hyperlink opens the UniFi Switch’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. • 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.
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.
Chapter 11: UniFi Switch Details UniFi® Controller User Guide UniFi Switch – Ports Port Configuration Click Ports to display the port name, status, TX and RX throughput, PoE setting, and networks/VLANs. • Port Displays the number of the port. • Name Displays the customizable name or identifier of the port. Click Apply to save the change. • 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.
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. -- Mirroring The network traffic of this port will receive the mirrored traffic from the port listed below for analysis: • Mirroring Port Enter the number of the port that will be mirrored.
Chapter 11: UniFi Switch Details UniFi® Controller User Guide Name Displays the name of the network/VLAN. Config Displays the configuration: Native (____) or Customized. (Networks may be created in “Settings > Networks” on page 9.) Actions Click a button to perform the desired action: • Edit Click to edit the network/VLAN entry. • Delete Click to delete the network/VLAN entry.
Chapter 11: UniFi Switch Details Enable Flow Control Disabled by default. Flow Control allows the port to manage data rates in case the sending and receiving devices use different data transmission rates. Apply Click Apply to save changes. UniFi® Controller User Guide • 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.
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 # Guests Displays the number of guests connected to the guest network. UniFi Access Point – Users Name Displays the hostname, alias, or MAC address of the connected client. You can click the name to get additional details; see “Client Details” on page 79 for more information.
Chapter 12: UniFi Access Point Details UniFi® Controller User Guide UniFi Access Point – Configuration Radios Change device configuration settings. Alias Alias Enter or edit the customizable name or identifier of the AP. The Alias is also known as the host name. Apply Click Apply to save the change. Channel Select the appropriate settings: • Auto/(channel number) Select a channel number or keep the default, Auto. • HT20/HT40 Select HT20 for 20 MHz operation or HT40 for 40 MHz operation.
Chapter 12: UniFi Access Point Details WLANs UniFi® Controller User Guide Override You can deploy multiple wireless networks organized into WLAN groups on different APs. Enabled Select the checkbox to enable override settings on the AP VLAN Select the checkbox to enable the VLAN. WLAN Group Select the appropriate group from the drop-down menu. Name Displays the network name or SSID of the available wireless network. Overrides Displays the SSID override information applied to the wireless network.
UniFi® Controller User Guide Chapter 12: UniFi Access Point Details Network Wireless Uplinks Configure IP Select the Internet connection type for your service. When an AP is not connected by a wire, the Wireless Uplinks section lists potential uplink APs that can be selected to establish a wireless connection. • Using DHCP Enabled by default. The AP automatically acquires network settings from the network’s Dynamic Host Configuration Protocol (DHCP) server.
Chapter 12: UniFi Access Point Details UniFi® Controller User Guide Access Point - Isolated/Disconnected Access Point - Managed by Other When an AP is in an Isolated or Disconnected state, you can re-establish a connection to the UniFi Controller software using one of three methods: The Managed by Other state indicates that the AP is not in the default state but it is not controlled by the UniFi Controller. • Reconnect the AP to the gateway/router.
UniFi® Controller User Guide Chapter 12: UniFi Access Point Details Access Point - Pending Approval The Pending Approval state indicates that the Access Point is in the default state and is available for adoption. MAC Address Displays the MAC address of the AP. Model Displays the model number. Version Displays the version of software used on the AP. Last Seen Displays the amount of time that has passed since the AP was last seen.
Chapter 12: UniFi Access Point Details 76 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 “Add Click this option to set up a new number. The Ceate New Number screen appears:” on page 17 for more information. Forget This Switch 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 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. The top of the window displays the device icon and name (or MAC address). Properties • Detach Click to display the same information in a separate popup screen that can be moved anywhere within the browser screen.
Chapter 14: Client Details Wireless Client – Statistics UniFi® Controller User Guide Wireless Client – Configuration Config 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. Channel Displays the channel being used. Signal Displays the percentage of signal strength between the AP and client. TX Rate Displays the transmit rate.
Chapter 14: Client Details UniFi® Controller User Guide Debug Wired Client – Statistics Device Type Displays the type of device. If it is offline, “Unknown” is displayed. Wired Client – Details Network Displays the network used by the client. Port Displays the name and port of the UniFi device being used by the client. You can click the name to get additional details on the UniFi device. Activity Displays the level of activity in Bytes per second.
Chapter 14: Client Details Wired Client – Configuration UniFi® Controller User Guide 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. Once saved, the client will be designated as a “Noted” client on the Clients tab.
UniFi® Controller User Guide Chapter 15: Hotspot Manager Hotspot Manager includes four main tabs when accessed by the UniFi Controller admin account. For details on a specific tab, refer to the appropriate section. “Wireless Guests” on page 84 Chapter 15: Hotspot Manager To access the Hotspot Manager, go to Settings > Guest Control, and click Go to Hotspot Manager. See “Hotspot” on page 13 for more information. The UniFi Hotspot Manager login screen will appear.
Chapter 15: Hotspot Manager UniFi® Controller User Guide Wireless Guests Payments and Transactions The Hotspot’s active wireless guests are displayed. The Hotspot’s payments and transactions are displayed. Search Enter keywords in the Search field to find a specific guest based on Name/MAC Address, Package, Amount, Authorized By, or Status value. Search Enter keywords in the Search field to find a specific voucher based on Time, Name, Package, Amount, Extra Info, or Status value.
Chapter 15: Hotspot Manager UniFi® Controller User Guide Vouchers Create vouchers that include distributable codes, duration values, and use restrictions. Create Vouchers To create a batch of vouchers, click and complete the following: • Create __ Enter the number of vouchers to create. • One time/Multi-use Select how often the voucher can be used: One time or for Multi-use. • vouchers for __ Select how long the voucher is valid: 8 hours, 24 hours, 2 days, 3 days, 4 days, 7 days, or User‑defined.
Chapter 15: Hotspot Manager Operator Accounts Create Operator Accounts that can log in to Hotspot Manager to manage wireless guests, payments or transactions, and vouchers. UniFi® Controller User Guide Create New Operator To create an operator account, complete the following: • Account Name Enter a name for the operator. The Account Name can only be A-Z, a-z, or 0-9. No spaces are allowed. • Password Enter a password for the operator. The Password has to start with A-Z, a-z, or 0-9.
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: Mac /Applications/UniFi.
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 90 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.
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 94 UniFi® Controller User Guide Ubiquiti Networks, Inc.
UniFi® Controller User Guide Appendix C: Contact Information Appendix C: Contact Information Ubiquiti Networks Support Ubiquiti Support Engineers are located around the world and are dedicated to helping customers resolve software, hardware compatibility, or field issues as quickly as possible. We strive to respond to support inquiries within a 24-hour period. Ubiquiti Networks, Inc. 2580 Orchard Parkway San Jose, CA 95131 www.ubnt.com Online Resources Support: support.ubnt.com Community: community.ubnt.
© 2011-2015 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. All other trademarks are the property of their respective owners.