bmc.kepler.Accessor ​

==属性==

bmc.kepler.Assembly ​

==属性==

bmc.kepler.Chassis ​

==属性==

==自定义类型==

DeviceMaxCount: 结构体类型

• DeviceName: String - [兼容性保留]旧版本设备名称定义，新版本请优先使用DeviceSpecification获取包含槽位号的完整信息
• MaximumNum: U8 - [兼容性保留]旧版本设备最大数量定义，新版本请优先使用DeviceSpecification获取包含槽位号的完整信息

DeviceSpecification: 结构体类型

• DeviceName: String - 设备名称
• MaximumNum: U8 - 设备最大数量
• DeviceSlots: U8[] - 设备槽位号

bmc.kepler.Chassis.ChassisCapabilities ​

==属性==

bmc.kepler.Chassis.CoolingPolicies ​

==方法==

GetSpecificPWM

获取指定条件下环温策略控制PWM

参数

• Medium: String - 介质:风冷、液冷
• PolicyType: U8 - 曲线类型 1:Inlet 2:Disk
• SmartCoolingMode: String - SmartCooling模式：节能、低噪、高性能、自定义、液冷
• Temperature: S16 - 温度值

返回值

• ControlPWM: U8 - 控制占空比

bmc.kepler.Chassis.Dimension ​

==属性==

bmc.kepler.Chassis.Enclosure ​

==属性==

bmc.kepler.Chassis.EnergySavingMeasurement ​

==属性==

==方法==

GetPolicyGuidances

获取节能策略指导

返回值

• PolicyGuidanceData: Array - 节能策略指导数据

==自定义类型==

PolicyGuidance: 结构体类型

• Component: String - 部件名
• HealthPercent: U8 - 健康度
• CurrentPolicies: String[] - 当前策略
• RecommendedPolicies: String[] - 推荐策略
• Influence: String[] - 影响
• CurrentPolicyName: String[] - 当前策略名称
• RecommendedPolicyName: String[] - 推荐策略名称

bmc.kepler.Chassis.EnergySavingScene ​

==属性==

==方法==

GetModeByScene

根据查询的智能节能场景获取节能系统的模式以及各个模式下的对应的值

参数

• Scene: String - 根据查询的智能节能场景对应节能系统的配置值

返回值

• Systems: System - 获取节能系统的模式以及各个模式下的对应的值

GetEnergySavingStatus

获取场景化节能使能状态

返回值

• EnergySavingStatus: String - 场景化节能使能状态，Activated：生效，Inactivated ：不生效，Unknown：未知

GetEnergySavingStatusWithDomains

获取所有参与场景化节能的节能域的节能生效状态

返回值

• EnergySavingStatusWithDomains: EnergySavingStatus - 所有参与场景化节能的节能域的节能生效状态

==自定义类型==

System: 结构体类型

• key: String
• value: Parameters - 节能系统

Parameters: 结构体类型

• key: String
• value: String

EnergySavingStatus: 结构体类型

• key: String - 参与场景化节能的节能域名称,CPUSystem：CPU节能域；NPUSystem：NPU节能域
• value: String - 对应节能域的节能生效状态,Activated：生效，Inactivated ：不生效，Unknown：未知

bmc.kepler.Chassis.EnvironmentMetrics.Humidity ​

==属性==

bmc.kepler.Chassis.EnvironmentMetrics.Temperature ​

==属性==

bmc.kepler.Chassis.FanGroup ​

==属性==

bmc.kepler.Chassis.FruCtrl ​

==属性==

==方法==

PowerCtrl

上下电操作

参数

• OperateType: 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 - 命令执行结果

bmc.kepler.Chassis.FruDatas ​

==方法==

GetFruDataList

获取FruData列表

返回值

• FruDataList: Array

==自定义类型==

Item: 结构体类型

• key: String
• value: String

FruDataItems: 结构体类型

• Items: Item

bmc.kepler.Chassis.HddBackPlanes ​

==属性==

bmc.kepler.Chassis.LanSwitch ​

==方法==

LswReset

