DSCResources/MSFT_SPConfigWizard/MSFT_SPConfigWizard.psm1
|
function Get-TargetResource { [CmdletBinding()] [OutputType([System.Collections.Hashtable])] param ( [Parameter(Mandatory = $true)] [ValidateSet('Yes')] [String] $IsSingleInstance, [Parameter()] [ValidateSet("Present", "Absent")] [System.String] $Ensure = "Present", [Parameter()] [ValidateSet("mon", "tue", "wed", "thu", "fri", "sat", "sun")] [System.String[]] $DatabaseUpgradeDays, [Parameter()] [System.String] $DatabaseUpgradeTime, [Parameter()] [System.Management.Automation.PSCredential] $InstallAccount ) Write-Verbose -Message "Getting status of Configuration Wizard" # Check which version of SharePoint is installed if ((Get-SPDscInstalledProductVersion).FileMajorPart -eq 15) { $wssRegKey = "hklm:SOFTWARE\Microsoft\Shared Tools\Web Server Extensions\15.0\WSS" } else { $wssRegKey = "hklm:SOFTWARE\Microsoft\Shared Tools\Web Server Extensions\16.0\WSS" } # Read LanguagePackInstalled and SetupType registry keys $languagePackInstalled = Get-SPDscRegistryKey -Key $wssRegKey -Value "LanguagePackInstalled" $setupType = Get-SPDscRegistryKey -Key $wssRegKey -Value "SetupType" # Determine if LanguagePackInstalled=1 or SetupType=B2B_Upgrade. # If so, the Config Wizard is required if (($languagePackInstalled -eq 1) -or ($setupType -eq "B2B_UPGRADE")) { return @{ IsSingleInstance = "Yes" Ensure = "Absent" DatabaseUpgradeDays = $DatabaseUpgradeDays DatabaseUpgradeTime = $DatabaseUpgradeTime } } else { return @{ IsSingleInstance = "Yes" Ensure = "Present" DatabaseUpgradeDays = $DatabaseUpgradeDays DatabaseUpgradeTime = $DatabaseUpgradeTime } } } function Set-TargetResource { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [ValidateSet('Yes')] [String] $IsSingleInstance, [Parameter()] [ValidateSet("Present", "Absent")] [System.String] $Ensure = "Present", [Parameter()] [ValidateSet("mon", "tue", "wed", "thu", "fri", "sat", "sun")] [System.String[]] $DatabaseUpgradeDays, [Parameter()] [System.String] $DatabaseUpgradeTime, [Parameter()] [System.Management.Automation.PSCredential] $InstallAccount ) Write-Verbose -Message "Setting status of Configuration Wizard" # Check which version of SharePoint is installed if ((Get-SPDscInstalledProductVersion).FileMajorPart -eq 15) { $wssRegKey = "hklm:SOFTWARE\Microsoft\Shared Tools\Web Server Extensions\15.0\WSS" } else { $wssRegKey = "hklm:SOFTWARE\Microsoft\Shared Tools\Web Server Extensions\16.0\WSS" } # Read LanguagePackInstalled and SetupType registry keys $languagePackInstalled = Get-SPDscRegistryKey -Key $wssRegKey -Value "LanguagePackInstalled" # Getting the servers patch status from SharePoint # https://docs.microsoft.com/en-us/dotnet/api/microsoft.sharepoint.administration.spserverproductinfo.statustype $statusType = Invoke-SPDscCommand -Credential $InstallAccount ` -Arguments $PSBoundParameters ` -ScriptBlock { return Get-SPDscServerPatchStatus } if ($languagePackInstalled -eq 1) { Write-Verbose -Message "Config Wizard required because of language pack install" } else { Write-Verbose -Message ("No language pack was installed. Checking if all servers in " + ` "the farm have the binaries installed") Write-Verbose -Message ("Server status: $statusType (Has to be 'UpgradeAvailable' or " + ` "'UpgradeRequired' to continue)") if ($statusType -ne "UpgradeRequired" -and $statusType -ne "UpgradeAvailable") { Write-Verbose -Message ("WARNING: Upgrade not possible, not all servers have the " + ` "same binaries installed. Skipping Config Wizard!") return } } # Check if DatabaseUpgradeDays parameter exists $now = Get-Date if ($DatabaseUpgradeDays) { Write-Verbose -Message "DatabaseUpgradeDays parameter exists, check if current day is specified" $currentDayOfWeek = $now.DayOfWeek.ToString().ToLower().Substring(0, 3) if ($DatabaseUpgradeDays -contains $currentDayOfWeek) { Write-Verbose -Message ("Current day is present in the parameter DatabaseUpgradeDays. " + ` "Configuration wizard can be run today.") } else { Write-Verbose -Message ("Current day is not present in the parameter DatabaseUpgradeDays, " + ` "skipping the Configuration Wizard") return } } else { Write-Verbose -Message ("No DatabaseUpgradeDays specified, Configuration Wizard can be " + ` "ran on any day.") } # Check if DatabaseUpdateTime parameter exists if ($DatabaseUpgradeTime) { Write-Verbose -Message "DatabaseUpgradeTime parameter exists, current time is inside of time window" $upgradeTimes = $DatabaseUpgradeTime.Split(" ") $starttime = 0 $endtime = 0 if ($upgradeTimes.Count -ne 3) { $message = "Time window incorrectly formatted." Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $MyInvocation.MyCommand.Source throw $message } else { if ([datetime]::TryParse($upgradeTimes[0], [ref]$starttime) -ne $true) { $message = "Error converting start time" Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $MyInvocation.MyCommand.Source throw $message } if ([datetime]::TryParse($upgradeTimes[2], [ref]$endtime) -ne $true) { $message = "Error converting end time" Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $MyInvocation.MyCommand.Source throw $message } if ($starttime -gt $endtime) { $message = "Error: Start time cannot be larger than end time" Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $MyInvocation.MyCommand.Source throw $message } } if (($starttime -lt $now) -and ($endtime -gt $now)) { Write-Verbose -Message ("Current time is inside of the window specified in " + ` "DatabaseUpgradeTime. Starting wizard") } else { Write-Verbose -Message ("Current time is outside of the window specified in " + ` "DatabaseUpgradeTime, skipping the Configuration Wizard") return } } else { Write-Verbose -Message ("No DatabaseUpgradeTime specified, Configuration Wizard can be " + ` "ran at any time. Starting wizard.") } if ($Ensure -eq "Absent") { Write-Verbose -Message ("Ensure is set to Absent, so running the Configuration " + ` "Wizard is not required") return } # Check which version of SharePoint is installed if ((Get-SPDscInstalledProductVersion).FileMajorPart -eq 15) { $binaryDir = Join-Path $env:CommonProgramFiles "Microsoft Shared\Web Server Extensions\15\BIN" } else { $binaryDir = Join-Path $env:CommonProgramFiles "Microsoft Shared\Web Server Extensions\16\BIN" } $psconfigExe = Join-Path -Path $binaryDir -ChildPath "psconfig.exe" # Start wizard Write-Verbose -Message "Starting Configuration Wizard" $result = Invoke-SPDscCommand -Credential $InstallAccount ` -Arguments $psconfigExe ` -ScriptBlock { $psconfigExe = $args[0] Write-Verbose -Message "Starting 'Product Version Job' timer job" $pvTimerJob = Get-SPTimerJob -Identity 'job-admin-product-version' $lastRunTime = $pvTimerJob.LastRunTime Start-SPTimerJob -Identity $pvTimerJob $jobRunning = $true $maxCount = 30 $count = 0 Write-Verbose -Message "Waiting for 'Product Version Job' timer job to complete" while ($jobRunning -and $count -le $maxCount) { Start-Sleep -Seconds 10 $pvTimerJob = Get-SPTimerJob -Identity 'job-admin-product-version' $jobRunning = $lastRunTime -eq $pvTimerJob.LastRunTime $count++ } $stdOutTempFile = "$env:TEMP\$((New-Guid).Guid)" $psconfig = Start-Process -FilePath $psconfigExe ` -ArgumentList "-cmd upgrade -inplace b2b -wait -cmd applicationcontent -install -cmd installfeatures -cmd secureresources -cmd services -install" ` -RedirectStandardOutput $stdOutTempFile ` -Wait ` -PassThru $cmdOutput = Get-Content -Path $stdOutTempFile -Raw Remove-Item -Path $stdOutTempFile if ($null -ne $cmdOutput) { Write-Verbose -Message $cmdOutput.Trim() } Write-Verbose -Message "PSConfig Exit Code: $($psconfig.ExitCode)" return $psconfig.ExitCode } # Error codes: https://aka.ms/installerrorcodes switch ($result) { 0 { Write-Verbose -Message "SharePoint Post Setup Configuration Wizard ran successfully" } Default { $message = ("SharePoint Post Setup Configuration Wizard failed, " + ` "exit code was $result. Error codes can be found at " + ` "https://aka.ms/installerrorcodes") 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()] [ValidateSet("Present", "Absent")] [System.String] $Ensure = "Present", [Parameter()] [ValidateSet("mon", "tue", "wed", "thu", "fri", "sat", "sun")] [System.String[]] $DatabaseUpgradeDays, [Parameter()] [System.String] $DatabaseUpgradeTime, [Parameter()] [System.Management.Automation.PSCredential] $InstallAccount ) Write-Verbose -Message "Testing status of Configuration Wizard" $PSBoundParameters.Ensure = $Ensure if ($Ensure -eq "Absent") { Write-Verbose -Message ("Ensure is set to Absent, so running the Configuration Wizard " + ` "is not required") return $true } $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 } Export-ModuleMember -Function *-TargetResource |