commands

^

Suspend-DbaAgDbDataMovement

Author Chrissy LeMaire (@cl), netnerds.net
Availability Windows, Linux, macOS

 

Synopsis

Suspends data movement for an availability group database on a SQL Server instance.

Description

Suspends data movement for an availability group database on a SQL Server instance.

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.

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.

Alias
Required False
Pipeline false
Default Value
-AvailabilityGroup

The availability group where the database movement will be suspended.

Alias
Required False
Pipeline false
Default Value
-Database

The database or databases to suspend movement upon.

Alias
Required False
Pipeline false
Default Value
-InputObject

Enables piping from Get-DbaAgDatabase

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.

Alias
Required False
Pipeline false
Default Value False
-WhatIf

Shows what would happen if the command were to run. No actions are actually performed.

Alias wi
Required False
Pipeline false
Default Value
-Confirm

Prompts you for confirmation before executing any changing operations within the command.

Alias cf
Required False
Pipeline false
Default Value

 

Want to see the source code for this command? Check out Suspend-DbaAgDbDataMovement on GitHub.
Want to see the Bill Of Health for this command? Check out Suspend-DbaAgDbDataMovement.