复位交换板相关器件

参数

• Device: U32 - 交换板器件类型：1.chip、2.phy、3.all
• Type: U32 - 交换板器件复位类型：1.hard reset、2.soft reset

GetConfigInfo

获取交换板器件网络配置状态

返回值

• Value: String - 交换板器件网络配置状态

bmc.kepler.Chassis.LeakDetection ​

==属性==

==方法==

SetLeakPolicy

设置漏液后的应对策略

参数

• LeakValvePolicy: U8 - 漏液关断阀策略,0:不操作,1:自动关断,255:保持当前值
• LeakPowerPolicy: U8 - 漏液下电策略,0:不操作,1:自动下电,255:保持当前值

bmc.kepler.Chassis.LeakDetection.LeakDetector ​

==属性==

bmc.kepler.Chassis.ModbusDevice ​

==属性==

bmc.kepler.Chassis.PCIeSwitch ​

==属性==

bmc.kepler.Chassis.PowerOnLock ​

==方法==

SetPowerOnLock

整机上电锁

参数

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

返回值

• CmdResult: U8 - 函数执行结果

bmc.kepler.Chassis.PowerSubsystem.Capacitor ​

==属性==

==方法==

SetVOUTDebounceMilliseconds

设置电容输出电压采样防抖时间，仅适用于电容管理场景

参数

• VOUTDebounceMilliseconds: U32 - 电容输出电压采样防抖时间，单位：毫秒

SetDepthOfDischargeVolts

设置电容柜放电深度，仅适用于电容管理场景

参数

• DepthOfDischargeVolts: U32 - 电容放电深度，单位：V

Reset

复位电容，仅适用于电容管理场景

参数

• ResetType: String - 复位类型，ForceOff关机，On开机

bmc.kepler.Chassis.PowerSubsystem.Capacitor.Metrics ​

==属性==

bmc.kepler.Chassis.PowerSubsystem.PSUStrategy ​

==属性==

bmc.kepler.Chassis.PowerSubsystem.PowerSupplies ​

==属性==

==方法==

SetPsusFanMinPWM

设置所有psu风扇最低转速（如果设置的最低转速高于电源风扇控制的转速时才生效）

参数

• FanMinPWM: U8 - 所有psu风扇的转速百分比，有效值为[0, 100]

bmc.kepler.Chassis.PowerSubsystem.PowerSupplies.Metrics ​

==属性==

bmc.kepler.Chassis.PowerSubsystem.PowerSupply.Metrics ​

==属性==

==方法==

Reset

重置与此设备相关的汇总指标

bmc.kepler.Chassis.PowerSubsystem.PowerSupply.OutputControl ​

==属性==

==方法==

SetOutputPowerLimitWatts

设置电源输出限功率点

参数

• OutputPowerLimitWatts: U32 - 电源输出限功率点，单位：瓦特

SetOutputVoltageAdjustmentEnabled

设置电源输出电压调节使能状态

参数

• OutputVoltageAdjustmentEnabled: Boolean - 电源输出电压调节使能状态，true：开启，false：关闭

SetTargetOutputVoltage

设置电源目标输出电压

参数

• TargetOutputVoltage: Double - 电源目标输出电压，单位：伏特

bmc.kepler.Chassis.PowerSubsystem.Status ​

==属性==

bmc.kepler.Chassis.PumpGroup ​

==属性==

bmc.kepler.Chassis.SensorSelInfo ​

==属性==

bmc.kepler.Chassis.Sensors ​

==属性==

==方法==

GetThresholdSensorList

查询门限传感器列表

返回值

• SensorList: Array - 门限传感器列表

MockSensor

模拟传感器

参数

• Enabled: U8 - 是否使能模拟
• SensorName: String - 模拟传感器的名称
• Value: String - 模拟传感器读值，stop是停止模拟

GetSensorList

查询所有传感器列表

返回值

• SensorList: Array - 查询到的传感器列表

SetSensorStatus

设置传感器使能状态

参数

• SensorName: String - 传感器的名称
• Status: String - 使能状态(enabled,disabled)

