ResourceDefinition

uris

/redfish/v1/Managers/manager_id/SPService/SPDiagnose

properties

名称	类型	是否只读	说明
@odata.context	string	true	诊断配置集合资源模型的OData描述信息
@odata.id	string	true	诊断配置集合资源的访问路径
@odata.type	string	true	诊断配置集合资源的类型
Name	string	true	诊断配置集合资源的名称
Members@odata.count	number	true	诊断配置资源数量
Diagnose	array	false	诊断配置参数
DeviceType	string	false	诊断项目，包括： ● CPU ● Memory ● Disk ● NIC ● NPU ● Power说明SP 1.16.0以上版本支持NPU、Power诊断项目，仅适用于机型：A900 A3 SuperPoD，A800T A3，A800I A3
Mode	string	false	诊断类型，包括： ● Quick ● Full ● FullWithoutNic ● QuickWithoutNic ● Customized说明SP 1.16.0以上版本支持FullWithoutNic、QuickWithoutNic模式下发，仅适用于NPU诊断项目。相较Full和Quick模式，FullWithouNic和QuickWithoutNic不进行NPU Nic项诊断。Power项Mode当前仅为Full模式，下发任意模式均会转为Full模式进行诊断。SP 1.16.0及以上版本支持Customized，仅适用于NPU诊断项目。Customized模式需与SubItems字段配合使用，否则默认按照Full模式诊断。
DurationMinutes	number	false	诊断时长，诊断CPU和内存时需要，单位是分钟。诊断CPU快速模式下缺省值为5，全量模式下缺省值为60，取值范围是1-10000的整数。诊断内存时缺省值为0，取值范围是1-99999的整数
SubItems	列表	false	当诊断项为NPU并且诊断模式为Customized时，SubItems显示NPU各诊断子项的相关信息。具体内容见表3-228。
AssetVerification	object	false	核查资产类型，包括： ● CountVerification说明Smart Provisioning 1.20.0及后续版本支持核查资产
CountVerification	array	true	核查数量类型的资产信息说明Smart Provisioning 1.20.0及后续版本支持核查资产
CountItem	string	true	核查数量类型的资产信息子项，包括： ● Memory说明Smart Provisioning 1.20.0及后续版本支持核查资产
CountValue	number	true	用户输入的期望值 ● 针对Memory，取值范围为整数1-1000说明Smart Provisioning 1.20.0及后续版本支持核查资产

supported_methods

GET
POST(CREATE)

HTTP methods

GET

命令功能

查询 SP 服务的诊断配置集合资源

命令格式

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

请求头:

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/SPDiagnose

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

响应样例：

json

{
  "@odata.context": "/redfish/v1/$metadata#Managers/Members/1/SPService/SPDiagnose/$entity",
  "@odata.id": "/redfish/v1/Managers/1/SPService/SPDiagnose",
  "@odata.type": "#HwSPDiagnoseCollection.HwSPDiagnoseCollection",
  "Name": "SP Diagnose Collection",
  "Members@odata.count": 1,
  "Members": [
    {
      "@odata.id": "/redfish/v1/Managers/1/SPService/SPDiagnose/1"
    }
  ]
}

响应码：200

POST (CREATE)

命令功能

创建 SP 服务的诊断配置

命令格式

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

请求头:

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

请求消息体:

json

{
  "Diagnose": [
    {
      "DeviceType": typevalue,
      "Mode": modevalue,
      "DurationMinutes": timevalue,
      "SubItems": [
        {
          "ItemName": itemnamevalue,
          "ItemDurationMinutes": itemminutesvalue,
          "ItemExecuteTimes": itemtimesvalue,
          "ItemMode": itemmodevalue,
          "AssetVerification": assetverificationvalue,
          "ActionOnCompleted": {
            "LogDump": logdumpvalue,
            "RebootDelayMinutes": rebootdelayminutesvalue
          }
        }
      ]
    }
  ]
}

请求头参数说明

参见请求头参数说明

请求体参数说明

参数	参数说明	取值
typevalue	字符串(必填选项)	诊断项目，如果请求中同一类型有多个配置项，以最后一个为准，取值包括： ● CPU ● Memory ● Disk ● NIC ● NPU ● Power ● RAID说明SP 1.16.0以上版本支持NPU、Power诊断项目，仅适用于机型：A900 A3 SuperPoD，A800T A3，A800I A3 Smart Provisioning 1.19.0及以上版本支持SP686C和SP186 RAID诊断项目
modevalue	字符串(必填选项)	诊断类型，包括： ● Quick ● Full ● FullWithoutNic ● QuickWithoutNic ● Customized说明SP 1.16.0以上版本支持FullWithoutNic、QuickWithoutNic模式下发，仅适用于NPU诊断项目。相较Full和Quick模式，FullWithouNic和QuickWithoutNic不进行NPU Nic项诊断。Power项Mode当前仅为Full模式，下发任意模式均会转为Full模式进行诊断。SP 1.16.0及以上版本支持Customized，仅适用于NPU诊断项目。Customized模式需与SubItems字段配合使用，否则默认按照Full模式诊断。
timevalue	数字	诊断时长，诊断CPU、RAID和内存时需要，单位是分钟。诊断CPU快速模式下缺省值为5，全量模式下缺省值为60，取值范围是1-10000的整数。诊断内存时缺省值为0，诊断RAID缺省值为60，取值范围是1-99999的整数说明SP版本Smart Provisioning 1.19.0及以上支持自定义RAID诊断时长
itemnamevalue	字符串(选填选项)	● SignalQuality ● PCIeSignalQuality ● HCCSSignalQuality ● RoCESignalQuality ● Bandwidth ● PrbsTest ● HbmStress ● EDP ● TDP ● NicTest ● Aicore ● StressTest ● MemTest ● SmartSelfTest ● EthtoolTest ● PhyErrorTest ● DgemmTest ● OCM
itemminutesvalue	数字（选填选项）	诊断子项时长，单位为分钟。HbmStress、TDP、StressTest、MemTest、PhyErrorTest、DgemmTest和OCM诊断子项支持诊断时间设置：1. StressTest子项诊断模式为Standard时，缺省值为5，Stress模式缺省值为60，取值范围为1-10000的整数；2. MemTest子项诊断模式为Stress模式时，缺省值为0，取值范围为1-99999的整数；3. PhyErrorTest子项缺省值为60，取值范围为1-99999的整数；4. HbmStress子项缺省值为300，取值范围为1-10080的整数。5. TDP子项缺省值为300，取值范围为1-10080的整数。6. DgemmTest子项缺省值为30，取值范围为1-10000的整数；7. OCM子项缺省值为30，取值范围为1-99999的整数。其余诊断子项设置不生效。
itemtimesvalue	数字（选填）	NPU诊断子项执行轮次，该属性当前只对Aicore诊断子项生效，取值范围1-100（默认值3）
itemmodevalue	字符串(选填选项)	子项诊断模式，支持类型： ● Standard ● Stress说明SP版本1.19.0及以上版本支持该字段指定子项模式。HbmStress、StressTest、MemTest、SmartselfTest默认模式为Stress模式；Aicore默认为Standard模式；SignalQuality、PCIeSignalQuality、HCCSSignalQuality、RoCESignalQuality、Bandwidth、PrbsTest、TDP、EDP、NicTest、EthtoolTest、PhyErrorTest、DgemmTest、OCM不区分模式，设置不生效。
logdumpvalue	对象（选填）格式为 { "DumpEnabled": dump_enabled_value, "PushTimeoutMinutes": push_timeout_minutes_value }	● dump_enabled_value：布尔类型，是否使能日志导出。 ● push_timeout_minutes_value：数字类型，范围0~1440，日志导出超时时间，单位为分钟。0则为不设置超时时间。SP版本1.17.0及以上版本支持设置日志收集。若DumpEnabled设置为true，则在诊断完成后，SP会等待用户下发日志收集请求，最大等待时长由PushTimeoutMinutes指定。日志收集完成或等待超时则结束任务。请参阅3.2.84查询SP服务的配置结果资源章节，查询诊断任务结果。在诊断任务完成后的日志收集阶段，即 "Diagnose"任务结果的"TaskState"为 "Running"且"DiagFinished"为true时，下发收集日志请求。收集日志请求方法请参阅3.10.14收集日志资源章节，设置请求体参数"Type" 为"Software"，"SoftwareName" 为"SPDiagnose"，其余参数按照参数说明设置，并下发请求。
rebootdelayminutesvalue	整型（选填）	延迟重启时间，取值范围是1-60的整数说明SP 1.21.0及之后版本支持；原始诊断任务正常结束后开始计算的最大延迟时间。当延时时间计时结束后，诊断结束标志位DiagFinished的状态会变为true延迟重启时长需结合实际使用需求进行配置。推荐设置延迟时间为30分钟。
assetverificationvalue	对象（选填）格式为 { "CountVerification" : [ { "CountItem": countitemvalue, "CountValue": countvalue } ] }	● countitemvalue：字符串类型，核查数量类型的资产信息子项，支持核查数量类型子项："Memory"。 ● countvalue：数字类型，范围为1~1000，用户输入的期望值。说明Smart Provisioning 1.20.0及后续版本支持核查资产

