背景
服务器管理南向接口技术要求文档中,PCIeNVMe的相关接口,属性类型、签名类型以及方法无法满足开发需求,需要补充调整生成接口文档
关联ISSUE
暂无
整体方案
参考最新南向接口文档,根据代码实现进行对比排查,梳理缺失、不一致的点,进行相应补齐
评审点
1、bmc.dev.NVMe.NVMeMI接口下添加State和Progress属性
2、bmc.dev.NVMe.LogCollection接口下新增DumpMctpTransSize方法
详细描述
评审点1:bmc.dev.NVMe.NVMeMI接口下添加State和Progress属性
变更描述 :GetIdentifyData方法中,应用层通过监听State和Progress属性,刷新Task中的任务状态
接口 :bmc.dev.NVMe.NVMeMI
新增属性明细
| 属性名称 | 签名 | 默认值 | 只读 | 属性描述 | 属性来源 | 持久化类型 | 变更影响 |
|---|---|---|---|---|---|---|---|
| State | s | Idle | true | TelemetryData日志收集状态,Idle:空闲,Running:收集中,Completed:收集完成,Exception:异常,默认值Idle | 组件内部维护 | 不持久化 | 无影响 |
| Progress | y | 255 | true | TelemetryData日志收集进度 | 组件内部维护 | 不持久化 | 无影响 |
评审点2:bmc.dev.NVMe.LogCollection接口下新增DumpMctpTransSize方法
变更描述 :当前缺失了MCTP Transmission Unit Size的日志信息,需要新增方法
接口 :bmc.dev.NVMe.LogCollection
新增方法明细
| 方法名称 | req签名 | req说明 | rsp签名 | rsp说明 | 方法说明 |
|---|---|---|---|---|---|
| DumpMctpTransSize | s | Path :NVMe盘传输单元大小信息存放路径 | b | true:成功 false:失败 | 收集NVMe盘的MCTP传输单元大小信息 |
评审结论
评审点1:南向已支持创建task的实现,GetIdentifyData可以直接返回TaskId,不需要新增状态属性
评审点2:bmc.dev.NVMe.LogCollection接口下新增DumpMctpTransSize方法