Network Interface Metrics

The argument for all Net.Interface.* metrics is the interface name or interface index. Interface indices can be obtained from the Net.InterfaceList list.

Traffic counters are raw counter values. Use Counter32 or Counter64 data type in DCI configuration to get per-second rates automatically.

On NetBSD the 32-bit interface counter metrics are registered with data type Unsigned Integer 64; on OpenBSD they are registered as Unsigned Integer (the 64-bit variants as Unsigned Integer 64).

Net.Interface.BytesIn(ifName)

Inbound bytes. Available in 32-bit and 64-bit counter variants.

Data Type

Counter 32 / Counter 64

Platforms

Linux, Windows, Solaris, AIX, FreeBSD, NetBSD, OpenBSD, macOS (64-bit: Linux, Windows, Solaris, FreeBSD, OpenBSD, macOS)

Table 1. Arguments
Argument	Type	Description
ifName	String	Interface name or index

Table 2. Variants
Metric	Description
`Net.Interface.BytesIn(*)`	32-bit counter
`Net.Interface.BytesIn64(*)`	64-bit counter

Net.Interface.BytesOut(ifName)

Outbound bytes. Available in 32-bit and 64-bit counter variants.

Data Type

Counter 32 / Counter 64

Platforms

Linux, Windows, Solaris, AIX, FreeBSD, NetBSD, OpenBSD, macOS (64-bit: Linux, Windows, Solaris, FreeBSD, OpenBSD, macOS)

Table 3. Arguments
Argument	Type	Description
ifName	String	Interface name or index

Table 4. Variants
Metric	Description
`Net.Interface.BytesOut(*)`	32-bit counter
`Net.Interface.BytesOut64(*)`	64-bit counter

Net.Interface.InDrops(ifName)

Inbound dropped packets. Available in 32-bit and 64-bit counter variants.

Data Type

Counter 32 / Counter 64

Platforms

Linux, Windows, Solaris, AIX, FreeBSD, NetBSD, OpenBSD, macOS (64-bit: Linux, Windows, FreeBSD, OpenBSD, macOS)

Table 5. Arguments
Argument	Type	Description
ifName	String	Interface name or index

Table 6. Variants
Metric	Description
`Net.Interface.InDrops(*)`	32-bit counter
`Net.Interface.InDrops64(*)`	64-bit counter

Net.Interface.OutDrops(ifName)

Outbound dropped packets. Available in 32-bit and 64-bit counter variants.

Data Type

Counter 32 / Counter 64

Platforms

Linux, Windows, Solaris, AIX, FreeBSD (64-bit: Linux, Windows, FreeBSD)

Table 7. Arguments
Argument	Type	Description
ifName	String	Interface name or index

Table 8. Variants
Metric	Description
`Net.Interface.OutDrops(*)`	32-bit counter
`Net.Interface.OutDrops64(*)`	64-bit counter

Net.Interface.InErrors(ifName)

Inbound errors. Available in 32-bit and 64-bit counter variants.

Data Type

Counter 32 / Counter 64

Platforms

Linux, Windows, Solaris, AIX, FreeBSD, NetBSD, OpenBSD, macOS (64-bit: Linux, FreeBSD, OpenBSD, macOS)

Table 9. Arguments
Argument	Type	Description
ifName	String	Interface name or index

Table 10. Variants
Metric	Description
`Net.Interface.InErrors(*)`	32-bit counter
`Net.Interface.InErrors64(*)`	64-bit counter

Net.Interface.OutErrors(ifName)

Outbound errors. Available in 32-bit and 64-bit counter variants.

Data Type

Counter 32 / Counter 64

Platforms

Linux, Windows, Solaris, AIX, FreeBSD, NetBSD, OpenBSD, macOS (64-bit: Linux, FreeBSD, OpenBSD, macOS)

Table 11. Arguments
Argument	Type	Description
ifName	String	Interface name or index

Table 12. Variants
Metric	Description
`Net.Interface.OutErrors(*)`	32-bit counter
`Net.Interface.OutErrors64(*)`	64-bit counter

Net.Interface.PacketsIn(ifName)

Inbound packets. Available in 32-bit and 64-bit counter variants.

Data Type

Counter 32 / Counter 64

Platforms

Linux, Windows, Solaris, AIX, FreeBSD, NetBSD, OpenBSD, macOS (64-bit: Linux, Windows, Solaris, FreeBSD, OpenBSD, macOS)

Table 13. Arguments
Argument	Type	Description
ifName	String	Interface name or index

Table 14. Variants
Metric	Description
`Net.Interface.PacketsIn(*)`	32-bit counter
`Net.Interface.PacketsIn64(*)`	64-bit counter

Net.Interface.PacketsOut(ifName)

Outbound packets. Available in 32-bit and 64-bit counter variants.

Data Type

Counter 32 / Counter 64

Platforms

Linux, Windows, Solaris, AIX, FreeBSD, NetBSD, OpenBSD, macOS (64-bit: Linux, Windows, Solaris, FreeBSD, OpenBSD, macOS)

Table 15. Arguments
Argument	Type	Description
ifName	String	Interface name or index

Table 16. Variants
Metric	Description
`Net.Interface.PacketsOut(*)`	32-bit counter
`Net.Interface.PacketsOut64(*)`	64-bit counter

Net.Interface.AdminStatus(ifName)

