Add‑SqlDscRSSslCertificateBinding - dsccommunity/SqlServerDsc GitHub Wiki

Adds an SSL certificate binding for SQL Server Reporting Services.

Add-SqlDscRSSslCertificateBinding [-Configuration] <Object> [-Application] <String> [-CertificateHash] <String>
 [[-IPAddress] <String>] [[-Port] <Int32>] [[-Lcid] <Int32>] [-PassThru] [-Force]
 [-WhatIf] [-Confirm] [<CommonParameters>]

Adds an SSL certificate binding for SQL Server Reporting Services or Power BI Report Server by calling the CreateSSLCertificateBinding method on the MSReportServer_ConfigurationSetting CIM instance.

This command binds an SSL certificate to a specific application, IP address, and port for the Reporting Services instance. URL reservations must be set prior for the specified application to determine if the TLS/SSL certificate binding is valid.

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

Get-SqlDscRSConfiguration -InstanceName 'SSRS' | Add-SqlDscRSSslCertificateBinding -Application 'ReportServerWebService' -CertificateHash 'A1B2C3D4E5F6...'

Adds an SSL certificate binding for the Report Server Web Service using the default IP address (0.0.0.0) and port (443).

$config = Get-SqlDscRSConfiguration -InstanceName 'SSRS'
Add-SqlDscRSSslCertificateBinding -Configuration $config -Application 'ReportServerWebApp' -CertificateHash 'A1B2C3D4E5F6...' -Port 8443 -Confirm:$false

Adds an SSL certificate binding on port 8443 without confirmation.

Get-SqlDscRSConfiguration -InstanceName 'SSRS' | Add-SqlDscRSSslCertificateBinding -Application 'ReportServerWebService' -CertificateHash 'A1B2C3D4E5F6...' -PassThru

Adds the SSL binding and returns the configuration CIM instance.

Specifies the application for which to create the SSL binding. 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

Specifies the thumbprint (hash) of the SSL certificate to bind. The certificate must be installed in the local machine certificate store.

Type: String
Parameter Sets: (All)
Aliases:

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

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

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

Specifies the IP address for the SSL binding. Use '0.0.0.0' to bind to all IP addresses. Default value is '0.0.0.0'.

Type: String
Parameter Sets: (All)
Aliases:

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

Specifies the language code identifier (LCID) for the operation. 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: 6
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

If specified, returns the configuration CIM instance after adding the SSL certificate binding.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

Specifies the port number for the SSL binding. Default value is 443.

Type: Int32
Parameter Sets: (All)
Aliases:

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

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

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

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

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

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