Deploying SharePoint 2010 Solution Package Using PowerShell (Revisited)

  1function global:Deploy-SPSolutions() {
  2  <#
  3  .Synopsis
  4    Deploys one or more Farm Solution Packages to the Farm.
  5  .Description
  6    Specify either a directory containing WSP files, a single WSP file, or an XML configuration file containing the WSP files to deploy.
  7    If using an XML configuration file, the format of the file must match the following:
  8      <Solutions>    
  9        <Solution Path="<full path and filename to WSP>" UpgradeExisting="false">
 10          <WebApplications>            
 11            <WebApplication>http://example.com/</WebApplication>        
 12          </WebApplications>    
 13        </Solution>
 14      </Solutions>
 15    Multiple <Solution> and <WebApplication> nodes can be added. The UpgradeExisting attribute is optional and should be specified if the WSP should be udpated and not retracted and redeployed.
 16  .Example
 17    PS C:\> . .\Deploy-SPSolutions.ps1
 18    PS C:\> Deploy-SPSolutions -Identity C:\WSPs -WebApplication http://demo
 19    
 20    This example loads the function into memory and then deploys all the WSP files in the specified directory to the http://demo Web Application (if applicable).
 21  .Example
 22    PS C:\> . .\Deploy-SPSolutions.ps1
 23    PS C:\> Deploy-SPSolutions -Identity C:\WSPs -WebApplication http://demo,http://mysites
 24    
 25    This example loads the function into memory and then deploys all the WSP files in the specified directory to the http://demo and http://mysites Web Applications (if applicable).
 26  .Example
 27    PS C:\> . .\Deploy-SPSolutions.ps1
 28    PS C:\> Deploy-SPSolutions -Identity C:\WSPs -AllWebApplications
 29    
 30    This example loads the function into memory and then deploys all the WSP files in the specified directory to all Web Applications (if applicable).
 31  .Example
 32    PS C:\> . .\Deploy-SPSolutions.ps1
 33    PS C:\> Deploy-SPSolutions -Identity C:\WSPs\MyCustomSolution.wsp -AllWebApplications
 34    
 35    This example loads the function into memory and then deploys the specified WSP to all Web Applications (if applicable).
 36  .Example
 37    PS C:\> . .\Deploy-SPSolutions.ps1
 38    PS C:\> Deploy-SPSolutions -Identity C:\WSPs\MyCustomSolution.wsp -AllWebApplications -UpgradeExisting
 39    
 40    This example loads the function into memory and then deploys the specified WSP to all Web Applications (if applicable); existing deployments will be upgraded and not retracted and redeployed.
 41  .Example
 42    PS C:\> . .\Deploy-SPSolutions.ps1
 43    PS C:\> Deploy-SPSolutions C:\Solutions.xml
 44    
 45    This example loads the function into memory and then deploys all the WSP files specified by the Solutions.xml configuration file.
 46  .Parameter Config
 47    The XML configuration file containing the WSP files to deploy.
 48  .Parameter Identity
 49    The directory, WSP file, or XML configuration file containing the WSP files to deploy.
 50  .Parameter UpgradeExisting
 51    If specified, the WSP file(s) will be updated and not retracted and redeployed (if the WSP does not exist in the Farm then this parameter has no effect).
 52  .Parameter AllWebApplications
 53    If specified, the WSP file(s) will be deployed to all Web Applications in the Farm (if applicable).
 54  .Parameter WebApplication
 55    Specifies the Web Application(s) to deploy the WSP file to.
 56  .Link
 57    Get-Content
 58    Get-SPSolution
 59    Add-SPSolution
 60    Install-SPSolution
 61    Update-SPSolution
 62    Uninstall-SPSolution
 63    Remove-SPSolution
 64  #>
 65  [CmdletBinding(DefaultParameterSetName="FileOrDirectory")]
 66  param (
 67    [Parameter(Mandatory=$true, Position=0, ParameterSetName="Xml")]
 68    [ValidateNotNullOrEmpty()]
 69    [xml]$Config,
 70
 71    [Parameter(Mandatory=$true, Position=0, ParameterSetName="FileOrDirectory")]
 72    [ValidateNotNullOrEmpty()]
 73    [string]$Identity,
 74    
 75    [Parameter(Mandatory=$false, Position=1, ParameterSetName="FileOrDirectory")]
 76    [switch]$UpgradeExisting,
 77    
 78    [Parameter(Mandatory=$false, Position=2, ParameterSetName="FileOrDirectory")]
 79    [switch]$AllWebApplications,
 80    
 81    [Parameter(Mandatory=$false, Position=3, ParameterSetName="FileOrDirectory")]
 82    [Microsoft.SharePoint.PowerShell.SPWebApplicationPipeBind[]]$WebApplication
 83  )
 84  function Block-SPDeployment($solution, [bool]$deploying, [string]$status, [int]$percentComplete) {
 85    do { 
 86      Start-Sleep 2
 87      Write-Progress -Activity "Deploying solution $($solution.Name)" -Status $status -PercentComplete $percentComplete
 88      $solution = Get-SPSolution $solution
 89      if ($solution.LastOperationResult -like "*Failed*") { throw "An error occurred during the solution retraction, deployment, or update." }
 90      if (!$solution.JobExists -and (($deploying -and $solution.Deployed) -or (!$deploying -and !$solution.Deployed))) { break }
 91    } while ($true)
 92    sleep 5  
 93  }
 94  switch ($PsCmdlet.ParameterSetName) { 
 95    "Xml" { 
 96      # An XML document was provided so iterate through all the defined solutions and call the other parameter set version of the function
 97      $Config.Solutions.Solution | ForEach-Object {
 98        [string]$path = $_.Path
 99        [bool]$upgrade = $false
100        if (![string]::IsNullOrEmpty($_.UpgradeExisting)) {
101          $upgrade = [bool]::Parse($_.UpgradeExisting)
102        }
103        $webApps = $_.WebApplications.WebApplication
104        Deploy-SPSolutions -Identity $path -UpgradeExisting:$upgrade -WebApplication $webApps -AllWebApplications:$(($webApps -eq $null) -or ($webApps.Length -eq 0))
105      }
106      break
107    }
108    "FileOrDirectory" {
109      $item = Get-Item (Resolve-Path $Identity)
110      if ($item -is [System.IO.DirectoryInfo]) {
111        # A directory was provided so iterate through all files in the directory and deploy if the file is a WSP (based on the extension)
112        Get-ChildItem $item | ForEach-Object {
113          if ($_.Name.ToLower().EndsWith(".wsp")) {
114            Deploy-SPSolutions -Identity $_.FullName -UpgradeExisting:$UpgradeExisting -WebApplication $WebApplication
115          }
116        }
117      } elseif ($item -is [System.IO.FileInfo]) {
118        # A specific file was provided so assume that the file is a WSP if it does not have an XML extension.
119        [string]$name = $item.Name
120        
121        if ($name.ToLower().EndsWith(".xml")) {
122          Deploy-SPSolutions -Config ([xml](Get-Content $item.FullName))
123          return
124        }
125        $solution = Get-SPSolution $name -ErrorAction SilentlyContinue
126        
127        if ($solution -ne $null -and $UpgradeExisting) {
128          # Just update the solution, don't retract and redeploy.
129          Write-Progress -Activity "Deploying solution $name" -Status "Updating $name" -PercentComplete -1
130          $solution | Update-SPSolution -CASPolicies:$($solution.ContainsCasPolicy) `
131            -GACDeployment:$($solution.ContainsGlobalAssembly) `
132            -LiteralPath $item.FullName
133        
134          Block-SPDeployment $solution $true "Updating $name" -1
135          Write-Progress -Activity "Deploying solution $name" -Status "Updated" -Completed
136          
137          return
138        }
139
140        if ($solution -ne $null) {
141          #Retract the solution
142          if ($solution.Deployed) {
143            Write-Progress -Activity "Deploying solution $name" -Status "Retracting $name" -PercentComplete 0
144            if ($solution.ContainsWebApplicationResource) {
145              $solution | Uninstall-SPSolution -AllWebApplications -Confirm:$false
146            } else {
147              $solution | Uninstall-SPSolution -Confirm:$false
148            }
149            #Block until we're sure the solution is no longer deployed.
150            Block-SPDeployment $solution $false "Retracting $name" 12
151            Write-Progress -Activity "Deploying solution $name" -Status "Solution retracted" -PercentComplete 25
152          }
153
154          #Delete the solution
155          Write-Progress -Activity "Deploying solution $name" -Status "Removing $name" -PercentComplete 30
156          Get-SPSolution $name | Remove-SPSolution -Confirm:$false
157          Write-Progress -Activity "Deploying solution $name" -Status "Solution removed" -PercentComplete 50
158        }
159
160        #Add the solution
161        Write-Progress -Activity "Deploying solution $name" -Status "Adding $name" -PercentComplete 50
162        $solution = Add-SPSolution $item.FullName
163        Write-Progress -Activity "Deploying solution $name" -Status "Solution added" -PercentComplete 75
164
165        #Deploy the solution
166        
167        if (!$solution.ContainsWebApplicationResource) {
168          Write-Progress -Activity "Deploying solution $name" -Status "Installing $name" -PercentComplete 75
169          $solution | Install-SPSolution -GACDeployment:$($solution.ContainsGlobalAssembly) -CASPolicies:$($solution.ContainsCasPolicy) -Confirm:$false
170          Block-SPDeployment $solution $true "Installing $name" 85
171        } else {
172          if ($WebApplication -eq $null -or $WebApplication.Length -eq 0) {
173            Write-Progress -Activity "Deploying solution $name" -Status "Installing $name to all Web Applications" -PercentComplete 75
174            $solution | Install-SPSolution -GACDeployment:$($solution.ContainsGlobalAssembly) -CASPolicies:$($solution.ContainsCasPolicy) -AllWebApplications -Confirm:$false
175            Block-SPDeployment $solution $true "Installing $name to all Web Applications" 85
176          } else {
177            $WebApplication | ForEach-Object {
178              $webApp = $_.Read()
179              Write-Progress -Activity "Deploying solution $name" -Status "Installing $name to $($webApp.Url)" -PercentComplete 75
180              $solution | Install-SPSolution -GACDeployment:$gac -CASPolicies:$cas -WebApplication $webApp -Confirm:$false
181              Block-SPDeployment $solution $true "Installing $name to $($webApp.Url)" 85
182            }
183          }
184        }
185        Write-Progress -Activity "Deploying solution $name" -Status "Deployed" -Completed
186      }
187      break 
188    }
189  } 
190}