Admin UI Guide

If you enable SNMP polling on your flow network configuration, you must specify the credentials that allow you to poll the network device. The SNMP authentication credentials apply to all flow networks in a CIDR block and are automatically applied to every discovered flow network unless custom credentials are configured.

1. Log in to the Administration settings on the ExtraHop system through https://<extrahop-hostname-or-IP-address>/admin.
2. In the Network Settings section, click Flow Networks.
3. In the Shared SNMP Credentials section, click Add SNMP Credentials.
4. Type the IPv4 CIDR block in the CIDR field. For example, type 10.0.0.0/8 to match any IP address that starts with 10 or 10.10.0.0/16 to match any IP address that starts with 10.10. You cannot configure an IP address to match all traffic.
5. Select v1, v2c, or v3 from the SNMP version drop-down list and then complete the remaining fields.
6. Click Save.

You must configure an email server and sender before the ExtraHop system can send alert notifications or scheduled dashboard reports.

1. Log in to the Administration settings on the ExtraHop system through https://<extrahop-hostname-or-IP-address>/admin.
2. In the Network Settings section, click Notifications.
3. Click Email Server and Sender.
4. In the SMTP Server field, type the IP address or hostname for the outgoing SMTP mail server. The SMTP server should be the fully qualified domain name (FQDN) or IP address of an outgoing mail server that is accessible from the ExtraHop system. If the DNS server is set, then the SMTP server can be a FQDN, otherwise you must type an IP address.
5. In the SMTP Port field, type the port number for SMTP communication. Port 25 is the default value for SMTP and port 465 is the default value for SSL/TLS encrypted SMTP.
6. Select one of the following encryption methods from the Encryption drop-down list:
   • None. SMTP communication is not encrypted.
   • SSL/TLS. SMTP communication is encrypted through the Secure Socket Layer/Transport Layer Security protocol.
   • STARTTLS. SMTP communication is encrypted through STARTTLS.
7. In the Alert Sender Address field, type the email address for the notification sender.

   Note:

   The displayed sender address might be changed by the SMTP server. When sending through a Google SMTP server, for example, the sender email is changed to the username supplied for authentication, instead of the originally entered sender address.

8. (Optional): Select the Validate SSL Certificates checkbox to enable certificate validation. If you select this option, the certificate on the remote endpoint is validated against the root certificate chains specified by the trusted certificates manager. Note that the host name specified in the certificate presented by the SMTP server must match the hostname specified in your SMTP configuration or validation will fail. In addition, you must configure which certificates you want to trust on the Trusted Certificates page. For more information, see Add a trusted certificate to your ExtraHop system
9. In the Report Sender Address field, type the email address responsible for sending the message. This field is only applicable when sending scheduled dashboard reports from a Command appliance or Reveal(x) 360.
10. Select the Enable SMTP authentication checkbox and then type the SMTP server setup credentials in the Username and Password fields.
11. (Optional): Click Test Settings, type your email address, and then click Send. You should receive an email message with the subject title ExtraHop Test Email.
12. Click Save.

Add a list of email addresses to a group, then select the group when you configure email settings for an alert or scheduled dashboard report. Although you can specify individual email addresses, email groups are an effective way to manage your recipient list.

1. Log in to the Administration settings on the ExtraHop system through https://<extrahop-hostname-or-IP-address>/admin.
2. In the Network Settings section, click Notifications.
3. Click Email Notification Groups.
4. Click Add Group.
5. In the Group Info section, configure the following information:

   Name: Type a name for the email group.

   System Health Notifications: Select this checkbox if you want the email group to receive system alerts that are generated under conditions such as:

   • A virtual disk is in a degraded state.
   • A physical disk is in a degraded state or has an increasing error count.
   • A necessary disk partition is missing for firmware, datastore, or packet capture data.
   • A device could not reconnect to ExtraHop Cloud Services.
   • A license is expired or expiring soon.
   • A backup for customizations and resources has failed.

6. In the Email Addresses text box, type the recipient email addresses that should receive the emails sent to 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.
7. Click Save.

The state of the network can be monitored through the Simple Network Management Protocol (SNMP). SNMP collects information by polling devices on the network. SNMP enabled devices can also send alerts to SNMP management stations. SNMP communities define the group where devices and management stations running SNMP belong, which specifies where information is sent. The community name identifies the group.

1. Log in to the Administration settings on the ExtraHop system through https://<extrahop-hostname-or-IP-address>/admin.
2. In the Network Settings section, click Notifications.
3. Under Notifications, click SNMP.
4. On the SNMP Settings page, in the SNMP Monitor field, type the hostname for the SNMP trap receiver.
   Separate multiple hostnames with commas.
5. In the SNMP Community field, type the SNMP community name.
6. In the SNMP Port field, type 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.
   The default response port is 162.
7. (Optional): Click Test Settings to verify that your SNMP settings are correct.
   If the settings are correct, you should see an entry in the SNMP log file on the SNMP server similar to this example, where 192.0.2.0 is the IP address of your ExtraHop system and 192.0.2.255 is the IP address of the SNMP server:
   A response similar to this example displays:

   Connection from UDP: [192.0.2.0]:42164->[ 192.0.2.255]:162

   Copy
8. Click Save.

The syslog export option enables you to send alerts from an ExtraHop system to any remote system that receives syslog input for long-term archiving and correlation with other sources.

1. Log in to the Administration settings on the ExtraHop system through https://<extrahop-hostname-or-IP-address>/admin.
2. In the Network Settings section, click Notifications.
3. In the Destination field, type the IP address of the remote syslog server.
4. From the Protocol drop-down menu, select TCP or UDP. This option specifies the protocol over which the information will be sent to your remote syslog server.
5. In the Port field, type the port number for your remote syslog server. By default, this value is set to 514.
6. Click Test Settings to verify that your syslog settings are correct. If the settings are correct, you should see an entry in the syslog log file on the syslog server similar to the following:

   Jul 27 21:54:56 extrahop name="ExtraHop Test" event_id=1

   Copy
7. Click Save.
8. (Optional): Modify the format of syslog messages.
   By default, syslog messages are not compliant with RFC 3164 or RFC 5424. However, you can format syslog messages to be compliant by modifying the running configuration file.
   1. Click Admin.
   2. Click Running Config (Unsaved Changes).
   3. Click Edit Config.
   4. Add an entry under syslog_notification where the key is rfc_compliant_format and the value is either rfc5424 or rfc3164.
      The syslog_notification section should look similar to the following code:

          "syslog_notification": {
              "syslog_destination": "192.168.0.0",
              "syslog_ipproto": "udp",
              "syslog_port": 514,
              "rfc_compliant_format": "rfc5424"
          }

      Copy
   5. Click Update.
   6. Click Done.
9. (Optional): Modify the timezone referenced in syslog timestamps.
   By default, syslog timestamps reference UTC time. However, you can modify timestamps to reference the ExtraHop system time by modifying the running configuration file.
   1. Click Admin.
   2. Click Running Config (Unsaved Changes).
   3. Click Edit Config.
   4. Add an entry under syslog_notification where the key is syslog_use_localtime and the value is true.
      The syslog_notification section should look similar to the following code:

          "syslog_notification": {
              "syslog_destination": "192.168.0.0",
              "syslog_ipproto": "udp",
              "syslog_port": 514,
              "syslog_use_localtime": true
          }

      Copy
   5. Click Update.
   6. Click Done.

You must upload a .pem file that includes both a private key and either a self-signed certificate or a certificate-authority certificate.

1. In the Network Settings section, click 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.

1. In the Network Settings section, click 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 generate the SSL self-signed certificate.

   Note:

   The default hostname is extrahop.

A certificate signing request (CSR) is a block of encoded text that is given to your Certificate Authority (CA) when you apply for an SSL certificate. The CSR is generated on the ExtraHop system where the SSL certificate will be installed and contains information that will be included in the certificate such as the common name (domain name), organization, locality, and country. The CSR also contains the public key that will be included in the certificate. The CSR is created with the private key from the ExtraHop system, making a key pair.

1. Log in to the Administration settings on the ExtraHop system through https://<extrahop-hostname-or-IP-address>/admin.
2. In the Network Settings section, click SSL Certificate.
3. Click Manage certificates and then click Export a Certificate Signing Request (CSR).
4. In the Subject Alternative Names section, type the DNS name of the ExtraHop system. You can add multiple DNS names and IP addresses to be protected by a single SSL Certificate.
5. In the Subject section, complete the following fields. Only the Common Name field is required.

   Field	Description	Examples
   Common Name	The fully qualified domain name (FQDN) of the ExtraHop system. The FQDN must match one of the Subject Alternative Names.	*.example.com discover.example.com
   E-mail Address	The email address of the primary contact for your organization.	webmaster@example.com
   Organizational Unit	The division of your organization handling the certificate.	IT Department
   Organization	The legal name of your organization. This entry should not be abbreviated and should include suffixes such as Inc, Corp, or LLC.	Example, Inc.
   Locality/City	The city where your organization is located.	Seattle
   State/Province	The state or province where your organization is located. This entry should not be abbreviated.	Washington
   Country Code	The two-letter ISO code for the country where your organization is located.	US

6. Click Export. The CSR file is automatically downloaded to your computer.

1. In the Access Settings section, click Support Access.
2. Click Generate SSH Key.
3. Click Generate SSH Key.
4. Copy the encrypted key from the text box and email the key to your ExtraHop representative.
5. Click Done.

To prevent SSH access to the ExtraHop system with an existing SSH key, you can revoke the current SSH key. A new SSH key can also be regenerated if needed.

1. In the Access Settings section, click Support Access.
2. Click Generate SSH Key.
3. Choose one of the following options:
   • Click Regenerate SSH Key and then click Regenerate.

     Copy the encrypted key from the text box and email the key to your ExtraHop representative and then click Done.

   • Click Revoke SSH Key to prevent SSH access to the system with the current key.

By adding a local user account, you can provide users with direct access to your ExtraHop system and restrict their privileges as needed by their role in your organization.

1. Log in to the Administration settings on the ExtraHop system through https://<extrahop-hostname-or-IP-address>/admin.
2. In the Access Settings section, click Users.
3. Click Add User.
4. In the Personal Information section, type the following information:

   Login ID: The username that users will log in to the sensor with, which cannot contain any spaces. For example, adalovelace.

   Full Name: A display name for the user, which can contain spaces. For example, Ada Lovelace.

   Password: The password for this account.

   Note:

   On sensors and consoles, the password must meet the criteria specified by the global password policy. On ExtraHop recordstores and packetstores, passwords must be 5 characters or more.

   Confirm Password: Re-type the password from the Password field.

5. In the Authentication Type section, select Local.
6. In the User Type section, select the type of privileges for the user.
   • System and access administration privileges enables full read and write access to the ExtraHop system, including Administration settings.
   • Limited privileges enable you to select from a subset of privileges and options.

   Note:

   For more information, see the User privileges section.

7. Click Save.

Add a user account for LDAP or SAML users when you want to provision the remote user before that user logs in to the ExtraHop system. After the user is added to the system, you can add them to local groups or share items directly with them before they log in through the LDAP or SAML provider.

1. Log in to the Administration settings on the ExtraHop system through https://<extrahop-hostname-or-IP-address>/admin.
2. In the Access Settings section, click Users.
3. Click Add User.
4. In the Personal Information section, type the following information:

   Login ID: The email address that the user logs in to their LDAP or SAML SSO identity provider with.

   Note:

   Only lowercase email addresses are supported for remote users.

   Full Name: The first and last name of the user.

5. In the Authentication Type section, select Remote.
6. Click Save.

The ExtraHop system supports the Lightweight Directory Access Protocol (LDAP) for authentication and authorization. Instead of storing user credentials locally, you can configure your ExtraHop system to authenticate users remotely with an existing LDAP server. Note that ExtraHop LDAP authentication only queries for user accounts; it does not query for any other entities that might be in the LDAP directory.

