NAME

Set-DcsSMTPSettings

SYNOPSIS

Adds SMTP settings for the mail server used for outgoing email messages for the server group.

SYNTAX

Set-DcsSMTPSettings   [ -SMTPServer <String> ]   [ -EmailAddress <String> ]   [ -Username <String> ]   [ -Password <String> ]   [ -TCPPort <Int32> ]   [ -UseSSL <Boolean> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Adds SMTP settings for the mail server used for outgoing email messages for the server group. In order to send email notifications, the mail server and other settings must be configured. Specify the parameters to set or change.

PARAMETERS

-SMTPServer<String>
Name, ID, or address that identifies the mail server.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-EmailAddress<String>
Use this parameter to set the email address of the sender of the email. This could be a dedicated email address used for email notifications.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Username<String>
Use this parameter to set the user name of the email logon account. User name must match an existing account known to the operating system and exist on all servers in the server group.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Password<String>
Use this parameter to set the password of the email logon account.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-TCPPort<Int32>
Use this parameter to set the TCP port to use for the mail server. If not specified, the default port number of 25 will be used. Port 25 is standard and correct for most environments.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-UseSSL<Boolean>
Use the parameter to specify whether or not to use SSL encryption for security. Specify $true to use SSL encryption or $false to not use SSL encryption.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection is used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

OUTPUTS

SmtpServerSettings : Object that contains the SMTP settings for the server group.

NOTES

Also see Get-DcsSMTPSetting.

EXAMPLES


-------------- Example 1 Sets SMTP server settings for the server group --------------
Set-DcsSMTPSettings -SMTPServer cas.datacoresoftware.com -EmailAddress SANadministrator@datacore.com -Username SANadministrator -Password Adminpw1!
		

SMTP server for outgoing messages is set as "cas.datacoresoftware.com" with an email address of "SANadministrator@datacore.com". The user name is set as "SANadministrator" and the password is set to "Adminpw1!." The TCP port was not specified, so the default setting of 25 will be used.

SmtpServer:cas.datacoresoftware.com
EmailAddress:SANadministrator@datacore.com
Username:SANadministrator
TcpPort:25
UseSSL:False