Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Remove-DhcpServerv4Lease

Remove-DhcpServerv4Lease

ps_dhcpserverv4lease_v1.0.0.cdxml

Synopsis

Deletes the specified IPv4 address lease record from the Dynamic Host Configuration Protocol (DHCP) server service.

Syntax

Remove-DhcpServerv4Lease [-AsJob] [-CimSession] [-ComputerName] [-PassThru] [-ThrottleLimit] [-IPAddress] [-Confirm] [-WhatIf] [<CommonParameters>]

Remove-DhcpServerv4Lease [-ScopeId] [-AsJob] [-CimSession] [-ComputerName] [-PassThru] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Remove-DhcpServerv4Lease [-ScopeId] [-ClientId] [-AsJob] [-CimSession] [-ComputerName] [-PassThru] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Remove-DhcpServerv4Lease [-ScopeId] [-AsJob] [-CimSession] [-ComputerName] [-PassThru] [-ThrottleLimit] [-BadLeases] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed 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 <SwitchParameter>

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.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-BadLeases <SwitchParameter>

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.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

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

Aliases

Session

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ClientId <String[]>

Specifies the client ID whose IPv4 address lease is to be deleted. Windows clients use the MAC address as the client ID.

Aliases

None

Required?

true

Position

3

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-ComputerName <String>

Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service.

Aliases

Cn

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-IPAddress <IPAddress[]>

Specifies one or more IP addresses for which the lease records are deleted.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-PassThru <SwitchParameter>

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ScopeId <IPAddress>

Specifies the scope ID, in IPv4 address format, from which the IP address leases are deleted.

Aliases

None

Required?

false

Position

2

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-ThrottleLimit <Int32>

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.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Lease
Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Reservation
Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Scope

Return Type

Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Lease[]

Notes

None

Examples

EXAMPLE 1

This example deletes all of the IPv4 address leases inside of the scope 10.10.10.0 from the DHCP server service running on the computer named dhcpserver.contoso.com.

PS C:\>Remove-DhcpServerv4Lease -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0

EXAMPLE 2

This example deletes the IPv4 address leases for 10.10.10.10 and 20.20.20.20 from the DHCP server service running on the computer named dhcpserver.contoso.com.

PS C:\>Remove-DhcpServerv4Lease -ComputerName dhcpserver.contoso.com -IPAddress 10.10.10.10,20.20.20.20

EXAMPLE 3

This example deletes the IPv4 address leases from the DHCPv4 scope 10.10.10.0 for the clients identified by the client IDs F0-DE-F1-7A-00-5E and 00-24-D7-C5-25-B0.

PS C:\>Remove-DhcpServerv4Lease -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -ClientId F0-DE-F1-7A-00-5E,00-24-D7-C5-25-B0

EXAMPLE 4

This example deletes all of the bad, or declined, IPv4 address leases inside of the scope 10.10.10.0 from the DHCP server service running on the computer named dhcpserver.contoso.com.

PS C:\>Remove-DhcpServerv4Lease -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -BadLeases

EXAMPLE 5

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

PS C:\>Get-DhcpServerv4Scope -ComputerName dhcpserver.contoso.com | Get-DhcpServerv4Lease -ComputerName dhcpserver.contoso.com –BadLeases | Remove-DhcpServerv4Lease -ComputerName dhcpserver.contoso.com -BadLeases

EXAMPLE 6

This example deletes all IPv4 address leases from the scope 10.10.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.

PS C:\>Get-DhcpServerv4Lease -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 –AllLeases | Remove-DhcpServerv4Lease -ComputerName dhcpserver.contoso.com

EXAMPLE 7

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

PS C:\>Get-DhcpServerv4Scope -ComputerName dhcpserver.contoso.com | Remove-DhcpServerv4Lease -ComputerName dhcpserver.contoso.com

Online Version
Add-DhcpServerv4Lease
Get-DhcpServerv4Lease
Get-DhcpServerv4Scope