Network adapter statistics
The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.
Syntax
[Dynamic, Provider("NetAdapterCim")]
class MSFT_NetAdapterStatisticsSettingData : MSFT_NetAdapterSettingData
{
string Caption;
string Description;
string ElementName;
string InstanceID;
string Name;
string InterfaceDescription;
uint32 Source;
string SystemName;
uint32 SupportedStatistics;
uint64 ReceivedBytes;
uint64 ReceivedUnicastPackets;
uint64 ReceivedMulticastPackets;
uint64 ReceivedBroadcastPackets;
uint64 ReceivedUnicastBytes;
uint64 ReceivedMulticastBytes;
uint64 ReceivedBroadcastBytes;
uint64 ReceivedDiscardedPackets;
uint64 ReceivedPacketErrors;
uint64 SentBytes;
uint64 SentUnicastPackets;
uint64 SentMulticastPackets;
uint64 SentBroadcastPackets;
uint64 SentUnicastBytes;
uint64 SentMulticastBytes;
uint64 SentBroadcastBytes;
uint64 OutboundDiscardedPackets;
uint64 OutboundPacketErrors;
string RdmaStatistics;
string RscStatistics;
};
Members
The MSFT_NetAdapterStatisticsSettingData class has these types of members:
Properties
The MSFT_NetAdapterStatisticsSettingData class has these properties.
Caption
Data type: string
Access type: Read-only
Qualifiers: MaxLen ( 64 )
A short textual description of the object. This property inherits from CIM_ManagedElement.
Description
Data type: string
Access type: Read-only
A textual description of the object. This property inherits from CIM_ManagedElement.
ElementName
Data type: string
Access type: Read-only
A user-friendly name for the object. This property enables each instance to define a display name in addition to its key properties, identity data, and description information. Be aware that the Name property of ManagedSystemElement is also defined as a display name. However, it is often subclassed to be a Key. The same property can convey both identity and a user-friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information can be present in both the Name and ElementName properties. This property inherits from CIM_ManagedElement.
InstanceID
Data type: string
Access type: Read-only
Qualifiers: Key
Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. To ensure uniqueness within the NameSpace, the value of InstanceID should be constructed using the following "preferred" algorithm: OrgID:LocalID Where OrgID and LocalID are separated by a colon (:), and where OrgID must include a copyrighted, trademarked, or otherwise unique name that is owned by the business entity that is creating or defining the InstanceID or that is a registered ID assigned to the business entity by a recognized global authority. (This requirement is similar to the SchemaName_ClassName structure of Schema class names.) In addition, to ensure uniqueness, OrgID must not contain a colon (:). When using this algorithm, the first colon to appear in InstanceID must appear between OrgID and LocalID. LocalID is chosen by the business entity and should not be reused to identify different underlying (real-world) elements. If the above preferred algorithm is not used, the defining entity must assure that the resulting InstanceID is not reused across any InstanceIDs produced by this or other providers for the NameSpace of this instance. For DMTF-defined instances, the "preferred" algorithm must be used with the OrgID set to CIM.
This property inherits from CIM_SettingData.
InterfaceDescription
Data type: string
Access type: Read-only
Interface Description, also known as "ifDesc" or display name is a unique name assigned to the network adapter during installation. This name cannot be changed and is persisted as long as the network adapter is not uninstalled. This property inherits from MSFT_NetAdapterSettingData.
Name
Data type: string
Access type: Read-only
Name, also known as Connection Name, "ifAlias", or InterfaceAlias, is a unique name assigned to the adapter during installation. The Name of the adapter can be changed by the administrator and is persisted across the boot or network adapter restart. This property inherits from MSFT_NetAdapterSettingData.
OutboundDiscardedPackets
Data type: uint64
Access type: Read-only
The number of outgoing packets that were discarded even though they did not have errors.
OutboundPacketErrors
Data type: uint64
Access type: Read-only
The number of outgoing packets that were discarded because of errors.
RdmaStatistics
Data type: string
Access type: Read-only
RDMA statistics
ReceivedBroadcastBytes
Data type: uint64
Access type: Read-only
The number of broadcast bytes received without errors through this interface.
ReceivedBroadcastPackets
Data type: uint64
Access type: Read-only
The number of broadcast packets received without errors through this interface.
ReceivedBytes
Data type: uint64
Access type: Read-only
The number of bytes of data received without errors through this interface. This value includes bytes in unicast, broadcast, and multicast packets.
ReceivedDiscardedPackets
Data type: uint64
Access type: Read-only
The number of inbound packets which were chosen to be discarded even though no errors were detected to prevent the packets from being deliverable to a higher-layer protocol.
ReceivedMulticastBytes
Data type: uint64
Access type: Read-only
The number of multicast bytes received without errors through this interface.
ReceivedMulticastPackets
Data type: uint64
Access type: Read-only
The number of multicast packets received without errors through this interface.
ReceivedPacketErrors
Data type: uint64
Access type: Read-only
The number of incoming packets that were discarded because of errors.
ReceivedUnicastBytes
Data type: uint64
Access type: Read-only
The number of unicast bytes received without errors through this interface.
ReceivedUnicastPackets
Data type: uint64
Access type: Read-only
The number of unicast packets received without errors through this interface.
RscStatistics
Data type: string
Access type: Read-only
RSC statistics
SentBroadcastBytes
Data type: uint64
Access type: Read-only
The number of broadcast bytes transmitted without errors through this interface.
SentBroadcastPackets
Data type: uint64
Access type: Read-only
The number of broadcast packets transmitted without errors through this interface.
SentBytes
Data type: uint64
Access type: Read-only
The number of bytes of data transmitted without errors through this interface. This value includes bytes in unicast, broadcast, and multicast packets.
SentMulticastBytes
Data type: uint64
Access type: Read-only
The number of multicast bytes transmitted without errors through this interface.
SentMulticastPackets
Data type: uint64
Access type: Read-only
The number of multicast packets transmitted without errors through this interface.
SentUnicastBytes
Data type: uint64
Access type: Read-only
The number of unicast bytes transmitted without errors through this interface.
SentUnicastPackets
Data type: uint64
Access type: Read-only
The number of unicast packets transmitted without errors through this interface.
Source
Data type: uint32
Access type: Read-only
The source of the setting data. This property inherits from MSFT_NetAdapterSettingData.
Unknown (0)
Other (1)
Device (2)
Persistent storage (3)
SupportedStatistics
Data type: uint32
Access type: Read-only
The supported statistics
SystemName
Data type: string
Access type: Read-only
The scoping System\'s Name. This property inherits from MSFT_NetAdapterSettingData.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | None supported |
| Minimum supported server | Windows Server 2012 |
| Namespace | Root\StandardCimv2 |
| MOF | NetAdapterCim.mof |
| DLL | NetAdapterCim.dll |
Source: Microsoft Learn / Windows Win32 documentation by Microsoft and contributors (upstream author metadata: windowssdkdev). Documentation licensed CC BY 4.0. Code samples are covered by the MIT License. Converted from Markdown, with links normalized and embedded media omitted.
