Escolar Documentos
Profissional Documentos
Cultura Documentos
Controller
Release Version: 3.2
UniFi Controller User Guide Table of Contents
Table of Contents
UAP-AC
Wireless Uplink1
UAP-Outdoor+ UAP-PRO UAP-PRO
Router
UAP-PRO
or
UAP-AC
Hardware Overview and Installation
The Quick Start Guide that accompanied your UniFi AP
Additional information about the UniFi Controller is includes a hardware description and instructions for
available on our website at hardware installation.
http://community.ubnt.com/unifi
4. Click Next.
For most versions of Windows, the UniFi Controller 4. The UniFi Installation Wizard will create a secure
software can also be launched from Start > All Programs. primary wireless network for your devices. Perform the
following steps:
Clicking an Alert Device Link LED When enabled, the LED on the Access Point will light
up. When disabled, the LED will turn off.
The messages have clickable links [blue text in gray
brackets] for AP (see Access Point Details on page Uplink Connectivity Monitor It monitors the uplinks of
32), User, and Guest (see User/Guest Details on page the managed Access Points, either wired or wireless, by
43). Details vary based on the selection. checking to see if the gateway/custom IP can be reached.
The monitor and wireless uplink capability are enabled by
Settings default.
The Settings tab displays a list of available sub-tabs: Use default gateway Enabled by default. All managed
Access Points will use the gateway of the Access Point
Site Site-related settings. that is providing IP information, either by DHCP or Static
designation.
Wireless Networks Wireless networks and Use custom IP Select Use custom IP to specify an
group setup, including Zero Handoff Roaming. IP address; all managed Access Points will use the IP
address you enter in the Uplink IP address field.
Guest Control Guest portal and policies.
SNMP Select this option to activate the SNMP
(Simple Network Monitor Protocol) agent. SNMP
User Groups User group settings. is an application layer protocol that facilitates the
exchange of management information between
Controller Identity, discovery, and email server network devices. Network administrators use SNMP
settings. to monitor networkattached devices for issues that
warrantattention.
>_ Site Admins Admin accounts and privileges. Community String Specify the SNMP community
string. It is required to authenticate access to MIB
(Management Information Base) objects and functions
as an embedded password. The device supports a
read-only community string; authorized management
stations have read access to all the objects in the MIB
except the community strings, but do not have write
Settings > Site access. The device supports SNMP v1. The default
ispublic.
Configure the site-specific settings. To switch sites, select a
different site from the Site drop-down menu at the top of Remote Logging Enable to define a remote syslog server.
any screen. Enter the IP address and port of the syslog server.
Device Password The Device Password protects SSH
access to the UniFi APs. It is randomly generated when you
create a site. All devices in the same site share the same
SSH username and password. You can also make changes:
Username Enter the new username.
Password Enter the new password.
Apply Click Apply to save changes.
Site Configurations
Site Name Change the name of the site.
Country Select your country from the drop-down menu.
Automatic Upgrade When enabled, this option will
automatically upgrade your firmware when an update is
available.
WLANs
Name Enter a descriptive name for the WLAN group.
Name Displays the wireless network name or SSID.
Roaming To enable Zero Handoff Roaming, select the
Security Displays the type of security being used on your
checkbox.
wireless network.
Note: The UniFi AP-AC does not support Zero Guest Network Indicates whether or not the network is a
Handoff Roaming for the initial release, but it will guest network.
with a future firmware upgrade.
When you enable this option, multiple APs act as an Actions Click a button to perform the desired action:
AP cluster, appearing as a single AP. The wireless client Edit Make changes to the wireless network settings. Go
detects only one AP, so it seamlessly roams from AP to to the Create or Edit a Wireless Network section below.
AP there is no need to re-negotiate. The APs determine Delete Delete the wireless network.
which AP has the best connection and should serve the
Create Add a wireless network. Go to the Create or Edit a
client. They use multicasting to communicate so they
Wireless Network section below.
must be wired in the same Layer 2 domain.
Create or Edit a Wireless Network
Zero Handoff Roaming does not support wireless
uplinks and can only be used on a secured network. It
is also not meant for all scenarios. For example, if there
is too much load or interference, then Zero Handoff
Roaming may not be appropriate for your scenario.
Settings > Guest Control Portal Customization Select this option to have
customized portal pages appear in place of the default
The Guest Control screen displays the following sections:
login pages. See Portal Customization on page 48
Guest Policies (see below) for details on setting up custom portal pages.
Hotspot on page 11 (for Hotspot authentication) Portal URL Hostname Enter a hostname for the portal
Access Control on page 12 URL in place of the default IP address. Paired with an SSL
certificate, this ensures that site certificates are displayed
as trusted in the guest browser. Example: www.ubnt.com
When logging in with No authentication, guests will be
required to accept the Terms of Use before gaining access
to the Internet.
Guest Policies
Guest Portal Disabled by default. When disabled, guests
can access the Internet without entering a password or Authentication > Simple Password
accepting the Terms of Use. When this option is enabled, Select this option if guests are required to enter a simple
you can control the Guest Portal. password and accept the Terms of Use. When you select
Authentication When the Guest Portal is enabled, the Simple Password, you must select Guest Policy under
authentication options will appear: Settings > Wireless Networks > wireless_network_name >
Edit > Wireless Configurations in order to enforce password
No Authentication (see below) entry and selection of the Terms of Use by the guest. See
Simple Password (see the next column) Guest Policy on page 9 for more information.
Authentication > Hotspot on page 11
Authentication > External Portal Server on page 12
Authentication > No Authentication
Select this option if guests are not required to log in, but
must accept the Terms of Use. You must also select Guest
Policy under Settings > Wireless Networks > wireless_
network_name > Edit > Wireless Configurations in order to Guest Password Enter a password that guests must enter
enforce selection of the Terms of Use by the guest. See before accepting the Terms of Use and connecting to the
Guest Policy on page 9 for more information. Internet.
Expiration Specify the guest login expiration after a
designated period of time: 8 hours, 24hours, 2 days, 3 days,
4 days, 7 days, or Userdefined, 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
Expiration Specify the guest login expiration after a following options:
designated period of time: 8 hours, 24hours, 2 days, 3 days,
Redirect to the original URL After accepting the Terms
4 days, 7 days, or Userdefined, which can be designated in
of Use, guests are directed to the URL they requested.
minutes, hours, and days.
Promotional URL After accepting the Terms of Use,
Landing Page After accepting the Terms of Use, guests
guests are redirected to the URL that you specify. Ensure
are redirected to the landing page. Select one of the
that the URL begins with http://
following options:
(example: http://www.ubnt.com).
Redirect to the original URL After accepting the Terms
Portal Customization Select this option to have
of Use, guests are directed to the URL they requested.
customized portal pages appear in place of the default
Promotional URL After accepting the Terms of Use, login pages. See Portal Customization on page 48
guests are redirected to the URL that you specify. Ensure for details on setting up custom portal pages.
that the URL begins with http://
(example: http://www.ubnt.com).
-- Quickpay (Europe) Use your Quickpay account. When logging in with voucher-based Hotspot
To manage payments and transactions, use Hotspot authentication, guests will be required to enter the
Manager and see Hotspot Manager on page 45. voucher number and accept the Terms of Use before
gaining access to the Internet.
Server Information
Version Displays the software version. If there is an
update, UniFi will automatically download it and display it.
Name Displays the name of the administrator.
Backup
Email Displays the email address of the administrator.
Historical Data Retention Select the time duration
Role Displays the permissions level: admin (read/write of the backup: 1 week, 1 month, 2 months, 3 months,
access), readonly, or hotspot (operator read-only access). 6months, 1 year, or Everything. The default is 1 week.
Actions Click a button to perform the desired action: Download Click Download Backup Settings to
Revoke Remove the selected account. download a file that contains all of your settings so you
can restore them later if you choose.
Re-invite (Not applicable to superadmin or operator
accounts.) Send another email invitation. Restore
Invite Click to add a new site administrator. Choose File Select this option to restore settings from a
backup file that youve already downloaded.
Support Info
Debug Log You can customize the support information
that is collected:
device Select the level of severity required to trigger
device log entries. The default is Normal.
mgmt Select the level of severity required to trigger
management log entries. The default is Normal.
system Select the level of severity required to trigger
Email Enter the email address of the new administrator. system log entries. The default is Normal.
Admin Name Enter the name of the new administrator. apply Click apply to save changes.
Role Select Administrator (read/write access) or User Download Select this option to download a file to your
(read-only access). computer with information about your configuration. You
Invite Click Invite to send an email invitation. can email this file to our support team.
Cancel Click Cancel to discard changes.
Chapter 3: Map Tab Once youve created the map, you can upload it to the
UniFi Controller software by performing the following
The UniFi Controller software allows you to upload custom steps:
map images of your location(s) or use Google Maps for a 1. Click Configure Maps.
visual representation of your wireless network. When you Configure Maps button
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.
4. Click Close.
4. The default view is Map, which looks like a street map. 5. Click Close.
Use the tools on the left to navigate the map or zoom
in/out.
You can adjust the zoom using the slider on the right.
In the Search field, you can enter an address or the Placing Access Points on the Map
latitude and longitude of a specific location. Then press Drag the Access Point / / icon(s) from the Unplaced
the return or enter key. APs list on the left to the appropriate location(s) on
themap.
Wired/Wireless Access Point Each icon Show: Click any of the following options to display Access
indicates the location of the Access Point on the Point labels, details, wireless coverage, and topology on
map. Click and hold this icon to drag the Access themap.
Point to another location on the map. Click an
Access Point icon to reveal additional options.
Click a blank area of the map to hide the icons.
Labels Displays the name applied to the Access Point.
Refer to Alias under Configuration on page 36 to
Note: Not all icons are shown here.
change a name applied to an Access Point. If no custom
label is applied, the Access Points MAC address will be
displayed.
Topology Displays a visual representation of the network Setting the Map Scale
configuration and connections between Access Points.
Any device that is wirelessly connected will have a wireless 1. Click the Set Map Scale button.
icon next to it. A path of arrows will indicate the wireless 2. Click and hold to draw a line in the area that you want
Access Point and its uplink to a wired Access Point. to use to set the scale of the map. If you need to redraw
the line, just click and hold again to draw a new line.
Once youre happy with the line, click Next.
The legend at the bottom of the map shows the new scale
of the map.
Set Map Scale Use this option to define the scale of the
map. You will draw a line and define the distance that the
line represents.
Chapter 4: Statistics Tab Date At the top right of the screen, you can filter the
statistics by date and time period. You can also change the
The Statistics tab provides a visual representation of the duration interval by toggling between 24h (24 hours) and
network traffic connected to your managed APs. Charts 30d (30 days).
representing the number of clients and network traffic. An
hour-by-hour chart of the usage over the last 24 hours is
also displayed on this screen.
Clients
Recent Activities
The details of recent network activities are displayed.
Most Active AP
The details of the most active Access Point are displayed: # of Clients A graph displays the number of clients
Name or MAC address You can click this link to open the connected during the selected time period. Place the
AP Details screen. See Access Point Details on page mouse cursor over a point to display the exact number.
32 for additional information. Traffic A graph displays the network traffic during the
Download Displays the total amount of data downloaded selected time period. Place the mouse cursor over a point
by the AP. to display the specific amount of data.
Upload Displays the total amount of data uploaded by
the AP.
Most Active Client
The details of the most active client in current use are
displayed:
Name or MAC address You can click this link to open the
User/Guest Details screen. See User/Guest Details on
page 43 for additional information.
Download Displays the total amount of data downloaded
by the client.
Upload Displays the total amount of data uploaded by
the client.
All-Time Top Client
The details of the all-time, most active client are displayed:
Name or MAC address You can click this link to open the
User/Guest Details screen. See User/Guest Details on
page 43 for additional information.
Download Displays the total amount of data downloaded
by the client.
Upload Displays the total amount of data uploaded by
the client.
Adopt Adopt an Access Point that appears under 2G Clients Displays the number of clients connected to
Access Points > Pending at the top of the interface. The the Access Point using the 2.4 GHz band.
Status will appear as Adopting until the Access Point is 5G Clients Displays the number of clients connected to
connected. the Access Point using the 5 GHz band.
TX Displays the overall TX (transmit) rate.
RX Displays the overall RX (receive) rate.
TX 2G Displays the overall TX rate for the 2.4 GHz radio
Upgrade If a software upgrade is available for the band. The different colors represent different types of
Access Point, click Upgrade to install the latest UniFi packet activity:
firmware on the device. The Status will appear as
Upgrading until the process is complete and the Access Color Packet Activity
Points reconnects to the UniFi Controller software. Packets sent
Packets retried
Packets not sent due to likely interference
Signal Displays the percentage of signal strength and Actions Click a button to perform the desired action:
type of signal in use. The leaf symbol indicates power save Block Block this guest from accessing the Access Point.
mode. The device will return to active mode when Down
or Up activity resumes. Reconnect Reconnect this guest to the Access Point.
Authorize Manually grant authorization when a guest
Icon Clients Mode is in a pending state.
Unauthorize Remove authorization of wireless guest
ac 5 GHz (802.11ac) Active
access and disconnect the client.
5 GHz (802.11ac) Power Save
ac
a 5 GHz (802.11a) Active
For the User, Guest, and All filters, a secondary filter is Location Displays the name of the closest Access
available: Point managed by UniFi. You can click the name to get
Offline Only Only display clients who are currently additional details on the Access Point.
offline. Last Seen Displays the last date and time the AP was
All Display all clients, regardless of connection status. connected.
Last Seen Filter the results on the page based on the Past Connections
time the client was last seen. Select 1 day, 3 days, 7 days,
2weeks, 1 month, 2months, or 1 year.
Name/MAC Address Displays the hostname, alias, or
MAC address of the connected client. You can click the
name to get additional details.
User/Guest Indicates whether the client is/was
connected to a primary or guest network.
Down Displays the total amount of data downloaded by
the client.
Up Displays the total amount of data uploaded by
theclient.
Last Seen Displays the last date and time the client was
connected. You can apply one of the following filters:
Actions Click a button to perform the desired action: User Only display users.
Block Block this client from accessing the Access Point. Guest Only display guests.
After you have blocked a client, you can click unblock to All Display all users and guests.
allow access.
Date Filter by date and time period.
Rogue Access Points Name/MAC Address Displays the hostname, alias, or
MAC address of the connected client. You can click the
name to get additional details.
User/Guest Indicates whether the client is/was
connected to a primary or guest network.
Associated Displays the date and time the client first
connected.
Duration Displays the length of time the client was
connected.
Down Displays the total amount of data downloaded by
the client.
Up Displays the total amount of data uploaded by
theclient.
Slider Move the slider right and left to navigate between
pages of APs. IP Displays the last known IP address of the client.
Last Seen Filter the results on the page based on the Last AP Displays the name or MAC address of the last
time the AP was last seen. Select 1 day, 3 days, 7 days, Access Point used by the guest. You can click the name to
2weeks, 1 month, 2months, or 1 year. get additional details on the Access Point.
Name/SSID Displays the name of the wireless network.
BSSID Displays the MAC address of the APs wireless
interface.
Channel Displays the channel setting that the AP was
detected on.
Type Displays the security status indicating whether
encryption is used.
Manufacturer Displays the name of the AP manufacturer.
Chapter 9: Access Point MAC Address Displays the MAC address of the
AccessPoint.
Details Model Displays the model number.
Version Displays the version of software used on the
UniFi Access Points connect to the UniFi Controller Access Point.
software either by Ethernet, indicated as Connected, or by
a wireless connection, indicated as Connected(wireless). IP Address Displays the IP address of the Access Point.
Based on connection type, options under each tab vary. Uptime Displays the amount of time the Access Point has
Note: The UniFi AP-AC and AP-AC Outdoor do not been running without interruption.
support wireless uplinks for the initial release, but # Users Displays the number of users connected to the
they will with a future firmware upgrade. primary network.
The upper part of the window has four clickable tabs: # Guests Displays the number of users connected to the
Details (see below) guest network.
Users on page 35 Uplink (Wireless)
Guests on page 35 Click Uplink (Wireless) to display details about the
Configuration on page 36 wireless uplink. See Wireless Uplinks on page 39 to
The bottom of the window has two buttons: find, select, and connect to a wireless Access Point.
Locate Use the Locate button to flash the LED on the
Access Point and flash the Access Point icon on the map.
Restart Use the Restart button to restart the
AccessPoint.
Note: The UAP-AC, UAP-PRO, and UAP models are
shown in this chapter; however, this information also
applies to the other UniFi AP models.
Details
Details about the Access Point. Click Overview to display
the device specifics, connection details, uptime, and user
statistics.
Overview
Users Guests
Configuration Radio(s)
Change device configuration settings. Click the Apply
button to save changes.
Config
WLANs
You can deploy multiple wireless networks organized into
WLAN groups on different Access Points.
Override
Enabled Select the checkbox to enable override settings
on the Access Point.
VLAN Select the checkbox to enable the VLAN.
VLAN ID The VLAN ID is a unique value assigned to
each VLAN on a single device. Enter a value between
2and 4095. For example, in a large deployment where
there are multiple buildings, you can use a different
VLAN ID for each building while all of the VLANs remain
on the same corporate network.
SSID Enter the SSID override name to apply to the
wireless network.
PSK If the WPA-Personal security option has been applied
WLANs (11n/b/g) or WLANs (11n/a) to the WLAN under Settings > Wireless Networks on
WLAN Group Select the appropriate WLAN group from page 8, the PreShared Key (PSK) for the SSID specified
the drop-down menu. will automatically appear in this field.
Name Displays the network name or SSID of the available Actions Click a button to perform the desired action:
wireless network. Apply Click Apply to save changes.
Overrides SSID override information applied to the Restore Click Restore to remove any overrides that
wireless network. were applied to the selected wireless network.
Actions Click a button to perform the desired action: Cancel Click Cancel to discard changes.
Override Click Override to enable a VLAN (Virtual
Local Area Network), set the VLAN ID, and enter the SSID
override name to apply to the wireless network.
Network
Configure the Access Point to obtain an IP address
automatically or use a static IP address.
Potential Uplinks
AP Displays the name or MAC address of the potential
Uplink Access Point.
Channel Displays the channel in use for wireless
communication.
Signal Displays the percentage of signal strength.
Actions Click a button to perform the desired action:
Select Click Select to connect the wireless Access Point
to the wired Access Point.
Remove Click Remove to remove the wired Access
Point from this list of Potential Uplinks.
Note: An Access Point can only uplink to another
Access Point using the same radio band. For
example, the UAP-Outdoor 5G can only uplink to
another UniFi AP using the 5GHz radio band.
History Configuration
Config
Down Displays the amount of data downloaded by the Note Enter a description or comments. Once the note is
user during the session. saved, the user will be designated a Noted client on the
Insight > Known Wireless Clients tab.
Up Displays the amount of data uploaded by the user
during the session. Usergroups Assign a User Group to the user, or keep
the default, Automatic. User Groups are set up under the
Settings tab > User Groups option (see Settings > User
Groups on page 13 for more information).
Apply Click Apply to save changes.
Debug
Chapter 11: Hotspot Manager Search Enter keywords in the Search field to find a
specific guest based on Name/MAC Address, Package,
Hotspot Manager includes four main tabs when accessed Amount, Authorized By, or Status value.
by the UniFi Controller admin account. These tabs include Show guests within Filter by time duration: last
Wireless Guests, Payments/Transactions, Vouchers, and 24hours, 3days, 7 days, 2 weeks, 30 days, and 120 days.
Operator Accounts. Name/MAC Address Displays the connected guests
The UniFi Controller admin can create operator accounts device name or MAC address.
for the Hotspot Manager. Operator accounts are Package Displays the description of the package that was
designed for use by hotels or other businesses to service purchased (if applicable).
guests and have no access to other UniFi administrative
Amount Displays the amount paid for access (if
features. Operator accounts will have access to three
applicable).
tabs after login: Wireless Guests, Payments/Transactions,
andVouchers. Authorized By Displays the authorization method. If
there is no authorization, then None is displayed.
Wireless Guests Download Displays the total amount of data
The Hotspots active wireless guests are displayed. downloaded.
Upload Displays the total amount of data uploaded.
Status Displays the remaining session time for the guest.
Actions Click a button to perform the desired action:
Disconnect Immediately disconnect the selected guest.
Extend Every time you click this button, you extend a
guests session for an additional 24hours. For example,
if you click it three times, you will extend guest access
for three more days.
Payments/Transactions Vouchers
The Hotspots payments and transactions are displayed. Create vouchers that include distributable codes, duration
values, and use restrictions.
Operator Accounts
Create Operator Accounts that can log in to Hotspot
Manager to manage wireless guests, payments or
transactions, and vouchers.
Setup
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:
3. Select Portal Customization to enable it, and then Mac
click Apply.
/Applications/UniFi.app/Contents/Resources/data/
sites/<site_name>/portal
Windows
<Drive_Letter>:\Users\<Username>\Ubiquiti UniFi\data\
sites\<site_name>\portal
For specific instructions on accessing the files, refer to the
specific operating system:
Mac on page 49
Windows on page 50
9. You have several files that you can customize in the Customizable Default Files
portal folder (these are described in the Customizable
The following default customizable html and css files are
Default Files section).
located in the portal folder:
index.html Main landing page that displays pricing to
the guest.
payment.html Used to submit credit card information.
It requires https and also serves as an example of an
additional .html page.
fail.html Displayed when there is an error handling a
guest login.
reset-min.css Standardizes the rendering of HTML
elements across browsers.
styles.css Controls the style of HTML elements.
10. To customize the voucher, doubleclick the bundle
folder to open it. The following default files are located in the bundle folder:
voucher.html Main landing page.
voucher.css Standardizes the rendering of HTML
elements across browsers.
messages.properties You can edit this file using a text
editor such as TextEdit. This file defines package costs,
duration of access, package titles, and how the charge
will appear on a customers credit card account. Error
messages are also defined by this file.
Locate Manage
Locate the Access Point. The following window will Set the inform URL, allowing the Access Point to be
appear: 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:
Reset Reboot
Reset the Access Point to factory default settings. The To reboot the Access Point, click any of the buttons
following window will appear: (Locate, Manage, or Reset) on the UniFi Discovery Utility
screen. The following window will appear:
Appendix C: Contact
Information
Ubiquiti Networks Support
Ubiquiti Support Engineers are located around the world
and are dedicated to helping customers resolve software,
hardware compatibility, or field issues as quickly as
possible. We strive to respond to support inquiries within
a 24-hour period.
Online Resources
Support: support.ubnt.com
Community: community.ubnt.com
Downloads: downloads.ubnt.com
JL032814