Stop-SPEnterpriseSearchServiceInstance
Applies to: SharePoint Server 2010
Topic Last Modified: 2010-02-11
Stops an instance of a search service.
Syntax
Stop-SPEnterpriseSearchServiceInstance [-Identity] <SearchServiceInstancePipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]]
Detailed Description
The Stop-SPEnterpriseSearchServiceInstance cmdlet stops an instance of a search service.
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. 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 |
Input Types
Return Types
Example
------------------EXAMPLE------------------
Get-SPEnterpriseSearchServiceInstance -Local | Stop-SPEnterpriseSearchServiceInstance
This example stops the local search service instance.