.png)
Get-SPServiceInstance
Published: July 16, 2012
Applies to: SharePoint Foundation 2013 | SharePoint Server 2013 Enterprise
Returns the services instance for a specific server or the entire farm.
Get-SPServiceInstance [[-Identity] <SPServiceInstancePipeBind>] [-All <SwitchParameter>] [-AssignmentCollection <SPAssignmentCollection>]
Get-SPServiceInstance -Server <SPServerPipeBind> [-All <SwitchParameter>] [-AssignmentCollection <SPAssignmentCollection>]
Parameters
1| Parameter | Required | Type | Description | ||
| Identity | Optional | Microsoft.SharePoint.PowerShell.SPServiceInstancePipeBind | Specifies the GUID of the service instance. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. | ||
| 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: | Parameter | Required | Type | Description | ||
| Server | Required | Microsoft.SharePoint.PowerShell.SPServerPipeBind | Specifies the server from which to return the service instance. | ||
| 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.
|
Detailed Description
This cmdlet contains more than one parameter set. You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. For more information about how to use parameter sets, see Cmdlet Parameter Sets.
The Get-SPServiceInstance cmdlet returns the services instance specified by the Identity parameter for a specific server. If the Server parameter is not specified, the Get-SPServiceInstance cmdlet returns results for the entire farm.
Input Types
Return Types
--------------EXAMPLE-----------------
Get-SPServiceInstance –Server ServerA
This example displays the service instances from a given server.
Change History
| Date | Description |
|---|---|
| July 16, 2012 | Initial publication |
