Restore-SPEnterpriseSearchServiceApplicationIndex

Module:

sharepoint-server

Applies to:

SharePoint Server Subscription Edition

Restores the search index from the specified backup files.

Syntax

Restore-SPEnterpriseSearchServiceApplicationIndex
       [-SearchApplication] <SearchServiceApplication>
       [-BackupFolder] <String>
       [-AllReplicas]
       [-AllowMove]
       [[-Retries] <Int32>]
       [[-RetryPauseSeconds] <Int32>]
       [-AssignmentCollection <SPAssignmentCollection>]
       [-Confirm]
       [-WhatIf]
       [<CommonParameters>]

Restore-SPEnterpriseSearchServiceApplicationIndex
       [-SearchApplication] <SearchServiceApplication>
       [-Handle] <String>
       [[-Retries] <Int32>]
       [[-RetryPauseSeconds] <Int32>]
       [-AssignmentCollection <SPAssignmentCollection>]
       [-Confirm]
       [-WhatIf]
       [<CommonParameters>]

Description

This cmdlet contains more than one parameter set. You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. For more information about how to use parameter sets, see Cmdlet parameter sets.

This cmdlet will clear the complete search index for a specified search service application and replace it with the search index from the specified backup files.

This cmdlet supports parameter sets. The first set of parameters is for Application Configuration Attach mode and the second set of parameters is for Search Application Attach mode.

For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at SharePoint Server Cmdlets.

Examples

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

$ssa = Get-SPEnterpriseSearchServiceApplication
$handle = Restore-SPEnterpriseSearchServiceApplicationIndex -SearchApplication $ssa -BackupFolder "\\sample\backup\spbr0000"
Restore-SPEnterpriseSearchServiceApplicationIndex -SearchApplication $ssa -Handle $handle

This example starts a restore of the search index in the default search service application from a backup located at \\sample\backup\spbr0000.

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

$handle = Restore-SPEnterpriseSearchServiceApplicationIndex -SearchApplication $ssa -BackupFolder "\\sample\backup\spbr0000"
Restore-SPEnterpriseSearchServiceApplicationIndex -SearchApplication "Search Service Application" -Handle $handle

This example checks the status of the running job to restore of the search index in the search service application Search Service Application with the handle $handle .

Parameters

-AllowMove

Specifies a switch to move instead of copying files when restoring. Moving may be faster than copying.

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

-AllReplicas

Specifies a switch to restore all replicas, not just the primary.

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

-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

-BackupFolder

Specifies the full file path of the backup files.

Type:	String
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	False
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

-Handle

A handle returned from an initial call using Parameter set 1.

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

-Retries

Specifies the number of times to retry if temporary failure occurs.

Type:	Int32
Position:	5
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-RetryPauseSeconds

Seconds to pause between retries if temporary failure occurs.

Type:	Int32
Position:	6
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-SearchApplication

Specifies the search service application that contains the index files that should be restored.

Type:	SearchServiceApplication
Position:	1
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