bmc.kepler.Bus ​

==属性==

==方法==

SetAccessibility

设置bus可访问状态

参数

• Status: Boolean - 链路状态，true:使能访问链路， false:禁止访问链路
• DisableDuration: U16 - 失效时长，单位: 秒，取值范围: [1, 1800]，该参数只有将链路从使能状态变为禁止状态时生效，到期自动使能链路访问

bmc.kepler.Bus.BlockIO ​

==方法==

Read

按字节读取总线从地址对应的硬件数据

参数

• SlaveAddress: U8 - 目标器件地址
• ReadLength: U32 - 读取长度

返回值

• OutData: U8[] - 读取的结果

Write

按字节将指定内容写入总线从地址对应的硬件内

参数

• SlaveAddress: U8 - 目标器件地址
• InData: U8[] - 写入器件的数据内容

WriteRead

按字节将指定内容写入总线从地址对应的硬件内，再按字节读取总线从地址对应的硬件数据

参数

• SlaveAddress: U8 - 目标器件地址
• InData: U8[] - 写入器件的数据内容
• ReadLength: U8 - 读取的长度

返回值

• OutData: U8[] - 按字节读取总线从地址对应的硬件数据

bmc.kepler.Bus.Jtag ​

==属性==

bmc.kepler.Cli.Command ​

==属性==

bmc.kepler.CmdInfo ​

==属性==

==方法==

Process

处理IPMI请求，并返回响应

参数

• Data: U8[] - 请求数据
• Context: U8[] - 请求上下文的json字符串，包括通道类型、会话信息、客户端信息

返回值

• Response: U8[] - 响应数据

bmc.kepler.Debug.BlackBox ​

==方法==

DumpPsuBlackbox

收集电源黑匣子日志，异步则通过TaskId返回结果

返回值

• TaskId: U32 - 任务Id

bmc.kepler.Debug.DataAcquisitionService ​

==方法==

SetConfigurations

数据采集组件参数配置项

参数

• CfgType: String - 选择的配置类型(如：TestIODeterioration:使用导入的json文件触发慢盘检测、TestEstimatedLifespan:使用导入的json文件模拟获取硬盘参数触发预估寿命检测流程等)，为调试命令，仅在调试时使用
• CfgValue: String - 设置配置信息（如：json文件路径），为调试命令，仅在调试时使用

返回值

• Result: S32 - 配置信息设置结果，为调试命令，仅在调试时使用，0:设置成功 -1:设置失败

bmc.kepler.Debug.DiskFaultPrediction ​

==方法==

ExecuteRealDiskInference

触发执行一次环境真实硬盘预测推理

参数

• DataSource: U8 - 硬盘数据来源，0表示数据库获取，1表示手工构造输入
• SlotNumber: U8 - 硬盘槽位号

返回值

• PredictResult: String[] - 硬盘故障预测结果

ExecuteFakeDiskInference

触发执行一次打桩硬盘预测推理

参数

• DataSource: U8 - 指定的数据库数据
• Taghash: String - taghash值
• DiskInfo: String[] - 硬盘信息

返回值

• PredictResult: String[] - 硬盘故障预测结果

GetLatestInferenceResult

获取最近一次的预测结果

返回值

• LatestPredictionTime: String - 最近一次的预测时间
• DfpResult: String[] - 最近一次的预测结果

bmc.kepler.Debug.EnergySavingMeasurement ​

==方法==

SetPeriod

设置节能专家推荐系统计算周期

参数

• Period: U32 - 计算周期时间，单位为秒，最小时间为60s，最大时间为86400s（24小时）

bmc.kepler.Debug.EnergySavingScene ​

==方法==

MockActivatedModuleByDomain

模拟指定节能域的生效节能系统

参数

• DomainName: String - 指定的节能域名称，取值范围：CPUSystem、NPUSystem
• SystemName: String - 指定生效的节能系统名称，取值范围：BMA、NPM、LPM

MockEnergySavingStatusByDomain

模拟指定生效节能系统的状态查询返回值

参数

• DomainName: String - 指定的节能域名称，取值范围：CPUSystem、NPUSystem
• SystemName: String - 指定生效的节能系统名称，取值范围：BMA、NPM、LPM
• Parameters: String[] - 模拟指定节能系统的返回值列表

bmc.kepler.Debug.EventService ​

==方法==

GetEventDetailByCode

参数

• EventCode: String - 事件码

返回值

• EventDetail: Array - 已注册事件码的相关信息，例如事件名称，门限，屏蔽状态，当前读值，事件种类等

==自定义类型==

EventItem: 结构体类型

• EventName: String - 事件的名称
• EventDetail: KeyValueTable

KeyValueTable: 结构体类型

• key: String - 事件详情的键名
• value: String - 键值表中的值

bmc.kepler.Debug.IpmiCore.TraceIpmi ​

==属性==

==方法==

Trace

南向追踪接口

参数

• EnableTrace: Boolean - 南向追踪使能状态
• Channel: String - 南向追踪的通道
• Netfn: U8 - 南向追踪的IPMI网络字节功能码
• Cmd: U8 - 南向追踪的IPMI命令字
• Filter: String - 南向追踪的IPMI过滤字段
• LogType: String - 南向追踪的记录方式

bmc.kepler.Debug.LanSwitchMock ​

==方法==

RegRead

读取交换板寄存器值

