MSFT_MTNetworkAdapter class

[Some information relates to pre-released product which may be substantially modified before it's commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.]

The Network adapter data object. Statistic data is calculated based on current interval seconds setting.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.

Syntax

[UMLPackagePath("CIM::Core::CoreElements"), dynamic, provider("mttmprov"), AMENDMENT]
class MSFT_MTNetworkAdapter : CIM_ManagedElement
{
  string InstanceID;
  string Caption;
  string Description;
  string ElementName;
  string Name;
  string InterfaceDescription;
  string IPv4Address;
  string IPv6Address;
  string DNSName;
  string MachineJoinedName;
  uint16 MachineJoinedType;
  uint32 NdisMedium;
  uint32 NdisPhysicalMedium;
  uint16 OperationStatus;
  real32 Utilization;
  uint64 LinkSpeed;
  string InterfaceGuid;
  uint64 BytesSent;
  uint64 BytesReceived;
  uint64 BytesTotal;
  uint64 UniCastsSent;
  uint64 UniCastsReceived;
  uint64 UniCastsTotal;
  uint64 NonUniCastsSent;
  uint64 NonUniCastsReceived;
  uint64 NonUniCastsTotal;
  uint16 IntervalSeconds;
  uint16 CurrentIndex;
  real32 SentThroughput[];
  real32 ReceivedThroughput[];
  real32 SentBitsPerSecond[];
  real32 ReceivedBitsPerSecond[];
  real32 MaxSentBitsPerSecond[];
  real32 MaxReceivedBitsPerSecond[];
  real32 BytesSentThroughput;
  real32 BytesReceivedThroughput;
  real32 BytesTotalThroughput;
  uint64 BytesSentPerInterval;
  uint64 BytesReceivedPerInterval;
  uint64 BytesTotalPerInterval;
  uint64 UniCastsSentPerInterval;
  uint64 UniCastsReceivedPerInterval;
  uint64 UniCastsTotalPerInterval;
  uint64 NonUniCastsSentPerInterval;
  uint64 NonUniCastsReceivedPerInterval;
  uint64 NonUniCastsTotalPerInterval;
};

Members

The MSFT_MTNetworkAdapter class has these types of members:

Properties

The MSFT_MTNetworkAdapter class has these properties.

BytesReceived
Data type: uint64
Access type: Read-only

Gets the total number of bytes received on the connection to date.

BytesReceivedPerInterval
Data type: uint64
Access type: Read-only

Gets the total number of bytes received on the connection in the polling time interval.

BytesReceivedThroughput
Data type: real32
Access type: Read-only

Gets the percentage of connection bandwidth used by traffic received by the machine in the polling time period.

BytesSent
Data type: uint64
Access type: Read-only

Gets the total number of bytes sent on the connection to date.

BytesSentPerInterval
Data type: uint64
Access type: Read-only

Gets the total number of bytes sent on the connection in the polling time interval.

BytesSentThroughput
Data type: real32
Access type: Read-only

Gets the percentage of connection bandwidth used by traffic sent from the machine in the polling time period.

BytesTotal
Data type: uint64
Access type: Read-only

Gets the total number of bytes sent and received on the connection to date.

BytesTotalPerInterval
Data type: uint64
Access type: Read-only

Gets the total number of bytes received and sent on the connection in the polling time interval.

BytesTotalThroughput
Data type: real32
Access type: Read-only

Gets the percentage of connection bandwidth used by both sent and received traffic in the polling time period.

Caption
Data type: string
Access type: Read-only
Qualifiers: MaxLen (64)

The Caption property is a short textual description (one- line string) of the object.

This property is inherited from CIM_ManagedElement.

CurrentIndex
Data type: uint16
Access type: Read-only

Gets the current data sample index. Increment at every data sample.

Description
Data type: string
Access type: Read-only

The Description property provides a textual description of the object.

This property is inherited from CIM_ManagedElement.

DNSName
Data type: string
Access type: Read-only

Gets the domain name of the computer system joined on the network.

ElementName
Data type: string
Access type: Read-only

Gets a user-friendly name for the object. This property allows each instance to define a user-friendly name in addition to its key properties, identity data, and description information. Note that the Name property of CIM_ManagedSystemElement is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that 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 CIM_LogicalDevice), the same information can be present in both the Name and ElementName properties. Note that if there is an associated instance of CIM_EnabledLogicalElementCapabilities, restrictions on this properties may exist as defined in ElementNameMask and MaxElementNameLen properties defined in that class.

This property is inherited from CIM_ManagedElement.

InstanceID
Data type: string
Access type: Read-only

InstanceID is an optional property that may be used to opaquely and uniquely identify an instance of this class within the scope of the instantiating Namespace. Various subclasses of this class may override this property to make it required, or a key. Such subclasses may also modify the preferred algorithms for ensuring uniqueness that are defined below. 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 <Schema Name>_<Class Name> 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 not null and 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. If not set to null for DMTF-defined instances, the "preferred" algorithm must be used with the OrgID set to "CIM".

This property is inherited from CIM_ManagedElement.

InterfaceDescription
Data type: string
Access type: Read-only

Gets the name of the network adapter device.

InterfaceGuid
Data type: string
Access type: Read-only

Gets the GUID of the network adapter.

IntervalSeconds
Data type: uint16
Access type: Read-only

Gets the current data collection interval in seconds.

IPv4Address
Data type: string
Access type: Read-only

Gets the IPv4 network address configured on the network adapter.

IPv6Address
Data type: string
Access type: Read-only

Gets the IPv6 network address configured on the network adapter.

LinkSpeed
Data type: uint64
Access type: Read-only

