Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Set-DfsReplicationGroup

Set-DfsReplicationGroup

dfsrpowershell.dll

Synopsis

Modifies a replication group.

Syntax

Set-DfsReplicationGroup [-GroupName] [-DomainName] [-Description] [-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 <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

Microsoft.DistributedFileSystemReplication.DfsReplicationGroup

Return Type

Microsoft.DistributedFileSystemReplication.DfsReplicationGroup

Notes

None

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"
GroupName              : RG01
DomainName             : corp.contoso.com
Identifier             : 1f06f8d4-a0ae-4221-99d2-0bd1bb27882b
UseScheduleInLocalTime : True
UseScheduleInUtc       : False
Description            : Contoso Branch Office Data Collection for Backups

Online Version
Get-DfsReplicationGroup
New-DfsReplicationGroup
Remove-DfsReplicationGroup