ExtraHop Admin UI Guide

Version 5.0

Post-Deployment Actions

After you deploy the ExtraHop appliance, take the following actions. Refer to the section of the ExtraHop Admin UI Guide specified in each action below, except where noted.

  1. Password: Maintain system security after the evaluation period.

    Change the default password. For more information, see the Change Password section.

  2. NTP: Time is critical in the ExtraHop appliance, particularly when doing event correlation with time-based metrics and logs.

    Verify that the NTP settings are correct for your infrastructure, test settings, and sync NTP. For more information, see the System TimeIo section.

  3. Time Zone: The correct time zone is critical to run scheduled reports at the correct time.

    Ensure the ExtraHop appliance has the correct time zone. For more information, see the System Time section.

  4. Remote Authentication: Credential sprawl is a headache. The Discover appliance integrates with RADIUS, TACACS, and LDAP for remote integration.

    Set up remote authentication. For more information, see the Remote Authentication section.

  5. Firmware Update: ExtraHop firmware is updated often with enhancements and resolved defects.

    Verify that you have the current firmware. For more information, see the Firmware section.

  6. Audit Logging: The ExtraHop appliance can send events to a remote syslog collector.

    Configure the ExtraHop system to send audit logs. For more information, see the Audit Log section.

  7. SMTP Settings: The ExtraHop system can email alerts and system-health notifications.

    Set up and test notifications. For more information, see the Email Server and Sender section.

  8. System Notifications: The ExtraHop appliance can send email when it detects problems.

    Create an email group to receive notifications. For more information, see the Notifications section.

  9. iDRAC: Each physical ExtraHop appliance has an iDRAC port, similar to iLO or KVM over Ethernet.

    Connect and configure the iDRAC port. For more information, see Configuring the iDRAC Remote Access Console

  10. SSL Certificate: Each ExtraHop appliance ships with a self-signed certificate. If you have a PKI deployment, generate your own certificate and upload it to each ExtraHop appliance.

    Generate and deploy an SSL certificate for each ExtraHop appliance. For more information, see the SSL Certificate section.

  11. DNS ‘A’ Record: It is easier to access an ExtraHop appliance by hostname than by IP address.

    Create an ‘A’ record in your DNS root ("extrahop.yourdomain.local") for each ExtraHop appliance in your deployment. Refer to your DNS administration manual.

  12. Customizations: The datastore is easier to restore when you periodically save customizations.

    Save the current datastore configuration settings. For more information, see the Customizations section.

About This Guide

The Admin UI Guide provides detailed information about the administrator features and functionality of the ExtraHop Discover and Command appliances.

This guide provides an overview of the system navigation and information about the controls, fields, and options available throughout the UI.

For additional documentation, visit docs.extrahop.com.

We value your feedback. Please let us know how we can improve this document. Send your comments or suggestions to documentation@extrahop.com.

This section describes the general layout of the ExtraHop Admin UI. It focuses on navigating to the top level sections in the user interface, changing the password, logging on and off, and other page-level toolbar controls.

The ExtraHop Admin UI is a web application that uses the features of an Internet browser to create the graphical user interface. When the ExtraHop Admin UI opens in the browser window, the main frame contains a fixed toolbar at the top of the UI page to display application-level controls and links that are relevant to all interface pages.

The application-level toolbar contains the following controls or links:

  • Change default password: Opens the Change Password page to specify a new Admin UI password. For more information about changing the default password, see the Change Password section.
  • Launch Shell: Opens the ExtraHop web shell for entering admin commands to configure the ExtraHop appliance. For more information about using the ExtraHop web shell, see the Shell Commands section.
  • Log out: Ends the ExtraHop Admin UI session. For more information about logging out, see the Login/Logout section.
  • Help: Opens the ExtraHop Admin UI Guide.

The main administration page includes the following sections for configuring the ExtraHop appliance:

  • Status: Verify how the ExtraHop appliance is functioning on the network.
  • Network Settings: Configure the network settings for the ExtraHop appliance.
  • Packet Captures: View and download packet captures.
  • Cluster Settings: Add nodes to a Command appliance. Not available on a node.
  • Cluster Memberships: Join a Command appliance cluster. Not available on a Command appliance.
  • Access Settings: Configure access settings to the ExtraHop appliance.
  • System Configuration: Change the configuration settings of the ExtraHop appliance.
  • ExtraHop Explore Settings: Change the configuration settings of the Explore appliance.
  • System Settings: Configure the system-level settings for the ExtraHop appliance.
  • Diagnostics: Troubleshoot ExtraHop appliance issues.

The Admin UI page uses a Navigation bar to show you where you are in the UI in relation to the Admin main page.

Login/Logout

The ExtraHop Web UI is a secure site that prompts you for a user name and a password to access the interface. You can also view your current firmware version at the bottom of the Login window.

Log in to the ExtraHop Admin UI

To log in to the ExtraHop Admin UI:

  1. In your browser, navigate to the ExtraHop web administration utility at https://[IP address]/admin, where [IP address] is the IP address displayed on the LCD on the front panel of the ExtraHop appliance.
  2. On the Login page, enter the following information:
    • Username: Enter your ExtraHop Admin UI user name.
    • Password: Enter your ExtraHop Admin UI password.
  3. Click Log In.

The default user name is setup and the password is the service tag number of the appliance.

Change the Admin UI Password

You can modify the default admin credentials by clicking the Change Password link under the Log In button. If the default setup password is not changed, the Change Default Password button appears in the top-level toolbar of the Admin UI. Clicking this button opens the Change Password page to specify a new Admin UI password. For more information, refer to Change Password.

Note: You can also access the ExtraHop Admin UI from the Settings pop-up window of the ExtraHop Web UI. Click the Administration UI icon, and the ExtraHop Web UI redirects your browser to the Admin UI Login page.

Log Out of the Admin UI

To log out of the Admin UI, click Log out on the top-level toolbar.

Browser Compatibility

The following browsers are compatible with all ExtraHop appliances.

  • Chrome 45
  • Firefox 41
  • Internet Explorer 10 and 11
  • Safari 9

Status

ExtraHop system administrators use the metrics collected on the status pages to verify the overall health of the ExtraHop appliance.

The Status section includes the following status pages. These pages contain read-only collections of metrics and logging data that provide information about the current state of the ExtraHop appliance:

  • Health: Provides metrics to view the operating efficiency of the ExtraHop appliance.
  • Audit Log: Allows you to view event logging data and change Syslog settings.

Health

The Health page provides a collection of metrics to quickly check the operation of the ExtraHop appliance. If issues occur with the ExtraHop appliance, the metrics on the Health page help to troubleshoot the problem and determine why the ExtraHop appliance is not performing as expected.

To view the data on the Health page, click Status > Health.

The ExtraHop appliance system collects metrics on the following operational activities performed by the ExtraHop appliance and reports the status on the Health page.

  • System: Reports the following information about the system CPU usage and hard disk.
    • CPU User: The percentage of CPU usage associated with the ExtraHop appliance user.
    • CPU System: The percentage of CPU usage associated with the ExtraHop appliance.
    • CPU Idle: The CPU Idle percentage associated with the ExtraHop appliance.
    • CPU IO: The percentage of CPU usage associated with the ExtraHop appliance IO functions.
  • Bridge Status: Reports the following information about the ExtraHop appliance bridge component.
    • VM RSS: The bridge process physical memory in use.
    • VM Data: The bridge process heap virtual memory in use.
    • VM Size: The bridge process total virtual memory in use.
    • Start Time: Specifies the start time for the ExtraHop appliance bridge component.
  • Capture Status: Reports the following information about the ExtraHop appliance network capture status.
    • VM RSS: The network capture process physical memory in use.
    • VM Data: The network capture process heap virtual memory in use.
    • VM Size: The network capture process total virtual memory in use.
    • Start Time: The start time for the ExtraHop network capture.
  • Service Status: Reports the status of ExtraHop appliance services.
    • exalerts: The amount of time the ExtraHop appliance alert service has been running.
    • extrend: The amount of time the ExtraHop appliance trend service has been running.
    • exconfig: The amount of time the ExtraHop appliance config service has been running.
    • exportal: The amount of time the ExtraHop appliance web portal service has been running.
    • exshell: The amount of time the ExtraHop appliance shell service has been running.
  • Interface: Reports the status of ExtraHop appliance system interfaces.
    • RX packets: The number of packets received by the ExtraHop appliance on the specified interface.
    • RX Errors: The number of received packet errors on the specified interface.
    • RX Drops: The number of received packets dropped on the specified interface.
    • TX Packets: The number of packets transmitted by the ExtraHop appliance on the specified interface.
    • TX Errors: The number of transmitted packet errors on the specified interface.
    • TX Drops: The number of transmitted packets dropped on the specified interface.
    • RX Bytes: The number of bytes received by the ExtraHop appliance on the specified interface.
    • TX Bytes: The number of bytes transmitted by the ExtraHop appliance on the specified interface.
  • NVRAM: Reports the non-volatile random-access memory (NVRAM) status and usage of ExtraHop appliance components. It identifies and provides status for specified components that have configuration settings that remain in memory when the power to the appliance is turned off.
    • Name: The ExtraHop settings that are held in NVRAM.
    • Options: The read-write options for the settings held in NVRAM.
    • Size: The size in gigabytes for the identified component.
    • Utilization: The amount of memory utilization for each of the identified components as a quantity and as percentage of total available NVRAM.

Audit Log

The ExtraHop appliance audit log provides data about the operations of the system, broken down by component. The log lists all known events by timestamp, in reverse chronological order. You can configure where to send these logs in the syslog settings.

The ExtraHop appliance collects the following log data and reports the results on the audit log Activity page.

  • Time: The time at which the event occurred.
  • User: The ExtraHop appliance user who initiated the logged event.
  • Operation: The ExtraHop appliance operation that generated the logged event.
  • Details: The outcome of the event. Common results are Success, Modified, Execute, or Failure. Each log entry also identifies the originating IP address, if that address is known.
  • Component: The ExtraHop appliance component that is associated with the logged event.

View the Audit Log data

To view the data on the audit log activity:

  1. Click Status > Audit Log.
  2. Click View.
  3. To page through the log to view older entries, click Next.
  4. To page back to the beginning, click Previous.
  5. To jump to the last page of log entries, click Last.

Change the Syslog Settings

You can change the syslog settings to send your audit log information to a remote syslog server for longer-term storage, monitoring, and advanced analysis.

To change the Syslog settings:

  1. Click Status > Audit Log.
  2. Click Syslog Settings.
  3. On the Audit Log Syslog Settings page, enter the following:
    • Destination: Enter the name of the remote syslog server.
    • Protocol: Select TCP or UDP from the drop-down.
    • Port: Enter the port number. The default port is 514.
  4. Click Test Settings to test your new settings.
  5. Click Save.

Network Settings

The Network Settings section includes the following configurable network connectivity settings:

  • Connect to Atlas Services: Subscribe to monthly reports about system components (node only).
  • Connectivity: Configure network connections including proxy servers, interfaces, and bond interfaces.
  • Notifications: Set up alert notifications via email and SNMP traps.
  • SSL Certificate: Generate and upload a self-signed certificate.

The ExtraHop appliance has four 10/100/1000baseT network ports. The Gb1 port is used for management and requires an IP setting. The Gb2 port is used for monitoring network traffic and connects to the network tap or mirror port on your network switch. You also can use Gb3 and Gb4 for monitoring, if permitted by your license. Some appliances have two 10GbE SFP+ ports with the accompanying SFP+ SR-fiber modules. For more information, refer to your appliance specifications.

Before you begin configuring the network settings of the ExtraHop appliance, verify that a network patch cable connects the Gb1 port on the ExtraHop appliance to the management network. For more information about installing a ExtraHop appliance, refer to your appliance installation guide or contact ExtraHop Support for assistance.

For specifications, installation guides, and more information about your ExtraHop appliance, visit docs.extrahop.com.

Atlas Services

Atlas Services provide ExtraHop customers with a remote analysis report delivered monthly that contains specific recommendations for critical components across the application delivery chain.

Connect to Atlas Services

To connect to Atlas Services and receive monthly reports:

  1. Click Connect to Atlas Services.
  2. In the Connect to Atlas Services pop-up window, click Terms and Conditions.
  3. After you have read the terms and conditions, check the checkbox and click Yes.
Note: You can connect Command appliance nodes to Atlas Services, but you cannot connect the Command appliance.

Disconnect from Atlas Services

To disconnect from Atlas Services and stop receiving monthly reports:

  1. Click Disconnect from Atlas Services.
  2. In the confirmation pop-up window, click OK.

Test Atlas Services Connectivity

To ensure you have connectivity to the Atlas servers without starting to receive reports:

  1. Click Connect to Atlas Services.
  2. In the Connect to Atlas Services pop-up window, click Test Connectivity.
  3. A success or failure message will be displayed in the lower left corner of the box.
  4. Click Cancel.

Connectivity

To connect the ExtraHop appliance to the host network and use the optional software tap, the following network configuration information is required:

Network Settings

  • Host Name: The name of the appliance on the network.
  • Primary DNS: The IP address of the primary domain name server for the specified domain.
  • Secondary DNS: (Optional) The IP address of the secondary domain name server for the specified domain.

Proxy Settings

  • Global Proxy: Provides the ability to enable proxy support for connection to the Command appliance.
  • Atlas Proxy: Provides the ability to enable proxy support for connection to the Atlas Remote UI.

Bond Interface Settings

  • Create Bond Interface: Provides the ability to bond multiple interfaces together into a single logical interface that will use a single IP address for the combined bandwidth of the bond members. Only 1GbE ports are supported for bond interfaces. This is also known as link aggregation, port trunking, link bundling, Ethernet/network/NIC bonding, or NIC teaming. Bond interfaces only support manual, static bonding. Link Aggregation Control Protocol (LACP) is currently not supported.

     

    Note: Creating bond interfaces will cause you to lose connectivity to your ExtraHop appliance. You must make changes to your network switch configuration to restore that connectivity. The changes required depend on which switch you are using. Contact ExtraHop Support for assistance before you create a bond interface.

Interfaces

  • Interface Mode: Whether the port is enabled or disabled and if enabled, the port assignment.
  • DHCP: Whether DHCP is enabled or disabled.
  • IP address: The static IP address of the ExtraHop appliance on the network.
  • Netmask: The netmask used to divide the IP address into subnets.
  • Gateway: The IP address for the gateway node on the network.
  • MAC Address: The MAC address of the ExtraHop appliance.

In the Interface Status section, a diagram of the back of the ExtraHop physical appliance displays the following information about the current interface connections:

  • Blue Ethernet Port: Identifies the management port.
  • Black Ethernet Port: Indicates that the port is licensed and enabled but down.
  • Green Ethernet Port: Indicates that the licensed port has an active Ethernet cable connected.
  • Gray Ethernet Port: Identifies a disabled or unlicensed port.
Note: The Interface Status section is displayed for physical appliances only.

The EH5000, EH6000, EH6100, EH8000, and EH8100 have two 10GbE interfaces and three 1GbE interfaces. The 1GbE interfaces are disabled by default, and the ExtraHop appliance operates in the standard throughput mode. Enabling one or more of the 1GbE interfaces puts the ExtraHop appliance into the reduced throughput mode. Before changing the interface settings, refer to the following table to determine which throughput mode you want to use.

ExtraHop
Appliance
Throughput
Mode
Definition
EH9100 Standard 40Gbps throughput mode If the non-management 1GbE interfaces are disabled, you can use up to four of the 10GbE interfaces for a combined throughput of up to 40Gbps.
EH9100 Reduced 23Gbps throughput mode for use of 1GbE ports If the non-management 1GbE interfaces are enabled, the maximum total combined throughput is 23Gbps.
EH8000/8100 Standard 20Gbps throughput mode If the non-management 1GbE interfaces are disabled, you can use either one or both of the 10GbE interfaces for a combined throughput of up to 20Gbps.
EH8000/8100 Reduced 13Gbps throughput mode for use of 1GbE ports If the non-management 1GbE interfaces are enabled, the maximum total combined throughput is 13Gbps.
EH5000/6000/6100 Standard 10Gbps throughput mode If the non-management 1GbE interfaces are disabled, the maximum total combined throughput is 10Gbps.
EH5000/6000/6100 Reduced 8Gbps throughput mode If the non-management 1GbE interfaces are enabled, the maximum total combined throughput is 8Gbps.
EH5000/6000/6100 Reduced 3Gbps throughput mode with 10GbE ports disabled If the 10GbE interfaces are disabled, the maximum total combined throughput is 3Gbps.

Change the Network Settings

To change the network settings:

  1. Click Network Settings > Connectivity.
  2. In the Network Settings section, click Change.
  3. On the Edit Hostname page, modify the following fields as desired:
    • Hostname: The descriptive device name for the ExtraHop appliance on the network. Devices on the network can be identified by their IP address, MAC address, or by the descriptive name specified in this setting.
    • Primary DNS: The computer that stores the record of the network’s domain name, which is used to translate domain names specified in alpha-numeric characters into IP addresses. Each domain requires a primary domain name server and at least one secondary domain name server.
    • Secondary DNS: The backup server to the primary DNS.
  4. Click Save.

Change Interface Settings

Interface settings enable and disable interfaces, change the mode of the interface, and manage the interface's network settings and routes.

Change Interface Settings
  1. Click Network Settings > Connectivity.
  2. In the Interfaces section, click the name of the interface you want to edit.
  3. On the Network Settings for Interface <interface number> page, select one of the following options from the Interface Mode drop-down:
    • Disabled: The interface is disabled.
    • Monitoring Port (receive only): Monitors network traffic.
    • Management Port: Manages the ExtraHop appliance.
    • Management Port + RPCAP/ERSPAN Target: Manages the ExtraHop appliance and captures traffic forwarded from a software tap or ERSPAN.
    • High Performance ERSPAN Target: Captures traffic forwarded from ERSPAN. This interface mode enables the port to handle more than 1 Gbps. Set this interface mode if the ExtraHop appliance has a 10 GbE port.
    • Note: Interfaces 3 and 4 are disabled by default on the following appliances: EH2000, EH2000v, EH3000, EH5000, EH6000, EH6100, EH8000, EH8100, and EH9100. Interfaces 5 and 6 are disabled by default on the following appliances: EH5000, EH6000, EH6100, EH8000, EH8100, and EH9100.

  4. DHCP: DHCP is enabled by default. After the DHCP server assigns an IP address to the physical ExtraHop appliance, the IP address is displayed on the LCD front panel of the appliance.

    • If your network does not support DHCP, you can disable DHCP and configure a static IP address for the ExtraHop appliance.
    • To disable DHCP, uncheck the DHCP checkbox and click Save. When the browser changes to the new network address, log on to the Admin UI again.
    • If you are changing from a static IP address to a dynamic IP address, the changes occur immediately after you click Save, which results in a loss of connection to the Admin UI web page. After the system acquires an IP address, you must log on to the Admin UI again.
  5. IP Address: The IP address for the ExtraHop appliance. This setting can be acquired through DHCP or by setting a static IP address.

    To configure a static IP Address, disable DHCP, type a static IP address, and then click Save.

  6. Netmask: The netmask for the local network.
  7. Gateway: The gateway IP address.
  8. MAC Address: A unique identifier assigned to network devices by the device manufacturer. The MAC address of the ExtraHop appliance is printed on the label that is affixed to the bottom of the appliance.
  9. Click Save.
Note: If a node is a member of a Command cluster, you must remove the node from the cluster before you can configure Interface 1 settings.
Note: If you are using Amazon Web Services (AWS) with one interface, you must select Management + RPCAP/ERSPAN for Interface 1. If you are using two interfaces, you must select Management + RPCAP/ERSPAN for Interface 1 and Management + RPCAP/ERSPAN for Interface 2.
Set a Manual Route

If you do not have DHCP enabled, you can manually set a route to determine the traffic goes.

  1. Click Network Settings > Connectivity.
  2. In the Interfaces section, click the interface you want to set a manual route for.
  3. On the Network Settings for Interface <interface number> page, ensure that the IP Address and Netmask fields are complete and saved, and then click Edit Routes.
  4. In the Add Route section, complete the Network and Via IP fields, and then click Add.
  5. Repeat the previous step for each route you want to add.
  6. Click Save.
Change RPCAP Settings
  1. Click RPCAP Settings.

    On the Add RPCAP Port Definition page, edit the following settings as needed:

    • Port: Specifies the listening port on the ExtraHop appliance. Each port must be unique for each interface subnet on the same server. You can configure different subnets across servers with the same port, which can be a TCP and UDP port. If you are configuring multiple software taps and multiple software tap listeners, the payload might traverse a range of UDP ports. The range consists of 16 ports, starting with the specified port.

    • Interface Address: Specifies the subnet on the software tap server. If the server has multiple interfaces that match the interface address, the first interface on the server sends traffic to the ExtraHop appliance unless the interface name is specified.

    • Interface Name: Specifies the the interface on the packet-forwarding server from which to forward packets.

    • Filter: Specifies the traffic to forward with Berkeley Packet Filter syntax. For example, tcp port 80 forwards only TCP traffic on port 80, and not tcp port 80 forwards only non-TCP traffic on port 80.

      Note: You must specify an interface address or an interface name. If you specify both, then both settings will apply.
  2. Click Save.

 

Change the Global Proxy Settings

If your network topology requires a proxy server to enable your ExtraHop appliance to communicate either with a Command appliance or with other devices outside of the local network, you can enable your ExtraHop appliance to connect to a proxy server you already have on your network. Internet connectivity is not required for the global proxy server.

Only one global proxy server can be configured per ExtraHop appliance.

To enable the Global Proxy settings
  1. Click Network SettingsConnectivity.
  2. Click Enable Global Proxy.
  3. On the Global Proxy Settings page, type the following information:
    • Hostname: Type the hostname or IP address for your global proxy server.
    • Port: Type the port number for your global proxy server.
    • Username: Type the name of a user that has for access to your global proxy server.
    • Password: Type the password for the user specified above.
  4. Click Save.
To change Global Proxy settings:
  1. Click Network SettingsConnectivity.
  2. Click on the name of your global proxy.
  3. On the Global Proxy Settings page, modify the following information as needed:
    • Hostname: Type the hostname for your global proxy server.
    • Port: Type the port number used by your global proxy server.
    • Username: Type the name of a user that has access to your global proxy server.
    • Password: Type the password for the user specified above.
  4. Click Save.
To disable the Global Proxy setting:
  1. Click Network SettingsConnectivity.
  2. Click Disable Global Proxy.

Change the Atlas Proxy Settings

If your ExtraHop appliance does not have a direct Internet connection, you can connect to the Internet through a use a proxy server specifically designated for Atlas connectivity.

Note: If no Atlas proxy server is enabled, the ExtraHop appliance will attempt to connect through the global proxy. If no global proxy is enabled, the ExtraHop appliance will use a direct HTTP proxy to enable Atlas services.

Only one Atlas proxy can be configured per ExtraHop appliance.

To enable the Atlas Proxy settings:
  1. Click Network SettingsConnectivity.
  2. Click Enable Atlas Proxy.
  3. On the Atlas Proxy Settings page, type the following information:
    • Hostname: Type the hostname or IP address for your Atlas proxy server.
    • Port: Type the port number for your Atlas proxy server.
    • Username: Type the name of a user that has access to your Atlas proxy server.
    • Password: Type the password for the user specified above.
  4. Click Save.
To change the Atlas Proxy settings:
  1. Click Network SettingsConnectivity.
  2. Click the name of your Atlas proxy.
  3. On the Atlas Proxy Settings page, modify the following information as needed:
    • Hostname: Type the hostname or IP address for your Atlas proxy server.
    • Port: Type the port number used by your Atlas proxy server.
    • Username: Type name of a user that has access to your Atlas proxy server.
    • Password: Type the password for the user specified.
  4. Click Save.
To disable the Atlas Proxy:
  1. Click Network SettingsConnectivity.
  2. Click Disable Atlas Proxy.

Change the Bond Interface Settings

You can bond multiple 1GbE interfaces on your ExtraHop appliance together into a single logical interface that has one IP address for the combined bandwidth of the member interfaces. Bonding interfaces enables a larger throughput with a single IP address. This configuration is also known as link aggregation, port channeling, link bundling, Ethernet/network/NIC bonding, or NIC teaming. Only 1GbE interfaces are supported for bond interfaces.

Note: When you modify bond interface settings, you lose connectivity to your ExtraHop appliance. You must make changes to your network switch configuration to restore connectivity. The changes required are dependent on your switch. Contact ExtraHop Support for assistance before you create a bond interface.

Interfaces chosen as members of a bond interface are no longer independently usable and are shown as Disabled (bond member) in the Interfaces section of the Connectivity page. After a bond interface is created, you cannot add more members or delete existing members. The bond interface must be destroyed and recreated.

Note: Bond interfaces only support manual, static bonding. Link Aggregation Control Protocol (LACP) is currently not supported.

Bond interfaces cannot be set to Monitoring mode.

Create a Bond Interface

You can create a bond interface with at least one interface member and up to the number of members that are equivalent to the number of 1GbE interfaces on your ExtraHop appliance. 

  1. Click Network Settings > Connectivity.
  2. Click Create Bond Interface.
  3. On the Create Bond Interface page, select the following:
    • Members: Check the checkbox next to each interface you want to include in the bonding. Only 1GbE ports currently available for bond membership are displayed.
    • Take Settings From: Select the interface that has the settings you want to apply to the bond interface. Settings for all non-selected interfaces will be lost.
  4. Click Create.
  5. Refresh the page to display the Bond Interfaces section. Any bond interface member whose settings were not selected in the Take Settings From drop-down are shown as Disabled (bond member) in the Interfaces section.
Modify Bond Interface Settings

After a bond interface is created, you can modify most settings as if the bond interface is a single interface.

  1. Click Network Settings > Connectivity.
  2. In the Bond Interfaces section, click the bond interface you want to modify.
  3. On the Network Settings for Bond Interface <interface number> page, modify the following settings as needed:
    • Members: The interface members of the bond interface. Members cannot be changed after a bond interface is created. If you need to change the members, you must destroy and recreate the bond interface.
    • Interface Mode: The mode of the bond membership. A bond membership can be Management or Mangement+RPCAP/ERSPAN Target only.
    • DHCP: If DHCP is enabled, an IP address for the bond interface will be automatically obtained.
    • IP Address: The static IP address of the bond interface. This setting is unavailable if DHCP is enabled.
    • Netmask: The network netmask for the bond interface.
    • Gateway: The IP address of the network gateway.
    • Routes: The static routes for the bond interface. This setting is unavailable if DHCP is enabled.
  4. Click Save.
Destroy a Bond Interface

When a bond interface is destroyed, the separate interface members of the bond interface return to independent interface functionality. One member interface is selected to retain the interface settings for the bond interface and all other member interfaces are disabled. If no member interface is selected to retain the settings, the settings are lost and all member interfaces are disabled.

  1. Click Network Settings > Connectivity.
  2. In the Bond Interfaces section, click the red x next to the interface you want to destroy.
  3. On the Destroy Bond Interface <interface number> page, select the member interface to move the bond interface settings to. Only the member interface selected to retain the bond interface settings remains active, and all other member interfaces are disabled.
  4. Click Destroy.
  5. Refresh the page.

Notifications

Alerts are useful only if someone is notified about the alert when it is triggered. The ExtraHop appliance uses two types of alert notifications: email and SNMP traps. If SNMP is specified, then every alert will be sent as an SNMP trap to the specified SNMP server. If an email notification group is specified, then emails will be sent to the groups assigned to the alert.

The Network Settings > Notifications section of the Admin UI includes the following configurable settings:

  • Email Server and Sender: Configure the email server and sender settings.
  • Email Notification Groups: Set up email notification groups.
  • SNMP: Set up SNMP network monitoring. If you are using a Command appliance, this is configured at each node. Alerts fire on a node, which then sends notifications. After an alert fires, the event is visible on the Command appliance Web UI.
  • Syslog: Send ExtraHop data to another system for archiving and correlation.

Email Server and Sender

Alert notifications can be sent via email to members of an email group assigned to that alert whenever it fires.

Configure Email Settings

To enable email alerts, you must configure an email server and sender for the ExtraHop appliance to use to send the email alerts.

To configure the Email Server and Sender settings:

  1. Click Network Settings > Notifications.
  2. Click Email Server and Sender.
  3. On the Email Settings page, enter the following information:
    • SMTP Server: The IP address for the outgoing SMTP mail server.

      Note: The SMTP server should be the FQDN or IP address of an outgoing mail server that is accessible from the ExtraHop management network. If the DNS server is set, then the SMTP server can be a FQDN, otherwise it needs to be an IP address

    • Sender Address: The email address for the notification sender.
    • Report Sender Address: The email address for the report sender.
  4. Click Save.
Test Email Settings

To test the that the ExtraHop appliance can communicate with the SMTP server:

  1. Select Launch Shell in the upper right corner of the Admin UI.
  2. In the webshell, verify that the SMTP server is resolved and accessible by pinging the name. If DNS is not configured, then ping the IP address only.
  3. When the SMTP server configuration is confirmed, log in to the ExtraHop appliance and configure an alert.
Troubleshoot Email Settings

Refer to the following sample code to help troubleshoot communication issues.

  • Successful pings by hostname: This proves the DNS server is accessible and has the resolution information for the host.

  • Unsuccessful DNS lookup: This shows that either the DNS server is not accessible, or that the hostname is incorrect. To verify that the DNS server is accessible, ping the DNS server IP address.

  • Successful ping by IP address: This shows that the network is reachable by the ExtraHop system.

  • Unsuccessful ping by IP address: This shows that the network is unreachable by the ExtraHop system.

Email Notification Groups

Email notification groups are assigned to alerts to designate who should receive an email when that alert fires. Although you can specify individual email addresses to receive emails for alerts, email groups are the most effective way to manage your alert recipient list.

Add a New Email Notification Group

To add a new Email Notification Group:

  1. Click Network Settings > Notifications.
  2. Click Email Notification Groups.
  3. Click Add Group.
  4. In the Group Info section, enter the following information:
    • Name: The name of the email group.
    • System Health Notifications: Check this checkbox if you want to send system storage alerts to the email group. These alerts will fire under the following conditions:
      • The virtual disk is in a degraded state.
      • The physical disk is in a degraded state.
      • The physical disk has an increasing error count.
      • A necessary role is missing, such a firmware, datastore, or packet capture.
  5. In the Email Addresses text box, enter the recipient email addresses for the team members that you want to receive the alert emails for this group.

    Email addresses can be entered one per line or separated by a comma, semicolon, or space. Email addresses are checked only for [name]@[company].[domain] format validation. There must be at least one email address in this text box for the group to be valid.

  6. Click Save.
Modify Settings for an Existing Email Notification Group

To modify existing Email Notification Group settings:

  1. Click Network Settings > Notifications.
  2. Click Email Notification Groups.
  3. Click the name of the group that you want to update.
  4. In the Group Info section, modify the following information as desired:
    • Name: The name of the email group.
    • System Health Notifications: Select this checkbox if you want to send system storage alerts to the email group.
  5. In the Email Addresses text box, enter the recipient email addresses for the individuals that you want to receive the alert emails for this group.

    Email addresses can be entered one per line or separated by a comma, semicolon, or space.

  6. Click Save.
Delete an Existing Email Notification Group

If you want to delete an existing email notification group, it is a best practice to first unassign it from any alerts it is assigned to.

To delete an Email Notification Group:

  1. Click Network Settings > Notifications.
  2. Click Email Notification Groups.
  3. On the Email Groups page, click the red x to the left of the group name.
  4. Click OK to confirm the deletion.
    Note: When you delete an email group, the group and all of its associated email addresses are deleted.

SNMP

Simple Network Management Protocol (SNMP) is used to monitor the state of the network. SNMP collects information both by polling devices on the network and when SNMP-enabled devices send alerts to SNMP management stations. SNMP communities specify the group that devices and management stations running SNMP belong to, which specifies where information is sent. The community name identifies the group.

Note: Most organizations have an established system for collecting and displaying SNMP traps in a central location that can be monitored by their operations teams. For example, SNMP traps are sent to an SNMP manager, and the SNMP management console displays them.

Configure SNMP Settings

To configure the SNMP settings:

  1. Click Network Settings > Notifications.
  2. Click SNMP.
  3. On the SNMP Settings page, enter the following information:
    • SNMP Monitor: The hostname for the SNMP trap receiver. Multiple names can be entered, separated by commas.
    • SNMP Community: The SNMP community name.
    • SNMP Port:The SNMP port number for your network that is used by the SNMP agent to respond back to the source port on the SNMP manager. By default, this set to 162.
  4. Click Test Settings to test your SNMP settings.
  5. Click Save.
Download the ExtraHop SNMP MIB

SNMP does not provide a database of information that an SNMP monitored network reports. SNMP uses information specified by third-party management information bases (MIBs) that describe the structure of the collected data.

To download the ExtraHop SNMP MIB:

  1. Click Network SettingsNotifications.
  2. Click SNMP.
  3. Under SNMP MIB, click Download ExtraHop SNMP MIB.
  4. At the prompt, specify a location to save the downloaded file.
  5. Click Save.

Syslog

The syslog export enables you to send alerts from the ExtraHop appliance to any remote system that receives syslog input (e.g., Splunk, ArcSight, Q1 Labs, etc.) for long-term archiving and correlation with other sources.

Configure the Syslog notification settings

To send syslog messages to your remote server, you must first configure the syslog notification settings. Only one remote syslog server can be configured for each ExtraHop appliance.

To configure the Syslog notification settings for alerts:

  1. Click Network Settings > Notifications.
  2. Click Syslog.
  3. On the Syslog Notification Settings page, enter the following information:
    • Destination: The IP address of the remote syslog server.
    • Protocol: From the drop-down, select which protocol to use to send information to your remote syslog server.
    • Port: The port number for your remote syslog server. By default, this is set to 514.
  4. Click Test Settings to test your syslog settings.
  5. Click Save.

SSL Certificate

SSL is used to provide secure authentication to the Web UI and Admin UI of the ExtraHop appliance. To use SSL, a SSL certificate must be be uploaded to the ExtraHop appliance.

A self-signed certificate can be used in place of a certificate signed by a certificate authority. However, be aware that a self-signed certificate generates an error in the client browser and the browser reports that the signing certificate authority is unknown. The browser provides a set of confirmation pages to allow the use of the certificate, even though the certificate is self-signed.

Generate a Self-Signed Certificate

If you plan to use a self-signed certificate for your ExtraHop appliance, you must first generate the certificate.

To configure the self-signed SSL Certificate settings:

  1. Click Network Settings > SSL Certificate.
  2. Click Manage certificates to expand the section.
  3. Click Build SSL self-signed certificate based on hostname.
  4. On the Generate Certificate page, click OK to regenerate the SSL self-signed certificate based on the hostname.
    Note: The default hostname is extrahop.

The ExtraHop appliance generates the self-signed certificate and private key that can be uploaded to the server. Under Certificate Information, you can view the self-signed certificate information generated for the specified host.

Upload the SSL Certificate

Both self-signed and certificate authority SSL certificates and private keys must be uploaded to the ExtraHop appliance in .pem file format that includes both the certificate and the private key.

To upload an SSL certificate:

  1. Click Network Settings > SSL Certificate.
  2. Click Manage certificates to expand the section.
  3. Click Choose File and navigate to the certificate that you want to upload.
  4. Click Open.
  5. Click Upload.

Packet Captures

When packet capture is enabled through the Admin UI, you can write triggers to specify and deploy targeted packet captures from the ExtraHop appliance to an SSD installed on your ExtraHop appliance or, in the case of a virtual machine, to a regular disk drive. You must have access to the ExtraHop Admin UI and write permission to the ExtraHop Web UI to complete these steps.

  • View and Download Packet Captures: View packet captures and download them to your workstation.
  • Global Packet Capture: Save every packet on every flow, up to the specified limits.

Enable Packet Capture

Before you can use triggers to perform packet captures, you must first ensure you are licensed for packet capture on your ExtraHop appliance and your SSD is installed if you are not using a virtual machine.

To verify that your ExtraHop license has packet capture enabled:

  1. Click System Settings > License.
  2. In the Features section, verify that packet capture is enabled. If you do not see Packet Capture on the list or it is not listed as Enabled, contact ExtraHop Customer Support.
    Note: If you are using a virtual machine, the packet capture license is labeled Enabled (Unrestricted). This means the packet capture data will be written to a regular disk drive instead of an SSD.

To verify that the SSD is installed on your ExtraHop appliance (not applicable to virtual machines):

  1. Click System Settings > Disk. If the Drive Map shows the last slot in red, refer to Disk to install and enable the drive.
  2. If the Drive Map shows the SSD drive as green and the Status is Online, it is ready to use for packet capture.
    Note: If the SSD drive is dislodged and reinserted, you can re-enable it. This process requires reformatting the disk, which erases all data.

Specify the Packet Capture

(Skip this section if you are doing a global packet capture.) The ExtraHop appliance uses Application Inspection Triggers to gather custom metrics. These metrics are stored internally and can be used by other features, such as packet capture. Triggers are user-specified scripts that perform additional actions during well-defined events.

To create a trigger, complete the following steps:

  1. In the Web UI, click Settings > Triggers.
  2. Click New.
  3. Enter a name for the trigger and select the event(s) that will activate the trigger, then click the Editor tab and write your trigger source code.
    Note: After you have tested the trigger to ensure it works, clear the Enable Debugging check-box to avoid excessive debug messages in the Runtime Log.
  4. Assign the trigger to a device or group of devices.
  5. Click Save.

For more information on triggers, see the ExtraHop Trigger API documentation available on the ExtraHop Documentation website.

View and Download Packet Captures

After you have written a trigger to specify the targeted packet capture and the trigger has collected data, you can view and download packet captures in the Admin UI.

  1. Click Packet Captures > View and Download Packet Captures.
  2. On the Packet Captures page, select one or more packet captures and click Download Selected Captures.

    To filter packet captures, select the filter criteria from the Filter Packet Captures drop-down. You can also filter by the date of capture.

    To sort packet captures, click a column heading in the table and click the arrow to the right of the heading to flip the sort order between ascending and descending order.

  3. Open the downloaded packet captures in a packet analyzer such as Wireshark.

Global Packet Capture

You can use global packet capture to save every packet on every flow. Global packet capture is limited to 96 bytes per packet. Global packet capture occurs in the Admin UI and does not require any additional configuration or triggers.

  1. Click Packet Captures > Global Packet Capture.
  2. In the Start Global Packet Capture section, enter the following information:
    • Name: The name for the capture.
    • Max Packets: The maximum number of packets to capture.
    • Max Bytes: The maximum number of bytes to captures.
    • Max Duration (milliseconds): The maximum duration to run the global capture for.
    • Snaplen: The maximum number of bytes copied per frame. By default, this is 96 bytes but you can set it to be a value between 0 and 65536 bytes.
  3. Click Start.
  4. (Optional) Click Stop to stop the packet capture before any of the maximum limits are reached.

For more information on viewing the packets, see the View and Download Packet Captures section.

Cluster Settings (ECA)

If your organization uses the Command appliance to manage multiple network capture points, you can use the Admin UI to manage the nodes.

On the Command appliance, the Cluster Settings section includes the following configurable settings:

  • Set ECA Name: Set a name for the Command applianceif no Command applianceis currently set.
    OR
    ECA Name: <name>: Name of the currently set Command appliance.
  • Nodes: View and modify the cluster and its individual nodes.

Set ECA Name

If your Discover appliance is not yet the node of a Command appliance cluster, you need to specify the name of the Command appliance to join. You can also change the cluster by changing the Command appliance name.

To set the Command appliancename:

  1. Click Cluster Settings > Set ECA Name if you have not yet set an ECM name.
    OR
    Click Cluster SettingsECA Name: <name> if you have already set a name for your Command appliance.
  2. In the Set ECA Name pop-up window, enter a name and click Save.

Nodes

On the Cluster SettingsNodes page of the Command appliance Admin UI, you can view and modify the Command appliance cluster and its individual nodes.

Cluster Activity

In the Cluster Activity section, you can view the history, update the firmware, and run a support pack.

View the History

To view historical information about the Command appliance cluster:

  1. Click  Cluster SettingsNodes.
  2. In the Cluster Activity section, click History to view the Cluster Activity History pop-up window to which displays the five most recent actions.

Update the Firmware

From the Command appliance, you can update the firmware on some or all of the cluster nodes.

To update the firmware on all or specific cluster nodes:

  1. Click Cluster SettingsNodes
  2. In the Cluster Activity section, click the Update Firmware button.
  3. In the New Cluster Action: Update Firmware on Nodes pop-up window, select the following:
    • Firmware Image: Click Choose File to select firmware saved on your workstation, then navigate to the firmware file and click Open.
      OR
      Click the Retrieve from URL link if you received a URL from ExtraHop Support.
    • Apply To: Click the All nodes radio button to update the firmware on all nodes.
      OR
      Click the Matching nodes radio button and enter search criteria to update specific nodes that match that criteria.
  4. Click Upload.

Run a Support Pack

From the Command appliance, you can chose to run a support pack on some or all of the member nodes.

To run a support pack on the cluster or specific nodes:

  1. Click Cluster SettingsNodes.
  2. In the Cluster Activity section, click Run Support Pack.
  3. In the New Cluster Action: Run Support Pack on Nodes pop-up window, select the following:
    • Support Pack: Click the Default Support Pack radio button to run the support pack from the current firmware.
      OR
      Click the Upload Support Pack radio button, then click Choose File to select a support pack saved on your workstation, then navigate to the file and click Open.
    • Apply To: Click the All nodes radio button to run the support pack on all nodes.
      OR
      Click the Matching nodes radio button and enter search criteria to run the support pack on the specific nodes that match that criteria.
  4. Click Submit.

Cluster Nodes

In the Cluster Nodes section, you can add, delete, and assign tags to nodes in the cluster. Mousing over data in the Cluster Nodes section will give you additional information.

  • Host: Mouse over the node name to see more information about the node.
  • Added: Mouse over the date to see the full date and time the node was added to the cluster.
  • Status: Mouse over the status symbol to see the current status and the date and time the node was last synced. The available statuses are: Online, Warning, Disabled, and Offline.
  • License: Mouse over the status symbol to see the license status of the node. The available statuses are: Nominal, Expiring soon, License check pending, and Invalid.
  • Time: Mouse over the time symbol to see the node time delta compared to the time of the Command appliance. The available deltas are: NTP synced, Large time delta from ECA, and NTP not configured.

You can also mouse over the settings icon to edit the cluster node settings for that node, launch the shell, view the node in the Web UI, or view the node in the Admin UI.

Add Node

You can add nodes to the cluster from the Command appliance Admin UI either one at a time or you can add multiple nodes at once.

To add a single node:

  1. Click Cluster SettingsNodes.
  2. In the Cluster Nodes section, click Add Node.
  3. In the Add Cluster Node pop-up window, enter the following information:
    • Host: The name of the node.
    • Setup Password: The setup password for the node.
    • Product Key (optional): The optional product key for the node firmware.
    • Nickname: A friendly name for the node. If no friendly name is entered, the host name will be used instead.
    • Reset Configuration: Uncheck this checkbox if you do not want to remove existing node customizations such as device groups, alerts, and triggers. Gathered metrics such as captures and devices will not be removed.
  4. Click Save.

To add multiple nodes at one time:

  1. Create a text file with the information on the nodes you want to add to the cluster, one node per line, in the format:

    <Host> <Password> <Product-key> <Nickname>

    Note<Product-Key> and <Nickname> are both optional. You can provide a nickname without a product key.

  2. Click Cluster SettingsNodes.
  3. In the Cluster Nodes section, click Add Node.
  4. In the Add Cluster Node pop-up window, click Add multiple nodes.
  5. In the Add Multiple Cluster Nodes pop-up window, either:
    • Paste the contents of your text file into the Paste text file text box.
    • Click Upload text file > click Choose File, navigate to your saved text file and click Open.
  6. Reset Configuration: Uncheck this checkbox if you do not want to remove existing node customizations like device groups, alerts, and triggers from all the included notes. Gathered metrics such as captures and devices will not be removed.
  7. Click Add Nodes.
