Remove-Dhcp Serverv4Multicast Scope

Module:
dhcpserver
Removes multicast scopes.

Syntax 

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

Description

The Remove-DhcpServerv4MulticastScope cmdlet removes the specified multicast scopes from the Dynamic Host Configuration Protocol (DHCP) server. When you remove a multicast scope, the DHCP server cannot assign the range of IP addresses to DHCP clients.

Examples

Example 1: Remove a multicast scope by using a name 

PS C:\> Remove-DhcpServerv4MulticastScope -Name "Multicast_VideoConference" -ComputerName "DhcpServer01.Contoso.com"

This command removes the multicast scope named Multicast_VideoConference from the DHCP server named DhcpServer01.Contoso.com.

Example 2: Remove a multicast scope without a confirmation 

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

This command removes the multicast scope named Multicast_AudioConference from the DHCP server named DhcpServer01.Contoso.com. The cmdlet does not prompt the user for confirmation, regardless if the scopes are active or contain active client leases.

Example 3: Remove inactive multicast scopes 

PS C:\> Get-DhcpServerv4MulticastScope | Where-Object -FilterScript { $_.State -Eq "Inactive" } | Remove-DhcpServerv4MulticastScope -Force -PassThru

This command removes all of the disabled multicast scopes on the DHCP Server service. The Get-DhcpServerv4MulticastScope cmdlet returns the multicast scope objects and passes the objects to the Where-Object cmdlet by using the pipeline operator. For more information, type Get-Help Where-Object .

The Where-Object cmdlet filters the multicast scope objects for inactive multicast scopes, and passes the objects to the Remove-DhcpServerv4MulticastScope cmdlet by using the pipeline operator. The Remove-DhcpServerv4MulticastScope cmdlet removes the inactive scopes.

Required Parameters

-Name

Specifies an array of names of multicast scopes.

Type: String[]
Position: Named
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 DNS name or IP 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
-Force

Forces the command to run without asking for user confirmation.

If you specify this parameter, the cmdlet removes the scope regardless if there are active leases in the scope.

Type: SwitchParameter
Position: Named
Default value: None
Accept pipeline input: False
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#DhcpServerv4MulticastScope[]