Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

MSFT_NetAdapter class

A logical network adapters

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

Syntax

[Dynamic, Provider("NetAdapterCim")]class MSFT_NetAdapter : CIM_NetworkPort
{
  string   Caption;
  string   Description;
  datetime InstallDate;
  string   Name;
  string   Status;
  uint16   Availability;
  uint32   ConfigManagerErrorCode;
  boolean  ConfigManagerUserConfig;
  string   CreationClassName;
  string   DeviceID;
  boolean  ErrorCleared;
  string   ErrorDescription;
  uint32   LastErrorCode;
  string   PNPDeviceID;
  uint16   PowerManagementCapabilities[];
  boolean  PowerManagementSupported;
  uint16   StatusInfo;
  string   SystemCreationClassName;
  string   SystemName;
  uint64   Speed;
  uint64   MaxSpeed;
  uint64   RequestedSpeed;
  uint16   UsageRestriction;
  uint16   PortType;
  string   OtherPortType;
  string   OtherNetworkPortType;
  uint16   PortNumber;
  uint16   LinkTechnology;
  string   OtherLinkTechnology;
  string   PermanentAddress;
  string   NetworkAddresses[];
  boolean  FullDuplex;
  boolean  AutoSense;
  uint64   SupportedMaximumTransmissionUnit;
  uint64   ActiveMaximumTransmissionUnit;
  string   InterfaceDescription;
  string   InterfaceName;
  uint64   NetLuid;
  string   InterfaceGuid;
  uint32   InterfaceIndex;
  string   DeviceName;
  uint32   NetLuidIndex;
  boolean  Virtual;
  boolean  Hidden;
  boolean  NotUserRemovable;
  boolean  IMFilter;
  uint32   InterfaceType;
  boolean  HardwareInterface;
  boolean  WdmInterface;
  boolean  EndPointInterface;
  boolean  iSCSIInterface;
  uint32   State;
  uint32   NdisMedium;
  uint32   NdisPhysicalMedium;
  uint32   InterfaceOperationalStatus;
  boolean  OperationalStatusDownDefaultPortNotAuthenticated;
  boolean  OperationalStatusDownMediaDisconnected;
  boolean  OperationalStatusDownInterfacePaused;
  boolean  OperationalStatusDownLowPowerState;
  uint32   InterfaceAdminStatus;
  uint32   MediaConnectState;
  uint32   MtuSize;
  uint16   VlanID;
  uint64   TransmitLinkSpeed;
  uint64   ReceiveLinkSpeed;
  boolean  PromiscuousMode;
  boolean  DeviceWakeUpEnable;
  boolean  ConnectorPresent;
  uint32   MediaDuplexState;
  string   DriverDate;
  uint64   DriverDateData;
  string   DriverVersionString;
  string   DriverName;
  string   DriverDescription;
  uint16   MajorDriverVersion;
  uint16   MinorDriverVersion;
  uint8    DriverMajorNdisVersion;
  uint8    DriverMinorNdisVersion;
  string   PnPDeviceID;
  string   DriverProvider;
  string   ComponentID;
  uint32   LowerLayerInterfaceIndices[];
  uint32   HigherLayerInterfaceIndices[];
  boolean  AdminLocked;
};

Members

The MSFT_NetAdapter class has these types of members:

Methods

The MSFT_NetAdapter class has these methods.

MethodDescription
Disable

Disables a network adapter.

Enable

Enables a network adapter.

Lock

Locks a network adapter.

Rename

Renames a network adapter.

Restart

Restarts a network adapter.

Unlock

Unlocks a network adapter.

 

Properties

The MSFT_NetAdapter class has these properties.

ActiveMaximumTransmissionUnit
Data type: uint64
Access type: Read-only
Qualifiers: Units ( "Bytes" )

The active or negotiated maximum transmission unit (MTU) that can be supported. This property inherits from CIM_NetworkPort.

AdminLocked
Data type: boolean
Access type: Read-only

The management state of the network adapter. If True, the network adapter is locked and many of its properties cannot be changed unless the adapter is unlocked.

AutoSense
Data type: boolean
Access type: Read-only

A Boolean that indicates whether the network port is capable of automatically determining the speed or other communications characteristics of the attached network media. This property inherits from CIM_NetworkPort.

