代码仓
中
SPResult
更新时间: 2026/10/29
在AtomGit上查看源码

ResourceDefinition ​

uris ​

  • /redfish/v1/Managers/manager_id/SPService/SPResult/result_id

properties ​

名称类型是否只读取值范围/枚举值说明
@odata.contextstringtrue-配置结果资源模型的OData描述信息
@odata.idstringtrue-配置结果资源的访问路径
@odata.typestringtrue-配置结果资源的类型
Idstringtrue-配置结果资源的Id
Namestringtrue-配置结果资源的名称
Statusstringfalse-配置状态
● Idle:空闲状态
● Init:初始化中
● Deploying:正在部署
● Timeout:部署超时
● Finished:部署完成
OSInstall {objectfalse-基础部署的结果
OSInstall.TaskStatestringfalse-任务状态,包括:
● New:新建
● Starting:启动中
● Running:运行中
● Completed:已完成
● Cancelled:已取消
● Interrupted:已中断
● Exception:异常
OSInstall.Progressstringfalse-部署进度
OSInstall.Results[ ]arrayfalse-部署结果集合
OSInstall.Results[].OSTypestringfalse-镜像系统类型,如Suse 12.2
OSInstall.Results[].Statusstringfalse-安装状态,包括:
● Successful:成功
● Failed:失败
OSInstall.Results[].Stepstringfalse-当前任务描述
● SP Runing:SP运行中
● PRE:准备阶段
● OS Deploying:OS部署中
● POST:POST阶段
● FirstBoot:首次启动
● Finished:已完成
● Check OS Image:检查OS镜像
OSInstall.Results[].StartTimestringfalse-任务开始时间
OSInstall.Results[].EndTimestringfalse-任务结束时间
OSInstall.Results[].ErrorInfostringfalse-错误信息
}
Diagnose {objectfalse-硬件诊断任务结果
Diagnose.TaskStatestringfalse-任务状态,含义同OSInstall.TaskState
Diagnose.Operatestringfalse-操作类型,取值为Diagnose
Diagnose.DiagFinishedbooleanfalse-诊断是否已经完成
Diagnose.RebootDelayMinutesnumberfalse-延迟重启时间,下发诊断任务设置延迟重启时间后显示。说明:SP 1.21.0及之后版本支持。
Diagnose.Detail[ ]arrayfalse-诊断结果详细信息,详情见CPU、内存、硬盘详细信息表
Diagnose.Detail[].Devicestringfalse-诊断设备
Diagnose.Detail[].Statusstringfalse-诊断状态
Diagnose.Detail[].Descriptionstringfalse-诊断描述
Diagnose.Detail[].Remarkstringfalse-诊断所处阶段
Diagnose.Detail[].Progressstringfalse-诊断进度
Diagnose.Detail[].UsedTimestringfalse-诊断用时
Diagnose.Detail[].StartTimestringfalse-诊断开始时间
Diagnose.Detail[].EndTimestringfalse-诊断结束时间
Diagnose.Detail[].Modestringfalse-诊断类型
Diagnose.Detail[].DurationMinutesnumberfalse-诊断持续时间,CPU和内存支持配置
Diagnose.Detail[].Detail[ ]arrayfalse-诊断子项详细信息,详情见CPU、内存、硬盘详细信息表
Diagnose.Detail[].Detail[].Namestringfalse-部件名称
Diagnose.Detail[].Detail[].Modelstringfalse-部件型号
Diagnose.Detail[].Detail[].CPUIDstringfalse-部件CPUID
Diagnose.Detail[].Detail[].ClockSpeedstringfalse-部件主频
Diagnose.Detail[].Detail[].Statusstringfalse-部件状态
Diagnose.Detail[].Detail[].Qtystringfalse-部件规格,如48 cores/48 threads
Diagnose.Detail[].Detail[].Manufacturerstringfalse-部件厂商
Diagnose.Detail[].Detail[].DiagnoseResultstringfalse-部件诊断结果
}
DriveErase {objectfalse-硬盘擦除任务结果
DriveErase.TaskStatestringfalse-任务状态,含义同OSInstall.TaskState
DriveErase.Operatestringfalse-操作类型,取值为DriveErase
DriveErase.EraseModestringfalse-硬盘擦除模式
DriveErase.EraseStrategystringfalse-硬盘擦除策略
DriveErase.EraseFinishedbooleanfalse-硬盘擦除结束标志
DriveErase.Details[ ]arrayfalse-硬盘擦除详细信息
DriveErase.Details[].ControllerNamestringfalse-控制器名称
DriveErase.Details[].ControllerBDFstringfalse-控制器BDF
DriveErase.Details[].ControllerTypestringfalse-控制器类型
DriveErase.Details[].DriveList[ ]arrayfalse-控制器下的硬盘列表
DriveErase.Details[].DriveList[].EidSltstringfalse-物理槽位号
DriveErase.Details[].DriveList[].PciePathstringfalse-Pcie路径
DriveErase.Details[].DriveList[].DeviceLocatorstringfalse-硬盘丝印
DriveErase.Details[].DriveList[].Statestringfalse-硬盘状态
DriveErase.Details[].DriveList[].Modelstringfalse-硬盘型号
DriveErase.Details[].DriveList[].CapacityGiBstringfalse-容量
DriveErase.Details[].DriveList[].Interfacestringfalse-硬盘接口
DriveErase.Details[].DriveList[].MediaTypestringfalse-媒体类型
DriveErase.Details[].DriveList[].SerialNumberstringfalse-序列号
DriveErase.Details[].DriveList[].FirmwareVersionstringfalse-固件版本
DriveErase.Details[].DriveList[].Manufacturerstringfalse-硬盘厂商
DriveErase.Details[].DriveList[].Statusstringfalse-擦除状态
DriveErase.Details[].DriveList[].Descriptionstringfalse-擦除描述
DriveErase.Details[].DriveList[].Progressstringfalse-擦除进度
DriveErase.Details[].DriveList[].UsedTimestringfalse-擦除用时
DriveErase.Details[].DriveList[].StartTimestringfalse-擦除开始时间
DriveErase.Details[].DriveList[].EndTimestringfalse-擦除结束时间
}
RaidCfg {objectfalse-RAID配置任务结果
RaidCfg.TaskStatestringfalse-任务状态,含义同OSInstall.TaskState
RaidCfg.Progressstringfalse-RAID配置进度
RaidCfg.Detail[ ]arrayfalse-RAID配置详细信息
RaidCfg.Detail[].CardModelstringfalse-RAID卡型号
RaidCfg.Detail[].StartTimestringfalse-RAID配置开始时间
RaidCfg.Detail[].EndTimestringfalse-RAID配置结束时间
RaidCfg.Detail[].Operationstringfalse-操作类型
RaidCfg.Detail[].Descriptionstringfalse-RAID配置描述
RaidCfg.Detail[].Statusstringfalse-RAID配置状态
}
Upgrade {objectfalse-固件升级任务结果
Upgrade.TaskStatestringfalse-任务状态,含义同OSInstall.TaskState
Upgrade.Operationstringfalse-操作类型,取值为Upgrade
Upgrade.Progressstringfalse-固件升级进度
Upgrade.ActiveModestringfalse-固件生效模式,如ResetOS
Upgrade.Detail[ ]arrayfalse-固件升级详细信息
Upgrade.Detail[].Firmwarestringfalse-升级固件包名称
Upgrade.Detail[].StartTimestringfalse-升级开始时间
Upgrade.Detail[].EndTimestringfalse-升级结束时间
Upgrade.Detail[].DeviceNamestringfalse-设备名称,未上报时为null
Upgrade.Detail[].Locationnullfalse-设备位置,未上报时为null
Upgrade.Detail[].DeviceBDFnullfalse-设备BDF,未上报时为null
Upgrade.Detail[].SerialNumberstringfalse-设备序列号,未上报时为null
Upgrade.Detail[].Statusstringfalse-升级状态
Upgrade.Detail[].Devicestringfalse-设备型号
Upgrade.Detail[].DeviceUIDnullfalse-设备UID,未上报时为null
Upgrade.Detail[].LastVersionnullfalse-升级前版本,未上报时为null
Upgrade.Detail[].NewVersionstringfalse-升级后版本
Upgrade.Detail[].Descriptionstringfalse-升级描述
Upgrade.Detail[].DeviceTypestringfalse-设备类型
Upgrade.Detail[].ActiveModestringfalse-生效模式
Upgrade.Detail[].UpgradeTimestringfalse-升级耗时,单位为毫秒
}
SoftwareInstall {objectfalse-软件安装任务结果
SoftwareInstall.FirstBootScript {objectfalse-客户自定义首次启动脚本安装结果
SoftwareInstall.FirstBootScript.ErrorCodestringfalse-客户自定义首次启动脚本安装错误码
SoftwareInstall.FirstBootScript.Messagestringfalse-客户自定义首次启动脚本安装结果信息
}
SoftwareInstall.iBMA {objectfalse-iBMA安装结果
SoftwareInstall.iBMA.ErrorCodestringfalse-iBMA安装错误码
SoftwareInstall.iBMA.Messagestringfalse-iBMA安装结果信息
}
SoftwareInstall.iDriver {objectfalse-iDriver安装结果
SoftwareInstall.iDriver.ErrorCodestringfalse-iDriver安装错误码
SoftwareInstall.iDriver.Messagestringfalse-iDriver安装结果信息
}
SoftwareInstall.UploadFiles {objectfalse-上传文件结果
SoftwareInstall.UploadFiles.ErrorCodestringfalse-上传文件错误码
SoftwareInstall.UploadFiles.Messagestringfalse-上传文件结果信息
}
SoftwareInstall.CheckCompatibility {objectfalse-兼容性检查结果
SoftwareInstall.CheckCompatibility.ErrorCodestringfalse-兼容性检查错误码
SoftwareInstall.CheckCompatibility.Messagestringfalse-兼容性检查结果信息
SoftwareInstall.CheckCompatibility.IncompatibleList[ ]arrayfalse-不兼容部件列表
}
}

其它任务类型字段说明 ​

以下字段为其它任务类型(多节点传输链、资产核查、早期版本)返回的属性,不在下文的多任务执行结果示例中出现,单独说明如下:

字段数据类型是否只读取值范围/枚举值说明
GroupIdstringfalse-节点所属分组
NodeTypestringfalse-节点在传输链中的类型
● root:根节点
● child:子节点
Children[ ]arrayfalse-根节点下挂子节点,NodeType取值为root时有效,数组元素为对象(子节点UUID)
UUIDstringfalse-节点唯一ID
DeviceBusstringfalse-BDF信息
UIDstringfalse-设备ID信息
CurrentVersionstringfalse-当前版本
TargetVersionstringfalse-目标版本
AssetVerification{}objectfalse-核查资产类型
● CountVerification:数量校验
CountVerification[ ]arrayfalse-核查数量类型的资产信息
CountItemstringfalse-核查数量类型的资产信息子项
● Memory:内存
ActualTestResultstringtrue-测试项实际测试结果
Capacitystringtrue-容量
DiagnoseMessagestringtrue-具体的诊断信息
DignoseResultstringtrue-诊断结果:Successful;Failed
ExpectedTestResultstringtrue-测试项预期测试结果
MaxPowerstringtrue-最大功耗
PartNumberstringtrue-部件号
Positionstringtrue-NPU位置,如:0_0,标识,该项NPU为第0号槽位Chip 0位置。
PushTimeoutMinutesnumbertrue-日志导出超时时间
Resultstringtrue-测试结果:Pass,Fail,Warning
ResultRawstringtrue-非必有,测试结果原始数值
TaskNamestringtrue-测试项名称
Thresholdnumbertrue-阈值
Typestringtrue-类型
Valuenumbertrue-测试数据
ActionOnCompletedobjecttrue-诊断完成后的操作
DumpEnabledbooleantrue-是否使能日志收集操作
LogDumpobjecttrue-日志收集操作
Metrics[ ]arraytrue-测试项数值矩阵,具体字段表3-222
Reason[ ]arraytrue-非必有,若Result为非Pass,则显示失败原因
Reasons[ ]arraytrue-失败原因
Suggestion[ ]arraytrue-非必有,显示诊断建议。
TaskList[ ]arraytrue-已执行任务列表,具体字段表3-223

