Article
07/22/2014

Index of Search Server 2010 Windows PowerShell cmdlets

Applies to: Search Server 2010

Topic Last Modified: 2011-02-01

This article contains lists of Windows PowerShell cmdlets that are included with Microsoft Search Server 2010 in verb order and noun order.

In this article:

Display in verb order.
Display in noun order.

Search Server 2010 cmdlets in verb order

Cmdlet name	Description
Export-SPEnterpriseSearchTopology	Exports the topology for a shared search application.
Get-SPEnterpriseSearchAdministrationComponent	Returns the administration component for a search service application.
Get-SPEnterpriseSearchCrawlComponent	Returns a crawl component for a shared search application.
Get-SPEnterpriseSearchCrawlContentSource	Returns a crawl content source.
Get-SPEnterpriseSearchCrawlCustomConnector	Returns a CustomConnector object type.
Get-SPEnterpriseSearchCrawlDatabase	Returns a crawl store.
Get-SPEnterpriseSearchCrawlExtension	Returns the file types to be included in the content index.
Get-SPEnterpriseSearchCrawlMapping	Returns a crawl mapping for the search application.
Get-SPEnterpriseSearchCrawlRule	Accesses crawl rules.
Get-SPEnterpriseSearchCrawlTopology	Returns a crawl topology.
Get-SPEnterpriseSearchIndexPartition	Returns an index partition for a query topology.
Get-SPEnterpriseSearchLanguageResourcePhrase	Returns a language resource phrase.
Get-SPEnterpriseSearchMetadataCategory	Returns a crawled property category.
Get-SPEnterpriseSearchMetadataCrawledProperty	Returns a crawled property.
Get-SPEnterpriseSearchMetadataManagedProperty	Returns a managed property.
Get-SPEnterpriseSearchMetadataMapping	Returns the current state of a managed property mapping.
Get-SPEnterpriseSearchPropertyDatabase	Returns a property store.
Get-SPEnterpriseSearchQueryAndSiteSettingsService	Returns the search manager service.
Get-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance	Returns the service manager service instance.
Get-SPEnterpriseSearchQueryAndSiteSettingsServiceProxy	Returns the search manager service proxy.
Get-SPEnterpriseSearchQueryAuthority	Returns an authoritative page.
Get-SPEnterpriseSearchQueryComponent	Returns a query component.
Get-SPEnterpriseSearchQueryDemoted	Returns a demoted site rule.
Get-SPEnterpriseSearchQueryKeyword	Returns a keyword term.
Get-SPEnterpriseSearchQueryScope	Returns a query results scope.
Get-SPEnterpriseSearchQueryScopeRule	Returns a shared scope rule.
Get-SPEnterpriseSearchQuerySuggestionCandidates	Returns a list of queries.
Get-SPEnterpriseSearchQueryTopology	Returns a query topology.
Get-SPEnterpriseSearchRankingModel	Returns a ranking model.
Get-SPEnterpriseSearchSecurityTrimmer	Returns a custom security trimmer.
Get-SPEnterpriseSearchService	Returns the search service for a farm.
Get-SPEnterpriseSearchServiceApplication	Returns the search service application for a farm.
Get-SPEnterpriseSearchServiceApplicationProxy	Returns the search service application proxy.
Get-SPEnterpriseSearchServiceInstance	Returns the search service instance for a farm.
Get-SPEnterpriseSearchSiteHitRule	Returns the shared site hit rule.
Get-SPSearchService	Returns a Help search service (used for indexing Help content for use in Central Administration).
Get-SPSearchServiceInstance	Returns an instance of a Help search service.
New-SPEnterpriseSearchCrawlComponent	Adds a query component to a query topology.
New-SPEnterpriseSearchCrawlContentSource	Creates a new crawl content source for a shared search application.
New-SPEnterpriseSearchCrawlCustomConnector	Registers a protocol for custom crawling.
New-SPEnterpriseSearchCrawlDatabase	Creates a crawl database which can be added to a search service application.
New-SPEnterpriseSearchCrawlExtension	Adds an extension rule to a shared search application.
New-SPEnterpriseSearchCrawlMapping	Creates a crawl mapping rule for a shared search application.
New-SPEnterpriseSearchCrawlRule	Creates a new crawl rule.
New-SPEnterpriseSearchCrawlTopology	Adds a crawl topology to a shared search application.
New-SPEnterpriseSearchLanguageResourcePhrase	Adds a language resource phrase to a shared search application.
New-SPEnterpriseSearchMetadataCategory	Adds a crawled property category to a search service application.
New-SPEnterpriseSearchMetadataCrawledProperty	Adds a crawled property to a search application crawled property category.
New-SPEnterpriseSearchMetadataManagedProperty	Adds a managed property to a shared search application.
New-SPEnterpriseSearchMetadataMapping	Adds a managed property mapping to a shared search application.
New-SPEnterpriseSearchPropertyDatabase	Creates a new property store for use by a search service application.
New-SPEnterpriseSearchQueryAuthority	Adds an authoritative page to a shared search application.
New-SPEnterpriseSearchQueryComponent	Adds a query component to a query topology.
New-SPEnterpriseSearchQueryDemoted	Adds a demoted site rule to a shared search application.
New-SPEnterpriseSearchQueryKeyword	Adds a keyword term to a shared search application.
New-SPEnterpriseSearchQueryScope	Adds a query results scope to a shared search application.
New-SPEnterpriseSearchQueryScopeRule	Adds a shared scope rule to a query scope.
New-SPEnterpriseSearchQueryTopology	Adds a query topology to a shared search application.
New-SPEnterpriseSearchRankingModel	Adds a ranking model to a shared search application.
New-SPEnterpriseSearchSecurityTrimmer	Adds a custom security trimmer to a shared search application.
New-SPEnterpriseSearchServiceApplication	Adds a search service application to a farm.
New-SPEnterpriseSearchServiceApplicationProxy	Adds a new search application proxy to a farm..
New-SPEnterpriseSearchSiteHitRule	Adds a new site hit rule for a search application.
Ping-SPEnterpriseSearchContentService	Sends a request to the content distributor.
Remove-SPEnterpriseSearchCrawlComponent	Deletes a crawl component from a shared search application.
Remove-SPEnterpriseSearchCrawlContentSource	Deletes a specified crawl content source from a search application.
Remove-SPEnterpriseSearchCrawlCustomConnector	Removes a CustomConnector object.
Remove-SPEnterpriseSearchCrawlDatabase	Sets properties of a crawl database for a search service application.
Remove-SPEnterpriseSearchCrawlExtension	Removes a file name extension from the list of files that can be crawled.
Remove-SPEnterpriseSearchCrawlMapping	Deletes a crawl mapping.
Remove-SPEnterpriseSearchCrawlRule	Deletes a crawl rule.
Remove-SPEnterpriseSearchCrawlTopology	Deletes a crawl topology.
Remove-SPEnterpriseSearchLanguageResourcePhrase	Deletes a language resource phrase from a shared search application.
Remove-SPEnterpriseSearchMetadataCategory	Deletes a crawled property category.
Remove-SPEnterpriseSearchMetadataManagedProperty	Deletes a metadata managed property.
Remove-SPEnterpriseSearchMetadataMapping	Deletes a metadata mapping from a managed property.
Remove-SPEnterpriseSearchPropertyDatabase	Deletes a property store.
Remove-SPEnterpriseSearchQueryAuthority	Deletes an authoritative page.
Remove-SPEnterpriseSearchQueryComponent	Deletes a query component.
Remove-SPEnterpriseSearchQueryDemoted	Deletes a demoted site rule.
Remove-SPEnterpriseSearchQueryKeyword	Deletes a query keyword.
Remove-SPEnterpriseSearchQueryScope	Deletes a query scope.
Remove-SPEnterpriseSearchQueryScopeRule	Deletes query results scope rules.
Remove-SPEnterpriseSearchQueryTopology	Deletes a query topology.
Remove-SPEnterpriseSearchRankingModel	Deletes a ranking model.
Remove-SPEnterpriseSearchSecurityTrimmer	Deletes a custom security trimmer.
Remove-SPEnterpriseSearchServiceApplication	Deletes a search service application.
Remove-SPEnterpriseSearchServiceApplicationProxy	Deletes a search service application proxy.
Remove-SPEnterpriseSearchSiteHitRule	Deletes a site hit rule.
Remove-SPTrustedIdentityTokenIssuer	Deletes a security token service (STS) identity provider from the farm.
Restart-SPEnterpriseSearchQueryComponent	Restarts a failed query component.
Restore-SPEnterpriseSearchServiceApplication	Restores a third-party backup of a search application.
Resume-SPEnterpriseSearchServiceApplication	Resumes a search service application that was suspended.
Set-SPEnterpriseSearchAdministrationComponent	Sets properties of an administration component for a search service application.
Set-SPEnterpriseSearchCrawlContentSource	Sets the properties of a crawl content source for a shared search application.
Set-SPEnterpriseSearchCrawlDatabase	Sets properties of a crawl database for a search service application.
Set-SPEnterpriseSearchCrawlRule	Sets properties for a crawl rule.
Set-SPEnterpriseSearchCrawlTopology	Sets the properties of a crawl topology on a shared search application.
Set-SPEnterpriseSearchIndexPartition	Sets properties of an index partition for a query topology.
Set-SPEnterpriseSearchMetadataCategory	Sets properties of a crawled property category for a shared search application.
Set-SPEnterpriseSearchMetadataCrawledProperty	Sets the properties of a metadata crawled property for a shared search application.
Set-SPEnterpriseSearchMetadataManagedProperty	Sets the properties of a metadata managed property.
Set-SPEnterpriseSearchMetadataMapping	Sets the properties of a managed property mapping for a shared search application.
Set-SPEnterpriseSearchPropertyDatabase	Modifies properties for a property store.
Set-SPEnterpriseSearchQueryAuthority	Sets the properties of an authoritative page for a shared search application.
Set-SPEnterpriseSearchQueryComponent	Modifies properties for a query component.
Set-SPEnterpriseSearchQueryKeyword	Sets the properties of a keyword term for a shared search application.
Set-SPEnterpriseSearchQueryScope	Sets the properties of a query results scope for a shared search application.
Set-SPEnterpriseSearchQueryScopeRule	Sets the properties of a shared scope rule for a query scope.
Set-SPEnterpriseSearchQueryTopology	Sets the properties of a query topology for a shared search application.
Set-SPEnterpriseSearchRankingModel	Sets the properties of a ranking model for a shared search application.
Set-SPEnterpriseSearchService	Sets the properties of a search service for a farm.
Set-SPEnterpriseSearchServiceApplication	Sets the properties of a search service application for a farm.
Set-SPEnterpriseSearchServiceApplicationProxy	Sets properties of a search service application proxy.
Set-SPEnterpriseSearchServiceInstance	Sets the properties of a search service instance.
Set-SPSearchService	Sets properties of a Help search service.
Set-SPSearchServiceInstance	Sets properties of a Help search service instance.
Start-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance	Starts an instance of a search manager service.
Start-SPEnterpriseSearchServiceInstance	Starts an instance of a search service.
Stop-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance	Stops an instance of a search manager service.
Stop-SPEnterpriseSearchServiceInstance	Stops an instance of a search manager service.
Suspend-SPEnterpriseSearchServiceApplication	Suspends a search service application, pausing all crawls and search operations, to perform a task such as system maintenance.
Upgrade-SPEnterpriseSearchServiceApplication	Upgrades a search service application.

