Get-SPEnterpriseSearchServiceInstance

Reference

Module:: sharepoint-server

Applies to:: SharePoint Server Subscription Edition

Returns the search service instance for a farm.

Syntax

Get-SPEnterpriseSearchServiceInstance
   [[-Identity] <SearchServiceInstancePipeBind>]
   [-AssignmentCollection <SPAssignmentCollection>]
   [-Local]
   [<CommonParameters>]

Description

This cmdlet returns the SearchServiceInstance object when the object is created, updated, or deleted.

For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at SharePoint Server Cmdlets.

Examples

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

Get-SPEnterpriseSearchServiceInstance -Local

This example obtains a reference to the local search service instance.

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

Get-SPEnterpriseSearchServiceInstance | ?{$_.Server -match 'SP01'}

This example obtains a reference to the search service instance on the SharePoint server named 'SP01'.

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
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-Identity

Specifies the search service instance to return.

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.

Type:	SearchServiceInstancePipeBind
Position:	1
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-Local

Returns the search service instance for the current search server.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

Jaa