参数

• Unit: U8 - 交换板芯片Id
• Type: U8 - 交换板器件类型：Chip、Phy
• Port: U8 - 交换板端口号
• Addr: U32 - 交换板寄存器地址

返回值

• Value: U32 - 交换板寄存器的值

RegWrite

设置交换板寄存器的值

参数

• Unit: U8 - 交换板芯片Id
• Type: U8 - 交换板器件类型：Chip、Phy
• Port: U8 - 交换板端口号
• Addr: U32 - 交换板寄存器地址
• Value: U32 - 交换板寄存器的值

GetPortInfo

查询交换板端口的信息（端口速率、端口连接状态等）

参数

• Unit: U32 - 交换板芯片Id
• Port: U32 - 交换板端口号

返回值

• Value: String - 交换板端口的信息（端口速率、端口连接状态等）

SetPortEnable

设置交换板端口开关状态

参数

• Unit: U32 - 交换板芯片Id
• Port: U32 - 交换板端口号
• Enable: U32 - 交换板端口开关

SetPortStpState

设置交换板端口的STP状态

参数

• Unit: U32 - 交换板芯片Id
• Port: U32 - 交换板端口号
• State: U32 - 交换板端口的STP状态

GetSwitchErrorCode

获取交换板utp端口误码

参数

• Unit: U32 - 交换板芯片Id
• UtpNum: U32 - 交换板utp端口号

返回值

• Value: U32 - 交换板utp端口误码

SetPortMacAddr

设置交换板端口静态MAC地址

参数

• Unit: U32 - 交换板芯片Id
• Port: U32 - 交换板端口号
• MacStr: String - 交换板端口静态MAC地址

FlushPortAddr

清空交换板端口静态MAC地址

参数

• Unit: U32 - 交换板芯片Id
• Port: U32 - 交换板端口号

GetVlanInfo

获取交换板的vlan信息

参数

• Unit: U32 - 交换板芯片Id

返回值

• Value: String - 交换板的vlan信息

bmc.kepler.Debug.LogMock ​

==方法==

MockLog

模拟日志注入

参数

• Count: U32 - 注入的日志数量
• Text: String - 注入的日志内容
• RepeatText: Boolean - 标志是否重复内容

bmc.kepler.Debug.Managers.NandFlashMock ​

==属性==

==方法==

SetDebugValue

调试模式下设置参数

参数

• LifeTime: U8 - 调试模式下flash使用的寿命,百分比
• PreEOL: U8 - 调试模式下预留块状态
• DelayTime: U32 - 调试模式下计算使用寿命及使用块的间隔时间，单位秒
• TimeInterval: U32 - 调试模式下写入量统计时间间隔，单位秒
• WriteThreshold: U64 - 调试模式下写入量的阈值，单位字节
• ClearStatisticsInterval: U32 - 调试模式下重置写入量的时间间隔，单位秒

bmc.kepler.Debug.Managers.SOC.DDR ​

==方法==

InjectUCE

向指定地址注入UCE, 该注入的错误在下电后会丢失

参数

• Address: U32 - UCE注入的物理地址(有效范围0x80000000~0xFFFFFFFF, 要求四字节对齐)

返回值

• Result: String - UCE注入结果的提示信息

bmc.kepler.Debug.Managers.SecureBoot ​

==方法==

GetSecureBootConfiguration

查询安全启动相关信息

参数

• Subcmd: S32 - 查询的内容类型,当前仅支持0,表示查询BMC根文件系统签名CA的摘要值
• Args: String - Subcmd的执行参数,当Subcmd取值0时,该字段仅支持取值pss或者pkcs

返回值

• Configuration: String - 查询的安全启动的信息,当Subcmd为0时,返回样例["RootfsCADigest":"xxx"]

bmc.kepler.Debug.Mctp ​

==方法==

SetTransmissionUnitSize

参数

• Size: U16 - MCtp传输单元大小

bmc.kepler.Debug.Mock ​

==方法==

MockScannerFailure

模拟Scanner故障接口，ScannerName:模拟故障的Scanner名称，FailureDuration:故障持续时间(范围：1s<= FailureDuration <= 1800s)

参数

• ScannerName: String - 模拟故障的Scanner名称
• FailureDuration: U32 - 故障持续时间,单位(s),范围: 1s <= FailureDuration <= 1800s

MockBusCtrl

模拟控制总线挂死与恢复,BusName:模拟总线的名称，Action：模拟动作（suspend:挂死，resume:恢复）

参数

• BusName: String - 控制的Bus服务名称
• Action: String - 控制动作, suspend: 模拟总线挂死, resume: 模拟总线恢复

bmc.kepler.Debug.PCIeMock ​

==方法==

GetConnectors

显示指定类型设备当前所有槽位号和在位情况列表

参数

• DeviceType: String - 指定设备类型，可选OCP或PCIe

返回值

• Connectors: Array - 该类型设备槽位集合

LoadDevice

模拟加卸载PCIe设备

参数

• DeviceType: String - 指定设备类型，可选OCP或PCIe
• Slot: U8 - 指定槽位号
• Id: String - 设备Id
• AuxId: String - 设备AuxId

UnloadDevice

模拟加卸载PCIe设备

参数

• DeviceType: String - 指定设备类型，可选OCP或PCIe
• Slot: U8 - 指定槽位号

==自定义类型==

