Remove-Dhcp Serverv4Multicast Lease

Module:
dhcpserver
Removes multicast scope leases for a multicast scope or IP address.

Syntax 

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

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.

Examples

Example 1: Remove address leases for a range of addresses 

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

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.

Example 2: Remove address leases by scope name 

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

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

Required Parameters

-Name

Specifies the name of a multicast scope.

Type: String
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

Optional 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
-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
-ComputerName

Specifies the Domain Name System (DNS) name or IP address of the target computer that runs the Dynamic Host Configuration Protocol (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 an array of IP addresses to delete.

Type: IPAddress[]
Position: 2
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
-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

Outputs

Microsoft.Management.Infrastructure.CimInstance#DhcpServerv4MulticastLease[]