Skip to content

Setup & Management

Installing ​

To install an agent you must run the device connection command as root user.

The device connection command is unique per device. You can get the command in one of two ways.

Creating a new device ​

  1. In the device tree-view click "Add Device"
  2. Select between physical device or virtual machine
  3. Choose the install type

Choosing an install type ​

From agent version 1.0.24, you choose which capabilities the agent is built with when you add the device.

Install typeIncludes
CoreThe hardened base runtime only. Smallest footprint and smallest attack surface.
AdvancedCore plus CloudLink and the remote terminal.
CustomCore plus the capabilities you select.

WARNING

Capabilities are fixed when the agent is built. To change them later you must reinstall the agent. Reinstalling preserves the device identity, so choose the install type that matches how the device will actually be used.

If you are unsure, note that Core alone has no remote access. Choose Advanced if the device needs CloudLink VPN access or a remote shell.

For more information, see Capabilities.

Linking an existing device ​

If you have already created a device you can access its device connection command from the location below.

Devices > Your Device > Agent

Installation process ​

The installation process is completely automated. Depending on the performance of your system the typical installation time is listed below.

  • First time installation: 5-10 minutes
  • Second onwards: 1-5 minutes

Your time may vary.

INFO

First time installation means that the agent has never previously been run on that system.

software-defined automation