Properties for use in auto-enroll rules

Each connecting NXLog Agent sends several properties containing information about the agent’s operating environment. To those, NXLog Platform adds agent-management properties.

Table 1. Properties associated with a connected NXLog Agent
Property name	Description
address	Host IP address and port number used by the agent to connect to NXLog Platform or null when the agent is offline. Example: `10.10.22.21:55076`.
agent_label	The agent label specified during the NXLog Agent installation.
arch	CPU architecture of the agent’s host. Possible values: `x86_64`, `arm`.
config	The content of the `managed.conf` file: either the actual content or the expected content when it has been changed from NXLog Platform but not yet updated on the agent. Example: `config REGEX "(?s:.)AllowUntrusted(\s)(?i)true(?-i)(?s:.)*"`
configured	Configuration status: `true` if the agent has at least one input or output module configured, `false` otherwise.
cpu-load	Average CPU load of the agent process since the start of the process.
cpu-usage-time	CPU usage time of the agent process measured in milliseconds since the start of the process.
enrolled	Enrollment status of the agent: `true` if the enrollment process completed successfully, and `false` otherwise. To prevent unintended configuration changes when using the `enroll-by-rules` API endpoint, NXLog Platform automatically adds the property `enrolled = false` to all auto-enroll rules created using the UI.
`host`	Same as `hostname`.
`hostname`	The hostname of the machine that runs NXLog Agent, as reported by NXLog Agent.
`id`	The UUID of the agent in UUID Version 1 format. The agent typically reports its ID, but NXLog Platform can generate or overwrite it, for example, to avoid duplication when you create a second agent instance by cloning a VM.
`manager-address`	The NXLog Platform IP address and port number to which the agent is connected or null when the agent is offline. Example: `10.10.22.254:5515`
`memory-used`	Amount of RAM used by the agent in bytes.
`name`	Same as `hostname`.
`online`	Connection status of the agent: `true` if the connection between NXLog Platform and the agent is established, `false` otherwise.
`os`	Type of operating system running on the agent’s host. Possible values: `Android`, `Linux`, `Windows`, `AIX`, `FreeBSD` (for FreeBSD, NetBSD), `OpenBSD`, `BSD`, `HP-UX`, `Irix`, `macOS`, `Solaris`, `Unix`, `Unknown`.
`os-release`	Operating system type and version. Example: `Fedora Linux 39 (Workstation Edition)`
`status`	The agent’s management status: `ok`, `warning` (or `warn`), `error` (or `err`). The `errors` property contains a list of the detailed error types and messages.
`template-id`	UUID of the template assigned to the agent or `null` when a template is not assigned.
`template-name`	Name of the template assigned to the agent or `null` when a template is not assigned.
`version`	Version of NXLog Agent. Example: `6.2.9212`.

Properties for use in auto-enroll rules

See also