1. Log in to the Administration settings on the ExtraHop system through https://<extrahop-hostname-or-IP-address>/admin.
2. In the Access Settings section, click Remote Authentication.
3. From the Remote authentication method drop-down list, select LDAP and then click Continue.
4. On the LDAP Settings page, complete the following server information fields:
   1. In the Hostname field, type the hostname or IP address of the LDAP server. If you are configuring a hostname, make sure that the DNS entry of the ExtraHop system is properly configured.
   2. In the Port field, type the port number on which the LDAP server is listening.
   3. From the Server Type drop-down list, select Posix or Active Directory.
   4. (Optional): In the Bind DN field, type the bind DN. The bind DN is the user credentials that allow you 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.
   5. (Optional): In the Bind Password field, type the bind password. The bind password is the password required when authenticating with the LDAP server as the bind DN specified above. If you are configuring an anonymous bind, leave this field 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.
   6. From the Encryption drop-down list, select one of the following encryption options.

      None: This options specifies cleartext TCP sockets. All passwords are sent across the network in cleartext in this mode.

      LDAPS: This option specifies LDAP wrapped inside SSL.

      StartTLS: This option specifies TLS LDAP. (SSL is negotiated before any passwords are sent.)

   7. Select Validate SSL Certificates to enable certificate validation. If you select this option, the certificate on the remote endpoint is validated against the root certificates as specified by the trusted certificates manager. You must configure which certificates you want to trust on the Trusted Certificates page. For more information, see Add a trusted certificate to your ExtraHop system.
   8. Type a time value in the Refresh Interval field or leave the default setting of 1 hour. The refresh interval ensures that any changes made to user or group access on the LDAP server are updated on the ExtraHop system.
5. Configure the following user settings:
   1. Type the base DN in the Base DN field. The Base DN is the point from where a server will search for users. The base DN must contain all user accounts that will have access to the ExtraHop system. 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.
   2. Type a search filter in the Search Filter field. Search filters enable you to define search criteria when searching the LDAP directory for user accounts.

      Important:

      The ExtraHop system automatically adds parentheses to wrap the filter and will not parse this parameter correctly if you add parentheses manually. Add your search filters in this step and in step 5b, similar to the following example: cn=atlas* |(cn=EH-*)(cn=IT-*) In addition, if your group names include the asterisk (*) character, the asterisk must be escaped as Copy \2a. For example, if your group has a CN called test*group, type cn=test\2agroup in the Search Filter field.

   3. From the Search Scope drop-down list, select one of the following options. Search scope specifies the scope of the directory search when looking for user entities.

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

      Single level: This option looks for users that exist in the base DN only; not any subtrees.

6. (Optional): Import user groups. Select the Import user groups from LDAP server checkbox and configure the following settings.

   Note:

   Importing LDAP user groups enables you to share dashboards with those groups. The imported groups appear on the User Group page in the Administration settings.

   1. Type the base DN in the Base DN field. The Base DN is the point from where a server will search for user groups. The base DN must contain all user groups that will have access to the ExtraHop system. The user groups 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.
   2. Type a search filter in the Search Filter field. Search filters enable you to define search criteria when searching the LDAP directory for user groups.

      Important:

      For group search filters, the ExtraHop system implicitly filters on the objectclass=group, and so objectclass=group should not be added to this filter.

   3. From the Search Scope drop-down list, select one of the following options. Search scope specifies the scope of the directory search when looking for user group entities.

      Whole subtree: This option looks recursively under the base DN for matching user groups.

      Single level: This option looks for user groups that exist in the base DN; not any subtrees.

7. 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. You must resolve any errors before you continue.
8. Click Save and Continue.

You can configure your ExtraHop system to enable users to log in to the system through the Google identity management service.

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

1. Log in to the Administration settings on the ExtraHop system through https://<extrahop-hostname-or-IP-address>/admin.
2. In the Access Settings section, click Remote Authentication.
3. From the Remote authentication method drop-down list, select RADIUS and then click Continue.
4. On the Add RADIUS Server page, type the following information:

   Host

   The hostname or IP address of the RADIUS server. Make sure that the DNS of the ExtraHop system is properly configured if you specify a hostname.

   Secret

   The shared secret between the ExtraHop system and the RADIUS server. Contact your RADIUS administrator to obtain the shared secret.

   Timeout

   The amount of time in seconds that the ExtraHop system waits for a response from the RADIUS server before attempting the connection again.

5. Click Add Server.
6. (Optional): Add additional servers as needed.
7. Click Save and Finish.
8. From the Privilege assignment options drop-down list, choose one of the following options:
   • Remote users have full write access

     This option grants remote users full write access to the ExtraHop system. In addition, you can grant additional access for packet downloads, SSL session keys, NDR module access, and NPM module access.

   • Remote users have full read-only access

     This option grants remote users read-only access to the ExtraHop system. In addition, you can grant additional access for packet downloads, SSL session keys, NDR module access, and NPM module access.

9. (Optional): Configure packet and session key access. Select one of the following options to allow remote users to download packet captures and SSL session keys.
   • No access
   • Packet slices only
   • Packets only
   • Packets and session keys
