Set HPOVSMTPConfig - HewlettPackard/POSH-HPEOneView GitHub Wiki

HPE OneView 4.10 Library

Set-HPOVSmtpConfig

Configure appliance SMTP Reporting settings.

SYNTAX

Set-HPOVSmtpConfig[ [-SenderEmailAddress] <String>][ [-Server] <String>][ [-Port] <Int32>][ [-ConnectionSecurity] <>][ [-Password] <String>][ [-AlertEmailEnabled] <SwitchParameter>][ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
Set-HPOVSmtpConfig [-AlertEmailDisabled] <SwitchParameter>[ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<CommonParameters>]

Detailed 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.

Parameters

-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

-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? named
Default value (${Global:ConnectedSessions} | ? Default)
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

-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

-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

-Port <Int32>

Aliases [-SmtpPort] 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

-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>

Aliases [-SmtpServer] 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

<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

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

The finished Task object that includes the task result

Examples

 -------------------------- EXAMPLE 1 --------------------------

Set-HPOVSMTPConfig -SenderEmailAddress [email protected] -alertEmailEnabled

Set the appliance"s SMTP Sender Email Address to "[email protected]" and enable SMTP Email Alerting.

 -------------------------- EXAMPLE 2 --------------------------

Set-HPOVSMTPConfig -SenderEmailAddress [email protected] -alertEmailEnabled

Set the appliance"s SMTP Sender Email Address to "[email protected]" and enable SMTP Email Alerting.

 -------------------------- EXAMPLE 3 --------------------------

Set-HPOVSMTPConfig -SenderEmailAddress [email protected] -AlertEmailEnabled -ConnectionSecurity StartTls

Set the appliance"s SMTP Sender Email Address to "[email protected]", enabling SMTP Email Alerting and specifying StartTls connection security.

Related Links


Top

HPE OneView 4.00 Library

Set-HPOVSmtpConfig

Configure appliance SMTP Reporting settings.

SYNTAX

Set-HPOVSmtpConfig[ [-SenderEmailAddress] <String>][ [-Server] <String>] [-Port] <Int32>[ [-ConnectionSecurity] <>] [-Password] <String>[ [-AlertEmailEnabled] <SwitchParameter>][ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
Set-HPOVSmtpConfig [-AlertEmailDisabled] <SwitchParameter>[ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<CommonParameters>]

Detailed 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.

Parameters

-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

-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? named
Default value (${Global:ConnectedSessions} | ? Default)
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

-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

-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? fasle
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters?    False

-Port <Int32>

Aliases [-SmtpPort] Provide an alternate TCP port number than the default SMTP port value 25/TCP.

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

-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>

Aliases [-SmtpServer] 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

<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

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

The finished Task object that includes the task result

Examples

 -------------------------- EXAMPLE 1 --------------------------

Set-HPOVSMTPConfig -SenderEmailAddress [email protected] -alertEmailEnabled

Set the appliance's SMTP Sender Email Address to '[email protected]' and enable SMTP Email Alerting.

 -------------------------- EXAMPLE 2 --------------------------

Set-HPOVSMTPConfig -SenderEmailAddress [email protected] -alertEmailEnabled

Set the appliance's SMTP Sender Email Address to '[email protected]' and enable SMTP Email Alerting.

 -------------------------- EXAMPLE 3 --------------------------

Set-HPOVSMTPConfig -SenderEmailAddress [email protected] -AlertEmailEnabled -ConnectionSecurity StartTls

Set the appliance's SMTP Sender Email Address to '[email protected]', enabling SMTP Email Alerting and specifying StartTls connection security.

Related Links


Top
⚠️ **GitHub.com Fallback** ⚠️