TechNet
Export (0) Print
Expand All
Collapse the table of content
Expand the table of content
Expand Minimize

Use Windows PowerShell cmdlets to administer and configure search in SharePoint 2013

Last modified: April 14, 2016

Applies to: SharePoint Server 2013

Search is composed of several components, all of which provide specific functionality that is required for Search to operate. The following tables show the Windows PowerShell cmdlets that you can use to configure these Search components and manage Search operations for a SharePoint farm.

Index of Windows PowerShell cmdlets for SharePoint 2013 includes a complete list of all cmdlets in SharePoint 2013.

Administration

Cmdlet name Description
Get-SPEnterpriseSearchStatus Retrieves diagnostics information for the search components.
New-SPEnterpriseSearchAdminComponent Creates a new admin component for the given topology and search service instance.

Crawling

Cmdlet name Description
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.
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.
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.
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-SPEnterpriseSearchCrawlLogReadPermission Grants users permission to view the crawl log information.
Get-SPEnterpriseSearchCrawlLogReadPermission Retrieves the list of users which have permission to access the crawl log information.
Remove-SPEnterpriseSearchCrawlLogReadPermission Removes permission to view crawl log information.
Set-SPEnterpriseSearchDCTMConnectorConfig Configures the Microsoft SharePoint 2013 Indexing Connector for Documentum.

Service Application

Cmdlet name Description
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.
New-SPEnterpriseSearchServiceApplication Adds a search service application to a farm.
New-SPEnterpriseSearchServiceApplicationProxy Adds a new search application proxy to a farm..
Remove-SPEnterpriseSearchServiceApplication Deletes a search service application.
Remove-SPEnterpriseSearchServiceApplicationProxy Deletes a search service application proxy.
Restore-SPEnterpriseSearchServiceApplication Restores a third-party backup of a search application.
Resume-SPEnterpriseSearchServiceApplication Resumes a search service application that was suspended.
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.
Start-SPEnterpriseSearchServiceInstance Starts an instance of a search 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.
Backup-SPEnterpriseSearchServiceApplicationIndex Takes a backup of the search index to a specified backup location.
Upgrade-SPEnterpriseSearchServiceApplicationSiteSettings Upgrades search settings for a particular site collection.
Restore-SPEnterpriseSearchServiceApplicationIndex Restores the search index from the specified backup files.
Remove-SPEnterpriseSearchServiceApplicationSiteSettings Cleans up search settings for a particular site collection, subscription, or search application.
Get-SPEnterpriseSearchOwner Returns the search object owner.

Querying

Cmdlet name Description
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-SPEnterpriseSearchQueryDemoted Returns a demoted site rule.
Get-SPEnterpriseSearchQueryKeyword Returns a keyword term.
Get-SPEnterpriseSearchQuerySuggestionCandidates Returns a list of queries.
Get-SPEnterpriseSearchRankingModel Returns a ranking model.
Get-SPEnterpriseSearchSecurityTrimmer Returns a custom security trimmer.
New-SPEnterpriseSearchQueryAuthority Adds an authoritative page to a shared search application.
New-SPEnterpriseSearchQueryDemoted Adds a demoted site rule to a shared search application.
New-SPEnterpriseSearchQueryKeyword Adds a keyword term 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.
Remove-SPEnterpriseSearchQueryAuthority Deletes an authoritative page.
Remove-SPEnterpriseSearchQueryDemoted Deletes a demoted site rule.
Remove-SPEnterpriseSearchQueryKeyword Deletes a query keyword.
Remove-SPEnterpriseSearchRankingModel Deletes a ranking model.
Remove-SPEnterpriseSearchSecurityTrimmer Deletes a custom security trimmer.
Set-SPEnterpriseSearchQueryAuthority Sets the properties of an authoritative page for a shared search application.
Set-SPEnterpriseSearchRankingModel Sets the properties of a ranking model for a shared search application.
Start-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance Starts an instance of a search manager service.
Stop-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance Stops an instance of a search manager service.
Import-SPEnterpriseSearchPopularQueries Sets properties of a result item type.
Set-SPEnterpriseSearchResultItemType Sets properties of a result item type.
Set-SPEnterpriseSearchQuerySpellingCorrection Sets the operation status of the Query Spelling Corrections (QSC) component.
Remove-SPEnterpriseSearchResultItemType Creates a new result item type.
New-SPEnterpriseSearchResultItemType Creates a new Result Type.
Import-SPEnterpriseSearchThesaurus Deploys the dictionary to the thesaurus component in the query processing flow.
Get-SPEnterpriseSearchResultItemType Returns result item types.
Get-SPEnterpriseSearchQuerySpellingCorrection Returns the object that exposes the Query Spelling Correction (QSC) configuration.
Get-SPEnterpriseSearchResultSource Retrieves a result source.
New-SPEnterpriseSearchResultSource Creates a new result source.
Remove-SPEnterpriseSearchResultSource Deletes a result source.
Set-SPEnterpriseSearchResultSource Sets properties of a result source.

Metadata

Cmdlet name Description
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.
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.
Remove-SPEnterpriseSearchMetadataCategory Deletes a crawled property category.
Remove-SPEnterpriseSearchMetadataManagedProperty Deletes a metadata managed property.
Remove-SPEnterpriseSearchMetadataMapping Deletes a metadata mapping from a managed property.
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.
Get-SPEnterpriseSearchPropertyRuleCollection Returns the collection of rules that are applied to search results.
Get-SPEnterpriseSearchPropertyRule Returns a property rule.

Topology

Cmdlet name Description
Import-SPEnterpriseSearchTopology Imports and activates a topology from an XML file.
Export-SPEnterpriseSearchTopology Exports an existing search topology.
Set-SPEnterpriseSearchTopology Activates a given search topology.
Remove-SPEnterpriseSearchTopology Removes an inactive search topology from a search service application.
Remove-SPEnterpriseSearchComponent Removes the specified search component from the given search topology.
New-SPEnterpriseSearchTopology Creates a new search topology in the given search service application.
New-SPEnterpriseSearchQueryProcessingComponent Creates a new query processing component for the given topology and search service instance.
New-SPEnterpriseSearchIndexComponent Creates a new index component for the given topology and search service instance.
New-SPEnterpriseSearchContentProcessingComponent Creates a new content processing component for the given topology and search service instance.
Get-SPEnterpriseSearchTopology Retrieves one or all search topologies that belong to a given search service application.

General

Cmdlet name Description
Get-SPEnterpriseSearchLanguageResourcePhrase Returns a language resource phrase.
Get-SPEnterpriseSearchSiteHitRule Returns the shared site hit rule.
New-SPEnterpriseSearchLanguageResourcePhrase Adds a language resource phrase to a shared search application.
New-SPEnterpriseSearchSiteHitRule Adds a new site hit rule for a search application.
Remove-SPEnterpriseSearchLanguageResourcePhrase Deletes a language resource phrase from a shared search application.
Remove-SPEnterpriseSearchSiteHitRule Deletes a site hit rule.
Get-SPEnterpriseSearchVssDataPath Retrieves the index paths for all active search index components on the current server.
Get-SPEnterpriseSearchContentEnrichmentConfiguration Returns the content enrichment configuration for the specified search service application.
Set-SPEnterpriseSearchPrimaryHostController Sets the primary search host controller for the farm.
Set-SPEnterpriseSearchLinguisticComponentsStatus Sets the operation status of the linguistic query and document processing components.
Set-SPEnterpriseSearchContentEnrichmentConfiguration Stores the specified content enrichment configuration to the search service application.
Remove-SPEnterpriseSearchContentEnrichmentConfiguration Removes the current content enrichment configuration from the search service application.
New-SPEnterpriseSearchContentEnrichmentConfiguration Creates a new ContentEnrichmentConfiguration object.
Get-SPEnterpriseSearchLinguisticComponentsStatus Returns the status of the linguistic query and document processing components.
Get-SPEnterpriseSearchHostController Lists the specified or all search host controllers in the farm.
Set-SPEnterpriseSearchLinksDatabase Sets properties of a links database for a search service application.
Repartition-SPEnterpriseSearchLinksDatabases Obsolete. For replacement, see Repartition-SPEnterpriseSearchLinksDatabases
Move-SPEnterpriseSearchLinksDatabases Repartitions data across links databases.
Remove-SPEnterpriseSearchTenantSchema Removes a defined search schema.
Remove-SPEnterpriseSearchTenantConfiguration Removes all tenant specific search settings.
Remove-SPEnterpriseSearchLinksDatabase Deletes a links database.
Remove-SPEnterpriseSearchFileFormat Remove a previously registered file format from the system.
New-SPEnterpriseSearchLinksDatabase Creates a new links database for a search service application.
New-SPEnterpriseSearchFileFormat Adds a new file format in the parsing system.
New-SPEnterpriseSearchAnalyticsProcessingComponent Creates a new analytics processing component for the given topology and search service instance.
Import-SPEnterpriseSearchCustomExtractionDictionary Imports a custom extraction dictionary.
Get-SPEnterpriseSearchLinksDatabase Retrieves a reference to a links database.
Get-SPEnterpriseSearchFileFormat Retrieves all parseable file formats.
Set-SPEnterpriseSearchFileFormatState Enables or disables parsing of a given file format.
Get-SPEnterpriseSearchComponent Retrieves one or all search components in a given search topology.
Get-SPEnterpriseSearchServiceApplicationBackupStore Retrieves information about the search service application backup files.

Index of Windows PowerShell cmdlets for SharePoint 2013

Show:
© 2016 Microsoft