ResourceDefinition

uris

/redfish/v1/Managers/manager_id/SPService

properties

名称	类型	是否只读	取值范围/枚举值	说明
@odata.context	string	true	-	SP服务资源模型的OData描述信息
@odata.id	string	true	-	SP服务资源的访问路径
@odata.type	string	true	-	SP服务资源的类型
Id	string	true	-	SP服务资源的ID
Name	string	true	-	SP服务资源的名称
SPStartEnabled	boolean	false	-	从SP启动的使能
SPAutoUpgradeSupported	boolean	true	-	是否支持使用Auto模式升级SP
SysRestartDelaySeconds	number	false	-	OS重启延时时间
SPTimeout	number	false	-	部署超时时间
SPFinished	boolean	false	-	部署事务状态
SPDeviceInfoCollectEnabled	boolean	false	-	SP设备信息收集功能的使能状态
Version {	object	false	-	SP版本信息
Version.APPVersion	string	true	-	应用程序版本
Version.OSRevision	string	true	-	SP版本
Version.DataVersion	string	true	-	数据版本
Version.OSVersion	string	true	-	欧拉版本
Version.MajorVersion	string	true	-	SP主版本
Version.ReleaseDate	string	true	-	发布日期
Version.BaseVersion	string	true	-	基础版本（SP 1.11.0及以上）
Version.PluginVersion	string	true	-	插件版本（SP 1.17.0及以上）
Version.Signature {	object	true	-	版本签名信息
Version.Signature.PGP {	object	true	-	PGP签名方式
Version.Signature.PGP.Suffix	string	true	-	对应签名方式的签名文件后缀
}
Version.Signature.CMS {	object	true	-	CMS签名方式
Version.Signature.CMS.Suffix	string	true	-	对应签名方式的签名文件后缀
}
}
}
SPRAID {	object	true	-	指定RAID卡配置资源的访问路径
`SPRAID.@odata.id`	string	true	-	SPRAID资源的访问路径
}
SPRAIDCurrentConfigurations {	object	true	-	指定RAID卡当前配置资源的访问路径
`SPRAIDCurrentConfigurations.@odata.id`	string	true	-	SPRAIDCurrentConfigurations资源的访问路径
}
SPOSInstallPara {	object	true	-	指定OS安装配置资源的访问路径
`SPOSInstallPara.@odata.id`	string	true	-	SPOSInstallPara资源的访问路径
}
SPFWUpdate {	object	true	-	指定升级资源的访问路径
`SPFWUpdate.@odata.id`	string	true	-	SPFWUpdate资源的访问路径
}
SPResult {	object	true	-	指定配置结果的访问路径
`SPResult.@odata.id`	string	true	-	SPResult资源的访问路径
}
SPCfg {	object	true	-	指定SP自身配置资源的访问路径
`SPCfg.@odata.id`	string	true	-	SPCfg资源的访问路径
}
DeviceInfo {	object	true	-	指定硬件信息资源的访问路径
`DeviceInfo.@odata.id`	string	true	-	DeviceInfo资源的访问路径
}
SPDiagnose {	object	true	-	指定诊断资源的访问路径
`SPDiagnose.@odata.id`	string	true	-	SPDiagnose资源的访问路径
}
SPDriveErase {	object	true	-	指定SP服务的硬盘擦除配置的访问路径
`SPDriveErase.@odata.id`	string	true	-	SPDriveErase资源的访问路径
}
SystemErase {	object	true	-	指定SP系统擦除配置的访问路径
`SystemErase.@odata.id`	string	true	-	SystemErase资源的访问路径
}
Plugins {	object	true	-	指定SP插件资源的访问路径
`Plugins.@odata.id`	string	true	-	Plugins资源的访问路径
}
Actions {	object	true	-	SP服务组密钥导入操作
Actions.#SPService.DeleteFile {	object	true	-	删除配置升级文件
`Actions.#SPService.DeleteFile.@Redfish.ActionInfo`	string	true	-	操作信息查询路径
Actions.#SPService.DeleteFile.target	string	true	-	操作路径
}
Actions.#SPService.ExportSPRAIDConfigurations {	object	true	-	导出RAID当前配置文件
`Actions.#SPService.ExportSPRAIDConfigurations.@Redfish.ActionInfo`	string	true	-	操作信息查询路径
Actions.#SPService.ExportSPRAIDConfigurations.target	string	true	-	操作路径
}
Actions.#SPService.UpdateSchemaFiles {	object	true	-	更新SP相关的schema文件
`Actions.#SPService.UpdateSchemaFiles.@Redfish.ActionInfo`	string	true	-	操作信息查询路径
Actions.#SPService.UpdateSchemaFiles.target	string	true	-	操作路径
}
Actions.#SPService.Dump {	object	true	-	收集SP相关日志收集，仅在openUBMC 25.12 LTS及以上版本支持
Actions.#SPService.Dump.FileList [ {	array	true	-	Dump文件列表
Actions.#SPService.Dump.FileList[].Type	string	false	-	文件类型
Actions.#SPService.Dump.FileList[].Name	string	true	-	SP服务资源的名称
} ]
`Actions.#SPService.Dump.@Redfish.ActionInfo`	string	true	-	操作信息查询路径
Actions.#SPService.Dump.target	string	true	-	操作路径
}
}