Delete a Node

You can delete one or more nodes from the cluster at a time. 

To delete a node:

  1. Click Cluster SettingsNodes.
  2. In the Cluster Nodes section, check the checkbox next to each node you want to delete.
  3. Click the Delete button.
  4. In the Delete Cluster Nodes pop-up window, click OK.
Create a New Tag

You can add tags to your Command appliance that can help you categorize your nodes. There are eight tag colors available and but each color can be used multiple times with different labels. You must create a tag before you can apply it to a node.

An example of tag use would be to label all nodes on one datacenter with their location but use a single color to indicate the datacenter.

To create a new tag:

  1. Click Cluster SettingsNodes.
  2. In the Cluster Nodes section, click Tags.
  3. Click Add New Tag.
  4. In the Add Tag pop-up window, enter the following information:
    • Name: The label you want displayed with the tag color.
    • Color: Click the radio button next to the color you want to use for this tag.
  5. Click Save.
Edit a Tag

You can edit both the text and color of an existing tag. The tag will remain applied to any nodes it was previously assigned to but the color and/or label will be updated.

To edit a tag:

  1. Click Cluster SettingsNodes.
  2. In the Cluster Nodes section, click Tags.
  3. Click Edit Tag next to the tag you want to edit.
  4. In the Edit Tag <tag> pop-up window, rename the tag and/or click the radio button next to a new color.
  5. Click Save.
Delete a Tag

You can delete a tag at any time. It will be deleted from the tag list and removed from any nodes it had been applied to as soon as it is deleted.

To delete a tag:

  1. Click Cluster SettingsNode.
  2. In the Cluster Nodes section, click Tags.
  3. Click the red x next to the tag you want to delete.
  4. Click OK.
Add a Tag to a Node:

You can apply one or many tags to a node. You can also apply tags to multiple nodes at a time.

To add a tag to a node:

  1. Click Cluster Settings > Nodes.
  2. In the Cluster Nodes section, check the checkbox next each of the nodes you want to add a tag to.
  3. Click Tags and check the checkbox next to each of the tags you want to apply to the selected nodes.
  4. Click Apply.
Register the License

You can force the cluster nodes to register their licenses from the Command appliance.

To force license registration on the nodes:

  1. Click Cluster SettingsNodes.
  2. In the Cluster Nodes section, check the checkbox next to each of the nodes you want to register.
  3. Click More and select License Register from the drop-down.
  4. In the Nodes License Registration pop-up window, click OK.
Enable a Node

Enabled nodes are indicated by a green status icon in the Cluster Nodes list.

To enable a node:

  1. Click Cluster SettingsNodes.
  2. In the Cluster Nodes section, check the checkbox next to each of the nodes you want to enable.
  3. Click More and select Enable Nodes from the drop-down.
  4. In the Enable Nodes pop-up window, click OK.
Disable a Node

Disabled nodes are indicated with a blue status icon in the Cluster Nodes list.

To disable a node:

  1. Click Cluster Settings  > Nodes.
  2. In the Cluster Nodes section, check the checkbox next to each of the nodes you want to disable.
  3. Click More and select Disable Nodes from the drop-down.
  4. In the Disable Nodes pop-up window, click OK.

Cluster Memberships

If your organization uses the Command appliance to manage multiple network capture points, you can use the Admin UI of each Discover appliance to connect it to an Command appliance cluster.

Join an ECA cluster

Each Discover appliance can belong to a single cluster and a Command appliance cannot be a member of another Command appliance cluster. You can

To join a cluster:

  1. Click Cluster MembershipsJoin a Cluster.
  2. In the Join a Cluster pop-up window, enter the following information:
    • ECA Host: The name of the Command appliance in charge of the cluster you want to join.
    • Setup Password: The setup password for the Discover appliance node.
    • Node Nickname: A friendly name for the node. If no friendly name is entered, the host name will be used instead.
    • Reset Configuration: Uncheck this checkbox only if you do not want to remove existing node customizations such as device groups, alerts, and triggers. Gathered metrics such as captures and devices will not be removed.
  3. Click Save.

Access Settings

In the Access Settings section, you can change passwords, enable the support account, and specify users in the ExtraHop appliances for remote authentication.

  • Change Password: Change the password for user accounts.
  • Support Account: Enable troubleshooting assistance from ExtraHop Support.
  • Users: Add and delete users, and modify user privileges.
  • Sessions: View and terminate user sessions on the ExtraHop appliance.
  • Remote Authentication: Enable users to log on to the ExtraHop appliance using their existing credentials.
  • API Access: Generate and delete API keys, and access the API Explorer.

Change Password

Admin UI users have privileges to change the password to their personal Discover appliance account. Discover appliance Admin UI administrators have privileges to change the password for any user that has an account stored locally in the ExtraHop Admin database. For more information about privileges for specific Admin UI users and groups, see Users.

Note: The default password for Amazon Web Services (AWS) users is the string of numbers after the -i in the instance ID.

Change a User Password

Note: You can only change passwords for local users, not for users authenticated with LDAP.
  1. Click Access Settings > Change Password.
  2. On the Change Password page, enter the following information:
    • User: From the drop-down, select the user you want to set the password for.
    • New Password: Enter a new password for the selected user.
    • Confirm Password: Enter the new password for the selected user again to confirm it.
  3. Click Save.
  4. Click OK.

Change the Default Password

ExtraHop recommends that you change the default password for the setup account as soon as your evaluation period is complete. To remind administrators to make this change, there is a Change default password button displayed at the top of the page while the setup user is accessing the Admin UI with the default password. You can also change the password from the ExtraHop Login page.

  1. In the Admin UI, click Change default password.
  2. The Change Password page displays with the User field pre-populated with setup. Enter a new password and confirm that password, then click Save .
  3. Click OK.

Support Account

The support accounts are used to provide access for the ExtraHop Support team to help customers troubleshoot issues with the Discover appliance and to provide Atlas Services remote analysis reports.

These settings should be enabled only if the ExtraHop system administrator requests hands-on assistance from the ExtraHop Support team or if your organization is subscribed to Atlas Services.

Enable the Support Account

To enable the support account on a Discover appliance:

  1. Click Access Settings > Support Account.
  2. Click Support Account. (Note: On a Command appliance, click Support Access.)
  3. Click Enable Support Account.
  4. The next page contains an encrypted key used by ExtraHop Support to access the ExtraHop appliance. Select the contents of the text box on this page and send it to support@extrahop.com.
  5. Click Done.

To enable the support account on a Command appliance:

  1. Click Access Settings > Support Account.
  2. Click Enable Support Account.
  3. The next page contains an encrypted key used by ExtraHop Support to access the ExtraHop appliance. Select the contents of the text box on this page and send it to support@extrahop.com.
  4. Click Done.

Regenerate the Support Account Key

To regenerate a support account key: 

  1. Click Access Settings > Support Account.
  2. Click Regenerate Key and click Regenerate.
  3. The next page contains an encrypted key used by ExtraHop Support to access the ExtraHop appliance. Select the contents of the PGP message on this page and send it to support@extrahop.com.
  4. Click Done.

Disable the Support Account

To disable the support account on a Discover appliance:

  1. Click Access SettingsSupport Account.
  2. On the Support Account page, click Support Account.
  3. Click Disable Support Account.

To disable the support account on a Command appliance:

  1. Click Access SettingsSupport Account.
  2. Click Disable Support Account.

Enable the Atlas Remote UI Account

To enable the Atlas Remote UI account:

  1. Click Access Settings > Support Account.
  2. Click Atlas Remote UI Account.
  3. Click Enable Atlas Remote UI Account.
  4. The next page contains an encrypted key used by ExtraHop Support to access the Discover appliance. Select the contents of the text box on this page and send it to support@extrahop.com.
  5. Click Done.

Disable the Atlas Remote UI Account

To disable the Atlas Remote UI account:

  1. Click Access Settings > Support Account.
  2. Click Atlas Remote UI Account.
  3. Click Disable Atlas Remote UI Account.

Users

The Users page provides controls to add and delete users, and to change the access privileges of users of the ExtraHop appliance. Users with administrator-level privileges can add other users.

User accounts can be locally or remotely authenticated and authorized. For more information, see the Remote Authentication section.

User Authenticated User Authorized Appearance in the Managed User List Permissions Managed
Locally Locally Appears immediately In the ExtraHop
Remotely Locally Appears after first login In the ExtraHop
Remotely Remotely Will not appear In the remote server
Note: The local user account overrides all remote user account settings.

Add a User Account

To add a user to the ExtraHop appliance:

  1. Click Access Settings > Users.
  2. Click Add User at the bottom of the page.
  3. On the Add New User page, enter the following information in the Personal Information section:
    • Login ID: The new user login ID.
    • Full Name: The full name of the new user.
    • Password: The password for the new user.
    • Confirm Password: Repeat the new user's password for confirmation.
  4. In the Permissions section, check the checkboxes for the correct permissions for this user, then check the Enabled checkbox. Each enabled user must have a permission level selected.
  5. Click Save.

Modify a User Account on a Node

After a local user is created, you can modify the full name and the permissions for that user, if needed.

To change the account settings for a selected user:

  1. Click Access Settings > Users.
  2. Click the user name you want to modify.
  3. On the Update User '<user>' page, modify the permissions or change the full name of the user.
  4. Click Save .

Modify a User Account on a Command appliance

On the Command appliance, you can set additional permissions to access the Admin UI.

To change the account settings for a selected user on a Command appliance:

  1. >Click Access Settings > Users.
  2. Click the user name you want to modify.
  3. On the Update User '<user>' page, modify the permissions or change the full name of the user.

    When Cluster Node UI Privileges is selected, the user has access to specific clusters and nodes as permitted by the LDAP settings.

  4. Click Save.

Delete a User Account

To delete a selected user:

  1. Click Access Settings > Users.
  2. Click red x next to the account you want to delete.

Note: Remote user records are removed from the ExtraHop appliance only when they are manually deleted.

Default Accounts

The following accounts are preconfigured in the ExtraHop appliance. All accounts except shell are accessible at https://[IP address]/admin, where [IP address] is the IP address displayed on the LCD on the front panel of the ExtraHop appliance.

The shell account allows access to the ExtraHop command line interface (CLI). This account only allows access to the non-administrative shell commands. When accessing the privileged system configuration shell commands, the user types in enable and authenticates with the setup user password. The default password for this account is the service tag number on the right-front bracket of the ExtraHop appliance.

The setup account has full access privileges. The default password for this account is the service tag number on the right-front bracket of the ExtraHop appliance.

The admin account has read/write access to the ExtraHop Web UI. The default password for this account is admin.

The operator account has limited access to the ExtraHop Web UI. It is disabled by default but can be enabled and given the appropriate set of privileges. It does not have a preset password, so a password needs to be set manually prior to use.

The readonly account has read-only access to the ExtraHop Web UI. It does not have a preset password, so a password needs to be set manually prior to use.

Note: The default password for Amazon Web Services (AWS) users is the string of numbers after the -i in the instance ID.

For a quick reference of the default accounts, see the following table.

Account Privileges
shell Full System (CLI, Admin UI, and Web UI)
setup Full System (CLI, Admin UI, and Web UI)
admin Full Write
operator Limited Write
readonly Read-Only

Permissions

An administrator can grant users the following permissions.

Permission Description
Full System Privileges
  • Manage the ExtraHop appliance through the Admin UI.
  • Access system configuration commands in the ExtraHop command line interface (CLI) by securing the "enable" command.
  • Create and modify objects in the Web UI, such as devices and alerts.
  • Connect a Command appliance to one or more nodes.
Full Write Privileges Create and modify objects in the Web UI, such as devices and alerts.
Limited Write Privileges Create and modify summary widgets on the dashboard.
Read-Only Privileges Cannot make changes.
No Privileges Cannot view the UI.
Cluster Node UI Privileges Add and remove nodes through the Command appliance.

Sessions

The ExtraHop system provides controls to view and delete user connections to the web interface. The Sessions list is sorted by expiration date, which corresponds to the date the sessions were established. If a session expires or is deleted, the user must log in again to access the web interface.

View Active Sessions

To view active sessions, go to the Access Settings section and click Sessions.

Delete Active Sessions

You can delete active sessions individually or all at once. When you delete an active session, the session is terminated for the user and they must log in again to access the web interface.

To delete a single active session:

  1. Click the red x next to the session you want to delete.
  2. On the Delete Session page, click OK.

To delete all active sessions:

  1. Click Delete All.
  2. On the Delete all sessions page, click OK.

Remote Authentication

The ExtraHop appliance supports remote authentication for user authentication. It enables organizations that have authentication systems such as LDAP, RADIUS, or TACACS+ to allow all or a subset of their users to log on to the ExtraHop appliance using their existing credentials.

Centralized authentication provides the following benefits:

  • User password synchronization.
  • Automatic creation of ExtraHop accounts for users without administrator intervention.
  • Management of ExtraHop privileges based on LDAP groups.

To use remote authentication, you must have a remote server with one of the following configurations:

  • LDAP (such as OpenLDAP or Active Directory)
  • RADIUS
  • TACACS+

Administrators can grant access to ExtraHop appliance to all known users or restrict access by using LDAP filters.

LDAP

The ExtraHop appliance supports the Lightweight Directory Access Protocol (LDAP) for authentication and authorization. ExtraHop authentication only queries for user accounts; it does not use any other entities that are in the LDAP directory.

Users whose credentials are not stored locally are authenticated against the remote LDAP server using their username and password when they attempt to log on to the ExtraHop appliance. When a user attempts to log on to the ExtraHop UI, the ExtraHop appliance:

  • Attempts to authenticate the user locally.
  • Attempts to authenticate the user through the LDAP server if the user does not exist locally and the ExtraHop appliance is configured to use LDAP for remote authentication.
  • Logs the user on to the ExtraHop appliance if the user exists and the password is validated through LDAP. The LDAP password is not stored locally on the ExtraHop appliance.

If the user does not exist or an incorrect password is used, an error message appears with the login page.

Ensure that each user to be remotely authorized is in a permission-specific group on the LDAP server before beginning this procedure.

Configure LDAP Authentication

To authenticate with LDAP on the ExtraHop appliance:

  1. Click Access Settings > Remote Authentication.
  2. In the Methods section, select LDAP from the Remote authentication method drop-down, then click Continue.
  3. On the LDAP Settings page, enter the following information:
    • Hostname (required): The hostname or IP address of the LDAP server. Make sure that the DNS of the ExtraHop appliance is properly configured if you use a hostname.
    • Port (required): The port on which the LDAP server is listening. Port 389 is the standard cleartext LDAP server port. Port 636 is the standard port for secure LDAP (ldaps/tls ldap).
    • Base DN (required): The base of the LDAP search used to find users. The base DN must contain all user accounts that will have access to the ExtraHop appliance. The users can be direct members of the base DN or nested within an OU within the base DN if the Whole Subtree option is selected for the Search Scope specified below. Consult your LDAP administrator to learn what your organization uses. Examples include:
      • Active directory canonical name: example.com/people

        LDAP base DN: ou=people,dc=example,dc=com

      • Active directory canonical name: example.com/people/employees/portland

        LDAP base DN: ou=portland,ou=employees,ou=people,dc=example,dc=com

    • Login Attribute (required): The login attribute that holds the user's username attribute in the LDAP database. Examples include:
      • uid: A username attribute typically used in Unix LDAP environments.
      • sAMAccountName: An account name attribute typically used in Active Directory (AD) environments.
    • Search Filter: The criteria used when searching the LDAP directory for user accounts. Examples include:
      objectclass=person objectclass=* &(objectclass=person)(ou=webadmins)

      A search filter of objectclass=* matches all entities and is the default wildcard.

    • Search Scope: The scope of the directory search when looking for user entities. Options include:
      • Single level: This option looks for users that exist in the base DN; not any subtrees.

        For example, with a Base DN value of dc=example,dc=com, it would find a user uid=jdoe,dc=example,dc=com, but would not find uid=jsmith,ou=seattle,dc=example,dc=com.

      • Whole subtree: This option looks recursively under the base DN for matching users.

        For example, with a Base DN value of dc=example,dc=com, it would find both the user uid=jdoe,dc=example,dc=com and uid=jsmith,ou=seattle,dc=example,dc=com.

    • Bind DN: The Distinguished Name (DN) used by the ExtraHop appliance to authenticate with the LDAP server to perform the user search. The bind DN must have list access to the base DN and any OU, groups, or user account required for LDAP authentication. If this value is not set, then an anonymous bind is performed. Note that anonymous binds are not enabled on all LDAP servers. Using the active directory canonical name example.com/people, Bind DN examples include:
      cn=admin, ou=users, dc=example,dc=com uid=nobody,ou=people,dc=example,dc=com

      To verify whether anonymous binds are enabled, contact your LDAP administrator.

    • Bind Password: The password used when authenticating with the LDAP server as the bind DN specified above. If you are using an anonymous bind, leave this setting blank. In some cases, an unauthenticated bind is possible, where you supply a Bind DN value but no bind password. Consult your LDAP administrator for the proper settings.
    • SSL: Whether encryption should be used when making LDAP requests. Options include:
      • None: This options specifies the use of cleartext TCP sockets, typically port 389. Warning: All passwords are sent across the network in cleartext in this mode.
      • LDAPS: This option specifies LDAP wrapped inside SSL, typically on port 636.
      • StartTLS: This option specifies the use of TLS LDAP, typically on port 389. (SSL is negotiated before any passwords are sent.)

      If you are not sure which options are available, consult your LDAP administrator.

      Note: Clicking your browser’s Back button during this process could result in lost changes.
  4. Click Test Settings. If the test succeeds, a status message appears near the bottom of the page. If the test fails, click Show details to see a list of errors. Click Save and Continue.
  5. Determine whether you want to do local or remote authentication.
    1. Local authorization: By default, remote users have full write access. If you wish to grant all remote users read-only privileges by default, select Remote users have Read Only access.

      You can add read-write permissions on a per-user basis later through the Users page in the Admin UI.

    2. Remote authorization: You might also choose to obtain a permissions level from a remote server. When you select the Obtain permissions… option, you must complete at least one of the following fields to specify the remote permissions.

      These must be groups (not organizational units) that are pre-specified on the LDAP Server. A user account with access must be a direct member of a specified group. User accounts that are a member of a group that is a member of a group specified above will not have access. If the groups are not present, they will not be authenticated on the ExtraHop appliance.

      The ExtraHop appliance supports the following types of group membership:

      • Active Directory: memberOf
      • Posix: posixGroups, groupofNames, and groupofuniqueNames

      Examples:

      Given the base DN:

      ou=seattle,ou=washington,dc=usa,dc=example,dc=com

      and the bind DN:

      cn=ehaccess,ou=admins,ou=seattle,ou=Washington,dc=usa,dc=example,dc=com

      and the Search Scope set to Whole Subtree, any user account in the usa.example.com domain that is a member of:

      cn=extrahop-readonly,ou=groups,ou=seattle,ou=washington,dc=usa,dc=example,dc=com

      and is nested within:

      ou=seattle,ou=washington,dc=usa,dc=example,dc=com

      would have read-only access on the ExtraHop appliance.

      Examples of accounts with access:

      cn=JDoe,ou=users,ou=seattle,ou=Washington,dc=usa,dc=example,dc=com cn=admin,ou=seattle,ou=washington,dc=usa,dc=example,dc=com

      Examples of accounts without access:

      cn=JaneD,ou=users,dc=usa,dc=example,dc=com cn=Administrator,dc=usa,dc=example,dc=com
  6. Click Save and Finish.
  7. Click Done.

RADIUS

The ExtraHop appliance supports Remote Authentication Dial In User Service (RADIUS) for remote authentication and local authorization only. For remote authentication, the ExtraHop appliance supports unencrypted RADIUS and plaintext formats.

Configure RADIUS Authentication

To configure RADIUS authentication for the ExtraHop appliance:

  1. Click Access Settings > Remote Authentication.
  2. In the Methods section, select RADIUS from the Remote authentication method drop-drown, then click Continue.
  3. On the Add RADIUS Server page, enter the following information:
    • Host: The hostname or IP address of the RADIUS server. Make sure that the DNS of the ExtraHop appliance is properly configured if you use a hostname.
    • Secret: The shared secret between the ExtraHop appliance and the RADIUS server. Contact your RADIUS administrator to obtain the shared secret.
    • Timeout: The amount of time the ExtraHop appliance will wait for a response from the RADIUS server before it attempts to connect again.
  4. Click Add Server.
  5. Repeat steps 2, 3, and 4 to add multiple servers, if needed.
  6. Click Continue.
  7. By default, remote users have full write access. If you wish to grant all remote users read-only privileges by default, select Remote users have Read Only access.
  8. Click Save and Finish.
  9. Click Done.

TACACS+

The ExtraHop appliance supports Terminal Access Controller Access-Control System Plus (TACACS+) for remote authentication and authorization.

Ensure that each user to be remotely authorized has the ExtraHop service configured on the TACACS+ server before beginning this procedure.

Configure TACACS+ Authentication

To configure TACACS+ authentication for the ExtraHop appliance:

  1. Click Access Settings > Remote Authentication.
  2. In the Methods section, select TACACS+ from the Remote authentication method drop-down, then click Continue.
  3. On the Add TACACS+ Server page, enter the following information:
    • Host: The hostname or IP address of the TACACS+ server. Make sure that the DNS of the ExtraHop appliance is properly configured if you use a hostname.
    • Secret: The shared secret between the ExtraHop appliance and the TACACS+ server. Contact your RADIUS administrator to obtain the shared secret.
    • Timeout: The amount of time the ExtraHop appliance will wait for a response from the TACACS+ server before it attempts to connect again.
  4. Repeat steps 2, 3, and 4 to add multiple servers, if needed.
  5. Click Continue.
  6. Determine whether you want to do local or remote authentication.
    1. Local Authorization: By default, remote users have full write access. If you wish to grant all remote users read-only privileges by default, select Remote users have Read Only access.
    2. Remote Authorization: On the TACACS+ server, set up the ExtraHop service by adding the attribute service=extrahop and setting one of the following permissions.
      readonly=1 readwrite=1 limited=1 setup=1

      Example:

      user = dave { ... service = extrahop { readonly=1 } }
  7. Click Save and Finish.
  8. Click Done.

API Access

The API Access page provides controls to generate, view, and manage access for the API keys that are required to perform operations through the ExtraHop REST API. This page also provides a link to the REST API Explorer tool.

Administrators, or users with full system privileges, control whether users can generate API keys. For example, you can prevent remote users from generating keys or you can disable API key generation entirely. When this functionality is enabled, API keys are generated by users and can be viewed only by the user who generated the key.

API Modeling

Click the REST API Explorer link to open a web-based tool that enables you to try API calls directly on your ExtraHop Discover appliance.

The ExtraHop REST API Explorer tool also provides information about each resource and samples in cURL, Python 2.7, and Ruby.

See the ExtraHop REST API Guide for more information.

API Keys

You must generate an API key before you can perform operations through the ExtraHop REST API. API keys can be viewed only by the user who generated the key. After you generate an API key, you must append the key to your request headers.

Note: Administrators set up user accounts, and then users generate their own API key. Users can delete API keys for their own account, and users with full system privileges can delete API keys for any user. For more information, see the Users section in the ExtraHop Admin UI Guide.

The permission level that is set for a user dictates what that user can do through the REST API.

Permission level Functionality
Full System Privileges
  • Users can enable or disable API key generation for the ExtraHop appliance
  • Users can delete API keys for any user
  • Users can perform any operation available through the REST API
  • Users can view the last four digits and description for any API key on the system
Full Write Privileges
  • Users can generate an API key
  • Users can view or delete their own API key
  • Users can perform any configuration task through the REST API that is available for the ExtraHop Web UI
  • Users cannot perform any administration task through the REST API that is available for the ExtraHop Admin UI
Limited Write Privileges
  • Users can generate an API key
  • Users can view or delete their own API key
  • Users can modify personal customizations (such as a personal dashboard) through the REST API that is available for the ExtraHop Web UI
  • Users cannot perform any configuration task that might affect other users in the system
  • Users cannot perform any administration task through the REST API that is available for the ExtraHop Admin UI
Read-Only Privileges
  • Users can generate an API key
  • Users can view or delete their own API key
  • Users can perform limited GET operations through the REST API for the ExtraHop Web UI
Manage Access

You can manage which users are able to generate API keys on the ExtraHop appliance.

  1. Click Access SettingsAPI Access.
  2. In the Manage Access section, select one of the following options:
    • Allow All User Generated API Keys: Local and remote users can generate API keys.
    • Local Users Only: Only local users can generate API keys.
    • No API Keys Allowed: API keys cannot be generated.
  3. Click Save Settings.
Generate an API Key

After you log into the ExtraHop appliance, if API key generation is enabled, you can generate an API key.

  1. Click Access Settings > API Access.
  2. In the API Keys section, enter a description for the key, and then click Generate.
Delete an API Key

You can delete an API key from the ExtraHop appliance.

  1. Click Access Settings > API Access.
  2. In the Keys section, click the X next to the API key you want to delete.
  3. Click OK.

Keys

The Keys section lists all of the API keys for the ExtraHop appliance.

Configuration

This section contains ExtraHop appliance configuration settings that can be changed through the Admin UI.

  • Running Config: Download and modify the running configuration file.
  • Geomap Datasource: Modify the information in geomaps.
  • Datastore and Customizations: Reset the datastore and modify customizations.
  • Open Data Streams: Send log data to another system.
  • Capture: Configure the network capture settings.
  • Trends: Reset all trends and trend-based alerts.

Running Config

The Running Config settings let you make changes to the default ExtraHop appliance configuration settings and then save those settings to disk. The Running Config page provides an interface to view and modify the code that specifies the default system configuration and save changes to the current running configuration so the modified settings are enabled after a system restart.

The ExtraHop Admin UI includes the following controls to manage the default running system configuration settings:

  • Save config: Save changes to the current default system configuration.
  • Edit config: View and edit the underlying code that specifies the default ExtraHop appliance configuration.
  • Download config as a file: Download the system configuration to your workstation.
  • Note: Making configuration changes to the code on the Edit page is not recommended. You can make most modifications using other pages in the Admin UI.

Save Running Config Changes

When you modify any of the ExtraHop appliance default system configuration settings, you need to confirm the updates by saving the new settings. If you do not save the new settings, they will be lost when your ExtraHop appliance is rebooted.

Save System Configuration Settings

To save any modified system configuration settings:

  1. Click System Configuration > Running Config.
  2. Click Running Config > Save config.
  3. Review the comparison between the old running config and the current (new) running config. If the changes are correct, click Save.
  4. Click Done.

The Save page includes a diff feature that displays the changes. This feature provides a final review step before you write the new configuration changes to the default system configuration settings.

When you make a change to the running configuration, either from the Edit Running Config page, or from another system settings page in the Admin UI, changes are saved in memory and take effect immediately, but they are not usually saved to disk. If the system is restarted before the running configuration changes are saved to disk, those changes will be lost.

For example, if you make a change to a protocol classification setting on the Protocol Classification page, the change (in memory) takes effect immediately, but it does not permanently change the running configuration until you save the changes. As a reminder that the running configuration has changed, the Admin UI provides the following three notifications:

  • Save Configuration button: The Admin UI displays a button on the specific page that you modified to remind you to save the change to disk. When you click View and Save Changes, the UI redirects to the Save page described above.
  • Running Config*: The Admin UI adds a red asterisk (*) next to the Running Config entry on the Admin UI main page. This asterisk indicates that the running configuration has been changed, but it has not been saved to disk.
  • Save*: The Admin UI adds a red asterisk (*) next to the Save entry on the Running Config page. This asterisk indicates that the running configuration has been changed, but it has not been saved to disk.

After you make changes to the running configuration, the Running Config page displays another entry through which you can revert the changes.

Revert System Configuration Changes

To revert your changes without saving them to disk:

  1. Click System ConfigurationRunning Config
  2. Click Revert config.
  3. Click Revert.
  4. Click OK.
  5. Click Done.

Edit Running Config

The ExtraHop Admin UI provides an interface to view and modify the code that specifies the default system configuration. In addition to making changes to the running configuration through the settings pages in the Admin UI, changes can also be made on the Running Config page.

Note: Do not modify the code on the Running Config page unless instructed by ExtraHop Support.

Download as a File

You can download the Running Config settings to your workstation in text file format. You can open this text file and make changes to it locally, before copying those changes into the Running Config window.

Download Running Config as a Text File

To download the current running configuration settings as a text file:

  1. Click System ConfigurationRunning Config
  2. Click Download config as a File.

The current running configuration will be downloaded as a text file to your browser's default download location.

Geomap Data Source

This section enables you to download specific settings related to geomaps.

  • GeoIP Database: Upload a user-specified database.
  • IP Location Override: Override missing or incorrect IPs in the database.

GeoIP Database

The GeoIP Database specifies the current database being used by the ExtraHop appliance and enables you to choose between a default or user-uploaded database.

Change the GeoIP Database

To change which GeoIP database the ExtraHop appliance is using from the current database to a new custom database:

  1. Click System Configuration > Geomap Data Source.
  2. Click GeoIP Database.
  3. In the Change Source section, select the Upload New Database rado button, then click Choose File to upload a database in .dat format from your workstation.
  4. Navigate to the file you want to upload and click Open.
  5. Click Save.

To change which GeoIP database the ExtraHop appliance is using back to the default database.

  1. Click System Configuration > Geomap Data Source.
  2. Click GeoIP Database.
  3. In the Change Source section, select the Default Database radio button.
  4. Click Save.

IP Location Override

The IP Location Override page enables you to override missing or incorrect IPs that are in the GeoIP database. You can type a comma-delimited list or copy and paste a tab or comma-delimited list of overrides into the text box.

The columns are:

  • IP Address (a CIDR block)
  • Latitude
  • Longitude
  • City
  • State/Region
  • Country Name
  • ISO Country Code

You can edit and delete items as necessary, but you must ensure there is data present for each of the seven columns. For more information about ISO country codes, refer to https://www.iso.org/obp/ui/#search and click Country Codes.

Override an IP Location

To apply an IP location override:

  1. Under System Configuration, click Geomap Data Source.
  2. Click IP Location Override.
  3. In the text box, type or paste a tab or comma-delimited list of overrides in the following format:
    IP address, latitude, longitude, city, state/region, country name, ISO alpha-2 country code

    For example:

    10.10.113.0/24, 38.907231, -77.036464, Washington, DC, United States, US
  4. Click Save.

To verify the change, go to the Geomaps interface and mouse over a location included in your IP Location Overrides.

Datastore and Customizations

The Discover appliance includes a self-contained, streaming datastore for recording and retrieving performance and health metrics in real time. The datastore bypasses the OS file system and accesses the underlying block devices directly, rather than using a conventional relational database.

The ExtraHop Admin UI includes the following datastore configuration settings:

  • Local Datastore Settings: Remove all devices and device metrics from the datastore.
  • Extended Datastore Settings: Configure an external NFS or CIFS mount for long term storage of 5-minute, 1-hour, and 24-hour metrics.
  • Customizations: View, save, upload, and restore customizations. Datastore configurations settings from one Discover appliance can be uploaded to another Discover appliance in multiple-appliance deployment for consistency. The Discover appliance stores the last three user-saved datastore configurations.

Local Datastore Settings

The local datastore maintains records for all devices discovered by the ExtraHop appliance. Device metrics are collected and stored in the datastore to provide quick access to the latest network capture as well as historic and trend-based information about selected devices.

Note: Resetting the ExtraHop datastore deletes device IDs and device metrics from the ExtraHop appliance. Do not perform this operation unless you want to erase all device information from the ExtraHop appliance.

The ExtraHop appliance is provisioned to retain metrics for 30 days. Access to historical metrics is essential for performance tuning, troubleshooting, and capacity planning. Additionally, historical metrics are used internally for trend analysis.

In certain circumstances, such as moving the ExtraHop appliance from one network to another, you might need to clear the metrics in the datastore. Resetting the datastore removes all metrics, baselines, trend analyses, and discovered devices. Alerts that have been configured are retained, but they must be reapplied to the correct network, device, or device group. System settings and user accounts are unaffected.

You can reset the datastore using either the Admin UI or the command line interface (CLI). Before you reset the datastore, you might want to save your device and network customizations. Saved customizations are applied only to devices that have been discovered by the ExtraHop appliance, which typically takes a few minutes after resetting the datastore. For more information about saving customizations, see the Save Running Config Changes section.

Reset the Datastore with the Admin UI

To reset the datastore in the Admin UI:

  1. Click System Configuration > Datastore and Customizations.
  2. Click Reset Datastore.
  3. On the Reset Datastore page, uncheck the Save Customizations checkbox only if you do not want to save customizations, then type YES in the confirmation text box.
  4. Click Reset Datastore.
  5. Wait approximately one minute. When the datastore reset is complete, the browser will prompt you to restore customizations.
  6. If you chose to restore customizations, the browser redirects to a detailed list of imported customizations.
  7. Click OK.
  8. Go to the Web UI to view the devices that were discovered after the datastore reset. Wait approximately one minute for the system to discover and display new devices.
Reset the Datastore with the CLI

To reset the datastore in the CLI:

  1. Access the ExtraHop CLI using one of the following three methods:
    • From a USB keyboard and SVGA monitor directly connected to the ExtraHop appliance
    • Using an RS-232 serial cable and a terminal-emulator program. The terminal emulator must be set to 115200 bps with 8 data bits, no parity, and 1 stop bit (8N1). Hardware flow control must be disabled.
    • Secure shell (SSH)
  2. Connect to the ExtraHop appliance. The login is shell and the password is the service tag number on the pullout tab on the front panel of the ExtraHop appliance.
  3. Enable the administration controls. The password is the service tag number on the right-front bracket of the ExtraHop appliance.
    extrahop>enable
  4. Reset the datastore.
    extrahop#reset datastore

Extended Datastore Settings

The ExtraHop appliance enables you to write and store metrics externally on your own storage.

By default, the ExtraHop appliance automatically collects fast (30-second), medium (5-minute), and slow (1-hour) metrics locally. In addition, you can configure the ExtraHop appliance to collect 24-hour metrics in addition to 5-minute and 1-hour metrics on an extended datastore. The ExtraHop appliance supports NFS version 4, NFS version 4 with Kerberos, and CIFS (with optional authentication).

To set up an extended datastore, you must have administrative access and a licensed ExtraHop appliance. Additionally, you must configure any applicable Kerberos authentication settings, add mounts, and configure the datastores.

After you have added a mount, you can configure the extended datastore to do one of the following:

Configure Kerberos Authentication Settings (NFS Only)

Configure any applicable Kerberos authentication before you add an NFS mount.

  1. Click System Configuration > Datastore and Customizations.
  2. Click Extended Datastore Settings > Configure Mounts.
  3. Click Kerberos Configuration > Add Kerberos Config.
  4. Enter the following information:
    • Admin Server: The IP address or hostname of the master Kerberos server that issues tickets.
    • Key Distribution Center (KDC): The IP address or hostname of the server that holds the keys. (This server can be the same as the admin server.)
    • Realm: The name of the Kerberos realm for your configuration.
    • Domain: The name of the Kerberos domain for your configuration.
  5. Click the Keytab File drop-down and select Choose File. Then browse to a saved keytab file and click Open.
Add Mounts

You can add NFS mounts, CIFS mounts, or both.

If a mount becomes unreachable, the ExtraHop appliance buffers metrics until the allocated memory is full. Once the memory is full, the system overwrites older blocks until the connection is restored. When the mount reconnects, all of the metrics stored in memory are written to the mount.

If an extended datastore file is lost or corrupted, metrics contained in that file are lost. Other files in the extended datastore remain intact.

Add an NFS Mount

NOTE: To use an NFS mount, set one of the following permissions on the remote share:
  • The share must have read/write access for all users.
  • The share must be owned by the 'extrahop' user and have read/write access for the current user.

To add an NFS mount:

  1. Click System Configuration> Datastore and Customizations.
  2. Click Extended Datastore Settings > Configure Mounts.
  3. Click NFSv4 MountsAdd NFSv4 Mount.
  4. On the Configure NFSv4 Mount page, enter the following information:
    • Mount Name: A name for the mount; for example, EXDS.
    • Remote Share Path: The path for the mount in the following format:

      host:/mountpoint

      For example, herring:/mnt/extended-datastore

  5. From the Authentication drop-down, select an authentication type:
    • None
    • Kerberos: For krb5 security.
    • Kerberos (Secure Auth and Data Integrity): For krb5i security.
    • Kerberos (Secure Auth, Data Integrity, Privacy): For krb5p security.
  6. Click Save.

Add a CIFS Mount

To add a CIFS mount:

  1. Click System Configuration > Datastore and Customizations.
  2. Click Extended Datastore Settings > Configure Mounts.
  3. Click CIFS Mounts > Add CIFS Mount.
  4. On the Configure CIFS Mount page, enter the following information:
    • Mount Name: A name for the mount; for example, EXDS_CIFS
    • Remote Share Path: The path for the share in the following format:

      \\host\mountpoint

      For example:

      \\herring\extended-datastore

    • Domain: The site domain.
  5. If password protection is required, enter the following information:
    • On the Authentication drop-down, select password.
    • Complete the User and Password fields.
  6. Click the Save button.
Configure the Datastores

You can configure up to three active datastores—one for each cycle—and organize them as desired. For example, you can have three datastores on one share, or two datastores on one share and a third datastore on a second share.

After you have added a mount, you can configure the extended datastore to do one of the following:

When you configure the datastore, note the following conditions:

  • Only one ExtraHop appliance can write to a single external datastore at a time. However, one or more ExtraHop appliance can read simultaneously from a single external datastore if it is not being written to at the same time.
  • If an extended datastore contains multiple files with overlapping time stamps, metrics will be incorrect.
  • The ExtraHop appliance cannot read metrics committed to the extended datastore by a later ExtraHop appliance firmware version.
Add Storage Space

After you mount an NFS or CIFS share, you can connect your ExtraHop appliance to use this share as an extended datastore. To add storage that you plan to actively use:

  1. Click System Configuration > Datastore and Customizations.
  2. Click Extended Datastore Settings > Configure Extended Datastore.
  3. On the Configure Extended Datastore page, click the name of the mount you want to add storage space to and complete the Datastore Directory field.
  4. By default, the system records 24-hour metrics. Click the checkbox to also record 5-minute and 1-hour metrics.
  5. Select the Move existing radio button.
  6. Check the Overwrite checkbox to overwrite older data when the drive is full.
  7. Click Configure. After the storage is added,  the Status reads "Nominal".
Upgrade Your System

After you mount an NFS or CIFS share, you can update your ExtraHop appliance and import your existing metrics to that new ExtraHop appliance. To upgrade to a new ExtraHop appliance:

  1. On the old ExtraHop appliance (ExtraHop A), write the metrics to an external store using the previous procedure, Add Storage Space.
  2. On ExtraHop A:
    1. Click System ConfigurationDatastores and Customizations.
    2. Click Extended Datastore Settings > Configure Extended Datastore.
    3. Click Disconnect Extended Datastore.
    4. Type YES in the confirmation text box and click OK.
  3. On the new ExtraHop appliance (ExtraHop B):
    1. Click Configuration > Datastore and Customizations.
    2. Click Extended Datastore Settings > Import Metrics from External Datastore.
    3. Click the name of the datastore directory that you configured for ExtraHop A, then click Import Metrics.
    4. Type YES in the confirmation text box and click OK.
Archive Data

After you mount an NFS or CIFS share, you can archive the data from your extended datastore for long-term storage. This procedure assumes you have an extended datastore that is full and you want to archive it.

To back up the extended datastore for long-term archiving:

  1. Click System Configuration > Datastore and Customizations.
  2. Click Extended Datastore Settings > Configure Extended Datastore.
  3. On the Configure Extended Datastore page, click name of the mount you want to archive to.
  4. Complete the Datastore Directory field.
  5. Click Configure as > Archive (Read Only).
  6. Click Configure.
Disconnect an Extended Datastore

You can disconnect or unmount an extended datastore at any time without losing the ExtraHop data on the datastore. Disconnecting a datastore removes it from use but does not erase it.

To disconnect an extended datastore:

  1. Click System Configuration > Datastore and Customizations.
  2. Click Extended Datastore Settings > Configure Extended Datastore.
  3. On the Configure Extended Datastore page, click the name of the mount you want to remove, then click Disconnect Extended Datastare.
  4. Type YES to confirm the removal and click the OK button.
Note: If you are migrating 5-minute and 1-hour metrics from one ExtraHop system to another, you must perform a system reset on the target ExtraHop system. The internal datastore on the target ExtraHop system must be empty before data is imported from the external datastore.
Monitor Storage Space

When the datastore is almost full, a warning appears at the top of the Systems Settings page.

You can configure the system to send email messages based on the level of severity when the datastore space becomes limited. For more information, see the Notifications section.

Status Messages

The Status row for each mount and external datastore displays status information about each device or connection.

Mounts

Status Description User Action
Mounted The mount configuration was successful. None required
NOT MOUNTED The mount configuration was unsuccessful.
  • Verify the mount configuration information for accuracy and correct spelling.
  • Verify that the remote system is available.
  • Verify that the server is a supported type and version.
  • Verify credentials, if using authentication.
NOT READABLE The mount has permissions or network-related issues that prevent reading.
  • Verify the correct permissions are set on the share.
  • Verify the network connection and availability.
NO SPACE AVAILABLE The mount has no space remaining. Detach the mount and create a new one.
INSUFFICIENT SPACE
  • First appearance: The system anticipates that not enough space is available.
  • Second appearance: Less than 128MB of space is available.
Detach the mount and create a new one.
AVAILABLE SPACE WARNING Less than 1GB of space is available. Detach the mount and create a new one.
NOT WRITEABLE The mount has permissions or network-related issues that prevent writing.
  • Check permissions.
  • Check network connection and availability.

Datastores

Status Description User Action
Nominal The datastore is in a normal state. None required
INSUFFICIENT SPACE on: <MOUNT NAME> The datastore has insufficient space on the named mount and it cannot be written to. Create a new datastore. For the new datastore, consider using the Overwrite option, if appropriate.
NOT READABLE The datastore has permissions or network-related issues that prevent reading. Check permissions.
Check network connection and availability.
NOT WRITEABLE The datastore has permissions or network-related issues that prevent writing. Check permissions.
Check network connection and availability.

Customizations

 

View Saved Customizations

On this page, you can restore the configuration settings of a previous datastore and download configuration settings to your workstation.

Restore Datastore Customizations

Datastore configuration settings can be saved and, if necessary, saved settings can be used to restore the datastore to the last saved state.

Note: Restoring customizations does not create new devices; it associates the customized names to the devices found by the ExtraHop appliance. If a device has not been found, then the customized name is not restored. You can select Restore Customizations again to restore those same customizations. Restoring customizations does not overwrite any new customizations, but it overwrites any modified customized values.

To restore the ExtraHop datastore:

  1. Click System Configuration > Datastore and Customizations.
  2. Click Customizations > View Saved Customizations.
  3. Click Restore next to the customizations you want to restore in either the Saved Customizations or the Automatically Saved Customizations list.
  4. Click OK to restore the datastore.
  5. Click OK again.
Download Datastore Customizations

You can download the current datastore configuration settings into a .json archive file that can be stored on your workstation. This archive file can be used to restore the datastore settings on the originating ExtraHop appliance, if problems occur. In addition, these settings can be uploaded to specify the datastore configuration settings in a new ExtraHop appliance.

To download the ExtraHop datastore customization settings to an external file:

  1. Click System Configuration > Datastore and Customizations
  2. Click Customizations > View Saved Customizations.
  3. Click on the name of the saved customization that you want to download and the file will download to your browser's default download location.
Save Customizations

The ExtraHop appliance lets you save the current datastore configuration settings and store them in memory. These saved configuration settings can be used at a later date to restore the datastore to the saved state.

Save the Current Datastore Customizations

To save the current ExtraHop appliance datastore customizations:

  1. Click System Configuration > Datastore and Customizations.
  2. Click Customizations > Save Customizations.
  3. Click OK.
Upload and Restore Customizations

ExtraHop appliance datastore configuration can be exported and saved as a .json archive file. The datastore customization file can be uploaded to the ExtraHop appliance to restore customization settings on the original system or install datastore customization settings on a new ExtraHop appliance.

Note: Restoring customizations does not create new devices; it associates the customized names to the devices found by the ExtraHop appliance. If a device has not yet been found, then the customized name is not restored. Restoring customizations does not overwrite any new customizations, but it overwrites any modified customized values.
Upload and Restore Datastore Customizations

To upload and restore ExtraHop appliance datastore customizations:

  1. Click System Configuration > Datastore and Customizations
  2. Click Customizations > Upload and Restore Customizations.
  3. On the Upload and Restore Customizations page, click Choose File, navigate to the datastore customization file that you want to upload and click Open.
  4. Click Restore.
  5. When the file is finished uploading, click OK.

Open Data Streams

The Open Data Streams page provides an interface to send data to external systems.

The ExtraHop Admin UI includes the following controls to manage open data streams:

  • Syslog Systems: Send data to a specified syslog.
  • MongoDB: Send data to a MongoDB database.
  • HTTP: Send data to a remote HTTP server.
  • Kafka: Send data to a Kafka server.

Open Data Stream for Syslog Systems

Open data streams for syslog systems enables you to send data from the ExtraHop appliance to any system that receives syslog input (e.g., Splunk, ArcSight, Q1 Labs, etc.) for long-term archiving and correlation with other sources.

Configure Open Data Stream for Syslog

To configure open data streams for syslog systems:

  1. Under System Configuration, click Open Data Streams.
  2. Click Syslog Systems.
  3. Click Add New.
  4. In the Data Stream Configuration section, enter the following information:
    • Name: A friendly name for this configuration.
    • Host: The hostname or IP address of your syslog server.
    • Protocol: From the drop-down, select the protocol you want to use to send syslog information.
    • Port: The port number of your syslog server. By default, this is set to 514
    • Local Time: Check this checkbox if you want syslog information sent with timestamps in the local time of the ExtraHop appliance.
  5. (Optional) Click See Details to view diagnostics for this ODS configuration.
  6. (Optional) Click Test Settings.
  7. Click Save.
Delete a Data Stream Configuration

To delete a saved data stream configuration, click Delete, and then click Save.

Open Data Stream for MongoDB

The MongoDB export enables you to send data from the ExtraHop appliance to any system that receives MongoDB input for long-term archiving and correlation with other sources.

Configure Open Data Stream for MongoDB:

To configure open data streams for MongoDB:

  1. Under System Configuration, click Open Data Streams.
  2. Click MongoDB.
  3. Click Add New.
  4. In the Data Stream Configuration section, enter the following information:
    • Name: A friendly name for this configuration.
    • Host: The hostname or IP address of the remote MongoDB server.
    • Port: The port number of your remote MongoDB server. By default, the port is set to 27017.
    • Maximum Message Size (KB): The maximum message size to send to the remote MongoDB server. By default, this is set to 4096.
    • Encryption: From the drop-down menu, select your encryption choice.
    • Skip Certificate Verification: Check this checkbox if you want to trust certificates from unrecognized certificate authorities.
    • Users: Enter the following information for at least one user with permissions to write to the MongoDB server and click Add User:
      • Database: The name of the MongoDB database to send data to.
      • Username: The MongoDB username to use to write to the database.
      • Password: The password of the MongoDB user.
  5. (Optional) Click See Details to view diagnostics for this ODS configuration.

    The following values are recorded for diagnostic purposes:

    • Acivity since: Displays the UNIX timestamp when data collection began. This value is automatically reset every 24 hours.
    • Queue Full (Requests Dropped): Displays the number of requests dropped because the ExtraHop dispatch queue was full.
    • MongoDB Session Errors: Displays the number of session errors received from MongoDB.
    • I/O Errors: Displays the number of times the ODS MongoDB client attempted to send a request to the specified target, but the connection was refused or the target did not respond.
  6. (Optional) Click Test Settings.
  7. Click Save.
Configure a User for MongoDB Open Data Stream

To configure a user:

  1. In the Users section of the data stream configuration, type the following information:
    • Database: The name of the MongoDB to send data to.
    • Username: The MongoDB username used to write to the database.
    • Password: The password of the MongoDB user.
  2. Click Add User.
  3. Click Save.
Delete a Data Stream Configuration

To delete a saved data stream configuration, click Delete, and then click Save.

Open Data Stream for HTTP

The Open Data Stream (ODS) for HTTP export enables you to send data from the ExtraHop appliance to a remote HTTP server for long-term archiving and correlation with other sources. You can add up to 16 HTTP servers

HTTP requests from triggers are queued for processing by an ODS HTTP client. Note that the ODS HTTP client does not return the result of a request to the trigger that originated it. The architecture of the trigger subsystem does not allow the client to receive the result of the request it initiates.

Configure Open Data Stream for HTTP

To configure open data streams for HTTP:

  1. Under System Configuration, click Open Data Streams.
  2. Click HTTP.
  3. Click Add New.
  4. In the Data Stream Configuration section, enter the following information:
    • Name: Type a friendly name for this configuration. The Data Stream Configuration #1 name is default and cannot be changed.
    • Type: From the drop-down, select the type of protocol to use to send information.
    • Host: The hostname or IP address of the remote server.
    • Port: The port number of your server. By default, this is set to 8080.
    • Pipeline Requests: Check this checkbox to improve performance.
    • Use Basic Authentication: Check this checkbox if you want to use authentication. If this is selected, enter the following information:
      • User: The name of the user to authenticate with.
      • Password: The password for that user.
    • Additional HTTP Header: An additional HTTP header to include.
    • Signing Method: From the drop-down, select an optional signing method, either Amazon AWS or Microsoft Azure.
  5. (Optional) Click See Details to view diagnostics for this ODS configuration.

    The following values are recorded for diagnostic purposes:

    • Activity since: Displays the UNIX timestamp when data collection began. This value is automatically reset every 24 hours.
    • Requests: Displays the number of requests the ODS HTTP client attempted to send.
    • Queue Full (Requests Dropped): Displays the number of requests dropped because the ExtraHop dispatch queue was full.
    • Discarded Headers: The ODS HTTP client does not allow triggers to specify the following headers:
      • Connection
      • Authorization
      • Proxy-Connection
      • Content-Length
      • X-Forwarded-For
      • Transfer-Encoding

      If any of these headers are set, the ODS HTTP client will discard them.

    • I/O Errors: Displays the number of times the ODS HTTP client attempted to send a request to the specified target, but the connection was refused, the target did not respond, or the target did not respond in a way that an HTTP server is expected to respond.
    • Response Status: Displays the count of each response status code received.
  6. (Optional) Click Test Settings.
  7. Click Save.
Delete a Data Stream Configuration

To delete a saved data stream configuration, click Delete, and then click Save.

Open Data Stream for Kafka

You can export data from the ExtraHop appliance to any Kafka server for long-term archiving and correlation with other sources.

Configure Open Data Stream for Kafka

To configure open data streams for Kafka:

  1. Under System Configuration, click Open Data Streams.
  2. Click Kafka.
  3. Click Add New.
  4. In the Data Stream Configuration section, enter the following information:
    • Name: A friendly name for this configuration.
    • Compression: From the drop-down, select a compression choice.
    • Partition Strategy: From the drop-down, select your partition strategy choice.
    • Brokers: Enter the following information for each Kafka broker you want to add:

      Note: You must add at least one broker but you can add multiple brokers that are part of the same Kafka cluster to ensure connectivity in case a single broker is unavailable. All brokers must be part of the same cluster.

      1. Host: Enter the hostname or IP address of your Kafka broker.
      2. Port: Enter the port of your Kafka broker.
      3. Click Add Broker.
  5. (Option) Click See Details to view diagnostics for this ODS configuration.
  6. (Optional) Click Test Settings.
  7. Click Save.
Delete a Data Stream Configuration

To delete a saved data stream configuration, click Delete, and then click Save.

Capture

The Admin UI provides an interface to manage the ExtraHop appliance network capture settings. For example, by default the ExtraHop appliance is configured to discover devices by their MAC address, maintaining a one-to-one correspondence between the MAC address and the discovered device. Using the Capture Configuration settings, this method of discovery can be changed so that devices are discovered by IP address.

The network capture settings give ExtraHop appliance administrators the ability to fine-tune the network capture so that the Discover appliance discovers devices in the best and most complete method possible, based on the host networking environment.

Note: Capture settings are not configurable when using the Command appliance.

The ExtraHop Admin UI includes controls to manage the following network capture settings:

  • Excluded Protocol Modules: Specify protocols and associated devices that should be excluded from the network capture.
  • MAC Address Filters: Determine which devices are discovered by MAC address.
  • IP Address Filters: Determine which devices are discovered by IP address.
  • Port Filters: Enable TCP and UDP ports.
  • Pseudo Devices: Identify individual devices (that have IP addresses outside the monitored domains) that normally are shown in the capture only as the router address.
  • Protocol Classification: Add custom protocols to the capture and associate these custom protocols with ExtraHop module protocols.
  • Discover by IP: Enable or disable the discovery of devices on the network capture by IP address rather than by MAC address.
  • SSL Decryption: Add and manage SSL decryption keys to decrypt SSL traffic on the network.
  • Open Data Context API: Access the session table with the ExtraHop system acting as a memcache server.
  • Software Tap: Capture traffic using a high-speed packet forwarder (RPCAP).
  • Network Overlay Decapsulation: Enable or disable the network overlay decapsulation for NVGRE and VXLAN protocols.

Excluded Protocol Modules

The Excluded Protocol Modules page provides an interface to manage the protocols that you want to include in the network capture. By default, all supported modules on the ExtraHop appliance are included in the capture unless you manually exclude them.

Note: Capture settings are not configurable when using the Command appliance.

Exclude Protocol Modules

To exclude a protocol module from the network capture:

  1. Click System Configuration > Capture.
  2. Click Excluded Protocol Modules.
  3. Add Module to Exclude.
  4. On the Select Protocol Module to Exclude page, from the Module Name drop-down, select the module that you want to exclude from the capture.
  5. Click Add.
  6. On the Excluded Protocol Modules page, click Restart Capture.
  7. After the capture restarts, click OK.
Re-Include Excluded Protocol Modules

To re-include a previously excluded protocol module:

  1. Click System Configuration > Capture.
  2. Click Excluded Protocol Modules.
  3. On the Excluded Protocol Modules page, click Delete next to the module name for each module you want to re-include.
  4. Click Restart Capture.
  5. After the capture restarts, click OK.

MAC Address Filters

You can use filters to exclude specific MAC addresses or vendor device traffic from the network capture on the Discover appliance.

Note: Capture settings are not configurable when using the Command appliance.

For more information, see the Filtering and Deduplication section.

Exclude MAC addresses

To exclude a MAC address:

  1. Click System Configuration > Capture.
  2. Click MAC Address Filters.
  3. Click Add Filter.
  4. On the MAC Address Filters page, enter the following information for the MAC address or set of addresses you want to exclude:

    Note: You cannot use both filters at the same time. Use MAC Address to provide a specific MAC address to match and filter. Use Mask to provide a MAC address mask to filter ranges or sets of MAC addresses.

    • MAC Address: The MAC address to exclude. Enter an individual MAC address here if you want to filter an exact match.
    • Mask: The mask to use to filter non-exact match addresses.
  5. Click Add.
Re-Include Excluded MAC addresses

To re-include a MAC address that was previously excluded:

  1. Click System Configuration > Capture.
  2. Click MAC Address Filters.
  3. On the MAC Address Filters page, click Delete next to the MAC address filter for each address you want to re-include.
  4. Click OK.

IP Address Filters

You can use filters to exclude specific IP addresses and IP ranges from the network capture on the ExtraHop appliance.

Note: Capture settings are not configurable when using the Command appliance.

For more information, see the Filtering and Deduplication section.

Exclude an IP Address or Range

To exclude an IP address or range:

  1. Click System Configuration > Capture.
  2. Click IP Address Filters.
  3. Click Add Filter.
  4. On the IP Address Filters page, enter either a single IP address you want to exclude, or an IP address mask in CIDR format for a range of IP addresses you want to exclude.
  5. Click Add.
Re-Include an Excluded IP Address or Range

To re-include an IP address or range that was previously excluded:

  1. Click System Configuration > Capture.
  2. Click IP Address Filters.
  3. On the IP Address Filters page, click Delete next to the IP addresses or ranges you want to re-include.
  4. >Click OK.

Port Filters

You can use filters to exclude traffic from specific ports from the network capture on the Discover appliance.

Note: Capture settings are not configurable when using the Command appliance.

For more information, see the Filtering and Deduplication section.

Exclude a Port

To exclude a port:

  1. Go to the Configuration section and click Capture.
  2. On the Capture Configuration page, click Port Filters.
  3. Click Add Filter.
  4. On the Port Address Filters page, enter the following information:
    • Source Port: The source port you want to exclude

      Or

      Destination Port: The destination port you want to exclude.
    • IP Protocol: From the drop-down list, select the protocol you want to exclude on the indicated port.
  5. Click Add.
Re-Include an Excluded Port

To re-include a previously excluded port:

  1. Click System Configuration > Capture.
  2. Click Port Filters.
  3. On the Port Address Filters page, click Delete next to the port you want to re-include.
  4. Click OK.

Filtering and Deduplication

Refer to the following table to view the effects of filtering and deduplication on metrics, packet capture, and device discovery.

Packet Dropped by MAC address filter IP address filter Port filter L2 dedup L3 dedup
Network VLAN L2 Metrics Not collected Not collected
  • Not fragmented*: Not collected
  • Fragmented: Collected
Not collected Collected
Network VLAN L3 Metrics Not collected Not collected
  • Not fragmented: Not collected
  • Fragmented: Collected
Not collected Collected
Device L2/L3 Metrics Not collected Not collected
  • Not fragmented: Not collected
  • Fragmented, top-level: Collected
  • Fragmented, detail: Not collected
Not collected Collected
Global PCAP Packets Captured Captured Captured Captured Captured
Precision PCAP Packets Not captured Not captured Not captured Not captured Not captured
L2 Device Discovery No discovery Discovery Discovery -- --
L3 Device Discovery No discovery No discovery
  • Not fragmented: No discovery
  • Fragmented: Discovery
-- --

*For port filters, when IP fragments are present in the data feed, a port number is not determined during fragment reassembly. The ExtraHop appliance might collect metrics, capture packets, or discover a device even if the port filtering rule otherwise precludes it.

L2 duplicates are identical Ethernet frames. The duplicate frames do not usually exist on the wire, but are an artifact of the data feed configuration. L3 duplicates are frames that differ only in L2 header and IP TTL. These frames usually result from tapping on both sides of a router. Because these frames exist on the monitored network, they are counted at L2 and L3 in the locations referenced above. L3 deduplication is targeted toward L4 and above, for example, to avoid counting the L3 duplicates as TCP retransmissions.

Deduplication is enabled by default in newly installed ExtraHop appliance (firmware version 4.0.21268+). You can enable deduplication in earlier versions by adding capture settings to the Running Config. Contact ExtraHop Support for more information.

Pseudo Devices

By default, all IP addresses outside the locally-monitored broadcast domains are aggregated at one of the incoming routers. To identify the devices behind these routers, you can use the pseudo devices settings in the capture to enable reporting on these devices.

Note: Custom devices in version 4.0 and later take the place of pseudo devices. Unlike pseudo devices, you do not need Administrator privileges to configure custom devices. If you have previously created pseudo devices, they will remain on your ExtraHop appliance until you migrate them to custom devices. For more information, go to the ExtraHop Web UI, click Help, and refer to the ExtraHop Web UI Guide.

Note: Capture settings are not configurable when using the Command appliance.

Specify a Pseudo Device

To configure the pseudo devices settings:

  1. Click System Configuration >Capture.
  2. Click Psuedo Devices.
  3. Click Add Device.
  4. On the Add Pseudo Devices page, enter the following information:
    • IP Address: The IP address range for the device in CIDR notation.

      IP Address/subnet prefix length

      For example, 10.10.0.0/16 for IPv4 networks or 2001:db8::/32 for IPv6 networks.

    • MAC: A dummy MAC address for the device.
  5. Click Add.

Note: To monitor remote locations with multiple, non-contiguous subnets, specify the pseudo device multiple times with the same dummy MAC but with different IP subnets. For example, in the figure below, all traffic relating to any of the IP subnets assigned is attributed to the pseudo device with the MAC address 22:22:00:00:00:01.

Remove Pseudo Devices

To remove pseudo devices:

  1. Click System Configuration >Capture.
  2. Click Psuedo Devices.
  3. On the Pseudo Devices page, click Delete next to the pseudo device you want to remove from the list.
  4. Click OK.

Protocol Classification

Protocol classification relies on specific payloads to identify custom protocols that use specific ports. These protocols are Layer 7 (application-layer) protocols that sit above the Layer 4 (TCP or UDP) protocol. These applications have their own custom protocol, and they also use the TCP protocol.

The Protocol Classification page provides an interface to perform the following functions:

  • List applications and ports for the following network entities:
    • Widely-known applications that are mapped to non-standard ports.
    • Lesser-known and custom networking applications.
    • Unnamed applications that use TCP and UDP (for example, TCP 1234).
  • Add custom protocol-to-application mapping that includes the following information:
    • Name: The user-specified protocol name.
    • Protocol: The selected Layer 4 protocol (TCP or UDP).
    • Source: (Optional) The specified source port. Port 0 indicates any source port.
    • Destination: The destination port or range of ports.
  • Delete protocols with the selected application name and port mapping from the list.

    The application name and port do not display in the ExtraHop Web UI or in reports based on any future data capture. The device will appear in reports that use historical data, if the device was active and discoverable within the reported time period.

  • Restart the network capture.
    • You must restart the network capture before any protocol classification changes take effect.
    • Previously-collected capture data is preserved.

The ExtraHop appliance recognizes protocols on their standard ports (one exception is HTTP, which is recognized on any port). In some cases, if a protocol is using a non-standard port, it is necessary to add the non-standard port in the Admin UI. In these cases, it is important to properly name the non-standard port. The table below lists the standard ports for each of the protocols, along with the protocol name that must be used when adding the custom port numbers in the Admin UI.

In most cases, the name you use is the same as the name of the protocol. The most common exceptions to this rule are Oracle (where the protocol name is TNS) and Microsoft SQL (where the protocol name is TDS).

Canonical Name Protocol Name Transport Default Source Port Default Destination Port
CIFS CIFS TCP 0 139, 445
DB2 DB2 TCP 0 50000, 60000
Diameter AAA TCP 0 3868
FIX FIX TCP 0 0
FTP FTP TCP 0 21
FTP-DATA FTP-DATA TCP 0 20
HL7 HL7 TCP 0 2575
HL7 HL7 UDP 0 2575
IBM MQ IBMMQ TCP 0 1414
IBM MQ IBMMQ UDP 0 1414
ICA ICA TCP 0 1494, 2598
Informix Informix TCP 0 1526, 1585
iSCSI iSCSI TCP 0 3260
LDAP LDAP TCP 0 389, 390
LLDP LLDP Link Level N/A N/A
Memcache Memcache TCP 0 11210, 11211
MongoDB MongoDB TCP 0 27017
MS SQL Server TDS TCP 0 1433
MSRPC MSRPC TCP 0 135
MySQL MySQL TCP 0 3306
NFS NFS TCP 0 2049
NFS NFS UDP 0 2049
Oracle TNS TCP 0 1521
PCoIP PCoIP UDP 0 4172
PostgreSQL PostgreSQL TCP 0 5432
RADIUS AAA TCP 0 1812, 1813
RADIUS AAA UDP 0 1645, 1646, 1812, 1813
SIP SIP TCP 0 5060, 5061
SMPP SMPP TCP 0 2775
SMTP SMTP TCP 0 25
Sybase Sybase TCP 0 10200
SybaseIQ SybaseIQ TCP 0 2638

The name specified in the Protocol Name column in the table is used on the Protocol Classification page to classify a common protocol that uses non-standard ports.

Protocols in the ExtraHop Web UI that do not appear in this table include the following:

  • DNS: The standard port for DNS is 53. DNS does not run on non-standard ports.
  • HTTP: The ExtraHop appliance classifies HTTP on all ports.
  • HTTP-AMF: This protocol runs on top of HTTP and is automatically classified.

Protocols in this table that do not appear in the ExtraHop Web UI include the following:

  • FTP-DATA: The ExtraHop appliance does not handle FTP-DATA on non-standard ports.
  • LLDP: This is a link-level protocol, so port-based classification does not apply.
Add a Custom Protocol Classification

The following procedure describes how to add custom protocol classification labels using the TDS (MS SQL Server) protocol as an example. By default, the ExtraHop appliance looks for TDS traffic on TCP port 1533.

To add MS SQL Server TDS parsing on another port:

  1. Click System Configuration > Capture.
  2. Click Protocol Classification.
  3. Click Add Protocol.
  4. On the Protocol Classification page, enter the following information:
    • Name: From the drop-down, select Add custom label....
    • Name: Enter TDS for the custom protocol name.
    • Protocol: From the drop-down, select an L4 protocol to associate with the custom protocol (TCP in this example).
    • Source: The source port for the custom protocol. (The default value of 0 specifies any source port.)
    • Destination: The destination port for the custom protocol. To specify a range of ports, put a hyphen between the first and last port in the range. For example, 3400-4400.
    • Loose Initiation: Check this checkbox if you want the classifier to attempt to categorize the connection without seeing the connection open. ExtraHop recommends using loose initiation for long-lived flows.

      By default, the ExtraHop appliance uses loosely-initiated protocol classification, so it attempts to classify flows even after the connection was initiated. You can turn off loose initiation for ports that do not always carry the protocol traffic (for example, the wildcard port 0).

  5. Click Add.
  6. Confirm the setting change, and then click Restart Capture for the change to take effect. This will briefly interrupt the collection of data.
  7. After the capture restarts, a confirmation message appears. Click Done.
  8. This change has been applied to the running config. When you save the change to the running config, it will be reapplied when the ExtraHop appliance restarts. Click View and Save Changes at the top of the screen.
  9. Click Save to write the change to the default configuration.
  10. After the configuration is saved, a confirmation message appears. Click Done.

