< Back
Invoke-DbaAgFailover
Post
NAME Invoke-DbaAgFailover
SYNOPSIS
Failover an availability group.
SYNTAX
Invoke-DbaAgFailover [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
[[-SqlCredential] <Pscredential>] [[-AvailabilityGroup] <System.String[]>] [[-InputObject]
<Microsoft.SqlServer.Management.Smo.AvailabilityGroup[]>] [-Force <Switch>] [-EnableException <Switch>]
[<CommonParameters>]
DESCRIPTION
Failover an availability group.
PARAMETERS
-AvailabilityGroup [<System.String[]>]
Only failover specific availability groups.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-EnableException [<Switch>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Force [<Switch>]
Force Failover and allow data loss
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-InputObject [<Microsoft.SqlServer.Management.Smo.AvailabilityGroup[]>]
Enables piping from Get-DbaAvailabilityGroup
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlCredential [<Pscredential>]
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..
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlInstance [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
The SQL Server instance. Server version must be SQL Server version 2012 or higher.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Tags: AvailabilityGroup, HA, AG
Author: Chrissy LeMaire (@cl), netnerds.net
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- 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.
RELATED LINKS
https://dbatools.io/Invoke-DbaAgFailover
SYNOPSIS
Failover an availability group.
SYNTAX
Invoke-DbaAgFailover [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
[[-SqlCredential] <Pscredential>] [[-AvailabilityGroup] <System.String[]>] [[-InputObject]
<Microsoft.SqlServer.Management.Smo.AvailabilityGroup[]>] [-Force <Switch>] [-EnableException <Switch>]
[<CommonParameters>]
DESCRIPTION
Failover an availability group.
PARAMETERS
-AvailabilityGroup [<System.String[]>]
Only failover specific availability groups.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-EnableException [<Switch>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Force [<Switch>]
Force Failover and allow data loss
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-InputObject [<Microsoft.SqlServer.Management.Smo.AvailabilityGroup[]>]
Enables piping from Get-DbaAvailabilityGroup
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlCredential [<Pscredential>]
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..
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlInstance [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
The SQL Server instance. Server version must be SQL Server version 2012 or higher.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Tags: AvailabilityGroup, HA, AG
Author: Chrissy LeMaire (@cl), netnerds.net
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- 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.
RELATED LINKS
https://dbatools.io/Invoke-DbaAgFailover