supported_methods

GET
PATCH
POST

HTTP methods

GET

命令功能

查询 SP 服务资源

命令格式

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

请求头:

text

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

请求头:

text

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
SPFinished	SP任务完成状态	● true：已完成 ● false：未完成说明设置SPFinished为true，可提前终止SP任务。支持终止的任务如下：1. 硬件诊断（请参阅3.2.81-创建SP服务的诊断配置）2. 硬盘擦除（请参阅3.2.84-创建SP服务的硬盘擦除配置）3. OS安装（请参阅3.2.70-创建SP服务的OS安装配置）
SPDeviceInfoCollectEnabled	SP设备信息收集功能的使能状态	● 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

请求头:

text

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

请求消息体:

json

{
"Type": value
}

请求头参数说明

参见请求头参数说明

请求体参数说明

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

使用指南

openUBMC 25.12 LTS及以上版本支持删除系统擦除配置功能。 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

请求头:

text

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

请求消息体:

json

{}

请求头参数说明

参见请求头参数说明

请求体参数说明

无

使用指南

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

请参阅本章节使用实例，完成任务下发。
请参阅3.2.71 修改SP服务资源属性，设置从Smart Provisioning启动使能。
在不影响服务器业务的情况下，请参阅3.3.4 重启服务器，重启完成后服务器自动进入Smart Provisioning来执行导出任务。
请参阅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

请求头:

text

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

请求消息体:

json

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

请求头参数说明

参见请求头参数说明

请求体参数说明

参数	参数说明	取值
checksum_value	压缩包的校验和	● 需满足如下正则：^[0-9a-fA-F]{64}$ ● 校验和获取算法SHA256
filename	schema压缩包文件名	● 需满足如下正则：^(.) {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

请求头:

text

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

使用指南

仅在openUBMC 25.12 LTS及以上版本支持 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

ResourceDefinition ​

uris ​

properties ​

supported_methods ​

HTTP methods ​

GET ​

PATCH ​

POST (ACTION) ​

DeleteFile ​

POST (ACTION) ​

ExportSPRAIDConfigurations ​

POST (ACTION) ​

UpdateSchemaFiles ​

POST (ACTION) ​

Dump ​

ResourceDefinition

uris

properties

supported_methods

HTTP methods

GET

PATCH

POST (ACTION)

DeleteFile

POST (ACTION)

ExportSPRAIDConfigurations

POST (ACTION)

UpdateSchemaFiles

POST (ACTION)

Dump