ExportSel

导出传感器事件列表

参数

• Path: String - 导出sel的路径

返回值

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

GetSel

获取传感器事件列表

参数

• StartId: U16 - 事件索引
• Count: U16 - 事件条数

返回值

• Total: U16 - 事件总条数
• SelList: Array - 事件列表

GetDiscreteSensorList

查询离散传感器列表

返回值

• SensorList: Array - 离散传感器列表

GetReportedSel

获取上报事件

参数

• StartId: U64 - 事件起始序列号
• Count: U16 - 事件条数

返回值

• Total: U16 - 事件总条数
• SelList: Array - 事件列表

DumpSDR

将SDR数据dump为二进制文件

参数

• DumpMode: String - SDR数据缓存模式，限定为 LAN/BT 两种模式

AddOemSel

参数

• RecordType: U8 - 表征当前要添加的OEM SEL的类型
• Timestamp: U32 - 表征当前SEL发生的时间
• ManufactureID: U32 - 表征当前SEL记录的厂商
• SELDatas: String - 表征当前SEL记录的数据

返回值

• RecordId: U32 - 当前OEM SEL数据记录id

ClearSel

清空传感器事件

SetThresholds

设置门限传感器门限值

参数

• SensorName: String - 需要修改的传感器名称（若存在重名，以第一个为准）
• PersistenceType: U8 - 持久化类型
• Attributes: ThresholdAttributeItem - 需要修改的门限属性与取值，支持同时设置多个。属性值为双精度数字字符串，精度为3位小数（如1.000）

==自定义类型==

AllSensorItem: 结构体类型

• SensorNumber: U16
• SensorName: String
• SensorUnit: String
• SensorStatus: String
• SensorReading: String
• LowerFatal: String
• LowerCritical: String
• LowerNonCritical: String
• UpperNonCritical: String
• UpperCritical: String
• UpperFatal: String
• PosHysteresis: String
• NegHysteresis: String
• SensorType: U8
• BaseUnit: U8
• ReadingType: U8
• SystemId: U8

ThresholdSensorItem: 结构体类型

• SensorNumber: U16
• SensorName: String
• SensorIdentifier: String
• SensorUnit: String
• SensorStatus: String
• SensorReading: String
• LowerThresholdFatal: String
• LowerThresholdCritical: String
• LowerThresholdNonCritical: String
• UpperThresholdNonCritical: String
• UpperThresholdCritical: String
• UpperThresholdFatal: String
• SensorType: U8
• Status: String
• Health: String
• SystemId: U8

SelInfo: 结构体类型

• MappingTable: Array - Sel信息键值表,键的值包括:序号, 时间戳, 传感器名称, 传感器类型, 传感器事件级别, 传感器事件状态, 传感器事件描述

KeyValueTable: 结构体类型

• Key: String
• Value: String

DiscreteSensorItem: 结构体类型

• SensorNumber: U16
• SensorName: String
• SensorIdentifier: String
• SensorStatus: String
• SystemId: U8

ThresholdAttributeItem: 结构体类型

• key: String
• value: String

bmc.kepler.Chassis.Storage.StorageSetting ​

==属性==

bmc.kepler.Chassis.SuperPodLabel ​

==属性==

==方法==

SetSuperPodId

设置超节点ID

参数

• SuperPodId: U32 - 超节点ID

返回值

• Result: Boolean - 操作成功或失败

SetServerIndex

设置超节点服务器编号

参数

• ServerIndex: U16 - 服务器编号

返回值

• Result: Boolean - 操作成功或失败

SetSuperPodSize

设置超节点容量

参数

• SuperPodSize: U16 - 超节点容量

返回值

• Result: Boolean - 操作成功或失败

SetSuperPodEnabled

设置超节点模式

参数

• SuperPodEnabled: Boolean - 超节点模式，true开启超节点使能实现组网，false关闭超节点使能bmc单机运行

RestoreDefaults

恢复超节点属性默认值

返回值

• Result: Boolean - 操作成功或失败

SetSuperPodLabel

设置超节点属性,当前可设置属性为bmc.kepler.Chassis.SuperPodLabel接口下属性

参数

• Policy: U8
• SuperPodLabel: Array - 超节点属性，可设置属性，TopologyType，IsUBControlNode，IsUBControlNode

==自定义类型==

SuperPodLabel: 结构体类型

• Key: String - 超节点属性名，eg:TopologyType
• Value: U32 - 超节点属性值，eg:2

bmc.kepler.Chassis.ThermalSubsystem.AlgorithmsEngine ​

==方法==

GetAlgorithmsList

当前能效智能调速算法类型，算法运行状态和算法自定义配置生效状态

返回值

• AlgorithmsList: Array - 每一个数组对应一种算法类型

Import

能效智能算法导入配置的功能

参数

• AlgorithmType: String - 能效智能调速算法类型，取值范围：MPC
• ConfigType: String - 能效智能调速算法的配置类型，MPC算法支持的配置类型：TrainSet
• Content: String - 导入的配置的文件路径名称

返回值

• TaskId: U32 - 任务Id

ResetToDefaults

恢复指定算法对应配置的默认值

参数

• AlgorithmType: String - 能效智能调速算法类型，取值范围：MPC
• ResetType: String - 能效智能调速算法的配置类型,ResetAll表示恢复所有自定义配置

返回值

• TaskId: U32 - 任务Id

==自定义类型==

AlgorithmItem: 结构体类型

• AlgorithmType: String - 智能调速算法类型
• AlgorithmStatus: String - 智能调速算法运行状态
• CustomConfigurations: ConfigStatus - 智能调速算法自定义配置生效状态

ConfigStatus: 结构体类型

• key: String - 能效智能调速算法的自定义配置名称
• value: String - 能效智能调速算法的自定义配置的生效状态

bmc.kepler.Chassis.ThermalSubsystem.Metrics ​

==属性==

==方法==

ResetMetrics

散热器件累计耗电量信息重新统计

bmc.kepler.Chassis.ThermalSubsystem.Pumps ​

==属性==

bmc.kepler.Chassis.UBPort ​

==属性==

bmc.kepler.Chassis.UBPort.Status ​

==属性==

bmc.kepler.Chassis.Valve ​

==属性==

bmc.kepler.Chassis.Valves ​

==属性==

==方法==

StartPatrol

启动关断阀巡检

参数

• DelaySeconds: U32 - 巡检开始等待时间（秒）

bmc.kepler.Chip ​

==属性==

==方法==

SetAccessibility

设置芯片可访问状态: true:使能访问芯片， false:禁止访问芯片，禁止时长，单位: 秒，取值范围: [1, 1800]

参数

• Status: Boolean - Status == true -> Allow Chip access; Status == false -> Prohibit Chip access.
• DisableDuration: U16 - This parameter only takes effect when status is true.range:[1,1800];Unit:seconds.When duration ends, open Chip access automatically

SetLockStatus

设置芯片锁定状态，optype为1，表示加锁，0表示解锁

参数

• OpType: U8 - 0表示解锁，1表示加锁
• LockTime: U32 - 锁定时长，单位为秒，OpType为1时生效，范围：LockTime <= 30min，同APP同器件支持续锁

返回值

• ResultCode: Enum - OpType为1时：OK、RequestorMismatchedError（已锁定状态下，请求发起者与锁定者不一致）、InvalidParameter（LockTime范围错误）、ChipMismatchedError（同通道不同的器件锁定了总线）、ChannelMismatchedError（同总线不同通道的器件锁定了总线），OpType为0时：OK、RequestorMismatchedError（已锁定状态下，请求发起者与锁定者不一致）、UnlockedError（通道未锁定）、ChipMismatchedError（同通道的不同的器件锁定了总线）、ChannelMismatchedError（不同通道的器件锁定了总线）

==自定义类型==

SetLockStatusResultCode: 枚举类型

• 0: OK
• 1: InvalidParameter
• 2: UnlockedError
• 3: RequestorMismatchedError
• 4: ChipMismatchedError
• 5: ChannelMismatchedError

