Install-SPUserSolution
Published: July 16, 2012
Applies to: SharePoint Foundation 2013 | SharePoint Server 2013 Enterprise
Activates a sandboxed solution in a site collection.
Install-SPUserSolution [-Identity] <SPUserSolutionPipeBind> -Site <SPSitePipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]]
Parameters
| Parameter | Required | Type | Description | ||
|---|---|---|---|---|---|
| Identity | Required | Microsoft.SharePoint.PowerShell.SPUserSolutionPipeBind | Specifies the sandboxed solution to activate. The type must be a valid name of a sandboxed solution (for example, UserSolution1); or an instance of a valid SPUserSolution object. | ||
| Site | Required | Microsoft.SharePoint.PowerShell.SPSitePipeBind | Activates the sandboxed solution for the specified site collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form http://server_name; or an instance of a valid SPSite 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 | ||
| 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
The Install-SPUserSolution cmdlet activates a sandboxed solution in a site collection. A user solution is a sandboxed solution.
Input Types
Return Types
Errors
| Error | Description |
|---|---|
| Exceptions | Description |
|---|---|
-------------------EXAMPLE---------------------
Install-SPUserSolution -Identity contoso_solution.wsp -Site http://sitename
This example activates the sandboxed solution contoso_solution.wsp in the site http://sitename.
Change History
| Date | Description |
|---|---|
| July 16, 2012 | Initial publication |

Note: