Start-SPServiceInstance
Applies to: SharePoint Server 2010, SharePoint Foundation 2010
Topic Last Modified: 2010-02-15
Starts the service instance for a service on a specific server or the farm.
Start-SPServiceInstance [-Identity] <SPServiceInstancePipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]]
Use the Start-SPServiceInstance cmdlet to start the service instance for a service on a specific server or on the farm.
| Parameter | Required | Type | Description | ||
|---|---|---|---|---|---|
| Identity | Required | Microsoft.SharePoint.PowerShell.SPServiceInstancePipeBind | Specifies the GUID of the service instance to get. 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.
| ||
| Confirm | Optional | System.Management.Automation.SwitchParameter | Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters | ||
| WhatIf | Optional | System.Management.Automation.SwitchParameter | Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparameters |
Note | Error | Description |
|---|---|
| Exceptions | Description |
|---|---|
------------------EXAMPLE-----------------------
Start-SPServiceInstance 67877d63-bff4-4521-867a-ef4979ba07ce
This example starts the given service instance on the server.
The service instance GUID is unique to every farm. You can run the Get-SPServiceInstance cmdlet to see the GUID of the service instances, and then use the result from the SPServiceInstance cmdlet for other cmdlets.
