Remove-DhcpServerv4Lease is accessible with the help of DHCPServer module. To configure DHCPServer, go through this link.
Synopsis
Deletes the specified IPv4 address lease record from the Dynamic Host Configuration Protocol (DHCP) server service.
Description
The Remove-DhcpServerv4Lease cmdlet deletes one or more IPv4 lease records from the Dynamic Host Configuration Protocol (DHCP) server service.
If the ScopeId parameter is specified, then all of the leases for the specified scope are deleted.
If the IPAddress parameter is specified, then the leases for clients identified by one or more specified IP addresses are deleted. If the ClientId and the ScopeId parameter is specified, then the lease for the specified client identifier (ID) from the specified scope is deleted.
If the BadLeases and the ScopeId parameters are specified, then this cmdlet removes all of the bad lease records for the specified scope.
If the BadLeases parameter is specified without the ScopeId parameter, then this cmdlet removes all of the bad leases from all of the scopes on the DHCP server service.
Parameters
-AsJob
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell background jobs, see about_Jobs.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-BadLeases
Specifies that all of the bad IP address leases are deleted. An IPv4 address lease which is declined by a client because of an IPv4 address conflict is marked as bad by the DHCP server service.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CimSession
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.
| Type: | CimSession[] |
| Aliases: | Session |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ClientId
Specifies the client ID whose IPv4 address lease is to be deleted. Windows clients use the MAC address as the client ID.
| Type: | String[] |
| Position: | 2 |
| Default value: | None |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-ComputerName
Specifies the DNS name, or IPv4 or IPv6 address, of the target computer that runs the DHCP server service.
| Type: | String |
| Aliases: | Cn |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IPAddress
Specifies one or more IP addresses for which the lease records are deleted.
| Type: | IPAddress[] |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-PassThru
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ScopeId
Specifies the scope ID, in IPv4 address format, from which the IP address leases are deleted.
| Type: | IPAddress |
| Position: | 1 |
| Default value: | None |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-ThrottleLimit
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Syntax
Remove-DhcpServerv4Lease [-PassThru] [-ComputerName <String>] -IPAddress <IPAddress[]> [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [-WhatIf] [-Confirm] [<CommonParameters>]
Remove-DhcpServerv4Lease [-PassThru] [-ComputerName <String>] [-ScopeId] <IPAddress> [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [-WhatIf] [-Confirm] [<CommonParameters>]
Remove-DhcpServerv4Lease [-PassThru] [-ComputerName <String>] [-ScopeId] <IPAddress> [-ClientId] <String[]> [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [-WhatIf] [-Confirm] [<CommonParameters>]
Remove-DhcpServerv4Lease [-PassThru] [-ComputerName <String>] [-BadLeases] [[-ScopeId] <IPAddress>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [-WhatIf] [-Confirm] [<CommonParameters>]
————EXAMPLE 1————
PS C:>Remove-DhcpServerv4Lease -ComputerName dhcpsrv.TOSSolution.com -ScopeId 192.168.10.0
This example deletes all of the IPv4 address leases inside of the scope 192.168.10.0 from the DHCP server service running on the computer named dhcpsrv.TOSSolution.com.
————EXAMPLE 2————
PS C:>Remove-DhcpServerv4Lease -ComputerName dhcpsrv.TOSSolution.com -IPAddress 192.168.10.10,192.168.20.20
This example deletes the IPv4 address leases for 192.168.10.10 and 192.168.20.20 from the DHCP server service running on the computer named dhcpsrv.TOSSolution.com.
————EXAMPLE 3————
PS C:>Remove-DhcpServerv4Lease -ComputerName dhcpsrv.TOSSolution.com -ScopeId 192.168.10.0 -ClientId 00-0C-29-00-E0-6B,00-0C-29-B7-E0-6B
This example deletes the IPv4 address leases from the DHCPv4 scope 192.168.10.0 for the clients identified by the client IDs 00-0C-29-00-E0-6B and 00-0C-29-B7-E0-6B.
————EXAMPLE 4————
PS C:>Remove-DhcpServerv4Lease -ComputerName dhcpsrv.TOSSolution.com -ScopeId 192.168.10.0 -BadLeases
This example deletes all of the bad, or declined, IPv4 address leases inside of the scope 192.168.10.0 from the DHCP server service running on the computer named dhcpsrv.TOSSolution.com.
————EXAMPLE 5————
PS C:>Get-DhcpServerv4Scope -ComputerName dhcpsrv.TOSSolution.com | Get-DhcpServerv4Lease -ComputerName dhcpsrv.TOSSolution.com –BadLeases | Remove-DhcpServerv4Lease -ComputerName dhcpsrv.TOSSolution.com -BadLeases
This example deletes all of the bad, or declined, IPv4 address leases from all of the scopes on the DHCP server service running on the computer named dhcpsrv.TOSSolution.com. The Get-DhcpServerv4Scope cmdlet returns all of the scope objects and the scope objects are piped into the Get-DhcpServerv4Lease cmdlet. The Get-DhcpServerv4Lease cmdlet returns the bad address lease objects from all the scopes and the bad address lease objects are piped into this cmdlet, which deletes all of the bad address leases.
————EXAMPLE 6————
PS C:>Get-DhcpServerv4Lease -ComputerName dhcpsrv.TOSSolution.com -ScopeId 192.168.10.0 –AllLeases | Remove-DhcpServerv4Lease -ComputerName dhcpsrv.TOSSolution.com
This example deletes all IPv4 address leases from the scope 192.168.10.0. The command works by pipelining from the first cmdlet Get-DhcpServerv4Lease cmdlet returns the IPv4 address lease objects and the IPv4 address lease objects are piped into this cmdlet, which deletes the bad address leases.
————EXAMPLE 7————
PS C:>Get-DhcpServerv4Scope -ComputerName dhcpsrv.TOSSolution.com | Remove-DhcpServerv4Lease -ComputerName dhcpsrv.TOSSolution.com
This example deletes all of the IPv4 address leases from all of the DHCPv4 scopes on the DHCP server service running on the computer named dhcpsrv.TOSSolution.com. The Get-DhcpServerv4Scope cmdlet returns the DHCPv4 scope objects and the DHCPv4 scope objects are piped into this cmdlet, which deletes each of the address leases.
You can check the Version, CommandType and Source of this cmdlet by giving below command.
Get-Command Remove-DhcpServerv4Lease
You can also read about
- Add-DhcpServerv4Lease
- Get-DhcpServerv4Lease
- Get-DhcpServerv4Scope
To know more PowerShell cmdlets(Commands) on DHCPServer click here