代码仓
中
更新时间: 2026/11/09
在AtomGit上查看源码

event ​

版本信息 ​

项目内容
组件版本0.0.111(event_mgmt)
首发版本openUBMC 26.09
文档作者mkdlf
最后更新2026-11-03

版本信息表中的“首发版本”指event_mgmt组件首次随openUBMC发布的版本;各接口表中的“首发版本”指bmc.kepler.Systems.Events接口在mdb_interface中首次发布的版本。

1. 组件概述 ​

1.1 组件简介 ​

event组件主要用于承载BMC的事件管理,通过SEL日志记录事件消息,例如硬件错误、故障、告警等,并维护告警数量等信息以表征当前系统健康状态。

说明:本文档描述C++重构版本event_mgmt的接口行为。event_mgmt与原Lua版event组件功能基本一致,仅组件包名不同,D-Bus服务名仍为bmc.kepler.event。稳定前event与event_mgmt同步新增特性;稳定后event仅维护缺陷,新增功能主要由event_mgmt支持。

1.2 解决什么问题 ​

  • 管理事件对象,新增事件时发信号,便于运维监听、上报
  • 管理部件健康状态
  • 管理系统健康状态
  • 管理硬件健康状态

1.3 核心功能 ​

  • 事件与告警

对外呈现事件与告警两种不同的日志,但对于Event,两者仅严重等级不同,Normal级别的日志称为事件,告警则是Normal级别以上的日志。

  • 管理事件状态
  1. 所有日志都通过Event对象进行管理,即每一条日志都归属于一个对象
  2. 所有对象都有Assert/Deassert两种状态,所以也包括Normal级别的事件
  • 管理硬件健康状态
  1. 硬件事件通过CSR中Event对象的AffectHardwareHealth属性控制是否参与硬件健康判断,软件事件通过AddEvent的AffectHardwareHealth参数控制
  2. 系统硬件健康状态HardwareHealth由参与判断的事件中最高严重等级决定
  • 提供告警机制
  1. 读值监听

  2. 接口添加

1.4 外部交互边界图 ​

2. API 使用说明与示例 ​

2.1 GetAlarmList ​

功能说明 ​

查询当前告警。

属性内容
接口名bmc.kepler.Systems.Events
首发版本bmcsdk 25.03
废弃状态正常可用

参数说明 ​

参数名方向类型描述取值范围
StartId输入U16事件索引,(正序)从第几个开始查询U16
Count输入U16要查询的事件条数U16
QueryParameters输入Array查询条件列表,当前支持语言(Lang:en/zh)、严重等级(Severity:Normal/Minor/Major/Critical,严重程度从低到高为 Normal < Minor < Major < Critical,返回指定等级及更严重等级)和事件码(EventCode)数组元素为键值对,其中Key、Value均为字符串类型
Total输出U16事件总条数U16
EventList输出Array事件详细信息列表数组元素仍为数组(记为a1),a1的元素为键值对,其中Key、Value均为字符串类型

Severity不传时默认按Minor过滤,即返回 Minor/Major/Critical;传入某个等级时返回该等级及更严重等级,例如 Major 返回 Major/Critical,Critical 仅返回 Critical,Normal 返回全部等级。传入 Normal 时会过滤部分重启类事件。

返回值与异常 ​

返回值含义触发条件处理建议
Total不为0成功环境上产生了告警无
Total为0环境上没有产生告警时为成功,如果环境实际产生了告警,则意味着查询失败查询当前告警如果环境实际产生了告警,则要检查入参是否正确
抛错InternalError失败代码内部错误检查CSR配置或代码实现

应用场景 ​

查询当前告警。

调试示例 ​

命令行调试 ​
  • 不带条件查询10条索引从0开始的事件
bash
busctl --user call bmc.kepler.event /bmc/kepler/Systems/1/Events bmc.kepler.Systems.Events GetAlarmList 'a{ss}qqa(ss)' 3 Interface cli UserName Administrator ClientAddr <ip> 0 10 0

