ResourceDefinition

uris

/redfish/v1/Managers/manager_id/DiagnosticService/PRBSTest

properties

名称	类型	是否只读	说明
@odata.context	string	true	PRBSTest接口集合资源模型的OData描述信息
@odata.id	string	true	PRBSTest接口集合资源的访问路径
@odata.type	string	true	PRBSTest接口集合资源的类型
Id	string	true	PRBSTest接口集合资源ID
Name	string	true	PRBSTest接口集合资源名称
target	string	true	PRBSTest查询接口的访问路径
@Redfish.ActionInfo	string	true	PRBSTest查询接口说明的访问路径
MessageId	string	true	消息ID
RelatedProperties	array	true	消息相关属性
Message	string	true	详细信息
MessageArgs	array	true	信息参数
Severity	string	true	严重性Redfish支持的严重级别包括：OK、Warning、Critical
Resolution	string	true	解决建议
TestInfos	array	true	PRBS测试对象信息列表
State	string	true	PRBS测试对象的状态取值范围Pending:待测试Running:测试中Unknown:状态无法确定
BitErrorRate	array	true	PRBS测试对象的误码率
LossOfLock	array	true	PRBS测试对象的失锁状态
TestObjectId	string	false	PRBS测试对象序列号
OperationResults	array	true	下发PRBS测试配置返回信息
Result	string	true	下发PRBS测试配置结果取值范围 Success:成功 Failed:失败
Oem.Public	自定义属性	true	-

supported_methods

GET
POST

HTTP methods

GET

命令功能

查询 PRBS 测试接口集合的资源信息

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/DiagnosticService/PRBSTest

请求头:

X-Auth-Token: auth_value

请求消息体: 无

参数说明

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

使用指南

按照以下步骤，创建光模块PRBS测试：

启动服务器及其对接设备光模块PRBS发送，服务器配置请参阅下发PRBS测试配置。
启动服务器及其对接设备光模块PRBS接收，服务器配置请参阅下发PRBS测试配置。
清除服务器及其对接设备光模块历史PRBS统计数据，服务器配置请参阅清除PRBS 测试统计。
等待一定的测试时间。
查询服务器及其对接设备光模块PRBS测试信息，服务器配置请参阅查询PRBS测试信息。
终止服务器及其对接设备光模块PRBS测试，服务器配置请参阅终止PRBS测试。

使用实例

请求样例： GET https://device_ip/redfish/v1/Managers/manager_id/DiagnosticService/PRBSTest

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

响应样例：

json

{
  "@odata.id": "/redfish/v1/Managers/1/DiagnosticService/PRBSTest",
  "@odata.type": "#HwPRBSTest.v1_0_0.HwPRBSTest",
  "@odata.context": "/redfish/v1/$metadata#HwPRBSTest.HwPRBSTest",
  "Id": "PRBSTest",
  "Name": "PRBS Test",
  "TestObjects": {
    "@odata.id": "/redfish/v1/Managers/1/DiagnosticService/PRBSTest/TestObjects"
  },
  "Actions": {
    "#PRBSTest.QueryInfo": {
      "target": "/redfish/v1/Managers/1/DiagnosticService/PRBSTest/Actions/PRBSTest.QueryInfo",
      "@Redfish.ActionInfo": "/redfish/v1/Managers/1/DiagnosticService/PRBSTest/PRBSTestQueryInfoActionInfo"
    },
    "#PRBSTest.Config": {
      "target": "/redfish/v1/Managers/1/DiagnosticService/PRBSTest/Actions/PRBSTest.Config",
      "@Redfish.ActionInfo": "/redfish/v1/Managers/1/DiagnosticService/PRBSTest/PRBSTestConfigActionInfo"
    },
    "#PRBSTest.ClearStatistics": {
      "target": "/redfish/v1/Managers/1/DiagnosticService/PRBSTest/Actions/PRBSTest.ClearStatistics",
      "@Redfish.ActionInfo": "/redfish/v1/Managers/1/DiagnosticService/PRBSTest/PRBSTestClearStatisticsActionInfo"
    },
    "#PRBSTest.Shutdown": {
      "target": "/redfish/v1/Managers/1/DiagnosticService/PRBSTest/Actions/PRBSTest.Shutdown",
      "@Redfish.ActionInfo": "/redfish/v1/Managers/1/DiagnosticService/PRBSTest/PRBSTestShutdownActionInfo"
    }
  }
}

响应码：200

POST (ACTION)

QueryInfo

命令功能

查询 PRBS 测试信息

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/DiagnosticService/PRBSTest/Actions/PRBSTest.QueryInfo

请求头:

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

请求消息体:

json

{
  "TestObjects": []
}

请求头参数说明

参见请求头参数说明

请求体参数说明

参数	参数说明	取值
TestObjects	PRBS测试的对象	测试对象序列号列表说明目前最多支持8个PRBS测试对象

使用指南

无

使用实例

请求样例： POST https://device_ip/redfish/v1/Managers/manager_id/DiagnosticService/PRBSTest/Actions/PRBSTest.QueryInfo

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

