Set-DfsReplicationGroup
Set-DfsReplicationGroup
Modifies a replication group.
Syntax
Parameter Set: Default
Set-DfsReplicationGroup [-GroupName] <String[]> [[-Description] <String> ] [[-DomainName] <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Set-DfsReplicationGroup cmdlet modifies the configuration of existing replication groups.
A replication group is a set of servers, or members, that participate in the replication of one or more folders. A replicated folder is kept synchronized among the members of a replication group. This cmdlet cannot modify resource group bandwidth or schedules.
Parameters
-Description<String>
Specifies a description for a replication group.
Aliases |
none |
Required? |
false |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-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 |
-GroupName<String[]>
Specifies an array of names of replication groups. If you do not specify this parameter, the cmdlet queries for all participating replication groups. You can specify multiple collections, separated by commas, as well as wildcard characters (*).
Aliases |
RG,RgName |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
true |
-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.
- Microsoft.DistributedFileSystemReplication.DfsReplicationGroup
Examples
Example 1: Modify a replication group configuration
This command modifies the description of a replication group named RG01.
PS C:\> Set-DfsReplicationGroup -GroupName "RG01" -Description "Contoso Branch Office Data Collection for Backups"