响应:qa(a(ss)) 1 30 1 "Cause" "1. The power cable is not securely connected or is faulty.@#AB;2. The PSU is faulty." 1 "Description" "The AC/DC input of PSU 2 is lost or out-of-range (SN:xxx, BN:xxx)." 1 "SN" "xxx" 1 "Influence" "The system is powered off unexpectedly." 1 "Suggestion" "1. Check whether the power cables are disconnected or loose.@#AB;2. Replace the power cables.@#AB;3. Replace the PSU." 1 "Timestamp" "1776481334" 1 "TriggerMode" "1" 1 "EventCode" "0x0300000D" 1 "ActionId" "0" 1 "RecordId" "110" 1 "PN" "xxx" 1 "ChassisId" "" 1 "ManagerId" "1" 1 "SystemId" "1" 1 "Severity" "Critical" 1 "MessageArgs" "[\"2\"]" 1 "LedFaultCode" "P02" 1 "ReportChannel" "65535" 1 "SubjectType" "3" 1 "OldEventCode" "0x0803FFFF" 1 "EventName" "PSUInputLost" 1 "AdditionalInfo" "--2" 1 "State" "Asserted" 1 "SensorType" "0x08" 1 "ComponentInstance" "2" 1 "ComponentLocation" "chassis" 1 "ComponentName" "PS--2" 1 "EventReadingType" "0x6f" 1 "EventSequenceNumber" "0x0000000000000027" 1 "NodeId" ""
  • 查询10条索引从0开始,并且语言为英文、严重等级为紧急的事件
bash
busctl --user call bmc.kepler.event /bmc/kepler/Systems/1/Events bmc.kepler.Systems.Events GetAlarmList 'a{ss}qqa(ss)' 3 Interface cli UserName Administrator
 ClientAddr <ip> 0 10 2 'Lang' 'en' 'Severity' 'Critical'

响应:qa(a(ss)) 1 30 1 "Cause" "1. The power cable is not securely connected or is faulty.@#AB;2. The PSU is faulty." 1 "Description" "The AC/DC input of PSU 2 is lost or out-of-range (SN:xxx, BN:xxx)." 1 "SN" "xxx" 1 "Influence" "The system is powered off unexpectedly." 1 "Suggestion" "1. Check whether the power cables are disconnected or loose.@#AB;2. Replace the power cables.@#AB;3. Replace the PSU." 1 "Timestamp" "1776481334" 1 "TriggerMode" "1" 1 "EventCode" "0x0300000D" 1 "ActionId" "0" 1 "RecordId" "110" 1 "PN" "xxx" 1 "ChassisId" "" 1 "ManagerId" "1" 1 "SystemId" "1" 1 "Severity" "Critical" 1 "MessageArgs" "[\"2\"]" 1 "LedFaultCode" "P02" 1 "ReportChannel" "65535" 1 "SubjectType" "3" 1 "OldEventCode" "0x0803FFFF" 1 "EventName" "PSUInputLost" 1 "AdditionalInfo" "--2" 1 "State" "Asserted" 1 "SensorType" "0x08" 1 "ComponentInstance" "2" 1 "ComponentLocation" "chassis" 1 "ComponentName" "PS--2" 1 "EventReadingType" "0x6f" 1 "EventSequenceNumber" "0x0000000000000027" 1 "NodeId" ""

2.2 GetEventList ​

功能说明 ​

查询历史事件。

属性内容
接口名bmc.kepler.Systems.Events
首发版本bmcsdk 25.03
废弃状态正常可用

参数说明 ​

参数名方向类型描述取值范围
StartId输入U16事件索引,(正序)从第几个开始查询U16
Count输入U16要查询的事件条数U16
QueryParameters输入(可选参数)Array条件筛选,详见下表;D-Bus类型为a(ss),即(Key, Value)结构体数组,允许重复传入相同的Key数组元素为(Key, Value),其中Key、Value均为字符串类型
Total输出U16事件总条数U16
EventList输出Array事件详细信息列表数组元素仍为数组(记为a1),a1的元素为键值对,其中Key、Value均为字符串类型

可选参数

参数名称描述
Lang查询事件的语言(en:英文,zh:中文),非必选参数,默认英文
SelLevel日志级别,按严重等级精确过滤SEL日志(不额外过滤重启类事件),非必选参数。支持的日志级别:Normal/Minor/Major/Critical;可重复传入多个SelLevel,多个值之间为OR关系
SelObjectType主体类型,查询符合主体类型条件的SEL日志,非必选参数。可通过查询redfish/v1/Systems/system_id/LogServices/LogServices_id资源获得主体类型列表;可重复传入多个SelObjectType,多个值之间为OR关系
SelBeginTime起始时间,查询在起始时间到结束时间范围内产生的SEL日志,非必选参数。支持的日期格式:yyyy-MM-dd HH:mm:ss
SelEndTime结束时间,查询在起始时间到结束时间范围内产生的SEL日志,非必选参数。支持的日期格式:yyyy-MM-dd HH:mm:ss
SelSearchString用于模糊匹配事件描述、事件码,ASCII范围(0x20~0x7E),长度0~20字符
SelSelectId按RecordId精确查询,非必选参数。传入时仅按RecordId匹配并忽略其他筛选条件(语言除外)
SelSelectMode查询模式,非必选参数。当前支持ExactQuery:未传SelSelectId时,列表查询返回原始RecordId,不进行SEL转储后的记录号偏移

