Install-SPSolution
Applies to: SharePoint Server 2010, SharePoint Foundation 2010
Topic Last Modified: 2010-05-07
Deploys an installed SharePoint solution in the farm.
Install-SPSolution [-Identity] <SPSolutionPipeBind> [-AllWebApplications <SwitchParameter>] [-AssignmentCollection <SPAssignmentCollection>] [-CASPolicies <SwitchParameter>] [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-GACDeployment <SwitchParameter>] [-Language <UInt32>] [-Local <SwitchParameter>] [-Time <String>] [-WebApplication <SPWebApplicationPipeBind>] [-WhatIf [<SwitchParameter>]]
Install-SPSolution [[-Identity] <SPSolutionPipeBind>] -Synchronize <SwitchParameter> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-Language <UInt32>] [-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-SPSolution cmdlet deploys an installed SharePoint solution in the farm. Use the Add-SPSolution cmdlet to install a SharePoint solution package io the farm.
| Parameter | Required | Type | Description | ||
|---|---|---|---|---|---|
| Identity | Required | Microsoft.SharePoint.PowerShell.SPSolutionPipeBind | Specifies the SharePoint solution to deploy. 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 | Optional | System.Management.Automation.SwitchParameter | Specifies that the new SharePoint solution is deployed 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.
| ||
| CASPolicies | Optional | System.Management.Automation.SwitchParameter | Specifies that code access security (CAS) policies can be deployed for the new SharePoint solution. | ||
| 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 deployment of the new SharePoint solution. | ||
| GACDeployment | Optional | System.Management.Automation.SwitchParameter | Specifies that global assembly cache (GAC) can be deployed for the new SharePoint solution. | ||
| Language | Optional | System.UInt32 | Specifies a language for the solution when a solution language package is deployed. If this parameter is not specified, zero ("0") is assumed. Use zero for solutions that are valid for all languages. | ||
| Local | Optional | System.Management.Automation.SwitchParameter | Deploys the solution on the active server computer. | ||
| Synchronize | Optional | System.Management.Automation.SwitchParameter | Synchronizes all solutions or the specified solution in the local farm. | ||
| Time | Optional | System.String | Specifies when the solution will be deployed. The default value is immediate deployment. The type must be a valid DateTime value, in the form 2010, 5, 1. | ||
| WebApplication | Optional | Microsoft.SharePoint.PowerShell.SPWebApplicationPipeBind | Deploys the SharePoint solution for the specified SharePoint Web application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object. | ||
| 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------------------
Install-SPSolution -Identity contoso_solution.wsp -GACDeployment
This example deploys the installed SharePoint solution contoso_solution.wsp in the farm and specifies that GAC can be deployed for the new SharePoint solution.
