This topic has not yet been rated - Rate this topic

Get-SPEnterpriseSearchServiceApplicationBackupStore

SharePoint 2013

Published: July 16, 2012

Applies to: SharePoint Server 2013 Enterprise | SharePoint Server 2013 Standard

Retrieves information about the Search service application backup files.

Get-SPEnterpriseSearchServiceApplicationBackupStore [-BackupFolder] <String> [-Name] <String> [[-BackupId] <String>] [[-UseMostRecent] <SwitchParameter>] [[-IsVerbose] <SwitchParameter>] [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]]

Parameters

Parameter

Required

Type

Description

BackupFolder

Required

System.String

Specifies the full file path of the backup files.

Name

Required

System.String

Specifies the name of the Search service application from which to retrieve the related backup information.

BackupId

Optional

System.String

Specifies the GUID of the backup in the referred package.

UseMostRecent

Optional

System.Management.Automation.SwitchParameter

A switch to specify if the most recent backup should be used.

IsVerbose

Optional

System.Management.Automation.SwitchParameter

A switch to specify if messages should be printed out when the cmdlet is running.

AssignmentCollection

Optional

Microsoft.SharePoint.PowerShell.SPAssignmentCollection

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.

Confirm

Optional

System.Management.Automation.SwitchParameter

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

WhatIf

Optional

System.Management.Automation.SwitchParameter

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

Detailed Description

This cmdlet returns information about the search databases and index files in a specified Search service application backup location.

Input Types

Return Types

Example

------------------EXAMPLE 1-----------------

Get-SPEnterpriseSearchServiceApplicationBackupStore –BackupFolder \\sample\backup -Name "Search Service Application" -BackupId 3222ad97-91ad-471f-a764-780ec1f05f74

This example retrieves the backup of the search databases and index files that are located at \\sample\backup with the backup id 3222ad97-91ad-471f-a764-780ec1f05f74 from the Search service application Search Service Application.

------------------EXAMPLE 2-----------------

Get-SPEnterpriseSearchServiceApplicationBackupStore –BackupFolder \\sample\backup -Name "Search Service Application" -UseMostRecent

This example retrieves the most recently taken backup of the search databases and index files that are located at \\sample\backup from the Search service application Search Service Application.

Change History

Date	Description
July 16, 2012	Initial publication

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)