QueryParameters在D-Bus上的类型为a(ss)(结构体数组),不是a{ss}字典,因此允许重复Key;重复的SelLevel/SelObjectType按OR关系过滤。

SelSelectId优先于SelSelectMode;两者同时传入时按SelSelectId精确查询。SelSelectId精确查询返回原始RecordId,不进行SEL转储后的记录号偏移。

GetEventList按SelLevel精确匹配严重等级,不额外过滤重启类事件;重启类事件过滤仅适用于GetAlarmList的Normal查询。

返回值与异常 ​

返回值含义触发条件处理建议
Total不为0成功环境上产生了事件无
Total为0环境上没有产生事件时为成功,如果环境实际产生了事件,则意味着查询失败查询历史事件如果环境实际产生了事件,则要检查入参是否正确
抛错InternalError失败代码内部错误检查CSR配置或代码实现
抛错PropertyValueError失败入参不合法检查入参

应用场景 ​

查询历史事件。

限制条件 ​

无

调试示例 ​

命令行调试 ​
  • 查询历史事件(不加筛选条件)
bash
busctl --user call bmc.kepler.event /bmc/kepler/Systems/1/Events bmc.kepler.Systems.Events GetEventList 'a{ss}qqa(ss)' 3 Interface cli UserName <user_name> ClientAddr <ip> 0 10 0

响应:qa(a(ss)) 1 30 1 "Cause" "" 1 "Description" "BMC event records are cleared." 1 "SN" "" 1 "Influence" "" 1 "Suggestion" "" 1 "Timestamp" "947583908" 1 "TriggerMode" "1" 1 "EventCode" "0x1A00000F" 1 "ActionId" "0" 1 "ReportChannel" "65535" 1 "EventReadingType" "0x6f" 1 "OldEventCode" "0x1002FFFF" 1 "ChassisId" "" 1 "ManagerId" "1" 1 "SystemId" "0" 1 "Severity" "Normal" 1 "MessageArgs" "[]" 1 "SubjectType" "26" 1 "RecordId" "1" 1 "PN" "" 1 "SensorType" "0x10" 1 "AdditionalInfo" "" 1 "State" "Asserted" 1 "EventName" "BMCEventCleared" 1 "ComponentInstance" "1" 1 "ComponentLocation" "" 1 "ComponentName" "BMC" 1 "LedFaultCode" "" 1 "EventSequenceNumber" "0x0000000000000050" 1 "NodeId" "00"
  • 查询历史事件(加筛选条件,未查到满足筛选条件的事件)
bash
busctl --user call bmc.kepler.event /bmc/kepler/Systems/1/Events bmc.kepler.Systems.Events GetEventList 'a{ss}qqa(ss)' 3 Interface cli UserName Administrator ClientAddr 127.0.0.1 0 10 5 'SelBeginTime' '1970-01-01 00:01:54' 'SelEndTime' '1970-01-02 00:01:11' 'SelSearchString' 'Disk' 'SelObjectType' '2' 'Lang' 'zh'

响应:qa(a(ss)) 0 0
  • 查询历史事件(Level和Subject多值过滤,多个条件之间为OR关系)
bash
busctl --user call bmc.kepler.event /bmc/kepler/Systems/1/Events bmc.kepler.Systems.Events GetEventList 'a{ss}qqa(ss)' 3 Interface cli UserName Administrator ClientAddr <ip> 0 10 4 'SelLevel' 'Minor' 'SelLevel' 'Major' 'SelObjectType' '3' 'SelObjectType' '4'

响应:qa(a(ss)) 0 0(示例环境无匹配事件)

2.3 ClearEventList ​

功能说明 ​

清除所有事件。

属性内容
接口名bmc.kepler.Systems.Events
首发版本bmcsdk 25.03
废弃状态正常可用

参数说明 ​

无

应用场景 ​

清除所有事件。

调试示例 ​

