Suspend-StorageGroupCopy

Article
09/29/2015

Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3

Use the Suspend-StorageGroupCopy cmdlet to block replication and replay activities (log copying and replay) for a storage group that is enabled for local continuous replication (LCR), cluster continuous replication (CCR) or standby continuous replication (SCR).

Syntax

Suspend-StorageGroupCopy -Identity <StorageGroupIdParameter> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-ExecutionTimeout <Int32>] [-StandbyMachine <String>] [-SuspendComment <String>] [-WhatIf [<SwitchParameter>]]

Detailed Description

An Exchange administrator may periodically need to suspend replication and replay activities on a server. The administrator may want to do this to perform an administrative action or to permit data reconfiguration on the server.

To successfully initiate a Suspend-StorageGroupCopy operation, the following conditions must be true:

The storage group must be enabled for LCR, CCR, or SCR.
The user must use an account that is delegated Exchange Server Administrator role and local Administrators group for the target server. For more information about permissions, delegating roles, and the rights that are required to administer Exchange 2007, see Permission Considerations.

After a Suspend-StorageGroupCopy operation has completed, the following occurs:

There is no further input/output (I/O) activity on the storage group copy.
The storage group copy is suspended and reports a suspended status.
An event is recorded in the event log stating a specific reason.

If the task is run when the storage group copy is already suspended, no error is generated. This task can be run remotely.

Parameters

Parameter	Required	Type	Description
Identity	Required	Microsoft.Exchange.Configuration.Tasks.StorageGroupIdParameter	The Identity parameter takes one of the following values: GUID Name of the storage group
DomainController	Optional	Microsoft.Exchange.Data.Fqdn	The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that locates the clustered mailbox server in the Active Directory directory service.
StandbyMachine	Optional	System.String	The StandbyMachine parameter specifies the name of the server on which the SCR target is being suspended. This parameter must be used when suspending an SCR target. If this parameter is not specified, the LCR or CCR copy for the specified storage group will be suspended.
SuspendComment	Optional	System.String	The SuspendComment parameter specifies the reason that the replay or copy of log files was suspended. This parameter is limited to 512 characters.
Confirm	Optional	System.Management.Automation.SwitchParameter	The Confirm parameter causes the command to pause processing and requires the administrator to acknowledge what the command will do before processing continues. The default value is $true.
ExecutionTimeout	Optional	System.Int32	The ExecutionTimeout parameter specifies the maximum amount of time that this task can run before the test is determined to be a failure. If no test message or delivery report arrives before this time expires, the task ends, and an error is reported.
WhatIf	Optional	System.Management.Automation.SwitchParameter	The WhatIf parameter instructs the command to simulate the actions that it would take on the object. By using the WhatIf parameter, the administrator can view what changes would occur without having to apply any of those changes. The default value is $true.

Errors

Error Description

Error	Description
`Continous replication is not configured on <StorageGroupName>.`	This task cannot be used on a storage group that is not using LCR, CCR, or SCR.
`Server '<CMSName>' is not available. The cluster may be unavailable or a communication problem may exist. This task cannot complete without communicating with the cluster.`	The task was unable to connect to the cluster due to a communication issue or because the cluster is not available. This may be because the node is unavailable, the node is available and the cluster is unavailable, or the computer being used cannot access a node or computer.
`The Mailbox role is not configured on node <Node>.`	The Mailbox server role is not installed on this node.

Continous replication is not configured on <StorageGroupName>.

This task cannot be used on a storage group that is not using LCR, CCR, or SCR.

Server '<CMSName>' is not available. The cluster may be unavailable or a communication problem may exist. This task cannot complete without communicating with the cluster.

The task was unable to connect to the cluster due to a communication issue or because the cluster is not available.

This may be because the node is unavailable, the node is available and the cluster is unavailable, or the computer being used cannot access a node or computer.

The Mailbox role is not configured on node <Node>.

The Mailbox server role is not installed on this node.

Example

The first example shows how to suspend replication activities for a storage group named SG1 on server MBXSVR1 while the log files are moved to a new location. If you have more than one server, you must specify the server within the Identity parameter as shown in the first example. If you only have one server, you do not need to specify the server.

The second example shows how to suspend replication activities for an SCR target on SERVER2 for a storage group named SG1.

Suspend-StorageGroupCopy -Identity MBXSVR1\SG1 -SuspendComment "Moving log files to new location"
Suspend-StorageGroupCopy -Identity SG1 -StandbyMachine SERVER2