Installation & Configuration

How to add and install a Remote Agent

In EasyDCIM 1.25.0+, Remote Agents are deployed as Docker-based services managed by easydcim-control. For the general CLI workflow, see Docker Management with easydcim-control.

To add a new Remote Agent in the backend, go to Settings → Remote Agents and click Add Remote Agent.

Remote Agent Deployment Guide - EasyDCIM Documentation

The target server should run:

  • Debian 12 (bookworm) or Debian 13 (trixie)
  • with root or sudo access

On the Remote Agent server, install easydcim-control, then run the command generated in the EasyDCIM backend. A typical command looks like this:

sudo easydcim-control agent install

This workflow automatically:

  • installs Docker if required,
  • downloads the Remote Agent package and Docker appliance files,
  • starts the required containers,
  • initializes the Remote Agent database,
  • generates the agent API key,
  • registers the Remote Agent in EasyDCIM when the backend-generated command is used.

If you install the agent manually without the backend-generated registration parameters, you can still add it later in the EasyDCIM panel by providing the agent host and API key.

Local Remote Agent

When you install the main EasyDCIM stack with:

easydcim-control app install --key 'LICENSE_KEY'

a local Remote Agent is installed automatically unless you use --no-agent.

Information required by the form

When adding a Remote Agent manually, the form contains the following fields:

  • Name – Any descriptive name that helps identify the Remote Agent.
  • Remote Agent IP Address – The main IP address or hostname of the Remote Agent server.
  • Remote Agent API Key – The API key generated during easydcim-control agent install.
  • Remote Agent PXE IP – The address used by DHCP/TFTP services for operating system installation. In many environments it matches the main Remote Agent address.

If the connection test is successful, EasyDCIM redirects you to the Remote Agent summary page.

Information on the Remote Agent condition

The summary section includes information about the current agent condition. You will find there details on:

  • Synchronization Status – synchronization status between the Remote Agent and EasyDCIM
  • Connected Agent – the Remote Agent currently synchronized with EasyDCIM
  • Remote Agent Version – the installed Remote Agent version
  • Network Interfaces – a list of configured interfaces together with their main IP addresses
  • Password Protected Samba Share – password to Samba resources on the Remote Agent server
  • Uptime – time of uninterrupted work of the Remote Agent
  • Last Update – date of the last update

Remote Agent Deployment Details - EasyDCIM Documentation

The summary also presents the state of services such as DHCP, TFTP, and Samba.