Get-SqlDscRSSetupConfiguration: Fix for the SSRS 2016 case (#2347)

Author: Sidoran

CHANGELOG.md

@@ -129,6 +129,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 
+- `Get-SqlDscRSSetupConfiguration`
+  - Fixed issue where the function doesn't provide an output for SSRS 2016 instances
+    because registry paths were using `InstanceName` instead of `InstanceId`.
+    [issue #2346](https://github.com/dsccommunity/SqlServerDsc/issues/2346).
+  - Added fallback to `SQLPath` registry value for SQL 2016 and earlier when
+    `InstallRootDirectory` is not found [issue #2346](https://github.com/dsccommunity/SqlServerDsc/issues/2346).
+  - Added filtering to `MSReportServer_Instance` retrieval logic to handle the case
+    with many SSRSs.
 - `SqlRS`
   - Obtain the Reporting service name from WMI for version 14 and higher.
     [issue #2313](https://github.com/dsccommunity/SqlServerDsc/issues/2313)

source/Public/Get-SqlDscRSSetupConfiguration.ps1

@@ -92,20 +92,20 @@ function Get-SqlDscRSSetupConfiguration
         Write-Verbose -Message ($script:localizedData.Get_SqlDscRSSetupConfiguration_ProcessingInstance -f $instance.InstanceName)
 
         $returnObject = [PSCustomObject]@{
-            InstanceName                  = $instance.InstanceName
-            InstallFolder                 = $null
-            ServiceName                   = $null
-            ErrorDumpDirectory            = $null
-            CurrentVersion                = $null
-            CustomerFeedback              = $null
-            EnableErrorReporting          = $null
-            ProductVersion                = $null
-            VirtualRootServer             = $null
-            ConfigFilePath                = $null
-            EditionID                     = $null
-            EditionName                   = $null
-            IsSharePointIntegrated        = $null
-            InstanceId                    = $null
+            InstanceName           = $instance.InstanceName
+            InstallFolder          = $null
+            ServiceName            = $null
+            ErrorDumpDirectory     = $null
+            CurrentVersion         = $null
+            CustomerFeedback       = $null
+            EnableErrorReporting   = $null
+            ProductVersion         = $null
+            VirtualRootServer      = $null
+            ConfigFilePath         = $null
+            EditionID              = $null
+            EditionName            = $null
+            IsSharePointIntegrated = $null
+            InstanceId             = $instance.InstanceId
         }
 
         Write-Verbose -Message ($script:localizedData.Get_SqlDscRSSetupConfiguration_FoundInstance -f $instance.InstanceName)
@@ -115,11 +115,21 @@ function Get-SqlDscRSSetupConfiguration
         }
 
         # Get values from SSRS\Setup registry key
-        $getRegistryPropertyValueParameters.Path = 'HKLM:\SOFTWARE\Microsoft\Microsoft SQL Server\{0}\Setup' -f $instance.InstanceName
+        $getRegistryPropertyValueParameters.Path = 'HKLM:\SOFTWARE\Microsoft\Microsoft SQL Server\{0}\Setup' -f $returnObject.InstanceId
 
         # InstallRootDirectory
         $getRegistryPropertyValueParameters.Name = 'InstallRootDirectory'
         $returnObject.InstallFolder = Get-RegistryPropertyValue @getRegistryPropertyValueParameters
+        # Fallback to SQLPath if InstallRootDirectory is not found. This is the case for SQL 2016 and earlier.
+        if ($null -eq $returnObject.InstallFolder)
+        {
+            $getRegistryPropertyValueParameters.Name = 'SQLPath'
+            $returnObject.InstallFolder = Get-RegistryPropertyValue @getRegistryPropertyValueParameters
+            if (($null -ne $returnObject.InstallFolder) -and ($returnObject.InstallFolder -notmatch '^[A-Za-z]:\\?$'))
+            {
+                $returnObject.InstallFolder = $returnObject.InstallFolder.TrimEnd('\')
+            }
+        }
 
         # ServiceName
         $getRegistryPropertyValueParameters.Name = 'ServiceName'
@@ -134,7 +144,7 @@ function Get-SqlDscRSSetupConfiguration
         $returnObject.ConfigFilePath = Get-RegistryPropertyValue @getRegistryPropertyValueParameters
 
         # Get values from SSRS\CPE registry key
-        $getRegistryPropertyValueParameters.Path = 'HKLM:\SOFTWARE\Microsoft\Microsoft SQL Server\{0}\CPE' -f $instance.InstanceName
+        $getRegistryPropertyValueParameters.Path = 'HKLM:\SOFTWARE\Microsoft\Microsoft SQL Server\{0}\CPE' -f $returnObject.InstanceId
 
         # ErrorDumpDir
         $getRegistryPropertyValueParameters.Name = 'ErrorDumpDir'
@@ -149,7 +159,7 @@ function Get-SqlDscRSSetupConfiguration
         $returnObject.EnableErrorReporting = Get-RegistryPropertyValue @getRegistryPropertyValueParameters
 
         # Get values from SSRS\MSSQLServer\CurrentVersion registry key
-        $getRegistryPropertyValueParameters.Path = 'HKLM:\SOFTWARE\Microsoft\Microsoft SQL Server\{0}\MSSQLServer\CurrentVersion' -f $instance.InstanceName
+        $getRegistryPropertyValueParameters.Path = 'HKLM:\SOFTWARE\Microsoft\Microsoft SQL Server\{0}\MSSQLServer\CurrentVersion' -f $returnObject.InstanceId
 
         # CurrentVersion from registry
         $getRegistryPropertyValueParameters.Name = 'CurrentVersion'
@@ -164,8 +174,13 @@ function Get-SqlDscRSSetupConfiguration
             $reportServerCurrentVersion = [System.Version] $returnObject.CurrentVersion
 
             # Get values from MSReportServer_Instance
-            $msReportServerInstance = Get-CimInstance -Namespace ('root\Microsoft\SqlServer\ReportServer\RS_{0}\v{1}' -f $instance.InstanceName, $reportServerCurrentVersion.Major) -ClassName 'MSReportServer_Instance' -ErrorAction 'SilentlyContinue'
-
+            $getCimInstanceParameters = @{
+                Filter = "InstanceId='{0}'" -f $returnObject.InstanceId
+                Namespace = 'root\Microsoft\SqlServer\ReportServer\RS_{0}\v{1}' -f $instance.InstanceName, $reportServerCurrentVersion.Major
+                ClassName = 'MSReportServer_Instance'
+                ErrorAction = 'SilentlyContinue'
+            }
+            $msReportServerInstance = Get-CimInstance @getCimInstanceParameters
             if ($msReportServerInstance)
             {
                 $returnObject.EditionID = $msReportServerInstance.EditionID