Gets the total link speed of the network adapter, in bits per second.

MachineJoinedName
Data type: string
Access type: Read-only

Gets the machine joined domain or workgroup name of the computer system.

MachineJoinedType
Data type: uint16
Access type: Read-only

Gets the machine joined type on the network.

Unknown (0)

Unjoined (1)

Workgroup (2)

Domain (3)

VerifiedError (4)

NotVerified (5)

MaxReceivedBitsPerSecond
Data type: real32 array
Access type: Read-only

Gets a list of the maximum received bits per second at each interval. The statistics are logged with the latest 60 samples, with each interval defined in IntervalSeconds (second).

MaxSentBitsPerSecond
Data type: real32 array
Access type: Read-only

Gets a list of maximum sent bits per second at each interval. The statistics are logged with the latest 60 samples, with each interval defined in IntervalSeconds (second).

Name
Data type: string
Access type: Read-only
Qualifiers: key

Gets the name of connection on the network adapter device.

NdisMedium
Data type: uint32
Access type: Read-only

Gets the network adapter media type.

802.3 (0)

802.5 (1)

FDDI (2)

WAN (3)

Local Talk (4)

DIX (5)

Raw Arcnet (6)

878.2 (7)

ATM (8)

Wireless WAN (9)

IRDA (10)

BPC (11)

Connection Oriented WAN (12)

IP 1394 (13)

IB (14)

Tunnel (15)

Native 802.11 (16)

Loopback (17)

WiMAX (18)

IP (19)

NdisPhysicalMedium
Data type: uint32
Access type: Read-only

Gets the types of physical media that the network adapter supports.

Unspecified (0)

Wireless LAN (1)

Cable Modem (2)

Phone Line (3)

Power Line (4)

DSL (5)

FC (6)

1394 (7)

Wireless WAN (8)

Native 802.11 (9)

BlueTooth (10)

Infiniband (11)

WiMAX (12)

UWB (13)

802.3 (14)

802.5 (15)

IRDA (16)

Wired WAN (17)

Wired Connection Oriented WAN (18)

Other (19)

NonUniCastsReceived
Data type: uint64
Access type: Read-only

Gets the total number of bytes from nonsubnet-unicast addresses delivered to higher-level protocols by on the connection to date.

NonUniCastsReceivedPerInterval
Data type: uint64
Access type: Read-only

Gets the total number of bytes from nonsubnet-unicast addresses delivered to higher-level protocols on the connection in the polling time interval.

NonUniCastsSent
Data type: uint64
Access type: Read-only

Gets the total number of bytes requested to be transmitted to nonsubnet-unicast addresses by higher-level protocols on the connection to date.

NonUniCastsSentPerInterval
Data type: uint64
Access type: Read-only

Gets the total number of bytes requested to be transmitted to nonsubnet-unicast addresses by higher-level protocols on the connection in the polling time interval.

NonUniCastsTotal
Data type: uint64
Access type: Read-only

Gets the total number of nonunicast Sent and nonunicast Received packets to date.

NonUniCastsTotalPerInterval
Data type: uint64
Access type: Read-only

Gets the total number of nonunicast Sent and nonunicast Received packets in the polling time interval.

OperationStatus
Data type: uint16
Access type: Read-only

Gets the operational status of the network adapter.

Up (1)

Down (2)

Testing (3)

Unknown (4)

Dormant (5)

Not Present (6)

Lower Layer Down (7)

ReceivedBitsPerSecond
Data type: real32 array
Access type: Read-only

Gets a list of received bits per second at each interval. The statistics are logged with the latest 60 samples, with each interval defined in IntervalSeconds (second).

ReceivedThroughput
Data type: real32 array
Access type: Read-only

Gets a list of percentages of received throughput at each interval. The statistics are logged with the latest 60 samples, with each interval defined in IntervalSeconds (second).

SentBitsPerSecond
Data type: real32 array
Access type: Read-only

Gets a list of sent bits per second at each interval. The statistics are logged with the latest 60 samples, with each interval defined in IntervalSeconds (second).

SentThroughput
Data type: real32 array
Access type: Read-only

Gets a list of the percentages of sent throughput at each interval. The statistics are logged with the latest 60 samples, with each interval defined in IntervalSeconds (second).

UniCastsReceived
Data type: uint64
Access type: Read-only

Gets the total number of bytes received from unicast addresses by higher-level protocols.

UniCastsReceivedPerInterval
Data type: uint64
Access type: Read-only

Gets the total number of bytes from subnet-unicast addresses delivered to higher-level protocols on the connection in the polling time interval.

UniCastsSent
Data type: uint64
Access type: Read-only

Gets the total number of bytes requested to be transmitted to unicast addresses by higher-level protocols. The value includes the packets that were discarded or not sent.

UniCastsSentPerInterval
Data type: uint64
Access type: Read-only

Gets the total number of bytes requested to be transmitted to subnet-unicast addresses by higher-level protocols on the connection in the polling time interval.

UniCastsTotal
Data type: uint64
Access type: Read-only

Gets the total number of Unicast Sent and Unicast Received packets to date.

UniCastsTotalPerInterval
Data type: uint64
Access type: Read-only

Gets the total number of Unicast Sent and Unicast Received packets for the connection in the polling time interval.

Utilization
Data type: real32
Access type: Read-only

Gets the percentage of network utilization at the latest interval.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2016 Technical Preview

Namespace

Root\Microsoft\Windows\ManagementTools

MOF

MtTmProv.mof

DLL

MtTmProv.dll

See also

CIM_ManagedElement
Management Tools Task Manager WMI Provider

 

 

Show: