Edit

Set-DfsReplicationGroup

  • Reference
Module:
DFSR

Modifies a replication group.

Syntax

Set-DfsReplicationGroup
   [-GroupName] <String[]>
   [[-Description] <String>]
   [[-DomainName] <String>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

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.

Examples

Example 1: Modify a replication group configuration

PS C:\> Set-DfsReplicationGroup -GroupName "RG01" -Description "Contoso Branch Office Data Collection for Backups"
GroupName              : RG01
DomainName             : corp.contoso.com
Identifier             : 1f06f8d4-a0ae-4221-99d2-0bd1bb27882b
UseScheduleInLocalTime : True
UseScheduleInUtc       : False
Description            : Contoso Branch Office Data Collection for Backups

This command modifies the description of a replication group named RG01.

Parameters

-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

-Description

Specifies a description for a replication group.

Type:String
Position:1
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DomainName

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.

Type:String
Position:100
Default value:[Current Domain]
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-GroupName

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 (*).

Type:String[]
Aliases:RG, RgName
Position:0
Default value:None
Required:True
Accept pipeline input:True
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

Inputs

Microsoft.DistributedFileSystemReplication.DfsReplicationGroup

Outputs

Microsoft.DistributedFileSystemReplication.DfsReplicationGroup