SystemEraseCollection
更新时间: 2026/07/01
在Gitcode上查看源码

ResourceDefinition

uris

  • /redfish/v1/Managers/manager_id/SPService/SystemErase

properties

名称类型是否只读取值范围/枚举值说明
@odata.contextstringtrue系统擦除配置集合资源模型的OData描述信息
@odata.idstringtrue系统擦除配置资源的访问路径
@odata.typestringtrue系统擦除配置资源的类型
Namestringfalse系统擦除配置集合资源的名称
Members@odata.countnumbertrue系统擦除配置资源数量

supported_methods

  • GET
  • POST

HTTP methods

GET

命令功能

查询 SP 系统擦除配置集合资源

命令格式

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

请求头:

X-Auth-Token: auth_value

请求消息体: 无

参数说明

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

使用指南

GA140C机型不支持 SP版本和机型兼容性列表详见Smart Provisioning用户指南 BMC300 5.3.0.1及以上版本支持此功能。

使用实例

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

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

响应样例:

json
{
  "@odata.context": "/redfish/v1/$metadata#HwSystemEraseCollection.HwSystemEraseCollection",
  "@odata.id": "/redfish/v1/Managers/1/SPService/SystemErase",
  "@odata.type": "#HwSystemEraseCollection.HwSystemEraseCollection",
  "Name": "SP System Erase Collection",
  "Members@odata.count": 1,
  "Members": [
    {
      "@odata.id": "/redfish/v1/Managers/1/SPService/SystemErase/1"
    }
  ]
}

响应码:200

POST (CREATE)

命令功能

创建 SP 系统擦除配置

命令格式

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

请求头:

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

请求消息体:

json
{
  "Components": [
    {
      "Name": "name"
    }
  ]
}

请求头参数说明

参见 请求头参数说明

请求体参数说明

参数参数说明取值
name字符串系统擦除组件类型,取值包括:
● All:选择所有可擦除类型
● Disks:硬盘擦除
● SP:SP恢复出厂配置
● BIOS:BIOS恢复出厂配置
● iBMC:BMC恢复出厂配置

使用指南

BMC300 5.3.0.1及以上版本支持此功能。 GA140C机型不支持 SP版本和机型兼容性列表详见Smart Provisioning用户指南

使用实例

请求样例: POST https://device_ip/redfish/v1/Managers/manager_id/SPService/SystemErase

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

json
{
  "Components": [
    {
      "Name": "name"
    }
  ]
}

响应样例:

json
{
  "@odata.context": "/redfish/v1/$metadata#Managers/Members/1/SPService/SystemErase/Members/$entity",
  "@odata.id": "/redfish/v1/Managers/1/SPService/SystemErase/1",
  "@odata.type": "#HwSystemErase.v1_0_0.HwSystemErase",
  "Components": [
    {
      "Name": "Disks"
    },
    {
      "Name": "SP"
    },
    {
      "Name": "BIOS"
    },
    {
      "Name": "iBMC"
    }
  ]
}

响应码:201