Win32_NetworkAdapterConfiguration Class (Windows)

Win32_NetworkAdapterConfiguration Class

The Win32_NetworkAdapterConfiguration WMI class represents the attributes and behaviors of a network adapter. This class includes extra properties and methods that support the management of the TCP/IP and Internetwork Packet Exchange (IPX) protocols that are independent from the network adapter.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties. Properties are listed in alphabetic order, not MOF order.

Syntax

class Win32_NetworkAdapterConfiguration : CIM_Setting
{
  boolean  ArpAlwaysSourceRoute;
  boolean  ArpUseEtherSNAP;
  string   Caption;
  string   DatabasePath;
  boolean  DeadGWDetectEnabled;
  string   DefaultIPGateway[];
  uint8    DefaultTOS;
  uint8    DefaultTTL;
  string   Description;
  boolean  DHCPEnabled;
  datetime DHCPLeaseExpires;
  datetime DHCPLeaseObtained;
  string   DHCPServer;
  string   DNSDomain;
  string   DNSDomainSuffixSearchOrder[];
  boolean  DNSEnabledForWINSResolution;
  string   DNSHostName;
  string   DNSServerSearchOrder[];
  boolean  DomainDNSRegistrationEnabled;
  uint32   ForwardBufferMemory;
  boolean  FullDNSRegistrationEnabled;
  uint16   GatewayCostMetric[];
  uint8    IGMPLevel;
  uint32   Index;
  uint32   InterfaceIndex;
  string   IPAddress[];
  uint32   IPConnectionMetric;
  boolean  IPEnabled;
  boolean  IPFilterSecurityEnabled;
  boolean  IPPortSecurityEnabled;
  string   IPSecPermitIPProtocols[];
  string   IPSecPermitTCPPorts[];
  string   IPSecPermitUDPPorts[];
  string   IPSubnet[];
  boolean  IPUseZeroBroadcast;
  string   IPXAddress;
  boolean  IPXEnabled;
  uint32   IPXFrameType[];
  uint32   IPXMediaType;
  string   IPXNetworkNumber[];
  string   IPXVirtualNetNumber;
  uint32   KeepAliveInterval;
  uint32   KeepAliveTime;
  string   MACAddress;
  uint32   MTU;
  uint32   NumForwardPackets;
  boolean  PMTUBHDetectEnabled;
  boolean  PMTUDiscoveryEnabled;
  string   ServiceName;
  string   SettingID;
  uint32   TcpipNetbiosOptions;
  uint32   TcpMaxConnectRetransmissions;
  uint32   TcpMaxDataRetransmissions;
  uint32   TcpNumConnections;
  boolean  TcpUseRFC1122UrgentPointer;
  uint16   TcpWindowSize;
  boolean  WINSEnableLMHostsLookup;
  string   WINSHostLookupFile;
  string   WINSPrimaryServer;
  string   WINSScopeID;
  string   WINSSecondaryServer;
};

Methods

The Win32_NetworkAdapterConfiguration class defines the following methods.

