Join-SqlAvailabilityGroup

SYNOPSIS

Joins the local secondary replica to an availability group.

SYNTAX

ByPath (Default)

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

ByObject

Join-SqlAvailabilityGroup [-Name] <String> [-InputObject] <Server> [-Script]
 [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-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

-Name

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

Type: String
Parameter Sets: (All)
Aliases: 

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: 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.

Type: String
Parameter Sets: ByPath
Aliases: 

Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Script

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-InformationAction

Specifies how this cmdlet responds to an information event.

The acceptable values for this parameter are:

  • Continue
  • Ignore
  • Inquire
  • SilentlyContinue
  • Stop
  • Suspend
Type: ActionPreference
Parameter Sets: (All)
Aliases: infa

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-InformationVariable

Specifies an information variable.

Type: String
Parameter Sets: (All)
Aliases: iv

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: 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.

Type: Server
Parameter Sets: ByObject
Aliases: 

Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

Microsoft.SqlServer.Management.Smo.Server

You can pass a server instance to this cmdlet.

OUTPUTS

NOTES

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

New-SqlAvailabilityGroup

Remove-SqlAvailabilityGroup

Set-SqlAvailabilityGroup

Switch-SqlAvailabilityGroup

Test-SqlAvailabilityGroup