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

Remove-DhcpServerv4MulticastLease

ps_dhcpserverv4multicastlease_v1.0.0.cdxml

Synopsis

Removes one or more multicast scope leases for a specified multicast scope or IP address.

Syntax

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

Detailed Description

The Remove-DhcpServerv4MulticastLease cmdlet removes one or more multicast scope leases for a specified multicast scope. Specify IP addresses to indicate which leases in the multicast scope to remove. If you do not specify the IPAddress parameter, this cmdlet removes all leases in the specified multicast scope.

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

-ComputerName <String>

Specifies the Domain Name System (DNS) name or IP address of the target computer that runs the Dynamic Host Configuration Protocol (DHCP) Server service.

Aliases

Cn

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-IPAddress <IPAddress[]>

Specifies an array of IP addresses to delete.

Aliases

None

Required?

false

Position

3

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Name <String>

Specifies the name of a multicast scope.

Aliases

None

Required?

true

Position

2

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

-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


Return Type

Microsoft.Management.Infrastructure.CimInstance#DhcpServerv4MulticastLease[]

Notes

None

Examples

EXAMPLE 1: Remove address leases for a range of addresses

This command removes the multicast IP address leases for the addresses 224.0.0.50 through 224.0.0.51. The command specifies the multicast scope Multicast_VideoConference on the computer named DhcpServer01.Contoso.com.

PS C:\> Remove-DhcpServerv4MulticastLease -Name "Multicast_VideoConference" -IPAddress 224.0.0.50,224.0.0.51 -ComputerName "DhcpServer01.Contoso.com"

Example 2: Remove address leases by scope name

This command removes all of the multicast IP address leases for the scope named Multicast_AudioConference.

PS C:\>Remove-DhcpServerv4MulticastLease -Name "Multicast_AudioConference" -ComputerName "DhcpServer01.Contoso.com"

Online Version
Get-DhcpServerv4MulticastLease