Set-iBMCSMTPRecipient

NAME Set-iBMCSMTPRecipient



SYNOPSIS

Modify iBMC SMTP notify recipient of alarm emails.





SYNTAX

Set-iBMCSMTPRecipient [-Session] <RedfishSession[]> -MemberId <Int32[]> [-Enabled <Boolean[]>] [-EmailAddress

<String[]>] [-Description <String[]>] [<CommonParameters>]





DESCRIPTION

Modify iBMC SMTP notify recipient of alarm emails.





PARAMETERS

-Session <RedfishSession[]>

iBMC redfish session object which is created by Connect-iBMC cmdlet.

A session object identifies an iBMC server to which this cmdlet will be executed.



Required? true

Position? 1

Default value

Accept pipeline input? true (ByValue, ByPropertyName)

Accept wildcard characters? false



-MemberId <Int32[]>

Indicates which notification recipient to modify.

MemberId is the unique primary ID for notification recipient.

Support integer value range: [0, 3]



Required? true

Position? named

Default value

Accept pipeline input? true (ByValue, ByPropertyName)

Accept wildcard characters? false



-Enabled <Boolean[]>

Indicates Whether the notification recipient is enabled.

Support values are powershell boolean value: $true(1), $false(0).



Required? false

Position? named

Default value

Accept pipeline input? true (ByValue, ByPropertyName)

Accept wildcard characters? false



-EmailAddress <String[]>

Indicates the notificate recipient mailbox address.



Required? false

Position? named

Default value

Accept pipeline input? true (ByValue, ByPropertyName)

Accept wildcard characters? false



-Description <String[]>

Indicates the description of this recipient



Required? false

Position? named

Default value

Accept pipeline input? true (ByValue, ByPropertyName)

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 (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS

Null

Returns Null if cmdlet executes successfully.

In case of an error or warning, exception will be returned.





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



PS C:\\>$credential = Get-Credential



PS C:\\> $session = Connect-iBMC -Address 10.1.1.2 -Credential $credential -TrustCert

PS C:\\> Set-iBMCSMTPRecipient $session -MemberId 1 -Enabled $true -EmailAddress r2@huawei.com -Description 'desc'











RELATED LINKS

https://github.com/Huawei/Huawei-iBMC-Cmdlets



Get-iBMCSMTPSetting

Set-iBMCSMTPSetting

Get-iBMCSMTPRecipients

Connect-iBMC

Disconnect-iBMC