DSCResources/MSFT_SPInstall/MSFT_SPInstall.psm1
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 |
function Get-TargetResource { [CmdletBinding()] [OutputType([System.Collections.Hashtable])] param ( [Parameter(Mandatory = $true)] [ValidateSet('Yes')] [String] $IsSingleInstance, [Parameter(Mandatory = $true)] [System.String] $BinaryDir, [Parameter(Mandatory = $true)] [System.String] $ProductKey, [Parameter()] [System.String] $InstallPath, [Parameter()] [System.String] $DataPath, [Parameter()] [ValidateSet("Present", "Absent")] [System.String] $Ensure = "Present" ) Write-Verbose -Message "Getting install status of SharePoint" Write-Verbose -Message "Check if Binary folder exists" if (-not(Test-Path -Path $BinaryDir)) { $message = "Specified path cannot be found: {$BinaryDir}" Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $MyInvocation.MyCommand.Source throw $message } $InstallerPath = Join-Path -Path $BinaryDir -ChildPath "setup.exe" if (-not(Test-Path -Path $InstallerPath)) { $message = "Setup.exe cannot be found in {$BinaryDir}" Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $MyInvocation.MyCommand.Source throw $message } Write-Verbose -Message "Checking file status of $InstallerPath" $checkBlockedFile = $true if (Split-Path -Path $InstallerPath -IsAbsolute) { $driveLetter = (Split-Path -Path $InstallerPath -Qualifier).TrimEnd(":") Write-Verbose -Message "BinaryDir refers to drive $driveLetter" $volume = Get-Volume -DriveLetter $driveLetter -ErrorAction SilentlyContinue if ($null -ne $volume) { if ($volume.DriveType -ne "CD-ROM") { Write-Verbose -Message "Volume is a fixed drive: Perform Blocked File test" } else { Write-Verbose -Message "Volume is a CD-ROM drive: Skipping Blocked File test" $checkBlockedFile = $false } } else { Write-Verbose -Message "Volume not found. Unable to determine the type. Continuing." } } if ($checkBlockedFile -eq $true) { Write-Verbose -Message "Checking status now" try { $zone = Get-Item -Path $InstallerPath -Stream "Zone.Identifier" -EA SilentlyContinue } catch { Write-Verbose -Message 'Encountered error while reading file stream. Ignoring file stream.' } if ($null -ne $zone) { $message = ("Setup file is blocked! Please use 'Unblock-File -Path $InstallerPath' " + ` "to unblock the file before continuing.") Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $MyInvocation.MyCommand.Source throw $message } Write-Verbose -Message "File not blocked, continuing." } $x86Path = "HKLM:\Software\Wow6432Node\Microsoft\Windows\CurrentVersion\Uninstall\*" $installedItemsX86 = Get-ItemProperty -Path $x86Path | Select-Object -Property DisplayName $x64Path = "HKLM:\Software\Microsoft\Windows\CurrentVersion\Uninstall\*" $installedItemsX64 = Get-ItemProperty -Path $x64Path | Select-Object -Property DisplayName $installedItems = $installedItemsX86 + $installedItemsX64 $installedItems = $installedItems.DisplayName | Select-Object -Unique $spInstall = $installedItems | Where-Object -FilterScript { $_ -match "^Microsoft SharePoint Server (2013|2016|2019)$" } if ($spInstall) { return @{ IsSingleInstance = "Yes" BinaryDir = $BinaryDir ProductKey = $ProductKey InstallPath = $InstallPath DataPath = $DataPath Ensure = "Present" } } else { return @{ IsSingleInstance = "Yes" BinaryDir = $BinaryDir ProductKey = $ProductKey InstallPath = $InstallPath DataPath = $DataPath Ensure = "Absent" } } } function Set-TargetResource { # Supressing the global variable use to allow passing DSC the reboot message [CmdletBinding()] [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidGlobalVars", "")] param ( [Parameter(Mandatory = $true)] [ValidateSet('Yes')] [String] $IsSingleInstance, [Parameter(Mandatory = $true)] [System.String] $BinaryDir, [Parameter(Mandatory = $true)] [System.String] $ProductKey, [Parameter()] [System.String] $InstallPath, [Parameter()] [System.String] $DataPath, [Parameter()] [ValidateSet("Present", "Absent")] [System.String] $Ensure = "Present" ) Write-Verbose -Message "Setting install status of SharePoint" if ($Ensure -eq "Absent") { $message = ("SharePointDsc does not support uninstalling SharePoint or " + ` "its prerequisites. Please remove this manually.") Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $MyInvocation.MyCommand.Source throw $message } Write-Verbose -Message "Check if Binary folder exists" if (-not(Test-Path -Path $BinaryDir)) { $message = "Specified path cannot be found: {$BinaryDir}" Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $MyInvocation.MyCommand.Source throw $message } $InstallerPath = Join-Path -Path $BinaryDir -ChildPath "setup.exe" if (-not(Test-Path -Path $InstallerPath)) { $message = "Setup.exe cannot be found in {$BinaryDir}" Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $MyInvocation.MyCommand.Source throw $message } $majorVersion = (Get-SPDscAssemblyVersion -PathToAssembly $InstallerPath) if ($majorVersion -eq 15) { $svrsetupDll = Join-Path -Path $BinaryDir -ChildPath "updates\svrsetup.dll" $checkDotNet = $true if (Test-Path -Path $svrsetupDll) { $svrsetupDllFileInfo = Get-ItemProperty -Path $svrsetupDll $fileVersion = $svrsetupDllFileInfo.VersionInfo.FileVersion if ($fileVersion -ge "15.0.4709.1000") { $checkDotNet = $false } } if ($checkDotNet -eq $true) { $ndpKey = "HKLM:\SOFTWARE\Microsoft\NET Framework Setup\NDP\v4" $dotNet46Installed = $false if (Test-Path -Path $ndpKey) { $dotNetv4Keys = Get-ChildItem -Path $ndpKey foreach ($dotnetInstance in $dotNetv4Keys) { if ($dotnetInstance.GetValue("Release") -ge 390000) { $dotNet46Installed = $true break } } } if ($dotNet46Installed -eq $true) { $message = ("A known issue prevents installation of SharePoint 2013 on " + ` "servers that have .NET 4.6 already installed. See details " + ` "at https://support.microsoft.com/en-us/kb/3087184") Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $MyInvocation.MyCommand.Source throw $message } } } Write-Verbose -Message "Checking file status of $InstallerPath" $checkBlockedFile = $true if (Split-Path -Path $InstallerPath -IsAbsolute) { $driveLetter = (Split-Path -Path $InstallerPath -Qualifier).TrimEnd(":") Write-Verbose -Message "BinaryDir refers to drive $driveLetter" $volume = Get-Volume -DriveLetter $driveLetter -ErrorAction SilentlyContinue if ($null -ne $volume) { if ($volume.DriveType -ne "CD-ROM") { Write-Verbose -Message "Volume is a fixed drive: Perform Blocked File test" } else { Write-Verbose -Message "Volume is a CD-ROM drive: Skipping Blocked File test" $checkBlockedFile = $false } } else { Write-Verbose -Message "Volume not found. Unable to determine the type. Continuing." } } if ($checkBlockedFile -eq $true) { Write-Verbose -Message "Checking status now" try { $zone = Get-Item -Path $InstallerPath -Stream "Zone.Identifier" -EA SilentlyContinue } catch { Write-Verbose -Message 'Encountered error while reading file stream. Ignoring file stream.' } if ($null -ne $zone) { $message = ("Setup file is blocked! Please use 'Unblock-File -Path $InstallerPath' " + ` "to unblock the file before continuing.") Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $MyInvocation.MyCommand.Source throw $message } Write-Verbose -Message "File not blocked, continuing." } Write-Verbose -Message "Checking if Path is an UNC path" $uncInstall = $false if ($BinaryDir.StartsWith("\\")) { Write-Verbose -Message ("Specified BinaryDir is an UNC path. Adding servername to Local " + "Intranet Zone") $uncInstall = $true if ($BinaryDir -match "\\\\(.*?)\\.*") { $serverName = $Matches[1] } else { $message = "Cannot extract servername from UNC path. Check if it is in the correct format." Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $MyInvocation.MyCommand.Source throw $message } Set-SPDscZoneMap -Server $serverName } Write-Verbose -Message "Writing install config file" $configPath = Join-Path -Path $env:temp -ChildPath "SPInstallConfig.xml" $configData = "<Configuration> <Package Id=`"sts`"> <Setting Id=`"LAUNCHEDFROMSETUPSTS`" Value=`"Yes`"/> </Package> <Package Id=`"spswfe`"> <Setting Id=`"SETUPCALLED`" Value=`"1`"/> </Package> <Logging Type=`"verbose`" Path=`"%temp%`" Template=`"SharePoint Server Setup(*).log`"/> <PIDKEY Value=`"$ProductKey`" /> <Display Level=`"none`" CompletionNotice=`"no`" /> " if ($PSBoundParameters.ContainsKey("InstallPath") -eq $true) { $configData += " <INSTALLLOCATION Value=`"$InstallPath`" /> " } if ($PSBoundParameters.ContainsKey("DataPath") -eq $true) { $configData += " <DATADIR Value=`"$DataPath`"/> " } $configData += " <Setting Id=`"SERVERROLE`" Value=`"APPLICATION`"/> <Setting Id=`"USINGUIINSTALLMODE`" Value=`"0`"/> <Setting Id=`"SETUP_REBOOT`" Value=`"Never`" /> <Setting Id=`"SETUPTYPE`" Value=`"CLEAN_INSTALL`"/> </Configuration>" $configData | Out-File -FilePath $configPath Write-Verbose -Message "Beginning installation of SharePoint" $setupExe = Join-Path -Path $BinaryDir -ChildPath "setup.exe" $setup = Start-Process -FilePath $setupExe ` -ArgumentList "/config `"$configPath`"" ` -Wait ` -PassThru if ($uncInstall -eq $true) { Write-Verbose -Message "Removing added path from the Local Intranet Zone" Remove-SPDscZoneMap -ServerName $serverName } # Exit codes: https://docs.microsoft.com/en-us/windows/desktop/msi/error-codes switch ($setup.ExitCode) { 0 { Write-Verbose -Message "SharePoint binary installation complete" $global:DSCMachineStatus = 1 } 3010 { Write-Verbose -Message "SharePoint binary installation complete, but reboot is required" $global:DSCMachineStatus = 1 } 30066 { $pr1 = ("HKLM:\Software\Microsoft\Windows\CurrentVersion\" + ` "Component Based Servicing\RebootPending") $pr2 = ("HKLM:\Software\Microsoft\Windows\CurrentVersion\" + ` "WindowsUpdate\Auto Update\RebootRequired") $pr3 = "HKLM:\SYSTEM\CurrentControlSet\Control\Session Manager" if ( ($null -ne (Get-Item -Path $pr1 -ErrorAction SilentlyContinue)) ` -or ($null -ne (Get-Item -Path $pr2 -ErrorAction SilentlyContinue)) ` -or ((Get-Item -Path $pr3 | Get-ItemProperty).PendingFileRenameOperations.count -gt 0) ` ) { Write-Verbose -Message ("SPInstall has detected the server has pending " + ` "a reboot. Flagging to the DSC engine that the " + ` "server should reboot before continuing.") $global:DSCMachineStatus = 1 } else { $message = ("SharePoint installation has failed due to an issue with prerequisites " + ` "not being installed correctly. Please review the setup logs.") Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $MyInvocation.MyCommand.Source throw $message } } Default { $message = "SharePoint install failed, exit code was $($setup.ExitCode)" Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $MyInvocation.MyCommand.Source throw $message } } } function Test-TargetResource { [CmdletBinding()] [OutputType([System.Boolean])] param ( [Parameter(Mandatory = $true)] [ValidateSet('Yes')] [String] $IsSingleInstance, [Parameter(Mandatory = $true)] [System.String] $BinaryDir, [Parameter(Mandatory = $true)] [System.String] $ProductKey, [Parameter()] [System.String] $InstallPath, [Parameter()] [System.String] $DataPath, [Parameter()] [ValidateSet("Present", "Absent")] [System.String] $Ensure = "Present" ) Write-Verbose -Message "Testing install status of SharePoint" $PSBoundParameters.Ensure = $Ensure if ($Ensure -eq "Absent") { $message = ("SharePointDsc does not support uninstalling SharePoint or " + ` "its prerequisites. Please remove this manually.") Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $MyInvocation.MyCommand.Source throw $message } $CurrentValues = Get-TargetResource @PSBoundParameters Write-Verbose -Message "Current Values: $(Convert-SPDscHashtableToString -Hashtable $CurrentValues)" Write-Verbose -Message "Target Values: $(Convert-SPDscHashtableToString -Hashtable $PSBoundParameters)" $result = Test-SPDscParameterState -CurrentValues $CurrentValues ` -Source $($MyInvocation.MyCommand.Source) ` -DesiredValues $PSBoundParameters ` -ValuesToCheck @("Ensure") Write-Verbose -Message "Test-TargetResource returned $result" return $result } function Export-TargetResource { param ( [Parameter()] [System.String] $ProductKey = "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX", [Parameter()] [System.String] $BinaryLocation = "\\<location>" ) $VerbosePreference = "SilentlyContinue" Add-ConfigurationDataEntry -Node "NonNodeData" -Key "FullInstallation" -Value "`$False" -Description "Specifies whether or not the DSC configuration script will install the SharePoint Prerequisites and Binaries;" $Content = " if (`$ConfigurationData.NonNodeData.FullInstallation)`r`n" $Content += " {`r`n" $Content += " SPInstall BinaryInstallation" + "`r`n {`r`n" if ([System.String]::IsNullOrEmpty($BinaryLocation)) { $BinaryLocation = "\\<location>" } Add-ConfigurationDataEntry -Node "NonNodeData" -Key "SPInstallationBinaryPath" -Value $BinaryLocation -Description "Location of the SharePoint Binaries (local path or network share);" $Content += " BinaryDir = `$ConfigurationData.NonNodeData.SPInstallationBinaryPath;`r`n" if ([System.String]::IsNullOrEmpty($ProductKey)) { $ProductKey = "xxxxx-xxxxx-xxxxx-xxxxx" } Add-ConfigurationDataEntry -Node "NonNodeData" -Key "SPProductKey" -Value $ProductKey -Description "SharePoint Product Key" $Content += " ProductKey = `$ConfigurationData.NonNodeData.SPProductKey;`r`n" $Content += " Ensure = `"Present`";`r`n" $Content += " IsSingleInstance = `"Yes`";`r`n" $Content += " PSDscRunAsCredential = `$Creds" + ($Global:spFarmAccount.Username.Split('\'))[1].Replace("-", "_").Replace(".", "_") + ";`r`n" $Content += " }`r`n" $Content += " }`r`n" return $Content } Export-ModuleMember -Function *-TargetResource |