dbatoolsSuspend-DbaAgDbDataMovement
View SourceSynopsis
Suspends data synchronization for availability group databases to halt replication between replicas.
Description
Temporarily halts data movement between primary and secondary replicas for specified availability group databases. This stops transaction log records from being sent to secondary replicas, which is useful during maintenance windows, troubleshooting synchronization issues, or when preparing for manual failovers. While suspended, the secondary databases will fall behind the primary and cannot be failed over to until data movement is resumed.
Syntax
Suspend-DbaAgDbDataMovement
[[-SqlInstance] <DbaInstanceParameter[]>]
[[-SqlCredential] <PSCredential>]
[[-AvailabilityGroup] <String>]
[[-Database] <String[]>]
[[-InputObject] <AvailabilityDatabase[]>]
[-EnableException]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Examples
Example: 1
PS C:\> Suspend-DbaAgDbDataMovement -SqlInstance sql2017a -AvailabilityGroup ag1 -Database db1, db2
Suspends data movement on db1 and db2 to ag1 on sql2017a. Prompts for confirmation.
Example: 2
PS C:\> Get-DbaAgDatabase -SqlInstance sql2017a, sql2019 | Out-GridView -Passthru | Suspend-DbaAgDbDataMovement -Confirm:$false
Suspends data movement on the selected availability group databases. Does not prompt for confirmation.
Optional Parameters
-SqlInstance
The target SQL Server instance or instances. Server version must be SQL Server version 2012 or higher.
| Property | Value |
|---|---|
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value |
-SqlCredential
Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential).
Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory - Integrated are all supported.
For MFA support, please use Connect-DbaInstance.
| Property | Value |
|---|---|
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value |
-AvailabilityGroup
Specifies the availability group containing the databases to suspend. Required when using SqlInstance parameter.
Use this to target databases within a specific AG when multiple availability groups exist on the instance.
| Property | Value |
|---|---|
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value |
-Database
Specifies which availability group databases to suspend data movement for. Accepts multiple database names.
Use this when you need to halt synchronization for specific databases while leaving other AG databases running normally.
| Property | Value |
|---|---|
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value |
-InputObject
Accepts availability group database objects piped from Get-DbaAgDatabase or other dbatools AG commands.
Use this for pipeline operations when you want to filter and select specific AG databases before suspending data movement.
| Property | Value |
|---|---|
| Alias | |
| Required | False |
| Pipeline | true (ByValue) |
| Default Value |
-EnableException
By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.
This avoids overwhelming you with “sea of red” exceptions, but is inconvenient because it basically disables advanced scripting.
Using this switch turns this “nice by default” feature off and enables you to catch exceptions with your own try/catch.
| Property | Value |
|---|---|
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value | False |
-WhatIf
Shows what would happen if the command were to run. No actions are actually performed.
| Property | Value |
|---|---|
| Alias | wi |
| Required | False |
| Pipeline | false |
| Default Value |
-Confirm
Prompts you for confirmation before executing any changing operations within the command.
| Property | Value |
|---|---|
| Alias | cf |
| Required | False |
| Pipeline | false |
| Default Value |
Outputs
Microsoft.SqlServer.Management.Smo.AvailabilityDatabase
Returns one AvailabilityDatabase object for each database where data movement was suspended. When suspending data movement for multiple databases, one object is returned per database.
Default display properties:
- ComputerName: The computer name of the SQL Server instance
- InstanceName: The SQL Server instance name
- SqlInstance: The full SQL Server instance name (computer\instance)
- AvailabilityGroup: Name of the availability group
- LocalReplicaRole: Role of this replica (Primary or Secondary)
- Name: Database name
- SynchronizationState: Current synchronization state (NotSynchronizing, Synchronizing, Synchronized, Reverting, Initializing)
- IsFailoverReady: Boolean indicating if the database is ready for failover
- IsJoined: Boolean indicating if the database has joined the availability group
- IsSuspended: Boolean indicating if data movement is suspended (true after suspension completes)
*Additional properties available on the SMO AvailabilityDatabase object (via Select-Object ):
- DatabaseGuid: Unique identifier for the database
- EstimatedDataLoss: Estimated data loss in seconds
- EstimatedRecoveryTime: Estimated recovery time in seconds
- FileStreamSendRate: Rate of FILESTREAM data being sent (bytes/sec)
- GroupDatabaseId: Unique identifier for the database within the AG
- LastCommitTime: Timestamp of last committed transaction
- LogSendQueue: Size of log send queue in KB
- RedoRate: Rate of redo operations (bytes/sec)