Remove-DhcpServerv4Scope
Remove-DhcpServerv4Scope
Deletes the specified IPv4 scopes from the Dynamic Host Configuration Protocol (DHCP) server service.
Syntax
Parameter Set: Remove2
Remove-DhcpServerv4Scope [-ScopeId] <IPAddress[]> [-AsJob] [-CimSession <CimSession[]> ] [-ComputerName <String> ] [-Force] [-Passthru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Remove-DhcpServerv4Scope cmdlet deletes the specified IPv4 scopes from the Dynamic Host Configuration Protocol (DHCP) server service.
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 |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ComputerName<String>
Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Force
Deletes the scope even if active leases exist in the scope.
Aliases |
none |
Required? |
false |
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ScopeId<IPAddress[]>
Specifies one or more scope identifiers (IDs), in IPv4 address format, to be deleted.
Aliases |
none |
Required? |
true |
Position? |
1 |
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
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.
Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Scope[]
The
Microsoft.Management.Infrastructure.CimInstanceobject is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.
Outputs
The output type is the type of the objects that the cmdlet emits.
Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Scope[]
The
Microsoft.Management.Infrastructure.CimInstanceobject is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.
Examples
EXAMPLE 1
This example deletes the specified scopes from the DHCP server service.
PS C:\> Remove-DhcpServerv4Scope -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0, 20.20.20.0
EXAMPLE 2
This example deletes the specified scopes from the DHCP server service. This cmdlet does not prompt the user for confirmation even if the scopes are active or contain active client leases.
PS C:\> Remove-DhcpServerv4Scope -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0, 20.20.20.0 -Force
EXAMPLE 3
This example deletes all of the disabled scopes on the DHCP server service. The Get-DhcpServerv4Scope cmdlet returns the scope objects and pipes the scope objects into the Where-Object cmdlet. The Where-Object cmdlet returns the scope objects which are filtered for the state being InActive, or disabled, and pipes the filtered scope objects into this cmdlet, which deletes the disabled scopes passed through the pipeline.
PS C:\> Get-DhcpServerV4Scope | Where-Object –FilterScript { $_.State -Eq "Inactive" } | Remove-DhcpServerv4Scope -Force -Passthru