Deploy the ExtraHop Command Appliance on Linux KVM

This document provides information on how to install the ExtraHop Command virtual appliance on a Linux kernel-based virtual machine (KVM). This guide assumes that you are familiar with basic KVM administration.

If you have not already done so, download the ExtraHop Command virtual appliance file for KVM from the ExtraHop Customer Portal.

Important:If you want to deploy more than one ExtraHop virtual appliance, create the new instance with the original deployment package or clone an existing instance that has never been started.


Before you can install the ExtraHop virtual appliance, make sure that your environment meets the following requirements:

  • A KVM hypervisor environment capable of hosting a VM that has:
    • 4 GB RAM
    • Two vCPUs.
    • One 4 GB boot disk (virtio-scsi interface recommended)
    • One 40 GB or larger datastore disk (virtio-scsi interface recommended)

    The hypervisor CPU should provide Supplemental Streaming SIMD Extensions 3 (SSSE3) support.

  • An ExtraHop virtual appliance license key

Performance guidelines

The performance of the ExtraHop Command appliance depends on the number of sensors you are deploying in combination with the number of devices you expect the system to discover in your environment. To determine the appropriate sizing, see the Command Appliance Performance Guidelines.

Package contents

The installation package for KVM systems is a tar.gz file that contains the following items:

The domain XML configuration file
An MD5 checksum file to verify the integrity of the eca.xml file.
The boot disk
An MD5 checksum file to verify the integrity of the extrahop-boot.qcow2 file.
The datastore disk
An MD5 checksum file to verify the integrity of the extrahop-data.qcow2 file.

Edit the domain XML configuration file

Edit the configuration file and create the ExtraHop virtual appliance.

  1. Extract the tar.gz file that contains the installation package.
  2. Copy the two disks extrahop-boot.qcow2 and extrahop-data.qcow2 to your KVM system. Make a note of the location where you store these files.
  3. Open the domain XML configuration file. Find and edit the following values:
    1. Change the VM name (ExtraHop-ECA) to the name you want to assign to your ExtraHop virtual appliance.
    2. Change the source file path [PATH_TO_STORAGE] with the location where you stored the virtual disk files in step 1.
      <source file='[PATH_TO_STORAGE]/extrahop-boot.qcow2'/>
      <source file='[PATH_TO_STORAGE]/extrahop-data.qcow2'/>
  4. Save the XML file.
  5. Log in to the KVM console.
  6. Create the new ExtraHop virtual appliance with your revised domain XML configuration file by running the following command:
    virsh define eca.xml
  7. Start the virtual machine by running the following command:
    virsh start <vm_name>

    Where <vm_name> is the name of your virtual appliance you configured in step 3.

(Optional) Configure a static IP address

By default, ExtraHop systems ship with DHCP enabled. If your network does not support DHCP, you must configure a static address manually.

  1. Log in to the KVM host.
  2. Run the following command to connect to the ExtraHop system through the virtual serial console:
    virsh console <vm_name>

    Where <vm_name> is the name of your virtual machine.

  3. Press ENTER twice to get to the system login prompt.
    ExtraHop Discover Appliance Version
    exampleium login: 
  4. At the login prompt, type shell, and then press ENTER.
  5. At the password prompt, type default, and then press ENTER.
  6. To configure the static IP address, run the following commands:
    1. Enable privileged commands:
    2. At the password prompt, type default, and then press ENTER.
    3. Enter configuration mode:
    4. Enter the interface configuration mode:
    5. Run the ip command and specify the IP address and DNS settings in the following format: ip ipaddr <ip_address> <netmask> <gateway> <dns_server>
      For example:
      ip ipaddr
    6. Leave the interface configuration section:
    7. Save the running config file:
      running_config save
    8. Type y and then press ENTER.

Post-deployment actions

Open a web browser and type the IP address of the Command appliance in the address bar and then press ENTER. Accept the EULA and enter the product key to license the appliance.

Log in to the ExtraHop system with the setup user account and type default for the password.

Last modified 2023-11-07