bmc.kepler.Chip.Aggregate ​

==属性==

bmc.kepler.Chip.BitIO ​

==方法==

Read

按位读：将从硬件读取数据与掩码进行按位与操作后返回结果

参数

• Offset: U32 - 读取的offset，偏移位置
• Length: U8 - 读取长度
• Mask: U32 - 掩码: 用于与从硬件读取的内容进行按位与操作

返回值

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

Write

按位写：将indata内容与掩码进行按位与修改后写入芯片的offset位置

参数

• Offset: U32 - 写入的offset，偏移位置
• Length: U8 - 写入长度
• Mask: U32 - 写入掩码: 写入时先获取值，再按位修改后写入到硬件
• InData: U8[] - 写入的数据内容

bmc.kepler.Chip.BlockIO ​

==方法==

Read

按字节读取从芯片的offset偏移位置读取指定长度内容

参数

• Offset: U32 - 读取的offset，偏移位置
• Length: U32 - 读取长度

返回值

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

Write

按字节将指定内容写入芯片的offset偏移位置

参数

• Offset: U32 - 写入的offset，偏移位置
• InData: U8[] - 写入的数据内容

WriteRead

往固定的offset偏移写入请求数据，再从固定的offset读取指定长度内容

参数

• InData: U8[] - 写入的数据内容
• ReadLength: U32 - 读取的长度

返回值

• OutData: U8[] - 从offset是0xffffffff读取到的内容

ComboWriteRead

先往writeoffset偏移写入请求数据，再从readoffset读取指定长度内容

参数

• WriteOffset: U32 - 写入的offset，偏移位置
• InData: U8[] - 写入的数据内容
• ReadOffset: U32 - 读取的offset，偏移位置
• ReadLength: U32 - 读取长度

返回值

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

BatchWrite

批量写入：将不同offset偏移位置的数据，一次性写入对应的chip中

参数

• WriteData: Array - 写入数据：[[offset1,data1], [offset2,data2]]

PluginRequest

功能: 插件访问在hwproxy将代码进行加载后通过chip访问硬件；在插件中访问时将占据总线访问通道，不会切换至其他任务

参数

• PluginName: String - 插件名称
• Cmd: String - 命令名称，插件中已实现的函数，hwproxy加载后进行调用并将chip作为第一个参数传入
• Params: U8[] - 插件执行函数输入的参数

返回值

• OutData: U8[] - 插件执行函数的响应结果

PluginRequestEx

拓展插件请求，支持通过插件访问时对插件能力进行拓展配置

参数

• PluginName: String - 插件名称
• Cmd: String - 命令名称，插件中已实现的函数，hwproxy加载后进行调用并将chip作为第一个参数传入
• Params: U8[] - 插件执行函数输入的参数
• ControlParams: PluginControlParams - 插件能力参数，用以对插件请求拓展能力进行配置。当前支持，控制插件执行优先级：Priority，取值包括高优先级High和次优先级Secondary

返回值

• OutData: U8[] - 插件执行函数的响应结果

WriteReadByProtocol

通过指定物理介质和协议的方式对设备进行写入和读取访问

参数

• InData: U8[] - 写入的数据内容
• ReadLength: U32 - 读取的长度
• Protocol: U8 - 物理介质和协议类型, 当前仅支持0x02 SMBus/I2c

返回值

• OutData: U8[] - 读取的数据内容

==自定义类型==

SingleWriteData: 结构体类型

• Offset: U32
• InData: U8[]

PluginControlParams: 结构体类型

• key: String
• value: String

bmc.kepler.Chip.FlashIO ​

==方法==

Read

读取操作，按字节读取从芯片的offset偏移位置读取指定长度内容

参数

• Offset: U32 - 器件上读取的偏移位置
• Length: U32 - 读取的长度

返回值

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

Write

写入操作，按字节将指定内容写入芯片的offset偏移位置

参数

• Offset: U32 - 器件上写入的偏移位置
• InData: U8[] - 写入的数据内容

