整机与部件资源
更新时间: 2026/06/30
在Gitcode上查看源码

bmc.kepler.Systems.AirCoolingConfig

==属性==

属性名类型可读写信号通知描述
CtrlModeString只读变更广播风扇控制模式(自动/手动/混合)
CtrlModePersistTypeU8只读变更广播风扇控制模式的持久化类型;0:不持久化、1:复位持久化、2:掉电持久化
CtrlModeResetPersistString只读变更广播复位持久化的风扇控制模式
CtrlModePoweroffPersistString只读变更广播掉电持久化的风扇控制模式
TimeOutU32只读变更广播手动模式下的超时时间,时间:秒
ManualSpeedPercentU8只读变更广播手动模式下的转速级别
ManualSpeedPercentResetPersistU8只读变更广播复位持久化的手动模式下的转速级别
ManualSpeedPercentPoweroffPersistU8只读变更广播掉电持久化的手动模式下的转速级别
SpeedPercentRangeU8[]只读变更广播手动设置转速级别允许范围
MinAllowedSpeedPercentU8读写变更广播失联状态场景风扇转速级别,默认值255表示属性无效,有效值范围为机型允许的最小风扇转速比到100
InitialSpeedPercentU8读写变更广播开机风扇初始转速百分比
ActiveAlgorithmString只读变更广播当前实时生效的算法,取值为:MPC、PID或N/A
SpeedDeviationThresholdPercentU8读写变更广播风扇转速偏差阈值,取值为100时表示告警关闭

==方法==


SetManualSpeedPercent

设置风扇手动模式转速百分比

参数

  • FanId: U8 - 风扇Id
  • SpeedPercent: U8 - 风扇转速百分比

SetCtrlMode

设置风扇控制模式

参数

  • CtrlMode: String - 风扇控制模式
  • Timeout: U32 - 超时时长,时间:秒

SetCtrlModePersist

设置可持久化的风扇控制模式

参数

  • CtrlMode: String - 风扇控制模式
  • CtrlModePersistType: U8 - 当前风扇模式的持久化类型,0:不持久化,1:复位持久化,2:掉电持久化
  • Timeout: U32 - 超时时长,时间:秒

bmc.kepler.Systems.BIOSConfiguration

==属性==

属性名类型可读写信号通知描述
DEMTEnabledBoolean只读变更广播DEMT功能是否开启
RefreshRateU32只读变更广播内存刷新频率

==方法==


SetDEMTEnabled

设置DEMT功能是否开启

参数

  • DEMTEnabled: Boolean - DEMT功能是否开启

SetRefreshRate

设置内存刷新频率

参数

  • RefreshRate: U32 - 内存刷新频率

bmc.kepler.Systems.Bios

==属性==

属性名类型可读写信号通知描述
SystemStartupStateU8只读变更广播Bios启动状态, 枚举值, 0: Bios未启动, 32: Bios初始化ME完成, 64: Bios启动到PCIE信息上报完成, 96: SMBIOS write prepare, 99: SMBIOS write start, 102: SMBIOS write finish, 111: Bios进入PXE, 254: Bios Post阶段完成
SystemIdU8只读变更广播系统Id
VersionString只读变更广播Bios版本信息
BackupVersionString只读变更广播Bios备份版本信息
CurrentValueFileNameString只读变更广播当前生效的配置文件
ResultFileNameString只读变更广播配置生效结果文件
SettingFileNameString只读变更广播待生效配置文件
RegistryFileNameString只读变更广播标准配置文件
MenuDataString只读变更广播菜单数据
MenuChangeFlagU8只读变更广播菜单变动标志
RegistryVersionString只读变更广播标准配置文件的版本
DEMTConfigU8只读变更广播DEMT配置
PcieCardBDFU8[]只读变更广播Pcie卡BDF
PcieDiskBDFU8[]只读变更广播硬盘BDF
OCPCardBDFU8[]只读变更广播OCP卡BDF
BiosBootStageU8只读变更广播Bios启动阶段
UpgradeFailedU8只读变更广播正常升级完成后,BIOS Flash完整性校验状态,主要用于配置告警
RecoverFailedU8只读变更广播自恢复完成后,BIOS Flash完整性校验状态,主要用于配置告警
BiosLogPrintEnabledU8只读变更广播Bios的日志全打印使能状态
SettingsEffectiveStatusString只读变更广播Bios配置文件的生效状态
BiosConfigActiveModeU64只读变更广播设置BIOS配置导入的生效模式, 0:导入BIOS待生效配置,BIOS重启后生效 1:恢复BIOS默认配置,再导入BIOS待生效配置,BIOS重启后生效
TeeOSVersionString只读变更广播TeeOS版本号
ResetBiosToDefaultsPendingBoolean只读变更广播恢复默认命令下发但还没生效,true:表示存在(即未生效),false:表示不存在(即已生效)

==方法==


ClearCmos

清除BIOS配置信息

返回值

  • Result: S32 - 清除BIOS配置结果

SetBiosConfigActiveMode

设置BIOS配置导入的生效模式

参数

  • Mode: U64 - BIOS配置生效模式, 0:导入BIOS待生效配置,BIOS重启后生效 1:恢复BIOS默认配置,再导入BIOS待生效配置,BIOS重启后生效

ResetSetupConfig

清除BIOS配置以及待生效配置

返回值

  • Result: S32 - 清除BIOS配置以及待生效配置结果

ChangePassword

修改BIOS密码

参数

  • PasswordType: String - 密码类型
  • OldPassword: String - 旧密码
  • NewPassword: String - 新密码

返回值

  • Result: S32 - 修改结果,失败:-1,成功:0

SetBiosLogEnabled

设置BIOS日志全打印开关

参数

  • BiosLogPrintEnabled: U8 - BIOS全打印开关

返回值

  • Result: S32 - 设置BIOS全打印开关结果

ExportBiosSetup

导出Bios的配置

参数

  • FileType: String - 导出文件类型:Registry、CurrentValue、Setting、Result、ConfigValue

返回值

  • Result: String - 导出Bios的配置结果

ImportBiosSetup

导入Bios配置

参数

  • FileType: String - 导入文件类型:Registry、CurrentValue、Setting、Result、ConfigValue
  • Content: String - 导入文件内容

返回值

  • Result: S32 - 导入Bios配置结果

GetCurrentValueSetting

获取属性(参数ReqKey)当前配置的值

参数

  • ReqKey: String - 属性名

返回值

  • RespValue: String - 属性当前配置的值

RemoveCachedSettings

清除待生效的配置

返回值

  • Result: S32 - 清除待生效的配置的结果

ExportFirmware

导出对应系统的BIOS FLASH内容

参数

  • OutputFilePath: String - FLASH 数据文件导出路径,支持本地导出、远程导出; 当前只支持本地导出

返回值

  • TaskId: U32 - 导出BIOS FLASH的任务Id

VerifyPassword

校验待生效BIOS密码

参数

  • PasswordType: String - 密码类型
  • Password: String - 待校验密码

bmc.kepler.Systems.BiosUpgradeService

==属性==

属性名类型可读写信号通知描述
ActivatedStatusU8只读变更广播Bios无感升级固件生效状态, 枚举值0/1/2, 0:生效完成; 1:待生效; 2:生效中
FirmwareEffectiveStatusU8只读变更广播Bios普通升级固件生效状态, 枚举值1/2/3, 1:(待生效)固件待写入flash; 2:(生效中)固件已写入flash,待生效; 3:(生效完成)固件已写入flash,且已生效,包含无升级任务
PreserveConfigEnabledBoolean读写变更广播Bios配置保留使能, true: 升级bios后默认保留配置; false: 升级bios后默认不保留配置, 只有当bmc.kepler.UpdateService接口下的StartUpgrade方法未传保留配置参数时, 才用该属性判断升级是否保留配置

==方法==


ActivateFirmware

生效Bios固件

参数

  • DatabseType: String[] - Bios固件名:imu、imp等

GetFirmwareInfo

获取Bios固件信息

返回值

  • FirmwareInfo: String - Bios固件信息

ExportBiosFirmware

导出Bios固件信息

返回值

  • TaskId: U32 - 返回任务Id

bmc.kepler.Systems.BizTopoNode

==属性==

属性名类型可读写信号通知描述
SystemIDU8只读变更广播系统Id

bmc.kepler.Systems.Board

==属性==

属性名类型可读写信号通知描述
SlotU8只读变更广播槽位号
NumberU8只读变更广播逻辑编号
PositionString只读变更广播容器信息(如:chassis)
NameString只读变更广播单板名
ProductNameString只读变更广播产品名
SilkTextString只读变更广播丝印信息
ManufacturerString只读变更广播厂商
DescriptionString只读变更广播单板描述
BoardIDU16只读变更广播单板ID
PartNumberString只读变更广播部件编码
PcbVersionString只读变更广播PCB版本号
LogicVersionString只读变更广播逻辑版本号(cpld)
SRVersionString只读变更广播SR版本号
MCUVersionString只读变更广播MCU版本号
PSIPVersionString只读变更广播封装电源版本号
LogicUnitU32只读变更广播逻辑位号(U位号)
PowerWattsU32只读变更广播功率
RunningStatusU8只读变更广播监控cpld和mcu的运行状态(1:正常运行,0:异常)
FruIDU8只读变更广播关联Fru对象的FruID属性
NodeIdString只读变更广播资源id,优先遵循v2中redfish的计算规则,这里由容器信息Position和设备丝印名称DeviceName拼接而成,如:chassisPCIeRiser1
DeviceNameString只读变更广播板卡丝印信息(如:PCIe Riser1)
BoardTypeString只读变更广播单板类型
RefComponentString只读变更广播引用到Component对象
RefFruString只读变更广播引用到Fru对象
SerialNumberString只读变更广播序列号
CpldStatusU8只读变更广播Cpld状态
MultiLogicUnitLogicUnitObject只读变更广播单板所有逻辑位号,key:cpld名,value:逻辑位号
MultiLogicVersionLogicVerObject只读变更广播单板所有逻辑版本号,key:cpld名,value:逻辑版本号

==自定义类型==


LogicUnitObject: 结构体类型

  • key: String
  • value: U32

LogicVerObject: 结构体类型

  • key: String
  • value: String

bmc.kepler.Systems.Board.CpuBoard

==属性==

属性名类型可读写信号通知描述
PlatformU8只读变更广播平台类型
BIOSVersionString只读变更广播BIOS版本号,一host对应多个bcu的场景下只有主bcu显示

bmc.kepler.Systems.Board.M2

==属性==

属性名类型可读写信号通知描述
M2SlotPresenceU8只读变更广播M.2盘在位情况,每个bit表示一个槽位,bit0表示SSD1在位,bit1表示SSD2在位
M2SlotMaxCountU8只读变更广播M.2盘的上限

bmc.kepler.Systems.Board.NpuBoard

==属性==

属性名类型可读写信号通知描述
PowerWattsU16只读变更广播NPU模组功耗值,单位W
PowerCapWattsU16只读变更广播NPU模组功耗封顶值,单位W
MaxPowerCapWattsU16只读变更广播NPU模组支持的最大功耗封顶值,单位W
MinPowerCapWattsU16只读变更广播NPU模组支持的最小功耗封顶值,单位W
ModelString只读变更广播NPU模组型号
ComputeCapabilityString只读变更广播NPU模组的算力
VRDUpgradeStateU8只读变更广播vrd升级状态, 0代表未升级,1代表升级中

==方法==


Reset

复位NPU板

参数

  • Slot: U32 - 槽位号

ResetDevice

支持按区域复位NPU板

参数

  • RegionId: U8 - 复位NPU的区域Id:0xff复位全域,0x0保留,0x1复位计算单元

bmc.kepler.Systems.Board.NpuBoards

==方法==


SetNpuPowerCap

设置NPU封顶功耗

参数

  • PowerCapConfigs: Array - 设置NPU封顶功耗参数列表

返回值

  • FailedList: U8[] - 设置失败的NPU模组Id数组

==自定义类型==


PowerCapConfigsItem: 结构体类型

  • NpuId: U8 - NPU模组Id
  • Power: S16 - 封顶功耗调整幅度,正数表示上调,负数表示下调

bmc.kepler.Systems.Board.Unit

==属性==

属性名类型可读写信号通知描述
UIDString只读变更广播组件唯一标识
TypeString只读变更广播组件类型(枚举值:EXU,BCU,SEU,CLU,SEU)
HWSRVersionString只读变更广播天池组件Eeprom中的sr版本号
CurrentUpgradeStatusU8只读变更广播0表示未在升级,1:mcu正在升级,2cpld正在升级

bmc.kepler.Systems.BootOptions

==属性==

属性名类型可读写信号通知描述
BootSourceOverrideModeString只读变更广播系统启动模式,Legacy或UEFI
BootSourceOverrideEnabledString只读变更广播系统启动项生效次数:Disabled不生效,Once生效一次,Continuos一直生效
BootSourceOverrideTargetString只读变更广播系统启动项
BootOptionReferenceString[]只读变更广播唯一启动选项标识符
BootOrderString[]只读变更广播系统启动项启动顺序
BootModeSupportBoolean只读变更广播BIOS启动模式是否支持设置
BootModeIpmiSettableBoolean只读变更广播BIOS启动模式是否支持通过IPMI设置
BootOptionPolicyU8读写变更广播定制化启动项策略,0:不定制;1:设置永久启动项联动修改启动顺序,设置的永久启动项不被单次启动项覆盖
PreviousBootSourceOverrideTargetString只读变更广播上次设置的永久启动项类型

==方法==


ShieldIpmiModifyBootModeSupport

屏蔽是否可以通过ipmi设置启动模式

参数

  • ModeSwitch: Boolean - 屏蔽启动模式的开关

返回值

  • RespCode: S32 - 屏蔽结果

ImportCertificate

导入Bios的Https启动证书

参数

  • CertString: String - Https启动证书内容
  • CertType: String - Https启动证书类型

ImportCrl

导入Bios的Https启动证书吊销列表

参数

  • CertString: String - Https启动吊销证书内容
  • CertType: String - Https启动吊销证书类型

ResetCrl

重置Bios的Https启动证书吊销列表

参数

  • ResetType: String - Bios的Https证书吊销类型

ResetCertificate

重置Bios的Https启动证书

参数

  • ResetType: String - Bios的Https启动证书类型

GetCertificate

获取Bios的Https启动证书

返回值

  • CertInfo: String - Bios的Https启动证书类型

SetBootOrder

设置Bios启动顺序

参数

  • BootOrderJson: String - Bios启动顺序

返回值

  • OutCode: S32 - Bios启动顺序返回码
  • ErrName: String - Bios启动顺序错误名
  • ErrValue: String - Bios启动顺序错误值

SetStartOption

设置Bios启动项

参数

  • StartOption: String - Bios启动项

返回值

  • Result: S32 - 设置Bios启动项结果

SetStartOptionFlag

设置Bios启动项生效次数

参数

  • StartOptionFlag: String - Bios启动项次数

返回值

  • Result: S32 - 设置Bios启动项生效次数

SetBootMode

设置Bios启动模式

参数

  • mode: String - Bios启动模式

返回值

  • RespCode: S32 - 设置Bios启动模式结果

bmc.kepler.Systems.Component

==属性==

属性名类型可读写信号通知描述
FruIdU8只读变更广播关联所在的Fru的Fruid
InstanceU8只读变更广播组件设备Number
TypeU8只读变更广播组件类型
NameString读写变更广播组件设备名称
PresenceU8只读变更广播组件在位情况
HealthU8读写变更广播组件健康状态
PowerStateU8只读变更广播组件上电状态
BoardIdU16只读变更广播组件单板BoardId
UniqueIdString只读变更广播组件唯一标识,Vendor + ComponentID
ManufacturerString只读变更广播组件厂商信息
GroupIdU8只读变更广播组件逻辑组Id
LocationString只读变更广播组件的容器
SerialNumberString只读变更广播组件序列号
PartNumberString只读变更广播组件号
SegmentIdU8只读变更广播组件容器ID
FunctionString只读变更广播部件功能信息
PreviousSNString只读变更广播更换前SN,SerialNumber,来自board区域掉电持久化
ReplaceFlagU8只读变更广播部件是否发生了更换,用于产生SEL日志
NodeIdString只读变更广播节点的ID

==方法==


UpdateHealth

更新组件健康状态

参数

  • Health: U8 - 健康状态

bmc.kepler.Systems.Components

==方法==


GetComponentTypes

获取当前存在的所有对象的部件类型

返回值

  • ComponentTypes: Array - 所有对象的部件类型列表

==自定义类型==


ComponentTypes: 结构体类型

  • ComponentType: U8 - 部件类型
  • ComponentName: String - 部件名称

bmc.kepler.Systems.ComputerSystem

==属性==

属性名类型可读写信号通知描述
IdU8只读变更广播系统Id
OSVersionString只读变更广播OS版本号
KernelVersionString只读变更广播内核版本号
HostNameString读写变更广播主机名称
DomainNameString只读变更广播域名称
HostDescriptionString只读变更广播计算机描述
MajorOSVersionString只读变更广播操作系统主版本号
MinorOSVersionString只读变更广播操作系统次版本号
HostnameSyncEnabledBoolean读写变更广播从带内同步hostname到BMC使能开关,默认true

bmc.kepler.Systems.ComputerSystem.Metrics

==属性==

属性名类型可读写信号通知描述
TotalSystemMemoryGiBDouble只读变更广播总系统内存容量
SystemMemoryBuffersGiBDouble只读变更广播系统内存缓冲区容量
SystemMemoryCachedGiBDouble只读变更广播系统内存缓存区容量
NetBandwidthThresholdPercentU16读写变更广播网络带宽占用率门限默认值100

bmc.kepler.Systems.Contact

==属性==

属性名类型可读写信号通知描述
OfficalWebString读写变更广播官网
SupportWebString读写变更广播技术支持网站
EmailString读写变更广播邮箱
PhoneString读写变更广播电话
CopyrightString读写变更广播版权
KVMClientDownloadLinkString读写变更广播独立kvm客户端下载连接信息
QRCodeSupportedBoolean读写变更广播Web是否支持显示文档二维码标志位

bmc.kepler.Systems.ContainedPort

==属性==

属性名类型可读写信号通知描述
NodeIdString只读变更广播包含物理网口ID

bmc.kepler.Systems.CoolingArea

==属性==

属性名类型可读写信号通知描述
AreaIdU8只读变更广播调速域Id
RequirementIdxU8只读变更广播该调速区域关联的温度点Id
PolicyIdxGroupU8[]只读变更广播该调速区域关联的线性调速策略Id组
FanIdxGroupU8[]只读变更广播该调速区域关联的风扇组

bmc.kepler.Systems.CoolingConfig

==属性==

属性名类型可读写信号通知描述
SmartCoolingStateString只读变更广播智能调速使能状态, Enabled:使能,Disabled:未使能
SmartCoolingModeString只读变更广播智能调速模式
MediumString只读变更广播散热介质(风/液/风液混合)
CtrlModeString只读变更广播冷却单元的控制模式(自动/手动/混合)
TimeOutU32只读变更广播手动模式下的风扇超时时间,单位:秒
ManualLevelU8只读变更广播手动模式下的风扇转速级别
LevelPercentRangeU8[]只读变更广播手动设置转速级别允许范围
SensorLocationSupportedBoolean只读变更广播是否支持温度海洋界面显示
MinAllowedFanSpeedPercentU8读写变更广播失联状态场景风扇转速级别,默认值255表示属性无效,有效值范围为机型允许的最小风扇转速比到100
MixedModeSupportedBoolean只读变更广播是否支持混合模式场景,true:支持混合模式,false:不支持混合模式
MinAllowedFanSpeedEnabledBoolean只读变更广播MinAllowedFanSpeedPercent 使能状态,true:使能,false:未使能

==方法==


SetSmartCoolingMode

设置智能调速模式

参数

  • Mode: String - 智能调速模式,取值为:Custom、HighPerformance、LowNoise、EnergySaving或LiquidCooling

SetMedium

设置散热介质类型

参数

  • Medium: String - 散热介质类型:Air或Liquid

SetManualLevel

设置手动模式冷却级别

参数

  • UnitId: U8 - 冷却单元Id
  • Level: U8 - 设置的转速级别

SetCtrlMode

设置冷却单元控制模式

参数

  • CtrlMode: String - 冷却单元控制模式
  • Timeout: U32 - 超时时长,单位:秒

GetCustomTargetTemperatures

获取自定义目标温度点

返回值

  • CustomTargetTemperatures: Array - 自定义目标温度点数组

GetAbnormalPolicyEffectiveStatus

获取异常调速策略生效状态

参数

  • PolicyType: String - 异常调速类型, Fan, Pump, Temperature, All

返回值

  • EffectiveStatus: Boolean - 异常调速策略生效状态, true:触发异常调速, false:未触发异常调速

SetMinPWM

设置转速下限值

参数

  • DeviceType: String - 散热设备类型
  • DeviceIds: U8[] - 散热设备Id数组
  • DeviceSpeeds: U8[] - 散热设备转速数组

SetMinAllowedFanSpeedEnabled

设置MinAllowedFanSpeedPercent 使能状态

参数

  • MinAllowedFanSpeedEnabled: Boolean - MinAllowedFanSpeedPercent 使能状态

GetComponentThermalZone

获取指定温度点器件类型与散热器件对应关系

参数

  • ComponentType: String - 温度器件类型

返回值

  • ComponentThermalZone: Array - 指定温度器件对应散热器件数组

==自定义类型==


CustomTargetTemperatureItem: 结构体类型

  • TemperatureType: U32 - 温度点类型 1:Cpu 2:Outlet 3:Disk 4:Memory 5:PCH 6:VRD 7:VDDQ 8:NPUHbm 9:NPUAiCore 10:NPUBoard
  • TargetTemperatureCelsius: U8 - 目标调速温度值
  • MinTargetTemperatureCelsius: U8 - 目标温度调速温度值的最小值
  • MaxTargetTemperatureCelsius: U8 - 目标温度调速温度值的最大值

ComponentThermalZone: 结构体类型

  • Slot: U8 - 器件id
  • FanIds: U8[] - 器件对应风扇id
  • PumpIds: U8[] - 器件对应泵id

bmc.kepler.Systems.CoolingFan

==属性==

属性名类型可读写信号通知描述
FanIdU8只读变更广播风扇Id
HardwarePWMDouble只读变更广播风扇硬件占空比
FrontPresenceU8只读变更广播前转子在位状态,1:在位,0:不在位
RearPresenceU8只读变更广播后转子在位状态,1:在位,0:不在位
FrontStatusU8只读变更广播风扇前转子状态,0:正常,非0:异常
RearStatusU8只读变更广播风扇后转子状态,0:正常,非0:异常
FrontSpeedU16只读变更广播前转子转速
RearSpeedU16只读变更广播后转子转速
LevelU8只读变更广播风扇转速级别
ManualSpeedPercentResetPersistU8只读变更广播复位持久化的手动模式下的转速级别
ManualSpeedPercentPoweroffPersistU8只读变更广播掉电持久化的手动模式下的转速级别

bmc.kepler.Systems.CoolingPolicy

==属性==

属性名类型可读写信号通知描述
PolicyIdxU8只读变更广播线性调速策略ID
PolicyTypeU32只读变更广播Policy类型,用于标识特定Policy对象,1:InletCustom,2:DiskCustom,4294967295:InvalidType
IsValidU8只读变更广播策略是否生效,1生效,0不生效
ExpCondValString只读变更广播预期生效条件,取值为:Custom、HighPerformance、LowNoise、EnergySaving或LiquidCooling
ActualCondValString只读变更广播实际生效条件,取值为:Custom、HighPerformance、LowNoise、EnergySaving或LiquidCooling
CustomSupportedBoolean只读变更广播是否支持自定义调速曲线
FanSpeedRangePercentsU8[]只读变更广播自定义调速曲线风扇速度范围
HysteresisU8只读变更广播迟滞量
TemperatureRangeLowS16[]只读变更广播线性调速策略温度区间左值
TemperatureRangeHighS16[]只读变更广播线性调速策略温度区间右值
SpeedRangeLowS16[]只读变更广播线性调速策略转速区间左值
SpeedRangeHighS16[]只读变更广播线性调速策略温度区间右值

==方法==


SetCustomCoolingPolicy

设置自定义调速策略

参数

  • TemperatureArray: U8[] - 温度数组
  • FanSpeedArray: U8[] - 风扇速度数组

SetHysteresis

设置迟滞量

参数

  • Hysteresis: U8 - 迟滞量

bmc.kepler.Systems.CoolingPump

==属性==

属性名类型可读写信号通知描述
IdU16只读变更广播泵Id
SlotU8只读变更广播泵槽位号
ActualPWMDouble只读变更广播泵占空比
SpeedU16只读变更广播泵转速
PresenceU8只读变更广播泵在位状态,1:在位,0:不在位
StatusU8只读变更广播泵状态,0:正常,1:异常
LevelU8只读变更广播手动模式下的转速级别

bmc.kepler.Systems.CoolingRequirement

==属性==

属性名类型可读写信号通知描述
RequirementIdU64只读变更广播目标调速策略Id
TemperatureTypeU32只读变更广播温度点类型 1:Cpu 2:Outlet 3:Disk 4:Memory 5:PCH 6:VRD 7:VDDQ 8:NPUHbm 9:NPUAiCore 10:NPUBoard 11:Inlet 12:SoCBoardOutlet 13:SoCBoardInlet 4294967295:无效值
ActiveInStandbyBoolean只读变更广播Standby下调速是否生效
TargetTemperatureCelsiusU8只读变更广播目标调速的目标值
MaxAllowedTemperatureCelsiusU8只读变更广播最大允许的工作温度,即满转温度
CustomSupportedBoolean只读变更广播是否支持自定义目标温度值,true:支持,false:不支持
CustomTargetTemperatureCelsiusU8只读变更广播用户自定义温度值
TargetTemperatureRangeCelsiusU8[]只读变更广播自定义温度允许范围
MonitoringStatusU8只读变更广播温度点状态 0正常 1异常
MonitoringValueDouble只读变更广播温度点状态,关联硬件
FailedValueU64只读变更广播温度点失效调速值
ThresholdValueU8[]只读变更广播温度点告警阈值
AlarmSpeedU8[]只读变更广播告警调速策略
SmartCoolingTargetTemperatureCelsiusS16[]读写变更广播SmartCooling目标值数组,依次存放节能、高性能、低噪三种模式下的目标温度
SensorNameString只读变更广播目标调速策略关联的传感器名称

==方法==


SetTargetTemperature

自定义目标温度

参数

  • TemperatureCelsius: U8 - 目标温度值

SetBackupTemperatureCelsius

设置备用温度点温度值

参数

  • TemperatureCelsius: Double - 目标温度值

SetBackupTemperatureStatus

设置备用温度点状态

参数

  • Status: U8 - 目标温度值

SetMaxAllowedTemperature

设置全速阈值

参数

  • MaxAllowedTemperature: U8 - 全速阈值,单位:摄氏度

SetFailedValue

设置温度失效转速

参数

  • FailedValue: U64 - 温度失效转速

SetSmartCoolingTargetTemperature

设置SmartCooling目标值数组

参数

  • SmartCoolingTargetTemperature: S16[] - SmartCooling目标值数组,依次存放节能、高性能、低噪三种模式下的目标温度

SetBasicCoolingTargetTemperature

设置目标温度

参数

  • BasicCoolingTargetTemperature: U8 - 目标温度值

bmc.kepler.Systems.DPUCard

==属性==

属性名类型可读写信号通知描述
BootSourceOverrideModeU8只读变更广播系统启动项0:未设置1:PXE启动2:本地磁盘启动
PxeOptionString读写变更广播DPU卡的PXE启动选项
UUIDString只读变更广播DPU卡的UUID
StorageIpAddrString只读变更广播存储管理网口IP地址
StorageIpVlanU16只读变更广播存储管理网口VlanID
M2SlotMaxCountU8只读变更广播M.2卡的上限
M2SlotPresenceU8只读变更广播M.2卡在位情况,每个bit表示一个槽位
NetworkAdapterMaxCountU8只读变更广播网卡最大数量
NetworkAdapterPresenceU8只读变更广播网卡在位情况,每个bit表示一张
MCUVersionString只读变更广播MCU版本号
SRVersionString只读变更广播SR版本号
UIDString只读变更广播组件唯一标识
PfMacInfoArray只读变更广播扩展卡的Physical Function Port信息、Physical Function Id信息和永久物理地址信息
BootSourceOverrideEnabledU8只读变更广播系统启动固化选项,0:单次生效1:永久生效
ModelString只读变更广播DPU卡名称,如IT21SHSK
SystemLoadedStatusEnum只读变更广播DPU卡的OS启动状态
MRCLogLevelU8读写变更广播DPU卡BIOS MRC日志等级
UEFILogLevelU8读写变更广播DPU卡BIOS UEFI日志等级
LogicVersionString只读变更广播Cpld版本
MultiLogicVersionLogicVerObject只读变更广播DPU卡的CPLD版本号,格式 [“CPLD1”: “2.03”, “CPLD2”: “2.04”]
CPLDCountU8只读变更广播DPU卡的CPLD数量
PowerStateString只读变更广播DPU卡电源状态,On表示上电,Off表示下电
VrdVersionString只读变更广播VRD版本号
MPUBusyStatusU8读写变更广播MPU繁忙状态 0: 空闲 1: 繁忙
OSSupportedBoolean只读变更广播用来识别是否开启与OS相关的功能,比如QT100n卡没有诊断中断功能
CPLDProtocolVersionString[]只读变更广播CPLD协议版本,卡的CPLD新增功能时会更新该版本号
BOMString只读变更广播Bom信息

==方法==


SetDpuNmi

设置SDI卡诊断中断

参数

  • SlotId: U8 - 槽位号

Reset

复位DPU卡


SetPowerState

设置DPU电源状态

参数

  • PowerState: U8 - DPU电源状态

SetBootOption

设置系统启动项

参数

  • Mode: U8 - DPU系统启动项,0:未设置、1:PXE启动、2:本地磁盘启动
  • Enabled: U8 - DPU系统启动固化选项,0:单次生效、1:永久生效

ImportPublicKey

导入证书

参数

  • Type: String - 传入证书方式,URI:文件格式上传,text:字符串格式上传
  • Content: String - 传入内容,当Type是URI时,传入文件路径,Type是text时,传入证书内容

GetLLDPStatus

获取LLDP使能状态

参数

  • PortId: U8 - 待操作的网口ID

返回值

  • Status: U8 - LLDP使能状态,0-关闭,1-开始

SetLLDPStatus

设置LLDP使能状态

参数

  • PortId: U8 - 待操作的网口ID
  • Status: U8 - LLDP使能状态,0-关闭,1-开始

==自定义类型==


PfMacInfoItem: 结构体类型

  • Port: U16
  • PfId: U16
  • PermanentMac: String

SystemBootStatus: 枚举类型

  • 0: OSBootNotStarted
  • 1: OSBootStarting
  • 2: OSBootFailed
  • 3: OSBootCompleted
  • 4: OSBootTimeout
  • 5: NoBootableDevice

LogicVerObject: 结构体类型

  • key: String
  • value: String

bmc.kepler.Systems.DPUCard.Fault

==属性==

属性名类型可读写信号通知描述
HeartBeatLossU8只读变更广播是否发生心跳丢失

bmc.kepler.Systems.DPUCard.Manager

==属性==

属性名类型可读写信号通知描述
FirmwareVersionString只读变更广播Manager的固件版本号
ManagerTypeString只读变更广播Manager的类型,例如BMC

bmc.kepler.Systems.DPUCard.Manager.SOL

==属性==

属性名类型可读写信号通知描述
EnabledBoolean只读变更广播使能状态:true,使能;false,未使能
SerialDirectionU8只读变更广播串口连接方向,0:串口关闭 1:串口连接到管理控制单元,如IMU、MCP ; 2:串口连接到系统控制单元,如SCP;3:串口连接到计算处理单元,如AP

==方法==


SetSerialDirection

设置串口方向

参数

  • SerialDirection: U8 - SerialDirection:待设置的串口方向,0:串口关闭 1:串口连接到管理控制单元,如IMU、MCP ; 2:串口连接到系统控制单元,如SCP;3:串口连接到计算处理单元,如AP

bmc.kepler.Systems.DPUCard.Metrics

==属性==

属性名类型可读写信号通知描述
CPUTemperatureCelsiusS16只读变更广播SDI卡CPU温度(单位摄氏度,精度为1摄氏度,有小数点则四舍五入。)
SFP1TemperatureCelsiusS16只读变更广播光模块1温度
SFP2TemperatureCelsiusS16只读变更广播光模块2温度
Inlet1TemperatureCelsiusS16只读变更广播计算卡进风口温度
Outlet1TemperatureCelsiusS16只读变更广播计算卡出风口温度
PowerWattsU16只读变更广播功耗原始读值, 精度为0.1W
ActualPowerWattsU16只读变更广播功耗实际值
NetworkAdapterChipTemperatureCelsiusS16只读变更广播DPU Nic温度
NICSFPMaxTemperatureCelsiusS16只读变更广播DPU卡的网络板光模块最高温度

bmc.kepler.Systems.DPUCard.Processor

==属性==

属性名类型可读写信号通知描述
ArchitectureString只读变更广播DPU 的CPU架构
TotalCoresU8只读变更广播DPU 的CPU核数
IMUVersionString只读变更广播IMU固件版本号

bmc.kepler.Systems.DPUCard.System

==属性==

属性名类型可读写信号通知描述
BIOSVersionString只读变更广播板卡的BIOS版本号
BiosBootStageEnum只读变更广播DPU卡的BIOS启动状态
MemorySizeGiBU16只读变更广播DPU内存大小
DiskCapacityGiBU16只读变更广播DPU存储大小
SecureBootOptionEnabledBoolean读写变更广播是否开启安全启动项
IndependentPowerControlEnabledBoolean读写变更广播DPU卡是否独立控制电源状态 true:独立控制 false:非独立控制,默认值true

==自定义类型==


BiosBootStatus: 枚举类型

  • 0: BiosBootNotStarted
  • 1: BiosBootStarting
  • 2: BiosBootCompleted
  • 3: BiosBootTimeout

bmc.kepler.Systems.DataAcquisitionService

==属性==

属性名类型可读写信号通知描述
EnabledU8读写变更广播数据采集开关使能状态,取值:0表示关闭,1表示开启

==方法==


GetHistoryData

根据Component、MetricType、时间筛选数据采集表中Tag、Metric、DataPoint表信息

参数

  • Component: String - 筛选采集部件名称,未指定时默认查询所有部件。支持取值:CPU、Memory、Disk、MainBoard、PSU、Chassis、System、Fan、OpticalModule、NPU
  • MetricType: String - 筛选采集类型,未指定时默认查询所有部件,支持取值:Temperature、Voltage、Vurrent、Performance、Health、Log、Smart
  • StartTime: U64 - 筛选采集开始时间,格式为unix时间戳
  • EndTime: U64 - 筛选采集结束时间,格式为unix时间戳

返回值

  • Data: String - 筛选出的数据采集信息

ClearHistoryData

清除采集到的数据

返回值

  • TaskId: U32 - 清除数据时创建的任务Id

ExportHistoryData

导出服务器部件历史最长7天内的采集数据,压缩归档至Path路径

参数

  • Path: String - 导出路径本地导出时必须在/tmp路径下,默认路径:/tmp/metric_history.tar.gz。远程导出URI格式:文件传输协议://用户名:密码@ip地址/目录/文件名。文件传输协议包括:sftp、https、nfs、cifs、scp

返回值

  • TaskId: U32 - 创建的任务标识

bmc.kepler.Systems.DelayedPowerOnPolicy

==属性==

属性名类型可读写信号通知描述
ModeString读写变更广播延迟上电策略
SecondsDouble读写变更广播延迟上电时间

bmc.kepler.Systems.DiscreteEvent

==属性==

属性名类型可读写信号通知描述
PropertyU32只读变更广播离散事件监听的属性,如果监听类型是组合侦听则代表 IPMI SEL产生使用的数据和方向
EventDirU8只读变更广播离散事件产生的方向:0 - 恢复;其他 - 产生,当监听类型是独立侦听时使用
SensorObjectString只读变更广播离散事件关联的离散传感器,当IPMI SEL产生或者恢复时体现在当前传感器的健康状态以及SEL上

bmc.kepler.Systems.DiscreteSensor

==属性==

属性名类型可读写信号通知描述
EntityIdU8只读变更广播传感器对应的实体,来自于IPMI规范,具体需要关联传感器对应的Entity.Id
EntityInstanceU8只读变更广播传感器对应的实体,来自于IPMI规范,具体需要关联传感器对应的Entity.Instance
OwnerIdU8只读变更广播传感器归属标识,默认32(归属于BMC),来自于IPMI规范,具体可以参考规范 43.1
OwnerLunU8只读变更广播传感器的Lun,默认0,来自于IPMI规范,具体可以参考规范 43.1
CapabilitiesU8只读变更广播传感器支持能力,来自于IPMI规范,具体可以参考规范 43.1
SensorIdentifierString只读变更广播传感器标识
SensorNameString只读变更广播传感器对外显示的名称
PositiveHysteresisU8只读变更广播传感器正向迟滞量,来自于IPMI规范,具体可以参考规范 43.1
NegativeHysteresisU8只读变更广播传感器负向迟滞量,来自于IPMI规范,具体可以参考规范 43.1
SensorNumberU8只读变更广播传感器编号,默认255,来自于IPMI规范,由BMC自行生成;如果需要特殊的编号,则需要单独在传感器定制化进行定制(BMC正常运行时插入的部件的传感器不支持定制)
ReadingU16只读变更广播传感器原始读值,引用传感器的数据源(如Scanner)读值同步,需要填写一个默认值,用于数据源未更新时显示,需要注意在门限之内,防止产生SEL事件

bmc.kepler.Systems.DiscreteSensorDisplay

==属性==

属性名类型可读写信号通知描述
StatusString只读变更广播传感器当前状态:Enabled:传感器使能;Disabled:传感器禁用;InTest:传感器测试中;Starting:传感器更新中
HealthString只读变更广播传感器健康状态:Critical:紧急;Major:严重;Minor:一般;OK:正常
AssertStatusU16只读变更广播传感器SEL事件状态,bit0 - bit14依次对应15种offset的离散事件状态,1:Assert;0:Deassert

bmc.kepler.Systems.DiskCoolingConfig

==属性==

属性名类型可读写信号通知描述
DiskRowTemperatureAvailableBoolean只读变更广播背板上硬盘温度是否能正常获取
SysHDDsMaxTemperatureDouble只读变更广播HDD硬盘最大温度, 单位:摄氏度
SysSSDsMaxTemperatureDouble只读变更广播SSD硬盘最大温度(仅SAS/SATA), 单位:摄氏度
SysM2sMaxTemperatureDouble只读变更广播M.2硬盘最大温度, 单位:摄氏度
SysAllSSDsMaxTemperatureDouble只读变更广播所有SDD介质硬盘的最大温度, 单位:摄氏度
FrontNVMeSSDMaxTemperatureCelsiusDouble只读变更广播前置nvme盘最大温度,单位:摄氏度
FrontHddMaxTemperatureCelsiusDouble只读变更广播前置hdd盘最大温度,单位:摄氏度
RearNVMeSSDMaxTemperatureCelsiusDouble只读变更广播后置nvme盘最大温度,单位:摄氏度
RearHddMaxTemperatureCelsiusDouble只读变更广播后置hdd盘最大温度,单位:摄氏度

bmc.kepler.Systems.EnergyEfficiencyOptimization

==属性==

属性名类型可读写信号通知描述
ModeString读写变更广播智能节能模式
BusinessLoadString读写变更广播业务负载

==方法==


SetConfiguration

保存节能配置

参数

  • BusinessLoad: String - 业务负载
  • Configuration: String - 节能配置

bmc.kepler.Systems.EnergyMetric

==属性==

属性名类型可读写信号通知描述
SystemPowerU32只读变更广播系统总输入功率(单位W)
SystemOutputPowerU32只读变更广播系统总输出功率(单位W)
HighPowerThresholdWattsDouble只读变更广播电源功率过高告警门限
PowerConsumptionDouble只读变更广播累计耗电量(单位Kw*h)
MaxConsumedWattsU32只读变更广播峰值功率(系统最大功率,单位W)
MaxConsumedOccurredTimeU32只读变更广播峰值功率出现时间(时间戳),单位:秒
MinConsumedWattsU32只读变更广播系统最小功率(单位W)
StatisticsCollectedTimeU32只读变更广播开始统计时间(时间戳),单位:秒
AverageConsumedWattsU32只读变更广播系统平均功率(单位W)
HeatKcalU32只读变更广播系统电源消耗热量(单位Kcal)
EnergySavedPercentU8只读变更广播省电百分比
EnergySavedKwhDouble只读变更广播省电总量KWh
CarbonEmissionsReducedKgDouble只读变更广播减少碳排量(单位千克)
FanTotalPowerWattsU32只读变更广播风扇总功耗(单位瓦特)
PredictedPowerSavedKwhDouble只读变更广播开启节能功能后预计节省功耗
PredictedPowerSavedPercentDouble只读变更广播开启节能功能后预计节省功耗百分比
TotalPowerSavedKwhDouble只读变更广播累计节省功耗
TotalPowerSavedPercentDouble只读变更广播累计节省功耗百分比
PowerPredictStatusU8只读变更广播功耗预测模型状态
PowerPredictDescriptionString只读变更广播功耗预测工作状态描述
HistoryPowerAverageWattsU32只读变更广播节能特性开启前平均功率
MinPowerWattsU32只读变更广播服务器的最小功耗
MaxPowerWattsU32只读变更广播服务器的最大功耗

==方法==


PowerResetStatistics

重置功耗统计数据


CollectPowerHistoryData

收集历史功率数据

参数

  • FilePath: String - 文件导出路径
  • Domain: String - 数据域
  • DomainId: U32 - 域Id

返回值

  • TaskId: U32 - 任务Id

ResetPowerHistoryData

清空历史功率数据

参数

  • Domain: String - 数据域
  • DomainId: U32 - 域Id

GetPowerHistoryData

获取历史功耗统计数据

参数

  • Domain: String - 数据域
  • DomainId: U32 - 域Id

返回值

  • PowerHistoryData: Array - 收集历史功耗数据

SetHighPowerThresholdWatts

设置功耗告警阈值

参数

  • HighPowerThresholdWatts: Double - 功耗告警阈值

GetPredictedPowerData

获取功耗预测数据

返回值

  • PredictedPowerData: Array - 预测的未来整机功耗

GetPredictedPowerSavedData

获取节能收益预测数据

返回值

  • PredictedPowerSavedData: Array - 开启节能功能后模型预测的未来整机功耗

==自定义类型==


PowerHistoryDataItem: 结构体类型

  • Time: String - 统计时间
  • PowerWatts: U32 - 系统功率
  • PowerAverageWatts: U32 - 系统平均功率
  • PowerPeakWatts: U32 - 系统峰值功率

PredictedPowerDataItem: 结构体类型

  • Time: String - 预测时间
  • PredictedPowerWatts: U32 - 预测时间的整机功耗

PredictedPowerSavedDataItem: 结构体类型

  • Time: String - 预测时间
  • PredictedPowerSavedWatts: U32 - 开启节能功能后模型预测的未来整机功耗

bmc.kepler.Systems.Entity

==属性==

属性名类型可读写信号通知描述
IdU8只读变更广播Entity Id,IPMI 规范 43.14
InstanceU8只读变更广播Entity Instance,IPMI 规范 43.1中描述Instance配置,默认值 96
SlotU8只读变更广播Entity所在的槽位号,默认 255
NameString只读变更广播Entity的名称
PowerStateU8只读变更广播Entity的上下电状态,关联对应的上下电信号来源
PresenceU8只读变更广播Entity的在位状态,关联对应的在位信号来源
HealthU8只读变更广播Entity的健康状态,不需要配置,默认值 0

bmc.kepler.Systems.EventSummary

==属性==

属性名类型可读写信号通知描述
MinorCountU32只读变更广播当前system的一般事件的汇总数量
MajorCountU32只读变更广播当前system的严重事件的汇总数量
CriticalCountU32只读变更广播当前system的紧急事件的汇总数量

bmc.kepler.Systems.Events

==属性==

属性名类型可读写信号通知描述
HealthString只读变更广播系统健康状态,取值有0:Normal,1:Minor,2:Major,3:Critical
EventRecordSeqU64只读变更广播事件记录标识,随着事件产生递增
CriticalCountU32只读变更广播致命告警数量
MajorCountU32只读变更广播严重告警数量
MinorCountU32只读变更广播一般告警数量
VersionString只读变更广播当前事件配置的版本
CurEventCountU32只读变更广播当前事件数量
MaxEventCountU32只读变更广播最大事件数量
DumpRecordU64只读变更广播SEL日志转储的总量,每次转储均会累加
MajorVersionString只读变更广播告警语言配置的主版本
MinorVersionString只读变更广播告警语言配置的次要版本
AuxVersionString只读变更广播告警语言配置的辅助版本
EventModeU8读写变更广播事件的记录模式,0: 默认模式,记录达到最大数量后转储; 1: 记录达到最大数量后环形记录

==方法==


MockEvent

事件模拟接口

参数

  • EventCode: String - 事件码
  • Enabled: U8 - 模拟状态标识,1:开启模拟,0:关闭模拟
  • ObjectIndex: U16 - 事件下标
  • MockState: U8 - 事件状态,1:生成告警,0:恢复告警

GetAlarmList

查询当前告警接口

参数

  • StartId: U16 - 事件索引
  • Count: U16 - 事件条数
  • QueryParameters: Array - 带查询参数列表

返回值

  • Total: U16 - 事件总条数
  • EventList: Array - 事件详细信息列表

GetEventList

查询历史事件接口

参数

  • StartId: U16 - 事件索引
  • Count: U16 - 事件条数
  • QueryParameters: Array - 可选参数包括:1.语言(en:英文 zh:中文 默认英文)2.SelLevel日志级别(Informational/Minor/Major/Critical)3.SelObjectType主体类型4.SelBeginTime开始事件戳(yyyy-MM-dd HH:mm:ss)5.SelEndTime结束时间戳6.SelSearchString关键字,用于模糊匹配事件描述、事件码,ASCII范围(0x20~0x7E),长度0~20字符

返回值

  • Total: U16 - 事件总条数
  • EventList: Array - 事件详细信息列表

ClearEventList

清除全部事件


GetEventInfo

查询系统信息

返回值

  • Version: String - 事件配置版本
  • CurEventCount: U16 - 当前事件数量
  • MaxEventCount: U16 - 最大事件数量

MaskEvent

屏蔽事件接口

参数

  • EventCode: String - 事件码
  • MaskState: U8 - 屏蔽状态, 0:开启屏蔽 1:关闭屏蔽
  • Mode: U8 - 屏蔽模式, 1:NONE,不保存屏蔽状态,重启失效 2:RESET,重启后保持屏蔽 3:AC后保持屏蔽

GetMaskedEventList

查询屏蔽事件列表

返回值

  • MaskedEventList: Array - 屏蔽事件列表信息

AddEvent

添加软件事件接口

参数

  • EventInfo: Array - 必选参数:(ComponentName:事件主体名称 State:事件状态 EventKeyId:事件标识 EventName:事件名称 MessageArgs:动态参数列表 SystemId:事件归属的SystemId ManagerId:事件归属的ManagerId ChassisId:事件归属的ChassisId NodeId:事件对应的对象) 可选参数:(SubjectType:事件主体类型)

返回值

  • RecordId: String - 添加事件的记录标识

ExportEvent

导出历史事件记录

参数

  • Path: String - 导出历史事件的路径

返回值

  • TaskId: U32 - Task标识, 用于拼接任务路径

CheckEventName

校验Eventname集合

参数

  • EventName: String[] - 需要校验的EventName列表

返回值

  • Result: Boolean[] - 校验的结果列表

SetAlarmName

定制告警名称

参数

  • AlarmName: String - 定制的告警名称

SetEventSeverity

设置事件的严重等级

参数

  • EventCode: String - 告警码
  • Severity: U8 - 设置的告警级别(0:Normal 1:Minor 2:Major 3:Critical)

SetEventAction

设置事件产生后的动作

参数

  • EventKeyId: String - 告警定义
  • Action: U8 - 设置的事件动作(0:无动作 1:下电0S 2:复位OS 3:下电后上电)

AddSel

动态添加oem的sel生成对应的event

参数

  • EventInfo: Array - 必选参数:(EventCode:事件码 State:事件状态 Severity:事件严重等级 Description:事件描述 OldEventCode:旧事件码)等

GetAlarmSpecifiedFields

查询当前所有告警的指定字段内容

参数

  • EventFieldName: String - 待查询的字段名称。当前暂仅支持LedFaultCode

返回值

  • EventFieldValues: String[] - 当前所有告警的指定字段内容列表

==自定义类型==


EventInfo: 结构体类型

  • MappingTable: Array - 事件信息键值表,键的值包括:严重程度,事件关联的组件名称,事件状态,事件码,事件产生时间戳,事件描述,事件建议,事件原因,事件影响,事件动作,事件策略标识,事件上报通道掩码,事件触发模式,led显示故障码,旧事件码,事件主体类型,事件名称,事件动态参数,事件归属的SystemId,事件归属的ManagerId,事件归属的ChassisId,事件对应的对象

KeyValueTable: 结构体类型

  • Key: String
  • Value: String

MaskedEventInfo: 结构体类型

  • EventCode: String - 被屏蔽事件的事件码
  • EventName: String - 被屏蔽事件的事件标识

bmc.kepler.Systems.ExceptionInfo

==属性==

属性名类型可读写信号通知描述
CaterrDiagnoseResultU8只读变更广播根据CATERR诊断结果触发对应事件,取值:0-无结果,默认值;1-Host侧Caterr诊断失败;2-Host侧Caterr诊断成功
LocalSystemIdU8只读变更广播故障所在系统的物理编号,主系统编号0,同一个主系统内的子系统依次编号,从1开始
DumpProcessorLogResultU8只读变更广播上一次宕机收集结果,取值:0-未收集,1-收集成功,2-收集失败,默认值0。系统上下电/复位时,属性恢复默认值0。

==方法==


DumpProcessorLog

宕机收集方法,支持导出宕机寄存器信息,导出的信息文件储存在/tmp目录下

参数

  • LogType: String - 宕机收集支持的类型,当前只支持DFX,表示全量寄存器收集;预留扩展RAS、ALL:RAS表示RAS寄存器收集,ALL表示进行RAS、DFX两种类型收集
  • Path: String - 宕机收集的文件路径,可缺省,缺省情况下目录是/tmp;指定目录时,仅支持指定/tmp

返回值

  • TaskId: U32 - 宕机收集任务的Id号,全局唯一

bmc.kepler.Systems.FDMDomain.CPURAS

==属性==

属性名类型可读写信号通知描述
SystemIdU8只读变更广播CPU所在的os系统编号,从1开始,单系统默认为1
LogicalIdU8只读变更广播CPU逻辑编号,从1开始
BISTFailedU8只读变更广播CPU内建自检失败标记位,取值:0表示正常,1表示自检失败
CorrectableErrorU8只读变更广播CPU关键模块发生可纠正错误的标记位,取值:0-未发生可纠正错误,1-已发生可纠正错误
UncorrectableErrorU8只读变更广播CPU关键模块发生不可纠正错误的标记位,取值:0-未发生不可纠正错误,1-已发生不可纠正错误
IsolatedU8只读变更广播表示CPU的故障隔离状态,取值:0表示未进行隔离,1表示故障已被隔离
CoreIsolatedU8只读变更广播表示CPU故障核的隔离状态,取值:0表示未进行隔离,1表示故障已被隔离
IsolatedCoreIdString只读变更广播表示被隔离的CPU故障核的CPU编号,当前暂无业务承载
IsolatedCoreCountU8只读变更广播表示被隔离的core数量,默认值:0
ConfigErrorTypeU8只读变更广播表示CPU产生配置错误的错误类型,为枚举值,对应实际含义在csr中定义
ConfigErrorCodeString只读变更广播表示CPU产生配置错误时,错误类型下细分的具体错误码,为十六进制字符串格式
ModelMismatchedU8只读变更广播表示CPU型号不匹配的标记位,取值:0-正常,1-不匹配
FirmwareMismatchedU8只读变更广播表示CPU固件不匹配的标记位,取值:0-正常,1-不匹配
InterConnectionLaneFaultU8只读变更广播表示CPU互联总线(HCCS)故障状况的标记位,暂时无业务承载
InterConnectionLaneErrorMaskU8只读变更广播表示CPU互联总线(HCCS)故障Lane编号/位图,举例:bit0:Lane0;bit1:Lane1,以此类推。其中每个bit值为0表示正常,1表示异常
CacheWayErrorMaskU8只读变更广播表示CacheWay异常状态,bit位:0表示L1,1表示L2,2表示L3,其中每个bit值为0表示正常,1表示异常
CurrentPeriodCacheUncorrectableECCErrorCountU32只读变更广播统计CPU Cache模块运行周期内发生的不可纠正错误次数,取值范围:0~0xFFFFFFFF。系统上下电/复位/更换部件时,统计次数清零。
LifeTimeCacheUncorrectableECCErrorCountU32只读变更广播统计CPU Cache模块生命周期内发生的不可纠正错误次数,取值范围:0~0xFFFFFFFF。更换部件时,统计次数清零。
CorrectableErrorOverfrequencyCountU32只读变更广播系统运行周期内,CPU CE故障发生频率超门限的次数。取值范围:0~0xFFFFFFFF,默认值0。系统上下电/复位时,统计次数清零。
UBLinkFaultBitMapU64只读变更广播CPU出现灵衢总线连接故障的端口位图。bit0对应芯片UB端口0,以此类推。其中0表示正常,1表示异常。示例:5表示UB端口0、UB端口2异常

==方法==


ClearCurrentPeriodMetrics

清零该资源下当前周期的度量统计数据,如CurrentPeriodCacheUncorrectableECCErrorCount


bmc.kepler.Systems.FDMDomain.MemoryOnChipRAS

==属性==

属性名类型可读写信号通知描述
CorrectableECCU8只读变更广播MemoryOnChip发生可纠正错误,取值:0-未发生,1-发生,初始为0
UncorrectableECCU8只读变更广播MemoryOnChip发生不可纠正错误发生,取值:0-未发生,1-发生,初始为0
ScrubingUncorrectableECCU8只读变更广播MemoryOnChip发生巡检UCE错误,取值:0-未发生,1-发生,初始为0
ParityErrorU8只读变更广播MemoryOnChip发生奇偶校验错误,取值:0-未发生,1-发生,初始为0
CorrectableECCStormU8只读变更广播MemoryOnChip发生CE风暴错误,取值:0-未发生,1-发生,初始为0
CorrectableECCOverflowU8只读变更广播MemoryOnChip发生CE漏斗溢出错误,取值:0-未发生,1-发生,初始为0
IsolationStatusU8只读变更广播内存隔离自愈执行状态,取值范围:0(未执行隔离)、1(已成功执行隔离)、其他(预留), 初始为0,系统上下电/复位时,恢复到未执行隔离状态。

bmc.kepler.Systems.FDMDomain.MemoryRAS

==属性==

属性名类型可读写信号通知描述
SystemIdU8只读变更广播内存所归属的os系统编号,从1开始,单系统默认为1
NameString只读变更广播内存的命名,每个系统内唯一
LogicalCpuIdU8只读变更广播内存所属的CPU编号,从0开始
LogicalChannelIdU8只读变更广播内存所属逻辑通道编号,从0开始
DimmIdU8只读变更广播内存对应Dimm条id,从0开始
PredictiveFaultU8只读变更广播内存预故障标记位,取值0表示正常,1表示异常,初始值为0
ConfigErrorTypeU8只读变更广播表示内存产生配置错误的错误类型,为枚举值,对应实际含义在csr中定义
ConfigErrorCodeString只读变更广播表示内存产生配置错误时,错误类型下细分的具体错误码,为十六进制字符串格式
ScrubingUncorrectableECCU8只读变更广播内存发生巡检UCE错误,取值:0-未发生,1-发生,初始为0
ParityErrorU8只读变更广播内存发生奇偶校验错误,取值:0-未发生,1-发生,初始为0
UncorrectableECCErrorU8只读变更广播内存发生不可纠正错误,取值:0-未发生,1-已发生,初始为0
CorrectableECCErrorU8只读变更广播内存多次发生可纠正错误,导致CE统计超门限。取值:0-发生的可纠正错误未超门限,1-发生的可纠正错误已超门限
CorrectableECCU8只读变更广播内存发生可纠正错误,取值:0-未发生可纠正错误,1-发生可纠正错误
PoorContactFaultU8只读变更广播内存发生接触类故障,取值:0表示无故障,1表示有故障
LastPredictTimeU32只读变更广播上一次内存故障预测诊断时间,数据类型为Unix时间戳
HealthScoreU8只读变更广播内存健康分数,取值范围1-100
LastIsolationTypeU8只读变更广播上一次内存隔离类型,取值:0xFF-未隔离,0x00-ACLS,0x01-SPPR,0x02-HPPR,0x03-ADDDC,0x04-SDDC,0x05-RankSparing,0x06-PageOffline,默认值0xFF。系统上下电/复位时,属性恢复默认值0xFF。
LastIsolationStatusU8只读变更广播上一次内存隔离状态,取值:0表示未发生内存隔离,1表示内存隔离成功,2表示内存隔离失败
ErrorStormCountU32只读变更广播内存条的错误风暴次数(含CE、UCE等),更换内存条时会清零
CorrectableECCStormU8只读变更广播内存发生CE风暴, 取值: 0-未发生,1-非定制规则下发生CE风暴,其他-定制规则下发生CE风暴
CorrectableECCOverflowU8只读变更广播内存发生CE漏斗溢出,取值:0-未发生溢出,其他-发生溢出
CurrentPeriodUncorrectableECCErrorCountU32只读变更广播统计内存运行周期内发生的不可纠正错误次数,取值范围:0~0xFFFFFFFF。系统上下电/复位/更换部件时,统计次数清零。
LifeTimeUncorrectableECCErrorCountU32只读变更广播统计内存生命周期内发生的不可纠正错误次数,取值范围:0~0xFFFFFFFF。更换部件时,统计次数清零。
CorrectableECCStormBurstCountU32只读变更广播统计内存发生超级CE风暴的次数,取值范围:0~0xFFFFFFFF。系统下电/复位时,统计次数清零。
DataPoisonedU8只读变更广播内存检测到Data Poisoning。从0到1表示故障事件发生,从1到0不表示故障事件恢复。
CorrectableECCOverfrequencyCountU32只读变更广播系统运行期间,内存CE故障发生频率超门限的次数。取值范围:0~0xFFFFFFFF。系统上下电/复位时,统计次数清零。

