.png)
Uninstall-SPFeature
Published: July 16, 2012
Applies to: SharePoint Foundation 2013 | SharePoint Server 2013 Enterprise
Uninstalls an installed feature definition.
Uninstall-SPFeature [-Identity] <SPFeatureDefinitionPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-CompatibilityLevel <Int32>] [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]
Parameters
| Parameter | Required | Type | Description | ||
|---|---|---|---|---|---|
| Identity | Parameter | Microsoft.SharePoint.PowerShell.SPFeatureDefinitionPipeBind | Specifies the name of the feature or GUID to uninstall. The type must be the name of the feature folder located in the <drive>:\program files\common files\Microsoft Shared\Web server extensions\15\template\features folder, or must be a GUID, in the form 21d186e1-7036-4092-a825-0eb6709e9281. | ||
| 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.
| ||
| CompatibilityLevel | Optional | System.Int32 | Specifies the version of feature to uninstall. When the version is not specified it will default to the web applications MaxVersion value. The values for this can be either SharePoint Server 2010 or SharePoint Server 2013. | ||
| 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 | ||
| Force | No | System.Management.Automation.SwitchParameter | Forces the uninstallation of a feature that is already installed. | ||
| 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: Detailed Description
The Uninstall-SPFeature cmdlet removes the specified feature definition from the collection of feature definitions in the farm.
Input Types
Return Types
------------------EXAMPLE 1-----------------------
Uninstall-SPFeature -path "MyCustomFeature"
This example uninstalls the feature at $env:ProgramFiles\Common Files\Microsoft Shared\Web Server Extensions\15\TEMPLATE\FEATURES\MyCustomFeature/feature.xml.
------------------EXAMPLE 2-----------------------
Uninstall-SPFeature -path "MyCustomFeature" -CompatibilityLevel 14
This example uninstalls the feature at $env:ProgramFiles\Common Files\Microsoft Shared\Web Server Extensions\15\TEMPLATE\FEATURES\MyCustomFeature/feature.xml.
Change History
| Date | Description |
|---|---|
| July 16, 2012 | Initial publication |
