Set-SPEnterpriseSearchQueryComponent

 

Applies to: SharePoint Server 2010

Topic Last Modified: 2010-02-11

Modifies properties for a query component.

Syntax

Set-SPEnterpriseSearchQueryComponent [-Identity] <QueryComponentPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-FailoverOnly <Nullable>] [-QueryTopology <QueryTopologyPipeBind>] [-SearchApplication <SearchServiceApplicationPipeBind>] [-WhatIf [<SwitchParameter>]]

Detailed Description

The Set-SPEnterpriseSearchQueryComponent cmdlet updates properties for a query component.

Parameters

Parameter	Required	Type	Description
Identity	Required	Microsoft.Office.Server.Search.Cmdlet.QueryComponentPipeBind	Specifies the query component to set. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh, or an instance of a valid QueryComponent object.
AssignmentCollection	Optional	Microsoft.SharePoint.PowerShell.SPAssignmentCollection	Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. Note When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.
Confirm	Optional	System.Management.Automation.SwitchParameter	Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters
FailoverOnly	Optional	System.Nullable	Specifies that the query component only serves queries as a last resort, after all query instances for the partition have failed.
QueryTopology	Optional	Microsoft.Office.Server.Search.Cmdlet.QueryTopologyPipeBind	Specifies the query topology that contains the query component collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh, or an instance of a valid QueryTopology object.
SearchApplication	Optional	Microsoft.Office.Server.Search.Cmdlet.SearchServiceApplicationPipeBind	Specifies the search application that contains the query topology. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object.
WhatIf	Optional	System.Management.Automation.SwitchParameter	Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparameters

Input Types

Return Types

Example

------------------EXAMPLE------------------

$searchApp = Get-SPEnterpriseSearchServiceApplication mySearchServiceApp
Get-SPEnterpriseSearchQueryTopology -SearchApplication $searchApp
Get-SPEnterpriseSearchQueryComponent -QueryTopology $qt | 
Set-SPEnterpriseSearchQueryComponent -FailoverOnly $true

This example sets the query component of the search service application, mySearchServiceApp, to serve as a failover-only query component.