Using the Appliance Management Console (v2)

Introduction

The Appliance Management Console allows administrators to manage and troubleshoot their Field Effect network sensor. From the console, you can configure IP addressing, verify connectivity, review network traffic visibility, view system logs, change appliance credentials, and reboot the appliance when required.

This article covers the following topics: 

• Access the Appliance Management Console
• Appliance Types and Interfaces
• Main Menu Options
• Configure a Static IP Address
• Check Connectivity Status
• Check Network Traffic Status
• View System Logs
• Change the Password
• Toggling the Appliance's Relay Tunnel
• Reboot the Appliance

Access the Appliance Management Console

You can access the Appliance Management Console either locally or remotely.

The credentials will vary depending on your network sensor. See Finding Your Sensor's Service Tags and MAC Addresses to learn more.

From the Same Network

1. Determine the local IP address of your network sensor.
2. Open a web browser.
3. Navigate to: 
   1. https://<sensor-ip-address>/appliance_status/status

Using SSH

1. Determine the local IP address of your network sensor.
2. Connect to the appliance using an SSH client such as PuTTY or WinSCP on port 22.
3. Sign in using the credentials assigned to your appliance.

If you are using a physical sensor, you can also connect directly using a monitor and keyboard.

Appliance Types and Interfaces

The interfaces available in the Appliance Management Console depend on your appliance model. The console can be used to assign a static IP address when DHCP is unavailable or when alternate addressing is required.

Business and Enterprise Appliances

These appliances include:

• Green management port (DHCP)
• Red management port (static addressing)

Oskar Appliances

These appliances include:

• Green management port (DHCP)

Main Menu Options

The following options are available after you have logged into your sensor: 

Configure a Static IP Address

To configure a static IP address:

1. Select 1. Configure Static IP in the main menu.
2. Choose the interface you want to configure (red, green, etc.) 
   1. available interfaces depend on your sensor model.  
3. Enable Edit Mode (callout 2 in the fiure below).
4. Enter the required network settings.
5. Include CIDR notation in the IP address field (for example, /24).
6. Select Apply Settings.
7. Confirm the changes when prompted.

Important: If you connected through SSH using the interface being modified, your session may disconnect and require reconnection.

Remove Static IP Settings

To remove a static IP configuration:

1. Select 1. Configure Static IP in the main menu.
2. Select the configured interface.
3. Disable Edit Mode.
4. Select Apply Settings.

The interface returns to its previous configuration.

Check Connectivity Status

Use Connectivity Status to verify that the appliance can communicate with Field Effect services.

1. Select 2. Check Connectivity Status in the main menu.
2. Review the displayed results.
3. Select Recheck & Rerun to perform a new test.

If connectivity problems continue after rerunning the test, contact Field Effect Support and provide the results shown in the Connectivity Status screen. 

Check Network Traffic Status

Use Network Traffic Status to verify that the appliance is receiving and analyzing useful network traffic.

1. Select 3. Check Network Traffic Status in the main menu.
2. Review the traffic analysis results.

The appliance may report issues when:

• No internal hosts are communicating with public IP addresses.
• Most observed traffic is external-only traffic.
• Traffic is detected from five or fewer internal devices.

These conditions can indicate low visibility or an incorrect network traffic source.

View System Logs

System Logs provide diagnostic information that can help troubleshoot connectivity or deployment issues.

1. Select 3. View System Logs from the main menu.
2. Select a log category using the keyboard controls.
3. Review the information requested by Field Effect Support.

You may be asked to provide log output or screenshots during troubleshooting.

Change the Password

To change the sensor's password:

1. Select 5. Change Password in the main menu.
2. Enter the new password.
3. Re-enter the password to confirm.
4. Select Update Password.

Important: Store the new password securely. Future console access will require the updated credentials.

Toggling the Appliance's Relay Tunnel

This feature exists for troubleshooting purposes, and should only be used with Field Effect's recommendation. Disabling this tunnel without notifying Field Effect will most likely result in an interruption of service.

Reboot the Appliance

You can remotely restart the appliance when troubleshooting or maintenance requires it.

1. Select 7. Reboot Appliance in the main menu.
2. Confirm the reboot when prompted.

Rebooting the appliance temporarily interrupts monitoring while the system restarts.