命令行调试 ​
bash
busctl --user call bmc.kepler.event /bmc/kepler/Systems/1/Events bmc.kepler.Systems.Events ClearEventList a{ss} 3 Interface cli UserName Administrator ClientAddr <ip>

2.4 MockEvent ​

功能说明 ​

事件模拟接口。

属性内容
接口名bmc.kepler.Systems.Events
首发版本bmcsdk 25.03
废弃状态正常可用

参数说明 ​

参数名方向类型描述取值范围
EventCode输入String事件码String
Enabled输入U8模拟状态标识0:关闭模拟,1:开启模拟
ObjectIndex输入U16事件下标U16
MockState输入U8事件状态1:生成告警,0:恢复告警

返回值与异常 ​

返回值含义触发条件处理建议
无返回值成功参数合法且未被限流,模拟任务已提交(异步执行)稍后通过GetAlarmList/GetEventList确认模拟结果
无返回值(静默忽略)请求被限流距上次MockEvent调用不足500ms等待至少500ms后重试;不要仅凭接口返回成功判断模拟已生效
抛错PropertyValueError失败EventCode非法或事件码无匹配对象、Enabled/MockState取值非法、ObjectIndex越界检查入参及事件定义
抛错ResourceInUse失败并发模拟任务达到上限等待现有模拟任务完成后重试

应用场景 ​

模拟告警事件。接口调用存在最小间隔限制,短时间重复调用时后续请求会被忽略但仍返回成功;实际模拟任务为异步执行。

调试示例 ​

命令行调试 ​
bash
busctl --user call bmc.kepler.event /bmc/kepler/Systems/1/Events bmc.kepler.Systems.Events MockEvent a{ss}syqy 3 Interface cli UserName Administrator ClientAddr <ip> 0x0200000B 1 1 1

2.5 MaskEvent ​

功能说明 ​

屏蔽事件接口。

属性内容
接口名bmc.kepler.Systems.Events
首发版本bmcsdk 25.03
废弃状态正常可用

参数说明 ​

参数名方向类型描述取值范围
EventCode输入String事件码String
MaskState输入U8屏蔽状态0:开启屏蔽,1:关闭屏蔽
Mode输入U8屏蔽模式1:NONE,不保存屏蔽状态,重启失效
2:RESET,重启后保持屏蔽
3:AC后保持屏蔽

返回值与异常 ​

返回值含义触发条件处理建议
无返回值成功屏蔽状态设置成功通过GetMaskedEventList确认结果
抛错PropertyValueError失败Mode或MaskState取值非法检查屏蔽状态和屏蔽模式
抛错InvalidValue失败EventCode不存在检查事件码是否已定义

应用场景 ​

屏蔽事件接口。

调试示例 ​

命令行调试 ​
bash
busctl --user call bmc.kepler.event /bmc/kepler/Systems/1/Events bmc.kepler.Systems.Events MaskEvent a{ss}syy 3 Interface cli UserName Administrator ClientAddr <ip> '0x0200000B' 0 1

2.6 GetEventInfo ​

功能说明 ​

查询事件配置版本与事件数量信息。

属性内容
接口名bmc.kepler.Systems.Events
首发版本bmcsdk 25.03
废弃状态正常可用

参数说明 ​

参数名方向类型描述取值范围
Version输出String事件配置版本String
CurEventCount输出U16当前事件数量U16
MaxEventCount输出U16最大事件数量U16

返回值与异常 ​

返回值含义触发条件处理建议
返回Version、CurEventCount、MaxEventCount成功接口正常返回无
CurEventCount为0当前没有事件系统中尚未产生事件结合业务确认是否应产生事件;若应有事件,检查事件注册与CSR配置
抛错InternalError失败代码内部错误检查CSR配置或代码实现

应用场景 ​

查询事件配置版本、当前事件数量和最大事件数量,用于容量评估与问题定位。

调试示例 ​

命令行调试 ​
bash
busctl --user call bmc.kepler.event /bmc/kepler/Systems/1/Events bmc.kepler.Systems.Events GetEventInfo a{ss} 3 Interface cli UserName Administrator ClientAddr <ip>

响应:sqq "1.0.0" 2 10000

GetEventInfo方法返回的CurEventCount和MaxEventCount为U16;Events接口同名属性为U32,两者是不同接口签名,读取时以各自接口定义为准。

2.7 GetMaskedEventList ​

功能说明 ​

查询屏蔽事件列表。

属性内容
接口名bmc.kepler.Systems.Events
首发版本bmcsdk 25.03
废弃状态正常可用

参数说明 ​