10. (Optional): Configure NDR and NPM module access.
    • No access
    • Full access
11. Click Save and Finish.
12. Click Done.

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

1. Log in to the Administration settings on the ExtraHop system through https://<extrahop-hostname-or-IP-address>/admin.
2. In the Access Settings section, click Remote Authentication.
3. From the Remote authentication method drop-down list, select TACACS+, and then click Continue.
4. On the Add TACACS+ Server page, type the following information:

   Host: The hostname or IP address of the TACACS+ server. Make sure that the DNS of the ExtraHop system is properly configured if you are entering a hostname.

   Secret: The shared secret between the ExtraHop system and the TACACS+ server. Contact your TACACS+ administrator to obtain the shared secret.

   Note:

   The secret cannot include the number sign (#).

   Timeout: The amount of time in seconds that the ExtraHop system waits for a response from the TACACS+ server before attempting to connect again.

5. Click Add Server.
6. (Optional): Add additional servers as needed.
7. Click Save and Finish.
8. From the Permission assignment options drop-down list, choose one of the following options:
   • Obtain privileges level from remote server

     This option allows remote users to obtain privilege levels from the remote server. You must also configure permissions on the TACACS+ server.

   • Remote users have full write access

     This option grants remote users full write access to the ExtraHop system. In addition, you can grant additional access for packet downloads, SSL session keys, NDR module access, and NPM module access.

   • Remote users have full read-only access

     This option grants remote users read-only access to the ExtraHop system. In addition, you can grant additional access for packet downloads, SSL session keys, NDR module access, and NPM module access.

9. (Optional): Configure packet and session key access. Select one of the following options to allow remote users to download packet captures and SSL session keys.
   • No access
   • Packet slices only
   • Packets only
   • Packets and session keys
10. (Optional): Configure NDR and NPM module access.
    • No access
    • Full access
11. Click Save and Finish.
12. Click Done.

Users with system and access administration privileges can configure whether users can generate API keys for the ExtraHop system. You can allow only local users to generate keys, or you can also disable API key generation entirely.

1. Log in to the Administration settings on the ExtraHop system through https://<extrahop-hostname-or-IP-address>/admin.
2. In the Access Settings section, click API Access.
3. In the Manage API 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: Remote users cannot generate API keys.
   • No users can generate an API key: No API keys can be generated by any user.
4. Click Save Settings.

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.

1. In the Access Settings section, click API Access.
2. 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.

3. Click Save Settings and then click Done.

You must generate an API key before you can perform operations through the ExtraHop REST API. Keys can be viewed only by the user who generated the key or by users with system and access administration privileges. After you generate an API key, add the key to your request headers or the ExtraHop REST API Explorer.

1. In the Access Settings section, click API Access.
2. In the Generate an API Key section, type a description for the new key, and then click Generate.
3. Scroll down to the API Keys section, and copy the API key that matches your description.

By default, all supported modules on the ExtraHop system are included in the capture unless you manually exclude them.

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 dropdown, 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.

Add filters to exclude specific MAC addresses or vendor device traffic from the network capture

1. In the System Configuration section, click Capture.
2. Click MAC Address Filters.
3. Click Add Filter.
4. In the MAC Address field, type the MAC address to exclude.
5. In the Mask field, type the mask to indicate how many bits, from left to right, the filter checks against the MAC address.
6. Click Add.
   In the following example, the full MAC address is excluded from the capture:

   MAC Address: 60:98:2D:B1:EC:42

   Mask: FF:FF:FF:FF:FF:FF

   In this example, only the first 24 bits are evaluated for exclusion:

   MAC Address: 60:98:2D:B1:EC:42

   Mask: FF:FF:FF:00:00:00

Add filters to exclude specific IP addresses and IP ranges from the network capture on the ExtraHop system.

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.

Add filters to exclude traffic from specific ports from the network capture on the ExtraHop system.

1. In the System Configuration section,click Capture.
2. Click Port Filters.
3. Click Add Filter.
4. On the Add Port Filter page, type the port you want to exclude.
   • To specify a source port you want to exclude, type the port number in the Source Port field.
   • To specify a destination port you want to exclude, type the port number in the Destination Port field.
5. From the IP Protocol drop-down list, select the protocol you want to exclude on the indicated port.
6. Click Add.