-
Notifications
You must be signed in to change notification settings - Fork 52
Set HPOVSMTPConfig
Configure appliance SMTP Reporting settings.
Set-HPOVSmtpConfig[ [-SenderEmailAddress] <String>][ [-Server] <String>] [-Port] <Int32> [-Password] <String>[ [-AlertEmailEnabled] <SwitchParameter>][ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<CommonParameters>]Set-HPOVSmtpConfig [-AlertEmailDisabled] <SwitchParameter>[ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<CommonParameters>]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.
-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 |
-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)
None. You cannot pipe objects to this cmdlet.
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
-------------------------- 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.
Configure appliance SMTP Reporting settings.
Set-HPOVSMTPConfig [-Server] <String> [-Port] <Int32> [-Password] <Object>[ [-AlertEmailEnabled] <SwitchParameter>] [-ApplianceConnection] <Object> [<CommonParameters>]Set-HPOVSMTPConfig [-Server] <String> [-Port] <Int32> [-Password] <Object>[ [-AlertEmailDisabled] <SwitchParameter>] [-ApplianceConnection] <Object> [<CommonParameters>]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.
-AlertEmailDisabled <SwitchParameter>
Disable SMTP Email Alerting.
| Aliases | None |
| Required? | false |
| 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? | true |
| Position? | named |
| Default value | (${Global:ConnectedSessions} | ? Default) |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-Password <Object>
Provide an SMTP Password to authenticate to the SMTP Server. Object can either be a String or SecureString value. This password will be sent in clear text to the SMTP server.
| Aliases | None |
| Required? | true |
| Position? | 2 |
| 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? | true |
| Position? | 1 |
| Default value | 25 |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-SenderEmailAddress <String>
Specify the Sender Email Address for the appliance.
| Aliases | None |
| Required? | true |
| Position? | 0 |
| 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? | true |
| Position? | 0 |
| 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)
None. You cannot pipe objects to this Cmdlet.
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.
-------------------------- 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.
Configure appliance SMTP Reporting settings.
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>]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.
-SenderEmailAddress <SenderEmailAddress>
Specify the Sender Email Address for the appliance.
| Aliases | None. |
| 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 | None. |
| 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 | None. |
| 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 | None. |
| Required? | false |
| Position? | 3 |
| Default value | |
| Accept pipeline input? | true (ByValue) |
| Accept wildcard characters? | false |
-alertEmailDisabled <alertEmailDisabled>
Disable SMTP Email Alerting.
| Aliases | None. |
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
-alertEmailEnabled <alertEmailEnabled>
Enable SMTP Email Alerting
| Aliases | None. |
| 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)
None. You cannot pipe objects to this cmdlet.
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.
-------------------------- 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.