参数名方向类型描述取值范围
MaskedEventList输出Array屏蔽事件列表信息,包括EventCode:被屏蔽事件的事件码、EventName:被屏蔽事件的事件标识Array

应用场景 ​

查询屏蔽事件列表。

调试示例 ​

命令行调试 ​
bash
busctl --user call bmc.kepler.event /bmc/kepler/Systems/1/Events bmc.kepler.Systems.Events GetMaskedEventList a{ss} 3 Interface cli UserName Administrator ClientAddr <ip>

响应:a(ss) 2 "0x1A000053" "BMCAccessI2CDeviceFailure" "0x2C000073" "SystemPowerHigh"

2.8 AddEvent ​

功能说明 ​

添加软件告警。接口返回本次添加事件对应的记录标识RecordId。

属性内容
接口名bmc.kepler.Systems.Events
首发版本bmcsdk 25.03
废弃状态正常可用

参数说明 ​

参数名方向类型描述取值范围
EventInfo输入Array事件信息集合必选参数:(ComponentName:事件主体名称 State:事件状态 EventKeyId:事件标识 MessageArgs:动态参数列表 SystemId:事件归属的SystemId ManagerId:事件归属的ManagerId ChassisId:事件归属的ChassisId NodeId:事件对应的对象) 可选参数:(SubjectType:事件主体类型 SuggestionArgs:事件建议参数 LedFaultCode:LED显示故障码 AdditionalInfo:事件关联部件的补充信息 Timestamp:事件产生时间戳 AffectHardwareHealth:是否参与硬件健康判断)
RecordId输出String添加事件对应的记录标识String;添加失败时返回"0"

参数含义

参数名称描述
ComponentName事件主体名称(必选)
State事件状态(必选,“true”/“false”)
EventKeyId事件标识(必选,唯一)
SuggestionArgs事件建议参数(可选)
SubjectType事件主体类型(可选)(默认由事件码推导)
MessageArgs事件描述动态参数(必选)
SystemId事件归属的SystemId(必选)
ManagerId事件归属的ManagerId(必选)
ChassisId事件归属的ChassisId(必选)
NodeId事件对应的对象(必选)
LedFaultCodeLED显示故障码(可选)
AdditionalInfo事件关联部件的补充信息(可选)
Timestamp事件产生时间戳(可选,非负整数)
AffectHardwareHealth是否参与硬件健康判断(可选,true/1表示参与,false/0表示不参与,默认false)

注释

  1. MessageArgs、SuggestionArgs需要使用cjson.encode将表编码为字符串。
  2. ComponentName需要有效,与实际的Component匹配。
  3. EventName由EventKeyId对应的静态配置推导,不需要传入。
  4. 无法重复生成同一状态的事件,产生后需要有对应的恢复操作(如State传false)。
  5. AffectHardwareHealth仅控制是否参与HardwareHealth统计,不影响Health统计。
  6. 硬件事件的参与开关由CSR中Event对象的AffectHardwareHealth属性配置(默认true);软件事件通过本接口入参控制(默认false)。

返回值与异常 ​

返回值含义触发条件处理建议
RecordId成功软件事件添加成功保存返回的记录标识,用于恢复或问题跟踪
"0"未生成事件状态重复、组件未匹配或服务处于重启流程检查事件是否已处于相同状态,确认组件对象存在
抛错PropertyValueError失败必选参数缺失或非法、EventKeyId未定义、State非法、SubjectType/Timestamp非法、ComponentName无效、事件已被屏蔽检查入参、事件定义、Component对象和屏蔽状态
抛错InternalError失败代码内部错误检查事件组件日志与CSR配置

应用场景 ​

组件通过本接口产生或恢复软件告警。需要软件告警参与硬件健康判断时,传入AffectHardwareHealth为true或1。

调试示例 ​

命令行调试 ​
bash
busctl --user call bmc.kepler.event /bmc/kepler/Systems/1/Events bmc.kepler.Systems.Events AddEvent 'a{ss}a(ss)' 3 Interface cli UserName Administrator ClientAddr <ip> 9 ComponentName 'BMC' State 'true' EventKeyId 'BMC.InsecureCryptographicAlgorithm' 'MessageArgs' '["SSHKexs","diffie-hellman-group14-sha1,diffie-hellman-group-exchange-sha1"]' 'SystemId' '1' 'ManagerId' '1' 'ChassisId' '1' 'NodeId' '1' 'AffectHardwareHealth' 'true'

响应示例:

