Win32_PerfFormattedData_Tcpip_NetworkInterface class
The Win32_PerfFormattedData_Tcpip_NetworkInterface formatted data class provides pre-calculated 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 is shown as the Network Interface object in System Monitor. This class derives its raw data from the corresponding raw class Win32_PerfRawData_Tcpip_NetworkInterface. The original data source is the Tcpip performance library. Data is dynamically provided for this class from the performance library object by the WmiPerfInst provider.
Windows Server 2003 and Windows XP: WMI data for this class is supplied by the Formatted Performance Data 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 Performance Counter Classes. For more information about CounterType values, see WMI Performance Counter Types.
Syntax
class Win32_PerfFormattedData_Tcpip_NetworkInterface : Win32_PerfFormattedData
{
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_PerfFormattedData_Tcpip_NetworkInterface class has these types of members:
- Properties
Properties
The Win32_PerfFormattedData_Tcpip_NetworkInterface class has these properties.
BytesReceivedPerSec
Data type: uint32
Access type: Read-only
Qualifiers: CookingType ("PERF_COUNTER_COUNTER") , Counter ("BytesReceivedPerSec") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")
Rate at which bytes are received on the interface, including framing characters.
BytesSentPerSec
Data type: uint32
Access type: Read-only
Qualifiers: CookingType ("PERF_COUNTER_COUNTER") , Counter ("BytesSentPerSec") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")
Rate at which bytes are sent on the interface, including framing characters.
BytesTotalPerSec
Data type: uint64
Access type: Read-only
Qualifiers: CookingType ("PERF_COUNTER_BULK_COUNT") , Counter ("BytesTotalPerSec") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")
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: CookingType ("PERF_COUNTER_RAWCOUNT") , Counter ("CurrentBandwidth") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")
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 could 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
Label by which the statistic or metric is known. When sub-classed, the property can be overridden to be a key property. This property is inherited from CIM_StatisticalInformation.
OutputQueueLength
Data type: uint32
Access type: Read-only
Qualifiers: CookingType ("PERF_COUNTER_RAWCOUNT") , Counter ("OutputQueueLength") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")
Length of the output packet queue (in packets.) If this is longer than 2, delays are being experienced and the bottleneck 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: CookingType ("PERF_COUNTER_RAWCOUNT") , Counter ("PacketsOutboundDiscarded") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")
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: CookingType ("PERF_COUNTER_RAWCOUNT") , Counter ("PacketsOutboundErrors") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")
Number of outbound packets that could not be transmitted because of errors.
PacketsPerSec
Data type: uint32
Access type: Read-only
Qualifiers: CookingType ("PERF_COUNTER_COUNTER") , Counter ("PacketsPerSec") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")
Rate at which packets are sent and received on the network interface.
PacketsReceivedDiscarded
Data type: uint32
Access type: Read-only
Qualifiers: CookingType ("PERF_COUNTER_RAWCOUNT") , Counter ("PacketsReceivedDiscarded") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")
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: CookingType ("PERF_COUNTER_RAWCOUNT") , Counter ("PacketsReceivedErrors") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")
Number of inbound packets that contained errors preventing delivery to a higher-layer protocol.
PacketsReceivedNonUnicastPerSec
Data type: uint32
Access type: Read-only
Qualifiers: CookingType ("PERF_COUNTER_COUNTER") , Counter ("PacketsReceivedNonUnicastPerSec") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")
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: CookingType ("PERF_COUNTER_COUNTER") , Counter ("PacketsReceivedPerSec") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")
Rate at which packets are received on the network interface.
PacketsReceivedUnicastPerSec
Data type: uint32
Access type: Read-only
Qualifiers: CookingType ("PERF_COUNTER_COUNTER") , Counter ("PacketsReceivedUnicastPerSec") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")
Rate at which (subnet) unicast packets are delivered to a higher-layer protocol.
PacketsReceivedUnknown
Data type: uint32
Access type: Read-only
Qualifiers: CookingType ("PERF_COUNTER_RAWCOUNT") , Counter ("PacketsReceivedUnknown") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")
Number of packets received using the interface that were discarded because of an unknown or unsupported protocol.
PacketsSentNonUnicastPerSec
Data type: uint32
Access type: Read-only
Qualifiers: CookingType ("PERF_COUNTER_COUNTER") , Counter ("PacketsSentNonUnicastPerSec") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")
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: CookingType ("PERF_COUNTER_COUNTER") , Counter ("PacketsSentPerSec") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")
Rate at which packets are sent on the network interface.
PacketsSentUnicastPerSec
Data type: uint32
Access type: Read-only
Qualifiers: CookingType ("PERF_COUNTER_COUNTER") , Counter ("PacketsSentUnicastPerSec") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")
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 could 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
Minimum supported client |
Windows XP |
Minimum supported server |
Windows Server 2003 |
Namespace |
\root\CIMV2 |
DLL |
WmiPerfInst.dll; WmiCookr.dll on Windows Server 2003 and Windows XP |
See also
Accessing WMI Preinstalled Performance Classes