==方法==


ClearCurrentPeriodMetrics

清零该资源下当前周期的度量统计数据,如CurrentPeriodUncorrectableECCErrorCount


bmc.kepler.Systems.FDMDomain.NPURAS

==属性==

属性名类型可读写信号通知描述
CarrierBoardIdU8只读变更广播系统内,当前PU所在的载板编号,从1开始
NPUIndexU8只读变更广播载板内,当前实体NPU的编号,从1开始
DieIndexU8只读变更广播NPU内,当前die的编号,从0开始
PredictiveFaultU8只读变更广播NPU硬件预故障标志位,默认值0,异常状况置1,初始为0
DiagnosticFaultU8只读变更广播NPU硬件故障诊断的标志位,默认值0,异常状况置1
InterConnectionLaneErrorBitmapU32只读变更广播NPU互联总线(HCCS)故障macro编号/位图,bit0对应macro0,以此类推。其中0表示正常,1表示异常。示例:5表示macro0、macro2异常
UBLinkFaultBitMapU64只读变更广播NPU出现灵衢总线连接故障的端口位图。bit0对应芯片UB端口0,以此类推。其中0表示正常,1表示异常。示例:5表示UB端口0、UB端口2异常
CorrectableErrorU8只读变更广播NPU发生不可纠正错误,取值:0-未发生,1-发生,初始为0。系统上下电/系统复位/NPU复位,恢复为0。
UncorrectableErrorU8只读变更广播NPU发生不可纠正错误,取值:0-未发生,1-发生,初始为0。系统上下电/系统复位/NPU复位,恢复为0。
CurrentPeriodCacheUncorrectableECCErrorCountU32只读变更广播统计NPU Cache模块运行周期内发生的不可纠正错误次数,取值范围:0~0xFFFFFFFF。系统上下电/系统复位/NPU复位,统计次数清零。
LifeTimeCacheUncorrectableECCErrorCountU32只读变更广播统计NPU Cache模块生命周期内发生的不可纠正错误次数,取值范围:0~0xFFFFFFFF。更换NPU部件时,统计次数清零。

bmc.kepler.Systems.FDMDomain.PCIeRASCollector

==属性==

属性名类型可读写信号通知描述
CorrectableErrorU8只读变更广播PCIe设备发生可纠正错误,取值:0-未发生,1-发生,初始为0
UncorrectableErrorU8只读变更广播PCIe设备发生不可纠正错误,取值:0-未发生,1-发生,初始为0
FatalErrorU8只读变更广播PCIe设备发生致命错误,取值:0-未发生,1-发生,初始为0
ParityErrorU8只读变更广播PCIe设备发生奇偶校验错误,取值:0-未发生,1-发生,初始为0
SystemErrorU8只读变更广播PCIe设备发生系统错误,取值:0-未发生,1-发生,初始为0
BandwidthReductionU8只读变更广播PCIe降带宽检事件的上报属性,初始为0
LinkSpeedReducedU8只读变更广播PCIe设备降速率检测告警上报事件属性,初始为0
CorrectableErrorOverfrequencyU8只读变更广播PCIe设备CE故障发生频率超门限。取值:0-未发生,1-发生,默认值0。系统上下电/复位时,属性恢复默认值0。下一次出现故障时先恢复为0后置为1。
TimeoutErrorU8只读变更广播PCIe设备发生超时错误,取值: 0-未发生,1-发生,默认值0。系统上下电/复位时,属性恢复默认值0。下一次出现故障时先恢复为0后置为1。
DevSegmentU8只读变更广播PCIe设备的root port Segment,默认值:255。发生错误的PCIe设备Segment号,随错误上报赋值。
DevBusU8只读变更广播事件对应PCIe设备的Bus
DevDeviceU8只读变更广播PCIe设备的root port Bus,默认值:255。发生错误的PCIe设备Bus号,随错误上报赋值。
DevFunctionU8只读变更广播PCIe设备的root port Function,默认值:255。发生错误的PCIe设备Function号,随错误上报赋值。
RootBDFU32只读变更广播发生错误的PCIe设备的RootBDF号,bit[24:31]作为预留,bit[16:23]表示root Bus号,bit[8:15]表示root Device,bit[0:7]表示root Function,随错误上报赋值。系统上下电/系统复位,恢复默认值0xFFFFFFFF。
DeviceBDFU32只读变更广播发生错误的PCIe设备的DeviceBDF号,bit[24:31]作为预留,bit[16:23]表示device Bus号,bit[8:15]表示device Device,bit[0:7]表示device Function,随错误上报赋值。系统上下电/系统复位,恢复默认值0xFFFFFFFF。

bmc.kepler.Systems.FDMDomain.SystemRAS

==属性==

属性名类型可读写信号通知描述
SystemIdU8只读变更广播os系统编号,从1开始,单系统默认为1
NoMemoryDetectedInPOSTU8只读变更广播故障标志位,表示POST阶段检测不到内存,取值0表示正常,1表示异常,初始值为0
MemoryConfigErrorTypeU8只读变更广播系统内存配置错误类型,通过枚举值表示,枚举值对应具体错误含义在csr中定义
MemoryConfigErrorCodeString只读变更广播系统内存配置错误类型中,细分的具体错误码,为十六进制字符串格式

bmc.kepler.Systems.FDMDomain.UnknownPCIeRASCollector

==属性==

属性名类型可读写信号通知描述
CorrectableErrorU8只读变更广播PCIe设备发生可纠正错误,取值: 0-未发生,1-发生,默认值0。
CorrectableErrorStormU8只读变更广播PCIe设备发生可纠正错误风暴,取值: 0-未发生,1-发生,默认值0。
UncorrectableErrorU8只读变更广播PCIe设备发生不可纠正错误,取值: 0-未发生,1-发生,默认值0。
FatalErrorU8只读变更广播PCIe设备发生致命错误,取值: 0-未发生,1-发生,默认值0。
ParityErrorU8只读变更广播PCIe设备发生奇偶校验错误,取值: 0-未发生,1-发生,默认值0。
SystemErrorU8只读变更广播PCIe设备发生系统错误,取值: 0-未发生,1-发生,默认值0。
BandwidthReductionU8只读变更广播PCIe设备发生降带宽事件,取值: 0-未发生,1-发生,默认值0。
LinkSpeedReducedU8只读变更广播PCIe设备发生降速率事件,取值: 0-未发生,1-发生,默认值0。
CorrectableErrorOverfrequencyU8只读变更广播未知PCIe设备CE故障发生频率超门限。取值: 0-未发生,1-发生,默认值0。系统上下电/复位时,属性恢复默认值0。下一次出现故障时先恢复为0后置为1。
TimeoutErrorU8只读变更广播未知PCIe设备发生超时错误,取值: 0-未发生,1-发生,默认值0。系统上下电/复位时,属性恢复默认值0。下一次出现故障时先恢复为0后置为1。
DevSegmentU8只读变更广播PCIe设备的root port Segment,默认值:255。发生错误的PCIe设备Segment号,随错误上报赋值。
DevBusU8只读变更广播PCIe设备的root port Bus,默认值:255。发生错误的PCIe设备Bus号,随错误上报赋值。
DevDeviceU8只读变更广播PCIe设备的root port Device,默认值:255。发生错误的PCIe设备Device号,随错误上报赋值。
DevFunctionU8只读变更广播PCIe设备的root port Function,默认值:255。发生错误的PCIe设备Function号,随错误上报赋值。
RootBDFU32只读变更广播发生错误的PCIe设备的RootBDF号,bit[24:31]作为预留,bit[16:23]表示root Bus号,bit[8:15]表示root Device,bit[0:7]表示root Function,随错误上报赋值。系统上下电/系统复位,恢复默认值0xFFFFFFFF。
DeviceBDFU32只读变更广播发生错误的PCIe设备的DeviceBDF号,bit[24:31]作为预留,bit[16:23]表示device Bus号,bit[8:15]表示device Device,bit[0:7]表示device Function,随错误上报赋值。系统上下电/系统复位,恢复默认值0xFFFFFFFF。

bmc.kepler.Systems.FDMService

==属性==

属性名类型可读写信号通知描述
UnknownCaterrPolicyString读写变更广播FDM CATERR诊断失败处理策略。NoAction:不做任何处理;Reset:热复位;PowerOff:下电
IdentifiedCaterrPolicyString读写变更广播FDM CATERR诊断成功后处理策略。NoAction:不做任何处理;Reset:诊断成功后执行热复位;csr未配置时默认NoAction
MemFaultIsolationModeString读写变更广播内存隔离容错操作模式,取值SelfDecision表示BMC自决策模式(BMC直接自动控制RAS容错策略执行);InterAction表示联动模,(BMC进行模式识别,容错策略执行由第三方(refish接口)控制)
MemPoorContactAlarmEnabledBoolean读写变更广播内存DQ线接触不良告警功能使能状态,true表示功能使能,false表示未使能
MemFaultIsolationEnabledBoolean只读变更广播内存故障隔离功能总开关状态,仅有总开关开启时,其他隔离功能才能生效
MemPageOfflineEnabledBoolean读写变更广播内存页隔离(PageOffline)容错功能使能状态,true表示功能使能,false表示未使能
MemADDDCEnabledBoolean读写变更广播内存自适应双设备数据校正(Adaptive Double DRAM Device Correction, ADDDC)容错功能使能状态,true表示功能使能,false表示未使能
MemSoftPPREnabledBoolean读写变更广播内存软后包修复(soft post package repair, sPPR)容错功能使能状态,true表示功能使能,false表示未使能
MemHardPPREnabledBoolean读写变更广播内存硬后包修复(hard post package repair, hPPR)容错功能使能状态,true表示功能使能,false表示未使能
MemACLSEnabledBoolean读写变更广播内存单比特纠错算法(ACLS)容错功能使能状态,true表示功能使能,false表示未使能
MemRowSparingEnabledBoolean读写变更广播内存Row Sparing容错功能使能状态,true表示功能使能,false表示未使能;csr未配置时功能默认打开
MaxMemPageOfflineCountU32读写变更广播PageOffline容错能力上限值
MemHardFailureDetectionModeString读写变更广播内存硬失效模式识别方式。PatrolScrub:巡检识别硬失效模式;ExpertRule:规则识别硬失效模式
MemFaultPredictionEnabledBoolean读写变更广播内存故障预测功能使能状态,true表示功能使能,false表示未使能
MemFaultPredictionModeString读写变更广播内存故障预测模式, ExpertRule(专家规则模式)
HbmFPCEnabledBoolean读写变更广播CPU HBM内存故障隔离功能总开关,仅有总开关开启时,其他隔离功能才能生效
HbmACLSEnabledBoolean读写变更广播CPU HBM内存单比特纠错算法(ACLS)容错功能使能状态,true表示功能使能,false表示未使能
HbmSoftPPREnabledBoolean读写变更广播CPU HBM内存软后包修复(soft post package repair, sPPR)容错功能使能状态,true表示功能使能,false表示未使能
MemPatrolScrubAlarmEnabledBoolean读写变更广播内存巡检不可纠正错误(PS UCE)告警功能开关,true表示功能使能,false表示未使能
MemDynamicRemappingEnabledBoolean读写变更广播DDR4内存动态重映射开关,true表示功能使能,false表示未使能
MemCEStormDetectionModeU8读写变更广播表示内存CE风暴告警检测模式,0:覆盖率优先,1:准确率优先
CacheWayFPCEnabledBoolean读写变更广播L3 Cache故障预测及隔离功能开关 默认值: true
CoreIsolationAlarmThresholdU8读写变更广播core隔离告警门限,已隔离core数量大于等于门限值时产生告警,默认值:1,即1个core隔离就告警

==方法==


SetMemFaultIsolationEnabled

设置内存故障隔离总开关状态

参数

  • Status: Boolean - 内存故障隔离总开关状态,true表示开关打开,false表示开关关闭

GetFPCMemoryRecords

返回所有内存条基础信息、隔离状态与健康分值

返回值

  • FPCMemoryRecords: Array - 内存条信息,包括内存条基础信息、隔离状态与健康分值

GetPendingMemIsolation

获取联动模式下,一次上电期间,所有内存待隔离的颗粒信息

返回值

  • PendingList: Array - 一次上电期间所有内存待隔离的颗粒信息

ExecuteMemIsolation

联动模式下,根据待隔离记录中的Id,执行隔离操作

参数

  • SequenceNumList: U32[] - 需要执行的内存隔离记录的id集合,对应IsolationItem结构中SequenceNum字段

返回值

  • TaskId: U32 - 执行隔离操作时,创建的任务编号

ExecuteScrubbing

CPU侧内存巡检压测

参数

  • SystemId: U32 - 系统编号。
  • AddressType: String - 地址类型。
  • Address: String - 巡检地址。

返回值

  • TaskId: U32 - 执行CPU侧内存巡检压测,创建的任务编号。

==自定义类型==


FPCMemoryItem: 结构体类型

  • SystemId: String - 表示os系统编号,单系统默认为1
  • TimeStamp: U32 - 最近一次内存产生故障的时间,格式为unix时间戳
  • TimeZone: S32 - 最近一次内存产生故障的时区
  • Socket: U8 - 最近一次内存产生故障对应的CPU编号
  • Channel: U8 - 最近一次内存产生故障的所在的通道ID
  • Slot: U8 - 最近一次内存产生故障所在的DIMM ID
  • DeviceLocator: String - 最近一次内存产生故障的内存名称
  • SerialNumber: String - 最近一次内存产生故障的SN号
  • HealthScore: U8 - 最近一次内存产生故障时的健康分数
  • IsolationStatus: U8 - 最近一次内存产生故障的隔离状态

IsolationItem: 结构体类型

  • SystemId: String - 表示os系统编号,单系统默认为1
  • SequenceNum: U32 - 预隔离记录id(一次上电期间,隔离记录的唯一标识符)
  • TimeStamp: U64 - 识别故障颗粒的时间,格式为unix时间戳
  • ExecutionStatus: U8 - 故障颗粒的隔离执行状态,取值:0-待执行,1-已执行,2-执行失败
  • FailureMode: String - 内存的故障失效模式,包括Cell、Row、Column、Bank等
  • AddressInfo: String - 待隔离内存颗粒地址信息,用Json字符串格式表示

bmc.kepler.Systems.Fan

==属性==

属性名类型可读写信号通知描述
FanIdU16只读变更广播风扇ID
SlotU8只读变更广播风扇槽位
TypeU8只读变更广播风扇类型
ModelString只读变更广播风扇型号
CoefficientU8只读变更广播风扇转速系数
FanHealthU8只读变更广播风扇健康状态, 0: 健康, 1:不健康
FanEntityString只读变更广播风扇实体
FrontPresenceU8读写变更广播前转子在位状态, 1: 在位, 0:不在位
RearPresenceU8读写变更广播后转子在位状态, 1: 在位, 0:不在位
FrontSpeedU16读写变更广播前转子转速
RearSpeedU16读写变更广播后转子转速
FrontStatusU8只读变更广播前转子状态,0:正常,非0:异常
RearStatusU8只读变更广播后转子状态,0:正常,非0:异常
FrontRPMU16只读变更广播前转子转速,单位:转/分钟(r/min)
RearRPMU16只读变更广播后转子转速,单位:转/分钟(r/min)
HardwarePWMDouble读写变更广播硬件占空比
PWMPercentageU32只读变更广播占空比
ExpectedPWMDouble读写变更广播预期占空比
FanAlarmLedU8只读变更广播风扇告警
BOMString只读变更广播BOM编码
SystemIdU8只读变更广播系统Id
MaxSupportedPWMU32只读变更广播支持的最大转速
IdentifySpeedLevelU8只读变更广播识别风速级别
PartNumberString只读变更广播部件编码
FrontMaxSpeedU32只读变更广播前转子最大转速
RearMaxSpeedU32只读变更广播后转子最大转速
IsTwinsBoolean只读变更广播是否为双转子, true:为单转子,false:为双转子
PositionString只读变更广播容器信息,表示风扇所在的风扇板
SpeedStableBoolean只读变更广播风扇转速是否稳定(true:稳定,false:不稳定),期望转速与实际转速比相差25%以内为稳定
FunctionDescString只读变更广播功能描述
DeviceNameString只读变更广播部件名称

==方法==


SetFanPWM

设置风扇转速

参数

  • PWM: Double - 风扇转速占空比

返回值

  • Result: U8 - 返回结果,0:设置成功;1:设置失败

bmc.kepler.Systems.FanSnapshot

==方法==


GetActivatedPolicyFactors

获取已激活的风扇转速最高的调速策略因子

返回值

  • RetData: Struct - 返回的数据,数据内容包括:ValidFlag、ActivatedType、PWM和FactorName

==自定义类型==


FanSnapshot: 结构体类型

  • ValidFlag: Boolean - 表示Cooling组件是否有获取到风扇信息,true表示获取成功,false表示获取失败
  • ActivatedType: U8 - 策略激活类型,1表示触发异常调速,0表示无异常调速
  • PWM: U8 - 风扇转速百分比
  • FactorName: String - 当前转速生效的调速因子名称

bmc.kepler.Systems.FanType

==属性==

属性名类型可读写信号通知描述
NameString只读变更广播风扇型号名
IndexU8只读变更广播风扇型号索引
IsDefaultTypeBoolean只读变更广播是否为默认风扇型号
IsTwinsBoolean只读变更广播是否为双转子
FrontMaxSpeedU32只读变更广播前转子最大转速
RearMaxSpeedU32只读变更广播后转子最大转速
IdentifyRangeLowU32只读变更广播风扇型号识别转速左区间
IdentifyRangeHighU32只读变更广播风扇型号识别转速右区间
MatchedCountU8只读变更广播识别风扇数量
PartNumberString只读变更广播部件编码
BOMString只读变更广播BOM编码
SystemIdU8只读变更广播系统Id
SpeedRangeU8[]只读变更广播风扇转速和功率映射关系的风扇转速,数组长度至少为2,数组中的元素取值属于[0, 100]且递增
PowerRangeU16[]只读变更广播风扇转速和功率映射关系的功率数组,数组中的元素递增
FanDiameterMmU16只读变更广播风扇组件的直径,单位毫米

bmc.kepler.Systems.Fans

==属性==

属性名类型可读写信号通知描述
WorkInStandbyU8只读变更广播standby下风扇是否可以运转, 1:可以,0:不可以
EstimatedTotalPowerWattsU16只读变更广播估算的整机风扇总功耗

==方法==


SetPWM

设置所有风扇转速

参数

  • PWM: Double[] - 风扇转速占空比数组

返回值

  • Result: U8 - 返回结果,0:设置成功;1:设置失败

bmc.kepler.Systems.Fru

==属性==

属性名类型可读写信号通知描述
PcbIdU8只读变更广播PcbId, 需要关联到硬件, 从硬件读取Id
PcbVersionString只读变更广播PCB版本, 根据PcbId的值进行计算得出
FruIdU8只读变更广播FruId
FruNameString只读变更广播Fru名称
PowerStateU8只读变更广播Fru的热插拔状态
HealthU8只读变更广播健康状态
EepStatusU8只读变更广播EEPROM状态
GroupPositionString只读变更广播FRU的位置信息, 来自自发现的Position属性, 该属性用于确定FruId
TypeU8只读变更广播FRU类型,TYPE值请参照IPD Lite的BMC IPMI接口说明附录
FruDataIdString只读变更广播关联frudata对象名
BoardIdU16只读变更广播非天池:组件单板BoardID
UniqueIdString只读变更广播天池:组件唯一标识,Vendor + ComponentID
ConnectorGroupIdU32只读变更广播关联Connector传过来的GroupId

bmc.kepler.Systems.FruCtrl

==属性==

属性名类型可读写信号通知描述
PowerStateString只读变更广播反映实时电源状态
SysResetDetectedU8只读变更广播系统复位信号
FruTypeString只读变更广播上下电的Fru类型信息:host、NP加速卡、交换mesh卡
CurrentRestartCauseString只读变更广播用于记录业务系统本次复位原因
CurrentRestartCauseIdU8只读变更广播与CurrentRestartCause对应id
CurrentRestartTypeU8只读变更广播当前系统复位类型,取值0:Initiated by power up,1:Initiated by hard reset, 2:Initiated by warm reset
RestartCauseRecordsString[]只读变更广播用于记录业务系统历史复位原因,最多纪录10次
RestartCountU8只读变更广播用于纪记录业务系统复位次数
PowerOnStrategyString读写变更广播通电开机策略
PowerOnStrategyExceptionsU32读写变更广播殊通电开机策略,1为不执行此次通电开机策略,0为清除策略
LastResetTimeU64只读变更广播系统上一次复位或重启的日期和时间
PanelPowerButtonEnabledBoolean读写变更广播面板按钮使能true,不屏蔽为false
GracefulShutdownTimeoutEnabledU32读写变更广播安全下电时限使能开关
GracefulShutdownTimeoutSecondsU32读写变更广播安全下电超时时间,超时后执行强制下电
GracefulShutdownDefaultTimeoutSecondsU32只读变更广播安全下电默认超时时间,关联CSR
GracefulShutdownMaxTimeoutSecondsU32只读变更广播安全下电超时时间上限,关联CSR
GracefulShutdownMinTimeoutSecondsU32只读变更广播安全下电超时时间上限,关联CSR
HotswapStateString只读变更广播上下电流程中内部状态机流转产生,需要通知到事件
LastPowerEventU8只读变更广播仅对上电做事件记录复位持久化
PowerCtrlFaultU8只读变更广播判断上一次上电是否上电成功,或下电命令是否下电成功复位持久化
PowerCycleTypeU8只读变更广播0: 无power cycle任务;1: 有power cycle任务;2: 有force power cycle任务
PreviousPowerStateString只读变更广播表示上次通电状态 On: 上电状态;Off: 下电状态
ACCycleEnabledBoolean读写变更广播表示ACCycle功能是否使能 true:使能 false:未使能 默认为false

==方法==


PowerCtrl

上下电操作

参数

  • PowerCtrlType: String - 操作类型
  • RestartCause: String - 重启原因

返回值

  • CmdResult: S32 - 命令执行结果

SetPowerOnStrategyExceptions

配置例外通电开机策略

参数

  • Reason: String - 调用原因描述
  • Execute: String - 例外通电开机策略 Yes: 下次重启执行通电开机 No: 下次重启不执行通电开机策略 None:下次重启清除额外的通电开机策略
  • EffectivePeriod: String - 生效周期 Once:单次 Continuous:永久
  • Priority: U8 - 生效优先级 1-10 1:redfish(外部) 2:内部调用

返回值

  • CmdResult: U32 - 命令执行结果

SetACLost

通知fructrl组件发生整框掉电

参数

  • Type: U8 - 整框掉电类型, 1:powerdrop引起的AClost

返回值

  • CmdResult: U32 - 命令执行结果

FruPowerCtrl

根据FruID进行上下电操作

参数

  • PowerCtrlType: String - 操作类型 On:上电 ForceOff:强制下电 GracefulShutDown:安全下电 ForceRestart:强制重启 ForcePowerCycle:强制下电再上电 PowerCycle:安全下电再上电 ACCycle:整框掉电
  • RestartCause: String - 重启原因, 详见fructrl组件readme
  • FruID: U8 - FruID类型 0:计算域 4:交换域

返回值

  • CmdResult: S32 - 命令执行结果 0:表示执行成功 -1:表示执行失败

bmc.kepler.Systems.FruData.Board

==属性==

属性名类型可读写信号通知描述
MfgDateString只读变更广播生产日期
BoardManufacturerString只读变更广播单板生产厂商默认Huawei
BoardProductNameString只读变更广播单板产品名称
BoardSerialNumberString只读变更广播单板系列化编号
BoardPartNumberString只读变更广播单板部件号
BoardFRUFileIDString只读变更广播单板FRufileID
BoardCustomInfoString只读变更广播单板自定义信息

bmc.kepler.Systems.FruData.Chassis

==属性==

属性名类型可读写信号通知描述
ChassisTypeString只读变更广播关联的Chassis类型
ChassisPartNumberString只读变更广播关联的Chassis部件号
ChassisSerialNumberString只读变更广播关联的Chassis序列号
ChassisCustomInfoString只读变更广播关联的Chassis扩展域

bmc.kepler.Systems.FruData.Overview

==属性==

属性名类型可读写信号通知描述
FruIdU8只读变更广播关联所在的Fru的Fruid
FruTypeString只读变更广播关联所在的Fru的类型
FruNameString只读变更广播关联所在的Fru的名字
HealthU8只读变更广播FRU存储介质健康状态,取值如下: 0:读取正常 1:读取异常 255:未知

bmc.kepler.Systems.FruData.Product

==属性==

属性名类型可读写信号通知描述
ManufacturerNameString只读变更广播制造商名称
ProductNameString只读变更广播产品名,由整机测写入
ProductPartNumberString只读变更广播产品部件号
ProductVersionString只读变更广播产品网元类型/版本号,由产品软件定义
ProductSerialNumberString只读变更广播产品序列号
AssetTagString只读变更广播客户资产号,由客户定义
ProductFRUFileIDString只读变更广播产品fru编号
ProductCustomInfoString只读变更广播产品定制信息

bmc.kepler.Systems.FruData.System

==属性==

属性名类型可读写信号通知描述
SystemManufacturerString只读变更广播系统制造商
SystemProductNameString只读变更广播系统产品名称
SystemVersionString只读变更广播系统版本
SystemSerialNumberString只读变更广播系统序列号

bmc.kepler.Systems.Frus

bmc.kepler.Systems.GraphicalConsole

==属性==

属性名类型可读写信号通知描述
PersistentUSBConnectionEnabledBoolean读写变更广播虚拟键鼠是否支持连接
VideoEnabledBoolean只读变更广播录像使能
ScreenshotEnabledBoolean只读变更广播最后一屏使能
VideoAttributesArray只读变更广播录像文件信息
ScreenshotAttributesArray只读变更广播截屏文件信息
AutoOSLockEnabledBoolean读写变更广播系统自动锁定使能
AutoOSLockTypeString读写变更广播系统自动锁定方式,取值:Custom(自定义快捷键)、Windows(Windows默认锁定快捷键)
AutoOSLockKeyString[]读写变更广播系统自动锁定自定义快捷键
AutoScreenshotTriggersU32[]读写变更广播自动截屏触发类型,取值:0:PowerOff,1: OSReset,2:CatError
DisableKeyboardDuringBiosStartupBoolean读写变更广播BIOS启动过程中是否允许kvm键盘输入

==方法==


SetPersisUSBConnEnabled

设置虚拟键鼠是否支持连接

参数

  • Enabled: Boolean - 是/否

返回值

  • Result: S32 - 设置结果

CaptureScreenshot

手动截屏

参数

  • Mode: U8 - 手动截屏模式(是否唤醒屏幕)
  • DstPath: String - 目标路径

返回值

  • TaskId: U32 - 创建的任务标识

RemoveScreenshot

删除手动截屏


CreateVideoPlayToken

登录录像播放服务

参数

  • WebToken: String - Web端Token
  • VideoName: String - 录像名称

返回值

  • VideoPlayToken: String - 播放录像Token
  • VideoType: U8 - 录像类型

ExportVideo

导出录像文件

参数

  • VideoName: String - 录像名称
  • DstPath: String - 导出路径

返回值

  • TaskId: U32 - 创建的任务标识

ExportScreenshots

导出截图文件

参数

  • DstPath: String - 导出路径

返回值

  • TaskId: U32 - 创建的任务标识

EnableGraphicDisplay

使能图像通道


==自定义类型==


VideoItem: 结构体类型

  • VideoSizeByte: U32
  • CreateTime: String
  • VideoType: String

ScreenshotItem: 结构体类型

  • ScreenshotSizeByte: U32
  • CreateTime: String
  • ScreenshotType: String

bmc.kepler.Systems.HBM

==属性==

属性名类型可读写信号通知描述
LogicTemperatureCelsiusDouble只读变更广播HBM Logic区域温度
DRAMTemperatureCelsiusDouble只读变更广播HBM DRAM区域温度

bmc.kepler.Systems.HddBackplane

==属性==

属性名类型可读写信号通知描述
StartSlotU8只读变更广播指定硬盘起始槽位号
SlotCountU8只读变更广播指定硬盘背板的硬盘槽位数量

bmc.kepler.Systems.HistoryTemperature

==属性==

属性名类型可读写信号通知描述
TemperatureTypeU32只读变更广播温度类型 1:CPU, 2:出风口, 3:Disk, 4:Memory, 5:PCH, 6:VRD, 7:VDDQ, 8:NPUHbm, 9:NPUAiCore, 10:NPUBoard, 11:进风口, 12:SoCBoardOutlet, 13:SoCBoardInlet, 14:NPU, 15:DPU, 16:光模块, 0xFFFFFFFF:无效值(默认)
TemperatureNameString只读变更广播温度点名称

==方法==


GetData

获取温度点历史温度数据

返回值

  • RetData: Array - 返回的温度点历史温度数据

ClearData

清空温度点历史温度数据


==自定义类型==


TemperatureDataItem: 结构体类型

  • Time: String - 统计时间
  • InletTempCelsius: S32 - 温度值

bmc.kepler.Systems.IPMIEvent

==属性==

属性名类型可读写信号通知描述
SensorTypeU8只读变更广播IPMI 事件的传感器类型
ReadingTypeU8只读变更广播IPMI 事件的事件读值类型,复位持久化,事件类型来自于HOST侧上报
EventDataU32只读变更广播IPMI 事件的SEL数据,复位持久化,事件数据来自于HOST侧上报或者HOST上下电状态变化感知

