Export (0) Print
Expand All
Expand Minimize

Search cmdlets (Search Server 2010)

Search Server 2010
 

Applies to: Search Server 2010

Topic Last Modified: 2010-04-21

Search is composed of several components, all of which provide specific functionality that is required for Search to operate. These components can be configured by using Windows PowerShell cmdlets.

Administration

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.

Crawling

Cmdlet name Description

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.

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.

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.

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.


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.

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.

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.

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-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.

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.

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.

Restart-SPEnterpriseSearchQueryComponent

Restarts a failed query component.

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.

Start-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance

Starts an instance of a search manager service.

Stop-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance

Stops an instance of a search manager service.

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.

Topology

Cmdlet name Description

Import-SPEnterpriseSearchTopology

Imports and activates a topology from an XML file.

Export-SPEnterpriseSearchTopology

Exports an existing search topology.

General

Cmdlet name Description

Get-SPEnterpriseSearchIndexPartition

Returns an index partition for a query topology.

Get-SPEnterpriseSearchLanguageResourcePhrase

Returns a language resource phrase.

Get-SPEnterpriseSearchPropertyDatabase

Returns a property store.

Get-SPEnterpriseSearchSiteHitRule

Returns the shared site hit rule.

New-SPEnterpriseSearchLanguageResourcePhrase

Adds a language resource phrase to a shared search application.

New-SPEnterpriseSearchPropertyDatabase

Creates a new property store for use by a search service 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-SPEnterpriseSearchPropertyDatabase

Deletes a property store.

Remove-SPEnterpriseSearchSiteHitRule

Deletes a site hit rule.

Set-SPEnterpriseSearchIndexPartition

Sets properties of an index partition for a query topology.

Set-SPEnterpriseSearchPropertyDatabase

Modifies properties for a property store.

Microsoft FAST Search Server 2010 for SharePoint can replace SharePoint Server search features in environments where scale and performance requirements exceed the capabilities of SharePoint Server search. FAST Search Server 2010 for SharePoint can be deployed across multiple servers for redundancy and to increase performance and capacity. Deployment and management take place primarily through command-line operations — not the SharePoint Central Administration Web site — and can be scripted by using Windows PowerShell. FAST Search Server 2010 for SharePoint is only available with a SharePoint Server Enterprise Client Access License (CAL).

The following table describes the cmdlets for FAST Search Server 2010 for SharePoint.

 

Cmdlet name Description

Get-SPEnterpriseSearchExtendedConnectorProperty

Returns the value of the property of the search service application.

New-SPEnterpriseSearchExtendedConnectorProperty

Adds new Extended Connector properties.

Set-SPEnterpriseSearchExtendedConnectorProperty

Sets the value of an ExtendedConnector object.

Remove-SPEnterpriseSearchExtendedConnectorProperty

Removes properties of search service applications of ExtendedConnector type.

Set-SPEnterpriseSearchExtendedQueryProperty

Sets FAST Search for SharePoint service-specific properties.

Get-SPEnterpriseSearchExtendedQueryProperty

Returns the properties used for connecting SharePoint to a FAST Search for SharePoint service.

Get-SPEnterpriseSearchExtendedClickThroughExtractorJobDefinition

Gets an object representing the click-through extractor-job instance of a specific FAST Search for SharePoint search service application.

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