Database statistics now appear for any devices running TDS on the added port (in this example, 65000). This setting is applied across the capture, so you do not need to add it on a per-device basis.

Remove a Custom Protocol Classification

To remove custom protocols from the list:

  1. Click System Configuration > Capture.
  2. Click Protocol Classification.
  3. On the Protocol Classification page, click Delete next to the protocol that you want to remove from the list.
  4. Click OK.

  5. This change has been applied to the running config. When you save the change to the running config, it will be reapplied when the ExtraHop system restarts. Click View and Save Changes at the top of the screen.
  6. Click Save to write the change to the default configuration.
  7. After the configuration is saved, a confirmation message appears. Click Done.

Discover by IP

The ExtraHop appliance analyzes its incoming data feed to identify the devices that are communicating on the monitored network. This identification process is known as device discovery.

You can configure the ExtraHop appliance to approach device discovery in one of two ways:

  • Discovery by L3, or IP address (Default)
  • Discovery by L2, or MAC address
L3 Discovery Mode

In the default L3 discovery mode, the ExtraHop appliance recognizes a new device for each observed IP address that meets the following criteria:

  • A device responds to an Address Resolution Protocol (ARP) request for the IP address, allowing the ExtraHop appliance to associate the IP address with an L2 (MAC) address.
  • The associated MAC address is not the MAC address of an L3-routing device. The ExtraHop appliance uses heuristics for determining whether traffic having a particular MAC is a routing device.

In cases where multiple IP addresses meet the above criteria while sharing a MAC address (e.g., multi-homed NICs), each IP is discovered as a separate device.

When L3 discovery mode is used, in addition to the discovered L3 Devices, the ExtraHop appliance also creates L2 Devices for each unique MAC address. The following characteristics apply to these L2 devices:

  • When an L2 and L3 address are associated with the same device, a parent-child relationship is shown in the detail page for each device.
  • Any L2 traffic metrics that cannot be associated with a particular child L3 device (for example, L2 broadcast traffic) are associated with the parent L2 device.
  • In the device list view, you can filter the full device list for L2 devices only, L3 devices only, or all devices.
  • L2 devices that exist solely as parents to L3 devices do not count against licensed device count limits.

IP addresses in the data feed that do not appear to have an associated MAC address are generally located remotely beyond an L3-routing device and are not auto-discovered. However, discovery of a new device can be forced in the Remote Networks section.

The following diagram shows L3 device discovery in three common server NIC configurations.

L3 Discovery on Remote Networks

Remote networks are subnets visible to ExtraHop only via L3-routing devices. By default, the ExtraHop appliance does not discover and monitor devices on these networks. Adding these networks in the Remote Networks section configures the ExtraHop appliance to treat individual devices on remote networks as if they were part of the local network.

The following scenarios use the remote networks setting to discover devices:

  • An organization has a remote office without an on-site ExtraHop appliance but users at that site access central datacenter resources that are directly monitored by an ExtraHop appliance. The IP addresses at the remote site can be discovered as devices.
  • A cloud service or other type of off-site service hosts remote applications and has a known IP address range. The remote servers within this IP range can be individually tracked.

In the ExtraHop Administration UI, remote networks are designated by network addresses specified in CIDR notation (network IP address / subnet prefix length). For example, for IPv4 networks, the network identifier is written as 192.168.0.0/16. For IPv6 networks, the network identifier is written as 2001:db8::/32.

The following characteristics apply to remote network discovery:

  • The Local Network checkbox must be checked on the Discover by IP page to make remote networks available.
  • Remote networks are configured manually so the ExtraHop appliance does not require ARP traffic for their discovery.
  • Every actively communicating remote IP that matches a remote network's CIDR block will result in the discovery of one device in the ExtraHop appliance. Specifying wide subnet prefixes such as /16 might result in the discovery of a large number of devices. A /32 subnet prefix might be used to match a single remote IP.
  • Devices discovered by remote networks discovery count against licensed device count limits.

The following limitations apply to remote network discovery:

  • Private IP addresses, such as those on a private subnet (behind a router) or those that are behind a NAT device, are not visible. Only the public-facing IP addresses are discovered and visible in the ExtraHop appliance.
  • L2 information, such as the device's MAC address and L2 traffic, is not available if the device is on a different network from the one being monitored by the ExtraHop appliance. This information is not forwarded by routers, and therefore it is not visible to the ExtraHop appliance.
L2 Discovery Mode

You can also configure the ExtraHop appliance to discover devices using L2 discovery mode. In this mode, instead of an IP address acting as the basis for defining a new device, a MAC address is used. All IP addresses associated with a given MAC address are aggregated into a single device.

L2 discovery mode was once the default, but it is no longer common. If you feel that your ExtraHop deployment might benefit from the use of L2 discovery mode, contact ExtraHop Support at support@extrahop.com for further assistance.

Configure the Discovery Mode

To select the discovery mode and optionally configure remote network discovery:

  1. Click System Configuration > Capture.
  2. Click Discover by IP.
  3. On the Discover by IP page, in the Local Network section, do one of the following:
    • Check the Enable checkbox to turn on device discovery by IP address (L3 discovery).
    • OR

    • Uncheck the Enable checkbox to turn on device discovery by MAC address (L2 discovery).
  4. To configure remote network discovery, in the Remote Networks field, specify the remote network address in CIDR format and click Add.
  5. Click Save and Restart Capture.
  6. Click Done.
    Note: ExtraHop recommends performing a datastore reset after enabling or disabling Discover by IP. Clearing the datastore protects against potential problems, such as redundant data.

SSL Decryption

The ExtraHop appliance supports real-time decryption of SSL traffic for analysis. To use this feature, private keys associated with the SSL server certificate must be provided. The server certificate and private keys are uploaded over an HTTPS connection from a web browser to the ExtraHop appliance.

You can add the following keys to the ExtraHop appliance to facilitate SSL traffic decryption.

  • PEM certificates and RSA private keys
  • PKCS#12/PFX files with passwords
    Note: The PKCS#12/PFX files are archived in a secure container that contains both public and private certificate pairs and requires a password to access.

After upload, the private keys are stored on the internal USB flash media. All file systems on the internal USB flash media are obfuscated and cannot be mounted using standard tools. The private keys are stored in an encrypted format. To ensure that the keys are not transferable to other systems, they are encrypted with an internal key that is seeded with information specific to the system to which it was uploaded.

Separation of privileges is enforced such that only the SSL decryption process can access the private key material. The ExtraHop web administration utility can store new private keys and list the keys in the store for key management purposes, but cannot access the private key material after it is stored.

To export a password-protected key, use a utility such as OpenSSL:

openssl rsa -in yourcert.pem -out new.key

The Add Encrypted Protocol section specifies the protocols that handle decrypted SSL traffic. For example, for DNS traffic, you must create an entry for the DNS protocol on port 53. Port 0 represents any port.

Configure SSL Decryption

To configure the SSL decryption settings with a PEM Certificate and Private Key:

  1. Click System Configuration >Capture.
  2. Click SSL Decryption.
  3. In the SSL Decryption Keys section, click Add Keys.
  4. In the Add PEM Certificate and RSA Private Key section, enter the following information:
    1. Name: A friendly name for the added key.
    2. Enabled: Uncheck this checkbox if you do now want to enable this SSL certificate.
    3. Certificate: The public key certificate information.
    4. Private Key: The RSA private key information.
    5. Click Add.

To add PKCS#12/PFX files with passwords to the ExtraHop appliance:

  1. Click System Configuration > Capture.
  2. Click SSL Decryption.
  3. In the SSL Decryption Keys section, click Add Keys.
  4. In the Add PKCS#12/PFX File With Password section, enter the following information:
    1. Description: A friendly name for the added key.
    2. Enabled: Uncheck this checkbox if you don't want to enable this SSL certificate.
    3. PKCS#12/PFX file: Click Choose File and browse to the file, select it, and click Open.
    4. Password: The password for the PKCS#12/PFX file.
    5. Click Add.
    6. Click OK.
Add Encrypted Protocols

To add encrypted protocols to the ExtraHop appliance:

  1. Click System Configuration > Capture.
  2. Click SSL Decryption.
  3. In the Encrypted Protocols section, click Add Protocol.
  4. On the Add Encrypted Protocol page, enter the following information:
    • Protocol: From the drop-down list, select the protocol you want to add.
    • Key: From the drop-down, select a previously set key.
    • Port: The source port for the protocol. By default this is set to 443, which specifies HTTP traffic.
  5. Click Add.

Open Data Context API

The Open Data Context API allows external access to the global session table. Clients can store and retrieve key-value pairs using the memcache protocol.

For example, a script running on an external host inserts CPU load information into the ExtraHop session table. Triggers commit this information and other HTTP transactions as custom metrics. The script running on the external host can use any memcache client, and then use memcache commands, such as GET, SET, and INCREMENT, to communicate with the ExtraHop appliance.

When using the Open Data Context API, remember the following:

  • Committing large values to the session table causes performance degradation. Values can be almost unlimited in size. However, metrics committed to the datastore must be 4096 bytes or fewer.
  • All data must be inserted as strings to be readable by the ExtraHop appliance.
  • Keys expire at 30-second intervals. For example, if a key is set to expire in 50 seconds, it might take anywhere from 50 to 79 seconds to expire.
  • All keys set in the Open Data Context API are exposed via the SESSION_EXPIRE trigger event as they expire. This behavior is in contrast to the Application Inspection Triggers API, where the default behavior is not to expose expiring keys via SESSION_EXPIRE.

Note: This connection is not encrypted and should not be used to exchange sensitive information.

To enable the open data context API on the ExtraHop appliance:

  1. Click System Configuration >Capture.
  2. Click Open Data Context API.
  3. On the Open Data Context API page, enter the following information:
    • Enable Open Data Context API: Check this checkbox to enable the Open Data Context API.
    • TCP Port Enabled: Check this checkbox to enable the TCP port for Open Data Context.
    • TCP Port: The port number of the enabled TCP port. By default, this is set to 11211.
    • UDP Port Enabled: Check this checkbox to enable the UDP port for Open Data Context.
    • UDP Port: The port number of the enabled UDP port. By default, this is set to 11211.
  4. Click Save and Restart Capture.
  5. Click OK.

Note: Enabling the Open Data Context API opens TCP/UDP port 11211 by default, so ensure that the firewall rules allow access to these ports from any external host that will use the API.

Supported Memcache Client Libraries

You can use any standard memcache client library with the Open Data Context API. The ExtraHop appliance acts as a memcache version 1.4 server. For a list of client libraries, refer to http://code.google.com/p/memcached/wiki/Clients.

All memcache commands are supported, but the following actions are not supported:

  • Flush. Setting item expiration when adding or updating items is supported, but bulk expiration is not.
  • Detailed statistics by item size or key prefix. Basic statistics reporting is supported.
Insert Data as a String

Some memcache clients attempt to store type information in the values. For example, the python memcache library stores floats as pickled values, which cause invalid results when using Session.lookup in triggers.

Incorrect:

// python: >>> mc.set("my_float", 1.5)
// triggers: Session.lookup("my_float") // returns "F1.5\n."

Correct:

// python: >>> mc.set("my_float", str(1.5))
// triggers: Session.lookup("my_float") // returns "1.5"
Change the Session Table Size

The default session table size is 32768 entries. You can modify the running config to change the session table size, but increasing the session table size might impact memory consumption on the system and cause other issues. You must restart the capture to see these changes.

To change the session table size, add the following line to the "capture" section of the running config:

"jssession_table_size": 32768

For more information, see the Running Config section or contact ExtraHop Support.

Software Tap on a Linux Server

You must install the software tap on each server to be monitored to forward packets to the ExtraHop appliance. You can retrieve the commands from the procedures in this section or the ExtraHop Admin UI: https://<extrahop_ip>/admin/capture/rpcapd/linux/. In the ExtraHop Admin UI, the bottom of the System ConfigurationSoftware Tap (rpcapd) page contains links to automatically download the software tap.

Debian-Based Systems

To download and install the software tap on Debian-based systems:

  1. Click System Configuration > Capture
  2. Click Software Tap.
  3. Go to the section for your Linux system to copy and paste the commands into your terminal.
  4. At the prompt, enter the ExtraHop IP address, confirm the default connection to port 2003, and press Enter.
  5. (Optional) Run the following commands to verify the ExtraHop system is receiving traffic:
  6. sudo dpkg --get-selections | grep rpcapd sudo service rpcapd status
  7. (Optional) Run the following command to change the ExtraHop IP address, port number, or arguments to the service:
  8. >sudo dpkg-reconfigure rpcapd
RPM-Based Systems

To download and install the software tap on RPM-based systems:

  1. Click System Configuration > Capture.
  2. Click Software Tap.
  3. Go to the section for your Linux system to copy and paste the commands into your terminal.
  4. Run one of the following configuration commands:
    vim /opt/extrahop/etc/rpcapd.ini nano /opt/extrahop/etc/rpcapd.ini

    Example output:

    cat /opt/extrahop/etc/rpcapd.ini #ActiveClient = <TARGETIP>,<TARGETPORT> NullAuthPermit = YES

    Replace <TARGETIP> with your ExtraHop system's IP address and <TARGETPORT> with 2003, and uncomment the line.

    Example output:

    cat /opt/extrahop/etc/rpcapd.ini ActiveClient = 10.10.10.10,2003 NullAuthPermit = YES

    Run the following command to start sending traffic to the ExtraHop system:

    sudo /etc/init.d/rpcapd start
  5. (Optional) Run the following command to verify the ExtraHop system is receiving traffic:
    sudo service rpcapd status
Generic/Other Linux Systems

To download and install the software tap on another Linux system:

  1. Click System Configuration > Capture
  2. Click Software Tap.
  3. Go to the section for your Linux system to copy and paste the commands into your terminal.
  4. (Optional) Run the following command to verify the ExtraHop system is receiving traffic:
    sudo /etc/init.d/rpcapd status

Software Tap on a Windows Server

You must install the software tap on each server to be monitored to forward packets to the ExtraHop appliance. To download and install the software tap:

  1. Click System Configuration > Capture
  2. Click Software Tap.
  3. Click For Windows, click here.
  4. Click the Windows rpcapd installer to begin the download.
  5. When the file is finished downloading, click it to open the installer. You must have administrator privileges to run the installer.
  6. In the wizard, select the components to install.
  7. Complete the ExtraHop IP and ExtraHop Port fields and click Next. The default port is 2003.
  8. (Optional) Enter additional arguments in the text box and click Next.
  9. Browse to and select the destination folder to install RPCAP Service.
  10. (Optional) If RPCAP Service was previously installed, click Yes to delete the previous service.
  11. When the installation is complete, click Close.

Network Overlay Decapsulation

Network overlay encapsulation wraps standard network packets in outer protocol headers to perform specialized functions, such as smart routing and virtual machine networking management.

Network overlay decapsulation enables the ExtraHop appliance to remove these outer encapsulating headers and then process the inner packets.

NOTE: Enabling NVGRE and VXLAN decapsulation on your ExtraHop appliance can increase your device count as virtual appliances are discovered on the network. Discovery of these virtual devices cause you to exceed your licensed device limits and the additional metrics processing can cause performance to degrade in extreme cases.

MPLS, TRILL, and Cisco FabricPath protocols are automatically decapsulated by the ExtraHop system.

Enable NVGRE Decapsulation
  1. Click System ConfigurationCapture.
  2. Click Network Overlay Decapsulation.
  3. In the Settings section, check the Enabled checkbox next to NVGRE.
  4. Click Save.
Enable VXLAN Decapsulation

VXLAN is a UDP tunneling protocol is configured for specific destination ports. Decapsulation is not attempted unless the destination port in a packet matches the UDP destination port or ports listed in the VXLAN decapsulation settings.

  1. Click System ConfigurationCapture.
  2. Click Network Overlay Decapsulation.
  3. In the Settings section, check the Enabled checkbox next to VXLAN.
  4. In the UDP Destination Port text box, type a port number and click the green plus (+) . By default, port 4789 is added to the UDP Destination Port list. You can add up to eight destination ports.
  5. Click Save.

This section enables you to reset all trends and trend-based alerts.

To reset trends:

  1. Click System ConfigurationTrends.
  2. Click Reset Trends to erase all trend data from the ExtraHop appliance.

ExtraHop Explore Settings

This section contains the following configuration settings for the ExtraHop Explore appliance:

  • Configure Explore Cluster: Specify an Explore appliance to store flow and transaction records.
  • Automatic Flow Record Settings: Specify the automatic flow record settings.
  • ExtraHop Explore Status: View information about the Explore cluster status.

Configure Explore Cluster

When you deploy an Explore cluster in your environment, you must establish a connection from an ExtraHop Discover appliance or Command appliance to the Explore cluster before you can query records.