json

{
  "TestObjects": []
}

响应样例：

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",
"Oem": {
"Public": {
"TestInfos": [
{
"State": "Unknown",
"Statistics": {
"BitErrorRate": [
0,
0,
0,
0,
0,
0,
0
],
"LossOfLock": [
0,
0,
0,
0,
0,
0,
0
]
},
"TestObjectId": "MH241800890008"
},
{
"State": "Unknown",
"Statistics": {
"BitErrorRate": [
0,
0,
0,
0,
0,
0,
0
],
"LossOfLock": [
0,
0,
0,
0,
0,
0,
0
]
},
"TestObjectId": "INOAJ2291197"
}
]
}
}
}
]
}
}

响应码：200

POST (ACTION)

Config

命令功能

下发 PRBS 测试配置

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/DiagnosticService/PRBSTest/Actions/PRBSTest.Config

请求头:

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

请求消息体:

json

{
"Configuration": [
{
"TestObjectId": "",
"ConfigType": "",
"PatternId": ,
"DurationSeconds":
}
]
}

请求头参数说明

参见请求头参数说明

请求体参数说明

参数	参数说明	取值
TestObjectId	PRBS测试对象序列号	可通过 /redfish/v1/Managers/manager_id/DiagnosticService/PRBSTest/TestObjects获得
ConfigType	PRBS测试配置类型	字符串，取值范围 StartTransmitter ：启动PRBS发送 StartReceiver ：启动PRBS接收
PatternId	PRBS码型	数字，取值范围 0：PRBS-31Q 2：PRBS-23Q
DurationSeconds	PRBS测试超时时间超时后PRBS测试自动终止并清除测试统计	数字（单位：s）。取值范围 600 1800

使用指南

PRBS测试会导致正常业务流不通，需要在无业务的情况下执行

使用实例

请求样例： POST https://device_ip/redfish/v1/Managers/manager_id/DiagnosticService/PRBSTest/Actions/PRBSTest.Config

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

json

{
"Configuration": [
{
"TestObjectId": "",
"ConfigType": "",
"PatternId": ,
"DurationSeconds":
}
]
}

响应样例：

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",
        "Oem": {
          "Public": {
            "OperationResults": [
              {
                "Result": "Success",
                "TestObjectId": "MH241800890008"
              }
            ]
          }
        }
      }
    ]
  }
}

响应码：200

POST (ACTION)

ClearStatistics

命令功能

清除 PRBS 测试统计

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/DiagnosticService/PRBSTest/Actions/PRBSTest.ClearStatistics

请求头:

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

请求消息体:

json

{
  "TestObjects": []
}

请求头参数说明

参见请求头参数说明

请求体参数说明

参数	参数说明	取值
TestObjects	测试对象	测试对象序列号说明目前最多支持8个PRBS测试对象

使用指南

PRBS测试会导致正常业务流不通，需要在无业务的情况下执行

使用实例

请求样例： POST https://device_ip/redfish/v1/Managers/manager_id/DiagnosticService/PRBSTest/Actions/PRBSTest.ClearStatistics

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

json

{
  "TestObjects": []
}

响应样例：

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",
        "Oem": {
          "Public": {
            "OperationResults": [
              {
                "TestObjectId": "MH241800890008",
                "Result": "Success"
              },
              {
                "TestObjectId": "INOAJ2291197",
                "Result": "Success"
              }
            ]
          }
        }
      }
    ]
  }
}

响应码：200

POST (ACTION)

Shutdown

命令功能

终止 PRBS 测试

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/DiagnosticService/PRBSTest/Actions/PRBSTest.Shutdown

请求头:

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

请求消息体:

json

{
  "TestObjects": []
}

请求头参数说明

参见请求头参数说明

请求体参数说明

参数	参数说明	取值
TestObjects	测试对象	测试对象序列号说明目前最多支持8个PRBS测试对象

使用指南

PRBS测试会导致正常业务流不通，需要在无业务的情况下执行

使用实例

请求样例： POST https://device_ip/redfish/v1/Managers/manager_id/DiagnosticService/PRBSTest/Actions/PRBSTest.Shutdown

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

json

{
  "TestObjects": []
}

响应样例：

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",
        "Oem": {
          "Public": {
            "OperationResults": [
              {
                "TestObjectId": "MH241800890008",
                "Result": "Success"
              },
              {
                "TestObjectId": "INOAJ2291197",
                "Result": "Success"
              }
            ]
          }
        }
      }
    ]
  }
}

响应码：200

ResourceDefinition ​

uris ​

properties ​

supported_methods ​

HTTP methods ​

GET ​

POST (ACTION) ​

QueryInfo ​

POST (ACTION) ​

Config ​

POST (ACTION) ​

ClearStatistics ​

POST (ACTION) ​

Shutdown ​

ResourceDefinition

uris

properties

supported_methods

HTTP methods

GET

POST (ACTION)

QueryInfo

POST (ACTION)

Config

POST (ACTION)

ClearStatistics

POST (ACTION)

Shutdown