Remove-DhcpServerv4FailoverScope
Remove-DhcpServerv4FailoverScope is accessible with the help of DHCPServer module. To configure DHCPServer, go through this link.
Synopsis
Removes the specified scopes from the failover relationship.
Description
The Remove-DhcpServerv4FailoverScope cmdlet removes the specified scopes from the failover relationship. If any specified scope that is not part of the specified failover relationship or which does not exist, then a non-terminating error will be returned. This processing will be done before adding the valid scopes to the failover relationship. This cmdlet also deletes the scopes from the partner Dynamic Host Configuration Protocol (DHCP) server service. The scopes are retained on the DHCP server service running on the computer specified in the ComputerName parameter or the local computer.
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 IPv4 or IPv6 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.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
Specifies the name of one or more failover relationships from which the scopes are removed.
Type: | String |
Position: | 1 |
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 |
-ScopeId
Specifies the scope identifier (ID), in IPv4 address format, which are removed from the failover relationship.
Type: | IPAddress[] |
Position: | 2 |
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 |
Syntax
Remove-DhcpServerv4FailoverScope [-ComputerName <String>] [-Name] <String> [-ScopeId] <IPAddress[]> [-Force] [-PassThru] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [-WhatIf] [-Confirm] [<CommonParameters>]
—————-EXAMPLE 1—————-
PS C:>Remove-DhcpServerv4FailoverScope -ComputerName dhcpsrv.TOSSolution.com -Name rel-Failover -ScopeId 192.168.10.0,192.168.20.0
This example removes the scopes 192.168.10.0 and 192.168.20.0 from the failover relationship named rel-Failover. The specified scopes are deleted from the partner DHCP server service of the failover relationship and retained only on the computer named dhcpsrv.TOSSolution.com.
You can check the Version, CommandType and Source of this cmdlet by giving below command.
Get-Command Remove-DhcpServerv4FailoverScope
You can also read about
- Add-DhcpServerv4Failover
- Add-DhcpServerv4FailoverScope
- Get-DhcpServerv4Failover
- Invoke-DhcpServerv4FailoverReplication
- Remove-DhcpServerv4Failover
- Set-DhcpServerv4Failover
To know more PowerShell cmdlets(Commands) on DHCPServer click here