代码仓
中
文档中心
SPService
更新时间： 2026/07/01
在AtomGit上查看源码

ResourceDefinition ​

uris ​

  • /redfish/v1/Managers/manager_id/SPService

properties ​

名称类型是否只读取值范围/枚举值说明
@odata.contextstringtrue-SP服务资源模型的OData描述信息
@odata.idstringtrue-SP服务资源的访问路径
@odata.typestringtrue-SP服务资源的类型
Idstringtrue-SP服务资源的ID
Namestringtrue-SP服务资源的名称
SPStartEnabledbooleanfalse-从SP启动的使能
SPAutoUpgradeSupportedbooleantrue-是否支持使用Auto模式升级SP
SysRestartDelaySecondsnumberfalse-OS重启延时时间
SPTimeoutnumberfalse-部署超时时间
SPFinishedbooleanfalse-部署事务状态
SPDeviceInfoCollectEnabledbooleanfalse-SP设备信息收集功能的使能状态
Version {objectfalse-固件版本
Version.APPVersionstringtrue-应用程序版本
Version.OSRevisionstringtrue-SP版本
Version.DataVersionstringtrue-数据版本
Version.OSVersionstringtrue-欧拉版本
Version.MajorVersionstringtrue-SP主版本
Version.ReleaseDatestringtrue-发布日期
Version.BaseVersionstringtrue-基础版本（SP 1.11.0及以上）
Version.PluginVersionstringtrue-插件版本（SP 1.17.0及以上）
Version.Signature {objecttrue-版本签名信息
Version.Signature.PGP {objecttrue-PGP签名方式
Version.Signature.PGP.Suffixstringtrue-对应签名方式的签名文件后缀
}
Version.Signature.CMS {objecttrue-CMS签名方式
Version.Signature.CMS.Suffixstringtrue-对应签名方式的签名文件后缀
}
}
}
SPRAID {objecttrue-指定RAID卡配置资源的访问路径
SPRAID.@odata.idstringtrue-SPRAID资源的访问路径
}
SPRAIDCurrentConfigurations {objecttrue-指定RAID卡当前配置资源的访问路径
SPRAIDCurrentConfigurations.@odata.idstringtrue-SPRAIDCurrentConfigurations资源的访问路径
}
SPOSInstallPara {objecttrue-指定OS安装配置资源的访问路径
SPOSInstallPara.@odata.idstringtrue-SPOSInstallPara资源的访问路径
}
SPFWUpdate {objecttrue-指定升级资源的访问路径
SPFWUpdate.@odata.idstringtrue-SPFWUpdate资源的访问路径
}
SPResult {objecttrue-指定配置结果的访问路径
SPResult.@odata.idstringtrue-SPResult资源的访问路径
}
SPCfg {objecttrue-指定SP自身配置资源的访问路径
SPCfg.@odata.idstringtrue-SPCfg资源的访问路径
}
DeviceInfo {objecttrue-指定硬件信息资源的访问路径
DeviceInfo.@odata.idstringtrue-DeviceInfo资源的访问路径
}
SPDiagnose {objecttrue-指定诊断资源的访问路径
SPDiagnose.@odata.idstringtrue-SPDiagnose资源的访问路径
}
SPDriveErase {objecttrue-指定SP服务的硬盘擦除配置的访问路径
SPDriveErase.@odata.idstringtrue-SPDriveErase资源的访问路径
}
SystemErase {objecttrue-指定SP系统擦除配置的访问路径
SystemErase.@odata.idstringtrue-SystemErase资源的访问路径
}
Plugins {objecttrue-指定SP插件资源的访问路径
Plugins.@odata.idstringtrue-Plugins资源的访问路径
}
Actions {objecttrue-SP服务组密钥导入操作
Actions.#SPService.DeleteFile {objecttrue-删除配置升级文件
Actions.#SPService.DeleteFile.@Redfish.ActionInfostringtrue-操作信息查询路径
Actions.#SPService.DeleteFile.targetstringtrue-操作路径
}
Actions.#SPService.ExportSPRAIDConfigurations {objecttrue-导出RAID当前配置文件
Actions.#SPService.ExportSPRAIDConfigurations.@Redfish.ActionInfostringtrue-操作信息查询路径
Actions.#SPService.ExportSPRAIDConfigurations.targetstringtrue-操作路径
}
Actions.#SPService.UpdateSchemaFiles {objecttrue-更新SP相关的schema文件
Actions.#SPService.UpdateSchemaFiles.@Redfish.ActionInfostringtrue-操作信息查询路径
Actions.#SPService.UpdateSchemaFiles.targetstringtrue-操作路径
}
Actions.#SPService.Dump {objecttrue-收集SP相关日志收集，仅在BMC300 5.7.3.9及以上版本支持
Actions.#SPService.Dump.FileList [ {arraytrue-Dump文件列表
Actions.#SPService.Dump.FileList[].Typestringfalse-文件类型
Actions.#SPService.Dump.FileList[].Namestringtrue-SP服务资源的名称
} ]
Actions.#SPService.Dump.@Redfish.ActionInfostringtrue-操作信息查询路径
Actions.#SPService.Dump.targetstringtrue-操作路径
}
}

supported_methods ​

  • GET
  • PATCH
  • POST

HTTP methods ​

GET ​

命令功能

查询 SP 服务资源

命令格式

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

请求头:

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

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

响应码：200

PATCH ​

命令功能

修改 SP 服务资源属性

命令格式

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

请求头:

X-Auth-Token: auth_value
Content-Type: header_type
If-Match: ifmatch_value

请求消息体:

json
{
  "SPStartEnabled": SPStartEnabled_value,
  "SysRestartDelaySeconds": seconds_value,
  "SPTimeout": timeout_value,
  "SPFinished": finished_value,
  "SPDeviceInfoCollectEnabled": DeviceInfoCollectEnabled_value
}

请求头参数说明

参见 请求头参数说明

请求体参数说明

参数参数说明取值
SPStartEnabled从SP启动使能● true：开启
● false：关闭
SysRestartDelaySeconds系统重启时间整型，取值大于0
SPTimeout部署超时时间300 ~ 86400，默认7200
SPFinishedSP任务完成状态● true：已完成
● false：未完成说明设置SPFinished为true， 可提前终止SP任务。 支持终止的任务如下：1. 硬件诊断（请参阅3.2.81-创建SP服务的诊断配置） 2. 硬盘擦除（请参阅3.2.84-创建SP服务的硬盘擦除配置） 3. OS安装（请参阅3.2.70-创建SP服务的OS安装配置）
SPDeviceInfoCollectEnabledSP设备信息收集功能的使能状态● true：开启
● false：关闭

使用指南

可同时设置多个服务的参数。 GA140C机型不支持 SP版本和机型兼容性列表详见Smart Provisioning用户指南

使用实例

请求样例： PATCH https://device_ip/redfish/v1/Managers/manager_id/SPService

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

json
{
  "SPStartEnabled": SPStartEnabled_value,
  "SysRestartDelaySeconds": seconds_value,
  "SPTimeout": timeout_value,
  "SPFinished": finished_value,
  "SPDeviceInfoCollectEnabled": DeviceInfoCollectEnabled_value
}

响应样例：

json
{
  "@odata.context": "/redfish/v1/$metadata#Managers/Members/1/SPService/$entity",
  "@odata.id": "/redfish/v1/Managers/1/SPService",
  "@odata.type": "#HwSPService.v1_0_0.HwSPService",
  "Id": "SPService",
  "Name": "SPService",
  "SPStartEnabled": false,
  "SPAutoUpgradeSupported": true,
  "SysRestartDelaySeconds": 30,
  "SPTimeout": 300,
  "SPFinished": false,
  "SPDeviceInfoCollectEnabled": false,
  "Version": {
    "APPVersion": "1.9.0.23",
    "OSRevision": "1.9.0.23",
    "DataVersion": "1.9.0.23",
    "OSVersion": "EulerOS 2.0 (SP11)",
    "MajorVersion": "3",
    "ReleaseDate": "2023-07-26",
    "BaseVersion": "1.17.0.24",
    "PluginVersion": "1.0.0",
    "Signature": {
      "PGP": {
        "Suffix": "asc"
      },
      "CMS": {
        "Suffix": "p7s"
      }
    }
  },
  "SPRAID": {
    "@odata.id": "/redfish/v1/Managers/1/SPService/SPRAID"
  },
  "SPRAIDCurrentConfigurations": {
    "@odata.id": "/redfish/v1/Managers/1/SPService/SPRAIDCurrentConfigurations"
  },
  "SPOSInstallPara": {
    "@odata.id": "/redfish/v1/Managers/1/SPService/SPOSInstallPara"
  },
  "SPFWUpdate": {
    "@odata.id": "/redfish/v1/Managers/1/SPService/SPFWUpdate"
  },
  "SPResult": {
    "@odata.id": "/redfish/v1/Managers/1/SPService/SPResult"
  },
  "SPCfg": {
    "@odata.id": "/redfish/v1/Managers/1/SPService/SPCfg"
  },
  "DeviceInfo": {
    "@odata.id": "/redfish/v1/Managers/1/SPService/DeviceInfo"
  },
  "SPDiagnose": {
    "@odata.id": "/redfish/v1/Managers/1/SPService/SPDiagnose"
  },
  "SPDriveErase": {
    "@odata.id": "/redfish/v1/Managers/1/SPService/SPDriveErase"
  },
  "SystemErase": {
    "@odata.id": "/redfish/v1/Managers/1/SPService/SystemErase"
  },
  "Plugins": {
    "@odata.id": "/redfish/v1/Managers/1/SPService/Plugins"
  },
  "Actions": {
    "#SPService.DeleteFile": {
      "target": "/redfish/v1/Managers/1/SPService/Actions/SPService.DeleteFile",
      "@Redfish.ActionInfo": "/redfish/v1/Managers/1/SPService/DeleteFileActionInfo"
    },
    "#SPService.ExportSPRAIDConfigurations": {
      "target": "/redfish/v1/Managers/1/SPService/Actions/SPService.ExportSPRAIDConfigurations",
      "@Redfish.ActionInfo": "/redfish/v1/Managers/1/SPService/ExportSPRAIDConfigurationsActionInfo"
    },
    "#SPService.UpdateSchemaFiles": {
      "target": "/redfish/v1/Managers/1/SPService/Actions/SPService.UpdateSchemaFiles",
      "@Redfish.ActionInfo": "/redfish/v1/Managers/1/SPService/UpdateSchemaFilesActionInfo"
    },
    "#SPService.Dump": {
      "target": "/redfish/v1/Managers/1/SPService/Actions/SPService.Dump",
      "@Redfish.ActionInfo": "/redfish/v1/Managers/1/SPService/DumpActionInfo",
      "FileList": [
        {
          "Type": "RAIDCfg",
          "Name": "mainboardraidcard1.json"
        }
      ]
    }
  }
}

响应码：200

POST (ACTION) ​

DeleteFile ​

命令功能

删除 SP 服务的升级文件或者配置文件

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/SPService/Actions/SPService.DeleteFile

请求头:

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

请求消息体:

json
{
  "Type": value
}

请求头参数说明

参见 请求头参数说明

请求体参数说明

参数参数说明取值
value删除配置文件或者升级文件● RAIDCfg：删除RAID卡配置
● FWUpdateCfg：删除升级文件
● DriveEraseCfg：删除硬盘擦除配置
● SystemEraseCfg：删除系统擦除配置
● DiagnoseCfg：删除诊断配置
● OSInstallParaCfg：删除OS安装配置

使用指南

BMC300 5.3.0.1及以上版本支持删除系统擦除配置功能。 GA140C机型不支持 SP版本和机型兼容性列表详见Smart Provisioning用户指南

使用实例

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

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

json
{
  "Type": 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

POST (ACTION) ​

ExportSPRAIDConfigurations ​

命令功能

触发导出 SP 服务的 RAID 当前配置

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/SPService/Actions/SPService.ExportSPRAIDConfigurations

请求头:

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

请求消息体:

json
{}

请求头参数说明

参见 请求头参数说明

请求体参数说明

无

使用指南

GA140C机型不支持 SP版本和机型兼容性列表详见Smart Provisioning用户指南 触发导出SP服务的RAID当前配置的流程如下：

  1. 请参阅本章节使用实例，完成任务下发。
  2. 请参阅3.2.71 修改SP服务资源属性，设置从Smart Provisioning启动使能。
  3. 在不影响服务器业务的情况下，请参阅3.3.4 重启服务器，重启完成后服务器自动 进入Smart Provisioning来执行导出任务。
  4. 请参阅3.2.84 查询SP服务的配置结果资源查询任务结果。

使用实例

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

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

json
{}

响应样例：

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

POST (ACTION) ​

UpdateSchemaFiles ​

命令功能

更新 SP 相关的 schema 文件

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/SPService/Actions/SPService.UpdateSchemaFiles

请求头:

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

请求消息体:

json
{
  "ChecksumValue": checksum_value,
  "FileName": filename
}

请求头参数说明

参见 请求头参数说明

请求体参数说明

参数参数说明取值
checksum_value压缩包的校验和● 需满足如下正则： ^[0-9a-fA-F]{64}$
● 校验和获取算法SHA256
filenameschema压缩包文件名● 需满足如下正则：^(.) {5,255}$
● schema文件放置路径 “/tmp/web/文件名”

使用指南

该接口提供给SP使用，SP升级完成后调用该接口复制SP的schema到redfish目录下。 GA140C机型不支持 SP版本和机型兼容性列表详见Smart Provisioning用户指南

使用实例

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

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

json
{
  "ChecksumValue": checksum_value,
  "FileName": filename
}

响应样例：

json
{
  "@odata.context": "/redfish/v1/$metadata#TaskService/Tasks/Members/$entity",
  "@odata.type": "#Task.v1_0_2.Task",
  "@odata.id": "/redfish/v1/TaskService/Tasks/1",
  "Id": "1",
  "Name": "Update SP Schema Files Task",
  "Description": "",
  "TaskState": "Running",
  "TaskStatus": "OK",
  "StartTime": "2019-08-16T03:37:25+00:00",
  "Messages": [],
  "PercentComplete": null,
  "Oem": {
    "Public": {
      "TaskPercentage": null
    }
  }
}

响应码：200

POST (ACTION) ​

Dump ​

命令功能

收集 SP 相关的日志信息

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/SPService/Actions/SPService.Dump

请求头:

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

请求消息体:

json
{
  "Type": type_value,
  "Content": content_value
}

请求头参数说明

参见 请求头参数说明

请求体参数说明

参数参数说明取值
type_value收集日志的方法● URI
content_value收集sp相关日志的路径操作路径
● 本地导出："/tmp/文件名"
● 远程导出："sftp://用户名:用户密码@{IP}/目录/文件名"
文件传输协议包括五种：sftp、https、nfs、cifs、scp

使用指南

仅在BMC300 5.7.3.9及以上版本支持 GA140C机型不支持 SP版本和机型兼容性列表详见Smart Provisioning用户指南

使用实例

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

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

json
{
  "Type": type_value,
  "Content": content_value
}

响应样例：

json
{
  "@odata.context": "/redfish/v1/$metadata#Task.Task",
  "@odata.type": "#Task.v1_0_2.Task",
  "@odata.id": "/redfish/v1/TaskService/Tasks/1",
  "Id": "1",
  "Name": "Dump Sp Info Task",
  "Description": "",
  "TaskState": "Running",
  "TaskStatus": "OK",
  "StartTime": "2024-12-23T20:58:08+08:00",
  "Messages": [],
  "PercentComplete": null,
  "Oem": {
    "Public": {
      "TaskPercentage": null
    }
  }
}

响应码：202

下一篇探索openUBMC