Test‑SqlDscRSAccessible - dsccommunity/SqlServerDsc GitHub Wiki

Tests if SQL Server Reporting Services sites are accessible.

Test-SqlDscRSAccessible -Configuration <Object> [-ServerName <String>] [-TimeoutSeconds <Int32>]
 [-RetryIntervalSeconds <Int32>] [-Detailed] [<CommonParameters>]

Test-SqlDscRSAccessible [-ReportServerUri <String>] [-ReportsUri <String>] [-TimeoutSeconds <Int32>]
 [-RetryIntervalSeconds <Int32>] [-Detailed] [<CommonParameters>]

Tests if SQL Server Reporting Services or Power BI Report Server web sites are accessible by making HTTP requests to the configured URLs.

This command can be used to verify that a Reporting Services instance is fully configured and responding to web requests after initialization.

The command supports two modes:

• Configuration mode: Uses a CIM configuration instance to automatically detect the configured URLs from URL reservations.
• URI mode: Uses explicitly specified URIs for the ReportServer and/or Reports sites.

When using the Configuration parameter set, a dynamic -Site parameter becomes available that allows selecting which sites to test. The available sites are determined from the URL reservations configured for the instance.

Get-SqlDscRSConfiguration -InstanceName 'SSRS' | Test-SqlDscRSAccessible

Tests if all configured sites for the SSRS instance are accessible. Returns $true if all sites return HTTP 200, $false otherwise.

$config = Get-SqlDscRSConfiguration -InstanceName 'SSRS'
Test-SqlDscRSAccessible -Configuration $config -Site 'ReportServerWebService'

Tests if only the ReportServerWebService site is accessible for the SSRS instance.

Test-SqlDscRSAccessible -ReportServerUri 'http://localhost/ReportServer' -ReportsUri 'http://localhost/Reports'

Tests if the specified ReportServer and Reports URIs are accessible using explicit URIs.

Get-SqlDscRSConfiguration -InstanceName 'SSRS' | Test-SqlDscRSAccessible -Detailed

Tests if all configured sites are accessible and returns a detailed object with status information for each site.

Specifies the MSReportServer_ConfigurationSetting CIM instance for the Reporting Services instance. This can be obtained using the Get-SqlDscRSConfiguration command. This parameter accepts pipeline input.

Type: Object
Parameter Sets: Configuration
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

When specified, returns a detailed object containing accessibility status, HTTP status codes, and URIs for each site instead of a simple boolean.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

Specifies the explicit URI for the ReportServer web service to test. This parameter is used in the Uri parameter set.

Type: String
Parameter Sets: Uri
Aliases:

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

Specifies the explicit URI for the Reports web portal to test. This parameter is used in the Uri parameter set.

Type: String
Parameter Sets: Uri
Aliases:

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

Specifies the interval in seconds between retry attempts. Defaults to 5 seconds.

Type: Int32
Parameter Sets: (All)
Aliases:

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

Specifies the server name to use when constructing URLs from the configuration. Defaults to $env:COMPUTERNAME.

Type: String
Parameter Sets: Configuration
Aliases:

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

Specifies the maximum time in seconds to wait for the sites to become accessible. Defaults to 120 seconds.

Type: Int32
Parameter Sets: (All)
Aliases:

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

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

This command uses Invoke-WebRequest with -UseDefaultCredentials to authenticate to the Reporting Services sites.