.png)
Uninstall-SPSolution
Updated: October 30, 2012
Applies to: SharePoint Foundation 2013 | SharePoint Server 2013 Enterprise
Retracts a deployed SharePoint solution.
Uninstall-SPSolution [-Identity] <SPSolutionPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-CompatibilityLevel <String>] [-Confirm [<SwitchParameter>]] [-Language <UInt32>] [-Local <SwitchParameter>] [-Time <String>] [-WhatIf [<SwitchParameter>]]
Uninstall-SPSolution [-Identity] <SPSolutionPipeBind> -WebApplication <SPWebApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-CompatibilityLevel <String>] [-Confirm [<SwitchParameter>]] [-Language <UInt32>] [-Local <SwitchParameter>] [-Time <String>] [-WhatIf [<SwitchParameter>]]
Uninstall-SPSolution [-Identity] <SPSolutionPipeBind> -AllWebApplications <SwitchParameter> [-AssignmentCollection <SPAssignmentCollection>] [-CompatibilityLevel <String>] [-Confirm [<SwitchParameter>]] [-Language <UInt32>] [-Local <SwitchParameter>] [-Time <String>] [-WhatIf [<SwitchParameter>]]
Parameters
1| Parameter | Required | Type | Description | ||
| Identity | Required | Microsoft.SharePoint.PowerShell.SPSolutionPipeBind | Specifies the SharePoint solution to uninstall. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint solution (for example, SPSolution1); or an instance of a valid SPSolution 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.
| ||
| 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 | ||
| CompatibilityLevel | Optional | System.String | Specifies whether to uninstall the solution, from a specific version directory based on CompatibilityLevel. The default behavior if this parameter is not specified is to uninstall the solution only from the version directory based on the version tracked in the manifest of the solution's cab file. For the list of values, see the table in the Detailed Description section. | ||
| Language | Optional | System.UInt32 | Uninstalls the language pack for the specified language. The type must be a valid language identifier; for example, 1033. | ||
| Local | Optional | System.Management.Automation.SwitchParameter | Uninstalls the solution from the active server computer. | ||
| Time | Optional | System.String | Specifies when the solution will be uninstalled. The default value is immediate retraction. The type must be a valid DateTime value, in the form 2010,12,05. | ||
| 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: | Parameter | Required | Type | Description | ||
| Identity | Required | Microsoft.SharePoint.PowerShell.SPSolutionPipeBind | Specifies the SharePoint solution to uninstall. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint solution (for example, SPSolution1); or an instance of a valid SPSolution object. | ||
| WebApplication | Required | Microsoft.SharePoint.PowerShell.SPWebApplicationPipeBind | Uninstalls the SharePoint solution for the specified SharePoint Web application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of a SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication 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.
| ||
| 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 | ||
| CompatibilityLevel | Optional | System.String | Specifies whether to uninstall the solution, from a specific version directory based on CompatibilityLevel. The default behavior if this parameter is not specified is to uninstall the solution only from the version directory based on the version tracked in the manifest of the solution's cab file. For the list of values, see the table in the Detailed Description section. | ||
| Language | Optional | System.UInt32 | Uninstalls the language pack for the specified language. The type must be a valid language identifier; for example, 1033. | ||
| Local | Optional | System.Management.Automation.SwitchParameter | Uninstalls the solution from the active server computer. | ||
| Time | Optional | System.String | Specifies when the solution will be uninstalled. The default value is immediate retraction. The type must be a valid DateTime value, in the form 2010,12,05. | ||
| 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 |
| Parameter | Required | Type | Description | ||
| Identity | Required | Microsoft.SharePoint.PowerShell.SPSolutionPipeBind | Specifies the SharePoint solution to uninstall. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint solution (for example, SPSolution1); or an instance of a valid SPSolution object. | ||
| AllWebApplications | Required | System.Management.Automation.SwitchParameter | Specifies that the new SharePoint solution will be uninstalled for all SharePoint Web applications in the farm. | ||
| 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 | ||
| CompatibilityLevel | Optional | System.String | Specifies whether to uninstall the solution, from a specific version directory based on CompatibilityLevel. The default behavior if this parameter is not specified is to uninstall the solution only from the version directory based on the version tracked in the manifest of the solution's cab file. For the list of values, see the table in the Detailed Description section. | ||
| Language | Optional | System.UInt32 | Uninstalls the language pack for the specified language. The type must be a valid language identifier; for example, 1033. | ||
| Local | Optional | System.Management.Automation.SwitchParameter | Uninstalls the solution from the active server computer. | ||
| Time | Optional | System.String | Specifies when the solution will be uninstalled. The default value is immediate retraction. The type must be a valid DateTime value, in the form 2010,12,05. | ||
| 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 |
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 Uninstall-SPSolution cmdlet retracts a deployed SharePoint solution in preparation for removing it from the farm entirely. This cmdlet removes files from the front-end Web server. Use the Remove-SPSolution cmdlet to delete the solution package from the solution store of the farm; be sure to use the Remove-SPSolution cmdlet only after you have run Uninstall-SPSolution.
The following table lists the valid values for the CompatabilityLevel parameter:
| Value | Result |
| 14 | Uninstalls solution from 14 directories only |
| 15 | Uninstalls solution from 15 directories only |
| “14,15” | Uninstalls solution from both 14 and 15 directories |
| “AllVersions” or “All” | Uninstalls solution from both 14 and 15 directories |
| “OldVersions” or “Old” | Uninstalls solution from 14 directories only |
| “NewVersion” or “New” | Uninstalls solution from 15 directories only |
Input Types
Return Types
------------------EXAMPLE------------------
Uninstall-SPUserSolution -Identity contoso_solution.wsp
This example retracts the deployed SharePoint solution contoso_solution.wsp.
Change History
| Date | Description |
|---|---|
| October 30, 2012 | Added table with values for the CompatibilityLevel parameter. |
| July 16, 2012 | Initial publication |
