SPOSInstallPara Redfish 接口参数 FirmwareList 必选问题分析

在使用 Redfish 接口 /redfish/v1/Managers/1/SPService/SPOSInstallPara 进行操作系统安装参数配置时，openUBMC 环境中该接口将 UploadFiles/FirmwareList 参数设置为必选字段，导致未携带此字段的请求失败；而在 BMC V2（如 iBMC）环境中，该参数为可选字段，请求可以正常通过。以下从问题现象、技术差异、设计背景和兼容性建议四个方面进行综合分析。

问题现象对比

项目	openUBMC 环境	BMC V2（iBMC）环境
接口路径	/redfish/v1/Managers/1/SPService/SPOSInstallPara	同上
FirmwareList 是否必选	是（必选）	否（可选）
请求缺失 FirmwareList 行为	返回 400 错误，提示缺少必填字段	返回 201 成功
错误信息示例	"The create operation failed because the required property UploadFiles/FirmwareList was missing from the request."	无错误，直接成功
工具兼容性影响	已有工具未传该字段 → 失败	工具无需该字段 → 成功运行

核心问题：

相同的业务操作（设置 OS 安装参数），由于不同 BMC 实现对同一 Redfish 接口的参数约束不一致，导致上层管理工具无法跨平台兼容，产生部署失败。

技术背景与差异原因

1. SPOSInstallPara 接口功能说明

此 Redfish 接口用于配置服务器操作系统自动安装（Smart Provisioning OS Install）的参数，包括：

• 操作系统类型（OSType）
• 安装模式（InstallMode）
• 引导方式（BootOption）
• 软件包上传列表（UploadList）
• 固件升级列表（UploadFiles/FirmwareList）

其中 FirmwareList 属于 UploadFiles 对象的一部分，用于指定在 OS 安装前/后需要同步升级的固件组件（如驱动、BMC、RAID 卡固件等）。

2. openUBMC 设计更严格校验的原因

根据 openUBMC 的设计哲学与 Redfish 规范一致性原则，可能存在以下背景动因：

提升 Redfish 接口规范性

openUBMC 作为开源项目，强调遵循 DMTF Redfish Schema 定义。若在 ODATA 模型（如 #HWSPSInstallPara）中将 UploadFiles/FirmwareList 定义为非空数组或必传对象，则实现层强制校验属于符合标准的严谨行为。

参考：Redfish Schema 中可通过 "Required": true 明确字段为必填。

确保操作完整性与一致性

当用户通过此接口配置 SP 安装参数时，openUBMC 可能希望所有关联资源（包括上传文件、固件列表）都应在初始请求中明确表达，避免后续因缺少关键依赖项而导致安装流程中断。

增强安全性与可审计性

强制要求上传项（即使是空数组）显式声明，有助于日志追踪和策略审计。例如，明确知道“用户主动选择不上传固件” vs “用户忘了传”。

3. BMC V2 兼容旧工具的设计逻辑

华为 iBMC（BMC V2）作为成熟商用平台，在接口设计上更强调：

• 向后兼容性：支持多种版本的部署工具（如 SmartKit、ServerDeployer），允许部分字段可选以保持平滑升级。
• 用户体验优先：对于非核心功能（如固件上传），允许省略字段，系统默认处理为空。

这反映了商用产品对生态兼容的妥协，而 openUBMC 更偏向标准统一与接口健壮性。

是否应兼容实现？建议与方案

虽然 openUBMC 的“强校验”设计在技术上是合理的，但从 工具通用性、用户迁移成本和生态建设角度来看，建议适度兼容 BMC V2 的行为。

结论：FirmwareList 可保持“结构上存在”，但允许其为空或可选传递。

建议改进方向

方案	描述	推荐度
1. 支持字段可选，但值可为空数组	若请求体中包含 UploadFiles，则 FirmwareList 必须存在；若整体 UploadFiles 不存在，则允许忽略。或允许 FirmwareList: []。	☆
2. 自动补全默认值	接收端自动补全缺失的 FirmwareList 字段为 []，并记录日志。保持对外严格性的同时提升兼容性。
3. 提供兼容模式开关	在系统配置中增加“Redfish 兼容模式”选项，针对特定接口放宽校验规则。

实际应对建议（短期）

针对当前工具失败问题，建议采取以下措施：

1. 修改调用方工具（推荐）

在请求体中显式添加 FirmwareList 字段：

{
  "UploadFiles": {
    "FirmwareList": []
  },
  "UploadList": [
    "driver-package.zip",
    "driver-package.zip.asc"
  ]
}

即使无固件需上传，也传递空数组 []，满足 openUBMC 的校验要求。

2. 统一 Redfish 接口建模

建议 openUBMC 社区在 CSR 或 Redfish 接口映射配置中明确定义：

• FirmwareList 字段是否必选
• 是否支持 null 或省略
• 提供示例与错误码文档说明（如 Base.1.0.CreateFailedMissingReqProperties）

总结

建议 openUBMC 团队评估是否可将 FirmwareList 调整为“存在时必填，整体可选”模式，以实现与现有工具链的良好兼容，同时不牺牲接口完整性。

相关链接：

1. /redfish/v1/UpdateService/FirmwareInventory 多个属性缺失
2. cpld升级的即时生效和掉电生效问题
3. openUBMC Redfish Resource未完全遵循DMTF Redfish schema
4. CPLD 升级流程介绍说明
5. https://www.openubmc.cn/docs/zh/development/api/framework_api/utils