ConnectorItem: 结构体类型

• SlotNumber: U8 - PCIe设备的槽位号
• Presence: String - 该槽位上的设备在位情况，Present表示在位，Absent表示不在位
• Name: String - 该槽位上的设备名称
• Id: String - 该槽位上的设备Id
• AuxId: String - 该槽位上的设备AuxId

bmc.kepler.Debug.Performance ​

==属性==

bmc.kepler.Debug.Performance.Memory ​

==方法==

Stat

支持统计组件的整体内存占用情况，组件全部对象内存占用情况，以及组件指定对象的详细内存占用情况等功能。统计结果输出到/tmp/<app_name>.memstat，属主为app运行属主，权限为644

参数

• Dimension: String - 表示需要统计的内存数据维度，summay表示组件的整体内存占用情况，object表示组件全部或部分对象的内存占用情况
• Objects: String - 当Dimension取值object时，表示需要精确统计的对象列表，多个对象名称以','分隔

返回值

• Prompt: String - 结果输出提示

bmc.kepler.Debug.Performance.Metrics ​

==属性==

==方法==

Report

导出性能报表数据（导出到/tmp目录下）

bmc.kepler.Debug.PidConfiguration ​

==方法==

GetVersion

打印PID版本信息

SetPidPrintMode

设置PID信息打印开关

参数

• Type: U8 - PID信息类型，1表示配置信息，2表示控制信息
• Enabled: U8 - PID信息打印开关，取值为0和1, 0表示关闭信息打印，1表示开启信息打印

SetPidConfigItem

设置PID模块配置信息

参数

• ItemIndex: U8 - PID场景识别配置项索引
• ItemValue: U8 - 配置场景值

bmc.kepler.Debug.PowerCapping ​

==方法==

SimulatePowerCappingTask

通过模拟整机功耗值进行功耗封顶

参数

• Mode: U8 - 是否开启整机功耗调试模式，取值0和1,0表示关闭，1表示开启
• Ratio: Double - 功耗封顶值比例范围[0.1, 1.0]，该参数为可选参数

SimulatePowerCappingConfig

设置功耗封顶下限值，以及模拟上报功耗封顶失败事件请求

参数

• Type: U8 - 调试类型，0表示模拟功耗封顶下限值，1表示模拟上报功耗封顶失败事件
• Value: U32 - 功耗封顶下限值，该参数为可选参数

bmc.kepler.Debug.RemoteAccess ​

==方法==

GetRemoteProperties

获取远端BMC的对象属性

参数

• Target: String - 远端BMC的标识，由协议、地址、通道三部分构成，格式为 Protocol:Address/Channel。如：CAN:5/0 标识通过 CAN0 通道访问标识为5的远端BMC
• Object: String - 远端的属性归属的对象的名称
• Interface: String - 远端的属性归属的资源资源协作接口的名称
• Properties: String[] - 远端的属性名称列表

返回值

• Values: RemoteProperties - 远端MC上属性的名称和取值

RemoteCall

访问远端BMC的方法

参数

• Target: String - 远端BMC的标识，由协议、地址、通道三部分构成，格式为 Protocol:Address/Channel。如：CAN:5/0 标识通过 CAN0 通道访问标识为5的远端BMC
• Object: String - 远端的属性归属的对象的名称
• Interface: String - 远端的属性归属的资源资源协作接口的名称
• Method: String - 远端的方法名称
• Signature: String - 远端的方法请求签名
• Args: MethodArgs - 远端的方法参数

返回值

• Response: String - 远端方法的响应列表，采用 json 格式化的字符串输出

==自定义类型==

RemoteProperties: 结构体类型

• key: String - 属性的名称
• value: String - 属性值

MethodArgs: 结构体类型

• key: String - 参数的名称
• value: String - 参数值

bmc.kepler.Debug.RemoteAccess.CAN ​

==方法==

SendTestBoardcast

发送测试广播

参数

• Channel: U8 - 发送测试广播的CANBUS编号

PrintMetrics

打印CANBUS统计信息

参数

• Channel: U8 - 参与统计的CANBUS编号，默认为0xFF（打印所有的CANBUS统计信息）

返回值

• Details: Array - CANBUS的统计详细信息集合

==自定义类型==

DetailItem: 结构体类型

• Item: String - 每个CANBUS的统计详细信息，采用 json 格式编码

bmc.kepler.Debug.Storage.PhyBitError ​

==属性==

==方法==

MockData

模拟Phy误码数据

参数

• ControllerId: U8 - 控制器Id
• ExpanderId: U8 - Expander的Id
• FilePath: String - 误码数据文件存放路径

返回值

• MockResult: U8 - 模拟结果

bmc.kepler.Debug.Storage.RecordDriveSpareBlock ​

==方法==

MockRecordSpareBlock

模拟硬盘冗余块数据

参数

• Id: U8 - 硬盘Id
• SlcSpareBlock: U8 - 非用户区冗余块数据
• TlcSpareBlock: U8 - 用户区冗余块数据

bmc.kepler.Debug.Systems.ExceptionInfo ​

==方法==

SetStateMachine

调试命令：设置诊断状态机参数，用于调试触发各种诊断流程

参数

• Parm: U8[] - 诊断状态机参数

返回值

• Ret: S32 - 状态机参数的设置结果，-1：设置失败 0：设置成功
• ErrorInfo: String - 错误信息

SetExceptionStatus

调试命令：设置整机系统异常状态，用于测试多种系统异常信号记录

参数

• SysStatus: U32 - XPU状态（如：CPU、NPU）
• ProcessorsStatus: U64 - 预期所有处理器状态

返回值

• SysStatus: U32 - XPU状态（如：CPU、NPU）
• ProcessorsStatus: U64 - 预期所有处理器状态

bmc.kepler.Debug.Systems.FDMDomain ​

==方法==

GetConfigurations

调试命令：获取当前子系统下的fdm辅助配置信息

参数

• CfgType: String - 选择的配置类型(如：MemRASResource:获取内存隔离资源、HbmPageOffline:获取HBM PageOffline隔离资源等)，为调试命令，仅在调试时使用

返回值

• CfgData: String - 返回的配置信息，为调试命令，仅在调试时使用

SetConfigurations

调试命令：设置当前系统下的fdm辅助配置信息

参数

• CfgType: String - 选择的配置类型（如：HbmPageofflineResource:设置HBM PageOffline隔离资源数量、SetFdmLogLimitingEnable:设置imu日志限流开关等），为调试命令，仅在调试时使用
• CfgValue: String - 设置配置信息（如：HBM PageOffline隔离资源数量、限流开关等），为调试命令，仅在调试时使用

返回值

• Result: U32 - 配置信息设置结果，为调试命令，仅在调试时使用，0:设置成功 -1:设置失败

SysAddr2DdrAddr

将系统地址转换为DDR内存物理地址

参数

• SystemAddress: U64 - 系统地址，十进制

返回值

• DdrAddress: String - 物理内存地址，json格式字符串

SysAddr2HbmAddr

将系统地址转换为HBM物理地址

参数

• SystemAddress: U64 - 系统地址，十进制

返回值

• DdrAddress: String - HBM物理地址，json格式字符串

DdrAddr2SysAddr

将物理内存地址转换为系统地址

参数

• DdrAddress: String - 物理内存地址，json格式字符串

返回值

• SystemAddress: U64 - 系统地址，十进制

MemoryIsolation

向IMU请求故障内存隔离，并等待返回结果

参数

• IsolationType: String - 隔离类型，0:ACLS 1:SPPR 2:HPPR 3:ADDDC 4:SDDC 5:RankSparing 6:PageOffline
• DdrAddress: String - 待隔离的物理内存地址，json格式字符串

返回值

• Result: U32 - 隔离结果

bmc.kepler.Debug.Systems.FDMDomain.BoardRAS ​

==方法==

DumpBoardLog

获取天池组件flash中的日志，目前仅存在BCU导出在/tmp目录下，需要判断是否为软链接

参数

• SystemId: U8 - 需要导出日志的系统编号，从1开始。取值255表示对所有系统进行导出。

返回值

• TaskId: U32 - 表示导出日志创建的任务id，全局唯一

bmc.kepler.Debug.Systems.NCSI ​

==方法==

SendCmdOverMCTP

调试NCSIoverMCTP命令接口

参数

• NodeId: String - 网口的NodeId作为主件的唯一标识
• Command: U8 - MCTP命令packet_type
• Payload: String - 命令传入的数据

返回值

• Data: String - 命令返回数据

bmc.kepler.Debug.Systems.NetworkAdapters ​

==方法==

Dump

将网卡信息转储到日志文件

bmc.kepler.Debug.Systems.OpticalModules ​

==属性==

bmc.kepler.Dft ​

==方法==

MockLogStorm

模拟日志风暴的接口

参数

• Count: U32 - 风暴日志的次数

bmc.kepler.EepromData ​

==属性==

bmc.kepler.Example.InterfaceBar ​

==属性==

==方法==

MethodBar

参数

• StructArg: unknown
• ArrayArg: U32[]
• ArrayStruct: Array

返回值

• Result: U32

==自定义类型==

SturctArg: 结构体类型

• SubArg1: String
• SubArg2: String

bmc.kepler.Example.InterfaceFoo ​

==属性==

==方法==

MethodFoo

参数

• Arg1: U32

返回值

• Result: U32

bmc.kepler.Example.InterfaceTest ​

==属性==

==方法==

AddObject

参数

• Id: U32

DeleteObject

参数

• Id: U32

MethodA

参数

• Request: Dict1

返回值

• Result: Dict1

==自定义类型==

SturctArg: 结构体类型

• SubArg1: String
• SubArg2: U8

Dict1: 结构体类型

• key: String
• value: U32

bmc.kepler.FruCtrl.PowerOffLock ​

==属性==

==方法==

SetPowerOffLock

系统下电锁

参数

• Locked: Boolean - 是否下电锁定:true:锁定 false:解锁
• Timeout: U32 - 锁定超时时间（单位：s)，取值范围 [10, 3600]，超时之后自动解锁，多次同源锁定时按照最近的一次锁定时间为准
• AppName: String - 执行锁定的应用名称
• Reason: String - 执行锁定的原因描述，长度限制为128字节，整体采用大驼峰的格式。如：RetimerUpdate

bmc.kepler.FrudataService.Frudata ​

==方法==

Update

非标准电子标签更新资源树属性值接口

参数

• PropertyName: String[] - 电子标签属性名数组
• Value: String[] - 电子标签属性值数组

SetSysProductName

设置系统产品名称接口

参数

• FruId: U8 - 电子标签唯一标识FruId
• ProductName: String - 产品名称

SetProductAssetTag

设置产品资产标签

参数

• FruId: U8 - 电子标签ID
• AssetTag: String - 资产标签

bmc.kepler.Global.Managers.SOC ​

==属性==

bmc.kepler.Global.SecurityService.BasicTrustedComputing ​

==属性==

bmc.kepler.InferenceAsync ​

==方法==

InferenceAsync

site_ai异步推理服务入口，例如硬盘故障预测、内存故障预测等

参数

• ModelName: String - 模型名称
• Dimension: U32 - 总维度数
• Shape: U32[] - 维度信息
• Data: Double[] - 特征值

返回值

• TaskId: U32 - 创建的异步推理任务标识，全局唯一

bmc.kepler.Inventory.Hardware ​

==属性==

bmc.kepler.IpmiCore ​

==属性==

==方法==

Request

IPMI消息的请求接口

参数

• ChanType: U8 - IPMI消息的请求通道类型
• Instance: U8 - IPMI消息的请求通道实例
• NetFn: U8 - IPMI消息的网络码
• Lun: U8 - IPMI消息的Lun号
• Cmd: U8 - IPMI消息的命令字
• Payload: U8[] - IPMI消息的请求数据

返回值

• CompletionCode: U8 - 响应码
• Payload: U8[] - IPMI消息的响应数据

Route

底层通道传送的IPMI消息处理接口

参数

• Req: U8[] - 请求数据
• Ctx: U8[] - 请求上下文的json字符串，包括通道类型、会话信息、客户端信息

返回值

• Rsp: U8[] - 响应数据

SetHostPrivilegeLimited

设置host侧发送到BMC的ipmi命令权限限制集合

参数

• SystemId: String - 设置权限的host标识
• Privileges: String[] - 设置的权限集合，如果是nil或者空表则认为是清空权限集合

返回值

• Ret: Boolean - 返回值
• Reason: String - 设置权限失败的原因

SetChannelAccesses

根据通道类型设置IPMI通道访问权限

参数

• ChannelType: String - 通道类型
• AccessRole: String - 访问角色

GetIPMIChannel

根据通道编号获取IPMI通道信息

参数

• ChannelNumber: U8 - 通道编号

返回值

• Channels: Array - 通道信息，包括：InternalNumber：对内通道编号；ExternalNumber：对外通道编号；ProtocolType：协议类型；MediumType：媒体类型；ChannelType：通道类型；Instance：通道实例

==自定义类型==

Privileges: 结构体类型

• key: String
• value: String

ChannelInfo: 结构体类型

• key: String
• value: U8

bmc.kepler.LCN ​

==属性==

bmc.kepler.LCN.Card ​

==属性==

==自定义类型==

LogicVerObject: 结构体类型

• key: String - 逻辑器件名
• value: String - 逻辑器件版本号

bmc.kepler.LCN.Manage ​

==属性==

==方法==

ExportLog

导出日志

参数

• Path: String - 导出日志的路径

返回值

• TaskId: U32 - 任务ID

Reset

复位交换设备

参数

• ResetType: String - 交换设备复位类型

RestoreFactorySettings

复位交换设备且恢复出厂配置

bmc.kepler.LCN.ManagerAccountCollection ​

==方法==

NewAccount

创建用户

参数

• UserName: String - 用户名
• Password: String - 用户密码
• CipherType: U8 - 密码类型，0（可逆）1（不可逆）

GetAccounts

查询LCN设备所有用户

返回值

• Accounts: String - LCN设备所有用户

ChangePassword

修改用户密码

参数

• UserName: String - 用户名
• Password: String - 用户密码
• CipherType: U8 - 密码类型，0（可逆）1（不可逆）
• Policy: U8 - 修改策略，0（只修改本地）1（本地+LCN设备）

DeleteAcount

删除用户

参数

• UserName: String - 用户名

bmc.kepler.LCN.NetworkConfig ​

==属性==

==方法==

SetInterfaceConfig

设置网络配置

参数

• Policy: U8 - 修改策略, 0(只修改本地) 1(本地+1260), 仅GE3口支持修改本地
• Parameters: ParameterList - 设置可选参数 key: 参数名, value: 设置值

==自定义类型==

ParameterList: 结构体类型

• key: String - 参数名
• value: String - 设置值

bmc.kepler.LCN.UpdateService ​

==方法==

StartUpgrade

升级交换设备软件

参数

• ImageURI: String - 升级包文件路径
• ImageType: String - 升级包文件类型，支持UpdatePackage与PatchPackage，分别代表系统软件包与补丁包

返回值

• TaskId: U32 - 任务ID

bmc.kepler.LCN.Version ​

==属性==

==自定义类型==

LogicVerObject: 结构体类型

• key: String - 逻辑器件名
• value: String - 逻辑器件版本号

bmc.kepler.LifeCycle.Retirement ​

==属性==

==方法==

DataWipe

执行部件数据销毁

GetReport

获取部件数据销毁报告

返回值

• Report: DataWipeReportDict

==自定义类型==

DataWipeReportDict: 结构体类型

• key: String - 部件数据销毁报告属性
• value: String - 部件数据销毁报告值

bmc.kepler.LogRecorder.OperationLog ​

==方法==

Add

用于记录操作日志

参数

• Message: String

