Home Reference WMI Reference root CIMV2 Win32_NetworkAdapter
 

Win32_NetworkAdapter

The Win32_NetworkAdapter class represents a network adapter on a Win32 system.

Quick Start

Properties

Most WMI properties are read-only. You can only read values but not change them. Few properties are also writeable. You can assign new values to those properties.

Writeable properties are marked with this icon:   

AdapterType

Data type String

The AdapterType property reflects the network medium in use. This property may not be applicable to all types of network adapters listed within this class. Windows NT only.

'Ethernet 802.3','Token Ring 802.5','Fiber Distributed Data Interface (FDDI)','Wide Area Network (WAN)','LocalTalk','Ethernet using DIX header format','ARCNET','ARCNET (878.2)','ATM','Wireless','Infrared Wireless','Bpc','CoWan','1394'

AdapterTypeId

Data type UInt16

The AdapterTypeId property reflects the network medium in use. This property gives the same information as the AdapterType property, except that the the information is returned in the form of an integer value that corresponds to the following:

0 – Ethernet 802.3

1 – Token Ring 802.5

2 – Fiber Distributed Data Interface (FDDI)

3 – Wide Area Network (WAN)

4 – LocalTalk

5 – Ethernet using DIX header format

6 – ARCNET

7 – ARCNET (878.2)

8 – ATM

9 – Wireless

10 – Infrared Wireless

11 – Bpc

12 – CoWan

13 – 1394

This property may not be applicable to all types of network adapters listed within this class. Windows NT only.

AutoSense

Data type Boolean

A boolean indicating whether the NetworkAdapter is capable of automatically determining the speed or other communications characteristics of the attached network media.

Availability

Data type UInt16

The availability and status of the device. For example, the Availability property indicates that the device is running and has full power (value=3), or is in a warning (4), test (5), degraded (10) or power save state (values 13-15 and 17). Regarding the power saving states, these are defined as follows: Value 13 (“Power Save – Unknown”) indicates that the device is known to be in a power save mode, but its exact status in this mode is unknown; 14 (“Power Save – Low Power Mode”) indicates that the device is in a power save state but still functioning, and may exhibit degraded performance; 15 (“Power Save – Standby”) describes that the device is not functioning but could be brought to full power ‘quickly’; and value 17 (“Power Save – Warning”) indicates that the device is in a warning state, though also in a power save mode.

$Availability_ReturnValue = 
@{
    1='Other'
    2='Unknown'
    3='Running/Full Power'
    4='Warning'
    5='In Test'
    6='Not Applicable'
    7='Power Off'
    8='Off Line'
    9='Off Duty'
   10='Degraded'
   11='Not Installed'
   12='Install Error'
   13='Power Save - Unknown'
   14='Power Save - Low Power Mode'
   15='Power Save - Standby'
   16='Power Cycle'
   17='Power Save - Warning'
   18='Paused'
   19='Not Ready'
   20='Not Configured'
   21='Quiesced'
}

Caption

Data type String

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

ConfigManagerErrorCode

Data type UInt32

Indicates the Win32 Configuration Manager error code. The following values may be returned:

0 This device is working properly.

1 This device is not configured correctly.

2 Windows cannot load the driver for this device.

3 The driver for this device might be corrupted, or your system may be running low on memory or other resources.

4 This device is not working properly. One of its drivers or your registry might be corrupted.

5 The driver for this device needs a resource that Windows cannot manage.

6 The boot configuration for this device conflicts with other devices.

7 Cannot filter.

8 The driver loader for the device is missing.

9 This device is not working properly because the controlling firmware is reporting the resources for the device incorrectly.

10 This device cannot start.

11 This device failed.

12 This device cannot find enough free resources that it can use.

13 Windows cannot verify this device’s resources.

14 This device cannot work properly until you restart your computer.

15 This device is not working properly because there is probably a re-enumeration problem.

16 Windows cannot identify all the resources this device uses.

17 This device is asking for an unknown resource type.

18 Reinstall the drivers for this device.

19 Your registry might be corrupted.

20 Failure using the VxD loader.

21 System failure: Try changing the driver for this device. If that does not work, see your hardware documentation. Windows is removing this device.

22 This device is disabled.

23 System failure: Try changing the driver for this device. If that doesn’t work, see your hardware documentation.

24 This device is not present, is not working properly, or does not have all its drivers installed.

25 Windows is still setting up this device.

26 Windows is still setting up this device.

27 This device does not have valid log configuration.

28 The drivers for this device are not installed.

29 This device is disabled because the firmware of the device did not give it the required resources.

30 This device is using an Interrupt Request (IRQ) resource that another device is using.

31 This device is not working properly because Windows cannot load the drivers required for this device.

$ConfigManagerErrorCode_ReturnValue = 
@{
    0='This device is working properly.'
    1='This device is not configured correctly.'
    2='Windows cannot load the driver for this device.'
    3='The driver for this device might be corrupted    4= or your system may be running low on memory or other resources.'

    5='This device is not working properly. One of its drivers or your registry might be corrupted.'
    6='The driver for this device needs a resource that Windows cannot manage.'
    7='The boot configuration for this device conflicts with other devices.'
    8='Cannot filter.'
    9='The driver loader for the device is missing.'
   10='This device is not working properly because the controlling firmware is reporting the resources for the device incorrectly.'
   11='This device cannot start.'
   12='This device failed.'
   13='This device cannot find enough free resources that it can use.'
   14='Windows cannot verify this device's resources.'    15='This device cannot work properly until you restart your computer.'    16='This device is not working properly because there is probably a re-enumeration problem.'    17='Windows cannot identify all the resources this device uses.'    18='This device is asking for an unknown resource type.'    19='Reinstall the drivers for this device.'    20='Failure using the VxD loader.'    21='Your registry might be corrupted.'    22='System failure: Try changing the driver for this device. If that does not work
   23= see your hardware documentation. Windows is removing this device.'    24='This device is disabled.'    25='System failure: Try changing the driver for this device. If that doesn't work    26= see your hardware documentation.'
   27='This device is not present   28= is not working properly
   29= or does not have all its drivers installed.'

   30='Windows is still setting up this device.'
   31='Windows is still setting up this device.'
}

ConfigManagerUserConfig

Data type Boolean

Indicates whether the device is using a user-defined configuration.

CreationClassName

Data type String

CreationClassName indicates the name of the class or the subclass used in the creation of an instance. When used with the other key properties of this class, this property allows all instances of this class and its subclasses to be uniquely identified.

Description

Data type String

The Description property provides a textual description of the object.

DeviceID

Data type String

The DeviceID property contains a string uniquely identifying the network adapter from other devices on the system.

ErrorCleared

Data type Boolean

ErrorCleared is a boolean property indicating that the error reported in LastErrorCode property is now cleared.

ErrorDescription

Data type String

ErrorDescription is a free-form string supplying more information about the error recorded in LastErrorCode property, and information on any corrective actions that may be taken.

GUID

Data type String

The GUID property specifies the Globally-unique identifier for the connection.

Index

Data type UInt32

The Index property indicates the network adapter’s index number, which is stored in the system registry.

Example: 0.

InstallDate

Data type DateTime

The InstallDate property is datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.

Installed

Data type Boolean

The Installed property determines whether the network adapter is installed in the system.

Values: $true or $false. A value of $true indicates the network adapter is installed.

The Installed property has been deprecated. There is no replacementvalue and this property is now considered obsolete.

InterfaceIndex

Data type UInt32

The InterfaceIndex property contains the index value that uniquely identifies the local interface.

LastErrorCode

Data type UInt32

LastErrorCode captures the last error code reported by the logical device.

MACAddress

Data type String

The MACAddress property indicates the media access control address for this network adapter. A MAC address is a unique 48-bit number assigned to the network adapter by the manufacturer. It uniquely identifies this network adapter and is used for mapping TCP/IP network communications.

Manufacturer

Data type String

The Manufacturer property indicates the name of the network adapter’s manufacturer.

Example: 3COM.

MaxNumberControlled

Data type UInt32

The MaxNumberControlled property indicates the maximum number of directly addressable ports supported by this network adapter. A value of zero should be used if the number is unknown.

MaxSpeed

Data type UInt64

The maximum speed, in bits per second, for the network adapter.

Name

Data type String

The Name parameter specifies a friendly name for the printer. This may be overridden if the name has alreadybeen set by the printer.

  NetConnectionID

Data type String

The NetConnectionID property specifies the name of the network connection as it appears in the ‘Network Connections’ folder.

NetConnectionStatus

Data type UInt16

NetConnectionStatus is a string indicating the state of the network adapter’s connection to the network. The value of the property is to be interpreted as follows:

