Suspend-DfsReplicationGroup
Suspend-DfsReplicationGroup
Suspends replication between computers regardless of schedule.
Syntax
Parameter Set: Default
Suspend-DfsReplicationGroup [-GroupName] <String[]> [-SourceComputerName] <String> [-DestinationComputerName] <String> [-DurationInMinutes] <UInt32> [-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? |
false |
-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.
Aliases |
RG,RgName |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
false |
-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
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, uint, string Computername, string Computername
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.DistributedFileSystemReplication.DfsReplicationGroup
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