Search Server 2010 cmdlets in noun order

Cmdlet name	Description
Get-SPEnterpriseSearchAdministrationComponent	Returns the administration component for a search service application.
Set-SPEnterpriseSearchAdministrationComponent	Sets properties of an administration component for a search service application.
Ping-SPEnterpriseSearchContentService	Sends a request to the content distributor.
Get-SPEnterpriseSearchCrawlComponent	Returns a crawl component for a shared search application.
New-SPEnterpriseSearchCrawlComponent	Adds a query component to a query topology.
Remove-SPEnterpriseSearchCrawlComponent	Deletes a crawl component from a shared search application.
Get-SPEnterpriseSearchCrawlContentSource	Returns a crawl content source.
New-SPEnterpriseSearchCrawlContentSource	Creates a new crawl content source for a shared search application.
Remove-SPEnterpriseSearchCrawlContentSource	Deletes a specified crawl content source from a search application.
Set-SPEnterpriseSearchCrawlContentSource	Sets the properties of a crawl content source for a shared search application.
Get-SPEnterpriseSearchCrawlCustomConnector	Returns a CustomConnector object type.
New-SPEnterpriseSearchCrawlCustomConnector	Registers a protocol for custom crawling.
Remove-SPEnterpriseSearchCrawlCustomConnector	Removes a CustomConnector object.
Get-SPEnterpriseSearchCrawlDatabase	Returns a crawl store.
New-SPEnterpriseSearchCrawlDatabase	Creates a crawl database which can be added to a search service application.
Remove-SPEnterpriseSearchCrawlDatabase	Sets properties of a crawl database for a search service application.
Set-SPEnterpriseSearchCrawlDatabase	Sets properties of a crawl database for a search service application.
Get-SPEnterpriseSearchCrawlExtension	Returns the file types to be included in the content index.
New-SPEnterpriseSearchCrawlExtension	Adds an extension rule to a shared search application.
Remove-SPEnterpriseSearchCrawlExtension	Removes a file name extension from the list of files that can be crawled.
Get-SPEnterpriseSearchCrawlMapping	Returns a crawl mapping for the search application.
New-SPEnterpriseSearchCrawlMapping	Creates a crawl mapping rule for a shared search application.
Remove-SPEnterpriseSearchCrawlMapping	Deletes a crawl mapping.
Get-SPEnterpriseSearchCrawlRule	Accesses crawl rules.
New-SPEnterpriseSearchCrawlRule	Creates a new crawl rule.
Remove-SPEnterpriseSearchCrawlRule	Deletes a crawl rule.
Set-SPEnterpriseSearchCrawlRule	Sets properties for a crawl rule.
Get-SPEnterpriseSearchCrawlTopology	Returns a crawl topology.
New-SPEnterpriseSearchCrawlTopology	Adds a crawl topology to a shared search application.
Remove-SPEnterpriseSearchCrawlTopology	Deletes a crawl topology.
Set-SPEnterpriseSearchCrawlTopology	Sets the properties of a crawl topology on a shared search application.
Get-SPEnterpriseSearchIndexPartition	Returns an index partition for a query topology.
Set-SPEnterpriseSearchIndexPartition	Sets properties of an index partition for a query topology.
Get-SPEnterpriseSearchLanguageResourcePhrase	Returns a language resource phrase.
New-SPEnterpriseSearchLanguageResourcePhrase	Adds a language resource phrase to a shared search application.
Remove-SPEnterpriseSearchLanguageResourcePhrase	Deletes a language resource phrase from a shared search application.
Get-SPEnterpriseSearchMetadataCategory	Returns a crawled property category.
New-SPEnterpriseSearchMetadataCategory	Adds a crawled property category to a search service application.
Remove-SPEnterpriseSearchMetadataCategory	Deletes a crawled property category.
Set-SPEnterpriseSearchMetadataCategory	Sets properties of a crawled property category for a shared search application.
Get-SPEnterpriseSearchMetadataCrawledProperty	Returns a crawled property.
New-SPEnterpriseSearchMetadataCrawledProperty	Adds a crawled property to a search application crawled property category.
Set-SPEnterpriseSearchMetadataCrawledProperty	Sets the properties of a metadata crawled property for a shared search application.
Get-SPEnterpriseSearchMetadataManagedProperty	Returns a managed property.
New-SPEnterpriseSearchMetadataManagedProperty	Adds a managed property to a shared search application.
Remove-SPEnterpriseSearchMetadataManagedProperty	Deletes a metadata managed property.
Set-SPEnterpriseSearchMetadataManagedProperty	Sets the properties of a metadata managed property.
Get-SPEnterpriseSearchMetadataMapping	Returns the current state of a managed property mapping.
New-SPEnterpriseSearchMetadataMapping	Adds a managed property mapping to a shared search application.
Remove-SPEnterpriseSearchMetadataMapping	Deletes a metadata mapping from a managed property.
Set-SPEnterpriseSearchMetadataMapping	Sets the properties of a managed property mapping for a shared search application.
Get-SPEnterpriseSearchPropertyDatabase	Returns a property store.
New-SPEnterpriseSearchPropertyDatabase	Creates a new property store for use by a search service application.
Remove-SPEnterpriseSearchPropertyDatabase	Deletes a property store.
Set-SPEnterpriseSearchPropertyDatabase	Modifies properties for a property store.
Get-SPEnterpriseSearchQueryAndSiteSettingsService	Returns the search manager service.
Get-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance	Returns the service manager service instance.
Start-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance	Starts an instance of a search manager service.
Stop-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance	Stops an instance of a search manager service.
Get-SPEnterpriseSearchQueryAndSiteSettingsServiceProxy	Returns the search manager service proxy.
Get-SPEnterpriseSearchQueryAuthority	Returns an authoritative page.
New-SPEnterpriseSearchQueryAuthority	Adds an authoritative page to a shared search application.
Remove-SPEnterpriseSearchQueryAuthority	Deletes an authoritative page.
Set-SPEnterpriseSearchQueryAuthority	Sets the properties of an authoritative page for a shared search application.
Get-SPEnterpriseSearchQueryComponent	Returns a query component.
New-SPEnterpriseSearchQueryComponent	Adds a query component to a query topology.
Remove-SPEnterpriseSearchQueryComponent	Deletes a query component.
Restart-SPEnterpriseSearchQueryComponent	Restarts a failed query component.
Set-SPEnterpriseSearchQueryComponent	Modifies properties for a query component.
Get-SPEnterpriseSearchQueryDemoted	Returns a demoted site rule.
New-SPEnterpriseSearchQueryDemoted	Adds a demoted site rule to a shared search application.
Remove-SPEnterpriseSearchQueryDemoted	Deletes a demoted site rule.
Get-SPEnterpriseSearchQueryKeyword	Returns a keyword term.
New-SPEnterpriseSearchQueryKeyword	Adds a keyword term to a shared search application.
Remove-SPEnterpriseSearchQueryKeyword	Deletes a query keyword.
Set-SPEnterpriseSearchQueryKeyword	Sets the properties of a keyword term for a shared search application.
Get-SPEnterpriseSearchQueryScope	Returns a query results scope.
New-SPEnterpriseSearchQueryScope	Adds a query results scope to a shared search application.
Remove-SPEnterpriseSearchQueryScope	Deletes a query scope.
Set-SPEnterpriseSearchQueryScope	Sets the properties of a query results scope for a shared search application.
Get-SPEnterpriseSearchQueryScopeRule	Returns a shared scope rule.
New-SPEnterpriseSearchQueryScopeRule	Adds a shared scope rule to a query scope.
Remove-SPEnterpriseSearchQueryScopeRule	Deletes query results scope rules.
Set-SPEnterpriseSearchQueryScopeRule	Sets the properties of a shared scope rule for a query scope.
Get-SPEnterpriseSearchQuerySuggestionCandidates	Returns a list of queries.
Get-SPEnterpriseSearchQueryTopology	Returns a query topology.
New-SPEnterpriseSearchQueryTopology	Adds a query topology to a shared search application.
Remove-SPEnterpriseSearchQueryTopology	Deletes a query topology.
Set-SPEnterpriseSearchQueryTopology	Sets the properties of a query topology for a shared search application.
Get-SPEnterpriseSearchRankingModel	Returns a ranking model.
New-SPEnterpriseSearchRankingModel	Adds a ranking model to a shared search application.
Remove-SPEnterpriseSearchRankingModel	Deletes a ranking model.
Set-SPEnterpriseSearchRankingModel	Sets the properties of a ranking model for a shared search application.
Get-SPEnterpriseSearchSecurityTrimmer	Returns a custom security trimmer.
New-SPEnterpriseSearchSecurityTrimmer	Adds a custom security trimmer to a shared search application.
Remove-SPEnterpriseSearchSecurityTrimmer	Deletes a custom security trimmer.
Get-SPEnterpriseSearchService	Returns the search service for a farm.
Set-SPEnterpriseSearchService	Sets the properties of a search service for a farm.
Get-SPEnterpriseSearchServiceApplication	Returns the search service application for a farm.
New-SPEnterpriseSearchServiceApplication	Adds a search service application to a farm.
Remove-SPEnterpriseSearchServiceApplication	Deletes a search service application.
Restore-SPEnterpriseSearchServiceApplication	Restores a third-party backup of a search application.
Resume-SPEnterpriseSearchServiceApplication	Resumes a search service application that was suspended.
Set-SPEnterpriseSearchServiceApplication	Sets the properties of a search service application for a farm.
Suspend-SPEnterpriseSearchServiceApplication	Suspends a search service application, pausing all crawls and search operations, to perform a task such as system maintenance.
Upgrade-SPEnterpriseSearchServiceApplication	Upgrades a search service application.
Get-SPEnterpriseSearchServiceApplicationProxy	Returns the search service application proxy.
New-SPEnterpriseSearchServiceApplicationProxy	Adds a new search application proxy to a farm..
Remove-SPEnterpriseSearchServiceApplicationProxy	Deletes a search service application proxy.
Set-SPEnterpriseSearchServiceApplicationProxy	Sets properties of a search service application proxy.
Get-SPEnterpriseSearchServiceInstance	Returns the search service instance for a farm.
Set-SPEnterpriseSearchServiceInstance	Sets the properties of a search service instance.
Start-SPEnterpriseSearchServiceInstance	Starts an instance of a search service.
Stop-SPEnterpriseSearchServiceInstance	Stops an instance of a search manager service.
Get-SPEnterpriseSearchSiteHitRule	Returns the shared site hit rule.
New-SPEnterpriseSearchSiteHitRule	Adds a new site hit rule for a search application.
Remove-SPEnterpriseSearchSiteHitRule	Deletes a site hit rule.
Export-SPEnterpriseSearchTopology	Exports an existing search topology.
Import-SPEnterpriseSearchTopology	Imports and activates a topology from an XML file.
Get-SPSearchService	Returns a Help search service (used for indexing Help content for use in Central Administration).
Set-SPSearchService	Sets properties of a Help search service.
Get-SPSearchServiceInstance	Returns an instance of a Help search service.
Set-SPSearchServiceInstance	Sets properties of a Help search service instance.

Index of Search Server 2010 Windows PowerShell cmdlets

Search Server 2010 cmdlets in verb order

Search Server 2010 cmdlets in noun order

Additional resources