supported_methods ​

  • GET

HTTP methods ​

GET ​

命令功能

查询 SP 服务的配置结果资源

命令格式

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

请求头:

text
X-Auth-Token: auth_value

请求消息体: 无

参数说明

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

使用指南

响应结果以最新SP版本的实际返回结果为准。 使用SP服务过程中,请勿重启BMC,否则获取的配置结果资源将无效。 GA140C机型不支持。 SP版本和机型兼容性列表详见Smart Provisioning用户指南 Smart Provisioning 1.16.0及以上版本支持下发多个接口任务,使能启动SP连续执行任务。 支持多任务执行的接口包括:

  1. 硬件诊断(请参阅3.2.88 创建SP服务的诊断配置)
  2. 硬盘擦除(请参阅3.2.91 创建SP服务的硬盘擦除配置)
  3. OS安装(请参阅3.2.77 创建SP服务的OS安装配置)
  4. 固件升级(请参阅3.2.81 升级SP或者升级固件)

若任意以上接口任务同时存在,则按上述顺序依次执行任务。多任务执行的结果可参见下文的多任务执行结果示例。 在多任务执行过程中,支持下发终止任务请求。若当前正在执行的任务支持终止,则终止当前执行中的任务及后续未执行任务;若当前正在执行的任务不支持终止,则执行完当前任务后,终止后续任务。终止任务执行结果可参见下文的终止任务执行结果示例。 支持终止的任务如下:

  1. 硬件诊断(请参阅3.2.88 创建SP服务的诊断配置)
  2. 硬盘擦除(请参阅3.2.91 创建SP服务的硬盘擦除配置)
  3. OS安装(请参阅3.2.77 创建SP服务的OS安装配置)

