< Back
Join-DbaAvailabilityGroup
Post
NAME Join-DbaAvailabilityGroup
SYNOPSIS
Joins a secondary replica to an availability group on a SQL Server instance.
SYNTAX
Join-DbaAvailabilityGroup [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
[[-SqlCredential] <Pscredential>] [[-AvailabilityGroup] <System.String[]>] [[-ClusterType] <String>]
[[-InputObject] <Microsoft.SqlServer.Management.Smo.AvailabilityGroup[]>] [-EnableException <Switch>]
[<CommonParameters>]
DESCRIPTION
Joins a secondary replica to an availability group on a SQL Server instance.
PARAMETERS
-AvailabilityGroup [<System.String[]>]
The availability group to join.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-ClusterType [<String>]
Cluster type of the Availability Group. Only supported in SQL Server 2017 and above.
Options include: External, Wsfc or None.
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
-InputObject [<Microsoft.SqlServer.Management.Smo.AvailabilityGroup[]>]
Enables piped input 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 target SQL Server instance or instances. 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:\\>Get-DbaAvailabilityGroup -SqlInstance sql01 -AvailabilityGroup SharePoint | Join-DbaAvailabilityGroup
-SqlInstance sql02
Joins sql02 to the SharePoint availability group on sql01
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>$ag = Get-DbaAvailabilityGroup -SqlInstance sql01 -AvailabilityGroup SharePoint
PS C:\\> Join-DbaAvailabilityGroup -SqlInstance sql02 -InputObject $ag
Joins sql02 to the SharePoint availability group on sql01
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-DbaAvailabilityGroup -SqlInstance sql01 -AvailabilityGroup SharePoint | Join-DbaAvailabilityGroup
-SqlInstance sql02 -WhatIf
Shows what would happen if the command were to run. No actions are actually performed.
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Get-DbaAvailabilityGroup -SqlInstance sql01 -AvailabilityGroup SharePoint | Join-DbaAvailabilityGroup
-SqlInstance sql02 -Confirm
Prompts for confirmation then joins sql02 to the SharePoint availability group on sql01.
RELATED LINKS
https://dbatools.io/Join-DbaAvailabilityGroup
SYNOPSIS
Joins a secondary replica to an availability group on a SQL Server instance.
SYNTAX
Join-DbaAvailabilityGroup [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
[[-SqlCredential] <Pscredential>] [[-AvailabilityGroup] <System.String[]>] [[-ClusterType] <String>]
[[-InputObject] <Microsoft.SqlServer.Management.Smo.AvailabilityGroup[]>] [-EnableException <Switch>]
[<CommonParameters>]
DESCRIPTION
Joins a secondary replica to an availability group on a SQL Server instance.
PARAMETERS
-AvailabilityGroup [<System.String[]>]
The availability group to join.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-ClusterType [<String>]
Cluster type of the Availability Group. Only supported in SQL Server 2017 and above.
Options include: External, Wsfc or None.
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
-InputObject [<Microsoft.SqlServer.Management.Smo.AvailabilityGroup[]>]
Enables piped input 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 target SQL Server instance or instances. 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:\\>Get-DbaAvailabilityGroup -SqlInstance sql01 -AvailabilityGroup SharePoint | Join-DbaAvailabilityGroup
-SqlInstance sql02
Joins sql02 to the SharePoint availability group on sql01
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>$ag = Get-DbaAvailabilityGroup -SqlInstance sql01 -AvailabilityGroup SharePoint
PS C:\\> Join-DbaAvailabilityGroup -SqlInstance sql02 -InputObject $ag
Joins sql02 to the SharePoint availability group on sql01
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-DbaAvailabilityGroup -SqlInstance sql01 -AvailabilityGroup SharePoint | Join-DbaAvailabilityGroup
-SqlInstance sql02 -WhatIf
Shows what would happen if the command were to run. No actions are actually performed.
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Get-DbaAvailabilityGroup -SqlInstance sql01 -AvailabilityGroup SharePoint | Join-DbaAvailabilityGroup
-SqlInstance sql02 -Confirm
Prompts for confirmation then joins sql02 to the SharePoint availability group on sql01.
RELATED LINKS
https://dbatools.io/Join-DbaAvailabilityGroup