UniFi - Connect with Debug Tools & SSH

Users have options to connect directly to their UniFi device. The easiest way is to use the built-in Debug console in UniFi Network, and advanced users can also connect with SSH if they prefer.

We do not recommend using SSH unless instructed by one of our Support Engineers as part of advanced troubleshooting. Inexperienced users risk making changes that may degrade network performance, or even worse, completely break your deployment. Proceed with caution.

Simple Mode: Debug Console

The Debug Console is the recommended method for connecting directly to a UniFi console or other device.

Note: This requires an operational UniFi OS, so if your network is down, proceed to the SSH option below. Debug is also is not recommended if pasting long commands in; be sure to check commands that you paste into it before pressing enter.

  1. In UniFi Network, go to Settings > System > Advanced and turn Debug Tools On.
  2. Navigate to the UniFi Devices page and select your device.
  3. In the device panel, open its Settings, scroll to the bottom and select Debug.
  4. The debug panel will open and connect directly to the device.

Advanced Mode: SSH

Requirements

1. You are connected to the same local network as the device/console you plan to connect with via SSH. This may consist of using a laptop connected to the same WiFi network, or hardwired directly to the device.

2. SSH is enabled. UniFi Network devices and UniFi Consoles (Dream Machines, Cloud Keys, etc.) have independent SSH settings.

  • UniFi Consoles: SSH is disabled by default. To enable it, navigate to UniFi OS > Console Settings > SSH.
  • UniFi Network Devices: SSH is enabled by default. The credentials consist of a random string of characters. View and configure them by navigating to UniFi Network > Settings > Advanced > Device Authentication.

3. The device you are using has a command line interface (CLI) capable of establishing a Secure Shell (SSH) connection. Linux and macOS devices can use their native terminal. Windows OS requires PowerShell or PuTTY.

Establishing an SSH Connection

The format of the command used to establish an SSH connection is as follows:

ssh <username>@<ip-address>

The <username> for UniFi Consoles (UDM Pro / UNVR / Cloud Key) and UniFi Gateways (UXG Pro) is always ‘root’. For example, a Dream Machine Pro (which is a UniFi Cloud Gateway) with an IP address of 192.168.1.1 can be accessed as follows:

ssh root@192.168.1.1

Note: The UXG will use <username> = ‘root’, but the <password> will be the shared password set in your UniFi Network Application.

Default Credentials

Prior to setup/adoption, devices have a set of default credentials. 

  • UniFi Consoles -  root / ui (root / ubnt on older devices)
  • UniFi Gateways - root / ui (root / ubnt on older devices)
  • UniFi Devices - ui / ui (ubnt / ubnt on older devices)
Was this article helpful?
1380 out of 3767 found this helpful