Remove-SRGroup
Removes a replication group.
Syntax
Remove-SRGroup
[[-ComputerName] <String>]
[-Name] <String>
[-Force]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Remove-SRGroup cmdlet removes a replication group. A replication group contains one or more data volumes and an associated log volume. A replication group is the container of replication.
Examples
Example 1: Remove a replication group
PS C:\>Remove-SRGroup -ComputerName "SR-SRV06" -Name "ReplicationGroup02"
Confirm
Are you sure you want to perform this action?
This action will remove group ReplicationGroup02. Are you sure you want to continue?
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
This command removes the ReplicationGroup02 replication group from computer SR-SRV06.
Example 2: Remove all replication groups
PS C:\>Get-SRGroup | Remove-SRGroup
Confirm
Are you sure you want to perform this action?
This action will remove group ReplicationGroup01. Are you sure you want to continue?
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
This command gets all replication groups on this computer by using the Get-SRGroup cmdlet. The command passes them to the current cmdlet by using the pipeline operator. The current cmdlet removes each replication group.
Parameters
-AsJob
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
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 |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ComputerName
Specifies a single replica host computer NetBIOS name or fully qualified domain name (FQDN) of the computer for which this cmdlet removes groups. The default value is the local computer.
Type: | String |
Aliases: | CN |
Position: | 0 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Force
Forces the command to run without asking for user confirmation.
Type: | SwitchParameter |
Aliases: | F |
Position: | 100 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
Specifies the name of the replication group that this cmdlet removes.
Type: | String |
Aliases: | N |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
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 |
Required: | False |
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 |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |