How To Retrieve the Agent UUID

Purpose

The purpose of this document is to describe how to retrieve the Agent UUID.

Introduction

The Agent UUID is used to uniquely identify deployed agents. Each isolated agent process using unique configuration will have different UUID. When the Agent client is calling Agent server for the enrollment and getting its certificate it is using a tenant UUID and an unique secret per tenant.

Requirements

Prior to version v1.22.0, the command requires root privileges to access the certificate where the agent UUID is stored.

On Windows platforms administrator privileges are required.

Extracting the UUID

The UUID is available in a JSON format from running the agent with the sub command info.

BASH

# o24-agent info | jq .
{
  "agentUuid": "1dcea474-04ad-4112-99cf-aa9882e59986",
  "enrollmentStatus": true
}

In Windows the agent binary is located in \Program Files (x86)\Outpost24\Agent and you may need to use the full path to the agent.

"agentUuid" - will be populated if the agent is enrolled ("enrollmentStatus") and represents the UUID that should be filtered for in the Manage Targets view in the UI. If this key is not present, the agent is either not enrolled or an error with the certificate occurred (see logging information below).

"enrollmentStatus" - should always be populated with a boolean value indicating whether the agent is enrolled.

By default no errors are logged on standard error (or similar on Windows), so if an error occurred (as indicated by the exit code being anything but 0) you can tell the agent to show the logs, or look in your centralized logging system (journal or event viewer).

BASH

$ o24-agent info --stderr-log --log-level DEBUG --log-sd=0 ; echo $?
2021-08-17T15:12:35.5174308+02:00 ERROR failed to read config
1

For clarity, the --log-sd has been disabled to remove large amounts of data. However, --log-sd data will always be requested whenever data is sent in support cases.

Logs produced by this command will not be sent to the Agent server, but are instead stored in the centralized logging system in your environment.

Troubleshooting

The command fails because it is run as normal user rather than with root privileges.

Purpose

Introduction

Requirements

Extracting the UUID

Troubleshooting

Related Articles