Set-iBMCSyslogSetting

NAME Set-iBMCSyslogSetting



SYNOPSIS

Modify iBMC Syslog Notification Settings.





SYNTAX

Set-iBMCSyslogSetting [-Session] <RedfishSession[]> [[-ServiceEnabled] <Boolean[]>] [[-ServerIdentitySource]

{HostName | BoardSN | ProductAssetTag}] [[-AlarmSeverity] {Critical | Major | Minor | Normal}]

[[-TransmissionProtocol] {UDP | TCP | TLS}] [<CommonParameters>]





DESCRIPTION

Modify iBMC Syslog Notification Settings.





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



-ServiceEnabled <Boolean[]>

Indicates whether syslog is enabled.

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



Required? false

Position? 2

Default value

Accept pipeline input? true (ByValue, ByPropertyName)

Accept wildcard characters? false



-ServerIdentitySource

Indicates the notification server host identifier.

Available Value Set: BoardSN, ProductAssetTag, HostName.



Required? false

Position? 3

Default value

Accept pipeline input? true (ByValue, ByPropertyName)

Accept wildcard characters? false



-AlarmSeverity

Indicates which severity level alarm should be notified

Available Value Set: Critical, Major, Minor, Normal



Required? false

Position? 4

Default value

Accept pipeline input? true (ByValue, ByPropertyName)

Accept wildcard characters? false



-TransmissionProtocol

Indicates the transmission protocol of syslog.

Available Value Set: UDP, TCP, TLS



Required? false

Position? 5

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-iBMCSyslogSetting $session -ServiceEnabled $true -ServerIdentitySource HostName `

-AlarmSeverity Major -TransmissionProtocol UDP











RELATED LINKS

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



Get-iBMCSyslogSetting

Get-iBMCSyslogServer

Set-iBMCSyslogServer

Connect-iBMC

Disconnect-iBMC