Export (0) Print
Expand All
Expand Minimize

Stop-SPEnterpriseSearchServiceInstance

Published: July 16, 2012

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

Stops an instance of a search service.

Stop-SPEnterpriseSearchServiceInstance [-Identity] <SearchServiceInstancePipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]]

Parameters

Parameter Required Type Description

Identity

Required

Microsoft.Office.Server.Search.Cmdlet.SearchServiceInstancePipeBind

Specifies the shared search service instance to stop.

The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a query server (for example, MyQueryServer); or an instance of a valid SearchServiceInstance object.

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.

noteNote:

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 stops an instance of a search service.

noteNote:

Before you can stop a search service instance, you must remove all search topology components on the associated server from the active topology. This can be done in three ways:

- Removing components from the search topology. If there are items in the search index, see Manage search components in SharePoint Server 2013 and Manage the index component in SharePoint Server 2013. If there are no items in the search index, see Change the default search topology in SharePoint Server 2013.

- Moving components to another server. If there are items in the search index, see Manage search components in SharePoint Server 2013 and Manage the index component in SharePoint Server 2013. If there are no items in the search index, see Change the default search topology in SharePoint Server 2013.

- Removing the search service application. For more information, see Remove-SPEnterpriseSearchServiceApplication

Input Types

Return Types

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

Get-SPEnterpriseSearchServiceInstance -Local | Stop-SPEnterpriseSearchServiceInstance

This example stops the local search service instance.

Change History

Date Description

July 16, 2012

Initial publication

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft