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

ResourceDefinition ​

uris ​

  • /redfish/v1/Managers/manager_id/SPService/Plugins

properties ​

名称类型是否只读取值范围/枚举值说明
@odata.contextstringtrueSP插件集合资源模型的OData描述信息
@odata.idstringtrueSP插件集合资源的访问路径
@odata.typestringtrueSP插件集合资源的类型
NamestringtrueSP插件集合资源的名称
Members@odata.countnumbertrueSP插件资源数量
Idstringtrue任务ID
Descriptionstringtrue任务描述
TaskStatestringtrue任务执行状态
● New
● Starting
● Running
● Suspended
● Interrupted
● Pending
● Stopping
● Completed
● Killed
● Exception
● Service
TaskStatusstringtrue指定任务的完成状态。
● OK
● Warning
● Major
● Critical
StartTimestringtrue任务的起始时间
PercentCompletestringtrue任务完成的百分比进度。
TaskPercentagestringtrue任务执行的百分比

supported_methods ​

  • GET
  • POST

HTTP methods ​

GET ​

命令功能

查询 SP 插件集合资源

命令格式

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

请求头:

X-Auth-Token: auth_value

请求消息体: 无

参数说明

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

使用指南

GA140C机型不支持 SP版本和机型兼容性列表详见Smart Provisioning用户指南 SP插件分为自有插件与第三方插件，查询时有同名插件优先查询第三方插件。 SmartProvisioning启动和运行期间，该接口无法使用。

使用实例

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

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

响应样例：

json
{
  "@odata.context": "/redfish/v1/$metadata#SPPluginCollection.SPPluginCollection",
  "@odata.id": "/redfish/v1/Managers/1/SPService/Plugins",
  "@odata.type": "#SPPluginCollection.SPPluginCollection",
  "Name": "SPPlugin Collection",
  "Members@odata.count": 1,
  "Members": [
    {
      "@odata.id": "/redfish/v1/Managers/1/SPService/Plugins/NPUPlugin"
    }
  ]
}

响应码：200

POST (CREATE) ​

命令功能

安装 SP 插件

命令格式

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

请求头:

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

请求消息体:

json
{
  "PluginURIs": [
    {
      "PackageURI": " PackageURI_value",
      "SignatureFileURI": " SignatureFileURI_value"
    }
  ]
}

请求头参数说明

参见 请求头参数说明

请求体参数说明

参数参数说明取值
PackageURI_value插件文件路径文件路径，支持的文件传输的协议有https、sftp、nfs、cifs、scp、file，支持的文件格式为zip URI中不应含有“
SignatureFileURI_value插件签名文件路径文件路径，支持的文件传输的协议有https、sftp、nfs、cifs、scp、file，支持的认证文件格式为p7s

使用指南

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

  1. 升级SP时无法安装SP插件，安装SP插件时无法升级SP。
  2. SmartProvisioning启动和运行期间，该接口无法使用。
  3. SP插件需要和依赖工具一起安装，插件文件与依赖工具文件不区分顺序
  4. 安装插件队列中最多允许10个插件，超过10个插件会安装失败。
  5. 安装的插件需要与SP匹配
  6. 无法安装与已有第三方插件同名的插件，若要进行插件更新，请先进行插件的删 除。

使用实例

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

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

json
{
  "PluginURIs": [
    {
      "PackageURI": " PackageURI_value",
      "SignatureFileURI": " SignatureFileURI_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": "Install Sp Plugin Task",
  "Description": "",
  "TaskState": "Running",
  "TaskStatus": "OK",
  "StartTime": "2025-01-01T00:00:00+00:00",
  "Messages": [],
  "PercentComplete": null,
  "Oem": {
    "/Public": {
      "TaskPercentage": null
    }
  }
}

响应码：202