commands

^

Invoke-DbaAgFailover

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

 

Synopsis

Failover an availability group.

Description

Failover an availability group.

Syntax

Invoke-DbaAgFailover
    [[-SqlInstance] <DbaInstanceParameter[]>]
    [[-SqlCredential] <PSCredential>]
    [[-AvailabilityGroup] <String[]>]
    [[-InputObject] <AvailabilityGroup[]>]
    [-Force]
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

 

Examples

 

Example: 1
PS C:\> Invoke-DbaAgFailover -SqlInstance sql2017 -AvailabilityGroup SharePoint

Safely (no potential data loss) fails over the SharePoint AG to sql2017. Prompts for confirmation.

Example: 2
PS C:\> Get-DbaAvailabilityGroup -SqlInstance sql2017 | Out-GridView -Passthru | Invoke-DbaAgFailover -Confirm:$false

Safely (no potential data loss) fails over the selected availability groups to sql2017. Does not prompt for confirmation.

Example: 3
PS C:\> Invoke-DbaAgFailover -SqlInstance sql2017 -AvailabilityGroup SharePoint -Force

Forcefully (with potential data loss) fails over the SharePoint AG to sql2017. Prompts for confirmation.

Optional Parameters

-SqlInstance

The SQL Server instance. 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

Only failover specific availability groups.

Alias
Required False
Pipeline false
Default Value
-InputObject

Enables piping from Get-DbaAvailabilityGroup

Alias
Required False
Pipeline true (ByValue)
Default Value
-Force

Force Failover and allow data loss

Alias
Required False
Pipeline false
Default Value False
-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 Invoke-DbaAgFailover on GitHub.
Want to see the Bill Of Health for this command? Check out Invoke-DbaAgFailover.