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

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.

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

Note

In Windows the agent binary is located in \ProgramData\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.


Note

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).


$ 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
BASH

Note

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.

Note

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.




Copyright

© 2021 Outpost24® All rights reserved. This document may only be redistributed unedited and unaltered. This document may be cited and referenced only if clearly crediting Outpost24® and this document as the source. Any other reproduction and redistribution in print or electronically is strictly prohibited without explicit permission.

Trademark

Outpost24® and OUTSCAN™ are trademarks of Outpost24® in Sweden and other countries.