Export (0) Print
Expand All
Expand Minimize

Suspend-SPEnterpriseSearchServiceApplication

 

Applies to: SharePoint Server 2010

Topic Last Modified: 2010-02-11

Suspends a search service application, pausing all crawls and search operations, to perform a task such as system maintenance.

Suspend-SPEnterpriseSearchServiceApplication [-Identity] <SearchServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]]

The Suspend-SPEnterpriseSearchServiceApplication cmdlet reads the SearchServiceApplication object and moves it from the Online state to the Paused for: External Request state.

 

Parameter Required Type Description

Identity

Required

Microsoft.Office.Server.Search.Cmdlet.SearchServiceApplicationPipeBind

Specifies the search service application to suspend.

The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication 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

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

$ssa = Get-SPEnterpriseSearchServiceApplication -Identity MySSA
$ssa | Suspend-SPEnterpriseSearchServiceApplication

This example obtains a reference to a search service application named MySSA and pauses it, stopping all crawls.

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