Win32_PerfFormattedData_RemoteAccess_RASTotal class

  • Article

The Win32_PerfFormattedData_RemoteAccess_RASTotal formatted data class provides pre-calculated data from performance counters that monitor combined values for all ports of the Remote Access service (RAS) device on the computer.

This class represents the RAS Total object in System Monitor and returns the same data found in System Monitor. This class derives its raw data from the corresponding raw class Win32_PerfRawData_RemoteAccess_RASTotal. The original data source is the RemoteAccess 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_RemoteAccess_RASTotal : Win32_PerfFormattedData
{
  uint32 AlignmentErrors;
  uint32 BufferOverrunErrors;
  uint32 BytesReceived;
  uint32 BytesReceivedPerSec;
  uint32 BytesTransmitted;
  uint32 BytesTransmittedPerSec;
  string Caption;
  uint32 CRCErrors;
  string Description;
  uint32 FramesReceived;
  uint32 FramesReceivedPerSec;
  uint32 FramesTransmitted;
  uint32 FramesTransmittedPerSec;
  uint64 Frequency_Object;
  uint64 Frequency_PerfTime;
  uint64 Frequency_Sys100NS;
  string Name;
  uint32 PercentCompressionIn;
  uint32 PercentCompressionOut;
  uint32 SerialOverrunErrors;
  uint32 TimeoutErrors;
  uint64 Timestamp_Object;
  uint64 Timestamp_PerfTime;
  uint64 Timestamp_Sys100NS;
  uint32 TotalConnections;
  uint32 TotalErrors;
  uint32 TotalErrorsPerSec;
};

Members

The Win32_PerfFormattedData_RemoteAccess_RASTotal class has these types of members:

  • Properties

Properties

The Win32_PerfFormattedData_RemoteAccess_RASTotal class has these properties.

AlignmentErrors

Data type: uint32

Access type: Read-only

Qualifiers: CookingType ("PERF_COUNTER_RAWCOUNT") , Counter ("AlignmentErrors") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Total number of alignment errors for all RAS connections. Alignment errors occur when a byte received is different from the byte expected.

BufferOverrunErrors

Data type: uint32

Access type: Read-only

Qualifiers: CookingType ("PERF_COUNTER_RAWCOUNT") , Counter ("BufferOverrunErrors") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Total number of buffer overrun errors for all RAS connections. Buffer overrun errors occur when the software cannot handle the rate at which data is received.

BytesReceived

Data type: uint32

Access type: Read-only

Qualifiers: CookingType ("PERF_COUNTER_RAWCOUNT") , Counter ("BytesReceived") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Total number of bytes received for all RAS connections.

BytesReceivedPerSec

Data type: uint32

Access type: Read-only

Qualifiers: CookingType ("PERF_COUNTER_RAWCOUNT") , Counter ("BytesReceivedPerSec") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Number of bytes received per second for all RAS connections.

BytesTransmitted

Data type: uint32

Access type: Read-only

Qualifiers: CookingType ("PERF_COUNTER_RAWCOUNT") , Counter ("BytesTransmitted") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Total number of bytes transmitted for all RAS connections.

BytesTransmittedPerSec

Data type: uint32

Access type: Read-only

Qualifiers: CookingType ("PERF_COUNTER_RAWCOUNT") , Counter ("BytesTransmittedPerSec") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Number of bytes transmitted per second for all RAS connections.

Caption

Data type: string

Access type: Read-only

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

CRCErrors

Data type: uint32

Access type: Read-only

Qualifiers: CookingType ("PERF_COUNTER_RAWCOUNT") , Counter ("CRCErrors") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Total number of CRC errors for this connection. CRC errors occur when the frame received contains erroneous data.

Description

Data type: string

Access type: Read-only

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

FramesReceived

Data type: uint32

Access type: Read-only

Qualifiers: CookingType ("PERF_COUNTER_RAWCOUNT") , Counter ("FramesReceived") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Total number of data frames received for all RAS connections.

FramesReceivedPerSec

Data type: uint32

Access type: Read-only

Qualifiers: CookingType ("PERF_COUNTER_RAWCOUNT") , Counter ("FramesReceivedPerSec") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Number of frames received per second for all RAS connections.

FramesTransmitted

Data type: uint32

Access type: Read-only

Qualifiers: CookingType ("PERF_COUNTER_RAWCOUNT") , Counter ("FramesTransmitted") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Total number of data frames transmitted for all RAS connections.

FramesTransmittedPerSec

Data type: uint32

Access type: Read-only

Qualifiers: CookingType ("PERF_COUNTER_RAWCOUNT") , Counter ("FramesTransmittedPerSec") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Number of frames transmitted per second for all RAS connections.

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

Qualifiers: Key, MaxLen (256)

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.

PercentCompressionIn

Data type: uint32

Access type: Read-only

Qualifiers: CookingType ("PERF_COUNTER_RAWCOUNT") , Counter ("PercentCompressionIn") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Compression ratio for bytes being received.

PercentCompressionOut

Data type: uint32

Access type: Read-only

Qualifiers: CookingType ("PERF_COUNTER_RAWCOUNT") , Counter ("PercentCompressionOut") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Compression ratio for bytes being transmitted.

SerialOverrunErrors

Data type: uint32

Access type: Read-only

Qualifiers: CookingType ("PERF_COUNTER_RAWCOUNT") , Counter ("SerialOverrunErrors") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Total number of serial overrun errors for this connection. Serial overrun errors occur when the hardware cannot handle the rate at which data is received.

TimeoutErrors

Data type: uint32

Access type: Read-only

Qualifiers: CookingType ("PERF_COUNTER_RAWCOUNT") , Counter ("TimeoutErrors") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Total number of time-out errors for this connection. Time-out errors occur when an expected packet is not received in time.

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.

TotalConnections

Data type: uint32

Access type: Read-only

Qualifiers: CookingType ("PERF_COUNTER_RAWCOUNT") , Counter ("TotalConnections") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Total number of RAS connections.

TotalErrors

Data type: uint32

Access type: Read-only

Qualifiers: CookingType ("PERF_COUNTER_RAWCOUNT") , Counter ("TotalErrors") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Total number of CRC, time-out, serial overrun, alignment, and buffer overrun errors for all RAS connections.

TotalErrorsPerSec

Data type: uint32

Access type: Read-only

Qualifiers: CookingType ("PERF_COUNTER_RAWCOUNT") , Counter ("TotalErrorsPerSec") , PerfTimeStamp ("Timestamp_PerfTime") , PerfTimeFreq ("Frequency_PerfTime")

Total number of CRC, time-out, serial overrun, alignment, and buffer overrun errors per second for all RAS connections.

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