Export (0) Print
Expand All
Expand Minimize
0 out of 1 rated this helpful - Rate this topic

Set-SPEnterpriseSearchAdministrationComponent

SharePoint 2010

Published: May 12, 2010

Sets properties of an administration component for a search service application.

Set-SPEnterpriseSearchAdministrationComponent [[-Identity] <AdminComponentPipeBind>] [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-SearchApplication <SearchServiceApplicationPipeBind>] [-SearchServiceInstance <SearchServiceInstancePipeBind>] [-StoragePath <String>] [-WhatIf [<SwitchParameter>]]

Parameters

 

Parameter Required Type Description

Identity

Optional

Microsoft.Office.Server.Search.Cmdlet.AdminComponentPipeBind

Specifies the administration component to update.

The type must be a valid name (GUID), such as 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid AdminComponent 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 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

SearchApplication

Optional

Microsoft.Office.Server.Search.Cmdlet.SearchServiceApplicationPipeBind

Specifies the search application that contains the administration component.

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.

Force

Optional

System.Management.Automation.SwitchParameter

Specifies that the admin component must be moved to the new search service instance.

SearchServiceInstance

Optional

Microsoft.Office.Server.Search.Cmdlet.SearchServiceInstancePipeBind

Specifies the search service instance to host the administration component.

The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a search server (for example, MyQueryServer); or an instance of a valid SearchServiceInstance object.

StoragePath

Optional

System.String

Specifies the path for storing data for the administration component. The path must contain a valid file share and use valid registry characters.

The type must be a valid path in either of the following forms:

- C:\ folder_name

- \\server_name\folder_name

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

Detailed Description

The Set-SPEnterpriseSearchAdministrationComponent cmdlet updates properties of an AdministrationComponent object for a search service application.

Input Types

 

Return Types

 

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

$searchapp = Get-SPEnterpriseSearchServiceApplication "Sample Search Service Application" admin = Get-SPEnterpriseSearchAdministrationComponent -SearchApplication $searchapp
$admin | Set-SPEnterpriseSearchAdministrationComponent -SearchServiceInstance newserver -Force

This example moves the administration component to a different server.

Change History

 

Date Description Reason

May 12, 2010

Initial publication

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.