Win32_PerfFormattedData_Tcpip_ICMP class

The Win32_PerfFormattedData_Tcpip_ICMP formatted data class provides pre-calculated data from performance counters that monitor the rates at which messages are sent and received by using ICMP protocols. It also includes counters that monitor ICMP protocol errors.

This class is shown as the ICMP object in System Monitor. This class derives its raw data from the corresponding raw class Win32_PerfRawData_Tcpip_ICMP. 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_ICMP : Win32_PerfFormattedData
{
  string Caption;
  string Description;
  uint64 Frequency_Object;
  uint64 Frequency_PerfTime;
  uint64 Frequency_Sys100NS;
  uint32 MessagesOutboundErrors;
  uint32 MessagesPerSec;
  uint32 MessagesReceivedErrors;
  uint32 MessagesReceivedPerSec;
  uint32 MessagesSentPerSec;
  string Name;
  uint32 ReceivedAddressMask;
  uint32 ReceivedAddressMaskReply;
  uint32 ReceivedDestUnreachable;
  uint32 ReceivedEchoPerSec;
  uint32 ReceivedEchoReplyPerSec;
  uint32 ReceivedParameterProblem;
  uint32 ReceivedRedirectPerSec;
  uint32 ReceivedSourceQuench;
  uint32 ReceivedTimeExceeded;
  uint32 ReceivedTimestampPerSec;
  uint32 ReceivedTimestampReplyPerSec;
  uint32 SentAddressMask;
  uint32 SentAddressMaskReply;
  uint32 SentDestinationUnreachable;
  uint32 SentEchoPerSec;
  uint32 SentEchoReplyPerSec;
  uint32 SentParameterProblem;
  uint32 SentRedirectPerSec;
  uint32 SentSourceQuench;
  uint32 SentTimeExceeded;
  uint32 SentTimestampPerSec;
  uint32 SentTimestampReplyPerSec;
  uint64 Timestamp_Object;
  uint64 Timestamp_PerfTime;
  uint64 Timestamp_Sys100NS;
};

Members

The Win32_PerfFormattedData_Tcpip_ICMP class has these types of members:

Properties

The Win32_PerfFormattedData_Tcpip_ICMP class has these properties.

Caption
Data type: string
Access type: Read-only

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

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.

MessagesOutboundErrors
Data type: uint32
Access type: Read-only
Qualifiers: CookingType ("PERF_COUNTER_RAWCOUNT") , Counter ("MessagesOutboundErrors") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Number of ICMP messages that this entity did not send due to problems discovered within ICMP, such as lack of buffers. This value does not include errors discovered outside the ICMP layer, such as those recording the failure of IP to route the resultant datagram. In some implementations, none of the error types are included in the value of this property.

MessagesPerSec
Data type: uint32
Access type: Read-only
Qualifiers: CookingType ("PERF_COUNTER_RAWCOUNT") , Counter ("MessagesPerSec") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Total rate at which ICMP messages are sent and received by the entity. The rate includes those messages received or sent in error.

MessagesReceivedErrors
Data type: uint32
Access type: Read-only
Qualifiers: CookingType ("PERF_COUNTER_RAWCOUNT") , Counter ("MessagesReceivedErrors") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Number of ICMP messages that the entity received but determined as having errors (for example, bad ICMP checksums, bad length, and so on).

MessagesReceivedPerSec
Data type: uint32
Access type: Read-only
Qualifiers: CookingType ("PERF_COUNTER_COUNTER") , Counter ("MessagesReceivedPerSec") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Rate at which ICMP messages are received by the entity. The rate includes those messages received in error.

MessagesSentPerSec
Data type: uint32
Access type: Read-only
Qualifiers: CookingType ("PERF_COUNTER_COUNTER") , Counter ("MessagesSentPerSec") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Rate at which the entity attempts to send ICMP messages. The rate includes those messages sent in error.

Name
Data type: string
Access type: Read-only
Qualifiers: Key, MaxLen (256)

Label by which the statistic or metric is known. When subclassed, the property can be overridden to be a key property. This property is inherited from CIM_StatisticalInformation.

ReceivedAddressMask
Data type: uint32
Access type: Read-only
Qualifiers: CookingType ("PERF_COUNTER_RAWCOUNT") , Counter ("ReceivedAddressMask") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Number of ICMP address mask request messages received.

ReceivedAddressMaskReply
Data type: uint32
Access type: Read-only
Qualifiers: CookingType ("PERF_COUNTER_RAWCOUNT") , Counter ("ReceivedAddressMaskReply") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Number of ICMP address mask reply messages received.

ReceivedDestUnreachable
Data type: uint32
Access type: Read-only
Qualifiers: CookingType ("PERF_COUNTER_RAWCOUNT") , Counter ("ReceivedDestUnreachable") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Number of ICMP destination unreachable messages received.

