RemoveByClientId method of the PS_DhcpServerv4Lease class

  • Article

Deletes the specified IPv4 address lease record from the DHCP server.

Syntax

uint32 RemoveByClientId(
  [in]  boolean           PassThru,
  [in]  string            ComputerName,
  [in]  string            ClientId[],
  [in]  string            ScopeId,
  [out] DhcpServerv4Lease cmdletOutput[]
);

Parameters

PassThru [in]

If this parameter is specified, the cmdlet return the PowerShell objects which are deleted.

ComputerName [in]

DNS name or IP address of the target computer running the DHCP server service.

ClientId [in]

Client identifier whose IP address lease is to be deleted. Windows clients use the MAC address as the client identifier.

ScopeId [in]

Scope identifier (in IPv4 address format) from which the IP address leases are to be deleted.

cmdletOutput [out]

An embedded instance of the DhcpServerv4Lease class.

Requirements
Minimum supported client
 None supported
Minimum supported server
 Windows Server 2012
Namespace
 Root\Microsoft\Windows\DHCP
MOF
DhcpServerPsProvider.mof
DLL
DhcpServerPsProvider.dll

See also

PS_DhcpServerv4Lease