使用指南

GA140C机型不支持 SP版本和机型兼容性列表详见Smart Provisioning用户指南创建SP服务的诊断配置的流程如下：

请参阅本章节使用实例，完成任务下发。
请参阅3.2.71 修改SP服务资源属性，设置从Smart Provisioning启动使能。
在不影响服务器业务的情况下，请参阅3.3.4 重启服务器，重启完成后服务器自动进入Smart Provisioning来执行升级任务。
请参阅3.2.84 查询SP服务的配置结果资源查询任务结果。
（可选）SP版本1.13.0及以上版本，在执行诊断任务过程中，如需终止任务，请参阅3.2.71 修改SP服务资源属性，设置SPFinished为true进行任务终止。请参阅 3.2.84 查询SP服务的配置结果资源，仅允许在Status为Deploying状态下进行任务终止。 SP版本1.16.0及以上版本支持下发多任务执行。支持在上述步骤1中同时下发其他支持多任务执行的接口任务，其他步骤与上述一致。支持多任务执行的任务接口和任务结果请参阅3.2.84 查询SP服务的配置结果资源的使用指南中的相关描述。

使用实例

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

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

json

{
  "Diagnose": [
    {
      "DeviceType": typevalue,
      "Mode": modevalue,
      "DurationMinutes": timevalue,
      "SubItems": [
        {
          "ItemName": itemnamevalue,
          "ItemDurationMinutes": itemminutesvalue,
          "ItemExecuteTimes": itemtimesvalue,
          "ItemMode": itemmodevalue,
          "AssetVerification": assetverificationvalue,
          "ActionOnCompleted": {
            "LogDump": logdumpvalue,
            "RebootDelayMinutes": rebootdelayminutesvalue
          }
        }
      ]
    }
  ]
}

响应样例：

json

{
  "@odata.context": "/redfish/v1/$metadata#Managers/Members/1/SPService/SPDiagnose/Members/$entity",
  "@odata.id": "/redfish/v1/Managers/1/SPService/SPDiagnose/1",
  "@odata.type": "#HwSPDiagnose.v1_0_0.HwSPDiagnose",
  "Diagnose": [
    {
      "DeviceType": "CPU",
      "Mode": "Quick",
      "DurationMinutes": 100
    }
  ]
}

响应码：201

ResourceDefinition ​

uris ​

properties ​

supported_methods ​

HTTP methods ​

GET ​

POST (CREATE) ​

ResourceDefinition

uris

properties

supported_methods

HTTP methods

GET

POST (CREATE)