Availability
Data type: uint16
Access type: Read-only

Availability and status of the device. This property inherits from CIM_LogicalDevice.

ValueMeaning
Other
1 (0x1)
Unknown
2 (0x2)
Running/Full Power
3 (0x3)
Warning
4 (0x4)
In Test
5 (0x5)
Not Applicable
6 (0x6)
Power Off
7 (0x7)
Off Line
8 (0x8)
Off Duty
9 (0x9)
Degraded
10 (0xA)
Not Installed
11 (0xB)
Install Error
12 (0xC)
Power Save - Unknown
13 (0xD)

The device is known to be in a power save mode, but its exact status is unknown.

Power Save - Low Power Mode
14 (0xE)

The device is in a power save state but still functioning, and may exhibit degraded performance.

Power Save - Standby
15 (0xF)

The device is not functioning but could be brought to full power quickly.

Power Cycle
16 (0x10)
Power Save - Warning
17 (0x11)

The device is in a warning state, though also in a power save mode.

 

Caption
Data type: string
Access type: Read-only

Short textual description of the object. This property is inherited from CIM_ManagedElement.

ComponentID
Data type: string
Access type: Read-only

The PnP component ID, also known as the Hardware ID of the network adapter.

ConfigManagerErrorCode
Data type: uint32
Access type: Read-only

Win32 Configuration Manager error code. This property inherits from CIM_LogicalDevice.

ValueMeaning
0 (0x0)

Device is working properly.

1 (0x1)

Device is not configured correctly.

2 (0x2)

Windows cannot load the driver for this device.

3 (0x3)

Driver for this device might be corrupted, or the system may be low on memory or other resources.

4 (0x4)

Device is not working properly. One of its drivers or the registry might be corrupted.

5 (0x5)

Driver for the device requires a resource that Windows cannot manage.

6 (0x6)

Boot configuration for the device conflicts with other devices.

7 (0x7)

Cannot filter.

8 (0x8)

Driver loader for the device is missing.

9 (0x9)

Device is not working properly; the controlling firmware is incorrectly reporting the resources for the device.

10 (0xA)

Device cannot start.

11 (0xB)

Device failed.

12 (0xC)

Device cannot find enough free resources to use.

13 (0xD)

Windows cannot verify the device's resources.

14 (0xE)

Device cannot work properly until the computer is restarted.

15 (0xF)

Device is not working properly due to a possible re-enumeration problem.

16 (0x10)

Windows cannot identify all of the resources that the device uses.

17 (0x11)

Device is requesting an unknown resource type.

18 (0x12)

Device drivers must be reinstalled.

19 (0x13)

Failure using the VxD loader.

20 (0x14)

Registry might be corrupted.

21 (0x15)

System failure. If changing the device driver is ineffective, see the hardware documentation. Windows is removing the device.

22 (0x16)

Device is disabled.

23 (0x17)

System failure. If changing the device driver is ineffective, see the hardware documentation.

24 (0x18)

Device is not present, not working properly, or does not have all of its drivers installed.

25 (0x19)

Windows is still setting up the device.

26 (0x1A)

Windows is still setting up the device.

27 (0x1B)

Device does not have valid log configuration.

28 (0x1C)

Device drivers are not installed.

29 (0x1D)

Device is disabled; the device firmware did not provide the required resources.

30 (0x1E)

Device is using an IRQ resource that another device is using.

31 (0x1F)

Device is not working properly; Windows cannot load the required device drivers.

 

ConfigManagerUserConfig
Data type: boolean
Access type: Read-only

If TRUE, the device is using a user-defined configuration. This property inherits from CIM_LogicalDevice.

ConnectorPresent
Data type: boolean
Access type: Read-only

Indicates if a connector is present on the network adapter. This value is set to TRUE if this is a physical adapter or FALSE if this is not a physical adapter.

CreationClassName
Data type: string
Access type: Read-only

Name of the class or subclass used in the creation of an instance. When used with other key properties of the class, this property allows all instances of the class and its subclasses to be uniquely identified. This property inherits from CIM_LogicalDevice.

Description
Data type: string
Access type: Read-only

Textual description of the object. This property is inherited from CIM_ManagedElement.

DeviceID
Data type: string
Access type: Read-only

Address or other identifying information to uniquely name the logical device. This property inherits from CIM_LogicalDevice.

