Set HPOVSMTPConfig

Library Version 2.00

Library Version 1.20

HPE OneView 2.00 Library

## Set-HPOVSMTPConfig

Configure appliance SMTP Reporting settings. ### SYNTAX

Set-HPOVSMTPConfig [-SmtpServer] <String> [-SmtpPort] <Int32> [-Password] <String>[ [-alertEmailEnabled] <SwitchParameter>] [-ApplianceConnection] <Object> [<CommonParameters>]

Set-HPOVSMTPConfig [-SmtpServer] <String> [-SmtpPort] <Int32> [-Password] <String>[ [-alertEmailDisabled] <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

-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?	true
Position?	named
Default value	(${Global:ConnectedSessions} | ? Default)
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	Appliance
Required?	true
Position?	2
Default value
Accept pipeline input?	false
Accept wildcard characters?	False

-SenderEmailAddress <String>

Specify the Sender Email Address for the appliance.

Aliases	Appliance
Required?	true
Position?	0
Default value
Accept pipeline input?	false
Accept wildcard characters?	False

-SmtpPort <Int32>

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

Aliases	Appliance
Required?	true
Position?	1
Default value	25
Accept pipeline input?	false
Accept wildcard characters?	False

-SmtpServer <String>

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

Aliases	Appliance
Required?	true
Position?	0
Default value
Accept pipeline input?	false
Accept wildcard characters?	False

-alertEmailDisabled <SwitchParameter>

Disable SMTP Email Alerting.

Aliases	Appliance
Required?	false
Position?	named
Default value	False
Accept pipeline input?	false
Accept wildcard characters?	False

-alertEmailEnabled <SwitchParameter>

Enable SMTP Email Alerting

Aliases	Appliance
Required?	false
Position?	named
Default value	False
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

System.Management.Automation.PSCustomObject

If successful, returns an async task resource that can be monitored with status and progress of the saved email notification operation.

### Examples

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

PS C:\> Set-HPOVSMTPConfig -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 --------------------------

PS C:\> Set-HPOVSMTPConfig -SenderEmailAddress hpov-alerts@contoso.com -alertEmailEnabled

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

Related Links

• [Get-HPOVSMTPConfig] (https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVSMTPConfig)
• [Add-HPOVSmtpAlertEmailFilter] (https://github.com/HewlettPackard/POSH-HPOneView/wiki/Add-HPOVSmtpAlertEmailFilter)

Top

HPE OneView 1.20 Library

## Set-HPOVSMTPConfig

Configure appliance SMTP Reporting settings. ### SYNTAX

Set-HPOVSMTPConfig [-SenderEmailAddress] <SenderEmailAddress>[ [-SmtpServer] <SmtpServer>][ [-SmtpPort] <SmtpPort>][ [-Password] <Password>][ [-alertEmailEnabled] <alertEmailEnabled>] [<CommonParameters>]

Set-HPOVSMTPConfig [-SenderEmailAddress] <SenderEmailAddress>[ [-SmtpServer] <SmtpServer>][ [-SmtpPort] <SmtpPort>][ [-Password] <Password>][ [-alertEmailDisabled] <alertEmailDisabled>] [<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, HP 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

-SenderEmailAddress <SenderEmailAddress>

Specify the Sender Email Address for the appliance.

Aliases
Required?	true
Position?	1
Default value
Accept pipeline input?	true (ByValue)
Accept wildcard characters?	false

-SmtpServer <SmtpServer>

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

Aliases
Required?	false
Position?	1
Default value
Accept pipeline input?	true (ByValue)
Accept wildcard characters?	false

-SmtpPort <SmtpPort>

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

Aliases
Required?	false
Position?	2
Default value	25
Accept pipeline input?	false
Accept wildcard characters?	false

-Password <Password>

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

Aliases
Required?	false
Position?	3
Default value
Accept pipeline input?	true (ByValue)
Accept wildcard characters?	false

-alertEmailDisabled <alertEmailDisabled>

Disable SMTP Email Alerting.

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

-alertEmailEnabled <alertEmailEnabled>

Enable SMTP Email Alerting

Aliases
Required?	false
Position?	named
Default value	False
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

System.Management.Automation.PSCustomObject

If successful, returns an async task resource that can be monitored with status and progress of the saved email notification operation.

### Examples

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

PS C:\> Set-HPOVSMTPConfig -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 --------------------------

PS C:\> Set-HPOVSMTPConfig -SenderEmailAddress hpov-alerts@contoso.com -alertEmailEnabled

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

Related Links

• [Get-HPOVSMTPConfig] (https://github.com/HewlettPackard/POSH-HPOneView/wiki/Get-HPOVSMTPConfig)
• [Add-HPOVSmtpAlertEmailFilter] (https://github.com/HewlettPackard/POSH-HPOneView/wiki/Add-HPOVSmtpAlertEmailFilter)

Top