Remove-DfsReplicationGroup
Remove-DfsReplicationGroup
Removes a replication group.
Syntax
Parameter Set: Default
Remove-DfsReplicationGroup [-GroupName] <String[]> [[-DomainName] <String> ] [-Force] [-RemoveReplicatedFolders] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Remove-DfsReplicationGroup cmdlet removes a replication group.
When you remove a replication group, you remove the group from Active Directory, and you also delete all associated aspects of the DFS Replication topology for that replication group, such as members, memberships, and connections. All replication halts on all members. This operation does not delete any replicated file data or private data. Use this command only when you decommission a replication group.
Parameters
-DomainName<String>
Specifies a NetBIOS or fully qualified domain name (FQDN) for an Active Directory domain that contains the replication group. If you do not specify this parameter, the cmdlet uses the current domain.
Aliases |
none |
Required? |
false |
Position? |
101 |
Default Value |
[Current Domain] |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Force
Forces the command to run without asking for user confirmation. Use this parameter for scripted removal of replication groups.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-GroupName<String[]>
Specifies an array of names of replication groups. You can specify multiple groups, separated by commas, as well as wildcard characters (*).
If the replication group contains any replicated folders, you must specify the RemoveReplicatedFolders switch parameter.
Aliases |
RG,RgName |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
true |
-RemoveReplicatedFolders
Indicates that the cmdlet removes any replicated folders belonging to the replication group prior to deleting the replication group.
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.DistributedFileSystemReplication.DfsReplicationGroup
Outputs
The output type is the type of the objects that the cmdlet emits.
- [none]
Examples
Example 1: Remove a replication group
This command removes the replication group named RG01 from the current domain.
PS C:\> Remove-DfsReplicationGroup -GroupName "RG01"
Example 2: Remove replication groups using a wildcard
This command removes all replication groups that include the pattern RG* in domain corp.contoso.com, even if the groups include replicated folders.
PS C:\> Remove-DfsReplicationGroup -GroupName "RG*" -RemoveReplicatedFolders -Domain corp.contoso.com -RemoveReplicatedFolders