【已评审】新增资源协作接口用于获取待生效固件信息

Interface SIG Interface评审
1

背景

web界面展示暂存固件和待生效固件的版本号信息
当前Web界面和UIRest接口获取暂存固件和待生效固件信息内没有版本号字段，因此需要增加版本号字段
当前UIRest接口获取待生效固件信息是通过方法GetPendingFirmwareList（响应签名a(yssss)，不包含版本号信息），因此需要新增方法

关联ISSUE

暂无

整体方案

1.Web界面支持展示暂存固件和待生效固件的版本号信息
2.UIRest接口支持获取暂存固件和待生效固件的版本号信息
3.新增资源协作接口方法，用于获取待生效固件信息

评审点一 Web界面支持展示暂存固件和待生效固件的版本号信息

详细描述

image
image1920×798 96.8 KB

image
image1920×543 82.1 KB

评审点二 UIRest接口支持获取暂存固件和待生效固件的版本号信息

详细描述

支持获取暂存固件版本号信息
URI: /UI/Rest/BMCSettings/UpdateService/UpdateProgress
操作类型：Get
操作权限： ReadOnly
变更类型：响应参数UpgradeTasks内增加Version字段
新增响应说明：

{
    "UpgradeTasks": [
        {
            "TaskName": "Staged Firmware",
            "Component": "CPLD(BCU_CPLD1_010101)",
            "FileName": "xxx.hpm",
            "TaskState": "Staged",
            "FirmwareId": "BCU_CPLD1_010101",
            "Version": "7.03"
        }
    ],
    "UpgradeMode": "Serial"
}
字段 字段说明 类型
Version 固件版本 String

支持获取待生效固件版本号信息
URI: /UI/Rest/BMCSettings/UpdateService/PendingFirmwareList
操作类型：Get
操作权限： ReadOnly
变更类型：响应参数PendingFirmwareList内增加Version字段
新增响应说明：

{
    "PendingFirmwareList": [
        {
            "SystemId": "1",
            "FirmwareType": "CPLD(BCU_CPLD1_010101)",
            "ActiveStatus": "ToBeActivated",
            "ActiveAction": "ACCycle",
            "Version": "7.03"
        }
    ]
}
字段 字段说明 类型
Version 固件版本 String

评审点三 新增资源协作接口方法，用于获取待生效固件信息

详细描述

资源协作path: /bmc/kepler/UpdateService（原有）
资源协作interface: bmc.kepler.UpdateService （原有）
变化类型：新增方法
方法名称：GetPendingFirmwareFullData

方法名称 权限 请求签名 请求参数 响应签名 响应参数 说明
GetPendingFirmwareFullData ReadOnly 无 无 a(a{ss}) PendingFirmwareList：类型为 array<dict> ，表征当前待生效固件信息信息，其中数组的每个元素 PendingFirmware都是一个待生效固件的信息。
当前 PendingFirmware 属性如下：
SystemId：类型为 string ，表征系统ID
Firmware：类型为 string ，表征待生效固件描述
FirmwareInstance：类型为 string ，表征待生效固件实例
ActiveStatus：类型为 string ，表征待生效固件的生效状态
ActiveAction：类型为 string ，表征待生效固件的生效动作
FirmwareId：类型为 string ，表征待生效固件Id
Version：类型为 string ，表征待生效固件的版本信息

评审结论

  1. 同意Web界面支持展示暂存固件和待生效固件的版本号信息，添加示例见评审点一
  2. 同意UIRest接口/UI/Rest/BMCSettings/UpdateService/UpdateProgress接口响应体中UpgradeTasks属性对象中新增Version属性，表示暂存固件的版本号；
  3. 同意UIRest接口/UI/Rest/BMCSettings/UpdateService/PendingFirmwareList接口响应体中PendingFirmwareList属性对象中新增Version属性，表示待生效固件的版本号信息；
  4. 同意新增资源协作接口方法GetPendingFirmwareFullData，用于获取待生效固件信息，签名a(a{ss})，详细响应参数见评审点三；