Edit

Get-SPServerScaleOutDatabase

  • Reference
Module:
sharepoint-server
Applies to:
SharePoint Server Subscription Edition

Returns all scale-out database objects.

Syntax

Get-SPServerScaleOutDatabase
   -ServiceApplication <SPServiceApplicationPipeBind>
   [-AssignmentCollection <SPAssignmentCollection>]
   [-Confirm]
   [-WhatIf]
   [<CommonParameters>]

Description

Use the Get-SPServerScaleOutDatabase cmdlet to return all scale-out database objects for the specified service application.

A scale-out database is a database which implements the Shared Service Database Scale Out Generic Protocol. For more information, see SharePoint Shared Service Database Scale Out Generic Protocol Specification (https://go.microsoft.com/fwlink/p/?LinkId=273867)

Examples

----------EXAMPLE--------------

$serviceApplication = Get-SPServiceApplication -Name "AppManagement"
Get-SPServerScaleOutDatabase -ServiceApplication $serviceApplication

This example gets all scale-out databases for the given service application by using the $serviceApplication variable.

Parameters

-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.

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 Subscription Edition

-Confirm

Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-ServiceApplication

Specifies the service application of the scale-out databases.

Type:SPServiceApplicationPipeBind
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-WhatIf

Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparameters

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

Inputs

Microsoft.SharePoint.PowerShell.SPAssignmentCollection

Outputs

System.Object