To pair a Discover appliance or Command appliance to an Explore cluster:

  1. Click on ExtraHop Explore Settings > Configure Explore Cluster.
  2. Click Add New.
  3. In the Host #1 Host field, type the hostname or IP address of any Explore appliance in the Explore cluster.
  4. For each additional Explore appliance in the cluster, click Add New and enter the unique hostname or IP address in the corresponding Host field.
  5. Click Save.
  6. Note the information listed for Fingerprint. Verify that the fingerprint listed on this page matches the fingerprint of the Explore appliance (Host #1) listed on the Status > Fingerprint page in the Explore Admin UI.
  7. In the Explore Setup Password field, type the password of the Explore appliance.
  8. Click Join, and then click Done.

Automatic Flow Records

Flow records show communication between two devices over an (L3) IP protocol. Automatic flow records are sent when a flow terminates, or periodically for flows that remain active for an extended period of time.

  • Enabled: Enable or disable the generation of flow records.
  • Publish Interval (in seconds): Specify the number of seconds after which a flow record is sent to the Explore appliance if the flow is still active.
  • IP Addresses: Add IP addresses to restrict flow record generation to specific devices.
  • Port Ranges: Add port numbers to restrict flow record generation to a single port or range of ports.

ExtraHop Explore Status

This section displays the following status information for the Explore appliance:

  • Activity since: Displays the timestamp when record collection began. This value is automatically reset every 24 hours.
  • Records Sent: Displays the number of records sent to the Explore appliance from a Discover appliance.
  • I/O Errors: Displays the number of errors generated.
  • Queue Full (Records Dropped): Displays the number of records dropped when records are created faster than they can be sent to the Explore appliance.

System Settings

You can configure the following components of the ExtraHop appliance in the System Settings section:

  • Services: Enable management, SNMP, and SSH services.
  • Firmware: Update the ExtraHop appliance firmware.
  • System Time: Configure the system time.
  • Shutdown or Restart: Halt and restart status times.
  • License: Update the license to enable add-on modules.
  • Schedule Reports: View a list of scheduled reports that are in the process of being generated.
  • Disk: View information about the disks in the ExtraHop appliance.
    Note: If you are using the Command appliance, Scheduled Reports appears instead of Disk. The scheduled reports functionality allows you to view reports for troubleshooting purposes.

Services

Services run in the background and perform functions that do not require user input. The Admin UI provides the following settings to manage the services used by the ExtraHop appliance. These services can be started and stopped through the Admin UI:

  • Web Shell: Enable or disable the Launch Shell button in the upper right corner of the Admin UI screen.
  • Management GUI: Enable or disable the ExtraHop GUI service. This service enables support for the browser-based ExtraHop Web UI and Admin UI interfaces.
  • SNMP Service: Enable or disable the ExtraHop system SNMP service.
  • SSH Access: Enable or disable SSH access. This service enables support for the ExtraHop command-line interface (CLI).

Management GUI

Management GUI setting controls the status of the Apache Web Server that runs the ExtraHop UI web application. By default, this service is enabled so that ExtraHop users have access to the ExtraHop Web UI and Admin UI. If this service is disabled, it terminates the Apache Web Server session, turning off web browser access to the ExtraHop UIs.

Warning: Do not disable this service unless you are an experienced ExtraHop administrator and you are familiar with the ExtraHop Command-Line Interface (CLI) commands to restart the Management GUI service.

To enable or disable the Management GUI service:

  1. Click System SettingsServices.
  2. Check or uncheck the Management GUI checkbox.
  3. Click Save.

SNMP Service

Simple Network Management Protocol (SNMP) is used to monitor the state of the network. SNMP collects information by polling devices on the network. SNMP-enabled devices can send alerts to SNMP management stations.

The SNMP service needs to be enabled to use SNMP notification in the ExtraHop appliance. For more information about configuring SNMP notifications, see the SNMP section.

To enable or disable the SNMP service:

  1. Click System Settings > Services.
  2. Check or uncheck the SNMP Service checkbox.
  3. Click Save.

The SNMP community string is an identifier used to poll SNMP service. To configure the SNMP service:

  1. Click System SettingsServices.
  2. On the Services page, next to SNMP Service, click Configure.
  3. On the SNMP Service Configuration page, enter the following information:
    • Enabled: Check the checkbox to enable the SNMP service.
    • SNMP Community: A friendly name for the SNMP community.
    • SNMP System Contact: A valid name or email address for the SNMP system contact.
    • SNMP System Location: A location for the SNMP system.
  4. Click Save Settings.

SSH Access

The SSH Service setting controls the status of the Secure Shell protocol that manages the ExtraHop command-line interface (CLI). By default, this service is enabled so that ExtraHop users have access to the ExtraHop appliance functionality through the CLI. If this service is disabled, it terminates SSH, turning off CLI access to the ExtraHop appliance.

Note: The SSH Service and the Management GUI Service cannot be disabled at the same time. At least one of these services must be enabled on the ExtraHop appliance at all times to provide interface functionality to the system.

To enable or disable the SSH:

  1. Click System SettingsServices.
  2. Check or uncheck the SSH Service checkbox.
  3. Click Save.

Web Shell

The Admin UI provides access to the Extrahop web shell by default. Click the Launch Shell button in the top right corner of the screen to launch the web shell.

To enable and disable the Launch Shell button:

  1. Click System SettingsServices.
  2. Check or uncheck the Web Shell checkbox.
  3. Click Save.

Firmware

The Admin UI provides an interface to upload and delete the firmware on the ExtraHop appliance.

The ExtraHop Admin UI includes the following firmware configuration settings:

  • Update: Upload and install new ExtraHop appliance firmware versions.
  • Delete: Select and delete installed firmware versions from the ExtraHop appliance.

You can download the latest firmware at the ExtraHop Customer Portal. A checksum of the uploaded firmware is usually available in the same download location as the .tar firmware file. If there is an error during firmware installation, ExtraHop Support might ask you to verify the checksum of the firmware file.

Note: If you are upgrading an Command appliance, make sure to upgrade the Command appliance first and then upgrade the nodes. To function correctly, the Command appliance and nodes must use the same minor version of ExtraHop firmware.

Upload New Firmware Versions

Firmware images that you want to upload must be accessible from the computer on which you are running the web browser.

To upload a new ExtraHop appliance firmware version from a file:

  1. Click System SettingsFirmware.
  2. Click Update.
  3. On the Update Firmware page, enter the following information:
    • Firmware Image: Click Choose File, navigate to the .tar file you want to upload, and click Open.

      If the ExtraHop appliance has less than 300MB of space remaining, a warning message appears with a link to clean up the disk. ExtraHop strongly recommends performing a disk cleanup before uploading new firmware to ensure continued device functionality.

    • Automatically Restart: Uncheck this checkbox if you do not want the ExtraHop appliance to automatically restart after installing the new firmware.
  4. Click Update. The ExtraHop appliance initiates the firmware update. You can monitor the progress of the update with the Updating progress bar.
  5. After the firmware update is installed successfully, the ExtraHop appliance displays the version number of the new firmware image. Click Reboot to restart the system.
  6. After restarting, on the Admin UI main page, view the firmware information at the top right of the page.
  7. Verify that the firmware version number displayed matches the version that you downloaded from ExtraHop.

To upload a new ExtraHop appliance firmware version from a URL:

  1. Click System SettingsFirmware.
  2. Click Update.
  3. On the Update Firmware page, click Retrieve from URL instead.
  4. On the Update Firmware page, enter the following information:
    • Firmware URL: The URL to obtain the firmware from.

      If the ExtraHop appliance has less than 300MB of space remaining, a warning message appears with a link to clean up the disk. ExtraHop strongly recommends performing a disk cleanup before uploading new firmware to ensure continued device functionality.

    • Automatically Restart: Uncheck this checkbox if you do not want the ExtraHop appliance to automatically restart after installing the new firmware.
  5. Click Update. The ExtraHop appliance initiates the firmware update. You can monitor the progress of the update with the Updating progress bar.
  6. After the firmware update is installed successfully, the ExtraHop appliance displays the version number of the new firmware image. Click Reboot to restart the system.
  7. After restarting, on the Admin UI main page, view the firmware information at the top right of the page.
  8. Verify that the firmware version number displayed matches the version that you downloaded from the URL.

Upload New Firmware Versions (Command appliance)

Firmware images that you want to upload must be accessible from the computer on which you are running the web browser.

Note: Make sure to upgrade the Command appliancefirst and then upgrade the nodes.

To upload a new Command appliance firmware version from a file:

  1. On the Command appliance click System SettingsFirmware.
  2. Click Update.
  3. On the Update Firmware page, enter the following information:
    • Firmware Image: Click Choose File, navigate to the .tar file you want to upload, and click Open.

      If the Command appliance has less than 300MB of space remaining, a warning message appears with a link to clean up the disk. ExtraHop strongly recommends performing a disk cleanup before uploading new firmware to ensure continued device functionality.

    • Automatically Restart: Uncheck this checkbox if you do not want the Command appliance to automatically restart after installing the new firmware.
  4. Click Update. The Command appliance initiates the firmware update. You can monitor the progress of the update with the Updating progress bar.
  5. After the firmware update is installed successfully, the Command appliance displays the version number of the new firmware image. Click Reboot to restart the system.
  6. After restarting, on the Admin UI main page, view the firmware information at the top right of the page.
  7. Verify that the firmware version number displayed matches the version that you downloaded from ExtraHop.

To upload a new Command appliance firmware version from a URL:

  1. On the Command appliance, click System SettingsFirmware.
  2. Click Update.
  3. On the Update Firmware page, click Retrieve from URL instead.
  4. On the Update Firmware page, enter the following information:
    • Firmware URL: The URL to obtain the firmware from.

      If the Command appliance has less than 300MB of space remaining, a warning message appears with a link to clean up the disk. ExtraHop strongly recommends performing a disk cleanup before uploading new firmware to ensure continued device functionality.

    • Automatically Restart: Uncheck this checkbox if you do not want the Command appliance to automatically restart after installing the new firmware.
  5. Click Update. The system initiates the firmware update. You can monitor the progress of the update with the Updating progress bar.
  6. After the firmware update is installed successfully, the Command appliance displays the version number of the new firmware image. Click Reboot to restart the system.
  7. After restarting, on the Admin UI main page, view the firmware information at the top right of the page.
  8. Verify that the firmware version number displayed matches the version that you downloaded from the URL.

Update Node Firmware from a Command appliance:

  1. On the Command appliance, Click Cluster Settings > Nodes.
  2. Click Update Firmware.
  3. Click Choose File to select the .tar file on your workstation. Click the Retrieve from URL link if you received a URL from ExtraHop Support.
  4. Click the All nodes radio button to update the firmware on all nodes, or click the Matching nodes radio button and enter search criteria to update specific nodes at a time.
  5. Click Upload.

Delete Firmware Versions

The ExtraHop appliance makes available every installed firmware image that has been uploaded on the system. For maintenance purposes, these uploaded firmware images can be deleted from the system to reduce the number of available versions.

To delete firmware images from the ExtraHop appliance:

  1. Click System Settings > Firmware.
  2. Click Delete.
  3. On the Installed Firmware Images page, check the checkbox next to the firmware image that you want to delete.
  4. Note: You can select multiple versions.

  5. If you want to delete all installed firmware images, check the Check all checkbox.
  6. Note: Selecting the All option does not allow you to select and delete the active firmware version.

  7. Click Delete Selected.
  8. Click OK.

Update the Firmware Using the Command Line Interface

Follow these steps to update the firmware for the ExtraHop appliance using the ExtraHop command line interface (CLI).

  1. Access the ExtraHop CLI using one of the following three methods:
    • From a USB keyboard and SVGA monitor directly connected to the ExtraHop appliance.
    • Using an RS-232 serial cable and a terminal-emulator program. The terminal emulator must be set to 115200 bps with 8 data bits, no parity, and 1 stop bit (8N1). Hardware flow control should be disabled.
    • Secure shell (SSH)
      Note: When changing the network settings, it is recommended that you use a serial cable or directly connected keyboard and monitor. This approach ensures that access to the ExtraHop appliance will not be disrupted if the settings are configured improperly.
  2. Connect to the ExtraHop appliance. The login is shell and the password is the service tag number on the right-front bracket of the ExtraHop appliance.
  3. Enable the administration controls. The password is the same as above.
    extrahop>enable
  4. class="lead-in">Enter configuration mode.
    extrahop#configure term
  5. Download the firmware update using the FTP account credentials that you received from ExtraHop Support.
    extrahop(config)#download ftp://[login]:[password]@[FTP IP address]:/[firmware image]
  6. The ExtraHop appliance downloads and applies the upgrade.
    Connecting to ipaddr ... connected. Logging in as login ... Logged in! ==> SYST ... done. ==> PWD ... done. ==> TYPE I ... done. ==> CWD not needed. ==> PASV ... done. ==> LIST ... done. [ <=> ] 1,591 --.-K/s in 0s ==> CWD not required. ==> PASV ... done. ==> RETR firmware-image-version ... done. Length: 10045440 (9.6M) 100%[=====================>] 10,045,440 --.-K/s in 0.09s FINISHED --2009-03-10 12:28:59-- Downloaded: 2 files, 9.6M in 0.09s (112 MB/s) Applying update. Please wait... Update succeeded. Would you like to reboot now [Y/n]?:
  7. Restart the ExtraHop appliance.
  8. After the ExtraHop appliance restarts, verify the version by connecting to the CLI and running the show version command.
    extrahop>show version extrahop-1.0.7238
    Note: The version number displayed should match the version of the firmware image you downloaded when you updated the Command appliance.

System Time

When capturing data, it is helpful to have the time on the ExtraHop appliance match the local time of the router. The ExtraHop appliance can rely on setting time locally, or it can keep the system time accurate by using time servers. You can use the default time server setting, pool.ntp.org, or you can configure the system time manually.

To configure the system time:

  1. Click System Settings > System Time.
  2. Click Configure Time.
  3. From the Select time zone drop-down, a time zone.
  4. Click Save and Continue.
  5. Select the Use NTP server to set time radio button, the click Select.
  6. To set the NTP servers, enter the IP addresses for the time servers and click Save.
  7. Click Done.

The default time server setting is pool.ntp.org.

Note: If needed, select the Set clock manually radio button to adjust the date and time. Set the date and time values, and then click Save. The System Clock time setting is not UTC, but it reflects the time zone currently set in the Time Zone section.

The NTP Status table displays a list of NTP servers that are used to keep the system clock in sync. To sync a remote server to the current system time, click the Sync Now button.

Shutdown or Restart

The Admin UI provides an interface to halt, shutdown, and restart the ExtraHop appliance. The ExtraHop Admin UI includes restart controls for the following system components:

  • System: Pause the operation of the ExtraHop appliance or shut down and restart the ExtraHop appliance.
  • Bridge Status: Shut down and restart the ExtraHop bridge component.
  • Capture Status: Shut down and restart the ExtraHop capture component.
  • Portal Status: Shut down and restart the ExtraHop web portal.

For each ExtraHop appliance component, the table includes a time stamp to show the start time.

System

To shutdown the ExtraHop appliance:

  1. Click System Settings > Shutdown or Restart.
  2. On the Shutdown or Restart page, under System, click Shutdown.
  3. At the prompt, click Shutdown.

To shutdown and restart the ExtraHop appliance:

  1. Click System Settings > Shutdown or Restart.
  2. On the Shutdown or Restart page, under System, click Restart.
  3. At the prompt, click Restart.

Bridge Status

To shut down and restart the ExtraHop bridge:

  1. Click System Settings > Shutdown or Restart.
  2. On the Shutdown or Restart page, under Bridge Status, click Restart.
  3. At the prompt, click OK.
  4. Click Done.

Capture Status

To shut down and restart the ExtraHop capture:

  1. Click System Settings > Shutdown or Restart.
  2. On the Shutdown or Restart page, under Capture Status, click Restart.
  3. At the prompt, click OK.
  4. Click Done.

Portal Status

To shut down and restart the ExtraHop web portal:

  1. Click System Settings > Shutdown or Restart.
  2. On the Shutdown or Restart page, under Portal Status, click the Restart.
  3. At the prompt, click OK.
  4. Click Done.

License

The Admin UI provides an interface to add and update licenses for add-in modules and other features available in the ExtraHop appliance. The License Administration page includes the following licensing information and settings:

  • Manage license: Provides an interface to add and update licenses for ExtraHop appliance features and modules.
  • System Information: Displays the identification and expiration information about the ExtraHop appliance.
  • Modules: Displays the list of modules on the ExtraHop appliance and whether they are enabled or disabled.
  • Interfaces: Displays the list of licensed Interfaces (such as 10G) and whether the specified interface is active.
  • Features: Displays the list of licensed ExtraHop appliance features (such as Activity Mapping) and whether the licensed features are enabled or disabled.

To view the licensing system information and the status of licensed modules on the ExtraHop appliance:

  1. Click System Settings > License.
  2. On the License Administration page, under Modules, check the status column to verify that the add-in modules are enabled.

To register an existing license:

  1. Click System Settings > License.
  2. Click Manage license.
  3. Click Register and wait for the licensing server to finish processing.
  4. Click Done.

To update a module license or add new licenses to the ExtraHop system:

  1. Click System Settings > License.
  2. Click Manage license.
  3. Click Update.
  4. In the Enter License text box, enter the licensing information for the module.
  5. License information must include the dossier and service tag number for the ExtraHop appliance as well as key-value pairs to enable the module licenses and other ExtraHop appliance features. In the license information, a key-value pair with a value of 1 enables the feature or module; a key-value pair with a value of 0 disables the feature or module. For example:

    -----BEGIN EXTRAHOP LICENSE----- serial=ABC123D; dossier=1234567890abcdef1234567890abcdef; mod_cifs=1; mod_nfs=1; mod_amf=0; live_capture=1; capture_upload=1; 10G=1; triggers=0; poc=0; early_access_3.1=0; activity_map=1; ssl_acceleration=0; ssl_decryption=0; +++; ABCabcDE/FGHIjklm12nopqrstuvwXYZAB12345678abcde901abCD; 12ABCDEFG1HIJklmnOP+1aA=; =abcd; -----END EXTRAHOP LICENSE-----
  6. Click Update.

Disk

The Disk page displays a map of the drives on your ExtraHop appliance and lists their statuses. This information can help you determine whether drives need to be installed or replaced. Automatic system health checks and email notifications (if enabled) can provide timely notice about a disk that is in a degraded state. System health checks display disk errors at the top of the Settings page.

For information about configuring and repairing RAID10 functionality on the EH8000 appliance, refer to the guides on docs.extrahop.com.

For help replacing a RAID 0 disk or installing an SSD drive, refer to the instructions below. The RAID 0 instructions apply to the following types of disks:

  • Datastore (EH2000/3000/5000/6000/8000)
  • Packet Capture (EH3000/6000/8000)
  • Firmware (EH3000/6000/8000)

Do not attempt to install or replace the drive in Slot 0 unless instructed by ExtraHop Support.

To ensure that system health checks and email notifications are running, mouse over the Settings button in the Web UI navigation bar.

  • If the message "System Health Checks Not Running" appears, contact ExtraHop Support at support@extrahop.com for instructions. This message also appears at the top of the Settings page.
  • If the message "System Health Notifications Not Configured" appears, refer to Email Notification Groups to set up email notifications for system health. Alternatively, click the Settings button, and then click View Admin Notifications page for more details at the top of the Settings page.
Note: Ensure that your device has a RAID controller before attempting the following procedure. If unsure, contact ExtraHop Support at support@extrahop.com. This procedure uses the EH5000 appliance as an example. A persistently damaged disk might not be replaceable with this procedure.

To replace a RAID 0 disk:

  1. In the system health email notification, note which machine has the problematic disk.
  2. In the ExtraHop Web UI for the identified machine, click the Settings button in the navigation bar, and go to the Disk page by doing either of the following:
    • Click Administration. Then, under System Settings, click Disk.
    • Click the Disk Error link at the top of the page.
  3. Under the section for the disk type (for example, Datastore), find the problematic disk and note the Slot Number.

    In the following example, the Media Error Count is increasing on the disk, and the Slot Number is 0. The Drive Map shows the disk in yellow.

    You can click RAID Disk Details at the bottom of the section to display more details.

  4. Insert an identical disk into an available slot.

    The system detects the new disk and adds a new row (Disk Error Action) with a link to replace the bad disk.

  5. Verify the new disk's information:
    • Under Unused Disks on the Disk Details page, verify that the new disk is the same size, speed, and type as the disk being replaced.
    • Mouse over the old and new disks in the Drive Map. The new disk displays the message "Unconfigured(good), Spun Up."

  6. Under the section for the disk type, click Replace with Disk in slot #n in the Disk Error Action row.

    The data begins copying over. The Copy Status row shows the progress. Mousing over the disk in the Drive Map shows the status.

  7. After copying is complete, make sure that the copy process was successful:
    • Settings button and Settings page no longer display error messages.
    • Disk page shows the old disk under the Unused Disk section.
  8. Remove the old disk.

    The Drive Map now shows the new disk in green.

    If you want to move the disk to the old disk's slot, you can power off the ExtraHop appliance, move the disk, and then power on the appliance.

To install a new SSD drive:

  1. Ensure that your ExtraHop license has packet capture enabled. For more information, refer to Packet Captures.
  2. Go to the System Settings section and click Disk. If the Drive Map shows the last slot (Disk #5 on the EH2000, Disk #7 on the EH5000) in red, you must replace the SSD drive.

  3. Insert the SSD drive into the last slot and wait for the LED on the drive to turn green.
  4. In the Admin UI, refresh the browser. The Drive Map shows the last slot in yellow because the drive is not configured.

  5. Next to SSD Assisted Packet Capture, click Enable.
  6. Wait about 1 minute for the drive to be configured and brought online.
  7. The browser automatically refreshes. The Drive Map shows the SSD drive as green and the Status changes to Online.

Note: If the SSD drive is dislodged and reinserted, you can re-enable it. This process requires reformatting the disk, which erases all data.

Scheduled Reports (Command appliance)

This page displays a list of scheduled reports are in the process of being generated by the Command appliance. This list contains only reports that are presently being processed or were halted during generation due to an error, not reports to be processed in the future. Refer to this page if you stop receiving the scheduled reports that you created in the Reports section of the ExtraHop Web UI.

For more information about creating a report, refer to the Reports section of the Web UI Guide.

For more information about configuring email server settings and creating email groups, see the Notifications section.

To view scheduled reports:

  1. In the ExtraHop Web UI, click Settings, click Reports, click a report, and click the Email Schedule tab to ensure the report has been scheduled.
  2. In the Admin UI, click System Settings > Scheduled Reports.
  3. View the list of reports. If the report was scheduled to be sent less than 10 minutes in the past, it might be in the process of generating. If the first report was scheduled to be sent more than 10 minutes in the past, an error might have occurred while generating the report and is delaying subsequent reports from being sent.
  4. Click the red delete symbol next to the report to remove it from the list.
    Note: If all reports are generating without errors, reports remain in the queue while they are generating and then leave the queue when sent. Reports typically remain in the queue for less than 1 minute.

Diagnostics

The Diagnostics section includes the following pages:

  • Exception Files: Enable or disable the ExtraHop appliance exception files.
  • Support Packs: Upload and execute ExtraHop appliance support packages.
  • Offline Capture File: Configure the Discover appliance live (online) or offline capture mode. (Not available on a Command appliance.)

Exception Files

The Admin UI provides a page to enable or disable writing exceptions to the ExtraHop exception files.

To enable writing to Exception Files:

  1. Click Diagnostics > Exception Files.
  2. On the Enable/Disable Exception Files page, click Enable Exception Files to turn on the setting to write exceptions to the exception files.

To disable writing to exception files:

  1. Click Diagnostics > Exception Files.
  2. On the Enable/Disable Exception Files page, click Disable Exception Files to turn off the setting to write exceptions to the exception files.

Support Packs

When you receive assistance from ExtraHop Support, you might need to load an ExtraHop-provided support pack to apply a special setting, make a small adjustment to the system, or get help with remote support or enhanced settings. The ExtraHop Admin UI includes the following configuration settings to manage support packages:

  • View Support Pack Results: View, download, or delete selected support packages.
  • Upload Support Pack: Upload diagnostic support packages on the ExtraHop appliance.
  • Apply System Support Pack: Execute a selected diagnostic support package.

Support Pack Results

You can view, download, or delete the diagnostic support packages that have been uploaded to the ExtraHop appliance.

To view the diagnostic support packages on the ExtraHop appliance:

  1. Click Diagnostics > Support Packs.
  2. Click View Support Pack Results.

To download a selected diagnostic support package:

  1. Click Diagnostics > Support Packs.
  2. Click View Support Pack Results.
  3. Click the name of the diagnostic support package that you want to download. The file will download to your browser's default download location.

To delete a selected diagnostic support package:

  1. Click Diagnostics > Support Packs.
  2. Click View Support Pack Results.
  3. Click the red x next to the support package you want to delete.
  4. Click OK.

Upload Support Pack

To upload a selected diagnostic support package:

  1. Clck Diagnostics > Support Packs.
  2. Click Upload Support Pack.
  3. Click Choose File next to Diagnostic image, navigate to the diagnostic support package you want to upload, and click Open.
  4. Click Upload to add the file to the ExtraHop appliance.

System Support Pack

Some support packs only perform a function on the ExtraHop appliance, while others gather information about the state of the system for analysis by the ExtraHop Support team. If the support pack generated a results package to send to the ExtraHop Support team, then the Admin UI redirects to the Support Pack Results page. If it does not, you can go to the Support Pack Results page from the Support Pack page.

To create a diagnostic support package that can be downloaded and sent to the ExtraHop Support team:

  1. Click Diagnostics > Support Packs.
  2. Under Support Pack, click Execute next to System Support Pack.
  3. Click OK.

Offline Capture File

By default, the ExtraHop appliance is configured to obtain network data in Live Network Traffic (Online) Capture mode. You can turn off this setting if you want to capture data using an uploaded capture file.

The Offline Capture mode in the Discover appliance enables an ExtraHop administrator to upload a capture file (recorded by packet sniffers, such as Wireshark or tcpdump) to the ExtraHop datastore for analysis. When the system is set to Offline mode, the offline file upload feature is enabled, allowing a capture file to be uploaded to the datastore. In Offline mode, no metrics are collected from the capture interface until the system is set to online mode again.

When the capture is set to Offline mode, the ExtraHop datastore is reset. All previously recorded performance metrics are deleted from the datastore. When the system is set to online mode, the datastore is reset again.

Note: Offline Capture mode is not configurable when using the Command appliance.

Set the Offline Capture Mode

To configure the capture mode setting:

  1. Click Diagnostics > Offline Capture File.
  2. Click the Offline - Upload Capture File radio button to turn on the setting to set the capture mode to offline.

    The capture process is stopped, the capture state is set to offline, and the datastore is cleared of all data.

  3. Click Save to activate the new setting.

    When the system has set the capture to offline mode, the Upload a Capture File page is displayed.

  4. To upload a capture file:
    1. Click Choose File, browse to the capture file that you want to upload, select the file and click Open.
    2. On the Offline Capture page, click Upload.

      The Discover appliance displays the Offline Capture Results page when the capture file uploads successfully.

To verify that the system is in offline mode, access the Health page in the Admin UI to see the Capture Status values. Each metric should have a value of offline. When you check the capture status, the status shown for VM RSS, VM Data, VM Size, and Start Time should indicate that the system is in offline mode.

For more information about the Health page, see the Health section.

Reset the Online Capture Mode

The Capture mode settings in the Admin UI are also used to return the Discover appliance to online capture mode. When you choose to restart the ExtraHop online capture, the data loaded into the datastore from the offline capture file is deleted as soon as you save the online capture setting.

To turn on Online Capture mode:

  1. Click Diagnostics > Offline Capture File.
  2. Click the Online - Live Traffic radio button.
  3. Click Save.
  4. At the prompt to restart the excap, click OK.

The Discover appliance removes the performance metrics collected from the previous capture file and prepares the datastore for real-time analysis from the capture interface.

Shell

The ExtraHop shell provides a command-line interface (CLI) for managing configuration settings in the ExtraHop appliance. The CLI can be used as a stand-alone interface, or as an supplemental interface that is accessible through the Admin UI.

Note: The CLI is used as the primary management interface when using the appliance’s USB connection to attach a keyboard and monitor to the appliance itself, or when using the IDRAC interface that is available on the latest ExtraHop appliance models.

When the Admin UI is enabled and you are logged on, you can open the ExtraHop shell from the Admin UI application toolbar.

To open a shell window from the Admin UI, go to the top-level toolbar, click Launch Shell.

The ExtraHop Web Shell opens in a separate browser window.

The command syntax includes the ExtraHop appliance hostname to specify the appliance that will process the commands. For example, the following enable command is executed on the ExtraHop appliance on the network that has a hostname of extrahop.

extrahop>enable

You can type a question mark (?) at any prompt to generate a list of available commands. For example, if you type show ? at the prompt, the CLI will list all supported show commands and provide a brief description of each command.

Note: The question mark (?) does not print in the CLI display, and you do not have to press the Enter key after typing the question mark. The CLI displays the sub-commands (or parameters) associated with the current command.

Privileged and Non-Privileged Modes

The CLI distinguishes between two user modes to determine the access privileges to specific commands:

  • Privileged. Has read-write privileges which provides access to all commands. In privileged mode, the elevated-privileged prompt is a hash symbol (#) instead of a greater than symbol (>).
  • Non-Privileged. Has read-only privileges which provides access to a limited set of commands. In non-privileged mode, the prompt is a greater than symbol (>).

Users that log on in non-privileged mode have access to the following four commands and their sub-commands:

  • enable. Enables privileged mode. When this command is executed, it prompts for a password to authorize privileged mode.
  • ping. Sends a ping request to a specified device.
  • show. Shows the ExtraHop appliance configuration settings in view-only mode.
  • traceroute. Sends a traceroute request to a specified device.

Users that enable privileged mode are granted access to all the CLI commands. The top-level commands that are enabled in privileged mode are:

  • configure. Enables configuration mode.
  • delete. Allows delete operations.
  • disable. Disables privileged mode.
  • enable. Enables privileged mode.
  • ping. Sends a ping request.
  • reload. Allows reload services operations.
  • reset. Allows reset services operations.
  • restart. Allows restart services operations.
  • show. Shows the current system configuration settings.
  • shutdown. Shuts down the ExtraHop appliance.
  • stop. Stops ExtraHop services.
  • support. Enables (or disables) the ExtraHop Support account.
  • traceroute. Sends a traceroute request.

Shell Commands

The following shell commands are supported by the ExtraHop appliance. Note that you need to be in Privileged mode to execute commands that change ExtraHop appliance configuration settings.

configure

Puts the ExtraHop appliance into Configuration mode. After the configure command executes and the system is in Configuration mode, you can pass in any of the sub-commands listed below.

Syntax

extrahop#configure

Example

The following command sequence opens Configuration mode, enables the interface sub-commands, sets a static IP address, DNS servers, and hostname for the ExtraHop appliance, and then exits Configuration mode:

extrahop#configure extrahop(config)#interface extrahop(config-if)#ip ipaddr <ipaddr> <netmask> <gateway> extrahop(config-if)#ip dnsservers <ipaddr> <ipaddr 2> extrahop(config-if)#ip hostname <name> extrahop(config-if)#exit extrahop(config)#exit

The configure command supports the following sub-commands:

current

Enables the user to change the firmware version to any version that is installed on the system.
After specifying a new firmware version, the CLI will prompt you to reboot the ExtraHop appliance.

Syntax

extrahop#configure extrahop(config)#current <version>

Parameters

  • version. Specifies the version number of the ExtraHop firmware that you want to upload as the current firmware on the ExtraHop appliance.

Parameters

  • URI. Specifies the URI of a downloaded diagnostic script from ExtraHop Support to run on the ExtraHop appliance.
diagnostics

Downloads and executes a signed diagnostics script.

Syntax

extrahop#configure extrahop(config)#diagnostics <URI>

Parameters

  • URI. Specifies the URI of a downloaded diagnostic script from ExtraHop Support to run on the ExtraHop appliance.
eula_reset

Reset the POC and EUSL/TOS license agreements. Note that this command is intended for use by ExtraHop Support only.

Syntax

extrahop#configure extrahop(config)#eula_reset
install

Retrieves and uploads a firmware update from ExtraHop.

Syntax

extrahop#configure extrahop(config)#install <uri>

Parameters

  • URI. Specifies the URI of a firmware update from ExtraHop Support that is uploaded to the ExtraHop appliance.
interface

Puts the CLI in Interface mode and provides sub-commands to specify how the ExtraHop appliance acquires an IP address and the hostname for the ExtraHop appliance.

Syntax

extrahop#configure extrahop(config)#interface extrahop(config-if)#ip ipaddr <addr> <netmask> <gateway> Parameters

The interface command includes the following sub-commands and parameters:

  • ip dhcp. Configures the ExtraHop appliance to use the DHCP option.
  • enable. Enables the DHCP setting.
  • ip dnsserver. Configures the system DHCP servers. This parameter requires the following values:
  • primary addr. Specifies the primary IP address of the DNS Server.
  • secondary addr. Specifies the secondary IP address of the DNS server. This parameter is optional.
  • ip hostname. Specifies the system hostname. This parameter is optional.
  • name. Specifies the hostname for the ExtraHop appliance.
  • ip ipaddr. Configures the static IP address for the system. This parameter requires the following values:
    • addr. A static IP address.
    • netmask. An address that specifies the subnet mask.
    • gateway. The IP address of the computer that is used by devices on the network to access another network or a public network.
license

Provides sub-commands to enter the license string to update the ExtraHop license. The license key text is sent by ExtraHop Support, and it is pasted into the CLI at the Enter license text prompt.

Syntax

extrahop#configure extrahop(config)#license update Enter license text: <license>

Parameters

The license command includes the following sub-commands and parameters:

  • update. Updates the ExtraHop appliance license. This parameter requires the following parameter values:
  • license. Specifies the license key.
reformat

Provides sub-commands to schedule or cancel a reformat.

Syntax

extrahop#configure extrahop(config)#reformat

Parameters

The reformat command performs a reformat on the next boot and includes the following sub-command:

  • reformat cancel. Cancels the scheduled reformat.
remote_auth

Provides sub-commands to enable or disable remote authentication of users on the ExtraHop appliance. Note that the sub-commands ldap, radius, and tacacs put the CLI in the specific mode to accept parameters for the specified remote authentication method.

Syntax

extrahop#configure extrahop(config)#remote_auth disabled

Parameters

The remote_auth command includes the following sub-commands and parameters:

  • disabled. Disables remote authentication.
  • ldap. Specifies configuration parameters to enable the LDAP remote authentication method. This command puts the CLI in ldap mode and requires the following parameter values:
    • basedn. Specifies the base of the LDAP search used to find users.
    • binddn. Specifies the Distinguished Name (DN) used by the ExtraHop appliance to authenticate with the LDAP server.
    • port. Specifies the listening port number of the LDAP server.
    • search. Specifies the search filter used when searching the LDAP directory for user accounts.
    • server. Specifies the hostname or IP address of the LDAP server (or servers).
    • show. Displays the current LDAP settings.
  • radius. Specifies configuration parameters to enable the RADIUS remote authentication method. This command puts the CLI in radius mode and requires requires the following parameter values:
  • delete_server. Deletes a specified RADIUS server host.
  • server. Specifies the hostname or IP address of the RADIUS server (or servers), the shared secret password, and an optional timeout value.
  • show. Displays the current RADIUS settings.
  • tacacs. Specifies configuration parameters to enable the TACACS remote authentication method. This command puts the CLI in tacacs mode and requires requires the following parameter values:
    • delete_server. Deletes a specified TACACS server host.
    • server. Specifies the hostname or IP address of the TACACS server (or servers), the shared secret password, and an optional timeout value.
    • show. Displays the current TACACS settings.
running_config

Provides commands to update the running configuration settings and save changes made to the running configuration to disk. The update command generates a prompt in the CLI to provide the updated configuration text. For more information about modifying the running config code, see the Running Config section.

Syntax

extrahop#configure extrahop(config)#running_config edit Enter configuration:

Parameters

The running_config command includes the following sub-commands and parameters:

  • edit. Provides an interface to make changes to sections of the running configuration.
  • update. Provides an interface to make changes to the entire running configuration. You are prompted to enter the running config text by the CLI.
  • save. Saves the changes made to the running configuration to disk.
  • revert. Reverts to the saved running configuration.
services

Provides commands to enable or disable the Admin UI, enable or disable the SSH service that supports the CLI interface, and enable or disable SNMP services.

Syntax

extrahop#configure extrahop(config)#services gui <enable/disable>

The services command includes the following sub-commands and parameters:

  • gui. Enables or disables the web service that supports the Admin UI. This command supports the parameter values enable to turn on the service and disable to turn off the service.
  • snmp. Enables or disables the SNMP service that supports SNMP monitoring. This command supports the parameter values enable to turn on the service and disable to turn off the service.
  • ssh. Enables or disables the SSH service that supports the command-line interface. This command supports the parameter values enable to turn on the service and disable to turn off the service.
systemsettings

Provides commands to work with ExtraHop appliance core files.

Syntax extrahop#configure extrahop(config)#systemsettings corefiles lifetime <value>

Parameters

The systemsettings command includes the following sub-commands and parameters:

  • corefiles enable. Enables the ExtraHop appliance core files.
  • corefiles disable. Disables the ExtraHop appliance core files.
  • lifetime. Sets the value for the core files lifetime.
  • value. Specifies the lifetime value.
time

Provides commands to set the ExtraHop appliance time, specified using the following date-time syntax: <MMM DD YYYY H:M:S>.

Syntax

extrahop#configure extrahop(config-time)#time <time>

Parameters

  • time. Specifies the time in the following format: MMM DD YYYY H:M:S.

delete

Puts the ExtraHop appliance into Delete mode. After the delete command executes and the system is in delete mode, you can pass in any of the sub-commands listed below to remove files from the system.

Syntax

extrahop#delete

Example

The following command sequence opens delete mode and removes a specified firmware version from the system:

extrahop#delete firmware <version>

The delete command supports the following sub-commands:

core

Provides commands to delete core files from the ExtraHop appliance. This command requires that you specify at least one core file name.

Syntax

extrahop#delete core <file>

Parameters

  • file. Specifies the name of the core file to delete.
firmware

Provides commands to delete firmware versions from the ExtraHop appliance. This command requires that you specify at least one firmware version name.

Syntax

extrahop#delete firmware <version>

Parameters

  • version. Specifies the firmware version that you want to delete from the ExtraHop appliance.

disable

Removes the ExtraHop appliance from Enable mode. After the disable command executes and the system is disabled, you will need to execute the enable command to perform any operations that modify settings using the command-line interface.

Syntax

extrahop#disable

Example

The following command sequence disables the command-line interface:

extrahop#disable

enable

Puts the ExtraHop appliance in Privileged mode. After the enable command executes and the system is fully enabled, you can enter and execute other commands to perform operations using the command-line interface. At the start of a session, this command is usually the first command issued. If you are prompted to enter a username and password, use the following credentials:

  • Type shell as the logon user name.
  • Type the number displayed on the service tag
  • Note: The service tag is on a pullout tab located on the front of the ExtraHop appliance, below the video connector on the 610 and below the power button on the 710.

Syntax

extrahop>enable

Example

The following command sequence enables the command-line interface and prompts for the appliance password:

extrahop>enable
password:

ping

Executes a command to ping a selected target to verify the ability to contact the specified host. Ping results specify the response packets received and the round-trip time.

Syntax

extrahop#ping <addr>

Parameters

  • addr. Specifies the IP address of the device to ping.

Example

The following command sequence pings a device at the specified IP address:

extrahop#ping 192.164.111.10

reload

Executes a reload operation for the specified ExtraHop appliance component. After the reload command is invoked, you can reload any of the supported components identified by their sub-commands.

Syntax

extrahop#reload

Example

The following command sequence activates Reload mode and reloads the ExtraHop bridge service:

extrahop#reload exbridge

The reload command supports the following sub-commands:

exbridge

Specifies the ExtraHop bridge as the component service to reload.

Syntax

extrahop#reload exbridge
excap

Specifies the ExtraHop capture as the component service to reload.

Syntax

extrahop#reload excap

reset

Executes a reset operation for the specified ExtraHop appliance component. After the reset command is invoked, you can reset the ExtraHop Datastore, which clears all current data from the Datastore.

Syntax

extrahop#reset

Example

The following command sequence activates Reset mode and clears data from the ExtraHop datastore:

extrahop#reset datastore

The reset command supports the following sub-commands:

datastore

Clears the saved data from the ExtraHop Datastore.

Syntax

extrahop#reset datastore

restart

Executes a restart operation for the specified ExtraHop appliance component. After the restart command is invoked, you can restart the ExtraHop component services identified by the following sub-commands.

Syntax

extrahop#restart

Example

The following command sequence activates Restart mode and restarts the ExtraHop bridge service:

extrahop#restart exbridge

The restart command supports the following sub-commands:

exbridge

Specifies the ExtraHop bridge as the component service to restart.

Syntax

extrahop#restart exbridge
excap

Specifies the ExtraHop capture as the component service to restart.

Syntax

extrahop#restart excap
exportal

Specifies the ExtraHop web portal as the component service to restart.

Syntax

extrahop#restart exportal
webserver

Specifies the ExtraHop web server as the component service to restart.

Syntax

extrahop#restart webserver
system

Specifies the ExtraHop system as the component to restart. This operation reboots the entire ExtraHop appliance.

Syntax

extrahop#restart system

show

Puts the CLI in View mode so that you can see the settings and parameter values associated with the ExtraHop appliance components. After the show command executes and the system is in View mode, you can look at the settings associated with every aspect of the ExtraHop appliance.

Syntax

extrahop#show

Example

The following command sequence puts the interface in View mode and shows the ExtraHop appliance time:

extrahop#show clock

The show command supports the following sub-commands:

clock

Specifies the ExtraHop computer current clock time as the setting to show.

Syntax

extrahop#show clock
controllers

Shows the settings for all the ExtraHop appliance active interfaces.

Syntax

extrahop#show controllers
cores

Shows the settings for the ExtraHop appliance core files.

Syntax

extrahop#show cores
dhcp

Shows whether DHCP is enabled or disabled on the ExtraHop appliance.

Syntax

extrahop#show dhcp
diskmon

Shows the hard disk monitor statistics for the hard drive on the ExtraHop appliance appliance.

Syntax

extrahop#show diskmon
dnsservers

Shows the DNS server configuration settings for the ExtraHop appliance.

Syntax

extrahop#show dnsservers
eula_accepted

Shows shows whether the EUSL/TOS and POC agreements have been accepted for the ExtraHop appliance.

Syntax

extrahop#show eula_accepted
firmware

Shows the firmware versions installed on the ExtraHop appliance. Executing this command on a Discover appliance will result in each firmware version being prefaced with "ExtraHop". Executing this command on a Command appliance will result in each firmware version listed being prefaced with "ECA".

Syntax

extrahop#show firmware
flash

Shows the content of the flash key for the ExtraHop appliance.

Syntax

extrahop#show flash
gateway

Shows the gateway configuration settings for the ExtraHop appliance.

Syntax

extrahop#show gateway
history

Shows the session command history for the current CLI session.

Syntax

extrahop#show history
hostname

Shows the system hostname for the ExtraHop appliance.

Syntax

extrahop#show hostname
inventory

Shows the firmware version, service tag, dossier ID, and hostname for the ExtraHop appliance.

Syntax

extrahop#show inventory
ip

Provides sub-commands to show IP address configuration settings for the ExtraHop appliance.

Syntax

extrahop#show ip arp

Parameters

The ip command includes the following parameters:

  • arp. Shows ARP resolution for the device and any computers connected to the device.
  • interface. Shows information for every IP interface on the connected computer.
  • sockets. Shows all active Internet connections for the device.
  • traffic. Shows the IP, ICMP, ICMP msg, TCP, UDP, UDP lite, TCP Ext, and IP Ext traffic for the device.
ipaddr

Shows the IP address and netmask for the ExtraHop appliance management port.

Syntax

extrahop#show ipaddr
ldap

Shows the LDAP configuration settings for the ExtraHop appliance.

Syntax

extrahop#show ldap
license

Shows the licensed modules for the ExtraHop appliance and which ones are enabled or disabled.

Syntax

extrahop#show license
log

Provides sub-commands to show the logs for the ExtraHop appliance.

Syntax

extrahop#show log

Parameters

The log command includes the following parameters:

  • exbridge. Shows the ExtraHop appliance bridge component logs.
  • excap. Shows the ExtraHop appliance capture logs.
  • exportal. Shows the ExtraHop appliance web portal logs.
macaddr

Shows the MAC address for the ExtraHop appliance.

Syntax

extrahop#show macaddr
memory

Shows the total, used, free, shared, buffers, and cached memory as well as Swap information for the ExtraHop appliance.

Syntax

extrahop#show memory
nics

Shows all NICs (network interface controllers) as well as their link status and link speed for the ExtraHop appliance.

Syntax

extrahop#show nics
processes

Shows the status of all ExtraHop appliance processes.

Syntax

extrahop#show processes
radius

Shows the RADIUS configuration settings for the ExtraHop appliance.

Syntax

extrahop#show radius
remote_auth

Shows the remote authentication configuration settings for the ExtraHop appliance.

Syntax

extrahop#show remote_auth
running_config

Shows the running configuration settings for the ExtraHop appliance.

Syntax

extrahop#show running_config
systemsettings

Shows whether the core files are enabled and if the offline capture setting is enabled for the ExtraHop appliance.

Syntax

extrahop#show systemsettings
tacacs

Shows the TACACS configuration settings for the ExtraHop appliance.

Syntax

extrahop#show tacacs
users

Shows the user accounts for the ExtraHop appliance.

Syntax

extrahop#show users
version

Shows the base firmware version and the currently running firmware version on the ExtraHop appliance.

Syntax

extrahop#show version

shutdown

Initiates the system shutdown operation for the ExtraHop appliance.

Syntax

extrahop#shutdown

Example

The following command sequence initiated the ExtraHop appliance shutdown:

extrahop#shutdown

stop

Stops the specified ExtraHop appliance components. After the stop command is invoked, you can halt the operation of specific system component services without shutting down the entire ExtraHop appliance.

Syntax

extrahop#stop

Example

The following command sequence puts the interface in Stop mode and halts the operation of the ExtraHop bridge component service:

extrahop#stop exbridge

The stop command supports the following sub-commands:

exbridge

Specifies the ExtraHop bridge as the system component service to stop.

Syntax

extrahop#stop exbridge
excap

Specifies the ExtraHop capture as the system component service to stop.

Syntax

extrahop#stop excap
exportal

Specifies the ExtraHop web portal as the system component service to stop.

Syntax

extrahop#stop exportal
webserver

Specifies the ExtraHop web server as the system component service to stop.

Syntax

extrahop#stop webserver

support

Provides commands to enable or disable the ExtraHop appliance support account. After the support command is invoked, you can enable or disable the support account.

Syntax

extrahop#support

Example

The following command sequence puts the interface in Support mode and it activates the support account:

extrahop#support enable

The support command includes the following sub-commands:

enable

Turns on the ExtraHop appliance support account.

Syntax

extrahop#support enable
disable

Turns off the ExtraHop appliance support account.

Syntax

extrahop#support disable

traceroute

Executes the traceroute command on the ExtraHop appliance to measure packet delays across the network.

Syntax

extrahop#traceroute <addr>

Parameters

  • addr. Specifies the IP address of a network device.

Example

The following command executes the traceroute command to measure network packet loss for the route to and from the specified IP address:

extrahop#traceroute <addr>

Appendix

Common Acronyms

The following common computing and networking protocol acronyms are used in this guide.

Acronym Full Name
CIFS Common Internet File System
CLI Command Line Interface
CPU Central Processing Unit
DHCP Dynamic Host Configuration Protocol
DNS Domain Name System
ERSPAN Encapsulated Remote Switched Port Analyzer
FIX Financial Information Exchange
FTP File Transfer Protocol
HTTP Hyper Text Transfer Protocol
IP Internet Protocol
iSCSI Internet Small Computer System Interface
L2 Layer 2
L3 Layer 3
LDAP Lightweight Directory Access Protocol
MAC Media Access Control
MIB Management Information Base
NFS Network File System
NVRAM Non-Volatile Random Access Memory
RADIUS Remote Authentication Dial-In User Service
RPC Remote Procedure Call
RPCAP Remote Packet Capture
RSS Resident Set Size
SMPP Short Message Peer-to-Peer Protocol
SMTP Simple Message Transport Protocol
SNMP Simple Network Management Protocol
SSD Solid-State Drive
SSH Secure Shell
SSL Secure Socket Layer
TACACS+ Terminal Access Controller Access-Control System Plus
TCP Transmission Control Protocol
UI User Interface
VM Virtual Machine
Published 2017-07-17 18:27