Set-SPEnterpriseSearchPrimaryHostController

Sets the primary search host controller for the farm.

Syntax

Set-SPEnterpriseSearchPrimaryHostController
   [-SearchServiceInstance] <SearchServiceInstancePipeBind>
   [-AssignmentCollection <SPAssignmentCollection>]
   [-Confirm]
   [-Force]
   [-WhatIf]
   [<CommonParameters>]

Description

This cmdlet sets the primary SearchHostController for the farm to the defined SearchHostController.

For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251831 (http://go.microsoft.com/fwlink/p/?LinkId=251831).

Examples

------------------EXAMPLE 1------------------

C:\PS>$ssi = Get-SPEnterpriseSearchServiceInstance -Local 
Set-SPEnterpriseSearchPrimaryHostController $ssi

This example sets the local SearchHostController instance as the new primary SearchHostController. It is up to the user to select the HostController with latest version available. If you choose a SearchHostController that is not running the latest version of the repository, you will have to confirm before you continue.

------------------EXAMPLE 2------------------

C:\PS>$ssi = Get-SPEnterpriseSearchServiceInstance -Local 
Set-SPEnterpriseSearchPrimaryHostController $ssi -Force

This example sets the local SearchHostController instance as the new primary SearchHostController. If you choose a SearchHostController that is not running the latest version of the repository, you will not get a confirmation message before you continue.

Required Parameters

-SearchServiceInstance

SearchServiceInstance of the server from where the SearchHostController object is returned.

Type:SearchServiceInstancePipeBind
Position:1
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016

Optional Parameters

-AssignmentCollection

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.

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.

Type:SPAssignmentCollection
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-Confirm

Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-Force

Force the change of the primary SearcHostController. No confirmation messages are asked, even if user tries to set primary to a SearchHostController not running the latest version of the repository.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016
-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016