Agent Metrics
This page is a compact index of all built-in metrics, lists, and tables provided by the NetXMS agent. Click any metric name to see its full description on the detailed category page.
For agent configuration, see Agent Configuration. For data collection setup, see Agent Data Collection.
Metric Naming Convention
Agent metrics follow a hierarchical naming convention:
Category.Subcategory.Metric(argument)
Metrics with arguments (in parentheses) accept runtime values.
An asterisk (*) in the argument list indicates a required argument.
Data Types
| Type | Description |
|---|---|
Integer |
Signed 32-bit integer |
Unsigned Integer |
Unsigned 32-bit integer |
Integer 64 |
Signed 64-bit integer |
Unsigned Integer 64 |
Unsigned 64-bit integer |
Float |
Floating point number |
String |
Text string |
Counter 32 |
32-bit monotonically increasing counter |
Counter 64 |
64-bit monotonically increasing counter |
Platform Codes
The platform column indicates which operating systems support each metric.
| Code | Platform |
|---|---|
All |
Available on all supported platforms |
L |
Linux |
W |
Windows |
F |
FreeBSD |
N |
NetBSD |
O |
OpenBSD |
S |
Solaris |
A |
AIX |
M |
macOS (Darwin) |
Metric Index
Agent Internal Metrics
| Metric | Type | Platform |
|---|---|---|
Counter 32 |
All |
|
Counter 32 |
All |
|
String |
All |
|
Unsigned Integer |
All |
|
Counter 32 |
All |
|
Unsigned Integer |
All |
|
String |
All |
|
Unsigned Integer |
All |
|
Unsigned Integer |
All |
|
Integer 64 |
All |
|
Unsigned Integer |
All |
|
String |
W |
|
Counter 64 |
All |
|
Unsigned Integer 64 |
All |
|
Integer |
All |
|
Unsigned Integer |
All |
|
Unsigned Integer 64 |
All |
|
Counter 32 |
All |
|
Unsigned Integer |
L, F, N, O, S, A, M |
|
Unsigned Integer 64 |
All |
|
Unsigned Integer 64 |
All |
|
Unsigned Integer 64 |
All |
|
String |
All |
|
Integer |
All |
|
Integer |
All |
|
Integer |
All |
|
Integer |
All |
|
Counter 64 |
All |
|
Unsigned Integer 64 |
All |
|
Counter 64 |
All |
|
Unsigned Integer |
All |
|
Counter 64 |
All |
|
Unsigned Integer |
All |
|
Unsigned Integer |
All |
|
Counter 32 |
All |
|
Unsigned Integer |
All |
|
Counter 64 |
All |
|
Unsigned Integer |
All |
|
String |
All |
|
String |
All |
|
Counter 32 |
All |
|
Unsigned Integer |
All |
|
Unsigned Integer |
All |
|
Unsigned Integer |
All |
|
Counter 64 |
All |
|
Counter 64 |
All |
|
Counter 64 |
All |
|
Counter 64 |
All |
|
Integer |
All |
|
String |
All |
|
Unsigned Integer |
All |
|
Counter 64 |
All |
|
Counter 64 |
All |
|
Unsigned Integer |
All |
|
Unsigned Integer |
All |
|
Unsigned Integer |
All |
|
Unsigned Integer |
All |
|
Unsigned Integer |
All |
|
Unsigned Integer |
All |
|
Unsigned Integer |
All |
|
Unsigned Integer |
All |
|
Unsigned Integer |
All |
|
Unsigned Integer |
All |
|
Unsigned Integer |
All |
|
Unsigned Integer |
All |
|
Counter 32 |
All |
|
Unsigned Integer |
All |
|
Unsigned Integer |
All |
|
String |
All |
|
Unsigned Integer |
All |
System Metrics
| Metric | Type | Platform |
|---|---|---|
String |
W |
|
Unsigned Integer |
W |
|
Integer |
L, W |
|
String |
All |
|
Integer 64 |
All |
|
String |
All |
|
String |
All |
|
String |
All |
|
Integer |
L, W, S, A |
|
String |
All |
|
String |
All |
|
Integer |
W |
|
Integer |
L, W, F, S |
|
String |
All |
|
Unsigned Integer |
All |
|
Unsigned Integer |
L, W, F, N, A, M |
|
String |
All |
|
String |
All |
|
String |
All |
|
Unsigned Integer |
All |
|
String |
L, W, F, S |
|
String |
L, W, F, S |
|
String |
L, W, F, S |
|
String |
L, W, F |
|
String |
W |
|
String |
W |
|
String |
L, W, F, S, A |
|
String |
L, W, F |
|
String |
W, A |
|
String |
L, W, F, S, A |
|
String |
All |
|
Unsigned Integer 64 |
L, S, A |
|
Unsigned Integer 64 |
L, S, A |
|
Unsigned Integer 64 |
L, S, A |
|
Unsigned Integer |
L, S, A |
|
Unsigned Integer 64 |
L, S, A |
|
Unsigned Integer 64 |
L, S, A |
|
Counter 64 |
L |
|
Counter 64 |
L |
|
Integer |
L, W |
|
String |
W |
|
Integer 64 |
W |
|
Integer 64 |
W |
|
Integer 64 |
W |
CPU Metrics
| Metric | Type | Platform |
|---|---|---|
Integer |
L |
|
Integer |
L |
|
Unsigned Integer |
All |
|
Unsigned Integer |
L |
|
Unsigned Integer |
L |
|
Integer |
F |
|
Float |
L |
|
String |
F |
|
String |
L |
|
Integer |
L |
|
String |
L, W, F |
|
Float |
All |
|
Float |
All |
|
Float |
All |
|
Unsigned Integer |
L, W, F |
|
Unsigned Integer |
L, W, F |
|
Unsigned Integer |
W |
|
Float |
L, W, F, S, A, M |
|
Float |
L, W, F, S, A, M |
|
Float |
L, W, F, S, A, M |
|
Float |
L, W, F, S, A, M |
|
Float |
L, W, F, S, A, M |
|
Float |
L, W, F, S, A, M |
|
Float |
L, W, F, S, A, M |
|
Float |
L, W, F, S, A, M |
|
Float |
L, S, A |
|
Float |
L, S, A |
|
Float |
L, W |
|
Float |
L, W |
|
Float |
L |
|
Float |
L |
|
Float |
L |
|
Float |
L |
|
Float |
L |
|
Float |
L |
|
Float |
L, F, M |
|
Float |
L, F, M |
|
Float |
L, W, F, S, A, M |
|
Float |
L, W, F, S, A, M |
|
Float |
L, W, F, S, A, M |
|
Float |
L, W, F, S, A, M |
|
Float |
L, W, F, S, A, M |
|
Float |
L, W, F, S, A, M |
|
Float |
L, W, F, S, A, M |
|
Float |
L, W, F, S, A, M |
|
Float |
L, S, A |
|
Float |
L, S, A |
|
Float |
L, W |
|
Float |
L, W |
|
Float |
L |
|
Float |
L |
|
Float |
L |
|
Float |
L |
|
Float |
L |
|
Float |
L |
|
Float |
L, F, M |
|
Float |
L, F, M |
|
Float |
L, W, F, S, A, M |
|
Float |
L, W, F, S, A, M |
|
Float |
L, W, F, S, A, M |
|
Float |
L, W, F, S, A, M |
|
Float |
L, W, F, S, A, M |
|
Float |
L, W, F, S, A, M |
|
Float |
L, W, F, S, A, M |
|
Float |
L, W, F, S, A, M |
|
Float |
L, S, A |
|
Float |
L, S, A |
|
Float |
L, W |
|
Float |
L, W |
|
Float |
L |
|
Float |
L |
|
Float |
L |
|
Float |
L |
|
Float |
L |
|
Float |
L |
|
Float |
L, F, M |
|
Float |
L, F, M |
|
Float |
W |
|
Float |
W |
|
Float |
W |
|
Float |
W |
|
Float |
W |
|
Float |
W |
|
Float |
W |
|
Float |
W |
|
Float |
W |
|
Float |
W |
|
Float |
A |
|
Float |
A |
|
Float |
A |
|
Float |
A |
|
Float |
A |
|
Float |
A |
|
Float |
A |
|
Float |
A |
|
Float |
A |
|
Float |
A |
|
Float |
A |
|
Float |
A |
|
Float |
A |
|
Float |
A |
|
Float |
A |
Memory Metrics
| Metric | Type | Platform |
|---|---|---|
Unsigned Integer 64 |
L, W, F, A |
|
Float |
L, W, F, A |
|
Unsigned Integer 64 |
L |
|
Float |
L |
|
Unsigned Integer 64 |
L, W, F, A |
|
Float |
L, W, F, A |
|
Unsigned Integer 64 |
A |
|
Float |
A |
|
Unsigned Integer 64 |
A |
|
Float |
A |
|
Unsigned Integer 64 |
L, W, F, N, O, S, A |
|
Float |
L, W, F, S, A |
|
Unsigned Integer 64 |
L, W, F, N, O, S, A |
|
Unsigned Integer 64 |
L, W, F, N, O, S, A |
|
Float |
L, W, F, S, A |
|
Unsigned Integer 64 |
A |
|
Float |
A |
|
Unsigned Integer 64 |
L |
|
Float |
L |
|
Unsigned Integer 64 |
L, W, F, N, O, S, A |
|
Float |
L, W, F, S, A |
|
Unsigned Integer 64 |
L, W, F, N, O, S, A |
|
Unsigned Integer 64 |
L, W, F, N, O, S, A |
|
Float |
L, W, F, S, A |
|
Unsigned Integer 64 |
L, F, N, O, S, A |
|
Float |
L, F, S, A |
|
Unsigned Integer 64 |
L, F, N, O, S, A |
|
Unsigned Integer 64 |
L, F, N, O, S, A |
|
Float |
L, F, S, A |
I/O Metrics
| Metric | Type | Platform |
|---|---|---|
Unsigned Integer 64 |
L, W, F, S, A, M |
|
Unsigned Integer 64 |
L, W, F, S, A, M |
|
Unsigned Integer 64 |
S |
|
Unsigned Integer 64 |
S |
|
Unsigned Integer 64 |
S |
|
Unsigned Integer 64 |
S |
|
Unsigned Integer 64 |
L, W, F, S, A, M |
|
Unsigned Integer 64 |
L, W, F, S, A, M |
|
Unsigned Integer 64 |
S |
|
Unsigned Integer 64 |
S |
|
Unsigned Integer 64 |
S |
|
Unsigned Integer 64 |
S |
|
Float |
L, W, F, S, A, M |
|
Float |
L, W, F, S, A, M |
|
Unsigned Integer |
S |
|
Unsigned Integer |
S |
|
Unsigned Integer |
S |
|
Unsigned Integer |
S |
|
Float |
L, W, F, S, A, M |
|
Float |
L, W, F, S, A, M |
|
Unsigned Integer |
S |
|
Unsigned Integer |
S |
|
Unsigned Integer |
S |
|
Unsigned Integer |
S |
|
Float |
A |
|
Float |
A |
|
Float |
L, W, F, S, A |
|
Float |
L, W, F, S, A |
|
Unsigned Integer |
S |
|
Unsigned Integer |
S |
|
Unsigned Integer |
S |
|
Unsigned Integer |
S |
|
Float |
L, W, F, S, A, M |
|
Float |
L, W, F, S, A, M |
|
Float |
W |
|
Float |
W |
|
Float |
W |
|
Float |
W |
|
Unsigned Integer |
L, A |
|
Unsigned Integer |
L, A |
|
Unsigned Integer |
L |
|
Unsigned Integer |
L |
|
Unsigned Integer |
L |
|
Unsigned Integer |
L |
File System Metrics
| Metric | Type | Platform |
|---|---|---|
Unsigned Integer 64 |
L, F, N, O, S, A, M |
|
Float |
L, F, N, O, S, A, M |
|
Unsigned Integer 64 |
All |
|
Float |
All |
|
Unsigned Integer 64 |
All |
|
String |
L, W, S, A |
|
Unsigned Integer 64 |
All |
|
Float |
L, W, N, O, S, A, M |
|
Unsigned Integer 64 |
L, F, O, S, A |
|
Float |
L, F, O, S, A |
|
Unsigned Integer 64 |
L, F, O, S, A |
|
Float |
L, F, O, S, A |
|
Unsigned Integer 64 |
L, F, O, S, A |
|
Unsigned Integer 64 |
L, F, O, S, A |
|
Float |
L, F, O, S, A |
Disk Metrics (Deprecated)
These metrics are deprecated aliases for FileSystem. metrics. Use FileSystem. instead.
| Metric | Type | Platform | Description |
|---|---|---|---|
|
Deprecated |
L, F, O, S, A, M |
Available disk space (use |
|
Deprecated |
L, F, O, S, A, M |
Available space percentage (use |
|
Deprecated |
L, W, F, O, S, A, M |
Free disk space (use |
|
Deprecated |
L, W, F, O, S, A, M |
Free space percentage (use |
|
Deprecated |
L, W, F, O, S, A, M |
Total disk capacity (use |
|
Deprecated |
L, W, F, O, S, A, M |
Used disk space (use |
|
Deprecated |
L, W, F, O, S, A, M |
Used space percentage (use |
Network Interface Metrics
| Metric | Type | Platform |
|---|---|---|
Counter 32 |
All |
|
Counter 32 |
All |
|
Counter 32 |
All |
|
Counter 32 |
All |
|
Counter 32 |
L, W, F, S, A |
|
Counter 32 |
All |
|
Counter 32 |
All |
|
Counter 32 |
All |
|
Counter 64 |
L, W, F, O, S, M |
|
Counter 64 |
L, W, F, O, S, M |
|
Counter 64 |
L, W, F, O, M |
|
Counter 64 |
L, F, O, M |
|
Counter 64 |
L, W, F |
|
Counter 64 |
L, F, O, M |
|
Counter 64 |
L, W, F, O, S, M |
|
Counter 64 |
L, W, F, O, S, M |
|
Integer |
L, W, F, N, O, S, A |
|
String |
L, W, S, A |
|
Integer |
All |
|
Unsigned Integer 64 |
L |
|
Unsigned Integer |
W, O, A |
|
Integer |
W, F, N, O, S, A, M |
|
Unsigned Integer 64 |
L, W, F, O, S, A |
|
Integer |
W, F |
|
Integer |
L, W, F, N, O, M |
|
Integer |
L, F, N, O, M |
|
String |
Server (Internal) |
|
Integer |
All |
|
Integer |
All |
|
Integer |
W |
|
String |
W |
|
String |
All |
|
String |
All |
Process Metrics
| Metric | Type | Platform |
|---|---|---|
Integer |
All |
|
Integer |
L, W, F, N, S, A, M |
|
Counter 64 |
L, W, F, N, S, A, M |
|
Integer 64 |
W |
|
Integer |
L, W, S, A |
|
Counter 64 |
W |
|
Counter 64 |
W |
|
Counter 64 |
W |
|
Counter 64 |
W, A |
|
Counter 64 |
W |
|
Counter 64 |
W, A |
|
Counter 64 |
L, W, N, S, A |
|
Float |
L, W, F, S, A, M |
|
Counter 64 |
L, W, N, S, A |
|
Integer 64 |
L, W, F, S, A, M |
|
Counter 64 |
S |
|
Integer |
L, W, F, N, S, A, M |
|
Integer 64 |
W |
|
Counter 64 |
L, W, N, S, A |
|
Integer |
L |
|
Integer 64 |
L, W, F, N, S, A, M |
|
Integer 64 |
L, W, F, N, S, A, M |
|
Integer |
S |
File Metrics
| Metric | Type | Platform |
|---|---|---|
String |
All |
|
Unsigned Integer 64 |
All |
|
Unsigned Integer 64 |
All |
|
Unsigned Integer |
All |
|
Unsigned Integer |
All |
|
Unsigned Integer |
All |
|
Unsigned Integer 64 |
All |
|
Unsigned Integer 64 |
All |
|
Unsigned Integer 64 |
All |
|
Unsigned Integer |
All |
|
String |
All |
|
String |
All |
|
String |
All |
Hardware Metrics
| Metric | Type | Platform |
|---|---|---|
String |
L, W, F, S, A |
|
String |
L, W, F, S, A, M |
|
String |
L, W, F, S, A, M |
|
String |
L, W, F, S |
|
String |
All |
|
String |
L, W, F, S |
|
String |
L, W, F, S |
|
String |
L, W, F, S |
|
String |
L, W, F, S |
|
String |
L, W, F, S |
|
String |
L, W, F, S |
|
String |
L, W, F, S |
|
Unsigned Integer |
L, W, F, S |
|
String |
L, W, F, S |
|
String |
L, W, F, S |
|
String |
L, W, F, S |
|
String |
L, W, F, S |
|
String |
L, W, F, S |
|
String |
L, W, F, S |
|
Unsigned Integer |
L, W, F, S |
|
String |
L, W, F, S |
|
Unsigned Integer |
L, W, F, S |
|
String |
L, W, F, S |
|
String |
L, W, F, S |
|
String |
L, W, F, S |
|
Unsigned Integer |
L, W, F, S |
|
String |
L, W, F, S |
|
String |
L, W, F, S |
|
Unsigned Integer 64 |
L, W, F, S |
|
String |
L, W, F, S |
|
Unsigned Integer |
L, W, F, S |
|
Unsigned Integer |
L, W, F, S |
|
String |
L, W, F, S |
|
String |
L, W, F, S |
|
Unsigned Integer |
L, W, F, S |
|
String |
L, W, F, S |
|
String |
L, W, F, S |
|
String |
L, W, F, S |
|
Unsigned Integer |
L, W, F, S |
|
String |
L, W, F, S |
|
String |
L, W, F, S |
|
String |
W |
|
Integer |
W |
|
String |
W |
|
String |
W |
|
String |
W |
|
String |
W |
|
Unsigned Integer 64 |
W |
|
Integer |
W |
|
String |
W |
Physical Disk Metrics
| Metric | Type | Platform |
|---|---|---|
Unsigned Integer 64 |
All |
|
String |
All |
|
String |
All |
|
String |
All |
|
Unsigned Integer |
All |
|
Unsigned Integer |
All |
|
String |
All |
|
String |
All |
|
Unsigned Integer 64 |
All |
|
String |
All |
|
Unsigned Integer |
All |
|
Unsigned Integer |
All |
|
Integer |
All |
|
Integer |
All |
Platform-Specific and Other Metrics
| Metric | Type | Platform |
|---|---|---|
String |
L |
|
String |
L |
|
String |
L |
|
String |
L |
|
String |
L |
|
String |
L |
|
String |
L |
|
String |
L |
|
String |
L |
|
String |
L, W, F, S |
|
String |
L, W, F, S |
|
Integer |
W |
|
Unsigned Integer |
W |
|
Unsigned Integer |
W |
|
Integer |
W |
|
Unsigned Integer |
All |
|
Integer |
All |
|
Unsigned Integer |
All |
|
Unsigned Integer |
All |
|
Unsigned Integer |
All |
|
String |
All |
|
String |
All |
|
Unsigned Integer 64 |
All |
|
Integer |
All |
|
String |
All |
|
String |
All |
|
String |
All |
|
String |
W |
|
Unsigned Integer 64 |
W |
|
Integer |
W |
|
Integer |
W |
|
String |
W |
|
String |
W |
|
String |
W |
|
String |
W |
|
Integer |
All |
|
Integer |
All |
|
String |
W |
|
Integer |
W |
|
Integer |
W |
|
Integer |
W |
|
Integer |
W |
|
Unsigned Integer |
W |
|
String |
W |
|
Unsigned Integer |
W |
|
String |
W |
|
String |
W |
|
String |
W |
|
Unsigned Integer 64 |
W |
|
String |
W |
|
Integer |
W |
|
String |
W |
|
Integer |
W |
|
Integer |
W |
|
String |
W |
|
Integer |
W |
|
Integer |
W |
|
String |
W |
|
Integer |
W |
|
String |
W |
|
String |
S |
|
Unsigned Integer 64 |
A |
|
String |
A |
|
Unsigned Integer 64 |
A |
|
Float |
A |
|
Unsigned Integer 64 |
A |
|
Unsigned Integer 64 |
A |
|
String |
A |
|
Unsigned Integer 64 |
A |
|
Unsigned Integer 64 |
A |
|
Float |
A |
|
Unsigned Integer |
A |
|
Unsigned Integer 64 |
A |
|
Float |
A |
|
Unsigned Integer |
A |
|
Unsigned Integer |
A |
|
Unsigned Integer 64 |
A |
|
Unsigned Integer 64 |
A |
|
Unsigned Integer 64 |
A |
|
Unsigned Integer 64 |
A |
|
Float |
A |
|
Integer |
All |
List and Table Metrics
Lists return enumerated values (queried with nxget -l), and tables return structured multi-column data (queried with nxget -t).
See the full list and table reference for details on returned columns and values.
| Name | Type | Platform |
|---|---|---|
List |
All |
|
List |
All |
|
List |
All |
|
List |
All |
|
List |
All |
|
List |
All |
|
List |
All |
|
List |
All |
|
List |
All |
|
List |
All |
|
List |
All |
|
List |
All |
|
List |
All |
|
List |
All |
|
List |
All |
|
List |
All |
|
List |
L |
|
List |
L, W, F, S, A, M |
|
List |
L, W, S |
|
List |
L, W, S |
|
List |
L, W, S |
|
List |
W |
|
List |
L, W, F, N, O, M |
|
List |
All |
|
List |
L, W, F, S, A |
|
List |
L |
|
List |
L, W, F, N, O, A, M |
|
List |
L, W |
|
List |
L, W, F, S, A, M |
|
List |
L, W, F, M |
|
List |
L |
|
List |
L |
|
List |
L, W, F, S, A, M |
|
List |
All |
|
List |
L, W |
|
List |
A |
|
List |
A |
|
List |
A |
|
List |
W |
|
List |
W |
|
List |
W |
|
List |
W |
|
List |
W |
|
List |
W |
|
List |
W |
|
List |
W |
|
List |
W |
|
List |
W |
|
List |
W |
|
List |
W |
|
List |
W |
| Name | Type | Platform |
|---|---|---|
Table |
All |
|
Table |
All |
|
Table |
All |
|
Table |
All |
|
Table |
All |
|
Table |
All |
|
Table |
All |
|
Table |
L, W, S, A, M |
|
Table |
L, W, S |
|
Table |
L, W, S |
|
Table |
L, W |
|
Table |
L, W, S |
|
Table |
L, W |
|
Table |
L, F, N, O, M |
|
Table |
L |
|
Table |
L |
|
Table |
L |
|
Table |
L, W |
|
Table |
L, W, F, S, A |
|
Table |
L |
|
Table |
L, W, F, S, A, M |
|
Table |
L, W |
|
Table |
W |
|
Table |
W |
Custom Metrics
Agents can be extended with custom metrics through:
-
External metrics — shell commands returning metric values; see External Metrics
-
Subagents — loadable modules providing additional metrics; see Subagents
-
External subagents — standalone processes communicating through IPC; see External Subagents
Querying Metrics
Using nxget
Use nxget to query agent metrics:
# Query a single metric
nxget <agent-ip> System.CPU.Usage
# Query with shared secret
nxget -s <shared-secret> 10.0.0.50 FileSystem.UsedPerc(/)
# List all supported metrics
nxget -I <agent-ip>
# Query a list metric
nxget -l <agent-ip> System.Processes
# Query a table metric
nxget -t <agent-ip> FileSystem.Volumes
Related Pages
-
Agent Configuration — agent setup and custom metrics
-
Agent Data Collection — configuring agent-based DCIs
-
Subagents — extending agent capabilities
-
Configuration File Reference — agent config file syntax