Use Remote Agent to Access Private Resources Behind a Firewall

The remote agent feature is designed for data that you would like to investigate in LogicHub but can't because it is stored behind your firewall. The remote agent is a lightweight application that you install in your environment to allow access by LogicHub to a location beyond the firewall.

A machine can have only one remote agent installed on it. If you require multiple remote agents, install each on a different machine.

For example, an on-premise Exchange server within your firewall isn't accessible by a LogicHub deployment hosted in AWS. Using the remote agent, you can allow the LogicHub to call the API of the on-premise Exchange server.

To allow access:

  1. Add a new remote agent.
  2. Download and install it in your environment.
  3. Select the remote agent when setting up your web API (or other) integration.

A remote agent is always used as part of an integration. If the credentials for your integration are associated with a particular firewall, additional remote agents might be required to provide access to data that is protected by other firewalls.

🚧

Outbound Connection

The remote agent makes an outbound connection to port 443 of the LogicHub deployment to establish a secure WebSocket connection with the LogicHub deployment.

Remote Agent High Availability Set Up

LogicHub provides a Remote Agent High Availability (HA) setup that runs on a remote agent with a configuration on two different machines, of which only one of them gets connected to the remote agent service first. The alternate machine attempts to connect every five seconds to avoid any remote agent downtime.

Add a New Remote Agent

  1. Select Settings > Remote Agents.
  2. Click New.
  3. Enter a name to identify the agent, and click Submit.
    • The agent is added and listed on the Remote Agents page.

The colored icons associated with the remote agent name indicate the status. Hover over an icon to see the status definition.

  • Yellow. The remote agent is not yet connected.
  • Green. The remote agent is connected and can be used.
  • Red. The remote agent was disconnected due to an error on the remote agent side or LogicHub side. Any connection that uses this agent won’t work. For additional information, see the troubleshooting article.

In addition to the name, the entry for each agent lists the user who created the agent application and the version. Each time the remote agent application is updated, a new version is created.

To delete a remote agent, click the more icon (...) on the right and select Delete.

Download the Remote Agent

You can download and install the remote agent on a Unix or Windows system.

For Unix, the system must have systemd and minimum glibc version 2.12. To check the glibc version, run the command

ldd --version

The remote agent package for Unix contains the following files.

lhub-remote-agent/
     |____ remote-agent        : The executable agent application.
     |____ agent.config        : The agent configuration file. 
     |____ install_and_run.sh  : The script to install and run the agent.

The remote agent package for Windows contains the following files.

lhub-remote-agent/
     |____ remote-agent        : The executable agent application.
     |____ agent.config        : The agent configuration file.
  • remote-agent is the executable agent application.
  • agent-config is the agent configuration file.

To download a remote agent package to a Unix or Windows system:

  1. On the Settings > Remote Agents page, click the Unix or Windows button for the remote agent. A zip file containing the remote agent software is downloaded to your local system.
  2. Unzip the file to a convenient location.

Unix

Follow the steps to install and upgrade the remote agent for Unix.

Install and Run the Agent

  1. Navigate to the directory on the Unix system that contains the unzipped remote agent package.
  2. Run the following script as root. The script sets up the remote agent as a Unix service and starts it.

sudo bash install_and_run.sh

Upgrade Remote Agent

  1. Go to Settings > Remote Agents.
  2. Download a new agent for the remote agent by clicking the Unix button.
  3. You can extract and replace the entire folder with the new one.
  4. Run sudo bash install_and_run.sh.

Check if the remote agent version on the remote agent page is updated.

Windows

Follow the steps to install and upgrade the remote agent for Windows.

Install and Run the Agent

  1. Navigate to the Windows folder that contains the unzipped remote agent package.
  2. Open a command window and run the following commands. The first command installs the remote agent as a Windows service, and the second starts the remote agent.

.\remote-agent --startup=auto install
.\remote-agent start

📘

Minimum Requirement for Windows Version

The remote agent requires Windows Server 2016 or newer.

You can manage the remote agent as you would for any other Unix or Windows service. By default, the agent restarts automatically when the system reboots.

Upgrade Remote Agent

  1. Stop the current running service.
  2. Go to Settings > Remote Agents.
  3. Download the windows remote agent by clicking on the Windows button.
  4. You can extract and replace the entire folder with the new one.
  5. Navigate to the folder in powershell and run the following commands:

.\remote-agent --startup=auto install
.\remote-agent start

Check if the remote agent version on the remote agent page is updated.

Add a Remote Agent to an Integration

  1. On the Automation > Integrations page, search for and select the integration for which you need access beyond a firewall.
  2. Click Details > Connections and click + to add a new connection.
  3. Enter a label for the integration and the credentials to authenticate to the application you’re integrating with.
    • For Remote Agent, select the remote agent you created or select the appropriate one from the drop-down.
  1. Click Connect to save the settings and connect integration.
    • The integration is now in place and ready for use. Open the Settings > Remote Agents page to view the status of the agent at any point in time. To know more about setting up integrations, see Add an Integration.

Did this page help you?