Overview of the serial console

The serial console is an interface that allows you to restart or reconfigure an appliance when you connect to it using a cable or AirConsole adapter. This is typically used for troubleshooting when other methods do not work.

This is typically used for troubleshooting when:

• Other configuration methods do not work.
• You are configuring an appliance to use a proxy server.

This page describes the hardware requirements for the serial console, as well as how to use the serial console.

Requirements

This section details the hardware and driver requirements to use the serial console for each model.

Hardware requirements

These are the hardware requirements for serial console sessions:

Appliance model	Cable	Driver	Appliance chipset
AWN101 Sensor	Black mini USB serial cable	Prolific driver	PL2303
AWN200 Sensor	Blue RJ45 to USB serial cable with PL2303TA chipset	OS X FTDI driver	Not applicable
AWN201 Sensor	Blue RJ45 to USB serial cable with PL2303TA chipset	OS X FTDI driver	Not applicable
AWN202 Sensor	Blue RJ45 to USB serial cable with PL2303TA chipset	OS X FTDI driver	Not applicable
AWN203 Sensor	DB9 to USB cable	Not applicable	Not applicable
AWN301 Sensor	DB9 to USB cable	Not applicable	Not applicable
AWN1000 Sensor	Blue RJ45 to USB serial cable with PL2303TA chipset	OS X FTDI driver	Not applicable
AWN 200 Series Scanner	Blue RJ45 to USB serial cable with PL2303TA chipset	OS X FTDI driver	Not applicable

Install the required drivers

This section guides you through the installation of required drivers to use the serial console.

AWN101 serial console session driver

To install the required driver for the AWN101 sensor:

1. If you are using a Mac, and this Mac was previously used for another console session, run this command in a terminal to uninstall the previously installed driver:

   sudo rm -rf /System/Library/Extensions/ProlificUsbSerial.kext

2. Download the driver from Prolific, and install it.

   Note: macOS requires approval before installation. You are prompted to enter your password during the installation.

3. Use the cable identified in Hardware requirements to connect the sensor and your computer.

AWN200 and AWN1000 serial console session driver

The Prolific driver included on all Windows machines may not be compatible with the serial console. To install the required driver for either the AWN200 or AWN1000 sensor model:

1. Use the cable identified in Hardware requirements to connect the sensor and your computer.
2. On the Windows machine, start Device Manager as an administrator.
3. Expand the Ports (COM & LPT) list.
4. If the driver name is THIS IS NOT PROLIFIC PL2303. PLEASE CONTACT YOUR SUPPLIER, complete the following steps to install a compatible driver:
   1. Right-click THIS IS NOT PROLIFIC PL2303. PLEASE CONTACT YOUR SUPPLIER and select Uninstall device.
   2. Download and extract the driver files from PL2303-WIN7_8_10_11.zip.
   3. To install the driver, run the PL2303_Prolific_DriverInstaller_v1.8.0.exe executable.
   4. Reboot the machine.
   5. In Device Manager, under Ports (COM & LPT), verify that the name of the driver is Prolific USB-to-Serial Comm Port (COM3).

Console session drivers for all other appliances

To install the required driver on all other appliance models:

1. Use the cable identified in Hardware requirements to connect the appliance to your computer.

2. In a terminal, run the following command to identify the serial device name:

   ls /dev/tty* | grep -i usb

   This may return multiple USB device names for the computer.

3. Run the following command, where <usb_serial_device> is one of the serial USB device names from the previous step:

   sudo screen /dev/<usb_serial_device> 115200

   For example, for Linux, you might enter sudo screen /dev/ttyUSB0 115200.

AirConsole requirements

AirConsole is a portable, battery powered RS232 serial port over WiFi or a Bluetooth adapter. If you cannot use a physical cable, and you own an AirConsole adapter, you can use it instead.

For AirConsole, you need the:

• AirConsole adapter
• IP or hostname address of the AirConsole adapter
• AirConsole driver downloaded and installed

To connect AirConsole:

1. Launch the AirConsoleOSX application on your Mac.
2. Change AirConsole from Auto to Manual.
3. Enter the hostname of the AirConsole. For example, aircon1.
4. Connect to the AirConsole device with this command, where <serial_number> is the serial number of the device:

   sudo screen /dev/cu.Airconsole-1 <serial_number>

Connect to the serial console

To connect your appliance to the serial console, complete the procedure for your operating system:

Windows