text
s "110"

返回的RecordId可用于后续恢复事件或问题跟踪。恢复事件时保持其他参数不变,将State置为false。

2.9 ExportEvent ​

功能说明 ​

导出历史事件记录。接口创建异步导出任务并返回任务标识TaskId,任务完成后可在目标路径获取导出文件。

属性内容
接口名bmc.kepler.Systems.Events
首发版本bmcsdk 25.03
废弃状态正常可用

参数说明 ​

参数名方向类型描述取值范围
Path输入String导出目标路径本地路径:必须以/tmp/开头且长度不超过255字符;远程路径:支持https:、sftp:、nfs:、cifs:、scp:协议
TaskId输出U32导出任务标识,用于拼接任务路径U32

返回值与异常 ​

返回值含义触发条件处理建议
TaskId成功导出任务创建成功通过任务机制查询进度并到目标路径获取文件
抛错PropertyValueFormatError失败本地路径长度超过255字符缩短导出路径
抛错InvalidPath失败本地路径不在/tmp下、包含..、空格、Shell特殊字符、控制字符或tar注入参数使用合法的/tmp路径
抛错FileTransferProtocolMismatch失败远程路径协议不支持使用支持的远程协议
抛错DuplicateExportingErr失败已有导出任务正在执行等待当前任务结束后重试
抛错InternalError失败任务创建失败或服务不可用检查事件组件日志和任务服务状态

应用场景 ​

用于导出历史事件记录(SEL),支持本地下载和远程文件传输。

限制条件 ​

  • 本地导出路径必须位于/tmp目录下。
  • 同一时间只允许一个导出任务执行。
  • 本地路径导出文件为tar包;路径以.tar.gz结尾时生成gzip压缩包。

调试示例 ​

命令行调试 ​
bash
busctl --user call bmc.kepler.event /bmc/kepler/Systems/1/Events bmc.kepler.Systems.Events ExportEvent 'a{ss}s' 3 Interface cli UserName Administrator ClientAddr <ip> '/tmp/event.tar.gz'

响应:u 1

2.10 CheckEventName ​

功能说明 ​

批量校验事件名称(EventName)是否已定义。

属性内容
接口名bmc.kepler.Systems.Events
首发版本bmcsdk 25.03
废弃状态正常可用

参数说明 ​

参数名方向类型描述取值范围
EventName输入String[]需要校验的EventName列表String[]
Result输出Boolean[]校验结果列表,顺序与输入一致;true表示已定义Boolean[]

应用场景 ​

供上层组件或接口定制在引用事件名称前校验事件定义是否存在。

调试示例 ​

命令行调试 ​
bash
busctl --user call bmc.kepler.event /bmc/kepler/Systems/1/Events bmc.kepler.Systems.Events CheckEventName 'a{ss}as' 3 Interface cli UserName Administrator ClientAddr <ip> 2 'PSUInputLost' 'NotExistEvent'

响应:ab 2 true false

2.11 SetAlarmName ​

功能说明 ​

定制告警名称。设置后,告警描述、建议、原因和影响中的默认名称BMC会被替换为指定名称,并持久化保存。

属性内容
接口名bmc.kepler.Systems.Events
首发版本bmcsdk 25.03
废弃状态正常可用

参数说明 ​

参数名方向类型描述取值范围
AlarmName输入String定制的告警名称String

应用场景 ​

用于OEM定制或品牌化场景,替换告警文案中的默认产品名称。

调试示例 ​

命令行调试 ​
bash
busctl --user call bmc.kepler.event /bmc/kepler/Systems/1/Events bmc.kepler.Systems.Events SetAlarmName 'a{ss}s' 3 Interface cli UserName Administrator ClientAddr <ip> 'OpenUBMC'

响应:无输出

2.12 SetEventSeverity ​

功能说明 ​

设置指定事件码对应事件的严重等级,并持久化保存。

属性内容
接口名bmc.kepler.Systems.Events
首发版本bmcsdk 25.03
废弃状态正常可用

参数说明 ​

参数名方向类型描述取值范围
EventCode输入String告警码形如0x0200000B的合法事件码
Severity输入U8设置的告警级别0:Normal,1:Minor,2:Major,3:Critical

返回值与异常 ​

返回值含义触发条件处理建议
无返回值成功严重等级设置成功重新查询告警确认等级
抛错PropertyValueError失败EventCode非法或不存在、Severity取值非法检查事件码和严重等级
抛错InternalError失败持久化或内部处理失败检查事件组件日志