DeviceName
Data type: string
Access type: Read-only

The name of the device object for this adapter.

DeviceWakeUpEnable
Data type: boolean
Access type: Read-only

TRUE if the network adapter supports wake-on-LAN capability and the capability is enabled, or FALSE if it does not.

DriverDate
Data type: string
Access type: Read-only

The network adapter driver date in YYYY-MM-DD format.

DriverDateData
Data type: uint64
Access type: Read-only

The network adapter driver date in FILETIME format. This is a 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC).

DriverDescription
Data type: string
Access type: Read-only

The description for the network adapter driver.

DriverMajorNdisVersion
Data type: uint8
Access type: Read-only

The major NDIS version the network adapter driver conforms to.

DriverMinorNdisVersion
Data type: uint8
Access type: Read-only

The minor NDIS version the network adapter driver conforms to.

DriverName
Data type: string
Access type: Read-only

The name of the network adapter driver.

DriverProvider
Data type: string
Access type: Read-only

The driver provider name.

DriverVersionString
Data type: string
Access type: Read-only

A string representing the network adapter driver version.

EndPointInterface
Data type: boolean
Access type: Read-only

This interface is an endpoint device and is not a true network interface that connects to a network.

ErrorCleared
Data type: boolean
Access type: Read-only

If TRUE, the error reported in the LastErrorCode property is now cleared. This property inherits from CIM_LogicalDevice.

ErrorDescription
Data type: string
Access type: Read-only

Free-form string that supplies information about the error recorded in the LastErrorCode property and corrective actions to perform. This property inherits from CIM_LogicalDevice.

FullDuplex
Data type: boolean
Access type: Read-only

Boolean that indicates that the port is operating in full duplex mode. This property inherits from CIM_NetworkPort.

HardwareInterface
Data type: boolean
Access type: Read-only

The interface for the network adapter is provided by a hardware device.

Hidden
Data type: boolean
Access type: Read-only

Network adapter is hidden and does not appear in any user interface.

HigherLayerInterfaceIndices
Data type: uint32 array
Access type: Read-only

The interface indices of higher layer interfaces.

IMFilter
Data type: boolean
Access type: Read-only

Network adapter is the adapter edge of an intermediate filter component.

InstallDate
Data type: datetime
Access type: Read-only

Date and time the object was installed. This property does not need a value to indicate that the object is installed. This property is inherited from CIM_ManagedSystemElement.

InterfaceAdminStatus
Data type: uint32
Access type: Read-only

Network adapter administrative status, as described in RFC 2863.

Up (1)
Down (2)
Testing (3)
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.

InterfaceGuid
Data type: string
Access type: Read-only

The GUID for the network interface.

InterfaceIndex
Data type: uint32
Access type: Read-only

The index that identifies the network interface. This index value may change when a network adapter is disabled and then enabled, and should not be considered persistent.

InterfaceName
Data type: string
Access type: Read-only

The locally unique identifier for the network interface. in InterfaceType_NetluidIndex format. Ex: Ethernet_2.

InterfaceOperationalStatus
Data type: uint32
Access type: Read-only

Current network interface operational status.

Up (1)
Down (2)
Testing (3)
Unknown (4)
Dormant (5)
Not Present (6)
Lower layer down (7)
InterfaceType
Data type: uint32
Access type: Read-only

The interface type as defined by the Internet Assigned Names Authority (IANA).

iSCSIInterface
Data type: boolean
Access type: Read-only

The interface is used by iSCSI software initiator and is in the paging path.

LastErrorCode
Data type: uint32
Access type: Read-only

Last error code reported by the logical device. This property inherits from CIM_LogicalDevice.

LinkTechnology
Data type: uint16
Access type: Read-only

An enumeration of the types of links. When set to 1 ("Other"), the related property OtherLinkTechnology contains a string description of the type of link. This property inherits from CIM_NetworkPort.

Unknown (0)
Other (1)
Ethernet (2)
IB (3)
FC (4)
FDDI (5)
ATM (6)
Token Ring (7)
Frame Relay (8)
Infrared (9)
BlueTooth (10)
Wireless LAN (11)
LowerLayerInterfaceIndices
Data type: uint32 array
Access type: Read-only

The interface indices of lower layer interfaces.