如需终止任务执行,请参阅3.2.71 修改SP服务资源属性,设置SPFinished为true以下发终止任务请求。

使用实例

请求样例: GET https://device_ip/redfish/v1/Managers/manager_id/SPService/SPResult/result_id

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

响应样例4:

json
{
"@odata.context": "/redfish/v1/$metadata#Managers/Members/1/SPService/SPResult/Members/$entity",
"@odata.id": "/redfish/v1/Managers/1/SPService/SPResult/1",
"@odata.type": "#hwSPResult.v1_0_0.HwSPResult",
"Id": "1",
"Name": "SP Result",
"Status": "Finished",
"OSInstall": {
"TaskState": "Completed",
"Progress": "100",
"Results": [
{
"OSType": "openEuler.x",
"Status": "Successful",
"Step": "Finished",
"StartTime": "2024-10-31 22:09:13",
"EndTime": "2024-10-31 22:35:15",
"ErrorInfo": ""
}
]
},
"Diagnose": {
"TaskState": "Completed",
"Operate": "Diagnose",
"DiagFinished": true,
"RebootDelayMinutes": 10,
"Detail": [
{
"Device": "CPU",
"Status": "Successful",
"Description": "Diagnose CPU successfully",
"Remark": "CPUOK",
"Progress": "100",
"UsedTime": "01:04",
"StartTime": "2024-10-31 22:07:21",
"EndTime": "2024-10-31 22:08:26",
"Mode": "Full",
"DurationMinutes": 1,
"Detail": [
{
"Name": "CPU01",
"Model": "Kunpeng 920-4826",
"CPUID": "10-D0-1F-48-00-00-00-00",
"ClockSpeed": "2600 MHz",
"Status": "Populated, Enabled",
"Qty": "48 cores/48 threads",
"Manufacturer": "--",
"DiagnoseResult": "Successful"
},
{
"Name": "CPU02",
"Model": "Kunpeng 920-4826",
"CPUID": "10-D0-1F-48-00-00-00-00",
"ClockSpeed": "2600 MHz",
"Status": "Populated, Enabled",
"Qty": "48 cores/48 threads",
"Manufacturer": "--",
"DiagnoseResult": "Successful"
}
]
}
]
},
"DriveErase": {
"TaskState": "Completed",
"Operate": "DriveErase",
"EraseMode": "Quick",
"EraseStrategy": "Thorough",
"EraseFinished": true,
"Details": [
{
"ControllerName": "SAS",
"ControllerBDF": "0000:b4:02.0",
"ControllerType": "SAS",
"DriveList": [
{
"EidSlt": "-",
"PciePath": "/sys/devices/pci0000:b4/0000:b4:02.0/host10/port-10:1/end_device-10:1/target10:0:1/10:0:1:0/block/sdc",
"DeviceLocator": "HDDPlaneDisk2",
"State": "-",
"Model": "HUS726T4TALA600",
"CapacityGiB": "3727.36",
"Interface": "SATA",
"MediaType": "HDD",
"SerialNumber": "V6HJX08S",
"FirmwareVersion": "T980",
"Manufacturer": "HGST",
"Status": "Successful",
"Description": "-",
"Progress": "100",
"UsedTime": "00:11",
"StartTime": "2024-10-31 22:08:51",
"EndTime": "2024-10-31 22:09:03"
},
{
"EidSlt": "-",
"PciePath": "/sys/devices/pci0000:b4/0000:b4:02.0/host10/port-10:3/end_device-10:3/target10:0:3/10:0:3:0/block/sde",
"DeviceLocator": "HDDPlaneDisk3",
"State": "-",
"Model": "HUS726T4TALA600",
"CapacityGiB": "3727.36",
"Interface": "SATA",
"MediaType": "HDD",
"SerialNumber": "V6HJ5NTS",
"FirmwareVersion": "T980",
"Manufacturer": "HGST",
"Status": "Successful",
"Description": "-",
"Progress": "100",
"UsedTime": "00:12",
"StartTime": "2024-10-31 22:08:51",
"EndTime": "2024-10-31 22:09:04"
}
]
}
]
},
"RaidCfg": {
"TaskState": "Completed",
"Progress": "Successful",
"Detail": [
{
"CardModel": "SoftwareRAID",
"StartTime": "2024-10-31 22:09:07",
"EndTime": "2024-10-31 22:09:09",
"Operation": "SoftwareRAID",
"Description": "The software RAID is created successfully.",
"Status": "Successful"
}
]
},
"Upgrade": {
"TaskState": "Completed",
"Operation": "Upgrade",
"Progress": "100.0",
"Detail": [
{
"Firmware": "Medium_1.5.7_Software_Linux_HGST-VelaA-HUS726T4TALA600-T980-ARM.zip",
"StartTime": "2024-10-31 22:11:56",
"EndTime": "2024-10-31 22:12:14",
"DeviceName": null,
"Location": null,
"DeviceBDF": null,
"SerialNumber": null,
"Status": "upgraded",
"Device": "HUS726T4TALA600",
"DeviceUID": null,
"LastVersion": null,
"NewVersion": "T980",
"Description": "upgrade successfully",
"DeviceType": "HDD",
"ActiveMode": "ResetOS",
"UpgradeTime": "35000"
}
],
"ActiveMode": "ResetOS"
},
"SoftwareInstall": {
"FirstBootScript": {
"ErrorCode": "",
"Message": ""
},
"iBMA": {
"ErrorCode": "",
"Message": ""
},
"iDriver": {
"ErrorCode": "255",
"Message": "Not found iDriver installation package."
},
"UploadFiles": {
"ErrorCode": "314",
"Message": "Files uploaded successfully.Not found uploaded driver files."
},
"CheckCompatibility": {
"ErrorCode": "",
"Message": "",
"IncompatibleList": []
}
}
}