ReceivedEchoPerSec
Data type: uint32
Access type: Read-only
Qualifiers: CookingType ("PERF_COUNTER_COUNTER") , Counter ("ReceivedEchoPerSec") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Rate of ICMP echo messages received.

ReceivedEchoReplyPerSec
Data type: uint32
Access type: Read-only
Qualifiers: CookingType ("PERF_COUNTER_COUNTER") , Counter ("ReceivedEchoReplyPerSec") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Rate of ICMP echo reply messages received.

ReceivedParameterProblem
Data type: uint32
Access type: Read-only
Qualifiers: CookingType ("PERF_COUNTER_RAWCOUNT") , Counter ("ReceivedParameterProblem") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Number of ICMP parameter problem messages received.

ReceivedRedirectPerSec
Data type: uint32
Access type: Read-only
Qualifiers: CookingType ("PERF_COUNTER_RAWCOUNT") , Counter ("ReceivedRedirectPerSec") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Rate of ICMP redirect messages received.

ReceivedSourceQuench
Data type: uint32
Access type: Read-only
Qualifiers: CookingType ("PERF_COUNTER_RAWCOUNT") , Counter ("ReceivedSourceQuench") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Number of ICMP source quench messages received.

ReceivedTimeExceeded
Data type: uint32
Access type: Read-only
Qualifiers: CookingType ("PERF_COUNTER_RAWCOUNT") , Counter ("ReceivedTimeExceeded") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Number of ICMP time exceeded messages received.

ReceivedTimestampPerSec
Data type: uint32
Access type: Read-only
Qualifiers: CookingType ("PERF_COUNTER_COUNTER") , Counter ("ReceivedTimestampPerSec") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Rate of ICMP timestamp (request) messages received.

ReceivedTimestampReplyPerSec
Data type: uint32
Access type: Read-only
Qualifiers: CookingType ("PERF_COUNTER_COUNTER") , Counter ("ReceivedTimestampReplyPerSec") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Rate of ICMP timestamp reply messages received.

SentAddressMask
Data type: uint32
Access type: Read-only
Qualifiers: CookingType ("PERF_COUNTER_RAWCOUNT") , Counter ("SentAddressMask") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Number of ICMP address mask request messages sent.

SentAddressMaskReply
Data type: uint32
Access type: Read-only
Qualifiers: CookingType ("PERF_COUNTER_RAWCOUNT") , Counter ("SentAddressMaskReply") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Number of ICMP address mask reply messages sent.

SentDestinationUnreachable
Data type: uint32
Access type: Read-only
Qualifiers: CookingType ("PERF_COUNTER_RAWCOUNT") , Counter ("SentDestinationUnreachable") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Number of ICMP destination unreachable messages sent.

SentEchoPerSec
Data type: uint32
Access type: Read-only
Qualifiers: CookingType ("PERF_COUNTER_COUNTER") , Counter ("SentEchoPerSec") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Rate of ICMP echo messages sent.

SentEchoReplyPerSec
Data type: uint32
Access type: Read-only
Qualifiers: CookingType ("PERF_COUNTER_RAWCOUNT") , Counter ("SentEchoReplyPerSec") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Rate of ICMP echo reply messages sent.

SentParameterProblem
Data type: uint32
Access type: Read-only
Qualifiers: CookingType ("PERF_COUNTER_RAWCOUNT") , Counter ("SentParameterProblem") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Number of ICMP parameter problem messages sent.

SentRedirectPerSec
Data type: uint32
Access type: Read-only
Qualifiers: CookingType ("PERF_COUNTER_COUNTER") , Counter ("SentRedirectPerSec") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime"))

Rate of ICMP redirect messages sent.

SentSourceQuench
Data type: uint32
Access type: Read-only
Qualifiers: CookingType ("PERF_COUNTER_RAWCOUNT") , Counter ("SentSourceQuench") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Number of ICMP source quench messages sent.

SentTimeExceeded
Data type: uint32
Access type: Read-only
Qualifiers: CookingType ("PERF_COUNTER_RAWCOUNT") , Counter ("SentTimeExceeded") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Number of ICMP time exceeded messages sent.

SentTimestampPerSec
Data type: uint32
Access type: Read-only
Qualifiers: CookingType ("PERF_COUNTER_COUNTER") , Counter ("SentTimestampPerSec") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Rate of ICMP timestamp (request) messages sent.

SentTimestampReplyPerSec
Data type: uint32
Access type: Read-only
Qualifiers: CookingType ("PERF_COUNTER_COUNTER") , Counter ("SentTimestampReplyPerSec") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Rate of ICMP timestamp reply messages 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

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

Performance Counter Classes
Accessing WMI Preinstalled Performance Classes
WMI Tasks: Performance Monitoring
Accessing Performance Data in Script

 

 

Show: