Export (0) Print
Expand All

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  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.

Restart

Restarts a network adapter.

Unlock

Unlocks a network adapter.

 

Properties

The MSFT_NetAdapter class has these properties.

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.

ComponentID
Data type: string
Access type: Read-only

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

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.

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.

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.

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.

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.

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.

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.

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.

PnPDeviceID
Data type: string
Access type: Read-only

The Plug and Play Device ID.

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.

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

The transmit link speed in bits per second.

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

ADD
Show:
© 2014 Microsoft