Win32_PerfRawData_Tcpip_NetworkInterface class

The Win32_PerfRawData_Tcpip_NetworkInterface raw performance data class provides raw data from performance counters that monitor the rates at which bytes and packets are sent and received over a TCP/IP network connection. It includes counters that monitor connection errors.

This class represents the Network Interface object in System Monitor. The original data source is the Tcpip performance library. The corresponding formatted data class is Win32_PerfFormattedData_Tcpip_NetworkInterface. Data is dynamically provided for this class from the performance library object by the WmiPerfInst provider.

Windows Server 2003, Windows XP, and Windows 2000:  WMI data for this class is supplied by the Performance Counter Provider.

The following syntax is simplified from MOF code and shows all inherited properties, including the Frequency and Timestamp properties required for class display in System Monitor. For more information about required property qualifiers, see Property Qualifiers for Raw Performance Counter Classes. For more information about CounterType values, see WMI Performance Counter Types.

Syntax

class Win32_PerfRawData_Tcpip_NetworkInterface : Win32_PerfRawData
{
  uint32 BytesReceivedPerSec;
  uint32 BytesSentPerSec;
  uint64 BytesTotalPerSec;
  string Caption;
  uint32 CurrentBandwidth;
  string Description;
  uint64 Frequency_Object;
  uint64 Frequency_PerfTime;
  uint64 Frequency_Sys100NS;
  string Name;
  uint32 OutputQueueLength;
  uint32 PacketsOutboundDiscarded;
  uint32 PacketsOutboundErrors;
  uint32 PacketsPerSec;
  uint32 PacketsReceivedDiscarded;
  uint32 PacketsReceivedErrors;
  uint32 PacketsReceivedNonUnicastPerSec;
  uint32 PacketsReceivedPerSec;
  uint32 PacketsReceivedUnicastPerSec;
  uint32 PacketsReceivedUnknown;
  uint32 PacketsSentNonUnicastPerSec;
  uint32 PacketsSentPerSec;
  uint32 PacketsSentUnicastPerSec;
  uint64 Timestamp_Object;
  uint64 Timestamp_PerfTime;
  uint64 Timestamp_Sys100NS;
};

Members

The Win32_PerfRawData_Tcpip_NetworkInterface class has these types of members:

• Properties

Properties

The Win32_PerfRawData_Tcpip_NetworkInterface class has these properties.

BytesReceivedPerSec

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("Bytes Received/sec") , CounterType (272696320) , DefaultScale (-4) , PerfDetail (200)

Rate at which bytes are received on the interface, including framing characters.

BytesSentPerSec

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("Bytes Sent/sec") , CounterType (272696320) , DefaultScale (-4) , PerfDetail (200)

Rate at which bytes are sent on the interface, including framing characters.

BytesTotalPerSec

Data type: uint64

Access type: Read-only

Qualifiers: DisplayName ("Bytes Total/sec") , PerfDefault, CounterType (272696576) , DefaultScale (-4) , PerfDetail (200)

Rate at which bytes are sent and received on the interface, including framing characters.

For more information about using uint64 values in scripts, see Scripting in WMI.

Caption

Data type: string

Access type: Read-only

Short textual description for the statistic or metric. This property is inherited from CIM_StatisticalInformation.

CurrentBandwidth

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("Current Bandwidth") , CounterType (65536) , DefaultScale (-6) , PerfDetail (200)

Estimate of the interface's current bandwidth in bits per second (bps). For interfaces that do not vary in bandwidth or for those where no accurate estimation can be made, this value is the nominal bandwidth.

Description

Data type: string

Access type: Read-only

Textual description of the statistic or metric. This property is inherited from CIM_StatisticalInformation.

Frequency_Object

Data type: uint64

Access type: Read-only

Frequency, in ticks per second, of Timestamp_Object. This property is defined by the provider. This property is inherited from Win32_Perf.

For more information about using uint64 values in scripts, see Scripting in WMI.

Frequency_PerfTime

Data type: uint64

Access type: Read-only

Frequency, in ticks per second, of Timestamp_Perftime. A value can be obtained by calling the Windows function QueryPerformanceCounter. This property is inherited from Win32_Perf.

For more information about using uint64 values in scripts, see Scripting in WMI.

Frequency_Sys100NS

Data type: uint64

Access type: Read-only

Frequency, in ticks per second, of Timestamp_Sys100NS (10000000). This property is inherited from Win32_Perf.

For more information about using uint64 values in scripts, see Scripting in WMI.

Name

Data type: string

Access type: Read-only

Qualifiers: Key, MaxLen (256)

Label by which the statistic or metric is known. This property is inherited from CIM_StatisticalInformation.

OutputQueueLength

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("Output Queue Length") , CounterType (65536) , DefaultScale (0) , PerfDetail (200)

Length of the output packet queue in packets. If this is longer than 2, delays occur. The cause of the delay should be found and eliminated, if possible. Because the requests are queued by NDIS in this implementation, this value is always 0.

PacketsOutboundDiscarded

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("Packets Outbound Discarded") , CounterType (65536) , DefaultScale (0) , PerfDetail (200)

Number of outbound packets that were chosen to be discarded even though no errors had been detected to prevent transmission. One possible reason for discarding such a packet could be to free up buffer space.

PacketsOutboundErrors

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("Packets Outbound Errors") , CounterType (65536) , DefaultScale (0) , PerfDetail (200)

Number of outbound packets that could not be transmitted because of errors.

PacketsPerSec

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("Packets/sec") , CounterType (272696320) , DefaultScale (-1) , PerfDetail (200)

Rate at which packets are sent and received on the network interface.

PacketsReceivedDiscarded

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("Packets Received Discarded") , CounterType (65536) , DefaultScale (0) , PerfDetail (200)

Number of inbound packets that were chosen to be discarded even though no errors had been detected to prevent delivery to a higher-layer protocol. One possible reason for discarding such a packet could be to free up buffer space.

PacketsReceivedErrors

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("Packets Received Errors") , CounterType (65536) , DefaultScale (0) , PerfDetail (200)

Number of inbound packets that contained errors preventing delivery to a higher-layer protocol.

PacketsReceivedNonUnicastPerSec

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("Packets Received Non-Unicast/sec") , CounterType (272696320) , DefaultScale (-1) , PerfDetail (300) , DisplayName ("Packets Received Non-Unicast/sec") , CounterType (272696320) , DefaultScale (-1) , PerfDetail (300)

Rate at which non-unicast (that is, subnet broadcast or subnet multicast) packets are delivered to a higher-layer protocol.

PacketsReceivedPerSec

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("Packets Received/sec") , CounterType (272696320) , DefaultScale (-1) , PerfDetail (200)

Rate at which packets are received on the network interface.

PacketsReceivedUnicastPerSec

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("Packets Received Unicast/sec") , CounterType (272696320) , DefaultScale (-1) , PerfDetail (300)

Rate at which subnet unicast packets are delivered to a higher-layer protocol.

PacketsReceivedUnknown

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("Packets Received Unknown") , CounterType (65536) , DefaultScale (0) , PerfDetail (200)

Number of packets received via the interface that were discarded because of an unknown or unsupported protocol.

PacketsSentNonUnicastPerSec

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("Packets Sent Non-Unicast/sec") , CounterType (272696320) , DefaultScale (-1) , PerfDetail (300)

Rate at which packets are requested to be transmitted to non-unicast (that is, subnet broadcast or subnet multicast) addresses by higher-level protocols. The rate includes the packets that were discarded or not sent.

PacketsSentPerSec

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("Packets Sent/sec") , CounterType (272696320) , DefaultScale (-1) , PerfDetail (200)

Rate at which packets are sent on the network interface.

PacketsSentUnicastPerSec

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("Packets Sent Unicast/sec") , CounterType (272696320) , DefaultScale (-1) , PerfDetail (300)

Rate at which packets are requested to be transmitted to subnet-unicast addresses by higher-level protocols. The rate includes the packets that were discarded or not sent.

Timestamp_Object

Data type: uint64

Access type: Read-only

Object-defined timestamp, defined by the provider. This property is inherited from Win32_Perf.

For more information about using uint64 values in scripts, see Scripting in WMI.

Timestamp_PerfTime

Data type: uint64

Access type: Read-only

High Performance counter timestamp. A value can be obtained by calling the Windows function QueryPerformanceCounter. This property is inherited from Win32_Perf.

For more information about using uint64 values in scripts, see Scripting in WMI.

Timestamp_Sys100NS

Data type: uint64

Access type: Read-only

Timestamp value in 100 nanosecond units. This property is inherited from Win32_Perf.

For more information about using uint64 values in scripts, see Scripting in WMI.

Remarks

All classes derived from Win32_Perf are designed to be used with a refresher object. For more information about how to create and use a refresher object in C++, see Accessing Performance Data in C++. For more information about how to create and use a refresher object using scripts, see Refreshing WMI Data in Scripts.

The performance class and property qualifiers determine how to interpret the class data. For more information, see Class Qualifiers for Performance Counter Classes and Property Qualifiers for Performance Counter Classes.

Examples

For script code examples, see WMI Tasks for Scripts and Applications and the TechNet ScriptCenter Script Repository.

For C++ code examples, see WMI C++ Application Examples.

Requirements

See also

Performance Counter Classes

Accessing WMI Preinstalled Performance Classes

WMI Tasks: Performance Monitoring

Accessing Performance Data in Script

Send comments about this topic to Microsoft

Build date: 11/19/2012