$NetConnectionStatus_ReturnValue = 
@{
    0='Disconnected'
    1='Connecting'
    2='Connected'
    3='Disconnecting'
    4='Hardware Not Present'
    5='Hardware Disabled'
    6='Hardware Malfunction'
    7='Media Disconnected'
    8='Authenticating'
    9='Authentication Succeeded'
   10='Authentication Failed'
   11='Invalid Address'
   12='Credentials Required'
   ..='Other'
}

NetEnabled

Data type Boolean

The NetEnabled property specifies whether the network connection is enabled or not.

NetworkAddresses

Data type String

An array of strings indicating the network addresses for an adapter.

PermanentAddress

Data type String

PermanentAddress defines the network address hard coded into an adapter. This ‘hard coded’ address may be changed via firmware upgrade or software configuration. If so, this field should be updated when the change is made. PermanentAddress should be left blank if no ‘hard coded’ address exists for the network adapter.

PhysicalAdapter

Data type Boolean

The PhysicalAdapter property specifies whether the adapter is physical adapter or logical adapter.

PNPDeviceID

Data type String

Indicates the Win32 Plug and Play device ID of the logical device. Example: *PNP030b

PowerManagementCapabilities

Data type UInt16

Indicates the specific power-related capabilities of the logical device. The array values, 0=”Unknown”, 1=”Not Supported” and 2=”Disabled” are self-explanatory. The value, 3=”Enabled” indicates that 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) describes that a device can change its power state based on usage or other criteria. “Power State Settable” (5) indicates that the SetPowerState method is supported. “Power Cycling Supported” (6) indicates that the SetPowerState method can be invoked with the PowerState input variable set to 5 (“Power Cycle”). “Timed Power On Supported” (7) indicates that the SetPowerState method can be invoked with the PowerState input variable set to 5 (“Power Cycle”) and the Time parameter set to a specific date and time, or interval, for power-on.

PowerManagementSupported

Data type Boolean

Boolean indicating that the Device can be power managed – ie, put into a power save state. This boolean does not indicate that power management features are currently enabled, or if enabled, what features are supported. Refer to the PowerManagementCapabilities array for this information. If this boolean is $false, the integer value 1, for the string, “Not Supported”, should be the only entry in the PowerManagementCapabilities array.

ProductName

Data type String

The ProductName property indicates the product name of the network adapter.

Example: Fast EtherLink XL

ServiceName

Data type String

The ServiceName property indicates the service name of the network adapter. This name is usually shorter that the full product name.

Example: Elnkii.

Speed

Data type UInt64

An estimate of the current bandwidth in bits per second. For endpoints which vary in bandwidth or for those where no accurate estimation can be made, this property should contain the nominal bandwidth.

Status

Data type String

The Status property is a string indicating the current status of the object. Various operational and non-operational statuses can be defined. Operational statuses are “OK”, “Degraded” and “Pred Fail”. “Pred Fail” indicates that an element may be functioning properly but predicting a failure in the near future. An example is a SMART-enabled hard drive. Non-operational statuses can also be specified. These are “Error”, “Starting”, “Stopping” and “Service”. The latter, “Service”, could apply during mirror-resilvering of a disk, reload of a user permissions list, or other administrative work. Not all such work is on-line, yet the managed element is neither “OK” nor in one of the other states.

'OK','Error','Degraded','Unknown','Pred Fail','Starting','Stopping','Service','Stressed','NonRecover','No Contact','Lost Comm'

StatusInfo

Data type UInt16

StatusInfo is a string indicating whether the logical device is in an enabled (value = 3), disabled (value = 4) or some other (1) or unknown (2) state. If this property does not apply to the logical device, the value, 5 (“Not Applicable”), should be used.

$StatusInfo_ReturnValue = 
@{
    1='Other'
    2='Unknown'
    3='Enabled'
    4='Disabled'
    5='Not Applicable'
}

SystemCreationClassName

Data type String

The scoping System’s CreationClassName.

SystemName

Data type String

The scoping System’s Name.

TimeOfLastReset

Data type DateTime

The TimeOfLastReset property indicates when the network adapter was last reset.

Methods

Examples

See Also

Help and Questions

  Community Content

You are cordially invited to add knowledge to this page. If you have sample code or additional information related to this WMI class, please share it. Use the comment form to send your information. We will edit and incorparate it into the reference library. Thank you!

Please do not use the comment form to submit questions. If you have questions or need assistance, visit our free forum: Help me with WMI.

Content last updated: 2013-12-27 12:16:44 (UTC).

Facebooktwittergoogle_pluspinterestlinkedinFacebooktwittergoogle_pluspinterestlinkedin