Set‑SqlDscRSSmtpConfiguration

SYNOPSIS

Sets the SMTP configuration for SQL Server Reporting Services.

SYNTAX

Set-SqlDscRSSmtpConfiguration [-Configuration] <Object> [-SmtpServer] <String> [-SenderEmailAddress] <String>
 [-PassThru] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Sets the SMTP configuration for SQL Server Reporting Services or Power BI Report Server by calling the SetEmailConfiguration method on the MSReportServer_ConfigurationSetting CIM instance.

This command configures the SMTP settings used for email delivery of reports through subscriptions.

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

EXAMPLES

EXAMPLE 1

Get-SqlDscRSConfiguration -InstanceName 'SSRS' | Set-SqlDscRSSmtpConfiguration -SmtpServer 'smtp.contoso.com' -SenderEmailAddress 'reports@contoso.com'

Configures SMTP delivery using the specified SMTP server.

EXAMPLE 2

$config = Get-SqlDscRSConfiguration -InstanceName 'SSRS'
Set-SqlDscRSSmtpConfiguration -Configuration $config -SmtpServer 'smtp.contoso.com' -SenderEmailAddress 'reports@contoso.com' -Force

Configures SMTP delivery without confirmation.

EXAMPLE 3

Get-SqlDscRSConfiguration -InstanceName 'SSRS' | Set-SqlDscRSSmtpConfiguration -SmtpServer 'smtp.contoso.com' -SenderEmailAddress 'reports@contoso.com' -PassThru

Configures SMTP delivery and returns the configuration CIM instance.

PARAMETERS

-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

-PassThru

If specified, returns the configuration CIM instance after setting the SMTP configuration.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-SenderEmailAddress

Specifies the email address to use in the "From" field of sent emails.

Type: String
Parameter Sets: (All)
Aliases:

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

-SmtpServer

Specifies the SMTP server to use for sending email. This can be a server name or IP address.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
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 changes to take effect.

RELATED LINKS

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