ReleaseDHCPLease method of the Win32_NetworkAdapterConfiguration class

Article
11/09/2023

The ReleaseDHCPLease WMI class method releases the IP address bound to a specific DHCP-enabled network adapter.

This topic uses Managed Object Format (MOF) syntax. For more information about using this method, see Calling a Method.

Syntax

uint32 ReleaseDHCPLease();

Parameters

This method has no parameters.

Return value

Returns a value of 0 (zero) for a successful completion when no reboot is required, 1 (one) for a successful completion when a reboot is required, and a different number if there is an error. For more information on error codes, see WMI Error Constants or WbemErrorEnum. For general HRESULT values, see System Error Codes.

Successful completion, no reboot required

Successful completion, no reboot required.

Successful completion, reboot required

Successful completion, reboot required.

Method not supported on this platform

Method not supported on this platform.

Unknown failure

Unknown failure.

Invalid subnet mask

Invalid subnet mask.

An error occurred while processing an Instance that was returned

An error occurred while processing an instance that was returned.

Invalid input parameter

Invalid input parameter.

More than 5 gateways specified

More than five gateways specified.

Invalid IP address

Invalid IP address.

Invalid gateway IP address

Invalid gateway IP address.

An error occurred while accessing the Registry for the requested information

An error occurred while accessing the registry for the requested information.

Invalid domain name

Invalid domain name.

Invalid host name

Invalid host name.

No primary/secondary WINS server defined

No primary or secondary WINS server defined.

Invalid file

Invalid file.

Invalid system path

Invalid system path.

File copy failed

File copy failed.

Invalid security parameter

Invalid security parameter.

Unable to configure TCP/IP service

Unable to configure TCP/IP service.

Unable to configure DHCP service

Unable to configure DHCP service.

Unable to renew DHCP lease

Unable to renew DHCP lease.

Unable to release DHCP lease

Unable to release DHCP lease.

IP not enabled on adapter

IP not enabled on adapter.

IPX not enabled on adapter

IPX not enabled on adapter.

Frame/network number bounds error

Frame or network number bounds error.

Invalid frame type

Invalid frame type.

Invalid network number

Invalid network number.

Duplicate network number

Duplicate network number.

Parameter out of bounds

Parameter out of bounds.

Access denied

Access denied.

Out of memory

Out of memory.

Already exists

Already exists.

Path, file or object not found

Path, file, or object not found.

Unable to notify service

Unable to notify service.

Unable to notify DNS service

Unable to notify DNS service.

Interface not configurable

Interface not configurable.

Not all DHCP leases could be released/renewed

Not all DHCP leases could be released or renewed.

DHCP not enabled on adapter

100

DHCP not enabled on adapter.

Other

101 4294967295

Remarks

Caution

If DHCP is enabled on the local computer system, the option disables TCP/IP on this specific network adapter. Unless you have an alternate path to the target system, that is, another TCP/IP bound network adapter, all TCP/IP communications will be lost.

Examples

The following VBScript code releases the DHCP leases for all TCP/IP-bound network adapters on a computer.

On Error Resume Next 
 
strComputer = "." 
Set objWMIService = GetObject("winmgmts:" _ 
    & "{impersonationLevel=impersonate}!\\" & strComputer & "\root\cimv2") 
 
Set colNetCards = objWMIService.ExecQuery _ 
    ("Select * From Win32_NetworkAdapterConfiguration Where IPEnabled = True") 
 
For Each objNetCard in colNetCards 
    objNetCard.ReleaseDHCPLease() 
Next

Requirements

Requirement	Value
Minimum supported client	Windows Vista
Minimum supported server	Windows Server 2008
Namespace	Root\CIMV2
MOF	CIMWin32.mof
DLL	CIMWin32.dll

Share via