.png)
Restore-SPEnterpriseSearchServiceApplication
Published: July 16, 2012
Applies to: SharePoint Server 2013 Enterprise | SharePoint Server 2013 Standard
Restores third-party backup of a search application.
Restore-SPEnterpriseSearchServiceApplication [-Name] <String> -AdminSearchServiceInstance <SearchServiceInstancePipeBind> -ApplicationPool <SPIisWebServiceApplicationPoolPipeBind> -DatabaseName <String> -DatabaseServer <String> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-DatabasePassword <SecureString>] [-DatabaseUsername <String>] [-FailoverDatabaseServer <String>] [-WhatIf [<SwitchParameter>]]
Restore-SPEnterpriseSearchServiceApplication [-Name] <String> -ApplicationPool <SPIisWebServiceApplicationPoolPipeBind> -TopologyFile <String> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-KeepId <SwitchParameter>] [-WhatIf [<SwitchParameter>]]
Parameters
1Parameter | Required | Type | Description | ||
Parameter | Required | Type | Description | ||
Name | Required | System.String | Specifies the new Search application name. | ||
ApplicationPool | Required | Microsoft.SharePoint.PowerShell.SPIisWebServiceApplicationPoolPipeBind | Specifies the application pool for the query web service. | ||
AdminSearchServiceInstance | Optional | Microsoft.Office.Server.Search.Cmdlet.SearchServiceInstancePipeBind | Specifies the search service instance to be used with the administration component. | ||
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 | ||
DatabaseName | Optional | System.String | Specifies the name of the database to create for the restoring the search application. The type must be a valid name of a SQL Server database, for example, RestoreDB1. | ||
DatabasePassword | Optional | System.String | Specifies the name of the password for the database server on the SQL Server. | ||
DatabaseServer | Optional | System.String | Specifies the name of the host server for the database specified in DatabaseName. The type must be a valid SQL Server host name, for example, SQLServerHost1. | ||
DatabaseUsername | Optional | System.String | Specifies the account name that is specified in the Database Server parameter. | ||
FailoverDatabaseServer | Optional | System.String | Use this parameter if you want the administration database to use a failover database server. | ||
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 | ||
ApplicationPool | Required | Microsoft.SharePoint.PowerShell.SPIisWebServiceApplicationPoolPipeBind | Specifies the application pool for the query web service. | ||
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 | ||
Parameter | Required | Type | Description | ||
Name | Required | System.String | Specifies the new Search application name. | ||
ApplicationPool | Required | Microsoft.SharePoint.PowerShell.SPIisWebServiceApplicationPoolPipeBind | Specifies the application pool for the query web service. | ||
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 | ||
KeepId | Optional | System.Management.Automation.SwitchParameter | Specifies if the search service application ID’s from the topology .xml file should be used for the restored search service application. | ||
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 | ||
ApplicationPool | Required | Microsoft.SharePoint.PowerShell.SPIisWebServiceApplicationPoolPipeBind | Specifies the application pool for the query web service. | ||
TopologyFile | Required | System.String | Specifies the path of the .XML file that contains the application topology information. | ||
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 |
Parameters
1Parameter | Required | Type | Description | ||
Parameter | Required | Type | Description | ||
Name | Required | System.String | Specifies the new Search application name. | ||
ApplicationPool | Required | Microsoft.SharePoint.PowerShell.SPIisWebServiceApplicationPoolPipeBind | Specifies the application pool for the query web service. | ||
AdminSearchServiceInstance | Optional | Microsoft.Office.Server.Search.Cmdlet.SearchServiceInstancePipeBind | Specifies the search service instance to be used with the administration component. | ||
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 | ||
DatabaseName | Optional | System.String | Specifies the name of the database to create for the restoring the search application. The type must be a valid name of a SQL Server database, for example, RestoreDB1. | ||
DatabasePassword | Optional | System.String | Specifies the name of the password for the database server on the SQL Server. | ||
DatabaseServer | Optional | System.String | Specifies the name of the host server for the database specified in DatabaseName. The type must be a valid SQL Server host name, for example, SQLServerHost1. | ||
DatabaseUsername | Optional | System.String | Specifies the account name that is specified in the Database Server parameter. | ||
FailoverDatabaseServer | Optional | System.String | Use this parameter if you want the administration database to use a failover database server. | ||
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 | ||
ApplicationPool | Required | Microsoft.SharePoint.PowerShell.SPIisWebServiceApplicationPoolPipeBind | Specifies the application pool for the query web service. | ||
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 |
Parameter | Required | Type | Description | ||
Parameter | Required | Type | Description | ||
Name | Required | System.String | Specifies the new Search application name. | ||
ApplicationPool | Required | Microsoft.SharePoint.PowerShell.SPIisWebServiceApplicationPoolPipeBind | Specifies the application pool for the query web service. | ||
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 | ||
KeepId | Optional | System.Management.Automation.SwitchParameter | Specifies if the search service application ID’s from the topology .xml file should be used for the restored search service application. | ||
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 | ||
ApplicationPool | Required | Microsoft.SharePoint.PowerShell.SPIisWebServiceApplicationPoolPipeBind | Specifies the application pool for the query web service. | ||
TopologyFile | Required | System.String | Specifies the path of the .XML file that contains the application topology information. | ||
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 is used by third parties to create a search application that uses existing data.
Some third parties back up the application data and have to restore the application later. So, the data is restored and uses the Restore-SPEnterpriseSearchServiceApplication cmdlet to create a new search application that uses the restored data.
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.
Application Configuration Attach mode only restores configuration data that is stored in the administration database. However, Search Application Attach restores configuration, topology and all crawled data.
Input Types
Return Types
-------------EXAMPLE 1--------------
$searchInstance = Get-SPEnterpriseSearchServiceInstance –local
$applicationPool = New-SPServiceApplicationPool -Name “SearchServiceApplicationPool” -Account “domain\username”
Restore-SPEnterpriseSearchServiceApplication -Name "SearchServiceApplication" -ApplicationPool $applicationPool -AdminSearchServiceInstance $searchInstance -DatabaseName "SearchServiceApplication_Admindb" -DatabaseServer "SQLServer1"
This example uses Application Configuration Attach mode to restore configuration data.
-------------EXAMPLE 2--------------
$applicationPool = New-SPServiceApplicationPool -Name “SearchServiceApplicationPool” -Account “domain\username”
Restore-SPEnterpriseSearchServiceApplication -Name "SearchServiceApplication" -ApplicationPool $applicationPool –TopologyFile "C:\TopologyFile.xml"
This example uses Search Application Attach mode to restore topology data in the file that is named topology.xml.
Get-SPEnterpriseSearchServiceApplication
New-SPEnterpriseSearchServiceApplication
Remove-SPEnterpriseSearchServiceApplication
Resume-SPEnterpriseSearchServiceApplication
Set-SPEnterpriseSearchServiceApplication
Upgrade-SPEnterpriseSearchServiceApplication
Suspend-SPEnterpriseSearchServiceApplication
