Get-SPSearchServiceInstance

Published: May 12, 2010

Returns an instance of a search service.

Get-SPSearchServiceInstance [[-Identity] <SPSearchServiceInstancePipeBind>] [-AssignmentCollection <SPAssignmentCollection>] [-Local <SwitchParameter>]

Parameters

 

Parameter Required Type Description

Identity

Optional

Microsoft.SharePoint.Search.Cmdlet.SPSearchServiceInstancePipeBind

Specifies the search service to update.

The type must be a valid GUID, such as 12345678-90ab-cdef-1234-567890bcdefgh a valid name of a search service, such as MySearch1; or an instance a valid SearchService 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.

Local

Optional

System.Management.Automation.SwitchParameter

Specifies to return the search service instance for the current search server.

Detailed Description

The Get-SPSearchServiceInstance cmdlet reads an SPSearchServiceInstance object when the cmdlet updates an instance of a search service that runs on one or more servers in the server farm.

Input Types

 

Return Types

 
Example

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

Get-SPSearchServiceInstance -Local

This example obtains a reference to the search service instance object that runs on the local computer.

See Also

Reference

Set-SPSearchService
Get-SPSearchService
Set-SPSearchServiceInstance

Change History

 

Date Description Reason

May 12, 2010

Initial publication

Page view tracker