Method	Description
DisableIPSec	Disables IP security on this TCP/IP-enabled network adapter.
EnableDHCP	Enables the Dynamic Host Configuration Protocol (DHCP) for service with this network adapter.
EnableDNS	Enables the Domain Name System (DNS) for service on this TCP/IP-bound network adapter.
EnableIPFilterSec	Enables IP security globally across all IP-bound network adapters.
EnableIPSec	Enables IP security on this specific TCP/IP-enabled network adapter.
EnableStatic	Enables static TCP/IP addressing for the target network adapter.
EnableWINS	Enables WINS settings specific to TCP/IP, but independent of the network adapter.
ReleaseDHCPLease	Releases the IP address bound to a specific DHCP-enabled network adapter.
ReleaseDHCPLeaseAll	Releases the IP addresses bound to all DHCP-enabled network adapters.
RenewDHCPLease	Renews the IP address on specific DHCP-enabled network adapters.
RenewDHCPLeaseAll	Renews the IP addresses on all DHCP-enabled network adapters.
SetArpAlwaysSourceRoute	Sets the transmission of ARP queries by the TCP/IP.
SetArpUseEtherSNAP	Enables Ethernet packets to use 802.3 SNAP encoding.
SetDatabasePath	Sets the path to the standard Internet database files (HOSTS, LMHOSTS, NETWORKS, and PROTOCOLS).
SetDeadGWDetect	Enables dead gateway detection.
SetDefaultTOS	Obsolete. This method sets the default Type of Service (TOS) value in the header of outgoing IP packets.
SetDefaultTTL	Sets the default Time to Live (TTL) value in the header of outgoing IP packets.
SetDNSDomain	Sets the DNS domain.
SetDNSServerSearchOrder	Sets the server search order as an array of elements.
SetDNSSuffixSearchOrder	Sets the suffix search order as an array of elements.
SetDynamicDNSRegistration	Indicates dynamic DNS registration of IP addresses for this IP-bound adapter. This method is new for Windows XP.
SetForwardBufferMemory	Specifies how much memory IP allocates to store packet data in the router packet queue.
SetGateways	Specifies a list of gateways for routing packets destined for a different subnet than the one this adapter is connected to.
SetIGMPLevel	Sets the extent to which the system supports IP multicasting and participates in the Internet Group Management Protocol.
SetIPConnectionMetric	Sets the routing metric associated with this IP-bound adapter. Windows 2000 with SP2 and earlier and Windows NT: This method is not available.
SetIPUseZeroBroadcast	Sets IP zero broadcast usage.
SetIPXFrameTypeNetworkPairs	Starting with Windows Vista, the Internetwork Packet Exchange (IPX) technology is no longer supported and this method is obsolete. Windows Server 2003, Windows XP, Windows 2000, and Windows NT 4.0: Sets IPX network number or frame pairs for this network adapter.
SetIPXVirtualNetworkNumber	Starting with Windows Vista, the Internetwork Packet Exchange (IPX) technology is no longer supported and this method is obsolete. Windows Server 2003, Windows XP, Windows 2000, and Windows NT 4.0: Sets the Internetwork Packet Exchange (IPX) virtual network number on the target computer system.
SetKeepAliveInterval	Sets the interval separating Keep Alive Retransmissions until a response is received.
SetKeepAliveTime	Sets how often TCP attempts to verify that an idle connection is still available by sending a Keep Alive packet.
SetMTU	Sets the default Maximum Transmission Unit (MTU) for a network interface. This method is not supported.
SetNumForwardPackets	Sets the number of IP packet headers allocated for the router packet queue.
SetPMTUBHDetect	Enables detection of Black Hole routers.
SetPMTUDiscovery	Enables Maximum Transmission Unit (MTU) discovery.
SetTcpipNetbios	Sets the default operation of NetBIOS over TCP/IP. Windows 2000 and Windows NT 4.0: This property is not available.
SetTcpMaxConnectRetransmissions	Sets the number of attempts TCP will retransmit a connect request before aborting.
SetTcpMaxDataRetransmissions	Sets the number of times TCP will retransmit an individual data segment before aborting the connection.
SetTcpNumConnections	Sets the maximum number of connections that TCP may have open simultaneously.
SetTcpUseRFC1122UrgentPointer	Specifies whether TCP uses the RFC 1122 specification for urgent data, or the mode used by Berkeley Software Design (BSD) derived systems.
SetTcpWindowSize	Sets the maximum TCP Receive Window size offered by the system.
SetWINSServer	Sets the primary and secondary Windows Internet Naming Service (WINS) servers on this TCP/IP-bound network adapter.

Properties

The Win32_NetworkAdapterConfiguration class defines the following properties.

ArpAlwaysSourceRoute

Data type: boolean
Access type: Read-only

If TRUE, TCP/IP transmits Address Resolution Protocol (ARP) queries with source routing enabled on Token Ring networks. By default (FALSE), ARP first queries without source routing, and then retries with source routing enabled if no reply is received. Source routing allows the routing of network packets across different types of networks.

ArpUseEtherSNAP

Data type: boolean
Access type: Read-only

If TRUE, Ethernet packets follow the IEEE 802.3 Sub-Network Access Protocol (SNAP) encoding. Setting this parameter to 1 forces TCP/IP to transmit Ethernet packets by using 802.3 SNAP encoding. By default (FALSE), the stack transmits packets in DIX Ethernet format. Windows 2000 and Windows NT systems can receive both formats.

Caption

Data type: string
Access type: Read-only

Description of the CIM_Setting object—a one-line string. This property is inherited from CIM_Setting.

DatabasePath

Data type: string
Access type: Read-only

Valid Windows file path to standard Internet database files (HOSTS, LMHOSTS, NETWORKS, and PROTOCOLS). The file path is used by the Windows Sockets interface. This property is only available on computer systems running Windows 2000 and Windows NT.

DeadGWDetectEnabled

Data type: boolean
Access type: Read-only

If TRUE, dead gateway detection occurs. With this feature enabled, Transmission Control Protocol (TCP) asks Internet Protocol (IP) to change to a backup gateway if it retransmits a segment several times without receiving a response.

DefaultIPGateway

Data type: string array
Access type: Read-only

Array of IP addresses of default gateways that the computer system uses.

Example: "192.168.12.1 192.168.46.1"

DefaultTOS

Data type: uint8
Access type: Read-only

Default Type Of Service (TOS) value set in the header of outgoing IP packets. Request for Comments (RFC) 791 defines the values. Default: 0 (zero), Valid Range: 0 - 255.

DefaultTTL

Data type: uint8
Access type: Read-only

Default Time To Live (TTL) value set in the header of outgoing IP packets. The TTL specifies the number of routers an IP packet can pass through to reach its destination before being discarded. Each router decrements by one the TTL count of a packet as it passes through and discards the packets—if the TTL is 0 (zero). Default: 32, Valid Range: 1 - 255.

Description

Data type: string
Access type: Read-only

Description of the CIM_Setting object. This property is inherited from CIM_Setting.

DHCPEnabled

Data type: boolean
Access type: Read-only

If TRUE, the dynamic host configuration protocol (DHCP) server automatically assigns an IP address to the computer system when establishing a network connection.

DHCPLeaseExpires

Data type: datetime
Access type: Read-only

Expiration date and time for a leased IP address that was assigned to the computer by the dynamic host configuration protocol (DHCP) server.

Example: 20521201000230.000000000

DHCPLeaseObtained

Data type: datetime
Access type: Read-only

Date and time the lease was obtained for the IP address assigned to the computer by the dynamic host configuration protocol (DHCP) server.

Example: 19521201000230.000000000

DHCPServer

Data type: string
Access type: Read-only

IP address of the dynamic host configuration protocol (DHCP) server.

Example: "10.55.34.2"

DNSDomain

Data type: string
Access type: Read-only

Organization name followed by a period and an extension that indicates the type of organization, such as microsoft.com. The name can be any combination of the letters A through Z, the numerals 0 through 9, and the hyphen (-), plus the period (.) character used as a separator.

Example: "microsoft.com"

DNSDomainSuffixSearchOrder

Data type: string array
Access type: Read-only

Array of DNS domain suffixes to be appended to the end of host names during name resolution. When attempting to resolve a fully-qualified domain name (FQDN) from a host-only name, the system will first append the local domain name. If this is not successful, the system will use the domain suffix list to create additional FQDNs in the order listed and query DNS servers for each.

Example: "samples.microsoft.com example.microsoft.com"

DNSEnabledForWINSResolution

Data type: boolean
Access type: Read-only

If TRUE, the Domain Name System (DNS) is enabled for name resolution over Windows Internet Naming Service (WINS) resolution. If the name cannot be resolved using DNS, the name request is forwarded to WINS for resolution.

DNSHostName

Data type: string
Access type: Read-only

Host name used to identify the local computer for authentication by some utilities. Other TCP/IP-based utilities can use this value to acquire the name of the local computer. Host names are stored on DNS servers in a table that maps names to IP addresses for use by DNS. The name can be any combination of the letters A through Z, the numerals 0 through 9, and the hyphen (-), plus the period (.) character used as a separator. By default, this value is the Microsoft networking computer name, but the network administrator can assign another host name without affecting the computer name.

Example: "corpdns"

DNSServerSearchOrder

Data type: string array
Access type: Read-only

Array of server IP addresses to be used in querying for DNS servers.

DomainDNSRegistrationEnabled

Data type: boolean
Access type: Read-only

If TRUE, the IP addresses for this connection are registered in DNS under the domain name of this connection in addition to being registered under the computer's full DNS name. The domain name of this connection is either set using the SetDNSDomain() method or assigned by DSCP. The registered name is the host name of the computer with the domain name appended.

Windows 2000 and Windows NT 4.0: This property is not available.

ForwardBufferMemory

Data type: uint32
Access type: Read-only
Qualifiers: Units(Bytes)

Memory allocated by IP to store packet data in the router packet queue. When this buffer space is filled, the router begins discarding packets at random from its queue. Packet queue data buffers are 256 bytes in length, so the value of this parameter should be a multiple of 256. Multiple buffers are chained together for larger packets. The IP header for a packet is stored separately. This parameter is ignored and no buffers are allocated if the IP router is not enabled. The buffer size can range from the network MTU to a value smaller than 0xFFFFFFFF. Default: 74240 (fifty 1480-byte packets, rounded to a multiple of 256).

FullDNSRegistrationEnabled

Data type: boolean
Access type: Read-only

If TRUE, the IP addresses for this connection are registered in DNS under the computer's full DNS name. The full DNS name of the computer is displayed on the Network Identification tab in the System application in Control Panel.

Windows 2000 and Windows NT 4.0: This property is not available.

GatewayCostMetric

Data type: uint16 array
Access type: Read-only

Array of integer cost metric values (ranging from 1 to 9999) to be used in calculating the fastest, most reliable, or least expensive routes. This argument has a one-to-one correspondence with the DefaultIPGateway property.

Windows NT 4.0: This property is not available.

IGMPLevel

Data type: uint8
Access type: Read-only

Extent to which the system supports IP multicast and participates in the Internet Group Management Protocol (IGMP). At level 0 (zero), the system provides no multicast support. At level 1, the system may only send IP multicast packets. At level 2, the system may send IP multicast packets and fully participate in IGMP to receive multicast packets.

Value	Meaning
0	No Multicast
1	IP Multicast
2	IP and IGMP Multicast (default)

Index

Data type: uint32
Access type: Read-only
Qualifiers: Key

Index number of the Windows network adapter configuration. The index number is used when there is more than one configuration available.

InterfaceIndex

Data type: uint32
Access type: Read-only

Index value that uniquely identifies a local network interface. The value in this property is the same as the value in the InterfaceIndex property in the instance of Win32_IP4RouteTable that represents the network interface in the route table.

Windows XP, Windows 2000, and Windows NT 4.0: This property is not available.

IPAddress

Data type: string array
Access type: Read-only

Array of all of the IP addresses associated with the current network adapter. Starting with Windows Vista, this property can contain either IPv6 addresses or IPv4 addresses. For more information, see IPv6 and IPv4 Support in WMI.

Example IPv6 address: "2010:836B:4179::836B:4179"

Windows Server 2003, Windows XP, Windows 2000, and Windows NT 4.0: This property contains addresses in IPv4 format.
Example: "172.16.22.0"

IPConnectionMetric

Data type: uint32
Access type: Read-only

Cost of using the configured routes for the IP bound adapter and is the weighted value for those routes in the IP routing table. If there are multiple routes to a destination in the IP routing table, the route with the lowest metric is used. The default value is 1.

Windows 2000 and Windows NT 4.0: This property is not available.

IPEnabled

Data type: boolean
Access type: Read-only

If TRUE, TCP/IP is bound and enabled on this network adapter.

IPFilterSecurityEnabled

Data type: boolean
Access type: Read-only

If TRUE, IP port security is enabled globally across all IP-bound network adapters and the security values associated with individual network adapters are in effect. This property is used in conjunction with IPSecPermitTCPPorts, IPSecPermitUDPPorts, and IPSecPermitIPProtocols. If FALSE, IP filter security is disabled across all network adapters and allows all port and protocol traffic to flow unfiltered.

IPPortSecurityEnabled

Data type: boolean
Access type: Read-only
Qualifiers: Deprecated

If TRUE, IP port security is enabled globally across all IP-bound network adapters. This property is obsolete. In place of this property, you should use IPFilterSecurityEnabled.

IPSecPermitIPProtocols

Data type: string array
Access type: Read-only

Array of the protocols permitted to run over the IP. The list of protocols is defined using the EnableIPSec method. The list will either be empty or contain numeric values. A numeric value of 0 (zero) indicates access permission is granted for all protocols. An empty string indicates that no protocols are permitted to run when IPFilterSecurityEnabled is TRUE.

IPSecPermitTCPPorts

Data type: string array
Access type: Read-only

Array of the ports that will be granted access permission for TCP. The list of protocols is defined using the EnableIPSec method. The list will either be empty or contain numeric values. A numeric value of 0 (zero)indicates access permission is granted for all ports. An empty string indicates that no ports are granted access permission when IPFilterSecurityEnabled is TRUE.

IPSecPermitUDPPorts

Data type: string array
Access type: Read-only

Array of the ports that will be granted User Datagram Protocol (UDP) access permission. The list of protocols is defined using the EnableIPSec method. The list will either be empty or contain numeric values. A numeric value of 0 (zero) indicates access permission is granted for all ports. An empty string indicates that no ports are granted access permission when IPFilterSecurityEnabled is TRUE.

IPSubnet

Data type: string array
Access type: Read-only

Array of all of the subnet masks associated with the current network adapter.

Example: "255.255.0.0"

IPUseZeroBroadcast

Data type: boolean
Access type: Read-only

If TRUE, IP zeros-broadcasts are used (0.0.0.0), and the system uses ones-broadcasts (255.255.255.255). Computer systems generally use ones-broadcasts, but those derived from BSD implementations use zeros-broadcasts. Systems that do not use that same broadcasts will not interoperate on the same network. The default is FALSE.

IPXAddress

Data type: string
Access type: Read-only