bmc.kepler.Systems.IPv4Address

==属性==

属性名类型可读写信号通知描述
AddressString只读变更广播IP地址
SubnetMaskString只读变更广播子网掩码
GatewayString只读变更广播网关
AddressOriginString只读变更广播地址模式

bmc.kepler.Systems.IPv6Address

==属性==

属性名类型可读写信号通知描述
AddressString只读变更广播IP地址
PrefixLengthString只读变更广播前缀长度
AddressStateString只读变更广播地址状态
AddressOriginString只读变更广播地址来源
GatewayString[]只读变更广播网关

bmc.kepler.Systems.Led

==属性==

属性名类型可读写信号通知描述
NameString只读变更广播Led灯的名称
OnDurationU8只读变更广播亮灯持续时间 默认值0
OffDurationU8只读变更广播关灯持续时间 默认值0
CapabilityU8只读变更广播颜色,3:绿色,2:红色
SystemIdU8只读变更广播系统id
StateU8读写变更广播当前Led灯的状态
IdU8只读变更广播每个LED灯都会对应一个固定id
FruIdU8只读变更广播关联的FRU id
ColorCapabilitiesU8只读变更广播Led灯支持的颜色能力
LocalControlStateColorString只读变更广播本地控制模式下的颜色
OverrideStateColorString只读变更广播超驰状态下的颜色
ModeU8只读变更广播Led模式
DefaultLCSColorU8只读变更广播本地控制模式(local control state)的默认颜色,0:reserved,1:BLUE,2:RED,3:GREEN,4:AMBER,5:ORANGE,6:WHITE
DefaultOSColorU8只读变更广播超驰模式(override state)的默认颜色,0:reserved,1:BLUE,2:RED,3:GREEN,4:AMBER,5:ORANGE,6:WHITE

==方法==


SetState

设置Led灯的状态

参数

  • State: U8 - Led灯的状态
  • Interval: U8 - 闪烁状态持续时长

返回值

  • State: U8 - Led灯的状态
  • OnDuration: U8 - 闪烁状态下亮灯持续时长
  • OffDuration: U8 - 闪烁状态下关灯持续时长

bmc.kepler.Systems.Led.Policy

==属性==

属性名类型可读写信号通知描述
NormalU16[]读写变更广播Normal等级亮灯策略
MinorU16[]读写变更广播Minor等级亮灯策略
MajorU16[]读写变更广播Major等级亮灯策略
CriticalU16[]读写变更广播Critical等级亮灯策略

bmc.kepler.Systems.Led.Policy.SystemHealth

==属性==

属性名类型可读写信号通知描述
SeverityReferenceSourceString读写变更广播Led健康灯的严重等级来源, 枚举值:Event、Sensor、EventAndSensor

bmc.kepler.Systems.LiquidCoolingConfig

==属性==

属性名类型可读写信号通知描述
CtrlModeString只读变更广播冷却单元的控制模式(自动/手动/混合)
TimeOutU32只读变更广播手动模式下的超时时间,时间:秒
ManualLevelU8只读变更广播手动模式下的转速级别
LevelPercentRangeU8[]只读变更广播手动设置转速级别允许范围
ActiveAlgorithmString只读变更广播当前实时生效的算法,取值为:MPC、PID或N/A

==方法==


SetManualLevel

设置手动模式冷却级别

参数

  • UnitId: U8 - 冷却单元Id
  • Level: U8 - 设置的转速级别

SetCtrlMode

设置冷却单元控制模式

参数

  • CtrlMode: String - 冷却单元控制模式
  • Timeout: U32 - 超时时长,时间:秒

bmc.kepler.Systems.MPCConfig

==属性==

属性名类型可读写信号通知描述
EnabledBoolean读写变更广播MPC是否使能,默认为false
TotalPowerSavedKwhDouble只读变更广播MPC累计节省能耗,千瓦时
LastStartTimeU32只读变更广播最近一次MPC开启时间,时间:秒
StatusString只读变更广播MPC模型状态,当前存在5种取值类型,Idle空闲状态,Training训练状态,Active生效状态,Inactive不生效状态,Unavailable不可用状态

bmc.kepler.Systems.Mctp

==属性==

属性名类型可读写信号通知描述
DiscoverFlagU8只读变更广播发现的标志
OwnerEidU8只读变更广播ME的Eid
OwnerPhyU16只读变更广播ME的物理地址
BmcEidU8只读变更广播BMC的Eid
BmcPhyU16只读变更广播BMC的物理地址
SystemIdU8只读变更广播系统Id
TableStatusU8只读变更广播路由表状态

bmc.kepler.Systems.Mctp.MctpBinding.PCIe

==属性==

属性名类型可读写信号通知描述
OwnerEidU8只读变更广播ME的Eid
OwnerPhyAddrU16只读变更广播ME的PCIe物理地址
BmcEidU8只读变更广播BMC的Eid
BmcPhyAddrU16只读变更广播BMC的PCIe物理地址
DiscoverFinishedBoolean只读变更广播MCTP是否完成初始化
RoutingTableReadyBoolean只读变更广播路由表是否就绪

bmc.kepler.Systems.Mctp.MctpBinding.SMBus

==属性==

属性名类型可读写信号通知描述
BmcEidU8只读变更广播SMBus协议使用的BMC的Eid
BmcPhyAddrU8只读变更广播SMBus协议使用的BMC的物理地址

bmc.kepler.Systems.Mctp.PCIeEndpoint

==属性==

属性名类型可读写信号通知描述
ServiceNameString只读变更广播注册通道的模块名
TargetEidU8只读变更广播对端的Eid
TargetPhyAddrU16只读变更广播对端PhyAddr
MessageTypeU8只读变更广播协议类型
MediumTypeU8只读变更广播物理介质类型, 0x02:SMBus 2.0 or I2C 100 kHz compatible, 0x0f:PCI compatible (PCI 1.0, 2.0, 2.1, 2.2, 2.3, 3.0, PCI-X 1.0, PCI-X 2.0), 0x80:SMBus 2.0 + I2C 100 kHz OEM master binding
StatusU8只读变更广播Endpoint状态, 0:初始状态, 1:Endpoint对象发现完成;

==方法==


Request

发送消息并接收响应的方法

参数

  • Data: U8[] - 请求数据
  • TimeoutMs: S32 - 超时时间
  • ReqHeaderFileds: ReqHeaderFileds - mctp上层协议请求报文头字段, 完成协议请求报文头的填充。目前支持, NCSI协议: 数据包类型 PacketType, 通道标识 ChannelId, 数据包标识 PackageId; NVME协议: 数据完整校验标识 IC, NVME消息类型 MsgType, 命令插槽标识 CmdSlot; PLDM协议: 报文类型 PldmType, 命令代码 CommandCode
  • RspHeaderValidators: RspHeaderValidators - 对mctp上层协议返回报文头的校验。支持校验项: NCSI: NCSI协议返回数据包类型 PacketType; PLDM协议: 返回命令代码 CommandCode

返回值

  • Data: U8[] - 响应数据

Send

发送消息的方法

参数

  • Data: U8[] - 请求数据
  • ReqHeaderFileds: ReqHeaderFileds - mctp上层协议请求报文头字段, 完成协议请求报文头的填充。目前支持, NCSI协议: 数据包类型 PacketType, 通道标识 ChannelId, 数据包标识 PackageId; NVME协议: 数据完整校验标识 IC, NVME消息类型 MsgType, 命令插槽标识 CmdSlot; PLDM协议: 报文类型 PldmType, 命令代码 CommandCode

==自定义类型==


ReqHeaderFileds: 结构体类型

  • key: String
  • value: String

RspHeaderValidators: 结构体类型

  • key: String
  • value: String

bmc.kepler.Systems.Mctp.PCIeRoutingEntry

==属性==

属性名类型可读写信号通知描述
EidRangeSizeU8只读变更广播MCTP标准定义的路由表字段 Eid范围
StartingEidU8只读变更广播MCTP标准定义的路由表字段 起始Eid
EntryTypeU8只读变更广播MCTP标准定义的路由表字段 路由类型
PhysTransportBindingIdU8只读变更广播MCTP标准定义的路由表字段 物理通道绑定的Id
MediaTypeIdU8只读变更广播MCTP标准定义的路由表字段 物理介质类型
PhysAddressU8[]只读变更广播MCTP标准定义的路由表字段 物理地址

bmc.kepler.Systems.Mctp.PCIeTransport

==属性==

属性名类型可读写信号通知描述
ServiceNameString只读变更广播注册通道的模块名
TargetEidU8只读变更广播对端的Eid
TargetPhyAddrU16只读变更广播对端PhyAddr
MessageTypeU8只读变更广播协议类型

bmc.kepler.Systems.Memory

==属性==

属性名类型可读写信号通知描述
SystemIdU8只读变更广播系统Id
NameString只读变更广播内存名
DimmNameString只读变更广播内存槽位名
PresenceU8只读变更广播内存在位状态
CpuIdU8只读变更广播内存对应的cpuId
NodeIdU8只读变更广播内存对应的节点Id
ChannelIdU8只读变更广播内存对应的物理通道Id
LogicalChannelIdU8只读变更广播内存对应的逻辑通道Id
DimmIdU8只读变更广播内存对应的槽位Id
AllowedSpeedsMHzU32只读变更广播运行的最高操作频率
BaseModuleTypeString只读变更广播基础模块类型RDIMM、UDIMM、LRDIMM
CapacityMiBU32只读变更广播容量
DataWidthBitsU32只读变更广播数据位宽
FirmwareRevisionString只读变更广播固件修订版本
ManufacturerString只读变更广播制造商
DramManufacturerString只读变更广播内存颗粒厂商
MemoryDeviceTypeString只读变更广播内存设备类型
MemorySubsystemControllerManufacturerIDString只读变更广播子系统控制器制造商Id
MemorySubsystemControllerProductIDString只读变更广播子系统控制器产品Id
MemoryTypeString只读变更广播内存类型
OperatingSpeedMhzU32只读变更广播内存模块的时钟频率
PartNumberString只读变更广播部件号
OriginalPartNumberString只读变更广播内存的原厂部件号
RankCountU32只读变更广播Rank数
SerialNumberString只读变更广播序列号
MinVoltageMillivoltU32只读变更广播最小工作电压
PositionString只读变更广播位置
DiagnosticFaultU8读写变更广播严重故障诊断告警状态
PredictiveFaultU8只读变更广播预故障告警状态
DeviceLocatorString只读变更广播内存的丝印
HealthU8只读变更广播健康状态
DimmNumU8只读变更广播DimmNum
BOMString只读变更广播物料清单
ManufacturerIDString只读变更广播制造商ID
ManufacturingDateString只读变更广播生产日期
ManufacturingLocationString只读变更广播制造地点
ChipBitWidthString只读变更广播内存位宽
TemperatureCelsiusDouble只读变更广播内存温度
TSensorTemperatureCelsiusS16只读变更广播Tsensor温度
SilkTextString只读变更广播内存的板上丝印
ErrorCorrectionString只读变更广播内存设备支持的纠错信息,取值有AddressParity、MultiBitECC、NoECC、SingleBitECC
TechnologyString只读变更广播内存的内存技术

bmc.kepler.Systems.Memory.Fault

==属性==

属性名类型可读写信号通知描述
PMICErrorU8只读变更广播1: 产生PMIC Error; 0: 默认值,没有产生PMIC Error

bmc.kepler.Systems.Memory.MemoryMetrics

==属性==

属性名类型可读写信号通知描述
BandwidthPercentU8只读变更广播占用率
BandwidthThresholdPercentU8只读变更广播占用率门限
ConsumedPowerWattU32只读变更广播功耗
SystemMemoryBuffersGiBDouble只读变更广播内存的缓存区容量
SystemMemoryCachedGiBDouble只读变更广播内存的缓冲区容量
TotalSystemMemoryGiBDouble只读变更广播内存的总容量

==方法==


SetBandwidthThreshold

设置内存占用率门限

参数

  • BandwidthThresholdPercent: U8 - 内存占用率门限

返回值

  • Result: S32 - 设置内存占用率门限结果

GetBandwidthHistory

获取内存占用率的历史数据

返回值

  • History: String - 内存占用率的历史数据

ClearBandwidthHistory

清除内存占用率的历史数据


bmc.kepler.Systems.MemoryChannel

==属性==

属性名类型可读写信号通知描述
NameString只读变更广播内存通道名
LogicalCpuIdU8只读变更广播逻辑cpuId
PhysicalChannelIdU8只读变更广播物理内存通道Id
LogicalChannelIdU8只读变更广播逻辑内存通道Id
DiagnosticFaultU8读写变更广播严重故障诊断告警状态
SystemIdU8只读变更广播系统Id
CorrectableECCStormBurstEventU8读写变更广播内存发生超级CE风暴,取值: 0-未发生,1-发生。系统下电/复位时,恢复到未发生状态。

bmc.kepler.Systems.NCSICapabilities

==属性==

属性名类型可读写信号通知描述
PCIeNCSIEnabledU8只读变更广播PCIE标卡NCSI线缆在位标记
PCIeNCSISupportedBoolean只读变更广播用于生产查询主板对PCIE标卡NCSI功能支持能力

bmc.kepler.Systems.NPUCard

==属性==

属性名类型可读写信号通知描述
PowerWattsU16只读变更广播功耗
PowerStateU8只读变更广播NPU卡电源状态,1表示上电,0表示下电
Core0TemperatureCelsiusU16只读变更广播芯片1温度
Core1TemperatureCelsiusU16只读变更广播芯片2温度
OutletTemperatureCelsiusU16只读变更广播NPU卡出风口温度
InletTemperatureCelsiusU16只读变更广播NPU卡出风口温度
FaultStateU32只读变更广播NPU卡的故障状态
FaultCodeString只读变更广播NPU卡的故障码
ChipHealthStatusEnum只读变更广播NPU卡精细化告警级别: 0代表无告警,1代表一般故障,2代表严重故障,3代表紧急故障
ChipFaultDescriptionString只读变更广播NPU卡故障描述
McuFirmwareVersionString只读变更广播NPU卡的MCU版本
SlotNumberU32只读变更广播NPU卡的槽位
SerialNumberString只读变更广播NPU卡的序列号
BoardIDU16只读变更广播NPU卡的board id
PcbVersionString只读变更广播NPU卡的pcb版本
NameString只读变更广播NPU卡的名称
FirmwareVersionString只读变更广播系统固件版本
MemoryCapacityMiBU32只读变更广播内存容量,单位(MB)

==自定义类型==


ChipHealthStatusEnum: 枚举类型

  • 0: Normal
  • 1: MinorFault
  • 2: MajorFault
  • 3: CriticalFault

bmc.kepler.Systems.NPUCard.PowerDevice

==属性==

属性名类型可读写信号通知描述
IdU8只读变更广播电源器件逻辑Id,从0开始
TemperatureCelsiusS16只读变更广播电源器件温度,0x7FFF表示当前状态不支持读取温度值,0x7FFE表示读取温度值失败,默认值0x7FFF
TypeString只读变更广播电源器件类型,枚举值包括:MOS;DrMOS;PSiP

bmc.kepler.Systems.NPUFDMService

==属性==

属性名类型可读写信号通知描述
HbmFPCEnabledBoolean读写变更广播NPU HBM FPC功能使能状态,true表示功能使能,false表示未使能;csr未配置时功能默认关闭
HbmFaultIsolationEnabledBoolean读写变更广播NPU HBM隔离修复功能使能状态,true表示功能使能,false表示未使能;csr未配置时功能默认关闭
HbmPageOfflineEnabledBoolean读写变更广播NPU HBM pageoffline功能使能状态,true表示功能使能,false表示未使能;csr未配置时功能默认关闭
HbmRowSparingEnabledBoolean读写变更广播NPU HBM Row Sparing容错功能使能状态,true表示功能使能,false表示未使能;csr未配置时功能默认打开
HbmPatrolScrubAlarmEnabledBoolean读写变更广播NPU HBM内存巡检发现不可纠正错误(PS UCE)后,BMC是否产生告警,true - 产生告警,false - 不产生告警
HbmFaultPredictionEnabledBoolean读写变更广播HBM内存UCE故障预测特性开关。取值:true-开启,false-关闭,默认值false。
HbmFaultPredictionModeString读写变更广播HBM内存UCE故障预测模式配置。取值:“Balanced”-均衡模式, “PrecisionFirst”-准确率优先模式, “RecallFirst”-覆盖率优先模式,默认值“PrecisionFirst”。
HbmHardFailureDetectionModeString读写变更广播HBM内存硬失效模式检测方式。PatrolScrub:通过巡检规则检测硬失效;ExpertRule:通过专家规则检测硬失效

==方法==


ExecuteScrubbing

NPU侧HBM巡检压测

参数

  • SlotId: U32 - NPU模组所在的物理槽位。
  • AddressType: String - 地址类型。
  • Address: String - 巡检地址。

返回值

  • TaskId: U32 - 执行NPU侧HBM巡检压测,创建的任务编号。

bmc.kepler.Systems.NetworkAdapter

==属性==

属性名类型可读写信号通知描述
IDString只读变更广播网卡ID
SystemIDU8只读变更广播系统ID
NameString只读变更广播网卡型号名称
DisplayNameString只读变更广播网卡显示名称
ManufacturerString只读变更广播厂商名称
DescriptionString只读变更广播网卡描述
PositionString只读变更广播网卡容器信息
DeviceLocatorString只读变更广播网卡丝印信息
TypeU8只读变更广播网卡类型
NetworkPortCountU8只读变更广播网口个数
NetworkDeviceFunctionCountU8只读变更广播网卡可用的最大物理功能数量
ModelString只读变更广播芯片型号
ChipVendorString只读变更广播芯片厂商
ModelDescriptionString只读变更广播芯片型号描述
ChipManufacturerString只读变更广播芯片厂商
DriverNameString只读变更广播驱动名称
DriverVersionString只读变更广播驱动版本
SlotNumberU8只读变更广播槽位号
NetDevFuncCapabilitiesU8只读变更广播网卡支持的协议,0:Disabled 1:Ethernet 2:FC 4:iSCSI 8:FCoE 16:OPA 32:IB
RootBDFString只读变更广播网卡BDF信息
FirmwareVersionString只读变更广播固件版本
VendorIDString只读变更广播厂商ID
DeviceIDString只读变更广播设备ID
SubsystemVendorIDString只读变更广播子系统厂商ID
SubsystemDeviceIDString只读变更广播子系统设备ID
BoardIDU16只读变更广播单板ID
BoardNameString只读变更广播单板名称
BoardIDHexString只读变更广播十六进制单板ID
ComponentUniqueIDString只读变更广播组件唯一标识
PCBVersionString只读变更广播PCB版本
AssociatedResourceString只读变更广播网卡资源归属
SupportedMctpBoolean只读变更广播网卡是否支持MCTP
HotPluggableBoolean只读变更广播网卡是否支持热插拔
ReadyToRemoveBoolean只读变更广播热拔出是否已准备好
AttentionHotPlugStateU8只读变更广播热插拔状态:0 - 不可操作;1 - 可拔出;2 - 可插入;其他 - 未知
SerialNumberString只读变更广播序列号
PreviousSerialNumberString只读变更广播更换前的序列号
TemperatureCelsiusS16只读变更广播芯片温度
TemperatureStatusU8只读变更广播芯片温度状态:0 - 正常;1 - 失效
MaxOperatingTemperatureCelsiusU16只读变更广播网卡在稳态下支持的最大温度
LLDPSupportedBoolean只读变更广播网卡是否支持LLDP
FruIdU8只读变更广播网卡电子标签
PredictiveFaultU8读写变更广播预测故障标志位
DiagnosticFaultU8读写变更广播故障诊断定位标志位
ReplacedFlagU8只读变更广播网卡更换标志位
SupportedLLDPBoolean只读变更广播网卡是否支持LLDP
ParentCardSlotIdU8只读变更广播关联上一级卡的槽位号
PfMacInfoArray只读变更广播Physical Function Mac信息
BandwidthThresholdPercentU16只读变更广播网络带宽占用率门限
NodeIdString只读变更广播网卡NodeId

==方法==


StartRemovingDevice

启动设备热拔

参数

  • ID: String - 设备号

DumpBlackBox

收集黑匣子日志,当前仅SDI 5.1的网络卡支持

参数

  • Path: String - 日志保存路径

返回值

  • TaskId: U32 - 任务ID

Reset

复位或上下电设备

参数

  • ResetType: String - 需要执行的复位或上下电动作:GracefulRestart - 优雅复位;ForceOff - 强制下电;ForceOn - 强制上电

==自定义类型==


PfMacInfoItem: 结构体类型

  • Port: U16 - Physical Function Port信息
  • PfId: U16 - Physical Function Id信息
  • PermanentMac: String - 永久物理地址信息

bmc.kepler.Systems.NetworkAdapter.NetworkAdapterMetrics

==属性==

属性名类型可读写信号通知描述
LinkWidthCapabilityString只读变更广播网卡支持的最大带宽能力
LinkSpeedCapabilityString只读变更广播网卡支持的最大速率能力
LinkWidthString只读变更广播网卡实际带宽
LinkSpeedString只读变更广播网卡实际速率
SFPMaxTemperatureCelsiusS16只读变更广播光模块最大温度,用于调速,单位:摄氏度
PowerMilliWattsU32只读变更广播网卡当前功率,单位:毫瓦

bmc.kepler.Systems.NetworkAdapter.PortConfig

==属性==

属性名类型可读写信号通知描述
PortCountU8只读变更广播预加载端口数量
PortCountAllowableValuesU8[]只读变更广播预加载端口数量取值,例如[2,4]表示支持配置成2口或4口
NodeIdString只读变更广播唯一标识,由网卡名加槽位号拼接而成,用于匹配该对象管理的网卡,例如EthernetAdapter1

==方法==


SetPortCount

参数

  • PortCount: U8 - 预加载端口数量

bmc.kepler.Systems.NetworkAdapter.Status

==属性==

属性名类型可读写信号通知描述
HealthU8只读变更广播网卡健康状态, 0:OK, 1:Minor, 2:Major, 3:Critical
FaultCodeString只读变更广播异常码
FaultStateU32只读变更广播故障状态,用于告警配置
PowerStatusU8只读变更广播Hi182x网卡电源状态,用于告警配置,1:正常, 0:异常, 255:未知

bmc.kepler.Systems.NetworkAdapters

==方法==


GetNetCardPortNum

获取网卡端口资源数量

参数

  • Type: U8 - 网口类型
  • SystemID: U8 - 系统系列号
  • SlotID: U8 - 槽位号

返回值

  • NetcardExist: U8 - 网卡在位信息
  • PortNum: U8 - 网口数量

GetPortSpeed

获取网口速率

参数

  • Type: U8 - 网口类型
  • Slot: U8 - 槽位号
  • PortID: U8 - 网卡端口号

返回值

  • Status: U8 - 网口连接状态
  • Speed: U32 - 网口速率

GetNetworkAdapterNum

获取网卡数量

返回值

  • NetworkAdapterNum: U8 - 网卡数量

GetNetworkPortNum

获取网口总数量

返回值

  • NetworkPortNum: U8 - 网口数量

GetBandwidthHistory

获取各个网卡的端口带宽占用率历史数据

返回值

  • History: String - 网口占用率历史数据

ClearBandwidthHistory

清空各个网卡的端口带宽占用率历史数据

参数

  • BWUWaveTitle: String - 网卡名称

SetBandwidthThreshold

设置网络带宽占用率门限

参数

  • BandwidthThresholdPercent: U8 - 占用率阈值,用于设置网口历史占用率

返回值

  • Result: S32 - 函数调用结果

bmc.kepler.Systems.NetworkBonding

==属性==

属性名类型可读写信号通知描述
IdString只读变更广播Bonding ID, 由BMA获取bonding资源时生成
NameString只读变更广播Bonding 名称, 在创建bonding资源时生成

bmc.kepler.Systems.NetworkBondings

==方法==


CreateBond

创建新Bond

参数

  • Request: Object - 创建bond需要的参数, 如port、BondingType等

返回值

  • TaskId: U32 - 创建的任务Id

DeleteBond

删除指定Bond

参数

  • Id: String - 待删除的Bond Id

返回值

  • TaskId: U32 - 创建的任务Id

SetLinkMonitorPeriodMS

设置Bond的链路监控周期

参数

  • Id: String - 待设置的Bond Id
  • LinkMonitorPeriodMS: U32 - 链路监控周期

返回值

  • TaskId: U32 - 创建的任务Id

==自定义类型==


Object: 结构体类型

  • key: String
  • value: String

bmc.kepler.Systems.NetworkBridge

==属性==

属性名类型可读写信号通知描述
IdString只读变更广播网桥ID
NameString只读变更广播网桥名称

bmc.kepler.Systems.NetworkPort

==属性==

属性名类型可读写信号通知描述
SystemIDU8只读变更广播系统ID
NodeIdString只读变更广播网口NodeId
NameString只读变更广播网口名称
TypeU8只读变更广播网口类型
PortIDU8只读变更广播网口ID
PermanentMACAddressString只读变更广播永久MAC地址
MACAddressString只读变更广播MAC地址
LinkStatusString读写变更广播链路状态
OSLinkStatusString读写变更广播BMA上报的网口连接状态
LinkStatusNumericU8读写变更广播链路状态
IPv6DefaultGatewayString只读变更广播IPv6默认网关
WorkModeString只读变更广播工作模式
FunctionTypeString只读变更广播网口类型:物理,虚拟
BDFString只读变更广播网口BDF
AutoConnectOnBootBoolean只读变更广播开机是否自动启用网络连接
AutoConnectOnBootValidityBoolean只读变更广播AutoConnectOnBoot当前是否为有效值
NetDevFuncTypeU8只读变更广播网络设备功能类型,0:Disabled 1:Ethernet 2:FC 4:iSCSI 8:FCoE 16:OPA 32:IB
MediumTypeString只读变更广播网口介质类型
SpeedMbpsU32只读变更广播链路速率
FullDuplexU8只读变更广播全双工状态,0:关闭,1:开启,255:未正常获取到状态(默认值)
AutoSpeedNegotiationU8只读变更广播自协商状态,0:关闭,1:开启,255:未正常获取到状态(默认值)
FirmwareVersionString只读变更广播固件版本
DriverNameString只读变更广播驱动名称
DriverVersionString只读变更广播驱动版本
LLDPEnabledBoolean读写变更广播网口LLDP使能 false:关闭使能 true:打开使能
SupportedLinkCapabilityString只读变更广播支持的传输速率
NetworkAdapterIdString只读变更广播对应的网卡ID属性
LinkMonitorPeriodMSU32只读变更广播网口链路监测周期,单位毫秒
UUIDString只读变更广播网口全球唯一标识,用于IB卡。只读属性,默认为空。
WorkloadTypeU8只读变更广播工作负载类型,0:负载服务器os;1:负载智能网卡的os;2:服务器os及智能网卡os均卸载
MTUSizeU16只读变更广播此接口当前配置的最大传输单元
AutoSpeedNegotiationCapableU8只读变更广播网口是否具备自协商能力,0:不具备,1:具备,255:未正常获取到状态(默认值)
InterfaceEnabledU8只读变更广播网口是否启用,0:未启用,1:启用,255:未正常获取到状态(默认值)
LinkStateString只读变更广播接口所需的链路状态,默认为空

==方法==


Configure

配置网口

参数

  • Request: Object - 配置网口时传入的参数列表,如连接状态、地址、掩码等

返回值

  • TaskId: U32 - 任务ID

==自定义类型==


Object: 结构体类型

  • key: String
  • value: String

bmc.kepler.Systems.NetworkPort.DataCenterBridging

==属性==

属性名类型可读写信号通知描述
Up2cosU8[]只读变更广播DCB 信息中的 Up2cos
UppgidU8[]只读变更广播DCB 信息中的 Uppgid
PgpctU8[]只读变更广播DCB 信息中的 Pgpct
PgStrictU8[]只读变更广播DCB 信息中的 PgStrict
PfcmapU8只读变更广播DCB 信息中的 Pfcmap

bmc.kepler.Systems.NetworkPort.Fault

==属性==

属性名类型可读写信号通知描述
LinkDownU8只读变更广播1: 产生LinkDown故障; 0: 默认值,没有产生LinkDown故障

bmc.kepler.Systems.NetworkPort.FibreChannel

==属性==

属性名类型可读写信号通知描述
FCIdString只读变更广播FC ID信息
WWNNString只读变更广播当前生效WWNN号
PermanentWWNNString只读变更广播出厂WWNN号
WWPNString只读变更广播当前生效WWPN号
PermanentWWPNString只读变更广播出厂WWPN号
SpeedGbpsU32只读变更广播端口链接速率,单位Gb,用于FC卡

bmc.kepler.Systems.NetworkPort.LLDPReceive

==属性==

属性名类型可读写信号通知描述
ChassisIdString只读变更广播从网络交换机接收到的Chassis ID
ChassisIdSubtypeString只读变更广播从网络交换机接收到的Chassis ID类型
PortIdString只读变更广播从网络交换机接收到的端口ID
PortIdSubtypeString只读变更广播从网络交换机接收到的端口ID类型
SystemNameString只读变更广播网络交换机名称
ManagementVlanIdU16只读变更广播从网络交换机接收到的VLAN ID

bmc.kepler.Systems.NetworkPort.Metrics

==属性==

属性名类型可读写信号通知描述
RXFramesString只读变更广播最近一次重置后端口上接收到的帧总数
TXFramesString只读变更广播最近一次重置后端口上传输的帧总数
RXDiscardsU64只读变更广播最近一次重置后端口接收路径中丢弃的帧总数
TXDiscardsU64只读变更广播最近一次重置后端口传输路径中丢弃的帧总数
PacketsDroppedU64只读变更广播丢包总数
RXUnicastFramesString只读变更广播收到的单播帧数量
RXMulticastFramesString只读变更广播收到的多播帧数量
RXBroadcastFramesString只读变更广播收到的广播帧数量
TXUnicastFramesString只读变更广播发送的单播帧数量
TXMulticastFramesString只读变更广播发送的多播帧数量
TXBroadcastFramesString只读变更广播发送的广播帧数量
RXFCSErrorsString只读变更广播接收到的校验错误帧数量
RXUndersizeFramesString只读变更广播接收到的超小帧数量
RXOversizeFramesString只读变更广播接收到的超长帧数量
TXSingleCollisionsString只读变更广播发送的单碰撞帧数量
TXMultipleCollisionsString只读变更广播发送的多碰撞帧数量
TXLateCollisionsString只读变更广播发送的延迟碰撞帧数量
TXExcessiveCollisionsString只读变更广播发送的超量碰撞帧数量
RXFrameAlignmentErrorsString只读变更广播接收的对齐错误的帧数量
RXPauseXOFFFramesU64只读变更广播网络发出的用于暂停传输的流量控制帧的总数
RXPauseXONFramesU64只读变更广播网络发出的用于恢复传输的流量控制帧的总数
TXPauseXOFFFramesU64只读变更广播发送至网络的 XOFF 帧的总数
TXPauseXONFramesU64只读变更广播发送至网络的 XON 帧的总数
RXFalseCarrierErrorsU64只读变更广播从物理层接收到的错误帧总数
BandwidthUsagePercentDouble只读变更广播网络带宽占用率
RXBytesString只读变更广播端口接收的字节总数
TXBytesString只读变更广播端口发送的字节总数
RXErrorsString只读变更广播端口接收到的错误总数

bmc.kepler.Systems.NetworkPort.RelatedItems

==属性==

属性名类型可读写信号通知描述
TransceiverLanesArray只读变更广播该网口关联的光模块丝印信息及其通道ID。数组元素的第1个参数表示光模块丝印信息,第2个参数表示光模块通道ID。举例:[(OSFP1,1),(OSFP1,2),(OSFP2,3),(OSFP2,4)]表示该网口关联当前网卡下OSFP1的通道1/2、OSFP2的通道3/4
ProcessorPortsArray只读变更广播该网口关联的处理器及其端口。数组元素的第1个参数表示处理器丝印,第2个参数表示处理器端口的逻辑ID。举例:[(“NPU1”, 0),(“NPU1”, 1)]表示该网口关联NPU1的第0、1个端口

==自定义类型==


RelatedTransceiverLane: 结构体类型

  • TransceiverSilkText: String - 光模块丝印信息
  • TransceiverLaneId: U8 - 光模块通道ID

RelatedProcessorPort: 结构体类型

  • ProcessorSilkText: String - 处理器丝印
  • PortId: U8 - 处理器端口的逻辑ID

bmc.kepler.Systems.NetworkPort.VLAN

==属性==

属性名类型可读写信号通知描述
VLANIdU16只读变更广播VLAN ID
VLANEnabledBoolean只读变更广播VLAN是否启用
VLANPriorityU8只读变更广播VLAN优先级
AutoConnectOnBootBoolean只读变更广播VLAN是否在系统启动时自动创建和启用
AutoConnectOnBootValidityBoolean只读变更广播AutoConnectOnBoot当前是否为有效值

==方法==


ConfigureVLAN

配置网口VLAN

参数

  • Request: Object - 配置参数列表

返回值

  • TaskId: U32 - 任务ID

DeleteVLAN

删除网口VLAN

返回值

  • TaskId: U32 - 任务ID

==自定义类型==


Object: 结构体类型

  • key: String
  • value: String

bmc.kepler.Systems.NetworkPort.VLANs

==方法==


CreateVLAN

创建VLAN

参数

  • Request: Object - 创建vlan参数列表

返回值

  • TaskId: U32 - 任务ID

==自定义类型==


Object: 结构体类型

  • key: String
  • value: String

bmc.kepler.Systems.OSConfiguration

==属性==

属性名类型可读写信号通知描述
CpuFrequencyMHzArray只读变更广播设置CPU Numa/Core频率(MHZ)
MsgMaxU32只读变更广播消息队列中单个消息的最大字节数
CFSBandwidthSliceUSU32只读变更广播CFS带宽控制
NrMigrateU32只读变更广播负载平衡可跨处理器迁移的任务数
MigrationCostNSU32只读变更广播任务迁移阈值
MinGranularityNSU32只读变更广播CPU上进程的最短运行时间
SwappinessU8只读变更广播swap的物理内存剩余空间百分比阈值
DirtyRatioU8只读变更广播脏数据提交阈值

==方法==


SetCpuFrequencyMHz

设置设置CPU Numa/Core频率(MHZ)

参数

  • CpuFrequencyMHz: Array - 设置CPU Numa/Core频率(MHZ)

SetMsgMax

设置消息队列中单个消息的最大字节数

参数

  • MsgMax: U32 - 消息队列中单个消息的最大字节数

SetCFSBandwidthSliceUS

设置CFS带宽控制

参数

  • CFSBandwidthSliceUS: U32 - CFS带宽控制

SetNrMigrate

设置负载平衡可跨处理器迁移的任务数

参数

  • NrMigrate: U32 - 负载平衡可跨处理器迁移的任务数

SetMigrationCostNS

设置任务迁移阈值

参数

  • MigrationCostNS: U32 - 任务迁移阈值

SetMinGranularityNS

设置CPU上进程的最短运行时间

参数

  • MinGranularityNS: U32 - CPU上进程的最短运行时间

SetSwappiness

设置swap的物理内存剩余空间百分比阈值

参数

  • Swappiness: U8 - swap的物理内存剩余空间百分比阈值

SetDirtyRatio

设置脏数据提交阈值

参数

  • DirtyRatio: U8 - 脏数据提交阈值

==自定义类型==


CpuFrequencyData: 结构体类型

  • NUMA: U8
  • CORE: U32[]

bmc.kepler.Systems.OpticalModule

==属性==

属性名类型可读写信号通知描述
NameString只读变更广播名称
ManufacturerString只读变更广播厂商名称
PartNumberString只读变更广播厂商部件名称
SerialNumberString只读变更广播序列号
RevisionNumberString只读变更广播产品修订版本号, ASCII字符串, 长度为2字符
ProductionDateString只读变更广播生产日期
TransceiverTypeString只读变更广播收发器类型
FiberConnectionTypeString只读变更广播传输模式
WaveLengthNanometerString只读变更广播波长,单位纳米
TypeString只读变更广播类型
SupportedSpeedsMbpsDouble[]只读变更广播支持的速率
HealthU8只读变更广播健康状态
IdentifierString只读变更广播识别码
ConnectorTypeString只读变更广播连接器类型
MediumTypeString只读变更广播介质类型
TransmissionDistanceString只读变更广播传输距离
RxLossStateBoolean只读变更广播接收端信号是否丢失
RxLossStateValidityBoolean只读变更广播RxLossState当前是否为有效值
TxLossStateBoolean只读变更广播发送端信号是否丢失
TxLossStateValidityBoolean只读变更广播TxLossState当前是否为有效值
TxFaultStateBoolean只读变更广播发送端是否故障
TxFaultStateValidityBoolean只读变更广播TxFaultState当前是否为有效值
TypeMatchBoolean只读变更广播类型是否匹配
TypeMatchValidityBoolean只读变更广播TypeMatch当前是否为有效值
SpeedMatchBoolean只读变更广播速率是否匹配
SpeedMatchValidityBoolean只读变更广播SpeedMatch当前是否为有效值
FaultStateU32只读变更广播故障状态
TemperatureCelsiusDouble只读变更广播光模块温度(用于告警)
PowerStateU8只读变更广播功率异常标志位(用于告警)
IsSupportedTypeU8只读变更广播网卡支持速率与光模块速率不匹配标志位(用于告警)
PresenceU8只读变更广播光模块是否在位
ChannelNumU8只读变更广播光模块内部通道数
RxSNRDouble[]只读变更广播端口接收信噪比
HostSNRDouble[]只读变更广播主机侧信噪比
MediaSNRDouble[]只读变更广播介质侧信噪比
AccessibleU8只读变更广播光模块是否可访问,0为不可访问,1为可访问
ModuleStateU8只读变更广播光模块当前运行状态, 默认值为255, 1: ModuleLowPwr, 2: ModulePwrUp, 3: ModuleReady, 4: ModulePwrDn, 5: ModuleFault, 其余取值为光模块厂家自定义状态
RelatedNetworkPortsU8[]只读变更广播光模块关联的网口Id
IdU8只读变更广播该光模块在当前网卡下的逻辑ID,从0开始
SilkTextString只读变更广播光模块丝印信息
TechnologyTypeString只读变更广播光模块技术类型

bmc.kepler.Systems.OpticalModule.BiasCurrent

==属性==

属性名类型可读写信号通知描述
TXBiasCurrentMilliAmpsDouble[]只读变更广播读取的电流,单位毫安
TXBiasCurrent1MilliAmpsDouble只读变更广播读取的通道1的电流,单位毫安
TXBiasCurrent2MilliAmpsDouble只读变更广播读取的通道2的电流,单位毫安
TXBiasCurrent3MilliAmpsDouble只读变更广播读取的通道3的电流,单位毫安
TXBiasCurrent4MilliAmpsDouble只读变更广播读取的通道4的电流,单位毫安
TXBiasCurrent5MilliAmpsDouble只读变更广播读取的通道5的电流,单位毫安
TXBiasCurrent6MilliAmpsDouble只读变更广播读取的通道6的电流,单位毫安
TXBiasCurrent7MilliAmpsDouble只读变更广播读取的通道7的电流,单位毫安
TXBiasCurrent8MilliAmpsDouble只读变更广播读取的通道8的电流,单位毫安
TXBiasCurrentStatusU32只读变更广播偏置电流异常状态;每个bit对应一个通道,某个bit取值1表示是对应偏置电流通道故障;当前光模块最多8通道,属性预留32位便于扩展
TXLowerThresholdCriticalDouble只读变更广播发送偏置电流告警下限阈值
TXUpperThresholdCriticalDouble只读变更广播发送偏置电流告警上限阈值
BiasCurrentTXUpperThresholdWarningDouble只读变更广播发送偏置电流警告上限阈值
BiasCurrentTXLowerThresholdWarningDouble只读变更广播发送偏置电流警告下限阈值

bmc.kepler.Systems.OpticalModule.Channel

==属性==

属性名类型可读写信号通知描述
IdU8只读变更广播光模块RX/TX通道号
BiasCurrentMilliAmpsDouble只读变更广播通道的偏置电流,单位毫安
RXPowerMilliWattsDouble只读变更广播通道的接收功率,单位毫瓦
TXPowerMilliWattsDouble只读变更广播通道的发送功率,单位毫瓦

bmc.kepler.Systems.OpticalModule.Diagnose

==属性==

属性名类型可读写信号通知描述
RxLossOfLockU8只读变更广播接受方向的CDR失败状态
TxLossOfLockU8只读变更广播发送方向的CDR失败状态
LaserRuntimeSecondsU32只读变更广播激光器运行时间,单位:秒
LaserTemperatureCelsiusDouble只读变更广播激光器管芯温度
PowerOnCountU16只读变更广播模块上电次数
UptimeSecondsU32只读变更广播模块上电时间,单位:秒
PowerStatusU16只读变更广播模块上电状态
OdspDieTemperatureCelsiusDouble只读变更广播ODSP结温
OdspHighTempRuntimeSecondsU32只读变更广播ODSP高温运行时间,单位:秒
SelfTestStatusU64只读变更广播光模块自体诊断告警状态,轻微隐患和严重故障各32bit
MediaInterfaceFaultStatusU16只读变更广播光链路告警状态,轻微隐患和严重故障各8bit,每个bit分别代表通道1至8状态,0代表正常,1代表有错误信息
HostInterfaceFaultStatusU16只读变更广播电链路告警状态,轻微隐患和严重故障各8bit,每个bit分别代表通道1至8状态,0代表正常,1代表有错误信息
RxLoSU32只读变更广播接收端LoS(信号丢失);每个bit对应一个通道,某个bit取值1表示是对应通道故障;当前光模块最多8通道,属性预留32位便于扩展
TxLoSU32只读变更广播发送端LoS(信号丢失);每个bit对应一个通道,某个bit取值1表示是对应通道故障;当前光模块最多8通道,属性预留32位便于扩展
TxFaultU32只读变更广播发送错误;每个bit对应一个通道,某个bit取值1表示是对应通道故障;当前光模块最多8通道,属性预留32位便于扩展
PRBSTestSupportedBoolean只读变更广播此光模块是否支持PRBS压测
FiberDirtyDetectedBoolean读写变更广播光模块是否脏污
FiberLoosenessDetectedBoolean读写变更广播光模块是否松动
ContaminationDetectionSupportedBoolean只读变更广播此光模块是否支持脏污检测

bmc.kepler.Systems.OpticalModule.Power

==属性==

属性名类型可读写信号通知描述
RXInputPowerMilliWattsDouble[]只读变更广播读取的接收功率,单位毫瓦
RXInputPowerStatusU32只读变更广播接收功率异常状态;每个bit对应一个通道,某个bit取值1表示是对应接收功率通道故障;当前光模块最多8通道,属性预留32位便于扩展
RXLowerThresholdCriticalDouble只读变更广播接收功率告警下限阈值
RXUpperThresholdCriticalDouble只读变更广播接收功率告警上限阈值
TXOutputPowerMilliWattsDouble[]只读变更广播读取的发送功率,单位毫瓦
TXOutputPowerStatusU32只读变更广播发送功率异常状态;每个bit对应一个通道,某个bit取值1表示是对应发送功率通道故障;当前光模块最多8通道,属性预留32位便于扩展
TXLowerThresholdCriticalDouble只读变更广播发送功率告警下限阈值
TXUpperThresholdCriticalDouble只读变更广播发送功率告警上限阈值
PowerTXUpperThresholdWarningDouble只读变更广播发送功率警告上限阈值
PowerTXLowerThresholdWarningDouble只读变更广播发送功率警告下限阈值
PowerRXUpperThresholdWarningDouble只读变更广播接收功率警告上限阈值
PowerRXLowerThresholdWarningDouble只读变更广播接收功率警告下限阈值
PowerClassU8只读变更广播光模块功耗分类, 默认值为255, 分类对应功耗由光模块协议定义
PowerCapacityWattsDouble只读变更广播光模块允许的最大额定功耗

bmc.kepler.Systems.OpticalModule.RelatedItems

==属性==

属性名类型可读写信号通知描述
NetworkPortLanesArray只读变更广播该光模块关联网口的ID以及关联网口的通道ID。数组元素的第1个参数表示网口逻辑ID,第2个参数表示网口通道ID。举例:[(1,1),(2,2),(1,3),(2,4)]表示该光模块关联当前网卡下第1个网口的通道1、第2个网口的通道2、第1个网口的通道3、第2个网口的通道4
ProcessorPortLanesArray只读变更广播该光模块关联处理器端口,四个参数依次表示处理器的类型、处理器Id、端口的ID以及关联端口的通道ID。举例:[('CPU',1,1,1),('NPU',2,4,2)]表示该光模块的两个通道依次关联当前系统下Id为1的CPU的第1个端口的通道1、Id为2的NPU的第4个端口的通道1

==自定义类型==


RelatedNetworkPortLane: 结构体类型

  • NetworkPortId: U8 - 网口逻辑ID
  • NetworkPortLaneId: U8 - 网口通道ID

RelatedProcessorPortLane: 结构体类型

  • ProcessorType: String - 处理器类型
  • ProcessorId: U16 - 处理器逻辑Id
  • PortId: U16 - 端口ID
  • PortLaneId: U16 - 端口通道ID

bmc.kepler.Systems.OpticalModule.Temperature

==属性==

属性名类型可读写信号通知描述
ReadingCelsiusDouble只读变更广播读取的芯片温度
LowerThresholdCriticalDouble只读变更广播下限阈值
UpperThresholdCriticalDouble只读变更广播上限阈值
TemperatureLowerThresholdCriticalDouble只读变更广播低温告警阈值
TemperatureUpperThresholdCriticalDouble只读变更广播高温告警阈值
TemperatureLowerThresholdWarningDouble只读变更广播低温警告阈值
TemperatureUpperThresholdWarningDouble只读变更广播高温警告阈值

bmc.kepler.Systems.OpticalModule.Voltage

==属性==

属性名类型可读写信号通知描述
SupplyVoltageDouble只读变更广播供电电压
LowerThresholdCriticalDouble只读变更广播下限阈值
UpperThresholdCriticalDouble只读变更广播上限阈值
VoltageLowerThresholdCriticalDouble只读变更广播低压告警阈值
VoltageUpperThresholdCriticalDouble只读变更广播高压告警阈值
VoltageLowerThresholdWarningDouble只读变更广播低压警告阈值
VoltageUpperThresholdWarningDouble只读变更广播高压警告阈值

bmc.kepler.Systems.PCIeDevice.PCIeFunction

==属性==

属性名类型可读写信号通知描述
SegmentNumberU16只读变更广播用于多PCI Bridge场景的编号,每一个SegmentNumber对应一个PCI Bus空间
BusNumberU8只读变更广播PCIe功能的总线号
DeviceNumberU8只读变更广播PCIe功能的设备号
FunctionNumberU8只读变更广播PCIe功能的功能号
RelatedProcessorIdU8只读变更广播关联的处理器逻辑Id
RootBusNumberU8只读变更广播PCIe功能的根总线号
RootDeviceNumberU8只读变更广播PCIe功能的根设备号
RootFunctionNumberU8只读变更广播PCIe功能的根功能号
VendorIdU16只读变更广播制造商ID
DeviceIdU16只读变更广播设备ID
SubsystemVendorIdU16只读变更广播子厂商ID
SubsystemIdU16只读变更广播子设备ID
FunctionProtocolString只读变更广播PCIe功能协议
FunctionTypeString只读变更广播PCIe功能类型
BaseClassCodeU8只读变更广播PCIe功能的基类码
SubClassCodeU8只读变更广播PCIe功能的子类码
ProgrammingInterfaceU8只读变更广播PCIe功能的编程接口
RevisionIdU8只读变更广播PCIe功能的版本号

bmc.kepler.Systems.PCIeDevice.PCIeFunction.RAS

==属性==

属性名类型可读写信号通知描述
FatalErrorCountU32读写变更广播PCIe功能致命错误计数
NonFatalErrorCountU32读写变更广播PCIe功能非致命错误计数
BadDLLPCountU32读写变更广播最近一次上电期间BadDLLP错误累计值
BadTLPCountU32读写变更广播最近一次上电期间BadTLP错误累计值
UnsupportedRequestCountU32读写变更广播最近一次上电期间UnsupportedRequest错误累计值
CorrectableErrorOverfrequencyCountU32读写变更广播最近一次上电期间PCIe设备CE故障发生频率超门限错误累计值

bmc.kepler.Systems.PCIeDevices

==属性==

属性名类型可读写信号通知描述
PCIeCardsDetectionStatusU8只读变更广播PCIe卡检测状态

==方法==


SetPcieErrorStatus

根据错误类型设置不同错误事件属性状态

参数

  • Segment: U8 - 用于多PCI Bridge场景的编号,每一个Segment对应一个PCI Bus空间
  • SocketID: U8 - PCIe设备所属CPU ID
  • Bus: U8 - PCIe设备的总线号
  • Device: U8 - PCIe设备的设备号
  • Function: U8 - PCIe设备的功能号
  • ErrorType: String - 错误类型:CorrectableError可纠正错误、UncorrectableError不可纠正错误、FatalError致命错误、ParityError奇偶校验错误、SystemError系统错误
  • Value: U8 - PCIe设备是否发生错误, 取值: 0-未发生,1-发生

返回值

  • Status: U8 - 错误事件属性状态

SetBandwidthReduction

设置PCIE降带宽事件属性

参数

  • Segment: U8 - 用于多PCI Bridge场景的编号,每一个Segment对应一个PCI Bus空间
  • Bus: U8 - PCIe设备的总线号
  • Device: U8 - PCIe设备的设备号
  • Function: U8 - PCIe设备的功能号
  • Value: U8 - 带宽事件属性值

返回值

  • Status: U8 - 设置降带宽事件属性状态

SetUCEByBIOS

设置PCIE设备BIOS上报的UCE故障

参数

  • Segment: U8 - 用于多PCI Bridge场景的编号,每一个Segment对应一个PCI Bus空间
  • Bus: U8 - PCIe设备的总线号
  • Device: U8 - PCIe设备的设备号
  • Function: U8 - PCIe设备的功能号
  • Value: U8 - 上报的UCE故障值

返回值

  • Status: U8 - 设置上报的UCE故障状态

SetDiagnosticFault

设置故障标志位

参数

  • Segment: U8 - 用于多PCI Bridge场景的编号,每一个Segment对应一个PCI Bus空间
  • SocketID: U8 - PCIe设备所属CPU ID
  • Bus: U8 - PCIe设备的总线号
  • Device: U8 - PCIe设备的设备号
  • Function: U8 - PCIe设备的功能号
  • Value: U8 - 故障标志位值

返回值

  • Status: U8 - 设置故障标志位状态

SetPredictiveFault

设置预故障告警标志位

参数

  • Segment: U8 - 用于多PCI Bridge场景的编号,每一个Segment对应一个PCI Bus空间
  • SocketID: U8 - PCIe设备所属CPU ID
  • Bus: U8 - PCIe设备的总线号
  • Device: U8 - PCIe设备的设备号
  • Function: U8 - PCIe设备的功能号
  • Value: U8 - 预故障告警标志位值

返回值

  • Status: U8 - 预故障告警标志位状态

GetDeviceName

根据SSBDF获取设备丝印名

参数

  • Segment: U8 - 用于多PCI Bridge场景的编号,每一个Segment对应一个PCI Bus空间
  • SocketID: U8 - PCIe设备所属CPU ID
  • Bus: U8 - PCIe设备的总线号
  • Device: U8 - PCIe设备的设备号
  • Function: U8 - PCIe设备的功能号

返回值

  • Status: U8 - 获取设备丝印名状态
  • DeviceName: String - 设备丝印名称

GetPCIeCardNum

获取pcie卡数量

返回值

  • PCIeCardNum: U32 - PCIe卡数量

SetFaultByBios

设置PCIERAID卡BIOS上报故障状态

参数

  • Bus: U8 - PCIe设备的总线号
  • Device: U8 - PCIe设备的设备号
  • Function: U8 - PCIe设备的功能号
  • FaultStatus: U8 - PCIe 卡故障状态

返回值

  • Status: U8 - 设置PCIERAID卡BIOS上报故障状态

SetLinkSpeedReduced

设置PCIe设备降速率事件属性

参数

  • Segment: U8 - 用于多PCI Bridge场景的编号,每一个Segment对应一个PCI Bus空间
  • Bus: U8 - PCIe设备的总线号
  • Device: U8 - PCIe设备的设备号
  • Function: U8 - PCIe设备的功能号
  • Value: U8 - PCIe设备降速率事件属性值

返回值

  • Status: U8 - 设置PCIe设备降速率事件属性状态

SetPCIeSlots

批量设置PCIe设备槽位号

参数

  • SlotSettings: SlotSettingDict - 字典,键为PcieAddrInfo对象的Path,用于定位需要更新的槽位对象;值为修改后的槽位ID,取值范围[0-254]

==自定义类型==


SlotSettingDict: 结构体类型

  • key: String - PcieAddrInfo对象的Path,用于定位需要更新的槽位对象
  • value: U8 - 修改后的槽位ID,取值范围[0-254],硬盘无效值为255

bmc.kepler.Systems.PCIeDevices.EthDevice

==属性==

属性名类型可读写信号通知描述
PortIdU8只读变更广播网口的物理编号,每张网卡从0开始
LaneIdU8只读变更广播网口的逻辑lane编号,每张网卡从0开始
SegmentU8只读变更广播用于多PCI Bridge场景的编号,每一个Segment对应一个PCI Bus空间
SocketIDU8只读变更广播网卡对应的CPU ID
ControllerIndexU8只读变更广播网卡对应的Eth控制器ID
BusU8只读变更广播网口设备的Bus
DeviceU8只读变更广播网口设备的Device
FunctionU8只读变更广播网口设备的Function
PortFunctionIdU8只读变更广播网口设备的PortFunctionId

bmc.kepler.Systems.PCIeDevices.PCIeCard

==属性==

属性名类型可读写信号通知描述
NameString只读变更广播产品名称(SP580等)
SlotIDU8只读变更广播槽位号
DeviceNameString只读变更广播设备资源名称
FunctionClassU8只读变更广播功能分类(0:未知、1:RAID、2:网卡、3:GPU卡、4:存储卡(SSD卡/M.2卡)、5:SDI卡、6:加速卡、7:扩展卡(PCIe Riser)、8:FPGA卡、9:NPU卡)
DescriptionString只读变更广播描述
PcbVersionString只读变更广播PCB版本
BoardIDU16只读变更广播单板ID(仅自研卡涉及)
BoardNameString只读变更广播单板名称(仅自研卡涉及)
LinkWidthAbilityString只读变更广播最大链路带宽
LinkWidthString只读变更广播链路带宽
LinkSpeedCapabilityString只读变更广播最大链路速率
LinkSpeedString只读变更广播链路速率
VendorIDU16只读变更广播制造商ID
DeviceIDU16只读变更广播设备ID
SubVendorIDU16只读变更广播子厂商ID
SubDeviceIDU16只读变更广播子设备ID
PositionString只读变更广播位置信息(容器信息)
ManufacturerString只读变更广播厂商
LaneOwnerU8只读变更广播资源归属,起始值为1,表示当前卡挂在哪个CPU下
FirmwareVersionString只读变更广播固件版本
PartNumberString只读变更广播部件编码
SerialNumberString只读变更广播序列号
RefComponentString只读变更广播关联部件对象
HealthU8只读变更广播健康状态
ModelString只读变更广播PCIe卡的型号
NodeIDString只读变更广播通过PCIe卡所在容器和槽位得到的唯一标识符
PresenceU8只读变更广播在位状态
CardModelString只读变更广播PCIe设备型号
CardManufacturerString只读变更广播PCIe设备制造商
CardForServersU8[]只读变更广播PCIe设备服务的系统Id列表

bmc.kepler.Systems.PCIeDevices.PCIeDevice

==属性==

属性名类型可读写信号通知描述
SlotIDU8只读变更广播槽位号
SegmentU8只读变更广播用于多PCI Bridge场景的编号,每一个Segment对应一个PCI Bus空间
SocketIDU8只读变更广播CPU ID
BusU8只读变更广播root port Bus
DeviceU8只读变更广播root port Device
FunctionU8只读变更广播root port Function
DevBusU8只读变更广播设备总线
DevDeviceU8只读变更广播设备的 Device
DevFunctionU8只读变更广播设备的 Function
DiagnosticFaultU8只读变更广播严重故障诊断告警状态
PredictiveFaultU8只读变更广播预故障告警状态
UCEByBIOSU8只读变更广播BIOS上报不可纠正错误标识,相当于V2 fatalerror
BandwidthReductionU8只读变更广播PCIE降带宽检测失败上报事件属性
LinkSpeedReducedU8只读变更广播PCIe设备降速率检测告警上报事件属性(BIOS上报)
FunctionClassU8只读变更广播PCIe设备的功能分类
DeviceNameString只读变更广播设备资源名称
PositionString只读变更广播设备位置(容器名称)
FaultByBiosU8只读变更广播Bios上报的异常状态
SlotTypeString只读变更广播PCIe槽位类型
FunctionProtocolString只读变更广播PCIe功能协议
FunctionTypeString只读变更广播PCIe功能类型
PCIeTypeString只读变更广播PCIe设备所在槽位使用的规范版本
MaxPCIeTypeString只读变更广播PCIe设备本身能支持的最高协议版本
NegotiatedPCIeTypeString只读变更广播PCIe设备实际协商的协议版本
PCIeDeviceTypeString只读变更广播PCIe设备类型
BaseClassCodeU8只读变更广播PCIe设备功能的基类码
SubClassCodeU8只读变更广播PCIe设备功能的子类码
ProgrammingInterfaceU8只读变更广播PCIe设备功能的编程接口

bmc.kepler.Systems.PCIeDevices.PCIeDevice.RAS

==属性==

属性名类型可读写信号通知描述
CorrectableErrorU8只读变更广播PCIe设备发生可纠正错误, 取值: 0-未发生, 1-发生
UncorrectableErrorU8只读变更广播PCIe设备发生不可纠正错误, 取值: 0-未发生,1-发生
FatalErrorU8只读变更广播PCIe设备发生致命错误, 取值: 0-未发生,1-发生
ParityErrorU8只读变更广播PCIe设备发生奇偶校验错误, 取值: 0-未发生,1-发生
SystemErrorU8只读变更广播PCIe设备发生系统错误, 取值: 0-未发生,1-发生
FatalErrorCountU32读写变更广播PCIe设备致命错误计数
NonFatalErrorCountU32读写变更广播PCIe设备非致命错误计数
BadDLLPCountU32读写变更广播最近一次上电期间BadDLLP错误累计值
BadTLPCountU32读写变更广播最近一次上电期间BadTLP错误累计值
UnsupportedRequestCountU32读写变更广播最近一次上电期间UnsupportedRequest错误累计值
CorrectableErrorOverfrequencyCountU32读写变更广播系统运行周期内,PCIe设备CE故障发生频率超门限的计数。取值范围:0~0xFFFFFFFF,默认值0。系统上下电/复位时,统计次数清零。
TimeoutErrorU8读写变更广播PCIe设备发生超时错误,取值: 0-未发生,1-发生,默认值0。系统上下电/复位时,属性恢复默认值0。

bmc.kepler.Systems.PCIeSlot

==属性==

属性名类型可读写信号通知描述
SlotIdU8只读变更广播槽位号,在csr中配置
SupportedComponentTypesU8[]只读变更广播槽位支持的组件类型,在csr中配置,元素取值范围与资源协作接口bmc.kepler.Systems.Component的Type属性一致
PowerStateString只读变更广播槽位供电状态,Off:不供电 On:供电
ReadyToEnumerateBoolean只读变更广播表示当前PCIe槽位是否已准备好枚举PCIe设备,为true表示可以将此槽位的归属CPU端口信息和丝印信息传递给BIOS用于PCIe设备枚举。

==方法==


PowerControl

控制槽位电源供电状态

参数

  • PowerState: String - Off:设置为Off表示槽位电源关闭;On:设置为On表示槽位电源开启

bmc.kepler.Systems.PcieAddrInfo

==属性==

属性名类型可读写信号通知描述
GroupIDU8只读变更广播逻辑组ID
SlotIDU8只读变更广播槽位id
PortIDU8只读变更广播pcie槽位对应的portId,用于上报bios槽位与portid对应的关系,计算对应槽位的rootBDF
ComponentTypeU8只读变更广播部件类型,与Component类的中的部件类型属性对应。(标准定义,如:8:PCIe标卡、13:NCI卡、83:OCP卡)
ControllerIndexU8只读变更广播PCIe控制器索引,CPU内部同类型控制器的索引,从0开始编号
ControllerTypeU8只读变更广播PCIe控制器类型(0:PCIeCore,1:NIC,2:SAS,3:SATA,4:ZIP,5:SEC)
SocketIDU8只读变更广播CPU ID
SegmentU8只读变更广播用于多PCI Bridge场景的编号,每一个Segment对应一个PCI Bus空间
BusU8只读变更广播root port Bus号
DeviceU8只读变更广播root port Device号
FunctionU8只读变更广播root port Function号
VendorIDU16只读变更广播供应商id
DeviceIDU16只读变更广播设备id
LanesU8只读变更广播PCIe插槽支持的最大PCIe通道数
PCIeTypeString只读变更广播PCIe插槽支持的最高PCIe规范版本
SlotTypeString只读变更广播PCIe插槽类型
ReadyToEnumerateBoolean只读变更广播表示当前PCIe槽位是否已准备好枚举PCIe设备,为true表示可以将此槽位的归属CPU端口信息和丝印信息传递给BIOS用于PCIe设备枚举。

bmc.kepler.Systems.Pmu

==属性==

属性名类型可读写信号通知描述
SystemIdU8只读变更广播系统Id
StatusU8只读变更广播状态
PmuTypeU8只读变更广播Pmu类型
PmuVersionString只读变更广播Pmu版本
SFPMaxTemperatureU16只读变更广播光模块最大温度

==方法==


Reset

复位Imu

返回值

  • Result: U8 - 复位Imu结果

GetPcieVidDid

获取PCIe设备的制造商ID和设备ID

参数

  • SystemId: U8 - 系统Id
  • IsLocal: Boolean - 是否访问PCI本地空间
  • CpuId: U8 - CPU索引号
  • Bus: U8 - PCIe设备的总线号
  • Device: U8 - PCIe设备的设备号
  • Function: U8 - PCIe设备的功能号

返回值

  • VendorId: U16 - 返回制造商ID
  • DeviceId: U16 - 返回设备ID

GetPcieSubVidDid

获取PCIe设备的子制造商ID和子设备ID

参数

  • SystemId: U8 - 系统Id
  • IsLocal: Boolean - 是否访问PCI本地空间
  • CpuId: U8 - CPU索引号
  • Bus: U8 - PCIe设备的总线号
  • Device: U8 - PCIe设备的设备号
  • Function: U8 - PCIe设备的功能号

返回值

  • VendorId: U16 - 返回制造商ID
  • DeviceId: U16 - 返回设备ID

bmc.kepler.Systems.PowerAction

==属性==

属性名类型可读写信号通知描述
PowerOnTimeoutFlagU8读写变更广播上电超时状态

bmc.kepler.Systems.PowerMgmt

==属性==

属性名类型可读写信号通知描述
IsManufacturerMismatchBoolean只读变更广播服务器多个输入电源模块的厂商是否一致匹配
IsModelMismatchBoolean只读变更广播服务器多个输入电源模块的型号是否一致匹配

bmc.kepler.Systems.PowerMgmt.OnePower

==属性==

属性名类型可读写信号通知描述
SlotNumberU32只读变更广播槽位号
ManufacturerString只读变更广播厂商
ModelString只读变更广播电源型号
PowerSupplyTypeU32只读变更广播电源模块的供电类型,0:DC; 1:AC; 2: ACorDC; 3: Unknown
PresenceU8只读变更广播在位状态,0:不在位,1:在位
PowerSupplyChannelU8只读变更广播电源供电电路,0:主路 1:备路
SerialNumberString只读变更广播序列号
PartNumberString只读变更广播部件编码
FirmwareVersionString只读变更广播电源固件版本
ProtocolString只读变更广播电源协议
DeviceLocatorString只读变更广播物理位置
ProductionDateString只读变更广播生产日期
WorkModeString只读变更广播单个电源主备工作模式(主用:Enabled,备用:StandbySpare)
PositionString只读变更广播容器信息
TotalRunningHoursU32只读变更广播总运行时间
RedundancyGroupIdU8只读变更广播电源冗余组ID,非0值代表此电源冗余,0值代表电源不是冗余电源组的一员
InputVoltageTypeU8只读变更广播交直流模式 0:DC; 1:AC
DMTFPowerSupplyTypeU8只读变更广播DMTF电源类型: 1 Other;2 Unknown;3 Linear; 4 Switching; 5 Battery; 6 UPS; 7 Converter; 8 Regulator
SourceTypeU8只读变更广播功率读数来源,0:chip(功率传感器芯片,如INA220); 1:PSU(电源MCU)
IsPartOfSysPowerBoolean只读变更广播是否参与整机功耗计算,true:功耗纳入整机功耗计算,false:功耗不纳入整机功耗计算
LineInputVoltageTypeString只读变更广播电源模块支持的供电类型
RelaySwitchedCountU16只读变更广播电源内部继电器切换次数,仅适用于机柜管理场景双输入电源
DeepSleepStandbyPowerWattsU16只读变更广播电源模块深度休眠状态下的待机功耗
InputNumU8只读变更广播电源供电线路数量,1:单路供电 2:双路供电

==方法==


SetPowerWorkMode

设置电源工作模式

参数

  • PowerWorkMode: U8 - 电源工作模式,1:设置为备用,0:设置为主用

返回值

  • CmdResult: U8 - 命令执行结果,0:设置成功,1:设置失败

Reset

电源复位设置

参数

  • ResetType: String - 复位类型

SetPowerSupplyCircuit

设置电源供电线路

参数

  • PowerSupplyCircuit: U8 - 0:主电路供电,1:备电路供电

bmc.kepler.Systems.PowerMgmt.OnePower.EfficiencyCurve

==属性==

属性名类型可读写信号通知描述
EfficiencyCurveArray只读变更广播电源转换效率曲线,键值表示电源负载百分比,值表示对应负载下的转换效率
PowerLevelString只读变更广播电源模块等级, 80PLUS:白牌;80PLUS Bronze:铜牌;80PLUS Silver:银牌;80PLUS Gold:金牌;80PLUS Platinum:白金牌;80PLUS Titanium:钛金牌;N/A:未知

==自定义类型==


EfficiencyCurveObject: 结构体类型

  • LoadPercent: U8 - 电源负载百分比
  • EfficiencyValue: Double - 电源转换效率

bmc.kepler.Systems.PowerMgmt.OnePower.Metrics

==属性==

属性名类型可读写信号通知描述
RateU16只读变更广播额定功率,单位:瓦特(W)
InputVoltageDouble只读变更广播输入电压
OutputVoltageDouble只读变更广播输出电压
InputCurrentAmpsDouble只读变更广播输入电流
OutputCurrentAmpsDouble只读变更广播输出电流
InputPowerWattsDouble只读变更广播单电源输入功率
OutputPowerWattsDouble只读变更广播单电源输出功率
RatedCurrentAmpsU16只读变更广播额定电流
InputFrequencyHzDouble只读变更广播电源频率,交流显示频率 直流显示为0

bmc.kepler.Systems.PowerMgmt.OnePower.Status

==属性==

属性名类型可读写信号通知描述
HealthU8只读变更广播电源模块状态,0:正常,非0:异常
IsUpgradingBoolean只读变更广播电源升级标识(false:未升级,true:升级中)
OutputStateU8只读变更广播电源电压输出状态(0为异常,1为正常)
NormalAndRedundancySupportedBoolean只读变更广播是否支持N+R(true:支持,false:不支持)
SleepModeString只读变更广播电源休眠模式(Normal,DeepSleep)
InputVoltageFaultU16只读变更广播电压输入状态(bit7:Vin_Ov_Fault, bit6:Vin_Ov_Warning, bit5:Vin_Uv_Warning, bit4:Vin_Uv_Fault),无效值32768,EVENT不处理
OutputVoltageFaultU8只读变更广播电压输出状态(bit7:Vout_Ov_Fault, bit6:Vout_Ov_Warning, bit5:Vout_Uv_Warning, bit4:Vout_Uv_Fault)
OutputCurrentFaultU8只读变更广播电流输出状态(bit7:Iout_Oc_Fault, bit5:Iout_Oc_Warning)
FanFaultU8只读变更广播风扇状态(bit7:Fan1_Fault, bit5:Fan1_Warning, bit3:Fan1_Speed_Override)
Fan1FaultU8只读变更广播风扇1故障 0:无故障; 1:有故障(pmbus 只有一个风扇状态,pmbus8100 区分Fan1/2)
Fan2FaultU8只读变更广播风扇2故障 0:无故障; 1:有故障
OverTemperatureU8只读变更广播过温故障 0:无故障; 1:有故障
FailureU8只读变更广播电源故障 0:无故障; 1:有故障
LossOfInputU8只读变更广播输入故障 0:无故障; 1:有故障
DeepSleepEnabledU8只读变更广播电源深度休眠使能(供告警使用) 0:未使能, 1:使能
ScanStatusU8只读变更广播电源信息采集任务执行情况(bit0:电源功率轮询,bit1:电源输入/输出 电流/电压查询,bit2:电源模式查询)0表示该属性未获取过,1表示获取过
InputVoltageStatusU8只读变更广播输入电压过欠压、掉电状态,0x00:表示正常(默认);0x01:表示过压;0x02:表示欠压;0x03:表示掉电;
DualInputVoltageStatusU16只读变更广播双通道输入电压状态:0x0000表示正常(默认),0x0010表示A路欠压,0x0020表示A路预欠压,0x0040表示A路预过压,0x0080表示A路过压,0x1000表示B路欠压,0x2000表示B路预欠压,0x4000表示B路预过压,0x8000表示B路过压
CommunicationStatusU8只读变更广播电源通信状态,0:正常,1:故障
MfrSpecificStatusU8只读变更广播电源厂商自定义状态
EquipmentModeU8只读变更广播电源装备模式, 0: 装备模式, 1: 非装备模式, 255: 未知(默认)
CMLStatusU8只读变更广播监测电源模块核心子系统健康状态:内部通信,存储,逻辑故障(bit0:非存储类逻辑错误,bit1:非标准通信异常,bit2:保留位,bit3:固件运行异常,bit4:非易失性存储器故障,bit5:包校验失败,bit6:无效数据,bit7:无效命令;bit间不互斥)
OtherStatusU8只读变更广播监测电源辅助子系统及环境异常:电气异常,热故障等特殊场景(bit0:保留位,bit1:输出OR-ing器件失效,bit2:输入B OR-ing器件失效,bit3:输入A OR-ing器件失效,bit4:输入B 熔断器/断路器触发,bit5:输入A 熔断器/断路器触发,bit6:保留位,bit7:保留位;bit间不互斥)
TPSUStatusHighU32只读变更广播TPSU状态位高4字节,按bit定义状态,仅适用于机柜管理场景双输入电源
TPSUStatusLowU32只读变更广播TPSU状态位低4字节,按bit定义状态,仅适用于机柜管理场景双输入电源
MainCircuitVINStatusU8只读变更广播电源主路供电的输入状态,取值:0:输入正常,1:输入过压,2:输入欠压,3:输入掉电,255:未知状态
BackupCircuitVINStatusU8只读变更广播电源备路供电的输入状态,取值:0:输入正常,1:输入过压,2:输入欠压,3:输入掉电,255:未知状态
ExtendedPowerStatusLowU32只读变更广播扩展电源状态低4字节,按bit定义状态,适用于现有属性无法承载电源状态的场景
ExtendedPowerStatusHighU32只读变更广播扩展电源状态高4字节,按bit定义状态,适用于现有属性无法承载电源状态的场景

==方法==


SetSleepMode

设置电源休眠模式

参数

  • SleepMode: String - 电源休眠模式:Normal或DeepSleep

返回值

  • CmdResult: U8 - 命令执行结果,0:设置成功,1:设置失败

SetAlarmLatch

设置电源告警锁存开关

参数

  • SwitchStatus: U8 - 电源告警锁存开关,0:告警不锁存, 1:告警锁存

bmc.kepler.Systems.PowerMgmt.OnePower.Temperatures

==属性==

属性名类型可读写信号通知描述
InletTemperatureCelsiusDouble只读变更广播进风口温度
InnerTemperatureCelsiusDouble只读变更广播出风口温度
EnvTemperatureCelsiusDouble只读变更广播单个电源的环境温度
PrimaryChipTemperatureCelsiusDouble只读变更广播电源内部器件温度(原边)
SecondaryChipTemperatureCelsiusDouble只读变更广播电源内部器件温度(副边)

bmc.kepler.Systems.PowerOnLock

==属性==

属性名类型可读写信号通知描述
PwrOnLockedBoolean只读变更广播是否满足上电条件
ReasonsString[]只读变更广播不允许上电的原因,KVM呈现,记录所有原因

==方法==


SetPowerOnLock

系统上电锁

参数

  • PwrOnLocked: Boolean - 是否上电锁定:true:锁定 false:解锁
  • Timeout: U32 - 有效的超时时间(单位1s)范围10~3600s
  • AppName: String - 模块App名
  • Reason: String - 增加上电锁的原因描述

返回值

  • CmdResult: U8 - 函数执行结果

bmc.kepler.Systems.PowerStrategy

==属性==

属性名类型可读写信号通知描述
PowerWorkingModeString只读变更广播电源工作模式
PowerActualWorkingModeString只读变更广播电源实际工作模式
PowerLimitValueU32只读变更广播功耗封顶值
PowerLimitEnabledBoolean只读变更广播功耗封顶使能
ExpectedActivePSUU8[]只读变更广播期望的主用电源列表
MaxPowerLimitInWattsU32只读变更广播功耗封顶上限值
MinPowerLimitInWattsU32只读变更广播功耗封顶下限值
WorkModeConfigurableBoolean只读变更广播是否支持电源工作模式
PowerLimitFailedBoolean只读变更广播功耗封顶是否失败
PowerLimitActivatedBoolean只读变更广播功耗封顶策略是否触发
PowerLimitExceptionSupportedBoolean只读变更广播是否支持功耗封顶失败动作
PowerCappingFailureOptionsString[]只读变更广播功耗封顶失败之后支持的动作选项,取值为LogEventOnly、NoAction、Reset、HardPowerOff中的一个或多个,PowerLimitExceptionSupported为false时,取值应为[]
PowerLimitExceptionLogEventBoolean读写变更广播是否支持功耗封顶失败动作记录事件日志
PowerLimitExceptionString读写变更广播功耗封顶失败动作,包括不操作、重启且记录事件日志、下电且记录事件日志
DeepSleepString读写变更广播深度休眠使能
PowerLimitWhenSteadyBoolean读写变更广播功耗封顶是否受限于BMC初始化完成
NormalAndRedundancyString只读变更广播N+R使能
DeepSleepSupportedBoolean只读变更广播是否支持电源深度休眠功能
NormalAndRedundancySupportedBoolean只读变更广播是否支持N+R备电功能
ActiveStandbySupportedBoolean只读变更广播是否支持电源主备模式功能
PowerCappingSupportedBoolean只读变更广播是否支持功耗封顶功能
PowerPredictSupportedBoolean只读变更广播是否支持节能收益预测功能
EnergyEfficiencyOptimizationSupportedBoolean只读变更广播是否支持智能能效寻优
EnergySavingSupportedBoolean只读变更广播是否支持节能功能
PSUsOutputVoltageLowBoolean只读变更广播N+R压差是否异常
RedundancyFailureBoolean只读变更广播冗余失效
PresetLimitInWattsU32读写变更广播预设功率封顶值
HighPowerThresholdWattsDouble只读变更广播功耗告警阈值
PowerLimitModeString只读变更广播功耗封顶模式,取值为Equal或Proportion
PSUsUnavailableOfflineCauseU32只读变更广播电源不可用原因,bit0:电源输入丢失,京东定制电源线未插报电源冗余告警时使用
PSUsOutputCurrentImbalanceBoolean只读变更广播电源均流不平衡
RedundancyModeU16只读变更广播系统电源冗余模式, 高字节代表主用电源数, 低字节代表冗余电源数量, 例:0x0301表示3+1冗余
PowerCappingControlModeU8只读变更广播功耗封顶控制模式, 0:主控模式,1:受控模式

==方法==


SetPowerWorkingMode

设置电源工作模式

参数

  • PowerWorkingMode: String - 电源工作模式
  • ActivePowerSuppliesList: U8[] - 主用电源列表

SetPowerLimitValue

设置功耗封顶值

参数

  • PowerLimitValue: U32 - 功耗封顶值

SetPowerLimitEnabled

设置功耗封顶使能

参数

  • PowerLimitEnabled: Boolean - 功耗封顶使能

SetNormalAndRedundancy

设置N+R使能

参数

  • NormalAndRedundancy: String - N+R使能

UpdateGetPowerInfoTimeStamp

更新最近一次iRM功耗管理请求时间


SetPowerLimitMode

设置功耗封顶模式

参数

  • PowerLimitMode: String - 功耗封顶模式

SetPowerLimitException

设置功耗封顶失败动作

参数

  • Action: String - 功耗封顶失败动作

GetPowerLimitException

查询功耗封顶失败动作,失败动作包括LogEventOnly、NoAction、Reset、HardPowerOff

返回值

  • Action: String - 功耗封顶失败动作

bmc.kepler.Systems.Processor

==属性==

属性名类型可读写信号通知描述
ProcessorTypeString只读变更广播处理器类型
SystemIdU8只读变更广播系统Id
IdU8只读变更广播Id
NameString只读变更广播名字
PresenceU8只读变更广播在位信息
InstructionSetString只读变更广播指令集
ArchitectureString只读变更广播芯片架构
ManufacturerString只读变更广播厂商
FamilyString只读变更广播处理器家族
ModelString只读变更广播产品型号
PartNumberString只读变更广播部件号
SNString只读变更广播序列号
FirmwareVersionString只读变更广播固件版本
SocketDesignationString只读变更广播槽位
PositionString只读变更广播容器:buc、pcie卡等
ThermalTripU8读写变更广播CPU的过热保护状态
HealthU8只读变更广播健康状态
ReplaceableBoolean只读变更广播此部件是否可以作为独立的部件进行替换

bmc.kepler.Systems.Processor.CPU

==属性==

属性名类型可读写信号通知描述
PhysicalIdU8只读变更广播物理ID
LogicalIdU8只读变更广播逻辑ID
MaxSpeedMHzU32只读变更广播最大转速
CurrentSpeedMHzU32只读变更广播当前转速
ProcessorIDU32只读变更广播处理器标识数据,按照SMBIOS规范定义,处理器标识数据长度为8字节,此属性位宽不足,因此已被弃用,改用此接口下的ProcessorIDString属性
ProcessorIDStringString只读变更广播处理器标识数据,字符串格式为XX-XX-XX-XX-XX-XX-XX-XX,X表示16进制数字
TotalCoresU32只读变更广播总核数
TotalEnabledCoresU32只读变更广播可用核数
TotalThreadsU32只读变更广播总线程
L1CacheU32只读变更广播一级缓存
L2CacheU32只读变更广播二级缓存
L3CacheU32只读变更广播三级缓存
CharacteristicsString只读变更广播特性
TemperatureCelsiusDouble读写变更广播温度(摄氏度)
MaxMemoryTemperatureCelsiusDouble读写变更广播最大温度
MaxMemoryTSensorTemperatureCelsiusS16读写变更广播最大TSensor温度(摄氏度)
MaxMemoryTemperatureNameString读写变更广播CPU下挂的最高温度内存标识
DiagnosticFaultU8读写变更广播严重故障诊断告警状态
PredictiveFaultU8读写变更广播预故障告警状态
CATERRU8只读变更广播宕机信号
DeviceLocatorString只读变更广播处理器资源的丝印,以系统维度中的CPU个数。
ProcessorHotU8只读变更广播CPU的内核过热保护状态,确认是否通用
EnabledBoolean只读变更广播启用状态
PowerGoodU8只读变更广播电源状态
IsMemoryPresenceU8只读变更广播CPU下是否存在在位的内存,存在为1,否则为0
PowerWattDouble只读变更广播CPU功率
TotalEnabledThreadsU32只读变更广播使能的超线程数
SilkTextString只读变更广播处理器资源的板上丝印
BaseSpeedMHzU32只读变更广播处理器的基本(标称)时钟速度,以MHz为单位

bmc.kepler.Systems.Processor.GPU

==属性==

属性名类型可读写信号通知描述
InfoRomVersionString只读变更广播InfoRom版本
SlotString只读变更广播槽位号
VendorIDU16只读变更广播厂商Id
DeviceIDU16只读变更广播设备ID
SubVendorIDU16只读变更广播子系统厂商Id
SubDeviceIDU16只读变更广播子系统设备Id
GPUUtilizationU16只读变更广播GPU 利用率(%)
MemoryUtilizationU16只读变更广播GPU 内存利用率(%)
BoardPartNumberString只读变更广播单板部件号
MemoryVendorString只读变更广播内存厂商
MemoryPartNumberString只读变更广播内存部件号
BuildDateString只读变更广播构建时间
UUIDString只读变更广播通用唯一标识符
PrimaryGPUTemperatureCelsiusDouble只读变更广播主处理器温度

bmc.kepler.Systems.Processor.GPU.Power

==属性==

属性名类型可读写信号通知描述
PowerWattsU16只读变更广播功率
PowerBrakeSetU8只读变更广播power brake状态
ExternalPowerSufficientU8只读变更广播外部供电是否充足

bmc.kepler.Systems.Processor.GPU.Status

==属性==

属性名类型可读写信号通知描述
ECCModeEnabledU8只读变更广播ECC模式当前使能状态
ECCModePendingEnabledU8只读变更广播ECC模式重启后使能状态
ResetRequiredU8只读变更广播是否需要重启
DoubleBitErrorPageCountU32只读变更广播双bit失效故障页个数
SingleBitErrorPageCountU32只读变更广播单bit失效故障页个数
NvLinkInfoArray只读变更广播连接状态、Replay错误计数、Recovery错误计数、流控CRC错误计数、数据CRC错误计数

==自定义类型==


NvLinkInfoItem: 结构体类型

  • LinkStatus: String - 连接状态
  • ReplayErrorCount: U32 - Replay错误计数
  • RecoveryErrorCount: U32 - Recovery错误计数
  • FlowControlCRCErrorCount: U32 - 流控CRC错误计数
  • DataCRCErrorCount: U32 - 数据CRC错误计数

bmc.kepler.Systems.Processor.MemorySummary.Metrics

==属性==

属性名类型可读写信号通知描述
PowerWattsU32只读变更广播处理器附属内存的总功耗

bmc.kepler.Systems.Processor.NPU

==属性==

属性名类型可读写信号通知描述
TotalMemoryKiBU32只读变更广播片上内存-总内存大小
MemoryUsageKiBU32只读变更广播片上内存-内存已用大小
MemoryFreeKiBU32只读变更广播片上内存-内存剩余大小
CapabilitySupportMaskU32只读变更广播能力支持掩码
MemoryCapacityKiBU32只读变更广播板卡NPU芯片-内存容量
MultiBitEccString只读变更广播多bit ECC信息
SingleBitEccString只读变更广播单bit ECC信息
AiCPUUsagePercentU16只读变更广播AiCpu使用率(%)
HBMBWUsagePercentU16只读变更广播HBM带宽使用率(%)
MemBWUsagePercentU16只读变更广播内存带宽使用率(%)
HBMUsagePercentU16只读变更广播HBM容量使用率(%)
MemUsagePercentU16只读变更广播内存容量使用率(%)
AiCoreUsagePercentU16只读变更广播核心网使用百分比
AiCoreMaxSpeedMHzU16只读变更广播Ai Core占用率(%)
AiCoreCurrentSpeedMHzU16只读变更广播Ai Core当前主频,单位:MHz
CtrlCPUUsagePercentU16只读变更广播ctrl CPU 占用率
ComputeCapabilityString只读变更广播芯片算力规格
ComputeCapabilitiesArray只读变更广播NPU芯片计算能力集合,包含支持的计算精度和对应算力
NimBusTempU16只读变更广播芯片外围设备NimBus温度
AiCoreTempU16只读变更广播AiCore计算核心温度
HBMTempU16只读变更广播HBM内存温度
PowerOnU8只读变更广播开机
PowerStateString只读变更广播NPU芯片上下电状态, 当前取值: Off、PoweringOff、On、PoweringOn
PowerCapacityWattsU32只读变更广播板卡NPU芯片-额定功耗
PowerConsumedWattsU16只读变更广播板卡NPU芯片-实际功耗
VoltU32只读变更广播npu电压,单位nV
PowerU16只读变更广播功耗,单位W
VRDChipTempU16只读变更广播VRD chip温度
BDFString只读变更广播BDF编号
RootBDFString只读变更广播芯片BDF
MemoryBandWidthU32只读变更广播板卡NPU芯片-额定带宽
ReadingCelsiusU16只读变更广播板卡NPU芯片-实际温度
IerrU8只读变更广播NPU宕机异常汇聚信号 0:正常 1:异常
PredictiveFaultU8读写变更广播预故障告警状态
DiagnosticFaultU8读写变更广播严重故障诊断告警状态
ECCAlarmStatusU8只读变更广播NPU ECC错误告警状态 2-严重告警(NPU ECC历史计数超门限值64) 1-事件 (NPU ECC历史计数超门限值32) 0-NPU ECC历史计数超门限值的情况未发生
IErrFlagU32只读变更广播NPU宕机异常汇聚信号 0:正常 1:异常
VendorIDU16只读变更广播槽位号
VersionString只读变更广播版本
DriverVersionString只读变更广播驱动版本
FaultCodeString只读变更广播NPU带内故障码
PowerCapWattsU16只读变更广播NPU模组功耗封顶值,单位W
TotalCoresU32只读变更广播NPU核数
LocationString只读变更广播NPU所属抽屉信息
FlashIdsU64[]只读变更广播NPU的flashid列表
SlotU8只读变更广播NPU的物理槽位信息
HBMSingleBitIsolatedPagesU32只读变更广播HBM 单Bit错误隔离次数
HBMMultiBitIsolatedPagesU32只读变更广播HBM 多Bit错误隔离次数
FailureCodeU64只读变更广播NPU上报的器件故障失效码,bitmap结构,默认值0,由低到高每个bit位置1代表特定器件故障失效

==方法==


GetEccInfo

获取NPU HBM Ecc信息

参数

  • Id: U8 - NPU编号,和硬件丝印匹配

返回值

  • SingleBitEcc: String - 单bit Ecc信息, Json字符串格式
  • MultiBitEcc: String - 多bit Ecc信息, Json字符串格式
  • SingleBitIsolatedPages: String - 单bit 隔离页信息, Json字符串格式
  • MultiBitIsolatedPages: String - 多bit 隔离页信息, Json字符串格式

DumpLog

收集NPU运行或者黑匣子日志

参数

  • LogType: String[] - 日志类型,支持的日志类型包括:Blackbox、Device
  • OutputFilePath: String - 日志导出路径,支持本地导出、远程导出

返回值

  • TaskId: U32 - 收集日志的任务ID

==自定义类型==


ComputeCapabilityItem: 结构体类型

  • Precision: String - 计算精度
  • CapabilityValue: Double - 算力数值
  • CapabilityUnits: String - 算力单位

bmc.kepler.Systems.Processor.NPUs

==方法==


DumpNpuLog

收集NPU日志

参数

  • NpuId: U8 - NPU芯片编号

返回值

  • TaskId: U32 - 收集日志的任务ID

bmc.kepler.Systems.Processor.Port

==属性==

属性名类型可读写信号通知描述
IdU8只读变更广播处理器端口逻辑ID,从0开始
PortIdString只读变更广播端口硬件定义标识符
IODieIdU8只读变更广播此端口归属的IO Die ID

bmc.kepler.Systems.Processor.ProcessorMemory

==属性==

属性名类型可读写信号通知描述
CapacityMiBU32只读变更广播内存容量,单位MiB
IntegratedMemoryBoolean只读变更广播是否集成在处理器内,true表示集成内存,false表示附加内存
MemoryTypeString只读变更广播内存类型
SpeedMHzU32只读变更广播内存工作时钟频率,单位MHz

bmc.kepler.Systems.Processor.ProcessorMetrics

==属性==

属性名类型可读写信号通知描述
BandwidthPercentU8只读变更广播此类处理器的整体占用率(%)
BandwidthThresholdPercentU8只读变更广播此类处理器整体占用率过高告警的门限值(%)
ConsumedPowerWattU32只读变更广播此类处理器的总功耗

==方法==


SetBandwidthThreshold

设置此类处理器整体占用率过高告警的门限值

参数

  • BandwidthThresholdPercent: U8 - 整体占用率过高告警的门限值(%)

返回值

  • Result: S32 - 整体占用率过高告警门限值的设置结果

GetBandwidthHistory

获取此类处理器整体占用率的历史数据

返回值

  • History: String - 处理器整体占用率的历史数据

ClearBandwidthHistory

清除此类处理器整体占用率的历史数据


bmc.kepler.Systems.Product

==属性==

属性名类型可读写信号通知描述
ProductNameString只读变更广播产品名称
ProductAliasString读写变更广播产品别名
ProductPictureString只读变更广播产品web界面展示图片名称
ProductVendorIDString只读变更广播产品厂商ID
ProductIdU32只读变更广播产品ID
ProductUniqueIDString只读变更广播产品唯一识别ID
ProductVersionString读写变更广播产品版本
LanguageSetString[]读写变更广播当前开启的语言集

==方法==


RetireSystem

产品报废处置

参数

  • PreserveLog: Boolean - 是否保存报警、维护和故障诊断日志

返回值

  • TaskId: U32 - 任务标识

GetRetirementStatus

获取报废处置任务状态信息

返回值

  • Status: String - 整体任务状态
  • Progress: U8 - 整体任务进度
  • Details: TaskStateDict - 子任务状态信息

==自定义类型==


TaskStateDict: 结构体类型

  • key: String - 子任务名称
  • value: String - 子任务状态

bmc.kepler.Systems.Product.Custom

==属性==

属性名类型可读写信号通知描述
OemDataU8[]读写变更广播第三方共享信息,对外提供设置和查询接口
ManufacturerString读写变更广播定制化厂商名称, redfish接口OEM厂商字段, 默认为Huawei
SmsNameString读写变更广播带内管理软件名称, 默认iBMA
ManufacturerOidString读写变更广播定制化厂商Oid, snmp接口Oid厂商字段, 默认为2011.2.235.1.1
CustomerRedfishVersionString读写变更广播客户Redfish规范版本信息,默认为空

bmc.kepler.Systems.Product.Device

==属性==

属性名类型可读写信号通知描述
NameString只读变更广播设备名称
SerialNumberString只读变更广播设备序列号
OwnerIdString只读变更广播设备所有者ID

bmc.kepler.Systems.Product.DigitalWarranty

==属性==

属性名类型可读写信号通知描述
StartPointString读写变更广播服务起始时间, 用户可配置, 默认生产日期生成的服务起始时间为1996-04-10
LifespanU8读写变更广播服务年限,用户可配置
FirstPowerOnTimeString只读变更广播服务器首次上电时间, 根据生产日期生成, 格式为: YYYY-MM-DD

bmc.kepler.Systems.Pump

==属性==

属性名类型可读写信号通知描述
IdU16只读变更广播泵ID
SlotU8只读变更广播槽位
ModelString只读变更广播型号
PartNumberString只读变更广播部件号
ExpectedPWMDouble只读变更广播预期的PWM值
ActualPWMDouble只读变更广播实际PWM值
MaxSupportedPWMU32只读变更广播泵全速额定PWM值
SpeedRPMU16只读变更广播泵转速(转/分钟)
MaxSpeedRPMU32只读变更广播泵全速额定转速(转/分钟)
PresenceU8只读变更广播1在位,0不在位
StatusU8只读变更广播泵状态,0:正常,1:转速异常,2:在位异常,3:停转
ManufacturerString只读变更广播泵的制造商
PhysicalContextString只读变更广播泵适用的区域或设备
ProductionDateString只读变更广播生产日期
SerialNumberString只读变更广播序列号
ServiceLabelString只读变更广播泵的位置标签
LocationReferenceString只读变更广播泵的位置参考
PumpTypeString只读变更广播泵的类型

bmc.kepler.Systems.Pumps

==属性==

属性名类型可读写信号通知描述
WorkInStandbyU8只读变更广播standby下是否可以运转,1:可以,0:不可以

==方法==


SetPWM

设置所有泵转速

参数

  • PWM: Double[] - 要设置的转速占空比数组

返回值

  • Result: U8 - 返回结果,0:设置成功;1:设置失败

bmc.kepler.Systems.Retimer

==属性==

属性名类型可读写信号通知描述
ChipNameString只读变更广播芯片名称
ChipTypeU8只读变更广播芯片类型:0为5902L、1为5902H、2为5901、3为ds280
FirmwareVersionString只读变更广播retimer版本号
ChipLocationString只读变更广播芯片位置号(丝印)
TemperatureCelsiusS16只读变更广播retimer的温度
DieIDString只读变更广播芯片 DIEID
HealthStatusU8只读变更广播芯片健康状态:0为正常,1为异常

bmc.kepler.Systems.SOC.BlackBox

==方法==


Dump

黑匣子信息转储

参数

  • Length: U32 - 读取数据长度, 单位Byte
  • Filename: String - 指定数据输出文件名

bmc.kepler.Systems.SecureBootOptions

==属性==

属性名类型可读写信号通知描述
SystemIdU8只读变更广播系统Id
CertificateExpiredU8只读变更广播证书过期标记

==方法==


ImportCertificate

导入Bios的安全启动证书

参数

  • DatabseType: String - 数据库类型 db、dbx
  • CertString: String - Bios的安全启动证书内容
  • CertType: String - Bios的安全启动证书类型

ResetCertificate

重置Bios安全启动证书

参数

  • DatabseType: String - 数据库类型 db、dbx
  • ResetType: String - 重置Bios安全启动证书类型

GetCertificate

获取Bios安全启动证书

返回值

  • CertInfo: String - Bios安全启动证书内容

bmc.kepler.Systems.SecurityModule

==属性==

属性名类型可读写信号通知描述
PresenceU8只读变更广播在位情况
HealthU8只读变更广播健康状态
ProtocolString只读变更广播协议类型
ManufacturerString只读变更广播厂商名称
ProtocolVersionString只读变更广播协议版本
FirmwareVersionString只读变更广播固件版本

bmc.kepler.Systems.SmBios

==属性==

属性名类型可读写信号通知描述
SerialNumberString只读变更广播SmBios序列号
VersionString只读变更广播SmBios版本
SKUNumberString只读变更广播SmBios SKU编号
FamilyString只读变更广播处理器家族
SmBiosStatusU8只读变更广播SmBios状态
SmBiosUpdatedFlagU8只读变更广播SmBios状态更新标记
FileChangeU8只读变更广播SmBios文件变化标记
FileNameString只读变更广播SmBios文件名
DiffFileNameString只读变更广播SmBios差异文件名
SystemIdU8只读变更广播系统Id

bmc.kepler.Systems.SmartProvision

==属性==

属性名类型可读写信号通知描述
MajorVersionString只读变更广播SmartProvision主版本号
MinorVersionString只读变更广播SmartProvision次版本号
LogicalDriveStateAbnormalU8只读变更广播系统中逻辑盘的状态,存在异常状态的逻辑盘时为1,不存在时为0

bmc.kepler.Systems.Sms

==属性==

属性名类型可读写信号通知描述
ChannelTypeU8只读变更广播通道类型,0:虚拟网卡 1:字符设备 2:USB
IdU8只读变更广播系统ID
RegisteredBoolean只读变更广播注册状态
NameString只读变更广播带内代理注册的名字
VersionString只读变更广播带内代理的版本号
TypeString只读变更广播带内代理注册的类型
IsSupportedBoolean只读变更广播带内代理使能状态,主要用于前端显示
WhiteListString只读变更广播带内代理设置的白名单,决定了那些接口可以透传
DriverVersionString只读变更广播带内代理驱动版本号,主要用于前端显示
CdevChannelEnabledBoolean只读变更广播字符设备通道打开关闭,默认ture

==方法==


SetForwardWhiteList

设置BMC直接访问BMA资源的白名单

参数

  • Request: String - 白名单列表

返回值

  • Response: String - 函数调用结果

ForwardRequest

BMC请求BMA资源透传转发接口

参数

  • Request: String - 请求参数,如url等
  • RetryTimes: U8 - 请求重试次数

返回值

  • Response: String - 函数调用结果

ForwardEvent

BMC订阅BMA资源变更事件后,事件上报接口

参数

  • RequestMethod: String - 请求方法, GET、POST等
  • RequestToken: String - 带内token
  • RequestBody: String - BMA传入的请求体

返回值

  • ResponseStatusCode: U32 - HTTP请求返回码

UpdateSpecificResource

更新指定类型的资源

参数

  • ResourceType: String - 资源类型

返回值

  • Response: String - 资源更新处理结果

SetChannelType

设置BOB通道类型,以及是否需要持久化

参数

  • ChannelType: U8 - 通道类型, 0:虚拟网卡 1:字符设备 2:USB
  • IsPowerOffPer: Boolean - 是否持久化

GetChannelType

获取BOB channel类型

参数

  • IsPowerOffPer: Boolean - 是否获取持久化属性

返回值

  • ChannelType: U8 - 通道类型

SetCdevChannelEnabled

带外设置cdev通道使能

参数

  • Enabled: Boolean - 是否使能

bmc.kepler.Systems.Sms.AgentPort

==属性==

属性名类型可读写信号通知描述
LocalPortU16只读变更广播BMC作为客户端,且通道不为Veth时,net_nat服务监听的本地回环口的端口
ServerPortU16只读变更广播BMC作为客户端时,BMA作为服务端的端口号
ServiceTypeString只读变更广播服务类型可选参数,可选:Snmp,Https

bmc.kepler.Systems.Sms.AgentPorts

==属性==

属性名类型可读写信号通知描述
ServerMaxPortU16读写变更广播BMC作为客户端,通道为VETH时,BMA为服务端的最大端口号
ServerMinPortU16读写变更广播BMC作为客户端,通道为VETH时,BMA为服务端的最大端口号

bmc.kepler.Systems.Sms.SmsStatus

==属性==

属性名类型可读写信号通知描述
RunningStateString只读变更广播Sms运行状态,用于前端页面展示
UpdateStateU8只读变更广播Sms资源更新状态,0:no start 1:update complete 2:update default
StateU8只读变更广播带内代理状态,0:正常 1:异常
HeartBeatStateU8只读变更广播心跳状态,0:正常 1:异常

bmc.kepler.Systems.Sms.Veth

==属性==

属性名类型可读写信号通知描述
PortU32只读变更广播带内代理支持的虚拟网口端口
IpAddrString只读变更广播带内代理支持的虚拟网口的IP端口
ProtocolTypeU8只读变更广播带内协议类型, 0表示HTTP, 1表示HTTPS, 默认是 HTTPS 协议
EnabledBoolean读写变更广播虚拟网口的使能状态, true: 使能, false: 禁用; 默认为true
FirewallModeString读写变更广播veth网口通信黑白名单模式, 取值范围包括[WhiteList, BlackList], 默认值为BlackList
WhiteListPortsU16[]读写变更广播veth网口允许访问的端口列表, 每个元素取值范围 1~65535, 最多50个元素
BlackListPortsU16[]读写变更广播veth网口禁止访问的端口列表, 每个元素取值范围 1~65535, 最多50个元素

bmc.kepler.Systems.Storage.Battery

==属性==

属性名类型可读写信号通知描述
NameString只读变更广播BBU名称
StateU8只读变更广播BBU在位信息
FaultU8只读变更广播BBU故障标志
HealthStatusU32只读变更广播bit0:电压过低,bit1:需要更换BBU,bit2:电量校准失败,bit3:电量校准超时,bit4:预故障,bit5:剩余容量低,bit6:没有用于缓存卸载的空间,others:resrved
HealthU8只读变更广播BBU健康状态
TemperatureCelsiusS16只读变更广播BBU温度

bmc.kepler.Systems.Storage.Controller

==属性==

属性名类型可读写信号通知描述
IdU8只读变更广播控制器Id, 由软件生成,默认值0xFF
TypeString只读变更广播控制器类型
NameString只读变更广播控制器名称
TemperatureCelsiusS16只读变更广播控制器芯片温度
TemperatureAbnormalU8只读变更广播温度异常描述,温度获取失败时置1
OOBSupportU8只读变更广播支持带外管理模式,0:不支持带外;1:支持带外
FirmwareVersionString只读变更广播控制器固件版本
SupportedModeString[]只读变更广播控制器工作模式
MemorySizeMiBU16只读变更广播控制器内存大小,单位MB
DeviceInterfaceString只读变更广播控制器设备接口
SASAddrString只读变更广播控制器SAS地址
SerialNumberString只读变更广播控制器序列号
MaxStripSizeBytesU32只读变更广播控制器支持的最大条带
MinStripSizeBytesU32只读变更广播控制器支持的最小条带
NVDataVersionString只读变更广播控制器配置版本
MaintainPDFailHistroryU8只读变更广播是否启用控制器的物理盘故障记忆功能
PCIeLinkWidthString只读变更广播控制器的PCIE带宽
UnconfiguredDriveWriteCachePolicyString只读变更广播非RAID组成员盘的写缓存策略:Enabled,Disabled,Default
HBADriveWriteCachePolicyString只读变更广播HBA模式下硬盘的写缓存策略:Enabled,Disabled,Default
ConfiguredDriveWriteCachePolicyString只读变更广播RAID组成员盘的写缓存策略:Enabled,Disabled,Default
SupportedRAIDTypesString[]只读变更广播RAID级别
SmarterCopyBackStateU8只读变更广播RAID控制器在检测到物理盘SMART错误之后是否自动进行Copyback
CopyBackStateU8只读变更广播指定控制器的回拷功能使能状态
BootDevicesString[]只读变更广播控制器的启动设备列表
HardwareRevisionString只读变更广播控制器的硬件版本
UncorrectableParityErrorCountU32只读变更广播控制器内存生命周期内不可纠正奇偶校验错误的数量
HotSpareActivationModeString只读变更广播控制器的热备激活模式:Failure,Predictive,Unknown
NoBatteryWriteCacheEnabledU8只读变更广播控制器的无电池写缓存模式
ReadCachePercentU8只读变更广播控制器的读缓存百分比,取值范围:0~100
JBODStateU8只读变更广播控制器的JBOD功能状态:false,true
CachePinnedStateU8只读变更广播控制器的Cache Pinned开关
DDREccCountU16只读变更广播DDR ECC计数
WorkModeString只读变更广播控制器的工作模式, 包括RAID、HBA、JBOD和MIXED四种
RefDrivesString[]只读变更广播控制器下挂载的所有硬盘名
CryptoEraseSupportedBoolean只读变更广播驱动器是否支持加密盘数据擦除
EpdSupportedBoolean只读变更广播控制器是否支持启用硬盘模式增强
TypeIdU8只读变更广播控制器的类型Id
DeviceNameString只读变更广播对应的PCIeDevice的设备名
BOMNumberString只读变更广播BOM编码
PositionString只读变更广播对应的PCIeDevice的位置
JbodSupportedBoolean只读变更广播当前控制器是否支持以直通方式管理硬盘,此属性由系统自动获取,禁止外部设置
SlowDriveDetectionModeU8读写变更广播慢盘检测开关模式,0-关闭,1-开启裸盘、成员盘慢盘检测,2-开启裸盘慢盘检测,3-开启成员盘慢盘检测,0xff-默认不支持
SupportedBootDeviceCountU8只读变更广播表示RAID卡支持的启动盘数量

==方法==


SetBootDevices

设置控制器的启动盘设备

参数

  • PriorityDriveName: String - 设备1名称
  • SecondaryDriveName: String - 设备2名称

SetBootDevicesV2

批量设置启动盘,设备按数组顺序表示优先级

参数

  • BootDevices: String[] - 启动盘设备数组,数组元素为逻辑盘或物理硬盘的设备名。数组长度最大为可支持的启动盘数量

SetJBODState

设置控制器的JBOD功能状态

参数

  • State: U8 - 状态 0:Disable 1:Enable

SetSmarterCopyBackState

设置RAID控制器在检测到物理盘SMART错误之后是否自动进行Copyback

参数

  • State: U8 - 状态 0:Disable 1:Enable

RestoreDefaultSettings

恢复控制器的默认配置


SetCopybackState

设置控制器的回拷功能

参数

  • State: U8 - 状态 0:Disable 1:Enable

SetMaintainPDFailHistoryState

用于设置RAID卡硬盘故障记忆功能的开启或者关闭

参数

  • State: U8 - 状态 0:关闭 1:开启

SetWorkMode

设置控制器的工作模式, Mode的取值为0:RAID, 1:HBA, 2:RAID, 3:MIXED; ProfileId的取值为0

参数

  • Mode: U8 - 工作模式: Mode的取值为0:RAID, 1:HBA, 2:RAID, 3:MIXED
  • ProfileId: U8 - 配置文件的IP, 取值为0

ImportForeignConfig

一键导入外部配置


DumpLog

收集RAID控制器信息

返回值

  • TaskId: U32 - 任务ID

ClearForeignConfig

一键清除外部配置


SetNoBatteryWriteCache

设置控制器无电池写缓存状态

参数

  • NoBatteryWriteCacheEnabled: U8 - 0-Disable, 1-Enable

SetReadCachePercent

设置控制器读缓存百分比

参数

  • ReadCachePercent: U8 - 取值范围:0~100

SetWriteCachePolicy

设置控制器写缓存策略

参数

  • Type: String - RAID卡下的硬盘管理类型
  • WriteCachePolicy: String - 写缓存策略

bmc.kepler.Systems.Storage.Controller.BatteryStatus

==属性==

属性名类型可读写信号通知描述
BatteryPresenceU8只读变更广播控制器下挂载的电池在位信息
BatteryFaultU8只读变更广播控制器下挂载的电池故障信息
BatteryHealthU8只读变更广播控制器下挂载的电池健康信息

bmc.kepler.Systems.Storage.Controller.Chip

==属性==

属性名类型可读写信号通知描述
ModelString只读变更广播raid卡芯片型号
ChipManufacturerString只读变更广播raid卡芯片厂商

bmc.kepler.Systems.Storage.Controller.ConsistencyCheck

==属性==

属性名类型可读写信号通知描述
StateU8只读变更广播RAID控制器一致性校验功能状态
PeriodOfHoursU16只读变更广播RAID控制器一致性校验周期,单位(小时), 取值范围[1:1440]
RateString只读变更广播RAID控制器一致性校验速率
AutoRepairEnabledU8只读变更广播RAID控制器一致性校验自修复开关
RunningStatusString只读变更广播RAID控制器一致性校验状态
TotalVolumeCountsU16只读变更广播RAID控制器一致性校验需要校验的总数量
CompletedVolumeCountsU16只读变更广播RAID控制器一致性校验运行已经完成的数量
DelayToStartU32只读变更广播RAID控制器一致性校验任务的等待开始时间,取值范围[0:24],时间单位:h

==方法==


Enable

打开控制器的一致性校验功能

参数

  • Period: U16 - RAID控制器一致性校验周期,单位(小时), 取值范围[1:1440]
  • Rate: U8 - RAID控制器一致性校验速率
  • AutoRepairedEnabled: U8 - 自动修复启用使能
  • DelayToStart: U32 - RAID控制器一致性校验任务的等待开始时间,取值范围[0:24],时间单位:h

Disable

关闭控制器的一致性校验功能


SetParameters

设置控制器的一致性校验信息

参数

  • Period: U16 - RAID控制器一致性校验周期,单位(小时), 取值范围[1:1440]
  • Rate: U8 - RAID控制器一致性校验速率
  • AutoRepairedEnabled: U8 - 自动修复启用使能

bmc.kepler.Systems.Storage.Controller.ControllerStatus

==属性==

属性名类型可读写信号通知描述
FaultCodeU16只读变更广播控制器的故障码
CommunicationLossU8只读变更广播控制器通信丢失标志
HealthU8只读变更广播控制器健康状态
FaultCodeByBiosU8只读变更广播BIOS上报的硬件故障错误码。0:正常;非0:故障

bmc.kepler.Systems.Storage.Controller.Driver

==属性==

属性名类型可读写信号通知描述
NameString只读变更广播控制器驱动器名称
VersionString只读变更广播控制器驱动器版本

bmc.kepler.Systems.Storage.Controller.VolumeManage

==属性==

属性名类型可读写信号通知描述
CreateVolumeSupportedBoolean只读变更广播控制器是否支持创建逻辑盘
SupportedReadPolicyListString[]只读变更广播支持的逻辑盘读策略列表
DefaultReadPolicyString只读变更广播默认的逻辑盘读策略
ReadPolicyWritableBoolean只读变更广播支持修改逻辑盘读策略
SupportedWritePolicyListString[]只读变更广播支持的逻辑盘写策略列表
DefaultWritePolicyString只读变更广播默认的逻辑盘写策略
WritePolicyWritableBoolean只读变更广播支持修改逻辑盘写策略
SupportedIOPolicyListString[]只读变更广播支持的逻辑盘IO策略列表
DefaultIOPolicyString只读变更广播默认的逻辑盘IO策略
IOPolicyWritableBoolean只读变更广播支持修改逻辑盘IO策略
SupportedAccessPolicyListString[]只读变更广播支持的逻辑盘访问策略列表
DefaultAccessPolicyString只读变更广播默认的逻辑盘访问策略
AccessPolicyWritableBoolean只读变更广播支持修改逻辑盘访问策略
SupportedDriveCachePolicyListString[]只读变更广播支持的逻辑盘硬盘缓存策略列表
DefaultDriveCachePolicyString只读变更广播默认的逻辑盘硬盘缓存策略
DriveCachePolicyWritableBoolean只读变更广播支持修改逻辑盘硬盘缓存策略

==方法==


CreateVolumeInNewArray

用全新阵列创建逻辑盘

参数

  • DriveLists: U8[] - 设备列表
  • RaidType: U8 - raid卡类型
  • SpanDepth: U8 - 阵列的数量
  • Name: String - 创建逻辑盘的名称
  • Capacity: U32 - 容量
  • CapacityUnit: U8 - 容量单位
  • StripSize: U8 - 条带大小
  • ReadPolicy: U8 - 逻辑盘读策略
  • WritePolicy: U8 - 逻辑盘写策略
  • IOPolicy: U8 - 逻辑盘IO策略
  • AccessPolicy: U8 - 逻辑盘访问策略
  • DiskCachePolicy: U8 - 硬盘Cache策略
  • InitType: U8 - 初始化类型
  • Accelerator: U8 - 加速方法

返回值

  • TaskId: U32 - 任务ID

DeleteVolume

删除指定逻辑盘

参数

  • VolumeId: U16 - 存储卷ID

返回值

  • TaskId: U32 - 任务ID

CreateVolumeInExisingtArray

在已有阵列上创建逻辑盘

参数

  • ArrayId: U16 - 阵列ID
  • BlockIndex: U8 - 块索引
  • RaidType: U8 - raid卡类型
  • SpanDepth: U8 - 阵列的数量
  • Name: String - 创建逻辑盘的名称
  • Capacity: U32 - 容量
  • CapacityUnit: U8 - 容量单位
  • StripSize: U8 - 条带大小
  • ReadPolicy: U8 - 逻辑盘读策略
  • WritePolicy: U8 - 逻辑盘写策略
  • IOPolicy: U8 - 逻辑盘IO策略
  • AccessPolicy: U8 - 逻辑盘访问策略
  • DiskCachePolicy: U8 - 硬盘Cache策略
  • InitType: U8 - 初始化类型
  • Accelerator: U8 - 加速方法

返回值

  • TaskId: U32 - 任务ID

CreateCachecadeVolume

创建cachecade逻辑盘

参数

  • DriveLists: U8[] - 设备列表
  • RaidType: U8 - raid卡类型
  • Name: String - 创建逻辑盘的名称
  • WritePolicy: U8 - 逻辑盘写策略
  • ArrayId: U16 - 阵列ID
  • Capacity: U32 - 容量
  • CapacityUnit: U8 - 容量单位
  • AssociateLd: U16 - 关联逻辑盘
  • CacheLineSize: U8 - 缓存行大小

返回值

  • TaskId: U32 - 任务ID

bmc.kepler.Systems.Storage.Diagnose

==属性==

属性名类型可读写信号通知描述
PhyErrorEnabledBoolean读写变更广播PHY误码诊断使能
PhyErrorIntervalU32读写变更广播PHY误码数据采集的时间间隔,单位秒
PhyErrorMaxRecordU8读写变更广播PHY误码在一个OS启动周期内记录的最大条数(有增长的记录)
PhyErrorThresholdU32读写变更广播PHY误码单位时间增长过快的判断门限值
MaxPhyErrorLogFileRotationCountU8读写变更广播PHY误码循环记录的最大文件数
PhyErrorSelUnlimitFlagBoolean读写变更广播PHY误码是否允许产生多个SEL告警事件

bmc.kepler.Systems.Storage.DiskArray

==属性==

属性名类型可读写信号通知描述
IdU16只读变更广播RAID组的序号,由RAID卡读到
UsedSpaceMiBU32只读变更广播RAID组的已使用的空间
TotalFreeSpaceMiBU32只读变更广播RAID组的空闲空间
FreeBlocksSpaceMiBU32[]只读变更广播RAID组的空闲块容量列表
RefVolumesU16[]只读变更广播RAID组的关联逻辑盘列表,例:[145, 144]
RefDrivesString[]只读变更广播RAID组的关联物理盘列表,例:[Disk0, Disk1]
AverageDriveFreeSpaceMiBU32只读变更广播指定驱动器阵列中每个驱动器的剩余容量
DriveNumPerSpanU8只读变更广播驱动器阵列中每个Span的成员的个数
RAIDTypeString只读变更广播驱动器阵列组成的虚拟磁盘的级别
RefControllerIdU8只读变更广播RAID组关联的控制器ID

bmc.kepler.Systems.Storage.DiskPartition

==属性==

属性名类型可读写信号通知描述
NameString只读变更广播os盘符
UsageU8只读变更广播磁盘分区利用率
TotalCapacityGiBDouble只读变更广播硬盘分区总容量
UsedCapacityGiBDouble只读变更广播硬盘分区当前使用容量

bmc.kepler.Systems.Storage.Drive

==属性==

属性名类型可读写信号通知描述
NodeIdString只读变更广播资源的唯一Id
IdU8只读变更广播硬盘Id, 由软件生成,默认值0
SlotNumberU8只读变更广播硬盘槽位号
NameString只读变更广播硬盘名称,Disk1,NMVeDisk1等
PresenceU8只读变更广播硬盘在位状态,0不在位,1在位
CapacityMiBU32只读变更广播硬盘容量,以MiB为单位
TemperatureCelsiusS16只读变更广播硬盘温度,硬盘存在零下负温场景
ModelString只读变更广播硬盘型号,比如MBF2300RC
EnclosureIdU16只读变更广播硬盘所在背板的id,由控制器分配
LocationIndicatorStateU8只读变更广播硬盘定位状态,根据locate寄存器和fault寄存器判断
LocateLedU8只读变更广播硬盘locate寄存器的值
FaultLedU8只读变更广播硬盘fault寄存器的值
ProtocolU8只读变更广播硬盘接口类型:0:Unknown,1:parallel.SCSI,2:SAS,3:SATA,4:FC
CapableSpeedGbsU8只读变更广播硬盘接口速率(最大速率)
NegotiatedSpeedGbsU8只读变更广播硬盘连接速率(协商速率)
MediaTypeU8只读变更广播硬盘介质类型:0:HDD,1:SSD,2:SSM,255:Unknown
FirmwareStatusU8只读变更广播硬盘固件状态
SerialNumberString只读变更广播硬盘序列号
ManufacturerString只读变更广播硬盘厂商
PowerOnHoursDouble只读变更广播硬盘通电时间
RevisionString只读变更广播硬盘固件版本
RotationSpeedRPMU16只读变更广播硬盘转速
BlockSizeBytesU16只读变更广播硬盘块大小
SASAddress1String只读变更广播硬盘SAS地址的第一部分
SASAddress2String只读变更广播硬盘SAS地址的第二部分
PredictedMediaLifeLeftPercentU8只读变更广播硬盘剩余磨损率,即剩余擦写次数的百分比(0-100,或者255表示无效)
PredictedFailCountU32只读变更广播硬盘预故障错误统计
MediaErrorCountU32只读变更广播硬盘媒介错误统计
OtherErrorCountU32只读变更广播硬盘其他错误统计
PatrolStateU8只读变更广播硬盘巡检状态:0:没有巡检或巡检结束,1:巡检中,255:未知
PowerStateU8只读变更广播物理盘的节能休眠状态,0:非休眠状态,1:休眠状态,2:过渡状态
SlotPowerStateU8只读变更广播物理盘槽位电源状态,0:下电,1:上电,255:未知
RebuildStateU8只读变更广播硬盘重构状态:0:没有重建或重建结束,1:重建中,255:未知
RebuildProgressU8只读变更广播硬盘重构进度
BootPriorityU8只读变更广播硬盘启动盘优先级
FormFactorU8只读变更广播硬盘尺寸: 0:Unknown, 1:5.25 inch, 2:3.5 inch, 3:2.5 inch, 4:1.8 inch, 5:Less than 1.8 inch, 6:mSATA, 7:M.2, 8:MicroSSD, 9:CFast
HotspareTypeU8只读变更广播硬盘热备状态
RefControllerIdU8只读变更广播关联的控制器Id
RefVolumeListU16[]只读变更广播关联的逻辑盘Id列表
RefDiskArrayIdU16只读变更广播关联的硬盘阵列Id
ManufacturerIdU32只读变更广播厂商Id
PCIeLinkSpeedDouble只读变更广播PCIe单个通道的速率
LocationString只读变更广播表示当前盘的物理位置
DeviceNameString只读变更广播表示当前盘的设备名称
ResourceIdU8只读变更广播表示当前盘的资源归属
ContainerPhysicalContextString只读变更广播表示当前硬盘所在背板在机箱相对位置,目前仅支持Front、Inner、Rear,分别表示在机箱前、中、后部
SystemDiskU8只读变更广播表示当前盘是否系统盘,0:非系统盘,1:系统盘,默认值255

