-
Notifications
You must be signed in to change notification settings - Fork 52
Test HPOVEmailAlert
Test appliance Email Alerting configuration.
Test-HPOVEmailAlert [-Recipients] <Array>[ [-Subject] <String>][ [-Body] <String>][ [-ApplianceConnection] <Object>] [<CommonParameters>]This cmdlet will generate a test email message.
-ApplianceConnection <Object>
Aliases [-Appliance]
Specify one or more HPOneView.Appliance.Connection object(s) or Name property value(s).
Default Value: ${Global:ConnectedSessions} | ? Default
| Aliases | Appliance |
| Required? | false |
| Position? | 3 |
| Default value | (${Global:ConnectedSessions} | ? Default) |
| 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? | 2 |
| Default value | Test email message from HPE OneView appliance. |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-Recipients <Array>
Specify the Sender Email Address for the appliance.
| Aliases | None |
| Required? | true |
| Position? | 0 |
| 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? | 1 |
| Default value | This is a test message. |
| 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)
None. You cannot pipe objects to this cmdlet.
System.Management.Automation.PSCustomObject
If successful, returns an object with the test message details.
-------------------------- EXAMPLE 1 --------------------------Test-HPOVEmailAlert -Recipients user1@contoso.com
Generate a test email message to "user1@contoso.com".
-------------------------- EXAMPLE 2 --------------------------Test-HPOVEmailAlert -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.
Test appliance Email Alerting configuration.
Test-HPOVEmailAlert [-Recipients] <Array>[ [-Subject] <String>] [-Body] <String>[ [-ApplianceConnection] <Object>] [<CommonParameters>]This cmdlet will generate a test email message.
-ApplianceConnection <Object>
Aliases [-Appliance]
Specify one or more HPOneView.Appliance.Connection object(s) or Name property value(s).
Default Value: ${Global:ConnectedSessions} | ? Default
| Aliases | Appliance |
| Required? | false |
| Position? | 3 |
| Default value | (${Global:ConnectedSessions} | ? Default) |
| 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? | fasle |
| Position? | 2 |
| Default value | Test email message from HPE OneView appliance. |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-Recipients <Array>
Specify the Sender Email Address for the appliance.
| Aliases | None |
| Required? | true |
| Position? | 0 |
| 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? | 1 |
| Default value | This is a test message. |
| 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)
None. You cannot pipe objects to this cmdlet.
System.Management.Automation.PSCustomObject
If successful, returns an object with the test message details.
-------------------------- EXAMPLE 1 --------------------------Test-HPOVEmailAlert -Recipients user1@contoso.com
Generate a test email message to 'user1@contoso.com'.
-------------------------- EXAMPLE 2 --------------------------Test-HPOVEmailAlert -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.