1. Use the cable identified in Hardware requirements to connect the appliance to your computer.
2. Launch PuTTY.
3. In the Session category, do the following:
   • Connection type — Select Serial.
   • Serial line — Enter the serial line for the console cable.
   • Speed — Enter 115200.
4. Navigate to Connection > Serial.
5. In the Flow Control list, select None.
6. Press Enter three times to initiate the serial console session.

Mac or Linux

1. Use the cable identified in Hardware requirements to connect the appliance to your computer.

2. In a terminal, run the following command to identify the serial device name:

   ls /dev/tty* | grep -i usb

   This may return multiple USB device names for the computer.

3. Run the following command, where <usb_serial_device> is one of the serial USB device names from the previous step:

   sudo screen /dev/<usb_serial_device> 115200

   For example, for Linux, you might enter sudo screen /dev/ttyUSB0 115200.

4. Press Enter three times to initiate the serial console session.

Navigate the serial console

On-screen instructions display how to navigate the serial console UI. Generally, you can perform the following actions using these keys:

• Move cursor down — Down arrow or Tab
• Move cursor up — Up arrow
• Select highlighted option — Enter
• Select from a list of options — Lowercase letters, such as a or b

Serial console tasks

These are the tasks available while using the serial console with an activated appliance:

• Update the network parameters
• View the current configuration and connectivity status
• Reconfigure the deployment type
• Restart the appliance
• Configure an appliance to use a proxy server

Update the network parameters

To update the network parameters:

1. Navigate to the main task screen.
2. Select Reconfigure on the management interface.
3. Select either DHCP or Static networking as the option that you wish to configure your management interface with.
4. If you selected Static networking, edit the following fields:
   • IP address
   • Netmask/Subnet
   • Primary DNS server
   • Secondary DNS server
   • Gateway
5. Select Next. This runs a series of connectivity tests. If the tests:
   • Pass — You are redirected to the main task screen.
   • Fail — Select Back to return to the previous screen. Change the configuration and retry the connectivity tests.

View the current configuration and connectivity status

To display the current device configuration details:

1. Navigate to the main task screen.
2. Select Show the current configuration. The following information displays:
   • Customer-ID — The customer ID.
   • Deployment-ID — The deployment ID.
   • Deployment-Type — The deployment type. This can be Internal Tap, Mirroring, or Scanner.
   • Network Type — The network type. This can be DHCP or Static networking.
   • Connectivity to Switchboard — The connectivity status of the appliance. This can be PASS or FAIL.
3. Select Next to return to the main task screen.

Reconfigure the deployment type

You can reconfigure the deployment to a different deployment type. To reconfigure the deployment:

1. Navigate to the main task screen.
2. Select Reconfigure the deployment type.
3. Select either Internal Tap, Mirroring, or Scanner.
4. Select Next to return to the main task screen.

Restart the appliance

To restart the appliance, navigate to the post-activation screen and select Reboot the device.

Configure an appliance to use a proxy server

Proxy servers for appliances are configured using the serial console.

Requirements

• Ensure that you have configured your proxy server.
• Ensure that you have the proxy server IP address and port information.
• Make sure you have completed the serial console set up. See Install the required drivers for steps.

Steps

1. Connect to the serial console. See Connect to the serial console for steps to connect to the serial console.

2. Select Next to navigate to the next screen. See Navigate the serial console for more information.

3. The option Use a proxy? Select an option: appears.

4. Select Yes.

5. From the Provide the following proxy information dropdown complete the following:

   • Server IP address — The proxy server IP address for your appliance.
   • Server port — The proxy server port information.

6. Select Next to navigate to the next screen.

   A confirmation message reading Applying configuration appears while the configuration is being applied.

   Caution: This process can take up to several minutes to complete. Do not navigate away from this screen or close the serial console session until the configuration has been applied.

   When the configuration has been applied, the option to verify the network connection appears.

7. Select Yes to run the network connectivity tests.

   Note: Verifying the network connectivity is not required, but strongly recommended by Arctic Wolf.

   Caution: Ensure that a network cable is plugged in prior to verifying the network connection.

8. Select Next.

9. If you selected Yes to run the connectivity tests, a series of connectivity tests are run.

10. If the connectivity tests:

    • Pass — Select Next.
    • Fail — Select Back to return to the previous screen. Change the configuration and retry the connectivity tests.

11. Select Next.

12. If you want to configure more post-activation settings, select the Next button to be brought to the main task menu.