Get‑SqlDscRSConfiguration

SYNOPSIS

Gets the SQL Server Reporting Services configuration CIM instance.

SYNTAX

Get-SqlDscRSConfiguration [-InstanceName] <String> [[-Version] <Int32>] [[-RetryCount] <Int32>]
 [[-RetryDelaySeconds] <Int32>] [-SkipRetry] [<CommonParameters>]

DESCRIPTION

Gets the SQL Server Reporting Services or Power BI Report Server configuration CIM instance (MSReportServer_ConfigurationSetting). This CIM instance can be used with other commands that manage Reporting Services configuration, such as Enable-SqlDscRsSecureConnection and Disable-SqlDscRsSecureConnection.

The returned CIM instance provides access to properties documented in MSReportServer_ConfigurationSetting, such as SecureConnectionLevel, DatabaseServerName, VirtualDirectoryReportServer, WindowsServiceIdentityActual, 'WindowsServiceIdentityConfigured' and methods for managing Reporting Services configuration.

By default, if the CIM instance is not found on the first attempt, the command will retry after a delay. This handles intermittent failures when the Report Server service or WMI provider is not immediately ready. Use -SkipRetry to disable retry behavior.

EXAMPLES

EXAMPLE 1

Get-SqlDscRSConfiguration -InstanceName 'SSRS'

Returns the configuration CIM instance for the SSRS instance. The version is automatically detected. Retries once after 30 seconds if not found.

EXAMPLE 2

Get-SqlDscRSConfiguration -InstanceName 'SSRS' -Version 15

Returns the configuration CIM instance for the SSRS instance with explicit version 15 (SQL Server 2019).

EXAMPLE 3

Get-SqlDscRSConfiguration -InstanceName 'SSRS' | Enable-SqlDscRsSecureConnection

Gets the configuration CIM instance for the SSRS instance and enables secure connection using the pipeline.

EXAMPLE 4

Get-SqlDscRSConfiguration -InstanceName 'SSRS' -RetryCount 3 -RetryDelaySeconds 10

Returns the configuration CIM instance for the SSRS instance, retrying up to 3 times with a 10-second delay between attempts if not found.

EXAMPLE 5

Get-SqlDscRSConfiguration -InstanceName 'SSRS' -SkipRetry

Returns the configuration CIM instance for the SSRS instance without any retry attempts. Throws an error immediately if not found.

PARAMETERS

-InstanceName

Specifies the name of the Reporting Services instance. This is a mandatory parameter.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-RetryCount

Specifies the number of retry attempts if the CIM instance is not found. Default is 1 retry attempt.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: 1
Accept pipeline input: False
Accept wildcard characters: False

-RetryDelaySeconds

Specifies the delay in seconds between retry attempts. Default is 30 seconds.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: 30
Accept pipeline input: False
Accept wildcard characters: False

-SkipRetry

If specified, skips retry attempts and throws an error immediately if the CIM instance is not found.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Version

Specifies the major version number of the Reporting Services instance. If not specified, the version is automatically detected using Get-SqlDscRSSetupConfiguration.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

None.

OUTPUTS

Microsoft.Management.Infrastructure.CimInstance

Returns the MSReportServer_ConfigurationSetting CIM instance for the

specified Reporting Services instance.

NOTES

RELATED LINKS