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
 

Suspend-DfsReplicationGroup

Suspend-DfsReplicationGroup

dfsrpowershell.dll

Synopsis

Suspends replication between computers regardless of schedule.

Syntax

Suspend-DfsReplicationGroup [-GroupName] [-SourceComputerName] [-DestinationComputerName] [-DurationInMinutes] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Suspend-DfsReplicationGroup cmdlet suspends replication between computers, even if replication was scheduled by either a replication group or a connection.

This cmdlet ignores the schedule for a specified number of minutes. This is typically preferable to altering the schedule temporarily to prevent replication, because this cmdlet does not require Active Directory replication and LDAP polling.

Parameters

-DestinationComputerName <String>

Specifies the name of the receiving computer. A destination computer is also called an inbound or downstream computer. This computer overrides its schedule and stops inbound replication.

Aliases

ReceivingMember,RMem

Required?

true

Position

3

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

true

-DurationInMinutes <UInt32>

Specifies the number of minutes to suspend replication.

Aliases

time

Required?

true

Position

4

Default value

None

Accept pipeline input?

false

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 replications groups. You can specify multiple groups, 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

-SourceComputerName <String>

Specifies the name of the sending computer. A source computer is also called an outbound or upstream computer.

Aliases

SendingMember,SMem

Required?

true

Position

2

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-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, uint, string Computername, string Computername

Return Type

Microsoft.DistributedFileSystemReplication.DfsReplicationGroup

Notes

None

Examples

Example 1: Suspend replication between servers

This command suspends replication from server SRV01 to SRV02 in the RG01 replication group for 15 minutes, even if the replication happens during an open replication schedule.

PS C:\> Suspend-DfsReplicationGroup -GroupName "RG01" -SourceComputerName SRV01 -DestinationComputerName SRV02 -DurationInMinutes 15

Example 2: Suspend replication between servers with verbose output

This command suspends replication from server SRV01 to SRV02 in the RG01 replication group for 5 minutes, even if the replication happens during an open replication schedule, and displays output.

PS C:\> Suspend-DfsReplicationGroup -GroupName "RG01" -SourceComputerName SRV01 -DestinationComputerName SRV02 -DurationInMinutes 5 -Verbose
VERBOSE: Performing operation "Suspend-DfsReplicationGroup" on Target "SRV01".
VERBOSE: The Suspend-DfsReplicationGroup cmdlet completed successfully.

Online Version
Get-DfsReplicationGroup
New-DfsReplicationGroup
Remove-DfsReplicationGroup
Set-DfsReplicationGroup
Sync-DfsReplicationGroup