Article
07/25/2014

Get-SPEnterpriseSearchAdministrationComponent

Applies to: SharePoint Server 2010, SharePoint Foundation 2010

Topic Last Modified: 2010-02-11

Returns the administration component for a search service application.

Syntax

Get-SPEnterpriseSearchAdministrationComponent -SearchApplication <SearchServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>]

Detailed Description

The Get-SPEnterpriseSearchAdmininstrationComponent cmdlet retrieves an administration component for a search service application in order to update or delete it.

Parameters

Parameter	Required	Type	Description
SearchApplication	Required	Microsoft.Office.Server.Search.Cmdlet.SearchServiceApplicationPipeBind	Specifies the search application that contains the administration component. The type must be a valid name (GUID), in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid SearchServiceApplication 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.

SearchApplication

Required

Microsoft.Office.Server.Search.Cmdlet.SearchServiceApplicationPipeBind

Specifies the search application that contains the administration component.

The type must be a valid name (GUID), in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid SearchServiceApplication 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.

Input Types

Return Types

Example

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

$searchApp = Get-SPEnterpriseSearchServiceApplication ExampleSearchServiceApplication
$adminCmpnt = Get-SPEnterpriseSearchAdministrationComponent
  -SearchApplication $searchApp

This example obtains an object reference to the administration component of a search service application named ExampleSearchServiceApplication.