MajorDriverVersion
Data type: uint16
Access type: Read-only

The major version of network adapter driver.

MaxSpeed
Data type: uint64
Access type: Read-only
Qualifiers: Units ( "Bits per Second" )

The maximum bandwidth, in bits per second, of the port. This property inherits from CIM_LogicalPort.

MediaConnectState
Data type: uint32
Access type: Read-only

Specifies the network adapter connection state.

Unknown (0)
Connected (1)
Disconnected (2)
MediaDuplexState
Data type: uint32
Access type: Read-only

The media duplex state of the network adapter.

MinorDriverVersion
Data type: uint16
Access type: Read-only

The minor version of network adapter driver.

MtuSize
Data type: uint32
Access type: Read-only

The maximum transfer unit (MTU) size the network adapter supports. This value does not include the size of the link-layer header.

Name
Data type: string
Access type: Read-only

Label by which the object is known. When subclassed, this property can be overridden to be a key property. This property is inherited from CIM_ManagedSystemElement.

NdisMedium
Data type: uint32
Access type: Read-only

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

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)
NetLuid
Data type: uint64
Access type: Read-only

The locally unique identifier (LUID) for the network interface as a 64 bit number.

NetLuidIndex
Data type: uint32
Access type: Read-only

An index assigned to the network adapter at the time of installation.This index is unique in the scope of interface type.

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

An array of strings that indicates the network addresses for the port. This property inherits from CIM_NetworkPort.

NotUserRemovable
Data type: boolean
Access type: Read-only

Network adapter cannot be removed by the user.

OperationalStatusDownDefaultPortNotAuthenticated
Data type: boolean
Access type: Read-only

The default port of the network adapter is not authenticated.

OperationalStatusDownInterfacePaused
Data type: boolean
Access type: Read-only

The network adapter is in the paused state.

OperationalStatusDownLowPowerState
Data type: boolean
Access type: Read-only

The network adapter is in a low power state.

OperationalStatusDownMediaDisconnected
Data type: boolean
Access type: Read-only

The network adapter is not in a media-connected state.

OtherLinkTechnology
Data type: string
Access type: Read-only

A string value that describes LinkTechnology when it is set to 1, "Other". This property inherits from CIM_NetworkPort.

OtherNetworkPortType
Data type: string
Access type: Read-only

Note: The use of this property is deprecated in lieu of CIM_LogicalPort.PortType. Deprecated description: The type of module, when PortType is set to 1 ("Other".) This property inherits from CIM_NetworkPort.

OtherPortType
Data type: string
Access type: Write-only

Describes the type of module, when PortType is set to 1 ("Other"). This property inherits from CIM_LogicalPort.

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

The network address that is hardcoded into a port. This hardcoded address can be changed using a firmware upgrade or a software configuration. When this change is made, the field should be updated at the same time. PermanentAddress should be left blank if no hardcoded address exists for the network adapter. This property inherits from CIM_NetworkPort.

PnPDeviceID
Data type: string
Access type: Read-only

The Plug and Play Device ID.

PNPDeviceID
Data type: string
Access type: Read-only

Indicates the Win32 Plug and Play device identifier of the logical device. This property inherits from CIM_LogicalDevice.

Example: "*PNP030b"

PortNumber
Data type: uint16
Access type: Read-only

Network ports are often numbered relative to either a logical module or a network element. This property inherits from CIM_NetworkPort.

PortType
Data type: uint16
Access type: Write-only

Forces consistent naming of the 'type' property in subclasses and to guarantee unique enum values for all instances of NetworkPort. When set to 1 ("Other"), related property OtherPortType contains a string description of the type of port. A range of values, DMTF_Reserved, has been defined that allows subclasses to override and define their specific types of ports. This property inherits from CIM_LogicalPort.

Unknown (0)
Other (1)
Not Applicable (2)
DMTF Reserved (3..15999)
Vendor Reserved (16000..65535)
PowerManagementCapabilities
Data type: uint16 array
Access type: Read-only

Array of the specific power-related capabilities of a logical device. This property is inherited from CIM_LogicalDevice. This property inherits from CIM_LogicalDevice.

ValueMeaning
Unknown
0 (0x0)
Not Supported
1 (0x1)
Disabled
2 (0x2)
Enabled
3 (0x3)

