Web Interface

Logging In

When navigating to the replicator using a modern web browser, the user will need to authenticate. The default login user name and password are admin. The password can be updated using the interactive mode command password webui.

Once LDAP server information is entered in the settings tab, users will also be able to log in using valid LDAP credentials. The LDAP password can be updated using the interactive mode command ldapadminpass.

After successfully logging in, the Dashboard Tab is displayed.

Dashboard Tab

The Dashboard Tab provides real time visualization feedback of the overall operations of the replicator. Information such as total packets inbound, packets outbound, bits inbound, and bits outbound are provided in both capacity charts (donut charts) and live trends (line graphs) displaying the last 20 data points of traffic. The time span of each trend will vary depending on the overall refresh rate of the live data.

Below the trends is a summary of total exporters, collectors, exporter/collector pairs, profiles, and last sample of traffic totals.

Streams Tab

The streams tab provides real time status of exporters sending packets to the replicator. New streams will highlight in green, and streams that stopped will highlight in red. The user can summarize all stopped streams by checking the alarm only box. A filter box is provided to quickly narrow the list down based on a keyword match.

By clicking the [check] link, the replicator will attempt to resolve the name of the exporter using DNS.

Additional details such as Last Status check, current status, and traffic details are displayed.

Exporters Tab

The exporters tab provides details related to the devices sending packets to the replicator. If there are any alarm conditions from the exporters, the total number of alerts will be highlighted by the Exporter Tab.

Exporters in Profiles

Any exporter that is in an alarm state is highlighted in red. The total number of exporters in profiles with alarms are highlighted beside the sub tab. The same checkbox and filter is available on each tab to quickly find the desired exporter(s).

Exporters Not in a Profile

The exporter tab contains two sub tabs. Exporters in Profiles (explained above) and Exporters Not in a Profile. The replicator will show users which incoming exporter streams are currently not associated with a profile.

The sub tab helps users quickly find and configure streams that are not replicated to any collectors. Exporters highlighted in red indicate a stream that was previously known has stopped. The user can click the [check] link to attempt to resolve the DNS name of that exporter. Clicking the [Add] link will pop up a dialog box to select a profile to associate this stream.

Additional details such as packets and bits received are displayed.

Collector Tab

The collector tab displays real time data related to collectors. The number beside the tab represents the number of collectors in an alarm state.

Any row highlighted in red indicates an issue with that collector. The user has many options to manage collectors.

  • Add details, or a note, to a collector by clicking the [edit] link
  • Set a threshold to alarm if a certain packet rate is exceeded. This can be done by clicking the [set] link in the status column.
  • [Delete] a collector from all profiles
  • [Add] the collector to a profile
  • [Remove] the collector from a profile
  • [View] a profile (this will leave the current tab)
  • Click [Check] to try and resolve the DNS name

Profiles Tab

Profiles define how packets come in and go out of the replicator. The profiles tab lists all configured profiles and their current state. The number beside the tab represents the number of profiles in an alarm state.

Real time data such as inbound and outbound traffic is shown as well as total policies, exporters, and collectors. Profiles highlighted in red indicate an issue with the policy. [edit] a policy will provide details on why that policy is in an alarm state.

The following actions are available from the profile tab:

  • [Delete] the profile which will stop packets to the collectors configured for the defined exporter streams
  • [Edit] the current profile
  • Create a new profile by clicking [New]

Creating a new Profile

Clicking the [new] link will display the new profile wizard. A profile consists of a name, an In Port, and an Out Port. The ports defined are UDP ports that direct the replicator on how to listen for and send packet traffic.

In most cases, users want to replicate traffic from any exporter sending packets on the in port. However if this isn’t desired, users can uncheck the match all and specify a network and CIDR (e.g. 192.168.2.0/24) to match a certain set of exporters.

Multiple policies can be later added to a profile. See the next section for more information.

After the information has been completed correctly, click save.

Editing a Profile

Clicking the [edit] link next to a profile will display its current configuration. The name, description, real time data, policies, exporters, and collectors are displayed.

Profiles are not considered complete until there are at least one exporter and one collector configured. From this interface the following actions are available:

  • [all] returns the user to the list of profiles
  • [new] launches the new profile wizard
  • [delete] permanently removes the profile
  • [edit] launches the edit profile modal to modify the name, the in port, and out port, or the description modal to modify the description of the profile
  • [add policy] launches the add policy modal
  • [add collector] launches the add collector modal
  • [add exporter] launches the add exporter modal
  • [remove] removes the policy, exporter, or collector depending on which one is clicked

Settings Tab

The settings tab is where users can modify the configuration of the replicator. Additional settings are available in the interactive prompt. Certain features can be enabled and disabled by checking or unchecking the enabled checkbox in the setting column. The settings column also contains the current value of the option. The description column explains what the option does.

If the user enters an invalid value, the replicator will provide feedback informing the user what entry values would be valid.

Status LED

The Status LED lists the state of all services and profiles and provides a status of each. It is a high level view of the health of the replicator’s processes.