Suspend-Dfs Replication Group

Module:
dfsr
Suspends replication between computers regardless of schedule.

Syntax 

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

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.

Examples

Example 1: Suspend replication between servers 

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

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.

Example 2: Suspend replication between servers with verbose 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.

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.

Required Parameters

-DestinationComputerName

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.

Type: String
Aliases: ReceivingMember, RMem
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-DurationInMinutes

Specifies the number of minutes to suspend replication.

Type: UInt32
Aliases: Time
Position: 3
Default value: None
Accept pipeline input: False
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 replications groups. You can use a comma separated list and the wildcard character (*).

Type: String[]
Aliases: RG, RgName
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-SourceComputerName

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

Type: String
Aliases: SendingMember, SMem
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

Optional Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Aliases: cf
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.

Type: SwitchParameter
Aliases: wi
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

Inputs

Microsoft.DistributedFileSystemReplication.DfsReplicationGroup, UInt, String

Outputs

Microsoft.DistributedFileSystemReplication.DfsReplicationGroup