Edit

Share via


Add-DatabaseToAvailabilityGroup

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

Syntax

Default

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

AllDatabases

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

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

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

Parameter properties

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

Parameter sets

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

-AssignmentCollection

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

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.

Parameter properties

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

Parameter sets

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

-DatabaseName

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

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.

Parameter properties

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

Parameter sets

Default
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-FileShare

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

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

Parameter properties

Type:String
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

-ProcessAllDatabases

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

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

Parameter properties

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

Parameter sets

AllDatabases
Position:Named
Mandatory:True
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.SharePoint.PowerShell.SPAssignmentCollection

Outputs

System.Object