bmc.kepler.MCAdmin ​

==方法==

GetComponentList

框架主程序提供给组件，用于查询当前正在运行的组件列表，返回值是一个string数组

返回值

• OutData: String[] - 返回值是一个string数组,表示正在运行的组件列表

AddMatch

在共享内存中添加订阅规则

参数

• MatchString: String - 要添加的订阅规则字符串

RemoveMatch

在共享内存中删除订阅规则

参数

• MatchString: String - 要删除的订阅规则字符串

bmc.kepler.Mdb ​

==方法==

GetObject

根据Path, Interfaces查找service与Interface的映射关系

参数

• Path: String - 资源树对象路径
• Interfaces: String[] - 资源树对象路径下的接口

返回值

• Object: Object - 返回service与Interface的映射关系

GetSubObjects

根据Path, Depth, Interfaces查找Path、service与Interface的映射关系

参数

• Path: String - 资源树对象路径
• Depth: S32 - 指定查找的资源树深度
• Interfaces: String[] - 资源树对象路径下的接口数组

返回值

• SubObjects: Objects - 返回Path、service与Interface的映射关系

GetSubPaths

根据Path, Depth, Interfaces查找所有满足条件的资源树路径

参数

• Path: String - 资源树对象路径
• Depth: S32 - 指定查找的资源树深度
• Interfaces: String[] - 资源树对象路径下的接口

返回值

• SubPaths: String[] - 返回所有满足条件的资源树路径

GetParentObjects

根据Path, Interfaces查找所有该Path的祖先Path

参数

• Path: String - 资源树对象路径
• Interfaces: String[] - 资源树对象路径下的接口

返回值

• ParentObjects: Objects - 返回所有的祖先资源树对象路径

GetServiceName

根据dbus的发送方查找服务名称

参数

• Sender: String - dbus通信服务的发送方

返回值

• ServiceName: String - 返回服务名称

GetServiceNames

查找所有的服务

返回值

• ServiceNames: String[] - 返回查找到的所有服务

GetPath

根据Interface下的属性值查找满足条件的资源树对象路径

参数

• Interface: String - 资源树对象路径下的接口
• Filter: String - 属性名属性值键值对的json字符串
• IgnoreCase: Boolean - 支持忽略属性值大小写

返回值

• Path: String - 返回满足查找条件且按字典序排序的第一个资源树对象路径
• Service: String - 返回所在的服务名称

GetInterfaceOwners

查询拥有该接口的发送方和资源树对象路径

参数

• Interface: String - 资源树对象路径下的接口

返回值

• InterfaceOwners: Array - 返回给定查询接口的拥有者

IsValidPath

根据Path、Ignore_case, 判断是否要忽略大小写来判断路径是否是一个有效路径

参数

• Path: String - 资源树对象路径
• IgnoreCase: Boolean - 支持忽略大小写进行判断

返回值

• Result: Boolean - 返回true表示是一个有效路径，false表示无效路径

GetSubPathsPaging

分页查找, 根据Path、Depth、Interfaces查找所有满足条件的资源树路径

参数

• Path: String - 资源树对象路径
• Depth: S32 - 指定查找的资源树深度
• Interfaces: String[] - 资源树对象路径下的接口
• Skip: S32 - skip如果传负数等效于skip传0
• Top: S32 - top传负数会取skip之后的所有数据

返回值

• Paths: String[] - 返回满足查找条件的资源树对象路径

GetClasses

获取服务下的所有类名

参数

• Service: String - 服务名称

返回值

• ClassNames: String[] - 对应服务下的所有类名

GetObjectList

根据类名查询对象名、服务名和资源树对象路径

参数

• ClassName: String - 服务下的类名

返回值

• ObjectList: Array - 对应类名的对象信息

GetObjectOwner

根据对象名查找服务和资源树对象路径

参数

• ObjectName: String - 对象名

返回值

• ObjectOwners: Array - 返回对象的拥有者信息

GetMatchedObjects

根据服务名和接口模式字符串查找对象名、资源树对象路径、接口

参数

• ObjectName: String - 对象名称
• InterfacePattern: String - 资源树对象路径下的接口模式字符串

返回值

• MatchedObjects: Array - 返回满足查找条件的对象信息

==自定义类型==

Object: 结构体类型

• key: String
• value: String[]

Objects: 结构体类型

• key: String
• value: Object

InterfaceOwner: 结构体类型

• Sender: String
• Path: String

ObjectInfo: 结构体类型

• ObjectName: String
• ObjectOwners: Array

ObjectOwner: 结构体类型

• Service: String
• Path: String

MatchedObject: 结构体类型

• ObjectName: String
• Path: String
• Interfaces: String[]

bmc.kepler.Metric ​

==方法==

GetData

根据MetricName获取采集项数据

参数

• MetricName: String[] - 采集项名称

返回值

• Val: Array - 采集项数据

GetItems

获取采集项描述信息

返回值

• Component: String - 采集主体名称
• Classification: Array - 分类信息
• Identification: Array - 标识信息
• MetricName: String[] - 采集项名称

SynDataAcquisitionEnable

将数据采集开关状态同步到业务组件

参数

• Enabled: U8 - 数据采集开关状态，取值：0表示关闭，1表示打开

==自定义类型==

DataCollectionItem: 结构体类型

• MetricName: String - 采集项名称
• Data: String[] - 采集项数据点

TagProp: 结构体类型

• PropName: String - 采集主体属性名
• PropVal: String - 采集主体属性值

bmc.kepler.MicroComponent ​

==属性==

==方法==

HealthCheck

检查组件健康状态的接口

返回值

• Status: S32 - 返回组件健康状态结果，正常返回0，检查失败后立即重启返回-2，其它异常情况返回-1

bmc.kepler.MicroComponent.ConfigManage ​

==方法==

Backup

配置文件备份

参数

• FilePath: String - 配置文件打包路径

返回值

• List: Array - 导出的配置文件名称、路径列表

Export

根据请求参数导出组件配置数据

参数

• Type: String - custom: 业务导出; configuration: 定制导出

返回值

• Data: String - 组件配置数据（json字符串形式）

Import

根据请求参数导入组件配置数据

参数

• Data: String - 组件配置数据（json字符串形式）
• Type: String - custom: 业务导入; configuration: 定制导入

Recover

配置文件还原

参数

• PreserveList: Object - 保留日志的列表

Verify

校验组件自定义定制化结果

参数

• Data: String - 组件配置数据(json字符串形式)

返回值

• Result: String - 组件自定义校验结果(json字符串形式)

GetTrustedConfig

获取供应链相关组件安全配置信息json字符串

返回值

• Configuration: String - 供应链相关组件安全配置信息json字符串

GetPreservedConfig

获取还原时需要保留的配置信息

参数

• PreserveFlag: Preserve - 保留配置标志，用于标识需要保留哪些配置信息

返回值

• PreserveData: String - 保留配置数据json字符串

==自定义类型==

Items: 结构体类型

• FileName: String
• OriginPath: String

Object: 结构体类型

• key: String
• value: String

Preserve: 结构体类型

• PreserveKey: String
• PreserveValue: String

bmc.kepler.MicroComponent.Debug ​

==属性==

==方法==

Dump

用于导出组件日志到指定路径

参数

• FilePath: String - 日志文件导出的路径

SetDlogLevel

设置组件的日志级别（生效时长是以小时为单位，范围是1-24，作用是在修改的日志级别小于默认级别时，在到生效时长后，改回默认级别）

参数

• Level: String - 设置的日志级别
• EffectiveHours: U8 - 日志级别，生效时长

AttachDebugConsole

使mdbctl和业务组件建立连接

参数

• Port: U32 - mdbctl分配的端口号

DetachDebugConsole

使mdbctl和业务组件断开连接

bmc.kepler.MicroComponent.Performance ​

==方法==

StartProfiling

开始统计组件的signal接收，rpc调用信息

参数

• Duration: U32 - 统计时长

bmc.kepler.MicroComponent.Reboot ​

==方法==

Prepare

用于业务组件进行重启前准备操作，要求操作耗时短、可恢复，例如检测是否可以复位、数据落盘

返回值

• Result: S32 - 返回业务组件重启前准备结果, SUCCESS(0),FAIL(-1)

Process

用于业务组件进行重启前处理操作，支持耗时较长、不可回滚、依赖其它组件的处理操作，例如CPLD生效

返回值

• Result: S32 - 返回业务组件重启前处理结果, SUCCESS(0),FAIL(-1)

Action

用于业务组件进行重启执行操作，支持耗时适中、不可回滚、不依赖其它组件的操作，例如资源回收、停止服务、数据落盘

返回值

• Result: S32 - 返回业务组件重启执行结果, SUCCESS(0),FAIL(-1)

Cancel

取消重启

bmc.kepler.MicroComponent.Reset ​

==方法==

Prepare

用于组件重置准备

参数

• ResetType: String - 重置类型。取值范围：WarmReset

返回值

• Result: S32 - 返回组件重置准备结果，0 代表 SUCCESS, -1 代表 FAIL

Action

执行组件重置

参数

• ResetType: String - 重置类型。取值范围：WarmReset

返回值

• Result: S32 - 返回组件重置执行结果，0 代表 SUCCESS, -1 代表 FAIL

Cancel

取消重置

参数

• ResetType: String - 重置类型。取值范围：WarmReset

bmc.kepler.MicroComponent.Snapshot ​

==方法==

StartSnapshot

收集组件snapshot，并保存到文件

返回值

• Result: String - 返回结果消息，包括保存路径

DiffSnapshot

收集组件snapshot，将与上一次snapshot接口比较的结果保存到文件

返回值

• Result: String - 返回结果消息，包括保存路径

bmc.kepler.Object.Properties ​

==属性==

==方法==

GetOptions

按接口名和属性名查询属性的能力选项

参数

• Interface: String - 接口名
• Property: String - 属性名

返回值

• Options: Struct - 属性能力选项，例如是否弃用、是否是易变属性等

GetPropertiesByOptions

按接口名和能力选项查询符合条件的所有属性

参数

• Interface: String - 接口名
• Options: Struct - 属性能力选项，例如是否弃用、是否是易变属性等

返回值

• Properties: String[] - 属性名列表

==自定义类型==

StructIdentifier: 结构体类型

• SystemId: U8
• ManagerId: String
• ChassisId: String
• Position: String

Options: 结构体类型

• volatile: Boolean
• deprecated: Boolean
• explicit: Boolean
• emitsChangedSignal: String

bmc.kepler.ObjectGroup ​

==属性==

==方法==

