Cmdlets > Test-DtEmailNotification

Test-DtEmailNotification

Tests e-mail configuration

Syntax

Test-DtEmailNotification [-ServiceHost] <Server> [-Options] <EmailNotificationOptions> [-To] <String> [-Body] <String> [<CommonParameters>]

Detailed Description

Tests the e-mail options configured with Set-DtEmailNotificationOptions by attempting to send an e-mail to the specified recipient.

Parameters

Name	Type	Description	Required	Pipeline Input
Service Host	Server	Specify the server object returned from the New-DtServer cmdlet. For this cmdlet, the -ServiceHost could be your source or target server.	true	false
Options	EmailNotificationOptions	Specify the object returned from the Get-DtEmailNotificationOptions cmdlet.	true	false
To	String	Specify the e-mail address that the test Double-Take e-mail message should be sent to. Multiple addresses can be separated by a comma.	true	false
Body	String	Specify the text of the test Double-Take email message.	true	false

Outputs

None

Examples

$DtServerObjectAlpha= New-DtServer -Name alpha -UserName domain\administrator -Password password

$DtEmailOptions = Get-DtEmailNotificationOptions -ServiceHost $DtServerObject

$DtEmailOptions.Enabled = $true

$DtEmailOptions.SmtpServer = "mail.company.com"

Set-DtEmailNotificationOptions -ServiceHost $DtServerObjectAlpha -Options $DtEmailOptions

Test-DtEmailNotification -ServiceHost $DtServerObjectAlpha -Options $DtEmailOptions -To "administrator@mail.company.com" -Body "This is a test Double-Take message."

Disconnect-DtServer -ServiceHost $DtServerObjectAlpha

A server object is created for the server alpha using the domain\administrator and password credentials. It assigns the server object to the variable called DtServerObjectAlpha. Then the default Double-Take e-mail notification options are stored in the variable DtEmailOptions. Two of the options are then changed. The Enabled option is set to true which turns on the e-mail notification feature. The SMTP server is also configured for mail.company.com. Those changes for the email notification options are set on the server. Finally a test message is sent to the administrator@mail.company.com addresses with the specified message text using the configured e-mail notification options. The connections for the server object are then closed.