响应码:200

响应样例5:

json
{
"@odata.context": "/redfish/v1/$metadata#Managers/Members/1/SPService/SPResult/Members/$entity",
"@odata.id": "/redfish/v1/Managers/1/SPService/SPResult/1",
"@odata.type": "#hwSPResult.v1_0_0.HwSPResult",
"Id": "1",
"Name": "SP Result",
"Status": "Finished",
"OSInstall": {
"TaskState": "Cancelled"
},
"DriveErase": {
"TaskState": "Interrupted",
"Operate": "DriveErase",
"EraseMode": "Secure",
"EraseStrategy": "Normal",
"EraseFinished": true,
"Details": [
{
"ControllerName": "SAS",
"ControllerBDF": "0000:b4:02.0",
"ControllerType": "SAS",
"DriveList": [
{
"EidSlt": "-",
"PciePath": "/sys/devices/pci0000:b4/0000:b4:02.0/host10/port-10:1/end_device-10:1/target10:0:1/10:0:1:0/block/sdc",
"DeviceLocator": "HDDPlaneDisk3",
"State": "-",
"Model": "HUS726T4TALA600",
"CapacityGiB": "3727.36",
"Interface": "SATA",
"MediaType": "HDD",
"SerialNumber": "V6HJ5NTS",
"FirmwareVersion": "T980",
"Manufacturer": "HGST",
"Status": "Aborted",
"Description": "-",
"Progress": "100",
"UsedTime": "00:40",
"StartTime": "2024-10-28 14:59:24",
"EndTime": "2024-10-28 15:00:23"
}
]
}
]
},
"RaidCfg": {
"TaskState": "Cancelled"
},
"Upgrade": {
"TaskState": "Cancelled"
}
}

响应码:200