Get-SPEnterpriseSearchServiceInstance
Applies to: SharePoint Server 2010
Topic Last Modified: 2010-02-11
Returns the search service instance for a farm.
Syntax
Get-SPEnterpriseSearchServiceInstance [[-Identity] <SearchServiceInstancePipeBind>] [-AssignmentCollection <SPAssignmentCollection>] [-Local <SwitchParameter>]
Detailed Description
The Get-SPEnterpriseSearchServiceInstance cmdlet returns the SearchServiceInstance object when the object is created, updated, or deleted.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Optional |
Microsoft.Office.Server.Search.Cmdlet.SearchServiceInstancePipeBind |
Specifies the search service instance to get. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a query server (for example, MyQueryServer); or an instance of a valid SearchServiceInstance 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. |
Local |
Optional |
System.Management.Automation.SwitchParameter |
Returns the search service instance for the current search server. |
Input Types
Return Types
Example
------------------EXAMPLE------------------
$ssInstance = Get-SPEnterpriseSearchServiceInstance -Local
This example obtains a reference to the local search service instance.