Configure the BeyondTrust Remote Support Middleware Engine

Start BeyondTrust Middleware Engine

BeyondTrust Middleware Engine Service

The BeyondTrust Middleware Engine runs as a Windows service. This service must be restarted whenever a new plugin is deployed or a plugin is removed.

Launch the Middleware Administration Tool

Once the Windows service is running, the middleware administration tool can be launched. Open a web browser on the server and go to http://127.0.0.1:53231/. This tool is accessible only from the server where the BeyondTrust Middleware Engine is installed. If necessary, the tool can run on a different port, and it can be turned on/off as desired.

For more information, please see Configure the Middleware Administration Tool.

Overview of the Middleware Administration Tool

Middleware administration tool home page

The home page of the middleware administration tool displays all deployed plugins as well as each plugin's configuration(s). Multiple plugin configurations can be created. Creating multiple plugin configurations allows a single plugin to integrate with multiple systems, such as two different B Series Appliances.

 

Add and Edit Plugin Configurations

Copy Icon

To add a new configuration for a deployed plugin, click the copy icon next to the plugin name. A window displays the copied configuration details, including connection information to a B Series Appliance and any plugin-specific settings.

This screen also includes an option to disable a plugin configuration.

For a specific plugin configuration, the following options are available:

Edit Icon

Edit the plugin configuration.

Test Icon

Plugin Test

Test the plugin configuration. Testing confirms that the plugin is configured correctly and that network resources can be accessed.

Test output varies between plugins.

Delete Icon

Delete the plugin configuration.

 

The configuration cannot be recovered after deletion.

Configuration changes made via the middleware administration tool are immediately effective. It is not necessary to restart the Windows service.

View Plugin Event History

History Icon

To view the event history for a plugin, click the history icon next to the plugin name. A page shows key details of each event the plugin has processed. The period history available depends on the event retention configured in the middleware administration tool. The default is seven days.

Plugin Event History

On the plugin events page, the following functionality is available:

  • Page and filter text
  • View raw event data
  • View error data if event processing failed.
  • Find the event GUID, an identifier attached to every log message for the event.
  • Replay an event (i.e., sending the event to the plugin to reprocess). This can be useful for events that fail for transient reasons, such as a network issue.

For information on how to change this event retention setting, see Configure the Middleware Administration Tool.

Work with the Event Retries for a Plugin

To view the active retries for a plugin, click the clipboard icon located next to the history icon. A page displays details about each retry.

The retry is removed from this page when the plugin:

  • Successfully processes the event
  • Reaches the retry limit

The retries are attempted using a Fibonacci backoff strategy. This strategy staggers the retries, with the first attempt taking place five seconds after the initial failure. The maximum number of retries is set in the plugin configuration. The Retry Events page provides the functionality required to replay the event before the next attempt time.

Middleware Plugin Retries

Configure the Middleware Administration Tool

You can modify the middleware administration tool to run on a different port, and you can turn it on or off as desired. You also can change the length of time that events are stored.

Middleware Configuration Tool

Edit Middleware Configuration

  1. From the home page of the middleware administration tool, click the Edit Middleware Configuration link.
  2. The following configuration options are available:
    • Logging Level: Defines the logging level for the BeyondTrust Middleware Engine. Modifications to this value take effect immediately. For maximum logging, select DEBUG. For minimum logging, select ERROR.
    • Outbound Event Base Address: The base address BeyondTrust Middleware Engine listens to for outbound events from a B Series Appliance. If this value is changed, the Windows service must be restarted.
    • Middleware Administration Tool Enabled: If disabled, the web-based tool is not available. If this value is changed, the Windows service must be restarted.
    • Middleware Administration Tool Base Address: The base address on which the administration tool runs. If this value is changed, the Windows service must be restarted.
    • Event Retention Days: The number of days to keep a record of events delivered to plugins. If this value is changed, the Windows service must be restarted.
  3. If desired, this configuration can be edited from a file, for example, when the administration tool is disabled.
    • Go to the directory where the BeyondTrust Middleware Engine is installed.
    • In a text editor, open MiddlewareConfig.txt.
    • Edit the file as needed. The file is in JSON format. Valid LogLevel values are ERROR, INFO, WARN, and DEBUG.

When changing the LogLevel from the text file, the change is not immediately effective. The log level can change dynamically only when it is changed from the administration tool user interface.

    • Below is the default configuration:
    • {
          "LogLevel": "ERROR",
          "EngineBaseAddress": "http://+:8180/",
          "AdminToolEnabled": true,
          "AdminToolBaseAddress": "http://127.0.0.1:53231/",
          "EventRetentionDays": 7
                      }
    • After making any changes, restart the Windows service.