Set-OVSMTPConfig

Syntax

Set-OVSMTPConfig
    [-SenderEmailAddress <String>]
    [-Server <String>]
    [-Port <Int32>]
    [-ConnectionSecurity <>]
    [-Password <String>]
    [-AlertEmailEnabled]
    [-UseMXRecordLookup]
    [-Async]
    [-ApplianceConnection <Object>]
    [<CommonParameters>]

Set-OVSMTPConfig
    [-AlertEmailDisabled]
    [-Async]
    [-ApplianceConnection <Object>]
    [<CommonParameters>]

Description

This Cmdlet configures the SMTP settings for the appliance. SMTP settings include deining the Sender EMAIL Address, SMTP relay server address, SMTP relay server TCP port, optional password, and if SMTP alerting is enabled or disabled.

Currently, HPE OneView does not support Secure SMTP, even though the TCP Port can be modified. Using the SmtpPort parameter is to specify an alternate TCP Port than the default TCP/25.

Examples

Example 1

Set-OVSMTPConfig -SenderEmailAddress hpov-alerts@contoso.com -alertEmailEnabled

Set the appliance"s SMTP Sender Email Address to "hpov-alerts@contoso.com" and enable SMTP Email Alerting.

Example 2

Set-OVSMTPConfig -SenderEmailAddress hpov-alerts@contoso.com -alertEmailEnabled

Set the appliance"s SMTP Sender Email Address to "hpov-alerts@contoso.com" and enable SMTP Email Alerting.

Example 3

Set-OVSMTPConfig -SenderEmailAddress hpov-alerts@contoso.com -AlertEmailEnabled -ConnectionSecurity StartTls

Set the appliance"s SMTP Sender Email Address to "hpov-alerts@contoso.com", enabling SMTP Email Alerting and specifying StartTls connection security.

Parameters

-SenderEmailAddress <String>

Specify the Sender Email Address for the appliance.

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

-Server <String>

Specify the SMTP Relay Server if DNS does not contain a valid DNS MX record for the sender email address domain name.

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

-Port <Int32>

Provide an alternate TCP port number than the default SMTP port value 25/TCP.

Aliases	SmtpPort
Required?	False
Position?	Named
Default value	25
Accept pipeline input?	false
Accept wildcard characters?	False

-Password <String>

Provide an SMTP Password to authenticate to the SMTP Server. This password will be sent in clear text to the SMTP server.

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

-AlertEmailDisabled <SwitchParameter>

Disable SMTP Email Alerting.

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

-AlertEmailEnabled <SwitchParameter>

Enable SMTP Email Alerting

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

-Async <SwitchParameter>

Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.

Aliases	None
Required?	False
Position?	Named
Default value	False
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

-ConnectionSecurity <>

Use to specify if the target SMTP server requires TLS security/authentication. Supported values:

None
TLS
StartTls

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

-UseMXRecordLookup <SwitchParameter>

Specify to use DNS MX record resolution for the domain in the email address provided.

Aliases	None
Required?	False
Position?	Named
Default value
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

HPEOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]

The finished Task object that includes the task result