Share via

Join-SqlAvailabilityGroup

Module:
SQLPS Module

Joins the local secondary replica to an availability group.

Syntax

ByPath (Default) 

Join-SqlAvailabilityGroup
    [-Name] <String>
    [[-Path] <String>]
    [-Script]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByObject 

Join-SqlAvailabilityGroup
    [-Name] <String>
    [-InputObject] <Server>
    [-Script]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Join-SqlAvailabilityGroup cmdlet joins the local secondary replica to an availability group. Run this cmdlet on an instance of SQL Server that hosts a secondary replica that is not joined to the availability group.

Examples

Example 1: Join a secondary replica to an availability group

PS C:\> Join-SqlAvailabilityGroup -Path "SQLSERVER:\SQL\SecondaryServer\InstanceName" -Name "MainAG"

This command joins a secondary replica to the availability group named MainAG. This server instance must host a secondary replica in this availability group.

Example 2: Create a script that joins a secondary replica to an availability group

PS C:\> Join-SqlAvailabilityGroup -Path "SQLSERVER:\SQL\SecondaryServer\InstanceName" -Name "MainAG" -Script

This command creates a Transact-SQL script that joins a secondary replica to the availability group named MainAG.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

Specifies the server that hosts the instance of SQL Server that hosts the secondary replica that this cmdlet joins to the availability group.

Parameter properties

Type:Server
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByObject
Position:3
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

Specifies the name of the availability group to which this cmdlet joins a secondary replica.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:2
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Path

Specifies the path of the instance of SQL Server that hosts the secondary replica that this cmdlet joins to the availability group. If you do not specify this parameter, this cmdlet uses current working location.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByPath
Position:3
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Script

Indicates that this cmdlet returns a Transact-SQL script that performs the task that this cmdlet performs.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.SqlServer.Management.Smo.Server

You can pass a server instance to this cmdlet.

Notes

  • The high availability data recovery service must be enabled on the server instance. The availability replica specified by the Path parameter must exist.