.png)
Restore-SPEnterpriseSearchServiceApplicationIndex
Published: July 16, 2012
Applies to: SharePoint Server 2013 Enterprise | SharePoint Server 2013 Standard
Restores the search index from the specified backup files.
Restore-SPEnterpriseSearchServiceApplicationIndex [-SearchApplication] <SearchServiceApplication> [-Handle] <String> [[-Retries] <Int32>] [[-RetryPauseSeconds] <Int32>] [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]]
Restore-SPEnterpriseSearchServiceApplicationIndex [-SearchApplication] <SearchServiceApplication> [-BackupFolder] <String> [[-AllReplicas] <SwitchParameter>] [[-AllowMove] <SwitchParameter>] [[-Retries] <Int32>] [[-RetryPauseSeconds] <Int32>] [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]]
Parameters
1| Parameter | Required | Type | Description | ||
| SearchApplication | Required | Microsoft.Office.Server.Search.Administration.SearchServiceApplication | Specifies the search service application that contains the index files that should be restored. | ||
| Handle | Required | System.String | A handle returned from an initial call using Parameter set 1. | ||
| Retries | Optional | System.Int32 | Specifies the number of times to retry if temporary failure occurs. | ||
| RetryPauseSeconds | Optional | System.Int32 | Seconds to pause between retries if temporary failure occurs. | ||
| 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.
| ||
| 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 |
Note: | Parameter | Required | Type | Description | ||
| SearchApplication | Required | Microsoft.Office.Server.Search.Administration.SearchServiceApplication | Specifies the search service application that contains the index files that should be restored. | ||
| BackupFolder | Required | System.String | Specifies the full file path of the backup files. | ||
| AllReplicas | Optional | System.Management.Automation.SwitchParameter | Specifies a switch to restore all replicas, not just the primary. | ||
| AllowMove | Optional | System.Management.Automation.SwitchParameter | Specifies a switch to move instead of copying files when restoring. Moving may be faster than copying. | ||
| Retries | Optional | System.Int32 | Specifies the number of times to retry if temporary failure occurs. | ||
| RetryPauseSeconds | Optional | System.Int32 | Seconds to pause between retries if temporary failure occurs. | ||
| 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.
| ||
| 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 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.
Input Types
Return Types
------------------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------------------
$ssa = Get-SPEnterpriseSearchServiceApplicationRestore-SPEnterpriseSearchServiceApplicationIndex -SearchApplication $ssa -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 .
Change History
| Date | Description |
|---|---|
| July 16, 2012 | Initial publication |