Administrative status of the interface.

Data Type

Integer

Platforms

Linux, Windows, Solaris, AIX, FreeBSD, NetBSD, OpenBSD

Table 17. Arguments
Argument	Type	Description
ifName	String	Interface name or index

Table 18. Return values
Value	Description
1	Up
2	Down
3	Testing

Net.Interface.Description(ifName)

Interface description.

Data Type

String

Platforms

Linux, Windows, Solaris, AIX

Table 19. Arguments
Argument	Type	Description
ifName	String	Interface name or index

Net.Interface.Link(ifName)

Link status of the interface. Deprecated on all platforms except Linux — use Net.Interface.OperStatus instead.

Data Type

Integer

Platforms

Linux, Windows, Solaris, AIX, FreeBSD, NetBSD, OpenBSD, macOS

Table 20. Arguments
Argument	Type	Description
ifName	String	Interface name or index

Table 21. Return values
Value	Description
0	Down
1	Up

Net.Interface.MaxSpeed(ifName)

Maximum interface speed in bits per second.

Data Type

Unsigned Integer 64

Platforms

Linux

Table 22. Arguments
Argument	Type	Description
ifName	String	Interface name or index

Net.Interface.MTU(ifName)

Maximum transmission unit.

Data Type

Unsigned Integer (Integer on AIX)

Platforms

Windows, AIX, OpenBSD

Table 23. Arguments
Argument	Type	Description
ifName	String	Interface name or index

Net.Interface.OperStatus(ifName)

Operational status of the interface.

Data Type

Integer

Platforms

Windows, Solaris, AIX, FreeBSD, NetBSD, OpenBSD, macOS

Table 24. Arguments
Argument	Type	Description
ifName	String	Interface name or index

Table 25. Return values
Value	Description
0	Down
1	Up

Net.Interface.Speed(ifName)

Interface speed in bits per second.

Data Type

Unsigned Integer 64 (Unsigned Integer on Solaris, Integer on AIX)

Platforms

Linux, Windows, FreeBSD, OpenBSD, Solaris, AIX

Table 26. Arguments
Argument	Type	Description
ifName	String	Interface name or index

Net.Interface.64BitCounters

Indicates whether 64-bit interface counters are supported.

Data Type

Integer

Platforms

Windows, FreeBSD

Net.IP.Forwarding

Indicates whether IPv4 forwarding is enabled.

Data Type

Integer

Platforms

Linux, Windows, FreeBSD, NetBSD, OpenBSD, macOS

Table 27. Return values
Value	Description
0	Disabled
1	Enabled

Net.IP6.Forwarding

Indicates whether IPv6 forwarding is enabled.

Data Type

Integer

Platforms

Linux, FreeBSD, NetBSD, OpenBSD, macOS

Table 28. Return values
Value	Description
0	Disabled
1	Enabled

Net.IP.NextHop(ipAddress)

Next hop gateway for the given destination address. This is a server-side metric with Internal origin, available on nodes with an agent or SNMP; it is not collected through the agent.

Data Type

String

Origin

Internal (server-side)

Table 29. Arguments
Argument	Type	Description
ipAddress	String	Destination IP address

Net.IP.Stats.TCPConnections

Total number of TCP connections across all states and IP versions. Also available as a parameterized variant for filtered queries (added in 6.1).

Data Type

Integer

Platforms

Linux, Windows, Solaris, AIX, FreeBSD, NetBSD, OpenBSD, macOS

The parameterized variant Net.IP.Stats.TCPConnections(*) accepts named parameters passed as key=value pairs separated by semicolons.

Table 30. Filter parameters
Parameter	Description
`state`	TCP connection state to count. If omitted, connections in all states are counted. Supported values: `ESTABLISHED`, `SYN_SENT`, `SYN_RECV`, `FIN_WAIT1`, `FIN_WAIT2`, `TIME_WAIT`, `CLOSE`, `CLOSE_WAIT`, `LAST_ACK`, `LISTEN`, `CLOSING`.
`version`	IP protocol version. Set to `4` for IPv4 only or `6` for IPv6 only. If omitted, connections on both IPv4 and IPv6 are counted.

Examples

Net.IP.Stats.TCPConnections(state=ESTABLISHED)
Net.IP.Stats.TCPConnections(state=LISTEN;version=4)
Net.IP.Stats.TCPConnections(version=6)

Net.RemoteShareStatus(path)

Check accessibility of a remote shared resource (Windows only). Net.RemoteShareStatus returns an integer code, Net.RemoteShareStatusText returns the same status as text.

Data Type

Integer (Net.RemoteShareStatus) / String (Net.RemoteShareStatusText)

Platforms

Windows

Table 31. Arguments
#	Type	Description
1	String	UNC path to the share (e.g., `\\server\share`)
2	String	Domain name (optional)
3	String	Login name (optional)
4	String	Password (optional)

Net.Resolver.AddressByName(hostname)

DNS forward resolution - resolves hostname to IP address.

Data Type

String

Platforms

All

Table 32. Arguments
Argument	Type	Description
hostname	String	Hostname to resolve

Net.Resolver.NameByAddress(ipAddress)

DNS reverse resolution - resolves IP address to hostname.

Data Type

String

Platforms

All

Table 33. Arguments
Argument	Type	Description
ipAddress	String	IP address to resolve