List and Table Metrics
List Metrics
List metrics return multi-value data. They are used for instance discovery and can be queried with nxget -l.
EtherNetIP.ListIdentity(host, port)
EtherNet/IP device identity.
Requires EnableEtherNetIPProxy to be set in agent configuration.
Data Type |
List |
Platforms |
All |
| Argument | Type | Description |
|---|---|---|
host |
String |
Device hostname or IP address |
port |
Integer |
TCP port (optional, default 44818) |
ExternalCheck.Checks
Names of all configured external checks, suitable for instance discovery with ExternalCheck.Status({instance}).
Listing the names does not execute the plugins; an agent with no configured checks returns an empty list.
Data Type |
List |
Platforms |
All |
See External Checks for configuration and DCI examples.
Modbus.DeviceIdentification(host, port, unitId[, useSymbolicNames])
Modbus device identification objects.
Data Type |
List |
Platforms |
All |
| Argument | Type | Description |
|---|---|---|
host |
String |
Device hostname or IP address |
port |
Integer |
TCP port (default: 502) |
unitId |
Integer |
Modbus unit ID, 1-255 (default: 1) |
useSymbolicNames |
Boolean |
Use symbolic object names (default: true) |
Requires EnableModbusProxy = yes.
Net.Resolver.AddressByName(hostname) (List)
All IP addresses for hostname.
Data Type |
List |
Platforms |
All |
| Argument | Type | Description |
|---|---|---|
hostname |
String |
Hostname to resolve |
SNMP.ScanAddressRange(startIP, endIP[, port[, version[, community]]])
SNMP-responsive hosts in range.
Data Type |
List |
Platforms |
All |
| Argument | Type | Description |
|---|---|---|
startIP |
String |
Start IP address |
endIP |
String |
End IP address |
port |
Integer |
UDP port (default: 161) |
version |
Integer |
SNMP version: 0 = v1, 1 = v2c, 3 = v3 (default: v2c) |
community |
String |
SNMP community string (default: public) |
Requires a master-server session and EnableSNMPProxy = yes.
TCP.ScanAddressRange(startIP, endIP, port)
TCP-responsive hosts in range.
Data Type |
List |
Platforms |
All |
| Argument | Type | Description |
|---|---|---|
startIP |
String |
Start IP address |
endIP |
String |
End IP address |
port |
Integer |
TCP port number (default: 4700) |
Requires a master-server session and EnableTCPProxy = yes.
TFTP.Get(host, file[, port])
TFTP file contents.
Data Type |
List |
Platforms |
All |
| Argument | Type | Description |
|---|---|---|
host |
String |
TFTP server hostname or IP |
file |
String |
File path on TFTP server |
port |
Integer |
UDP port (default: 69) |
Requires EnableTFTPProxy = yes.
FileSystem.MountPoints
Mounted filesystem list.
Data Type |
List |
Platforms |
Linux, Windows, macOS, FreeBSD, Solaris, AIX |
Net.ArpCache
ARP table entries.
Data Type |
List |
Platforms |
Linux, Windows, macOS, FreeBSD, NetBSD, OpenBSD |
Net.InterfaceNames
Interface name list.
Data Type |
List |
Platforms |
Linux, Windows, FreeBSD, Solaris, AIX |
Net.IP.RoutingTable
IP routing table.
Data Type |
List |
Platforms |
Linux, Windows, macOS, FreeBSD, NetBSD, OpenBSD, AIX |
System.CPU.Instances
CPU instance indices for per-CPU instance discovery.
Data Type |
List |
Platforms |
Linux, Windows, macOS, FreeBSD, Solaris, AIX |
System.Processes
Running process list.
Data Type |
List |
Platforms |
Linux, Windows, macOS, FreeBSD, Solaris, AIX |
LVM.LogicalVolumes
List of all logical volumes. With a volume group argument, lists logical volumes in that volume group only.
Data Type |
List |
Platforms |
AIX |
| Metric | Description |
|---|---|
|
List of all logical volumes |
|
List of logical volumes in volume group. Argument: volume group name |
LVM.PhysicalVolumes
List of all physical volumes. With a volume group argument, lists physical volumes in that volume group only.
Data Type |
List |
Platforms |
AIX |
| Metric | Description |
|---|---|
|
List of all physical volumes |
|
List of physical volumes in volume group. Argument: volume group name |
ACPI.ThermalZones
List of ACPI thermal zones.
Requires the wmi subagent.
Data Type |
List |
Platforms |
Windows |
Hardware.NetworkAdapters (List)
List of network adapters.
Requires the wmi subagent.
Data Type |
List |
Platforms |
Windows |
PDH.ObjectCounters(object)
List of counters for the given PDH object.
Requires the winperf subagent.
Data Type |
List |
Platforms |
Windows |
| Argument | Type | Description |
|---|---|---|
object |
String |
PDH object name |
PDH.ObjectInstances(object)
List of instances for the given PDH object.
Requires the winperf subagent.
Data Type |
List |
Platforms |
Windows |
| Argument | Type | Description |
|---|---|---|
object |
String |
PDH object name |
PDH.Objects
List of available PDH objects.
Requires the winperf subagent.
Data Type |
List |
Platforms |
Windows |
System.Desktops(windowStation)
Desktop sessions.
Data Type |
List |
Platforms |
Windows |
| Argument | Type | Description |
|---|---|---|
windowStation |
String |
Window station name |
System.Registry.Keys(path)
Registry subkey paths.
Data Type |
List |
Platforms |
Windows |
| Argument | Type | Description |
|---|---|---|
path |
String |
Registry path |
System.Registry.Values(path)
Registry value entries.
Data Type |
List |
Platforms |
Windows |
| Argument | Type | Description |
|---|---|---|
path |
String |
Registry path |
WindowsCertificateStore.Certificates(store)
Thumbprints of certificates in the given Windows certificate store.
Data Type |
List |
Platforms |
Windows |
| Argument | Type | Description |
|---|---|---|
store |
String |
Certificate store name (e.g., |
WMI.Classes(namespace)
List of WMI classes in the given namespace.
Requires the wmi subagent.
Data Type |
List |
Platforms |
Windows |
| Argument | Type | Description |
|---|---|---|
namespace |
String |
WMI namespace |
WMI.Query(namespace, query, property) (List)
Result of WMI query: the given property from each object matched by the query.
Requires the wmi subagent.
Data Type |
List |
Platforms |
Windows |
| Argument | Type | Description |
|---|---|---|
namespace |
String |
WMI namespace (e.g., |
query |
String |
WQL query |
property |
String |
Property to return. Array properties can be indexed (e.g., |
Table Metrics
Table metrics return structured multi-column data. They are used for table DCIs and can be queried with nxget -T.
Agent.Extensions
Configured agent extensions.
Data Type |
Table |
Platforms |
All |
| Column | Type | Description |
|---|---|---|
NAME |
String |
Extension name (instance key) |
MODE |
String |
Extension mode ( |
STATE |
String |
Extension state |
PID |
Unsigned Integer |
Process ID |
PORT |
Unsigned Integer |
Assigned port |
RESTART_COUNT |
Unsigned Integer |
Restart count |
CONNECTED_SINCE |
Unsigned Integer 64 |
Connection timestamp |
LAST_ERROR |
String |
Last error message |
Agent.Problems
Agent-registered problems.
Data Type |
Table |
Platforms |
All |
| Column | Type | Description |
|---|---|---|
KEY |
String |
Problem identifier (instance key) |
SEVERITY |
Unsigned Integer |
Severity |
MESSAGE |
String |
Problem description |
Agent.SessionAgents
Active session agents.
Data Type |
Table |
Platforms |
All |
| Column | Type | Description |
|---|---|---|
SESSION_ID |
Unsigned Integer |
Session identifier (instance key) |
SESSION_NAME |
String |
Session name |
USER_NAME |
String |
User associated with session |
CLIENT_NAME |
String |
Client application name |
STATE |
Integer |
State |
AGENT_TYPE |
Integer |
Agent type |
AGENT_PID |
Integer |
Agent PID |
SCREEN_WIDTH |
Unsigned Integer |
Screen width |
SCREEN_HEIGHT |
Unsigned Integer |
Screen height |
SCREEN_BPP |
Unsigned Integer |
Screen BPP |
Agent.SubAgents
Loaded subagents with details.
Data Type |
Table |
Platforms |
All |
| Column | Type | Description |
|---|---|---|
NAME |
String |
Subagent name (instance key) |
VERSION |
String |
Subagent version |
FILE |
String |
Subagent file path |
Agent.ZoneConfigurations
Zone configurations.
Data Type |
Table |
Platforms |
All |
| Column | Type | Description |
|---|---|---|
SERVER_ID |
String |
Server identifier (instance key) |
ZONE_UIN |
Unsigned Integer |
Zone unique identification number |
LOCAL_ID |
Unsigned Integer |
Local ID |
SECRET |
String |
Secret |
Agent.ZoneProxies
Zone proxy configurations.
Data Type |
Table |
Platforms |
All |
| Column | Type | Description |
|---|---|---|
SERVER_ID |
String |
Server identifier (instance key) |
PROXY_ID |
Unsigned Integer |
Proxy identifier (instance key) |
ADDRESS |
String |
Proxy IP address |
CONNECTED |
String |
Connected |
IN_USE |
String |
In use |
ExternalCheck.PerfData(name)
Performance data from a configured external check, with one row per parsed entry.
LABEL is the instance column.
Entries without a numeric value, including U (unknown), are skipped; a check that returns no valid performance data produces an empty table.
Data Type |
Table |
Platforms |
All |
| Argument | Type | Description |
|---|---|---|
name |
String |
Configured external check name (case-insensitive) |
| Column | Type | Description |
|---|---|---|
LABEL |
String |
Performance data label, with plugin output quoting removed (instance key) |
VALUE |
Float |
Numeric value without the unit suffix; no unit conversion is performed |
UOM |
String |
Unit of measurement supplied by the plugin (empty if omitted) |
WARNING |
String |
Warning threshold as supplied by the plugin (empty if omitted) |
CRITICAL |
String |
Critical threshold as supplied by the plugin (empty if omitted) |
MIN |
Float |
Minimum value supplied by the plugin (empty if omitted) |
MAX |
Float |
Maximum value supplied by the plugin (empty if omitted) |
Returns no-such-instance error for an unknown check name, and a collection error if the check process cannot be started or times out. A missing plugin in shell form is not such an error: the run produces no performance data, so the table is empty. See External Checks for configuration, output parsing, and caching.
PhysicalDisk.Devices (Table)
Physical disk device information.
Data Type |
Table |
Platforms |
All |
| Column | Type | Description |
|---|---|---|
NAME |
String |
Device name/path (instance key) |
TYPE |
String |
Type |
PROTOCOL |
String |
Protocol |
MODEL_FAMILY |
String |
Family |
MODEL_NAME |
String |
Model |
SERIAL_NUMBER |
String |
Serial number |
FIRMWARE_VERSION |
String |
Firmware Version |
CAPACITY |
Unsigned Integer 64 |
Total capacity (bytes) |
FileSystem.Volumes
Filesystem volume information.
Data Type |
Table |
Platforms |
Linux, Windows, macOS, Solaris, AIX |
| Column | Type | Description |
|---|---|---|
MOUNTPOINT |
String |
Mount point path (instance key, Linux) or volume identifier (Windows) |
VOLUME |
String |
Volume device path |
LABEL |
String |
Volume label |
FSTYPE |
String |
Filesystem type |
SIZE.TOTAL |
Unsigned Integer 64 |
Total size (bytes) |
SIZE.USED |
Unsigned Integer 64 |
Used space (bytes) |
SIZE.FREE |
Unsigned Integer 64 |
Free space (bytes) |
SIZE.AVAIL |
Unsigned Integer 64 |
Available space (bytes) |
SIZE.USED.PCT |
Float |
Used space percentage |
SIZE.FREE.PCT |
Float |
Free space percentage |
SIZE.AVAIL.PCT |
Float |
Available space percentage |
Hardware.Batteries (Table)
Battery information.
Data Type |
Table |
Platforms |
Linux, Windows, Solaris |
| Column | Type | Description |
|---|---|---|
HANDLE |
Integer |
SMBIOS handle (instance key) |
NAME |
String |
Battery name |
LOCATION |
String |
Physical location |
CAPACITY |
Unsigned Integer |
Capacity rating (mWh) |
VOLTAGE |
Unsigned Integer |
Voltage rating (mV) |
CHEMISTRY |
String |
Chemistry type |
MANUFACTURER |
String |
Manufacturer |
MANUFACTURE_DATE |
String |
Manufacture date |
SERIAL_NUMBER |
String |
Serial number |
Hardware.MemoryDevices (Table)
Physical memory device information.
Data Type |
Table |
Platforms |
Linux, Windows, Solaris |
| Column | Type | Description |
|---|---|---|
HANDLE |
Integer |
SMBIOS handle (instance key) |
LOCATION |
String |
Physical location |
BANK |
String |
Bank location |
FORM_FACTOR |
String |
Physical form factor |
TYPE |
String |
Memory type (DDR4, DDR5, etc.) |
SIZE |
Unsigned Integer 64 |
Capacity (bytes) |
MAX_SPEED |
Unsigned Integer 64 |
Maximum speed (MHz) |
CONF_SPEED |
Unsigned Integer 64 |
Configured speed (MHz) |
MANUFACTURER |
String |
Manufacturer |
PART_NUMBER |
String |
Part number |
SERIAL_NUMBER |
String |
Serial number |
Hardware.NetworkAdapters
Network adapter hardware information.
On Windows, this table is provided by the wmi subagent.
Data Type |
Table |
Platforms |
Linux, Windows |
| Column | Type | Description |
|---|---|---|
INDEX |
Unsigned Integer |
Adapter index (instance key) |
PRODUCT |
String |
Product name |
MANUFACTURER |
String |
Manufacturer |
DESCRIPTION |
String |
Description |
TYPE |
String |
Adapter type |
MAC_ADDRESS |
String |
MAC address |
IF_INDEX |
Unsigned Integer |
Network stack interface index |
SPEED |
Unsigned Integer 64 |
Adapter speed (bps) |
AVAILABILITY |
Unsigned Integer |
Availability status |
Hardware.Processors (Table)
Processor information.
Data Type |
Table |
Platforms |
Linux, Windows, Solaris |
| Column | Type | Description |
|---|---|---|
HANDLE |
Integer |
SMBIOS handle (instance key) |
TYPE |
String |
Processor type |
FAMILY |
String |
Processor family |
VERSION |
String |
Version string |
SOCKET |
String |
Socket designation |
CORES |
Unsigned Integer |
Core count |
THREADS |
Unsigned Integer |
Thread count |
MAX_SPEED |
Unsigned Integer 64 |
Maximum frequency (MHz) |
CURR_SPEED |
Unsigned Integer 64 |
Current frequency (MHz) |
MANUFACTURER |
String |
Manufacturer |
PART_NUMBER |
String |
Part number |
SERIAL_NUMBER |
String |
Serial number |
Hardware.StorageDevices (Table)
Storage device information.
Data Type |
Table |
Platforms |
Linux, Windows |
| Column | Type | Description |
|---|---|---|
NUMBER |
Unsigned Integer |
Device number (instance key) |
TYPE |
Unsigned Integer |
Device type |
TYPE_DESCRIPTION |
String |
Device type description |
BUS_TYPE |
String |
Bus type |
REMOVABLE |
Integer |
Removable |
SIZE |
Unsigned Integer 64 |
Size (bytes) |
MANUFACTURER |
String |
Manufacturer |
PRODUCT |
String |
Product name |
REVISION |
String |
Firmware revision |
SERIAL |
String |
Serial number |
Net.Interfaces
Network interface details.
Data Type |
Table |
Platforms |
Linux, Windows, macOS, FreeBSD, NetBSD, OpenBSD |
| Column | Type | Description |
|---|---|---|
INDEX |
Unsigned Integer |
Interface index (instance key) |
NAME |
String |
Interface name |
ALIAS |
String |
Interface alias (Linux only; empty on other platforms) |
TYPE |
Unsigned Integer |
Interface type (IANA ifType). Link aggregation interfaces (Linux bond and team, Windows NIC team, macOS bond, FreeBSD lagg) are reported as 161 ( |
MTU |
Unsigned Integer |
Maximum transmission unit (always 0 on macOS) |
SPEED |
Unsigned Integer 64 |
Speed in bits per second (Linux and Windows only; empty on Windows when the link speed is unknown) |
MAC_ADDRESS |
String |
Hardware address |
IP_ADDRESSES |
String |
Assigned IP addresses |
PEER_IP |
String |
Point-to-point peer IP addresses (empty on Windows) |
MAX_SPEED |
Unsigned Integer 64 |
Maximum interface speed (Linux only; empty on Windows) |
AGGREGATE |
Unsigned Integer |
Index of the link aggregation interface this interface is a member of; 0 if it is not a member. Linux, macOS, and FreeBSD; on Windows only when the NIC teaming (LBFO) configuration can be read through WMI. Not provided on NetBSD and OpenBSD. |
The server reads link aggregation membership from the AGGREGATE column during configuration polls.
When the agent does not provide the column, the server keeps the membership it already has for the node’s interfaces.
Net.IP.Neighbors (Table)
IP neighbor table.
Data Type |
Table |
Platforms |
Linux |
| Column | Type | Description |
|---|---|---|
IP_ADDRESS |
String |
IP address (instance key) |
MAC_ADDRESS |
String |
MAC address |
IF_INDEX |
Unsigned Integer |
Interface index |
Net.Wireguard.Interfaces
WireGuard interface information.
Data Type |
Table |
Platforms |
Linux |
| Column | Type | Description |
|---|---|---|
NAME |
String |
Interface name (instance key) |
PUBLIC_KEY |
String |
Public key |
LISTEN_PORT |
Unsigned Integer |
Listen port |
Net.Wireguard.Peers
WireGuard peer information.
Data Type |
Table |
Platforms |
Linux |
| Column | Type | Description |
|---|---|---|
INTERFACE |
String |
Interface name (instance key) |
PEER_PUBLIC_KEY |
String |
Public key (instance key) |
ENDPOINT |
String |
Peer endpoint address |
ALLOWED_IPS |
String |
Allowed IP ranges |
HANDSHAKE_TIMESTAMP |
Unsigned Integer 64 |
Last handshake |
RX_BYTES |
Unsigned Integer 64 |
Bytes received |
TX_BYTES |
Unsigned Integer 64 |
Bytes transmitted |
System.ActiveUserSessions (Table)
Active user session information.
Data Type |
Table |
Platforms |
Linux, Windows |
| Column | Type | Description |
|---|---|---|
ID |
Unsigned Integer |
Session identifier (instance key) |
USER_NAME |
String |
User name |
TERMINAL |
String |
Terminal name |
STATE |
String |
State |
CLIENT_NAME |
String |
Client hostname |
CLIENT_ADDRESS |
String |
Client IP address |
CLIENT_DISPLAY |
String |
Client display |
CONNECT_TIMESTAMP |
Unsigned Integer 64 |
Connect time |
LOGON_TIMESTAMP |
Unsigned Integer 64 |
Logon time |
IDLE_TIME |
Unsigned Integer |
Idle time (seconds) |
System.InstalledProducts
Installed software packages.
Data Type |
Table |
Platforms |
Linux, Windows, FreeBSD, Solaris, AIX |
| Column | Type | Description |
|---|---|---|
NAME |
String |
Product name (part of instance key) |
VERSION |
String |
Product version (part of instance key) |
VENDOR |
String |
Vendor name |
DATE |
Integer 64 (Linux/Windows), String (other platforms) |
Installation date |
URL |
String |
Product URL |
DESCRIPTION |
String |
Product description |
UNINSTALL_KEY |
String |
Uninstall key (Linux/Windows) |
USER |
String |
User (Windows only) |
System.OpenFiles
Open file handles.
Data Type |
Table |
Platforms |
Linux |
| Column | Type | Description |
|---|---|---|
PID |
Unsigned Integer |
Process ID (instance key) |
PROCNAME |
String |
Process |
HANDLE |
Unsigned Integer |
File handle (instance key) |
NAME |
String |
File path |
System.Processes (Table)
Running process details.
Data Type |
Table |
Platforms |
Linux, Windows, macOS, FreeBSD, Solaris, AIX |
| Column | Type | Description |
|---|---|---|
PID |
Unsigned Integer |
Process ID (instance key) |
NAME |
String |
Process name |
USER |
String |
User running the process |
THREADS |
Unsigned Integer |
Thread count |
HANDLES |
Unsigned Integer |
Handle/FD count |
KTIME |
Unsigned Integer 64 |
Kernel time (ms) |
UTIME |
Unsigned Integer 64 |
User time (ms) |
VMSIZE |
Unsigned Integer 64 |
Virtual memory size (bytes) |
RSS |
Unsigned Integer 64 |
Resident set size (bytes) |
MEMORY_USAGE |
Float |
Memory usage percentage |
PAGE_FAULTS |
Unsigned Integer 64 |
Page fault count |
CMDLINE |
String |
Command line |
System.Services (Table)
System services.
Data Type |
Table |
Platforms |
Linux, Windows |
| Column | Type | Description |
|---|---|---|
NAME |
String |
Service name (instance key) |
DISPNAME |
String |
Display name |
TYPE |
String |
Type |
STATE |
String |
Service state |
STARTUP |
String |
Startup type (Linux: N/A; Windows: auto/manual/disabled) |
RUN_AS |
String |
Account running the service |
PID |
Unsigned Integer |
Process ID |
BINARY |
String |
Binary path |
DEPENDENCIES |
String |
Service dependencies |
WindowsCertificateStore.Certificates(store) (Table)
Certificates in the given Windows certificate store.
Data Type |
Table |
Platforms |
Windows |
| Argument | Type | Description |
|---|---|---|
store |
String |
Certificate store name (e.g., |
| Column | Type | Description |
|---|---|---|
THUMBPRINT |
String |
SHA-1 thumbprint (instance key) |
SUBJECT |
String |
Subject name |
ISSUER |
String |
Issuer name |
TEMPLATE_ID |
String |
Certificate template identifier |
EXPIRATION_DATE |
String |
Expiration date (YYYY-MM-DD) |
EXPIRATION_TIME |
Unsigned Integer 64 |
Expiration UNIX timestamp |
EXPIRES_IN |
Integer |
Days until expiration |
HAS_PRIVATE_KEY |
Integer |
Private key presence (1=yes, 0=no) |
WMI.Query(namespace, query) (Table)
Generic WMI query result as a table.
Columns are determined by the properties of the objects returned by the query.
Requires the wmi subagent.
Data Type |
Table |
Platforms |
Windows |
| Argument | Type | Description |
|---|---|---|
namespace |
String |
WMI namespace (e.g., |
query |
String |
WQL query |