Administration cmdlets (FAST Search Server 2010 for SharePoint)

 

Applies to: FAST Search Server 2010

Administration cmdlets provide control over the search system. This functionality is in addition to the search configuration tasks that you can complete with the management pages in Central Administration. Common Windows PowerShell tasks include managing configuration files and binary resources, and managing content collections.

In this section:

• Manage resource stores

• Manage search setting groups

• Manage content collections

• Manage search scopes

Manage resource stores

The FAST Search Server 2010 for SharePoint resource store is a centralized file storage area for compiled dictionaries used in search tasks such as spell checking and stemming. The resource store controls the updating and propagation of these files across FAST Search Server 2010 for SharePoint servers. You can move local files to and from the resource store with these cmdlets.

Resource cmdlets

Note

To use the cmdlets, verify that you meet the following minimum requirements: You are a member of the FASTSearchAdministrators local group on the computer where FAST Search Server 2010 for SharePoint is installed.

Use these cmdlets to manage your resource files:

Task	Cmdlet
Upload a local resource to the FAST Search Server 2010 for SharePoint resource store	Add-FASTSearchResource
Download a resource from the FAST Search Server 2010 for SharePoint resource store	Get-FASTSearchResource
Delete a file from the FAST Search Server 2010 for SharePoint resource store	Remove-FASTSearchResource

Manage search setting groups

A search setting group is a collection of keywords, search settings, and user contexts. Keywords can be associated with search settings which determine how a query for a keyword is transformed before the query is executed. A search setting can be a synonym, Best Bet, Visual Best Bet, document promotion, or document demotion. For example, you could have a “product_terms” search setting group that includes keywords specific to a newly released software product. Every time that a user searches for one of those keywords, a Visual Best Bet banner could display, offering a trial copy of the product. A search setting can also be associated with a specific user context (a subset of users grouped by a common attribute in their SharePoint user profiles, such as an employee’s department), to target the search settings to a specific audience or special interest group. For example, the new product banner could be displayed only for non-employees, to provide a personalized search experience for different groups of users.

To use search setting groups, first define new keywords at Site Settings > Site Collection Administration > FAST Search keywords. Associate synonyms, Best Bets, Visual Best Bets, document promotions, or document demotions with specific keywords on the FAST Search keywords page. Create user contexts on the Manage User Context page, accessed from Site Settings > Site Collection Administration. You can associate a user context with a specific keyword’s search setting on the FAST Search keywords page. Finally, use the New-FASTSearchSearchSettingGroup cmdlet to name search setting groups and to associate keywords with those groups.

Note

You will rarely have to use the search setting group cmdlets. Usually, there is a one-to-one correspondence between site collections in SharePoint and search setting groups in FAST Search Server 2010 for SharePoint, created automatically by the SharePoint front-end.

Search setting group cmdlets

Note

To use the cmdlets, verify that you meet the following minimum requirements: You are a member of the FASTSearchAdministrators local group on the computer where FAST Search Server 2010 for SharePoint is installed.

Use these cmdlets to manage search setting groups:

Task	Cmdlet
Retrieve one or all FAST Search Server 2010 for SharePoint search setting groups	Get-FASTSearchSearchSettingGroup
Create a search setting group	New-FASTSearchSearchSettingGroup
Delete a search setting group	Remove-FASTSearchSearchSettingGroup

Manage content collections

A content collection is a group of items crawled by an indexing connector and stored in a search index for inclusion in a FAST Search Server 2010 for SharePoint search system. Each content collection is associated with a content source (e.g., SharePoint, Lotus Notes, etc.). When you use the integrated indexing connectors, you must have one collection per connector instance (FAST Search Content Search Service Application (SSA)). When you use the FAST Search Server 2010 for SharePoint specific connectors, you must have one collection per connector configuration. You can create, clear, delete, or retrieve collections with these cmdlets.

Note

Be careful when you are using Clear-FASTSearchContentCollection and Remove-FASTSearchContentCollection. These cmdlets will permanently delete all items of the specified collection from the index. Instead, delete content from a collection by changing the crawl configuration for the associated indexing connector.

Content collection cmdlets

Note

To use the cmdlets, verify that you meet the following minimum requirements: You are a member of the FASTSearchAdministrators local group on the computer where FAST Search Server 2010 for SharePoint is installed.

Use these cmdlets to manage your content collections:

Task	Cmdlet
Retrieve one or more FAST Search Server 2010 for SharePoint content collections	Get-FASTSearchContentCollection
Create a new content collection	New-FASTSearchContentCollection
Clear a collection of all content: delete all collection items from the index without removing the collection	Clear-FASTSearchContentCollection
Delete a content collection and all the items in the collection	Remove-FASTSearchContentCollection

Item processing cmdlets

You rarely have to use the Get-FASTSearchDocumentProcessingPipeline cmdlet because there is only one item processing pipeline defined in the system. The pipeline is named Office14 (webcluster).

Task	Cmdlet
Retrieve a FAST Search Server 2010 for SharePoint item preprocessing pipeline	Get-FASTSearchDocumentProcessingPipeline

Manage search scopes

A search scope can specify content that is important to your organization, such as all items that relate to a specific product or organizational group. Or a search scope can filter on a specific content collection or language. Search scopes are offered as drop-down selections in the search application. Search scopes are available for both Microsoft SharePoint Server and FAST Search Server 2010 for SharePoint search service applications (SSA), set at the site level.

Create search scopes

To create search scopes, define query filters with the Microsoft SharePoint Server cmdlet, New-SPEnterpriseSearchQueryScope.

To create a search scope specific to FAST Search Server 2010 for SharePoint, use the -ExtendedSearchFilter <fql expression> parameter with the New-SPEnterpriseSearchQueryScope cmdlet.

Search scope cmdlets

Note

To use the cmdlets, verify that you meet the following minimum requirements: You are a member of the Farm-level Administrators local group on the computer where Microsoft SharePoint Server is installed.

Use these SharePoint Server cmdlets to manage your search scopes:

Task	Cmdlet
Retrieve a FAST Search Server 2010 for SharePoint search scope	Get-SPEnterpriseSearchQueryScope
Create a FAST Search Server 2010 for SharePoint search scope	New-SPEnterpriseSearchQueryScope

See Also

Concepts

Index schema cmdlets (FAST Search Server 2010 for SharePoint)
Spell tuning cmdlets (FAST Search Server 2010 for SharePoint)