Install-SPFeature
Applies to: SharePoint Server 2010, SharePoint Foundation 2010
Topic Last Modified: 2010-05-07
Installs a SharePoint Feature by using the Feature.xml file.
Install-SPFeature [-Path] <String> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]
Install-SPFeature -AllExistingFeatures <SwitchParameter> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-SolutionId <String>] [-WhatIf [<SwitchParameter>]]
Install-SPFeature -ScanForFeatures <SwitchParameter> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-SolutionId <String>] [-WhatIf [<SwitchParameter>]]
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 Install-SPFeature cmdlet installs a specific SPFeature object by providing in the Identity parameter the relative path from the folder "$env:ProgramFiles\Common Files\Microsoft Shared\Web Server Extensions\14\TEMPLATE\FEATURES\ to the feature. The SharePoint Feature’s files must already be put in the proper directory, either manually or by using a solution installer.
If the AllExistingFeatures parameter is provided, the file system is scanned and any new features are installed. This is generally only used during deployment and upgrade.
| Parameter | Required | Type | Description | ||
|---|---|---|---|---|---|
| Path | Required | System.String | Specifies a valid file path; for example, MyFeature. Path to feature must be a literal path to the 14\Template\Features directory. Can be any standard character that the Windows system supports for a file name. The feature.xml filename is implied and does not need to be provided. If the feature file is not found on disk, the following error message is displayed: "Failed to find the XML file at location 14\Template\Features\<file path>." | ||
| AllExistingFeatures | Required | System.Management.Automation.SwitchParameter | Scans for existing, but unregistered features, and then registers them with the farm. | ||
| ScanForFeatures | Required | System.Management.Automation.SwitchParameter | Scans and then displays a feature. The ScanForFeatures parameter does not install a feature. | ||
| 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 | ||
| Force | Optional | System.Management.Automation.SwitchParameter | Forces the installation of an already installed feature. | ||
| SolutionId | Optional | System.String | Specifies the solution id of the features. If the SolutionId parameter is not provided, all solution ids are scanned. | ||
| 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 --------------EXAMPLE 1-----------------
Install-SPFeature -path "MyCustomFeature"
This example installs a new feature at $env:ProgramFiles\Common Files\Microsoft Shared\Web Server Extensions\14\TEMPLATE\FEATURES\MyCustomFeature/feature.xml.
--------------EXAMPLE 2-----------------
Install-SPFeature -AllExistingFeatures -Whatif
This example shows the unregistered features, available on the file system, that are installed if this command is run without the WhatIf parameter. This is commonly done after an upgrade process.
