ExtraHop Explore Admin UI Guide
Introduction to the ExtraHop Explore Admin UI
The ExtraHop Trace Admin UI Guide provides detailed information about the administrator features and functionality of the ExtraHop Trace applianceThe ExtraHop Explore Admin UI Guide provides detailed information about the administrator features and functionality for the Explore appliance.
In addition, this guide provides an overview of the global navigation and information about the controls, fields, and options available throughout the Explore Admin UI.
After you have deployed your Explore appliance, see the Explore Post-deployment Checklist.
We value your feedback. Please let us know how we can improve this document. Send your comments or suggestions to documentation@extrahop.com.
Supported Browsers
The following browsers are compatible with all ExtraHop appliances. We recommend that you install the latest version of the browser.
- Firefox
- Google Chrome
- Internet Explorer 11
- Safari
You must allow cookies and ensure that Adobe Flash Player is installed and enabled. Visit the Adobe website to confirm that Flash Player is installed and up-to-date.
Navigation
This section describes the general layout of the Admin UI on the ExtraHop Explore appliance.
The toolbar contains the following controls or links:
- Change default password
- Opens the Change Password page so that you can specify a new Admin UI password. For more information, see the Change the default password for the setup user section.
- Log out
- Ends the Admin UI session on the ExtraHop appliance. For more information, see the Log in and log out of the Admin UI section.
- Help
- Opens the ExtraHop Explore Admin UI Guide.
The administration page contains the following sections:
- Status and Diagnostics
- Verify how the Explore appliance is functioning on the network.
- Network Settings
- Configure the network settings for the Explore appliance.
- Access Settings
- Configure access settings to the Explore appliance.
- Appliance Settings
- Configure the system-level settings for the Explore appliance.
- Explore Cluster Settings
- Join an Explore cluster and manage cluster settings.
Status and Diagnostics
The Status and Diagnostics page displays metrics and logging data about the current state of the Explore appliance and enables system administrators to view the overall system health.
- Health
- Provides metrics to view the operating efficiency of the Explore appliance.
- Audit Log
- Enables you to view event logging data and to change syslog settings
- Fingerprint
- Provides the unique hardware fingerprint for the Explore appliance.
- Support Packs
- Enables you to upload and run support packages.
- Cluster Status
- Provides status information about the Explore cluster, cluster nodes, and indices.
Health
The Health page provides a collection of metrics that enable you check the operation of the Explore appliance. If issues occur with the Explore appliance, the metrics on the Health page help you to troubleshoot the problem and determine why the appliance is not performing as expected.
The following information is collected on the Health page.
- System
- Reports the following information about the system CPU usage and disk drives.
-
- CPU User
- Specifies the percentage of CPU usage associated with the Explore appliance user
- CPU System
- Specifies the percentage of CPU usage associated with the Explore appliance.
- CPU Idle
- Identifies the CPU idle percentage associated with the Explore appliance.
- CPU IO
- Specifies the percentage of CPU usage associated with the Explore appliance IO functions.
- Service Status
- Reports the status of Explore appliance system services
-
- exadmin
- Specifies the amount of time the Explore appliance web portal service has been running.
- exconfig
- Specifies the amount of time the Explore appliance config service has been running
- exreceiver
- Specifies the amount of time the Explore appliance receiver service has been running.
- exsearch
- Specifies that amount of time that the Explore appliance search service has been running.
- Interfaces
- Reports the status of Explore appliance network interfaces.
-
- RX packets
- Specifies the number of packets received by the Explore appliance on the specified interface.
- RX Errors
- Specifies the number of received packet errors on the specified interface.
- RX Drops
- Specifies the number of received packets dropped on the specified interface.
- TX Packets
- Specifies the number of packets transmitted by the Explore appliance on the specified interface.
- TX Errors
- Specifies the number of transmitted packet errors on the specified interface.
- TX Drops
- Specifies the number of transmitted packets dropped on the specified interface.
- RX Bytes
- Specifies the number of bytes received by the Explore appliance on the specified interface.
- TX Bytes
- Specifies the number of bytes transmitted by the Explore appliance on the specified interface.
- Partitions
- Reports the status and usage of Explore appliance components. The configuration settings for these components are stored on disk and retained even when the power to the appliance is turned off.
-
- Name
- Specifies the Explore appliance settings that are stored on disk.
- Options
- Specifies the read-write options for the settings stored on disk.
- Size
- Specifies the size in gigabytes for the identified component.
- Utilization
- Specifies the amount of memory usage for each of the components as a quantity and as percentage of total disk space.
- Record Sources
- Displays metrics about the records that are sent from the Discover appliance to the Explore cluster.
-
- Source EDA
- Displays the name of the Explore appliance that is sending records to the Explore cluster.
-
- Last Update
- Displays the timestamp when record collection began. The value is reset automatically every 24 hours or whenever the Explore appliance is restarted.
- RX Bytes
- Displays the number of compressed record bytes received from the Discover appliance.
- Record Bytes
- Displays the number of bytes received from the Discover appliance.
- Record Bytes Saved
- Displays the number of bytes successfully saved to the Explore appliance.
- Records Saved
- Displays the number of records successfully saved to the Explore appliance.
- Record Errors
- Displays the number of individual record transfers that resulted in an error. This value indicates the number of records that did not transfer successfully from the exreceiver process.
- TXN Errors
- Displays the number of bulk record transactions that resulted in an error. Errors in this field might indicate missing records.
- TXN Drops
- Displays the number of bulk records transactions that did not complete successfully. All records in the transaction are missing.
Audit log
The audit log provides data about the operations of the system, broken down by component. The log lists all known events by timestamp with the most recent events at the top of the list. You can configure where to send these logs in the Syslog Settings section.
The appliance collects the following log data and reports the results on the Audit Log page.
- Time
- Specifies the time at which the event occurred.
- User
- Identifies the user who initiated the logged event.
- Operation
- Specifies the system operation that generated the logged event.
- Details
- Specifies 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
- Identifies the appliance component that is associated with the logged event.
To configure the syslog settings:
Fingerprint
The Fingerprint page displays the device fingerprint for the Explore appliance. When joining a new Explore node or pairing a new publisher or client with the Explore cluster through this node, make sure that the fingerprint displayed is exactly the same as the fingerprint shown on the join or pairing page.
Explore Cluster Status
The Explore Cluster Status page provides details on the health of the Explore appliance.
Cluster
- Status
- The following status names can appear:
- Ready
- The node is available to join an Explore cluster.
- Green
- All data is replicated across the cluster.
- Yellow
- The primary shard is allocated but replica shards are not.
- Red
- One or more shards from the index are missing.
Note: If the status never returns to a yellow or green state, you might have to restore the cluster. For more information, see Restore the cluster state
Cluster Nodes
- Nickname
- Displays the nickname of the Explore node when configured on the page.
- Host
- Displays the IP address or hostname of the Explore node.
Indices
- Date (UTC)
- Displays the date the index was created.
- ID
- Displays the ID of the index. An ID other than 0 means that an index with the same date, but from a different source exists on the cluster.
- Source
- Displays the hostname or IP address of the Discover appliance where the record data originated.
- Records
- Displays the total number of records sent to the Explore appliance.
- Size
- Displays the size of the index.
- Status
- Displays the replication status of data on the cluster.
- Shards
- Displays the number of shards in the index.
- Unassigned Shards
- Displays the number of shards that have not been assigned to a node. Unassigned shards are typically replica shards that need to be kept on a different node than the node with the corresponding primary shard, but there are not enough nodes in the cluster. For example, a cluster with just one member will not have a place to store the replica shards, so with the default replication level of 1, the index will always have unassigned shards and have a yellow status.
- Relocating Shards
- Displays the number of shards that are moving from one node to another. Relocating shards typically occurs when an Explore node in the cluster fails.
Delete records
In certain circumstances, such as moving an Explore cluster from one network to another, you might want to delete records from the cluster.
You can delete records by index. An index is a collection of records that were created on the same day. Indexes are named according to the following pattern:
<node-id>-<date>-<index-id>
For example, an index titled extrahop-4-2016-5-16-0 indicates that the related records were created on May 16, 2016 (dates are specified in UTC). You can delete all data for a given day or span of days; for example, you might want to delete record content that you know contains sensitive information.
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 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 system.
- Run Default Support Pack
- Create a diagnostic support package that can be downloaded and sent to the ExtraHop Support team.
View the diagnostic support packages on the system
- In the Diagnostics section, click Support Packs.
- Click View Support Pack Results.
Download a selected diagnostic support package
Note: | Support pack files are encrypted and can be decrypted only by ExtraHop Support. |
- In the Diagnostics section, click Support Packs.
- Click View Support Pack Results.
- Click the name of the diagnostic support package that you want to download. The file will download to your browser's default download location.
Delete a selected diagnostic support package
- In the Diagnostics section, click Support Packs.
- Click View Support Pack Results.
- Locate the diagnostic support package that you want to delete.
- Click the Delete icon next to the support package create date.
- At the prompt, click OK.
Upload support pack
- In the Diagnostics section, click Support Packs.
- Click Upload Support Pack.
- Click Choose File.
- Navigate to the diagnostic support package that you want to upload.
- Select the file and click Open.
- Click Upload to add the file to the ExtraHop appliance.
Create a system support pack
Some support packs only perform a function on the ExtraHop appliance, while other support packs 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 View Support Pack Results page.
To create a diagnostic support package that can be downloaded and sent to the ExtraHop Support team:
- In the Diagnostics section, click Support Packs.
- Click Run Default Support Pack.
- Click OK.
Network settings
The Network Settings section includes the following configurable network connectivity settings.
- Connectivity
- Configure network connections.
- SSL Certificate
- Generate and upload a self-signed certificate.
- Notifications
- Set up alert notifications through email and SNMP traps.
The Explore appliance has four 10/100/1000baseT network ports and two 10GbE SFP+ network ports. By default, the Gb1 port is configured as the management port and requires an IP address. The Gb2, Gb3 and Gb4 ports are disabled and not configurable.
You can configure either of the 10GbE networks ports as the management port, but you can only have one management port enabled at a time.
Before you begin configuring the network settings on an Explore appliance, verify that a network patch cable connects the Gb1 port on the Explore appliance to the management network. For more information about installing an Explore appliance, refer to the Explore appliance deployment guide or contact ExtraHop Support for assistance.
For specifications, installation guides, and more information about your appliance, refer to docs.extrahop.com.
Atlas Services
Atlas Services provide ExtraHop customers with a remote analysis report that is delivered monthly. The report contains specific recommendations for critical components across the application delivery chain.
Connectivity
To connect the appliance to the host network, the following network configuration is required:
Network Settings
- Hostname
- Specifies the name of the appliance on the network.
- Primary DNS
- Specifies the IP address of the primary domain name server for the specified domain
- Secondary DNS
- (Optional) Specifies the IP address of the secondary domain name server for the specified domain.
Interfaces
- Interface
- Lists the available interfaces on the node.
- Mode
- Specifies whether the port is enabled or disabled and if enabled, the port assignment.
- DHCP
- Specifies whether DHCP is enabled or disabled.
- IP address
- Specifies the static IP address of the appliance on the network
- Netmask
- Specifies the netmask used to divide the IP address into subnets.
- Gateway
- Specifies the IP address for the gateway node on the network.
- Routes
- Specifies network route information if DHCP is disabled.
- MAC Address
- Specifies the MAC address of the appliance
- IPv6
- Specifies whether IPv6 is enabled or disabled.
Interface status
In the Interface Status section, a diagram of the back of the physical Explore appliance displays the following information about the current interface connections:
- Blue Ethernet Port
- Identifies the management port.
- Gray Ethernet Port
- Identifies a disabled port.
Note: | The Interface Status section only appears for physical appliances. |
Set a static route
Before you begin
You must disable DHCPv4 before you can add a static route.- On the Edit Interface page, ensure that the IPv4 Address and Netmask fields are complete and saved, and click Edit Routes.
- In the Add Route section, type a network address range in CIDR notation in the Network field and IPv4 address in the Via IP field and then click Add.
- Repeat the previous step for each route you want to add.
- Click Save.
Global proxy server
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.
Note: | Only one global proxy server can be configured per ExtraHop appliance. |
ExtraHop Cloud proxy
If your ExtraHop appliance does not have a direct internet connection, you can connect to the internet through a proxy server specifically designated for ExtraHop Cloud services and Atlas connectivity. Only one proxy can be configured per ExtraHop appliance.
Note: | If no cloud 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 connect through an HTTP proxy to enable the services. |
Configure an ExtraHop Cloud proxy server
- In the Network Settings section, click Connectivity.
- Click Enable ExtraHop Cloud Proxy. Click Change ExtraHop Cloud Proxy to modify an existing configuration.
- Click Enable ExtraHop Cloud Proxy.
- Type the hostname or IP address for your proxy server.
- Type the port number for your proxy server, such as 8080.
- (Optional): If required, type a username and password for your proxy server.
- Click Save.
Bond interfaces
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 enable 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. Bond interfaces cannot be set to monitoring mode.
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 configurable 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.
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.
Modify bond interface settings
After a bond interface is created, you can modify most settings as if the bond interface is a single interface.
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.
- In the Network Settings section, click Connectivity.
- In the Bond Interfaces section, click the red X next to the interface you want to destroy.
- 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.
- Click Destroy.
Notifications
The ExtraHop appliance can send alert notifications through email and SNMP traps. If SNMP is specified, then every alert is sent as an SNMP trap to the specified SNMP server. In addition, you can send alerts to a remote server through a syslog export.
The Notifications section in the Network Settings section of the Admin UI includes the following configurable settings.
- Email Server and Sender
- Configure the email server and sender settings.
- Email Addresses
- Add individual email addresses to receive system health notifications.
- SNMP
- Set up SNMP network monitoring.
- Syslog
- Send appliance data to another system for archiving and correlation.
Email addresses
You can send system storage alerts to individual recipients. Alerts are sent under the following conditions:
- A virtual disk is in a degraded state.
- A physical disk is in a degraded state.
- A physical disk has an increasing error count.
- A registered Explore node is missing from the cluster. The node might have failed, or it is powered off.
Add a new notification email address
To add a new disk notification email address:
- In the Network Settings section, click Notifications.
- Under Notifications, click Email Addresses.
- In the Email address text box, type the recipient email address.
- Click Save.
Delete a disk notification email address
To delete a disk notification email address:
- In the Network Settings section, click Notifications.
- Under Notifications, click Email Addresses.
- Click the red delete icon (X) to the right of the email address.
- On the Delete page, click OK.
The running config changes when you add or remove an email address. To preserve your changes, click View and Save Changes. For more information, see the Running Config section.
SNMP
The state of the network is monitored through the Simple Network Management Protocol (SNMP). SNMP collects information by polling devices on the network or SNMP enabled devices send alerts to SNMP management stations. SNMP communities define 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 syslog notification settings
The syslog export enables you to send alerts from the ExtraHop appliance to any remote system that receives syslog input for long-term archiving and correlation with other sources.
Note: | 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. |
SSL certificate
SSL provides secure authentication to the Admin UI of the ExtraHop appliance. To enable SSL, a SSL certificate must be uploaded to the 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 reporting 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.
Upload an SSL certificate
You must upload a .pem file that includes both a private key and either a self-signed certificate or a certificate-authority certificate.
Note: | The .pem file must not be password protected. |
- In the Network Settings section, click SSL Certificate.
- Click Manage certificates to expand the section.
- Click Choose File and navigate to the certificate that you want to upload.
- Click Open.
- Click Upload.
Add a trusted certificate to your ExtraHop appliance
Your ExtraHop appliance only trusts peers who present a TLS certificate that is signed by one of the built-in system certificates or any certificates that you upload. Only SMTP and LDAP connections are validated through these certificates.
Before you begin
You must be a user with full system privileges to add or remove trusted certificates.Important: | To trust the built-in system certificates and any uploaded certificates, you must also enable SSL certificate validation on the LDAP Settings page or Email Settings page. |
- Log into the Admin UI.
- In the Network Settings section, click Trusted Certificates.
- The ExtraHop appliance ships with a set of built-in certificates. Select Trust System Certificates if you want to trust these certificates, and then click Save.
- To add your own certificate, click Add Certificate and then paste the contents of the PEM-encoded certificate chain into the Certificate field
- Type a name into the Name field and click Add.
Important: | ExtraHop appliances only accept modern SSL configurations, which
includes TLS 1.2 and the cipher suites listed below. Note that the ExtraHop Web UI
will not display in Internet Explorer 11 unless TLS 1.0, TLS 1.1, and TLS 1.2 are
turned on in the advanced settings for Internet Explorer 11.
|
Next steps
Configure LDAP and SMTP settings to validate outbound connections with the trusted certificates.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. The Access Settings section has the following configurable settings:
- 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 Admin UI.
- Remote Authentication
- Enable users to log on to the Admin UI with their existing credentials.
- API Access
- Manage the settings that enable you to perform operations through the ExtraHop REST API.
- User Groups
- View and manage user groups imported from a configured LDAP server. The User Groups page appears only on ExtraHop Discover and Command appliances.
Change password
Users with administrative privileges to the Admin UI on the appliance can change the password for any user that has an account stored locally in the appliance. For more information about privileges for specific Admin UI users and groups, see the Users section.
Change the password settings
Note: | You can only change passwords for local users, not users authenticated with LDAP. |
- In the Access Settings section, click Change Password.
- Select the user from the drop-down list.
- Type the new password In the New password field.
- Retype the new password in the Confirm password field.
- Click Save.
Change the default password for the setup user
It is recommended that you change the default password for the setup user on the ExtraHop appliance after you log in for the first time. To remind administrators to make this change, there is a blue Change Password button at the top of the page while the setup user is accessing the Admin UI. After the setup user password is changed, the button at the top of the page no longer appears.
Note: | The password must be a minimum of 5 characters. |
Support account
Support accounts provide access for the ExtraHop Support team to help customers troubleshoot issues with the ExtraHop appliance and to provide remote analysis reports through Atlas Services.
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.
Users
The Users page provides controls to add and delete users, and to change a user's access privileges in 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.
- setup
- The setup account provides full system read and write privileges on the Web UI, Admin UI, and Shell, which is the ExtraHop command-line interface (CLI). For physical appliances, the default password for this account is the service tag number on the right-front bracket of the ExtraHop appliance. For virtual appliances, the password is default.
- shell
- The shell account permits access to non-administrative shell commands in the ExtraHop command-line interface (CLI). When accessing the privileged system configuration shell commands, the user types in enable and authenticates with the setup user password. For physical appliances, the default password for this account is the service tag number on the right-front bracket of the ExtraHop appliance. For virtual appliances, the password is default.
Note: | The default ExtraHop password for Amazon Web Services (AWS) users is the string of numbers after the -i in the instance ID. |
- When a user is authenticated and authorized locally, the user appears immediately in the managed users list. User permissions are managed in the ExtraHop appliance.
- When user is authenticated remotely but its authorization is managed locally, the user appears in the managed users list after the first login. The user's permissions are managed in the ExtraHop appliance.
- When a user is both authenticated and authorized remotely, the user does not appear in the managed users list. The user's permissions are managed in the remote server.
Note: | The local user account overrides all remote user account settings. |
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.
Delete active sessions
When you delete an active session for a user, the user is logged out of the Admin UI. You can not delete the current user session.
- In the Access Settings section, click Sessions.
-
Select the users that you want to delete.
- To delete a specific user, in the sessions table, click the red x at the end of the row for the specific user.
- To delete all active user sessions, click Delete All and then click OK.
Remote authentication
ExtraHop appliances supports remote authentication for user authentication. Remote authentication 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 appliance with 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 configure remote authentication, you must have a remote server with one of the following configurations:
- LDAP (such as OpenLDAP or Active Directory)
Administrators can grant access to all known users or restrict access by applying LDAP filters.
- RADIUS
- TACACS+
LDAP
The ExtraHop system supports the Lightweight Directory Access Protocol (LDAP) for authentication and authorization. ExtraHop LDAP authentication only queries for user accounts; it does not use any other entities that might be in the LDAP directory.
Users whose credentials are not stored locally are authenticated against the remote LDAP server by their username and password when they attempt to log onto the ExtraHop system. When a user attempts to log onto the ExtraHop UI, the ExtraHop system:
-
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 system is configured to use LDAP for remote authentication.
-
Logs the user on to the ExtraHop system if the user exists and the password is validated through LDAP. The LDAP password is not stored locally on the ExtraHop system.
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.
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.
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.
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, listed in the Keys section, and can be viewed only by the user who generated the key.
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. |
Click the REST API Explorer link to open a web-based tool that enables you to try API calls directly on your ExtraHop 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.
Manage API access
You can manage which users are able to generate API keys on the ExtraHop appliance.
- In the Access Settings section, click API Access.
-
In the Manage Access section, select one of the following
options:
- Allow all users to generate an API key
Local and remote users can generate API keys.
- Only local users can generate an API key
Only users created on the appliance can generate API keys.
- No users can generate an API key
API keys cannot be generated. Selecting this option will delete any
- Allow all users to generate an API key
- Click Save Settings, then click OK, and then click Done.
Next steps
Save the changes to the running config file.Enable CORS for the ExtraHop REST API
Cross-origin resource sharing (CORS) allows you to access the ExtraHop REST API across domain-boundaries and from specified web pages without requiring the request to travel through a proxy server.
You can configure one or more allowed origins or you can allow access to the ExtraHop REST API from any origin. Only administrative users with full system privileges can view and edit CORS settings.
Add an allowed origin
You can configure one or more allowed origins or you can allow access to the ExtraHop REST API from any origin.
- In the Access Settings section, click API Access.
-
In the CORS Settings section, specify one of the following
access configurations.
- To add a specific URL, type an origin URL in the text box, and then
click the plus (+) icon or press ENTER.
The URL must include a scheme, such as HTTP or HTTPS, and the exact domain name. You cannot append a path; however, you can provide a port number.
- To allow access from any URL, select the Allow API requests
from any Origin checkbox.
Note: Allowing REST API access from any origin is less secure than providing a list of explicit origins.
- To add a specific URL, type an origin URL in the text box, and then
click the plus (+) icon or press ENTER.
- Click Save Settings and then click Done.
Delete an allowed origin
You can delete a URL from the list of allowed origins or disable access from all origins.
- In the Access Settings section, click API Access.
-
In the CORS Settings section, modify one of the following access
configurations.
- To delete a specific URL, click the delete (X) icon next to the origin you want to delete.
- To disable access from any URL, clear the Allow API requests from any Origin checkbox.
- Click Save Settings.
Explore cluster settings
The Explore Cluster Settings section provides the following configurable settings:
- Join Cluster
- Join an Explore appliance to an existing Explore cluster. This setting appears only for single nodes that have not yet been joined to an Explore cluster.
- Cluster Members
- Displays all of the Explore nodes that are members of the Explore cluster.
- Managers and Clients
- Displays the hostname of the Command appliance that is configured to manage the Explore appliance as well as a list of all Discover appliances and Command appliances connected to the ExtraHop Explore appliance.
- Data Management
- Displays settings to set the data replication level and enable or disable shard reallocation.
- Connect to a Command Appliance
- Configure settings to enable a Command appliance to remotely run support packs on the Explore appliance
- Restore Cluster State
- Restore the Explore cluster to a healthy state. This setting only appears if the Explore cluster displays a status of red on the Cluster Status page.
Join an Explore cluster
To join a single Explore node to an existing Explore cluster:
- In the Explore Cluster Settings section, click Join Cluster.
- In the Host text box, type the host name or IP address of a node in the Explore cluster and then click Continue.
- Verify the fingerprint that appears matches the fingerprint of the Explore node that you are joining.
- In the Setup Password field, type the password for the setup user.
- Click Join.
Cluster Members
The Explore Cluster Members page displays the following properties for each node in the Explore cluster.
- Nickname
- Displays the IP address or nickname of the Explore appliance.
- To assign a nickname, or change the existing nickname of a cluster member, click the IP address or nickname in the Nickname column, type a name in the Name field, and then click Rename Node.
- Host
- Displays the IP address of the Explore appliance.
- License Status
- Displays the current status of the ExtraHop license. The License Status
field displays one of the following states:
- Nominal
- The Explore appliance has a valid license.
- Invalid
- The Explore appliance has an invalid license. New records cannot be written to this node and existing records cannot be queried.
- Pre-Expired
- The Explore appliance has a license that is expiring soon.
- Pre-Disconnected
- The Explore appliance cannot connect to the ExtraHop license server.
- Disconnected
- The Explore appliance has not connected to the ExtraHop license server for more than 7 days. New records cannot be written to this node and existing records cannot be queried.
- Actions
- Remove an Explore node from the cluster.
Remove a node from the cluster
- In the Explore Cluster Settings section, click Cluster Members.
- In the Actions column for the node you want to remove, click Remove Node.
- Click Remove Node to confirm.
Leave an Explore cluster
You can remove the local Explore node from an Explore cluster to remove all saved data on the node.
Manager and Connected Appliances
The Manager and Connected Appliances section includes the following information and controls.
- Manager
- Displays the hostname of the Command appliance that is configured to manage the Explore appliance. To connect to a Command appliance through a tunneled connection, click Connect to a Command Appliance. A tunneled connection might be required if a direct connection cannot be established through the Command appliance.
- Click Remove Manager to remove the Command appliance as the manager.
Note: The Explore appliance can be managed by only one Command appliance. - Clients
- Displays a table of all Discover appliances and Command appliances connected to the Explore appliance. The table includes the hostname of the connected client and the client product key.
- Click Remove Client in the Actions column to remove a connected client.
Data Management
You can configure the replication level of data on the Explore cluster. Additionally, you can enable and disable shard reallocation. You must connect a Discover appliance to the Explore cluster before you can configure replication level and shard reallocation settings.
Replication
You can change the replication level to specify the number of copies of the collected data stored on the cluster. A higher number of copies improves fault tolerance if a node fails and also improves the speed of query results. However, a higher number of copies takes up more disk space and might slow the indexing of the data.
Shard reallocation
Data in an Explore cluster is split up into manageable chunks called shards. Shards might need to be created or moved from one node to another, as in the case of a node failure.
Shard reallocation is enabled by default. Prior to updating the firmware or taking the node offline for maintenance (for example, replacing disks, power cycling the appliance, or removing network connectivity between Explore nodes), you should disable shard reallocation by doing the following:
- In the Cluster Settings section, click Data Management.
- Under Shard Reallocation, click Disable Shard Reallocation.
- After node maintenance is complete, enable shard reallocation by clicking Enable Shard Reallocation.
Connect to a Command appliance
Connect to a Command appliance to remotely run support packs and upgrade firmware on the Explore appliance.
The Explore appliance connects to the Command appliance through a tunneled connection. Tunneled connections are required in network environments where a direct connection from the Command appliance is not possible because of firewalls or other network restrictions.
Restore the cluster state
In rares instances, the Explore cluster might not recover from a red status, as seen in the Status section on the Cluster Status page. When this state occurs, it is possible to restore the cluster to a green state.
When you restore the cluster state, the Explore cluster is updated with the latest stored information about the Explore nodes in the cluster and all other connected appliances (Discover and Command appliances).
Important: | If you have recently restarted your Explore cluster, it might take an hour before the cluster status green appears, and restoring the cluster might not be necessary. If you are unsure whether you should restore the cluster state, contact ExtraHop Support. |
- In the Explore Cluster Settings section, click Restore Cluster State.
- On the Restore Cluster State page, click Restore Cluster State.
- Click Restore Cluster to confirm.
Appliance Settings
You can configure the following components of the ExtraHop appliance in the Appliance Settings section.
- Running Config
- Download and modify the running configuration file.
- Services
- Enable or disable the Web Shell, management GUI, SNMP service, and SSH access. The Services page appears only on ExtraHop Discover and Command appliances.
- Firmware
- Upgrade the ExtraHop system firmware.
- System Time
- Configure the system time.
- Shutdown or Restart
- Halt and restart system services.
- License
- Update the license to enable add-on modules.
- Disks
- Provides information about the disks in the appliance.
- Reset Packetstore
- Delete all packets stored on the ExtraHop Trace appliance. The Reset Packetstore page appears only on the Trace appliance.
Firmware
The Admin UI provides an interface to upload and delete the firmware on ExtraHop appliances.
The Admin UI includes the following firmware configuration settings:
- Upgrade
- 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.
Firmware images that you want to upload must be accessible from the computer on which you are running the web browser.
Note: | If you are upgrading the firmware on a Command appliance, first upgrade the Command appliance, next update all Discover appliances, and finally upgrade each Explore and Trace appliance individually. To function correctly, the Command appliance and Discover appliances must have the same minor version of ExtraHop firmware. |
Upgrade the firmware on your ExtraHop appliance
The following procedures show you how to upgrade your ExtraHop appliance to the latest firmware release. If you need assistance with your upgrade, contact ExtraHop Support.
Before you begin
- Download the firmware from the ExtraHop Customer Portal to your computer.
- If you have an ExtraHop Command appliance, upgrade the Command appliance first followed by all connected Discover appliances, and then upgrade all connected Explore and Trace appliances. The Command appliance firmware version must be greater than or equal to the firmware version of any connected appliances.
- For large Command appliance deployments (managing 50,000 devices or more), reserve a minimum of one hour to perform the upgrade.
- You must upgrade all Explore nodes in an Explore cluster. Note that during the upgrade, any nodes on different firmware versions might be unable to communicate with each other. During the upgrade process, the message "Error determining cluster state" might appear in the Explore Cluster settings section in the Admin UI of any node. After all of the nodes in the cluster are upgraded, the message no longer appears.
- You must disable all triggers on the Discover appliances that commit records to the Explore cluster and disable automatic flow records before upgrading. You can re-enable these settings after the Explore cluster status returns to Green. Note that records will not be collected during the upgrade.
Note: | Your browser might time out
after 5 minutes of inactivity. Refresh the browser page if the update appears
incomplete. If the browser session times out before the ExtraHop appliance is able to complete the update process, you can try the following connectivity tests to confirm the status up the upgrade process:
|
Delete firmware versions
The ExtraHop appliance stores every firmware image that has been uploaded to the system. For maintenance purposes, these firmware images can be deleted from the system.
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 set time locally or synchronize time with a time server. By default, system time is set locally, but we recommend that you change this setting and set time through a time server.
The System Time page displays the current configuration and the status of all configured NTP servers.
- Time Zone. Displays the currently selected time zone.
- System Time. Displays the current system time.
- Time Servers. Displays a comma-separated list of configured time servers.
- remote
- The host name or IP address of the remote NTP server you have configured to synchronize with.
- st
- The stratum level, 0 through 16.
- t
- The type of connection. This value can be u for unicast or manycast, b for broadcast or multicast, l for local reference clock, s for symmetric peer, A for a manycast server, B for a broadcast server, or M for a multicast server
- when
- The last time when the server was queried for the time. The default value is seconds, or m is displayed for minutes, h for hours, and d for days.
- poll
- How often the server is queried for the time, with a minimum of 16 seconds to a maximum of 36 hours.
- reach
- Value that shows the success and failure rate of communicating with the remote server. Success means the bit is set, failure means the bit is not set. 377 is the highest value.
- delay
- The round trip time (RTT) of the ExtraHop appliance communicating with the remote server, in milliseconds.
- offset
- Indicates how far off the ExtraHop appliance clock is from the reported time the server gave you. The value can be positive or negative, displayed in milliseconds.
- jitter
- Indicates the difference, in milliseconds, between two samples.
Shutdown or restart
The Explore Admin UI provides an interface to halt, shutdown, and restart the Explore appliance components.
- System
- Restart or shut down the Explore appliance.
- Admin
- Restart the Explore appliance administrator component.
- Receiver
- Restart the Explore receiver component.
- Search
- Restart the Explore search service.
For each Explore appliance component, the table includes a time stamp to show the start time.
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 the ExtraHop appliance
- System Information
- Displays the identification and expiration information about the ExtraHop appliance.
- Features
- Displays the list of licensed features and whether the licensed features are enabled or disabled.
Running config
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 preserved after a system restart.
The following controls are available to manage the default running system configuration settings:
- Save config or Revert config
- Save changes to the current default system configuration. The Revert config option appears when there are unsaved changes.
- 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 system modifications through other pages in the Admin UI. |
Saving 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.
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.
As a reminder that the running configuration has changed, the Admin UI provides the following three notifications:
- Save Configuration
- 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.
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 running config as a text 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.
- Click Running Config.
- Click Download config as a File.
Disks
The Disks page provides information about the configuration and status of the disks in your Explore appliance. The information displayed on this page varies based on whether you have a physical or virtual appliance.
Note: | We recommend that you configure the settings to receive email notifications about your system health. If a disk is beginning to experience problems, you will be alerted. For more information, see the Notifications section. |
The following information displays on the page:
- Drive Map
- (Physical only) Provides a visual representation of the front of the Explore appliance.
- RAID Disk Details
- Provides access to detailed information about all the disks in the node.
- Firmware
- Displays information about disks reserved for the Explore appliance firmware.
- Utility (Var)
- Displays information about disks reserved for system files.
- Search
- Displays information about disks reserved for data storage.
- Direct Connected Disks
- Displays information about virtual disks on virtual machine deployments, or USB media in physical appliances.
Thank you for your feedback. Can we contact you to ask follow up questions?