Add‑SqlDscRSUrlReservation

SYNOPSIS

Adds a URL reservation for SQL Server Reporting Services.

SYNTAX

Add-SqlDscRSUrlReservation [-Configuration] <Object> [-Application] <String> [-UrlString] <String>
 [[-Lcid] <Int32>] [-PassThru] [-Force] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

Adds a URL reservation for SQL Server Reporting Services or Power BI Report Server by calling the ReserveUrl method on the MSReportServer_ConfigurationSetting CIM instance.

This command reserves a URL for a specific application in the Reporting Services instance. The application can be the Report Server Web Service, the Reports web application (SQL Server 2016+), or the Report Manager (SQL Server 2014 and earlier).

The configuration CIM instance can be obtained using the Get-SqlDscRSConfiguration command and passed via the pipeline.

EXAMPLES

EXAMPLE 1

Get-SqlDscRSConfiguration -InstanceName 'SSRS' | Add-SqlDscRSUrlReservation -Application 'ReportServerWebService' -UrlString 'http://+:80'

Adds a URL reservation for the Report Server Web Service on port 80.

EXAMPLE 2

$config = Get-SqlDscRSConfiguration -InstanceName 'SSRS'
Add-SqlDscRSUrlReservation -Configuration $config -Application 'ReportServerWebApp' -UrlString 'https://+:443' -Confirm:$false

Adds a URL reservation for the Reports web application on port 443 without confirmation.

EXAMPLE 3

Get-SqlDscRSConfiguration -InstanceName 'SSRS' | Add-SqlDscRSUrlReservation -Application 'ReportServerWebService' -UrlString 'http://+:8080' -Lcid 1033 -PassThru

Adds a URL reservation with a specific LCID and returns the configuration CIM instance.

PARAMETERS

-Application

Specifies the application for which to reserve the URL. Valid values are:

• 'ReportServerWebService': The Report Server Web Service.
• 'ReportServerWebApp': The Reports web application (SQL Server 2016+).
• 'ReportManager': The Report Manager (SQL Server 2014 and earlier).

Type: String
Parameter Sets: (All)
Aliases:

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

-Configuration

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: (All)
Aliases:

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

-Force

If specified, suppresses the confirmation prompt.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Lcid

Specifies the language code identifier (LCID) for the URL reservation. If not specified, defaults to the operating system language. Common values include 1033 for English (US).

Type: Int32
Parameter Sets: (All)
Aliases:

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

-PassThru

If specified, returns the configuration CIM instance after adding the URL reservation.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-UrlString

Specifies the URL string to reserve. The URL string format is typically 'http://+:80' or 'https://+:443' where the plus sign (+) is a wildcard that matches all hostnames.

Type: String
Parameter Sets: (All)
Aliases:

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
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

Microsoft.Management.Infrastructure.CimInstance

Accepts MSReportServer_ConfigurationSetting CIM instance via pipeline.

OUTPUTS

None. By default, this command does not generate any output.

Microsoft.Management.Infrastructure.CimInstance

When PassThru is specified, returns the MSReportServer_ConfigurationSetting

CIM instance.

NOTES

The Reporting Services service may need to be restarted for the change to take effect.

RELATED LINKS

https://docs.microsoft.com/en-us/sql/reporting-services/wmi-provider-library-reference/configurationsetting-method-reserveurl