Agent Commands

Reference for the linuxguard-agent command-line interface — start, stop, status, show-config, enroll, and unenroll commands.

This page documents the linuxguard-agent command-line interface. Use these commands to manage the LinuxGuard agent on your system.

Command Reference

Command	Description
start	Start the LinuxGuard agent
stop	Stop the LinuxGuard agent
status	Check if the agent is running
show-config	Display current configuration
enroll	Enroll system into LinuxGuard
unenroll	Remove agent from tenant

linuxguard-agent start

Start the LinuxGuard agent.

Synopsis:

sudo linuxguard-agent start

Description:

Starts the LinuxGuard agent process. The agent typically starts automatically after installation, so this command is primarily used to manually restart the agent after it has been stopped.

linuxguard-agent stop

Stop the LinuxGuard agent.

Synopsis:

sudo linuxguard-agent stop

Description:

Stops the LinuxGuard agent process. While stopped, no monitoring data will be collected and the server will appear offline in the LinuxGuard console.

linuxguard-agent status

Check if the agent is running.

Synopsis:

sudo linuxguard-agent status

Description:

Reports whether the LinuxGuard agent is currently running and displays the process ID if active.

Examples:

When the agent is running:

$ sudo linuxguard-agent status
linuxguard-agent is running with PID: 1234

When the agent is not running:

$ sudo linuxguard-agent status
linuxguard-agent is not running

linuxguard-agent show-config

Display current agent configuration.

Synopsis:

linuxguard-agent show-config

Description:

Displays the current agent configuration in JSON format. This command does not require sudo and is useful for verifying enrollment settings and troubleshooting configuration issues.

Example:

$ linuxguard-agent show-config
{
  "tenant_id": "tenant_abc123",
  "api_key": "ak_***",
  "endpoint": "https://api.linuxguard.io/v1/",
  "environment": "production",
  "tags": ["web-server", "us-east"]
}

linuxguard-agent enroll

Enroll this system into LinuxGuard.

Synopsis:

sudo linuxguard-agent enroll --api-key=<API_KEY> --tenant-id=<TENANT_ID> [OPTIONS]

Description:

Enrolls the system into your LinuxGuard tenant. After enrollment, the agent begins sending monitoring data to the LinuxGuard console.

Options:

Option	Required	Description
--api-key	Yes	API Key from LinuxGuard console
--tenant-id	Yes	Tenant ID from LinuxGuard console
--environment	No	Environment name to assign (e.g., production, staging, development)
--group	No	Alias for --environment (backward compatible)
--tag	No	Tag to assign (can be repeated for multiple tags)

Note: The agent accepts both --environment and --group. The --group flag is an alias for backward compatibility. Use --environment for new enrollments.

Examples:

Basic enrollment:

sudo linuxguard-agent enroll --api-key=ak_xxx --tenant-id=tenant_xxx

With environment and tags:

sudo linuxguard-agent enroll \
  --api-key=ak_xxx \
  --tenant-id=tenant_xxx \
  --environment=production \
  --tag=web-server \
  --tag=us-east

Success output:

>> Sending initial snapshot...
>> Initial snapshot sent successfully
>> Successfully enrolled to LinuxGuard Endpoint: https://api.linuxguard.io/v1/

Already enrolled output:

This server has been enrolled since Mon, 01 Feb 2026 12:00:00 UTC

Note: After enrollment, the environment and tags are persisted locally and reused across agent restarts. To change the environment or tags, unenroll and re-enroll with the desired values.

linuxguard-agent unenroll

Remove this agent from the LinuxGuard tenant.

Synopsis:

sudo linuxguard-agent unenroll

Description:

Removes the server from LinuxGuard management. After unenrolling, the server will no longer appear in the LinuxGuard console and no monitoring data will be collected. To resume monitoring, you must run the enroll command again with valid credentials.

---

Related: Quick Start | Configuration Guide | Glossary