| external help file | module name | online version | applicable | title | schema |
|---|---|---|---|---|---|
Microsoft.Office.Server.Search.dll-help.xml |
SharePointServer |
SharePoint Server Subscription Edition |
Suspend-SPEnterpriseSearchServiceApplication |
2.0.0 |
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] [-WhatIf] [<CommonParameters>]
This cmdlet reads the SearchServiceApplication object and moves it from Paused for: External Request status to Suspend status.
For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at SharePoint Server Cmdlets.
$ssa = Get-SPEnterpriseSearchServiceApplication -Identity MySSA
$ssa | Suspend-SPEnterpriseSearchServiceApplicationThis example obtains a reference to a search service application named MySSA and pauses it, stopping all crawls and other search components such as content processing components, analytics processing components and indexing components.
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.
Type: SearchServiceApplicationPipeBind
Parameter Sets: (All)
Aliases:
Applicable: SharePoint Server Subscription Edition
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseManages 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.
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.
Type: SPAssignmentCollection
Parameter Sets: (All)
Aliases:
Applicable: SharePoint Server Subscription Edition
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalsePrompts you for confirmation before executing the command.
For more information, type the following command: get-help about_commonparameters
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Applicable: SharePoint Server Subscription Edition
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseDisplays 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
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Applicable: SharePoint Server Subscription Edition
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).