文档中心
SPFWUpdate
更新时间： 2026/07/01
在Gitcode上查看源码

ResourceDefinition ​

uris ​

  • /redfish/v1/Managers/manager_id/SPService/SPFWUpdate/updateid

properties ​

名称类型是否只读取值范围/枚举值说明
@odata.contextstringtrue升级资源模型的OData描述信息
@odata.idstringtrue升级资源的访问路径
@odata.typestringtrue升级资源的类型
Idstringtrue升级资源的Id
Namestringtrue升级资源的名称
TransferStatestringtrue升级文件传输状态
TransferFileNamestringtrue传输的文件名
TransferProgressPercentnumbertrue传输进度说明已屏蔽该属性频繁变化导致的事件上报
UpgradeProgressnumbertrue升级进度说明已屏蔽该属性频繁变化导致的事件上报
Messagesarraytrue提示消息
FileListarraytrue已经上传成功的文件名列表。
#SPFWUpdate.SimpleUpdateobjecttrue升级操作
codestringtrue指示消息注册表中特定消息ID的字符串。
messagestringtrue与消息注册表中的消息对应的易读的错误消息。
MessageIdstringtrue消息ID
RelatedPropertiesarraytrue消息相关属性
Messagestringtrue详细信息
MessageArgsarraytrue信息参数
Severitystringtrue严重性Redfish支持的严重级别包括：OK、Warning、Critical。
Resolutionstringtrue解决建议

supported_methods ​

  • GET
  • POST

HTTP methods ​

GET ​

命令功能

查询 SP 服务的升级资源

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/SPService/SPFWUpdate/updateid

请求头:

X-Auth-Token: auth_value

请求消息体: 无

参数说明

参数参数说明取值
device_ip登录设备的IP地址IPv4或IPv6地址
auth_value请求消息的鉴权参数可通过/redfish/v1/SessionService/Sessions创建会话时获得

使用指南

GA140C机型不支持 SP版本和机型兼容性列表详见Smart Provisioning用户指南

使用实例

请求样例： GET https://device_ip/redfish/v1/Managers/manager_id/SPService/SPFWUpdate/updateid

X-Auth-Token: auth_value 请求消息体：无

响应样例：

json
{
  "@odata.context": "/redfish/v1/$metadata#Managers/Members/1/SPService/SPFWUpdate/Members/$entity",
  "@odata.id": "/redfish/v1/Managers/1/SPService/SPFWUpdate/1",
  "@odata.type": "#HwSPFWUpdate.v1_0_0.HwSPFWUpdate",
  "Id": "1",
  "Name": "SP Framework Update",
  "TransferState": null,
  "TransferFileName": null,
  "TransferProgressPercent": null,
  "UpgradeProgress": null,
  "Messages": [],
  "FileList": [],
  "Actions": {
    "#SPFWUpdate.SimpleUpdate": {
      "target": "/redfish/v1/Managers/1/SPService/SPFWUpdate/1/Actions/SPFWUpdate.SimpleUpdate",
      "@Redfish.ActionInfo": "/redfish/v1/Managers/1/SPService/SPFWUpdate/1/SimpleUpdateActionInfo"
    }
  }
}

响应码：200

POST (ACTION) ​

SimpleUpdate ​

命令功能

升级 SP 或者升级固件

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/SPService/SPFWUpdate/update_id/Actions/SPFWUpdate.SimpleUpdate

请求头:

X-Auth-Token: auth_value
Content-Type: header_type

请求消息体:

json
{
  "ImageURI": "ImageURI_value",
  "SignalURI": "SignalURI_value",
  "ImageType": "ImageType_value",
  "Parameter": "Parameter_value",
  "UpgradeMode": "UpgradeMode_value",
  "ActiveMethod": "ActiveMethod_value"
}

请求头参数说明

参见 请求头参数说明

请求体参数说明

参数参数说明取值
updateid升级资源ID可通过查询集合资源获取
ImageURI_value升级文件文件路径（支持的文件传输的协议有https、sftp、nfs、cifs、scp、file） 说明Firmware支持以上六种协议，文件格式为zip。SP仅支持cifs和nfs 。 说明SP支持cifs和nfs两种协议， 升级文件可以为文件夹或iso文件。 文件名不能超过200个字符。
SignalURI_value升级文件对应的认证文件远程路径文件路径（支持的文件传输的协议有https、sftp、nfs、cifs、scp、file） 说明Firmware认证文件格式为asc和p7s，升级SP时，此参数无效。 文件名不能超过200个字符。
ImageType_value镜像类型镜像类型：
● Firmware
● SP
Parameter_value附带参数附带参数，可选值：all
UpgradeMode_value升级模式升级模式，可取值：
● Auto
● Recover
ActiveMethod_value生效方法生效方式，可选值：
● Immediately
● RestartOS
● RestartServer
● PowerCycle说明SP升级成功后即时生效，此参数无效。

使用指南

GA140C机型不支持 SP版本和机型兼容性列表详见Smart Provisioning用户指南

  1. 升级固件时，当固件包指定的生效方式优先级高于Restart时，以固件包指定生效 方式为准。
  2. 固件包支持Immediately、RestartOS、RestartServer、PowerCycle等生效方式。
  3. 生效方式优先级为：Immediately < RestartOS（同Restart）< RestartServer < PowerCycle。
  4. 业务侧上电到系统启动期间，该接口无法使用。
  5. SmartProvisioning启动和运行期间，该接口无法使用。 升级固件的流程如下（不适用于升级SP）：
  6. 请参阅本章节使用实例，完成任务下发。
  7. 请参阅3.2.71 修改SP服务资源属性，设置从Smart Provisioning启动使能。
  8. 在不影响服务器业务的情况下，请参阅3.3.4 重启服务器，重启完成后服务器自动 进入Smart Provisioning来执行升级任务。
  9. 请参阅3.2.84 查询SP服务的配置结果资源查询任务结果。 SP版本1.16.0及以上版本支持下发多任务执行。支持在上述步骤1中同时下发其他支持 多任务执行的接口任务，其他步骤与上述一致。支持多任务执行的任务接口和任务结 果请参阅3.2.84 查询SP服务的配置结果资源的使用指南中的相关描述。

使用实例

请求样例： POST https://device_ip/redfish/v1/Managers/manager_id/SPService/SPFWUpdate/update_id/Actions/SPFWUpdate.SimpleUpdate

X-Auth-Token: auth_value Content-Type: header_type 请求消息体：

json
{
  "ImageURI": "ImageURI_value",
  "SignalURI": "SignalURI_value",
  "ImageType": "ImageType_value",
  "Parameter": "Parameter_value",
  "UpgradeMode": "UpgradeMode_value",
  "ActiveMethod": "ActiveMethod_value"
}

响应样例：

json
{
  "error": {
    "code": "Base.1.0.GeneralError",
    "message": "A general error has occurred. See ExtendedInfo for more information.",
    "@Message.ExtendedInfo": [
      {
        "@odata.type": "#Message.v1_0_0.Message",
        "MessageId": "Base.1.0.Success",
        "RelatedProperties": [],
        "Message": "Successfully Completed Request",
        "MessageArgs": [],
        "Severity": "OK",
        "Resolution": "None"
      }
    ]
  }
}

响应码：200