Skip to content

Test-OVEmailAlert

Syntax

Test-OVEmailAlert
    [-Recipients] <Array>
    [-Subject <String>]
    [-Body <String>]
    [-ApplianceConnection <Object>]
    [<CommonParameters>]

Description

This Cmdlet will generate a test email message.

Examples

Example 1

Test-OVEmailAlert -Recipients user1@contoso.com

Generate a test email message to "user1@contoso.com".

Example 2

Test-OVEmailAlert -Recipients user1@contoso.com.,user2@contoso.com -Subject "This is a test email message." 

Generate a test email message to multiple recipients with a custom subject.

Parameters

-Recipients <Array>

Specify the Sender Email Address for the appliance.

Aliases None
Required? True
Position? Named
Default value
Accept pipeline input? false
Accept wildcard characters? False

-Subject <String>

Provide a custom subject for the email message.

Aliases None
Required? False
Position? Named
Default value This is a test message.
Accept pipeline input? false
Accept wildcard characters? False

-Body <String>

Provide a custom message body. Can be either a plan text or HTML message.

Aliases None
Required? False
Position? Named
Default value Test email message from HPE OneView appliance.
Accept pipeline input? false
Accept wildcard characters? False

-ApplianceConnection <Object>

Specify one or more [HPEOneView.Appliance.Connection] object(s) or Name property value(s).

Aliases Appliance
Required? False
Position? Named
Default value (${Global:ConnectedSessions} | ? Default)
Accept pipeline input? false
Accept wildcard characters? False

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)

Input Types

None. You cannot pipe objects to this Cmdlet.

Return Values

If successful, returns an object with the test message details.