Stop-SearchIndex

Last updated last month

Stops the Sitecore index.

Syntax

Stop-SearchIndex -Index <ISearchIndex>

Stop-SearchIndex [-Name <String>]

Stop-SearchIndex [-Name <String>]

Detailed Description

The Stop-SearchIndex command stops the Sitecore index.

© 2010-2017 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions

Parameters

-Index <ISearchIndex>

Aliases

Required?

true

Position?

named

Default Value

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Name <String>

The name of the index to stop.

Aliases

Required?

false

Position?

named

Default Value

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • Sitecore.ContentSearch.ISearchIndex or System.String

Outputs

The output type is the type of the objects that the cmdlet emits.

  • None

Notes

Help Author: Adam Najmanowicz, Michael West

Examples

EXAMPLE 1

The following stops the indexing process from running.
PS master:\> Stop-SearchIndex -Name sitecore_master_index

EXAMPLE 2

The following stops the indexing process from running.
PS master:\> Get-SearchIndex -Name sitecore_master_index | Stop-SearchIndex

Related Topics