Add-DatabaseToAvailabilityGroup

Reference

Module:: SharePointServer

Applies to:: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Adds one or more SharePoint databases to a SQL Server Availability Group

Syntax

Add-DatabaseToAvailabilityGroup
   [-AGName] <String>
   [-AssignmentCollection <SPAssignmentCollection>]
   -DatabaseName <String>
   [-FileShare <String>]
   [<CommonParameters>]

Add-DatabaseToAvailabilityGroup
   [-AGName] <String>
   [-AssignmentCollection <SPAssignmentCollection>]
   [-FileShare <String>]
   [-ProcessAllDatabases]
   [<CommonParameters>]

Description

Use the Add-DatabaseToAvailabilityGroup cmdlet to add an availability group to the farm.

Examples

Example 1

Add-DatabaseToAvailabilityGroup -AGName MyAvailabilityGroup -DatabaseName WSS_Content -FileShare \\backup\share\

This example adds the database WSS_Content to the availability group named "MyAvailabilityGroup".

Example 2

Add-DatabaseToAvailabilityGroup -AGName MyAvailabilityGroup -ProcessAllDatabases -FileShare \\backup\share\

This example adds all SharePoint databases attached to the farm to the availability group named "MyAvailabilityGroup"

Parameters

-AGName

The name of the availability group from which the databases are being added.

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-AssignmentCollection

Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.

NOTE: When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.

Type:	SPAssignmentCollection
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-DatabaseName

The name of the database to be added to the availability group. Note: This parameter should not be used in conjunction with the ProcessAllDatabases parameter.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-FileShare

When a database is being added to the availability group, backup / restores are done from this location to propagate the database to all replicas.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-ProcessAllDatabases

Adds all databases from the current SharePoint farm into the availability group.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Inputs

Microsoft.SharePoint.PowerShell.SPAssignmentCollection

Outputs

System.Object

Share via