==方法==


SetLocationIndicatorState

设置物理盘的定位灯状态

参数

  • LocationIndicatorState: U8 - 定位指示灯状态 0 = Off 1 = Blinking

SetFaultIndicatorState

设置物理盘的故障灯状态

参数

  • FaultIndicatorState: U8 - 故障指示灯状态 0 = Off 1 = Blinking

SetFirmwareStatus

设置物理盘的固件状态

参数

  • FirmwareStatus: U8 - 固件状态

SetHotspareType

设置物理盘是否为热备盘

参数

  • HotspareType: U8 - 驱动器的热备状态 0 = None 1 = Global 2 = Dedicated
  • VolumeId: U16 - 存储卷ID

SetBootPriority

设置物理盘的启动优先级

参数

  • BootPriority: U8 - 启动优先级 0 = None 1 = Primary

SetPatrolState

设置物理盘的巡检状态

参数

  • PatrolState: U8 - 巡检状态 0 = stop 1 = run

CryptoErase

支持设置物理盘被加密擦除


SetSlotPowerState

设置物理盘槽位的电源状态

参数

  • SlotPowerState: String - 要对物理盘槽位执行的上下电操作,ForceOff:强制下电,ForceOn:强制上电

bmc.kepler.Systems.Storage.Drive.AddrInfo

==属性==

属性名类型可读写信号通知描述
TypeString只读变更广播硬盘的丝印类型
SocketIdU8只读变更广播硬盘的CPU归属
SlotIdU8只读变更广播硬盘的槽位号
PortIdU8只读变更广播硬盘的端口号
RootBDFString只读变更广播硬盘的BDF

bmc.kepler.Systems.Storage.Drive.Diagnose

==方法==


CollectDiagnoseData

通过指定信息收集硬盘诊断数据

参数

  • DiagnoseDataType: String[] - 用于指定收集的具体诊断数据类型

返回值

  • TaskId: U32 - 任务Id

GetDiagnoseData

根据指定信息获取不同的硬盘诊断数据

参数

  • DiagnoseDataType: String[] - 用于指定获取的具体诊断数据类型

返回值

  • DiagnoseData: Data - 获取到的诊断数据

==自定义类型==


Data: 结构体类型

  • key: String
  • value: String

bmc.kepler.Systems.Storage.Drive.DriveStatus

==属性==

属性名类型可读写信号通知描述
MissingU16只读变更广播硬盘丢失标志
PredictiveFailureU8只读变更广播预故障标志
InAFailedArrayU8只读变更广播是否处于一个故障的硬盘阵列。0:否,1:是
CapacityErrorBoolean只读变更广播硬盘容量是否异常
FirmwareStatusErrorBoolean只读变更广播硬盘固件状态是否异常
FailureBoolean只读变更广播硬盘是否故障
HealthU8只读变更广播硬盘健康状态

bmc.kepler.Systems.Storage.Drive.DriveSubHealth

==属性==

属性名类型可读写信号通知描述
EstimatedRemainingLifespanInsufficientU8只读变更广播硬盘预估剩余寿命不足
SLCSpareBlockPercentageU8只读变更广播非用户区剩余冗余块百分比
TLCSpareBlockPercentageU8只读变更广播用户区剩余冗余块百分比
EstimatedRemainingLifespanU32只读变更广播硬盘预估剩余寿命
IODeteriorationHealthCodeU16只读变更广播硬盘IO性能健康码
FailurePredictedBoolean读写变更广播硬盘是否发生预测性故障,true:发生预测性故障,false:未发生预测性故障

bmc.kepler.Systems.Storage.Drive.NVMe

==属性==

属性名类型可读写信号通知描述
LifeUsedPercentageU8只读变更广播驱动器寿命百分比

==方法==


GetSmartInfo

通过标准NVMe-mi协议获取SMART/Health Information

参数

  • Vendor: U16 - 指定smart信息为标准协议还是自定义,标准格式传0,自定义传厂商自定义标识

返回值

  • MessageResponse: U8[] - 响应报文, 小端字节序排列

SendNvmeMICommand

按照标准NVMe-mi协议发送NVMe-MI Command格式命令,请求参数可以参照协议第5章Management Interface Command Set的请求报文填充

参数

  • Opcode: U8 - 该字段指定要处理的NVMe-MI Command格式的操作码
  • Dword0: U32 - 该字段为特定命令的 Dword 0
  • Dword1: U32 - 该字段为特定命令的 Dword 1
  • RequestData: U8[] - 预留请求字节, 小端字节序排列

返回值

  • Status: U8 - 该字段为命令的响应码
  • NVMeResponse: U32 - 该字段为特定命令响应
  • ResponseData: U8[] - 预留响应字节, 小端字节序排列

GetTelemetryData

通过标准NVMe-mi协议获取Telemetry Host/Controller-initiated

参数

  • DataType: String - 指定收集硬盘host或controller的日志,取值范围:Host/Controller

返回值

  • TaskId: U32 - 任务标识

GetIdentifyData

通过标准NVMe-mi协议获取Identify command信息

参数

  • CNSValue: U8 - 指定Controller or Namespace Structure决定该命令返回的数据结构,参考协议的Identify – CNS Values图表定义

返回值

  • MessageResponse: U8[] - 响应报文, 小端字节序排列

bmc.kepler.Systems.Storage.Drive.NVMe.SMART

==属性==

属性名类型可读写信号通知描述
AvailableSpareU8只读变更广播驱动器可用冗余空间的百分比(0到100)
CriticalWarningU8只读变更广播控制器状态的重要的告警,bit0:表示冗余空间小于设定的阈值,bit1:表示温度超过或低于一个重要的阈值,bit2:表示由于重要的media错误,器件的可靠性已经降低,bit3:该介质已经被置为只读模式,bit4:表示控制器的易失性器件fail,该域仅在控制器内部存在易失性器件时有效,bit5-7:保留
UsedPercentageU8只读变更广播用户实际使用和厂家设定的器件寿命的百分比(0到100)
StatusU8只读变更广播SMART告警状态

bmc.kepler.Systems.Storage.Drive.SAS.SMART

==属性==

属性名类型可读写信号通知描述
StripTemperatureCelsiusU32只读变更广播驱动器条带温度(摄氏度)
ElementsInGrownDefectListU32只读变更广播增长缺陷列表(G表)中的元素
ElementsInPrimaryDefectListU32只读变更广播主缺陷列表(P表)中的元素
ManufacturedInWeekOfYearString只读变更广播生产日期:年中周
BlocksSentToInitiatorU32只读变更广播发送到启动器的块
BlocksReceivedFromInitiatorU32只读变更广播从启动器收到的块
UntilNextInterSMARTTestMinutesU32只读变更广播距下一次内部SMART测试的时长(分钟)
LastPrefailEventSeqNumU32只读变更广播最后一次预测故障事件的序列号

bmc.kepler.Systems.Storage.Drives

==属性==

属性名类型可读写信号通知描述
MaxTemperatureCelsiusU8只读变更广播驱动器最高温度,用于风扇调速
LogAutoCollectEnableBoolean读写变更广播硬盘日志自动收集开启状态
LogAutoCollectIntervalU8读写变更广播硬盘日志自动收集周期

==方法==


CollectIODeteriorationDiagInfo

设置启动收集硬盘IO性能诊断信息

返回值

  • TaskId: U32 - 任务Id

GetDrivesSubHealthDiagInfo

获取硬盘IO性能诊断信息列表

参数

  • SubHealthType: String - 硬盘亚健康数据类型

返回值

  • SubHealthDiagInfoList: Array - 硬盘亚健康诊断信息列表

GetNvmeDriveRawData

获取NVMe盘的信息

参数

  • index: U16 - Nvme盘序号

返回值

  • NvmeDriveData: String - Nvme盘信息数据

GetNvmeDriveCount

获取NVMe盘的数量

返回值

  • NvmeDriveCount: U16 - Nvme盘数量

SetDriveSubHealthDiagResult

设置硬盘IO性能健康码

参数

  • SubHealthDiagResult: Array - 硬盘亚健康信息诊断结果列表,必选参数:(DriveName:硬盘名称)可选参数:(EstimatedRemainingLifespan:硬盘预估寿命告警码,EstimatedRemainingLifespan:硬盘预估剩余寿命,IODeteriorationHealthCode:硬盘I/O性能健康码)

StartCollectLog

手动触发收集硬盘日志

参数

  • DriveName: String - 硬盘名称

==自定义类型==


DriveList: 结构体类型

  • key: U32
  • value: DiagInfoList

DiagInfoList: 结构体类型

  • key: String
  • value: String

KeyValueTable: 结构体类型

  • Key: String
  • Value: String

bmc.kepler.Systems.Storage.PhyError

==属性==

属性名类型可读写信号通知描述
PhyIdU8只读变更广播PHY误码Id
InvalidDwordCountU32只读变更广播无效DWORD数
LossDwordSyncCountU32只读变更广播丢失DWORD同步数
PhyResetProblemCountU32只读变更广播PHY重启问题数
RunningDisparityErrorCountU32只读变更广播连续不均衡性错误数

bmc.kepler.Systems.Storage.ReplicaDrive

==属性==

属性名类型可读写信号通知描述
IdU8只读变更广播复制后的硬盘编号
SerialNumberString只读变更广播复制后的硬盘序列号
TemperatureCelsiusU8只读变更广播复制后的硬盘温度

bmc.kepler.Systems.Storage.SASMetrics

==属性==

属性名类型可读写信号通知描述
ControllerIdU8只读变更广播关联的控制器序号
InvalidDwordCountU32只读变更广播无效DWORD数
LossDwordSyncCountU32只读变更广播丢失DWORD同步数
PhyResetProblemCountU32只读变更广播PHY重启问题数
RunningDisparityErrorCountU32只读变更广播连续不均衡性错误数

bmc.kepler.Systems.Storage.StorageConfig

==属性==

属性名类型可读写信号通知描述
StorageConfigReadyU8只读变更广播用于控制器配置导入导出场景,标志了所有控制器的状态
VolumesStateAbnormalU8只读变更广播是否存在状态异常的逻辑盘。0:否,1:是
DiskPartitionUsagePercentageThresholdU8读写变更广播磁盘分区占用率告警阈值(百分比)

bmc.kepler.Systems.Storage.Volume

==属性==

属性名类型可读写信号通知描述
IdU16只读变更广播逻辑盘的Id
VolumeNameString只读变更广播逻辑盘的名称
OptimumIOSizeBytesU32只读变更广播逻辑盘的条带大小
DefaultReadPolicyString只读变更广播逻辑盘的默认读策略
DefaultWritePolicyString只读变更广播逻辑盘的默认写策略
StateU8只读变更广播逻辑盘的状态
RAIDTypeU8只读变更广播逻辑盘的Raid级别
CapacityBytesU64只读变更广播逻辑盘的容量
DriveCachePolicyU8只读变更广播逻辑盘的硬盘缓存策略
CurrentForegroundInitStateU8只读变更广播逻辑盘当前是否在FGI中
ForegroundInitProgressU8只读变更广播逻辑盘当前的FGI进度,百分比
CurrentReadPolicyString只读变更广播逻辑盘当前读策略
CurrentWritePolicyString只读变更广播逻辑盘当前写策略
BootPriorityU8只读变更广播启动优先级
BootEnableU8只读变更广播是否为启动盘
OSDriveNameString只读变更广播逻辑盘对应的OS盘符
BGIEnableU8只读变更广播后台初始化使能状态
SSDCachecadeVolumeU8只读变更广播是否为CacheCade逻辑盘
ConsistencyCheckU8只读变更广播一致性检查功能的启用状态
SSDCachingEnableU8只读变更广播是否可使用CacheCade逻辑盘
AssociatedVolumesU16[]只读变更广播所关联的普通逻辑盘的访问路径
AssociatedCacheCadeVolumeU16[]只读变更广播所关联的CacheCade逻辑盘的访问路径
DefaultCachePolicyString只读变更广播逻辑盘默认的Cache策略
AccessPolicyString只读变更广播逻辑盘的访问策略
CurrentCachePolicyString只读变更广播逻辑盘当前Cache策略
CacheLineSizeKiBU8只读变更广播缓存行大小
AccelerationMethodString只读变更广播加速方法
RebuildProgressU8只读变更广播指定逻辑盘数据重建进度
InitializationModeU8只读变更广播初始化模式
RebuildStateU8只读变更广播指定逻辑盘数据重建状态
RefControllerIdU8只读变更广播指定逻辑盘所属控制器id
RefDriveListString[]只读变更广播指定逻辑盘关联的物理盘列表
RefDiskArrayListU16[]只读变更广播指定逻辑盘关联的阵列列表
HotSpareDriveListString[]只读变更广播逻辑盘关联热备盘列表
SpanCountU8只读变更广播逻辑盘包含的子组数
MaxResizableSizeBytesU64只读变更广播逻辑盘的最大可设置的容量

==方法==


SetName

设置逻辑盘的名称

参数

  • Name: String - 名称

SetReadPolicy

设置逻辑盘的读策略

参数

  • ReadPolicy: U8 - 读策略

SetWritePolicy

设置逻辑盘的写策略

参数

  • WritePolicy: U8 - 写策略

SetBootable

设置逻辑盘是否启动盘

参数

  • BootPriority: U8 - 启动优先级

SetIOPolicy

设置逻辑盘的IO策略

参数

  • IOPolicy: U8 - IO策略

SetBGIEnable

设置逻辑盘的后台初始化

参数

  • BGIEnabled: U8 - 是否后台初始化

SetAccessPolicy

设置逻辑盘的获取策略

参数

  • AccessPolicy: U8 - 获取策略

SetDiskCachePolicy

设置逻辑盘的硬盘Cache策略

参数

  • DiskCachePolicy: U8 - 硬盘Cache策略

StartForegroundInit

开始前台初始化

参数

  • InitType: U8 - 初始化类型

返回值

  • TaskId: U32 - 任务ID

CancelForegroundInit

取消前台初始化

返回值

  • TaskId: U32 - 任务ID

SetCachecadeEnable

设置Cache使能状态

参数

  • AssociateCachecade: U8 - 关联Cache号

SetAccelerator

设置逻辑盘的加速方法

参数

  • Accelerator: U8 - 加速方法

SetCapacitySize

设置逻辑盘的容量

参数

  • CapacitySize: U32 - 容量大小
  • CapacityUnit: U8 - 容量单位,0:MB,1:GB,2:TB

SetStripSize

设置逻辑盘的条带大小

参数

  • StripSize: U8 - 条带大小

bmc.kepler.Systems.SystemFirmwareProgress.Status

==属性==

属性名类型可读写信号通知描述
KBCErrorU8只读变更广播KBC Controller自检错误
VideoErrorU8只读变更广播显卡芯片异常

bmc.kepler.Systems.SystemLockDown

==属性==

属性名类型可读写信号通知描述
SystemLockDownSupportString读写变更广播产品是否支持系统锁定功能,通过license控制其状态
SystemLockDownStatusString读写变更广播系统锁定开关状态

bmc.kepler.Systems.TPCM.Component

==属性==

属性名类型可读写信号通知描述
ActualManufacturerString只读变更广播实际部件厂商
ActualModelString只读变更广播实际部件型号
ActualUniqueIdentifierString只读变更广播实际部件唯一标识
StandardManufacturerString只读变更广播基准部件厂商
StandardModelString只读变更广播基准部件型号
StandardUniqueIdentifierString只读变更广播基准部件唯一标识
StatusU8只读变更广播部件状态,0-正常,1-新增,2-移除,3-变更

bmc.kepler.Systems.TemperatureManagement

==属性==

属性名类型可读写信号通知描述
SensorLocationSupportedBoolean只读变更广播是否支持温度海洋界面显示

==方法==


GetTemperaturesInfo

获取温度点信息

返回值

  • TemperaturesInfo: Array - 温度点信息

==自定义类型==


TemperaturesInfo: 结构体类型

  • Name: String - 温度点名称
  • ReadingValue: Double - 温度值
  • Status: String - 告警状态
  • UpperThreshold: U8[] - 告警阈值上限(轻微/严重/致命)
  • LowerThreshold: U8[] - 告警阈值下限(轻微/严重/致命)
  • CoordinateX: U8 - 温度点横坐标
  • CoordinateY: U8 - 温度点纵坐标

bmc.kepler.Systems.ThermalTrip

==属性==

属性名类型可读写信号通知描述
ActionU8读写变更广播高温下电后上电策略动作 1:上电 0:不上电
TimeDelaySecondsU32读写变更广播高温下电后上电延时时间,单位为秒,默认300秒

bmc.kepler.Systems.ThresholdSensor

==属性==

属性名类型可读写信号通知描述
EntityIdU8只读变更广播传感器对应的实体,来自于IPMI规范,具体需要关联传感器对应的Entity.Id
EntityInstanceU8只读变更广播传感器对应的实体,来自于IPMI规范,具体需要关联传感器对应的Entity.Instance
CapabilitiesU8只读变更广播传感器支持能力,来自于IPMI规范,具体可以参考规范 43.1
SensorTypeU8只读变更广播传感器类型,来自于IPMI规范,具体可以参考规范 42.2
SensorIdentifierString只读变更广播传感器标识
SensorNameString只读变更广播传感器对外显示名称
ReadingMaskU16只读变更广播传感器读值掩码,来自于IPMI规范,具体可以参考规范 43.1
UpperNonrecoverableU8只读变更广播传感器紧急事件上限,来自于IPMI规范,具体可以参考规范 43.1
UpperCriticalU8只读变更广播传感器严重事件上限,来自于IPMI规范,具体可以参考规范 43.1
UpperNoncriticalU8只读变更广播传感器一般事件上限,来自于IPMI规范,具体可以参考规范 43.1
LowerNonrecoverableU8只读变更广播传感器紧急事件下限,来自于IPMI规范,具体可以参考规范 43.1
LowerNoncriticalU8只读变更广播传感器严重事件下限,来自于IPMI规范,具体可以参考规范 43.1
LowerCriticalU8只读变更广播传感器一般事件下限,来自于IPMI规范,具体可以参考规范 43.1
PositiveHysteresisU8只读变更广播传感器正向迟滞量,来自于IPMI规范,具体可以参考规范 43.1
NegativeHysteresisU8只读变更广播传感器负向迟滞量,来自于IPMI规范,具体可以参考规范 43.1
OwnerLunU8只读变更广播传感器的Lun,默认0,来自于IPMI规范,具体可以参考规范 43.1
SensorNumberU8只读变更广播传感器编号,默认255,来自于IPMI规范,由BMC自行生成;如果需要特殊的编号,则需要单独在传感器定制化进行定制(BMC正常运行时插入的部件的传感器不支持定制)
ReadingU8只读变更广播传感器原始读值,引用传感器的数据源(如Scanner)读值同步,需要填写一个默认值,用于数据源未更新时显示,需要注意在门限之内,防止产生SEL事件
ReadingStatusU8只读变更广播传感器读值状态,默认0,引用传感器的数据源(如Scanner)读值状态同步
OriginalReadingDouble只读变更广播传感器的原始值,当线型标志配置0x70-0x7f时,需要此属性配合Reading(固定配置170)计算传感器读数系数以提升读值精度至1w

bmc.kepler.Systems.ThresholdSensorDisplay

==属性==

属性名类型可读写信号通知描述
UpperNonrecoverableDisplayString只读变更广播传感器紧急门限上限可读描述,精度3位有效数字
UpperCriticalDisplayString只读变更广播传感器严重门限上限可读描述,精度3位有效数字
UpperNoncriticalDisplayString只读变更广播传感器一般门限上限可读描述,精度3位有效数字
LowerNonrecoverableDisplayString只读变更广播传感器紧急门限下限可读描述,精度3位有效数字
LowerNoncriticalDisplayString只读变更广播传感器严重门限下限可读描述,精度3位有效数字
LowerCriticalDisplayString只读变更广播传感器一般门限下限可读描述,精度3位有效数字
PositiveHysteresisDisplayString只读变更广播传感器正向迟滞量可读描述,精度3位有效数字
NegativeHysteresisDisplayString只读变更广播传感器负向迟滞量可读描述,精度3位有效数字
ReadingDisplayString读写变更广播传感器读值可读描述,精度3位有效数字
UnitDisplayString只读变更广播传感器单位可读描述
StatusString只读变更广播传感器当前状态:Enabled:传感器使能;Disabled:传感器禁用;InTest:传感器测试中;Starting:传感器更新中
HealthString只读变更广播传感器健康状态:Critical:紧急;Major:严重;Minor:一般;OK:正常
AssertStatusU16只读变更广播传感器SEL事件状态,16进制的数,bit4 - bit15依次对应12种门限事件状态,1:Assert;0:Deassert

bmc.kepler.Systems.UnitConfigError

==属性==

属性名类型可读写信号通知描述
Port1LinkInfoString读写变更广播端口1连接信息
Port1StatusU8读写变更广播端口1状态(0: 初始状态、1: 匹配成功、2: 线缆连接错误、3: 组件不在白名单、4: 组件uid无法获取、5: 组件连接不完整、255: 不告警)
Port2LinkInfoString读写变更广播端口2连接信息
Port2StatusU8读写变更广播端口2状态(0: 初始状态、1: 匹配成功、2: 线缆连接错误、3: 组件不在白名单、4: 组件uid无法获取、5: 组件连接不完整、255: 不告警)
AbsenceAllowedU8只读变更广播是否允许组件设备不在位(0:不允许不在位,当不在位时产生该告警、1:允许不在位,不产生告警)

bmc.kepler.Systems.UsbDevice.Cdrom

==属性==

属性名类型可读写信号通知描述
ConnectStateU32只读变更广播连接状态,未连接为0,连接为1

==方法==


Connect

Cdrom设备建立连接

返回值

  • UsbId: U32 - 复合设备USB口
  • FuncId: U32 - 功能设备ID

Disconnect

Cdrom设备断开连接


bmc.kepler.Systems.UsbDevice.KeyMouse

==属性==

属性名类型可读写信号通知描述
ConnectStateU32只读变更广播连接状态,未连接为0,连接为1
MouseModeU32读写变更广播键鼠模式

==方法==


Connect

鼠标建立连接

返回值

  • KeyUsbId: U32 - 复合设备USB口
  • KeyFuncId: U32 - 功能设备ID
  • MouseUsbId: U32 - 鼠标USBID
  • MouseFuncId: U32 - 鼠标功能设备ID

Reset

重置鼠标连接

返回值

  • KeyUsbId: U32 - 复合设备USB口
  • KeyFuncId: U32 - 功能设备ID
  • MouseUsbId: U32 - 鼠标USBID
  • MouseFuncId: U32 - 鼠标功能设备ID

Disconnect

鼠标断开连接


bmc.kepler.Systems.UsbDevice.LCD

==属性==

属性名类型可读写信号通知描述
ConnectStateU32只读变更广播设备连接状态, 0表示未连接, 1表示连接

==方法==


Connect

LCD设备建立连接


Disconnect

LCD设备断开连接


bmc.kepler.Systems.UsbDevice.Ums

==属性==

属性名类型可读写信号通知描述
ConnectStateU32只读变更广播连接状态, 未连接为0, 连接为1
EnabledBoolean读写变更广播u盘使能标志

==方法==


Connect

u盘建立连接

参数

  • FlashDev: String - u盘设备名称

返回值

  • UsbId: U32 - 复合设备USB口
  • FuncId: U32 - 功能设备ID

Disconnect

u盘断开连接


bmc.kepler.Systems.VirtualMachine

==属性==

属性名类型可读写信号通知描述
NameString只读变更广播虚机名称
UUIDString只读变更广播虚机UUID

bmc.kepler.Systems.VirtualMachine.TPCM

==属性==

属性名类型可读写信号通知描述
MeasureEnabledBoolean读写变更广播是否使能度量, 取值范围: true、false, 默认值为true
MeasureControlAllowedBoolean读写变更广播度量不一致时是否启动虚机, 取值范围: true、false, 默认值为false

bmc.kepler.Systems.VirtualMedia.CD

==属性==

属性名类型可读写信号通知描述
EjectPolicyString读写变更广播镜像弹出策略
EjectTimeoutSecondsU32读写变更广播虚拟媒体超时弹出时间,单位:秒
UserNameString读写变更广播访问远程镜像使用的用户名
ConnectedViaString读写变更广播虚拟媒体连接途径
ImageString读写变更广播远程镜像URI
ImageNameString读写变更广播远程镜像文件名
MediaTypesString[]读写变更广播虚拟媒体类型
ConnectNumU8读写变更广播虚拟媒体连接数量
ConnectStateU8读写变更广播虚拟媒体连接状态,0:未连接、1:已连接

==方法==


InsertMedia

插入媒体

参数

  • Image: String - 镜像URI
  • ProtocolType: String - 传输协议类型
  • UserName: String - 插入镜像访问用户名
  • Password: String - 插入镜像访问密码

返回值

  • TaskId: U32 - 任务标识

EjectMedia

弹出媒体

返回值

  • TaskId: U32 - 任务标识

SetPassword

设置访问远程镜像密码

参数

  • Password: String - 访问密码字符串

bmc.kepler.Systems.VncService

==属性==

属性名类型可读写信号通知描述
IdU8读写变更广播VNC服务Id
DisableKeyboardDuringBiosStartupBoolean读写变更广播BIOS启动过程中是否允许vnc键盘输入

bmc.kepler.Systems.VrdChip

==属性==

属性名类型可读写信号通知描述
NameString读写变更广播芯片名称 Type+No
VendorString读写变更广播芯片厂商
TypeString读写变更广播芯片类型
FirmwareVersionString读写变更广播固件版本

bmc.kepler.Systems.VrdMgmt

==属性==

属性名类型可读写信号通知描述
SystemIdU8只读变更广播系统Id
HealthU8只读变更广播健康状态
StatusU8只读变更广播Vrd值为无效值时,Status置为0,有效值时,置位为1
CpuIdU8只读变更广播所关联的CPU id
Cpu0v9TACoreDouble读写变更广播Vrd供电信息,供电区域类型为CORE,DieId为1
Cpu0v75DDRVDDDouble读写变更广播Vrd供电信息,供电区域类型为DDR,无DieId
Cpu0v9TBCoreDouble读写变更广播Vrd供电信息,供电区域类型为CORE,DieId为3
Cpu0v9UncoreDouble读写变更广播Vrd供电信息,供电区域类型为UNCORE,无DieId
Cpu0v8NADVDDDouble读写变更广播Vrd供电信息,供电区域类型为Nimbus,DieId为0
Cpu0v8NBDVDDDouble读写变更广播Vrd供电信息,供电区域类型为Nimbus,DieId为2
Cpu1v1DDRVddqDouble读写变更广播Vrd供电信息,供电区域类型为VDDQ,无DieId
CpuTACoreTempDouble读写变更广播临时Vrd供电信息,供电区域类型为CORE,DieId为1
CpuDDRVDDTempDouble读写变更广播临时Vrd供电信息,供电区域类型为DDR,无DieId
CpuTBCoreTempDouble读写变更广播临时Vrd供电信息,供电区域类型为CORE,DieId为3
CpuUncoreTempDouble读写变更广播临时Vrd供电信息,供电区域类型为UNCORE,无DieId
CpuNADVDDTempDouble读写变更广播临时Vrd供电信息,供电区域类型为Nimbus,DieId为0
CpuNBDVDDTempDouble读写变更广播临时Vrd供电信息,供电区域类型为Nimbus,DieId为2
CpuDDRVddqTempDouble读写变更广播临时Vrd供电信息,供电区域类型为VDDQ,无DieId
VrdTemperatureCelsiusDouble只读变更广播Vrd温度,用作调速
WattsDouble读写变更广播功率

bmc.kepler.Systems.VrdPower

==属性==

属性名类型可读写信号通知描述
SystemIdU8只读变更广播系统id
CpuIdU8只读变更广播cpu index取值范围为0 ~ n
TypeU8只读变更广播电源供电区域类型, 0: Core, 1: Uncore, 2: DDr, 3: Nimbus, 4: VDDQ
DieIdU8只读变更广播电源供电die区域, 0: NA, 1: TA, 2: NB, 3: TB, 255: 不涉及
VoltageDouble只读变更广播电源电压,单位 V
CurrentAmpsDouble只读变更广播电源电流,单位 A
TemperatureCelsiusDouble只读变更广播电源温度,单位℃