Skip to main content

Installing Host Agents

Create an enrollment profile from Agents → Install Agent. Lumetry shows the enrollment token once and renders both Linux and Windows commands with the current Lumetry endpoint. Installer locations are deployment-owned; copy the displayed command rather than substituting a package URL from another environment.

Windows Server​

The Windows package supports 64-bit Windows Server 2019 and newer. Run the displayed command from an elevated PowerShell session:

$installer = Join-Path $env:TEMP "install-lumetry-agent.ps1"
Invoke-WebRequest -UseBasicParsing `
  "https://downloads.example.com/agent/install.ps1" `
  -OutFile $installer
powershell.exe -ExecutionPolicy Bypass -File $installer `
  -BackendUrl "https://lumetry.example.com" `
  -EnrollmentToken "lmtae_..."

For collector-first routing, add:

-CollectorUrl "http://collector.internal:4319"

To request placement in an existing topology Cluster during enrollment, add either -Cluster "ANVMBWEBWX" for a case-insensitive display-name match or -ClusterId "cls.anvmbwebwx" for an exact external-ID match. Do not supply both. Enrollment still succeeds without a group when the value is missing, is not a Cluster, or does not identify exactly one Cluster.

The bootstrap verifies the package checksum. The package installer also verifies Authenticode signatures before it creates the service.

The installed service:

  • is named LumetryAgent;
  • starts automatically after boot and has restart recovery configured;
  • runs under the dedicated Windows virtual account NT SERVICE\LumetryAgent;
  • stores identity, the offline queue, configuration, and local status under %ProgramData%\Lumetry\Agent;
  • writes operational messages to the Windows Application event log.

When IIS is installed, setup ensures the IIS Management Scripts and Tools role service is present and grants the dedicated service identity local read/method access to the IIS WMI namespace. The agent does not run as LocalSystem or as a local administrator.

The installer removes the enrollment token from the service environment after the host enrolls successfully.

Uninstall from an elevated PowerShell session:

& "$env:ProgramFiles\Lumetry\Agent\uninstall.ps1"

Uninstall removes the service, program files, and agent state. Use -KeepState only when intentionally preserving identity and buffered data for troubleshooting.

Linux​

Run the Linux command shown by Lumetry. The bootstrap selects x64 or arm64, verifies the package checksum, and installs the systemd service:

curl -fsSL \
  https://downloads.example.com/agent/install.sh |
  sudo bash -s -- \
    --backend https://lumetry.example.com \
    --enroll-token lmtae_...

Add --collector http://collector.internal:4319 for collector-first routing.

To request placement in an existing topology Cluster, add either --cluster=ANVMBWEBWX or --cluster_id=cls.anvmbwebwx. The external-ID form is the recommended automation key. Do not supply both. A missing or ambiguous match leaves the host unassigned without blocking enrollment.

Network behavior​

Agents make outbound connections only. With a collector configured, the agent tries the collector first and falls back to Lumetry directly when network policy allows. When neither complete path is available, metrics remain in the bounded local queue and upload after connectivity recovers.

Production deployments should use TLS for Lumetry and for collector connections that cross an untrusted network.