GetObjects

获取此位置的所有owner的对象

参数

• Owner: String - 对象所有者App名称

返回值

• Position: String - 组件的position
• Objects: Array - 组件此position所有对象的信息（类名，对象名，对象属性，拓展属性）
• LifeCycleId: U32 - 组件对象生命周期id标志

GetTopology

获取对象组拓扑信息

返回值

• Topology: String - 对象组拓扑信息

==自定义类型==

ObjectInfo: 结构体类型

• ClassName: String
• ObjectName: String
• ObjectProps: String
• ObjectExtends: String

bmc.kepler.Persistence ​

==方法==

Read

查询单个数据库表数据

参数

• TableName: String - 查询的数据库表名
• AppName: String - 发起请求的组件名称

返回值

• Result: Array - 查询结果，包含单个数据表的数据

BatchRead

批量查询数据库表数据

参数

• TableNames: String[] - 查询的数据库表名

返回值

• Result: TablesData - 查询结果，包含多个数据表的数据

Save

持久化写入

参数

• OperateType: S32 - 持久化操作类型。取值包括18（插入），23（更新），9（删除）
• TableName: String - 被修改的数据库表名
• PrimaryKeys: Array - 被修改这条记录对应的主键数据
• Properties: PropertiesInfo - 修改的持久化属性信息，包括每个属性的值和持久化类型
• AppName: String - 发起请求的组件名称

Flush

触发缓存事务实时落盘

参数

• AppName: String - 发起请求的组件名称

==自定义类型==

DataItem: 结构体类型

• key: String - 数据项的名称
• value: U8[] - 数据项的值

PrimaryKeyData: 结构体类型

• KeyName: String - 主键名
• KeyValue: U8[] - 主键值

TableRow: 结构体类型

• RowIndex: String - 行数据索引，由这行数据的主键字段键值对拼接而成
• RowData: DataItem - 行数据，包含各属性值

TableRows: 结构体类型

• key: String - 行数据索引，由这行数据的主键字段键值对拼接而成
• value: DataItem - 行数据，包含各属性值

TableDataByStatus: 结构体类型

• Key: String - 持久化数据状态，取值包括active（当前有效）和deleted（已删除）
• value: TableRows - 状态对应的持久化表数据

TablesData: 结构体类型

• key: String - 持久化表名
• value: TableDataByStatus - 持久化表数据，按数据状态区分

PropertiesInfo: 结构体类型

• key: String - 持久化属性名
• value: DataItem - 持久化属性的信息，包括数据值和持久化类型

bmc.kepler.ProductInfo.FruCtrlCapabilities ​

==属性==

bmc.kepler.Products.HostBMCCoolingConfig ​

==属性==

bmc.kepler.Redfish.Task ​

==属性==

==方法==

GetTaskId

获取Redfish任务Id

参数

• TaskId: U32

返回值

• RedfishTaskId: U32 - 资源数的任务Id映射的Redfish任务Id, 0表示任务不存在

bmc.kepler.Scanner ​

==属性==

bmc.kepler.Scanner.Aggregate ​

==属性==

bmc.kepler.SystemControl ​

==属性==

==方法==

ForceReset

强制复位BMC的接口

参数

• ResetType: U8 - 重启类型。0 表示下次从正常系统启动，1 表示下次从最小系统启动

GracefulReset

平滑复位BMC的接口

参数

• ResetType: U8 - 重启类型。0 表示下次从正常系统启动，1 表示下次从最小系统启动

返回值

• OutData: S32 - 返回业务组件善后处理的结果

WarmReset

热复位BMC的接口

ForceResetWithCause

强制复位BMC的接口，需要带有原因

参数

• ResetType: U8 - 重启类型。0 表示下次从正常系统启动，1 表示下次从最小系统启动
• ResetCause: U8 - 重启原因

GracefulResetWithCause

平滑复位BMC的接口，需要带有原因

参数

• ResetType: U8 - 重启类型。0 表示下次从正常系统启动，1 表示下次从最小系统启动
• ResetCause: U8 - 重启原因

返回值

• OutData: S32 - 当前平滑重启的处理结果

SetResetLockStatus

设置复位锁定状态

参数

• ResetMode: String - 重启模式。WarmReset 表示热复位，GracefulReset 表示平滑复位，ForceReset 表示强制复位
• OperationType: String - 操作类型。Lock 表示加锁，Unlock 表示解锁
• TimeoutSeconds: U32 - 超时时间。组件设置复位锁定后在指定时间内未解锁，则自动解除。范围：10 ~ 300。单位：秒。
• LockCause: Enum - 复位锁定原因。系统处于复位锁定状态，无法执行复位操作的原因。Default:默认值为当前状态不支持此操作; BiosDuringPost：处于 BIOS POST 阶段不允许复位

==自定义类型==

LockCause: 结构体类型

bmc.kepler.UnifiedBus.Port ​

==属性==

==自定义类型==

MACAddressesItem: 结构体类型

• MACAddress: String - MAC地址

bmc.kepler.UnifiedBus.Port.Metrics ​

==属性==

==自定义类型==

CreditBackPressureItem: 结构体类型

• VituralLaneId: U8 - 虚拟laneId
• LastBackpressureTime: String - 最近一次反压发生时间
• BackPressureCount: U64 - 反压个数

bmc.kepler.Watchdog2.Status ​

==属性==