The power management features are currently enabled but the exact feature set is unknown or the information is unavailable.

Power Saving Modes Entered Automatically
4 (0x4)

The device can change its power state based on usage or other criteria.

Power State Settable
5 (0x5)

The SetPowerState method is supported. This method is found on the parent CIM_LogicalDevice class and can be implemented. For more information, see Designing Managed Object Format (MOF) Classes.

Power Cycling Supported
6 (0x6)

The SetPowerState method can be invoked with the PowerState parameter set to 5 ("Power Cycle").

Timed Power On Supported
7 (0x7)

The SetPowerState method can be invoked with the PowerStateparameter set to 5 ("Power Cycle") and Time set to a specific date and time, or interval, for power-on.

 

PowerManagementSupported
Data type: boolean
Access type: Read-only

If TRUE, the device can be power managed, that is, put into a power-save state. If FALSE, the integer value 1 ("Not Supported") should be the only entry in the PowerManagementCapabilities array.

This property does not indicate whether power management features are currently enabled, or if enabled, which features are supported. For more information, see the PowerManagementCapabilities array.

This property inherits from CIM_LogicalDevice.

PromiscuousMode
Data type: boolean
Access type: Read-only

TRUE if the interface is in promiscuous mode or FALSE if it is not.

ReceiveLinkSpeed
Data type: uint64
Access type: Read-only

The receive link speed in bits per second.

RequestedSpeed
Data type: uint64
Access type: Write-only
Qualifiers: Units ( "Bits per Second" )

The requested bandwidth, in bits per second, of the port. The actual bandwidth is reported in the Speed property. This property inherits from CIM_LogicalPort.

Speed
Data type: uint64
Access type: Read-only
Qualifiers: Units ( "Bits per Second" )

The bandwidth, in bits per second, of the port. This property inherits from CIM_LogicalPort.

State
Data type: uint32
Access type: Read-only

The plug and play state of the network adapter.

Unknown (0)
Present (1)
Started (2)
Disabled (3)
Status
Data type: string
Access type: Read-only

Current status of the object. This property is inherited from CIM_ManagedSystemElement.

Values include the following:

"OK"
"Error"
"Degraded"
"Unknown"
"Pred Fail"
"Starting"
"Stopping"
"Service"
"Stressed"
"NonRecover"
"No Contact"
"Lost Comm"
StatusInfo
Data type: uint16
Access type: Read-only

State of the logical device. If this property does not apply to the logical device, the value 5 ("Not Applicable") should be used. This property inherits from CIM_LogicalDevice.

Other (1 (0x1))
Unknown (2 (0x2))
Enabled (3 (0x3))
Disabled (4 (0x4))
Not Applicable (5 (0x5))
SupportedMaximumTransmissionUnit
Data type: uint64
Access type: Read-only
Qualifiers: Units ( "Bytes" )

The maximum transmission unit (MTU) that can be supported. This property inherits from CIM_NetworkPort.

SystemCreationClassName
Data type: string
Access type: Read-only

Scoping system's creation class name. This property inherits from CIM_LogicalDevice.

SystemName
Data type: string
Access type: Read-only

Scoping system's name. This property inherits from CIM_LogicalDevice.

TransmitLinkSpeed
Data type: uint64
Access type: Read-only

The transmit link speed in bits per second.

UsageRestriction
Data type: uint16
Access type: Write-only

In some cases, a logical port might be identifiable as a front end or back end port. An example of this situation would be a storage array that might have back end ports to communicate with disk drives and front end ports to communicate with hosts. If there is no restriction on the use of the port, then the value should be set to 'not restricted'. This property inherits from CIM_LogicalPort.

Unknown (0)
Front-end only (2)
Back-end only (3)
Not restricted (4)
Virtual
Data type: boolean
Access type: Read-only

Network adapter emulates a physical network card.

VlanID
Data type: uint16
Access type: Read/write

The Virtual LAN Identifier set on the network adapter.

WdmInterface
Data type: boolean
Access type: Read-only

The lower-level interface of the network adapter is a WDM bus driver such as USB.

Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Namespace

\root\StandardCimv2

MOF

NetAdapterCim.mof

DLL

NetAdapterCim.dll

 

 

Community Additions

Show:
© 2014 Microsoft