Remove-DhcpServerv4MulticastScope

Remove-DhcpServerv4MulticastScope

Removes multicast scopes.

Syntax

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

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

Parameters

-AsJob

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 DNS name or IP address of the target computer that runs the DHCP Server service.

Aliases

Cn

Required?

false

Position?

named

Default Value

none

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.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Name<String[]>

Specifies an array of names of multicast scopes.

Aliases

none

Required?

true

Position?

named

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.

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

Prompts you for confirmation before running the cmdlet.

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

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

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

Example 1: Remove a multicast scope by using a name

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

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

Example 2: Remove a multicast scope without a confirmation

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.

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

Example 3: Remove inactive multicast scopes

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.

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

Get-DhcpServerv4MulticastScope

Set-DhcpServerv4MulticastScope

Add-DhcpServerv4MulticastScope

Get-DhcpServerv4MulticastScopeStatistics