Edit

Share via


Suspend-DfsReplicationGroup

Suspends replication between computers regardless of schedule.

Syntax

Default (Default)

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.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:ReceivingMember, RMem

Parameter sets

(All)
Position:2
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-DurationInMinutes

Specifies the number of minutes to suspend replication.

Parameter properties

Type:UInt32
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Time

Parameter sets

(All)
Position:3
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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 (*).

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:True
DontShow:False
Aliases:RG, RgName

Parameter sets

(All)
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-SourceComputerName

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:SendingMember, SMem

Parameter sets

(All)
Position:1
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.DistributedFileSystemReplication.DfsReplicationGroup

UInt

String

Outputs

Microsoft.DistributedFileSystemReplication.DfsReplicationGroup