Erase

擦除操作，根据Offset所在扇区/块/芯片进行擦除

参数

• Offset: U32 - 待擦除的Flash上偏移位置
• Type: U8 - 擦除类型,0:扇区擦除, 1:32K块擦除, 2:64K块擦除, 3:芯片擦除

RawRead

原始读取操作，支持单个自定义格式帧数据的原始读取操作

参数

• Length: U32 - 读取的数据长度
• InData: U8[] - 读取帧数据，包括命令字及负载数据

返回值

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

RawWrite

原始写入操作，支持单个自定义格式帧数据的原始写入操作

参数

• InData: U8[] - 写入帧数据，包括命令字及负载内容

bmc.kepler.Chip.JtagTarget ​

==方法==

GetChipIdcode

用于获取Jtag链上所有器件的IDCODE

返回值

• DeviceId: U32[] - Jtag链上所有器件的IDCODE

SetTargetNumber

选择Bypass模式下在JTAG链中的需要升级的器件

参数

• Num: U32 - 芯片的IDCODE

SetBypassMode

用于设置是否使用Bypass模式升级(链上除目标器件外其他器件设置为Bypass)

参数

• Enable: Boolean - 设置是否使用Bypass模式升级的参数

BypassChannelTest

进行jtag链路测试

参数

• Id: U8 - cpld的id, 设备号
• Channel: U8 - 通道号, Jtag的通道号

返回值

• ResultCode: Boolean - 为true代表测试成功，为false代表测试失败

Upgrade

进行固件升级

参数

• FilePath: String - 升级文件的路径
• FileType: U8 - 升级文件的类型, 0代表VME, 1代表SVF

Collect

通过JTAG收集芯片寄存器数据到指定的文件

参数

• FilePath: String - 数据采集指令文件路径
• FileType: U8 - 数据采集指令文件的类型, 0代表VME, 1代表SVF
• OutputFilePath: String - 数据采集输出文件路径

Verify

安全自检, 通过指定格式文件完成安全自检

参数

• FilePath: String - 安全自检文件的路径
• FileType: U8 - 安全自检文件的类型, 0代表VME, 1代表SVF

bmc.kepler.Chip.PowerMeter.Ina ​

==属性==

bmc.kepler.Chip.Rtc ​

==属性==

bmc.kepler.Connector ​

==属性==

==方法==

Reload

重新加载连接器

参数

• Bom: String - 连接器的Bom
• Id: String - 连接器的Id
• AuxId: String - 连接器的AuxId
• IdentifyMode: U8 - 连接器的加载方式

bmc.kepler.Mux.I2cMux ​

bmc.kepler.PowerEquipment.Circuit ​

==属性==

bmc.kepler.PowerEquipment.PowerDistribution ​

==属性==

bmc.kepler.PowerEquipment.PowerDistribution.Metrics ​

==属性==

==方法==

ResetMetrics

重置采集的历史数据，重置之后重新开始采集

bmc.kepler.PowerEquipment.PowerDistribution.TransferConfig ​

==属性==

==方法==

TransferControl

将电源输入从现有市电电路转移到备用市电电路

bmc.kepler.PowerEquipment.PowerDistribution.TransferConfiguration ​

==属性==

==方法==

SetExpectedPowerSupplyCircuit

设置预期的供电线路

参数

• PowerSupplyCircuit: String - 供电模式

返回值

• TaskId: U32 - 任务Id

bmc.kepler.ThermalMgmt ​

==方法==

SetFanPWM

设置风扇转速

参数

• SystemId: U8 - 系统Id
• FanId: U8 - 风扇Id
• PWM: Double - 风扇转速占空比

返回值

• Result: U8 - 返回结果，0：设置成功；1：设置失败

bmc.kepler.thermal_mgmt ​

==方法==

SetFanPWM

设置风扇转速

参数

• SystemId: U8 - 系统Id
• FanId: U8 - 风扇Id
• PWM: Double - 风扇转速占空比

返回值

• Result: U8 - 返回结果，0：设置成功；1：设置失败