应用场景 ​

用于Redfish EventService.SetEventSeverityLevel等上层接口调整告警严重等级。

调试示例 ​

命令行调试 ​
bash
busctl --user call bmc.kepler.event /bmc/kepler/Systems/1/Events bmc.kepler.Systems.Events SetEventSeverity 'a{ss}sy' 3 Interface cli UserName Administrator ClientAddr <ip> '0x0200000B' 2

响应:无输出

2.13 SetEventAction ​

功能说明 ​

设置指定事件产生后执行的动作,并持久化保存。

属性内容
接口名bmc.kepler.Systems.Events
首发版本bmcsdk 25.03
废弃状态正常可用

参数说明 ​

参数名方向类型描述取值范围
EventKeyId输入String事件定义标识已定义的事件EventKeyId
Action输入U8设置的事件动作0:无动作,1:下电0S,2:复位OS,3:下电后上电

返回值与异常 ​

返回值含义触发条件处理建议
无返回值成功动作设置成功触发对应事件验证动作
抛错PropertyValueError失败EventKeyId不存在或Action取值非法检查事件定义和动作取值
抛错InternalError失败持久化失败检查数据库和事件组件日志

应用场景 ​

用于配置事件产生后的主机电源动作,例如故障时下电或复位OS。

调试示例 ​

命令行调试 ​
bash
busctl --user call bmc.kepler.event /bmc/kepler/Systems/1/Events bmc.kepler.Systems.Events SetEventAction 'a{ss}sy' 3 Interface cli UserName Administrator ClientAddr <ip> 'BMC.InsecureCryptographicAlgorithm' 0

响应:无输出

2.14 AddSel ​

功能说明 ​

动态添加OEM SEL记录,并生成对应的Event对象。

属性内容
接口名bmc.kepler.Systems.Events
首发版本bmcsdk 25.03
废弃状态正常可用

参数说明 ​

参数名方向类型描述取值范围
EventInfo输入ArraySEL事件信息集合必选参数:EventCode、OldEventCode、Severity、State、Description、SubjectType、SystemId

参数含义

参数名称描述
EventCode事件码(必选)
OldEventCode旧事件码(必选)
Severity事件严重等级(必选,Normal/Minor/Major/Critical)
State事件状态(必选,Assert/1表示产生,其他值表示恢复)
Description事件描述(必选)
SubjectType事件主体类型(必选)
SystemId事件归属的SystemId(必选)

返回值与异常 ​

返回值含义触发条件处理建议
无返回值成功SEL事件提交成功通过GetEventList查询新增记录
抛错InvalidField失败必选参数缺失检查EventInfo中的必选参数

应用场景 ​

用于OEM定制场景动态注入SEL事件;处理为异步执行,查询结果可能存在短暂延迟。

调试示例 ​

命令行调试 ​
bash
busctl --user call bmc.kepler.event /bmc/kepler/Systems/1/Events bmc.kepler.Systems.Events AddSel 'a{ss}a(ss)' 3 Interface cli UserName Administrator ClientAddr <ip> 7 'EventCode' '0x0200000B' 'OldEventCode' '0x0200FFFF' 'Severity' 'Minor' 'State' 'Assert' 'Description' 'OEM SEL test' 'SubjectType' '2' 'SystemId' '1'

响应:无输出

2.15 GetAlarmSpecifiedFields ​

功能说明 ​

查询当前所有告警中指定字段的值列表,结果按值去重且忽略空值。

属性内容
接口名bmc.kepler.Systems.Events
首发版本bmcsdk 26.06
废弃状态正常可用

参数说明 ​

参数名方向类型描述取值范围
EventFieldName输入String待查询的字段名称当前仅支持LedFaultCode
EventFieldValues输出String[]当前所有告警的指定字段内容列表String[]

返回值与异常 ​

返回值含义触发条件处理建议
EventFieldValues成功查询完成无
空列表成功当前告警不存在该字段或字段值为空结合当前告警列表确认
抛错PropertyValueError失败EventFieldName不支持使用LedFaultCode

应用场景 ​

用于上层接口汇总当前告警关联的LED故障码等信息。

调试示例 ​

命令行调试 ​
bash
busctl --user call bmc.kepler.event /bmc/kepler/Systems/1/Events bmc.kepler.Systems.Events GetAlarmSpecifiedFields 'a{ss}s' 3 Interface cli UserName Administrator ClientAddr <ip> 'LedFaultCode'

响应:as 2 'P02' 'P03'

2.16 关键属性 ​

bmc.kepler.Systems.Events ​

对象路径:/bmc/kepler/Systems/:SystemId/Events

属性名类型可读写描述
HealthString只读系统健康状态,取值:Normal/Minor/Major/Critical
HardwareHealthString只读硬件健康状态,取值:Normal/Minor/Major/Critical;由参与硬件健康判断的事件中最高严重等级决定
EventRecordSeqU64只读事件记录标识,随着事件产生递增
CriticalCountU32只读致命告警数量
MajorCountU32只读严重告警数量
MinorCountU32只读一般告警数量
VersionString只读当前事件配置的版本
CurEventCountU32只读当前事件数量
MaxEventCountU32只读最大事件数量
DumpRecordU64只读SEL日志转储的总量,每次转储均会累加
MajorVersionString只读告警语言配置的主版本
MinorVersionString只读告警语言配置的次要版本
AuxVersionString只读告警语言配置的辅助版本
EventModeU8读写事件记录模式:0表示默认模式,记录达到最大数量后转储;1表示记录达到最大数量后环形记录

bmc.kepler.Systems.EventSummary ​

对象路径:/bmc/kepler/Systems/:SystemId/EventSummary

属性名类型可读写描述
MinorCountU32只读当前System的一般事件汇总数量
MajorCountU32只读当前System的严重事件汇总数量
CriticalCountU32只读当前System的紧急事件汇总数量
HealthString只读当前System的健康状态,取值:Normal/Minor/Major/Critical
HardwareHealthString只读当前System的硬件健康状态,取值:Normal/Minor/Major/Critical;由参与硬件健康判断的事件中最高严重等级决定

调试示例 ​

命令行调试 ​
bash
busctl --user get-property bmc.kepler.event /bmc/kepler/Systems/1/Events bmc.kepler.Systems.Events Health

响应:s "Normal"
bash
busctl --user set-property bmc.kepler.event /bmc/kepler/Systems/1/Events bmc.kepler.Systems.Events EventMode y 1

响应:无输出

3. 组件扩展案例 ​

3.1 扩展能力概述 ​

不适用

4. 日志说明 ​

4.1 一键日志收集 ​

文件路径内容说明
AppDump/event/current_event.txt记录当前告警
AppDump/event/sel.txt
AppDump/event/eo_sel.csv
记录历史事件
AppDump/event/mask_event.txt记录屏蔽的事件
AppDump/event/event.db
AppDump/event/event_reset.db
持久化数据库
LogDump/event/alarm.log事件硬件对象注册信息以及最近三次的读值

4.2 关键日志信息 ​

日志片段日志级别含义解读建议处理动作
Event xxx has no associated componentERROR事件未关联Component对象检查事件CSR中的Component配置及对象解析结果
Event xxx has no component pathERROR事件关联的Component对象缺少path信息检查Component对象是否已正确加载
query definition failed for EventKeyId=xxxWARNING查询事件静态定义失败检查EventKeyId配置及事件定义数据库
register_event_from_object: xxx failedERROR事件对象注册失败结合异常信息检查事件定义、Component和事件对象属性
Component for event code xxx not found, registration skippedWARNING模拟事件未找到关联Component,注册被跳过检查模拟事件码对应的Component是否存在
add_event: event code xxx is maskedERROR软件事件对应的事件码已被屏蔽检查屏蔽配置,必要时调用MaskEvent解除屏蔽

5. 问题定界指南 ​

5.1 典型问题定界 ​

现象描述是否为本组件问题判断依据关键证据收集方法
告警描述不符合预期否Event组件仅提供告警描述的公共机制,传入的参数及格式由开发者自行实现查看告警描述涉及参数的数据源
告警关联的数据源读数达到了告警门限,但是没有产生告警是已满足告警条件但是未产生告警

5.2 调试方法 ​

开启调试日志 ​

busctl资源协作接口方法调试见文档第二章节。

复现问题方法 ​

  1. CSR不配置要验证的事件,或CSR配置了事件但是未关联对应的Component对象,查看事件的注册情况,预期注册失败

6. 常见问题解答 ​

常见问题解答请查阅《事件告警常见问题》。

附录 ​

附录A 参考资料 ​

附录B 修订记录 ​

版本日期修订人修订内容
v1.02026-04-30mkdlf初始版本创建
v1.12026-11-03mkdlf适配event_mgmt 0.0.111 C++重构版本,补充接口、HardwareHealth属性及日志说明