Managing appliances via serial console

Overview

The Q4 / Q8 / Q8W / w4 / w8 / e3 / e3w / e6 / e6w / e6wl appliances support management via serial console for troubleshooting purposes. 

Note: Serial console management is generally not necessary and should only be used if advised by a support technician.

 

Finding the Right Cable

Q8, Q8W, w8, e3, and e3w

These appliances support serial console access through micro USB. An USB A to micro USB is included with the appliance. 

usb2musb.png

 

Q4, w4, e6, e6w, and e6wl

These appliances support serial console access through an RJ45 interface. These appliances do include a DB9 to RJ45 console cable, but if you do not have a computer with DB9 (9-pin Serial port) you can purchase separately an USB to RJ45 serial cable.

usb2rj45.jpg

 

 

 

Connecting to Serial Console From Your PC

The only required setting for connecting via serial is the baud rate. All of our appliances use 115200. For specific connection details for your operating system see below:

  • Windows

    1. On Microsoft Windows 10 and 11, the USB to Serial driver is usually built-in.
      With the cable connected to your Windows computer and the appliance, check your Device Manager.

    2. Locate the "Ports (COM & LPT)" section for a Prolific-USB-to-Serial Comm Port. 

    3. Confirm the COM port associated to the device.

    4. Install the Putty utility.

    5. Open Putty and create a new connection of type "Serial"

    6. Enter the COM port (e.g. COM3) and the speed "115200"

    7. Click Open

      PuTTY_BasicSettings.png


  • macOS

    1. Recent versions of macOS include the necessary USB drivers and utilities for managing your appliance via serial console. To confirm:
      • Open the Terminal app and list your /dev directory "ls /dev". If your cable is connected to both your Mac and the appliance, you should see a device starting with "tty.usbserial". If you do not see a similar named device try a different cable.
      • Once you confirm the device name, use the built-in "screen" utility with the following command:

        screen /dev/tty.usbserial-210 115200

        Note: In the connection string above, the USB serial device name is tty.usbserial-210. This name may be slightly different depending on your system and cable. 

        serial-macos-connect.png

    2. Once you connect to the device, press the return key to access the login prompt.

    3. Note: The login is "root" and the password is the same as the web administration admin account.

      serial-login.png

    4. After successful login, you can proceed to the troubleshooting menu.

      serial-menu.png

Menu Option Function
Remap Interfaces Reorder the hardware interfaces.
Configure Interface Basic configuration settings for interfaces.
Ping Initiate a ping test to a target of your choice.
Remote Support Toggles remote support access for this appliance.
Upgrade Check for and initiate any available software upgrade.
Reboot Restart the hardware appliance.
Shutdown Shut down the hardware appliance.
Reset To Factory Defaults Restore the software to defaults, undoing any configurational changes that have been made.
Exit to Shell Exit this console and return to the command line.

 

 

Accessing the console menu from the command line (NG Firewall)

This menu can be accessed by running the following command from the command line or SSH terminal.

/usr/share/untangle/bin/ut-textui.py

 

 

Follow
Was this article helpful?
1 out of 2 found this helpful
Have more questions? Submit a request

Comments

0 comments

Please sign in to leave a comment.

Powered by Zendesk