Skip to main content

Automation ManagementAutomation Management Guide

Table of Contents

Connect Automation Management to Segmented Networks

Configure a secure connection from Automation Management to a segmented network by creating an automation agent and running the automation agent using Docker.

To securely connect Automation Management to a segmented network, you:

  1. Complete the required prerequisites

  2. Create the automation agent

  3. Download the Automation Management image

  4. Run the automation agent

You can create up to five automation agents. You can run multiple automation agents on a single virtual machine or remote host.

Prerequisites

  • Download and install Docker.

  • Ensure your virtual machine or remote host has the necessary resources for your workload. If you're performing resource-intensive operations, like processing in-memory data or manipulating a large file, adjust your resources accordingly to avoid out-of-memory (OOM) errors.

    At a minimum, ensure your virtual machine or remote host meets the following system requirements:

    • CPU – 1 CPU

    • RAM – 1GB

    • OS – linux/amd64 or linux/arm64

  • Ensure your network has the necessary performance for your workload. If you're performing network-intensive operations, like downloading large amounts of data or requiring low round-trip times (RTT), ensure your network has sufficient bandwidth and low latency.

1. Create the automation agent

  1. In Automation Management, navigate to the Automation Agents tab, then click + New Automation Agent.

  2. Enter information about the automation agent:

    • Agent Name – Enter a unique name for the automation agent. You can enter up to 32 characters. You can't rename the automation agent after it's created.

    • Hostname or IP – Enter the host name or IP address of the virtual machine or remote host to which you're connecting.

  3. Click Confirm and Create. Automation Management creates a .env file that contains all the environment variables required to run the automation agent.

  4. To download the .env file, click Download Package, then save the .env file to your local machine as agentworkerconfig.env.

    Caution

    You can't return to the window after you close it, so ensure that you download the file before closing the window. If you close the window without downloading the file, you must delete the automation agent, then recreate it.

    The automation agent status is changed to In progress. If the automation agent isn't run in one minute, the status is changed to Heartbeat failed.

2. Download the Automation Agent image

Download the Automation Management image to your local machine using Docker. If you've previously downloaded the image, you don't need to download the image again.

In a command-line interpreter (CLI), enter:

docker pull us-docker.pkg.dev/exa-cloud-utils/public/exabeam-automation-agent:1.0

3. Run the automation agent

Create and run a Docker container from the Automation Management image using the environment variables you downloaded.

  1. In the command-line interpreter (CLI), navigate to the folder where you saved agentworkerconfig.env; for example:

    cd /path/folder

  2. To create and run a container using the environment variables for your automation agent, in the CLI, enter:

    docker run --env-file ./agent_package_testAgent1.env us-docker.pkg.dev/exa-cloud-utils/public/exabeam-automation-agent:1.0

    The automation agent is assigned a JSON Web Token (JWT) for authenticating HTTP requests to your network. The JWT is valid for 365 days, after which it expires. When the JWT is deleted, revoked, or expired, you can delete the automation agent.

    If the automation agent successfully runs and establishes a connection to your network, its status is changed to Running.