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-DhcpServerv4Reservation

Remove-DhcpServerv4Reservation

ps_dhcpserverv4reservation_v1.0.0.cdxml

Synopsis

Deletes the IPv4 Reservation from the specified scope.

Syntax

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

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

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

Detailed Description

The Remove-DhcpServerv4Reservation cmdlet deletes the IPv4 reservation from the specified scope. If the ScopeId parameter is specified, then all of the reservations from the scope are deleted. If the IPAddress or ClientId parameter is specified, then one or more specific reservations identified by IP addresses or client identifiers (IDs) are deleted.

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

-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 one or more client IDs for one of more reservations which are to be deleted. For Windows clients, the MAC address is used as a client identifier.

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 Dynamic Host Configuration Protocol (DHCP) server service.

Aliases

Cn,ReservationServer

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-IPAddress <IPAddress[]>

Specifies one or more IPv4 addresses for one or more reservations which are to be deleted.

Aliases

ReservedIP

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 reservations are to be deleted.

Aliases

ReservationScopeID

Required?

true

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/DhcpServerv4Reservation
Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Scope

Return Type

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

Notes

None

Examples

EXAMPLE 1

This example deletes all of the reservations in the specified scope.

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

EXAMPLE 2

This example deletes the specified reservations from the DHCP server service.

PS C:\> Remove-DhcpServerv4Reservation -ComputerName dhcpserver.contoso.com -IPAddress 10.10.10.5, 10.10.10.6

EXAMPLE 3

This example deletes the specified reservation identified by client ID from the DHCP server service. For Windows computers, the MAC address is used as a client identifier.

PS C:\> Remove-DhcpServerv4Reservation -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -ClientId F0-DE-F1-7A-00-5E

EXAMPLE 4

This example deletes all of the reserved IP addresses 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 pipes the objects into this cmdlet, which deletes the reservations from each of the scopes passed in through the pipeline.

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

Online Version
Add-DhcpServerv4Reservation
Get-DhcpServerv4Reservation
Get-DhcpServerv4Scope
Set-DhcpServerv4Reservation