ResourceDefinition
uris
/redfish/v1/Managers/manager_id/SecurityService/DiceCert
properties
| 名称 | 类型 | 是否只读 | 取值范围/枚举值 | 说明 |
|---|---|---|---|---|
| @odata.context | string | true | DICE证书资源模型的OData描述信息 | |
| @odata.id | string | true | DICE证书资源节点的访问路径 | |
| @odata.type | string | true | DICE证书资源类型 | |
| Id | string | true | DICE证书资源的ID | |
| Name | string | true | DICE证书资源的名称 | |
| target | string | true | Actions操作路径 | |
| Redfish.ActionInfo | string | true | 操作查询路径 | |
| DiceCert.ExportDiceCSR | object | true | 导出DICE CSR文件的资源路径 | |
| DiceCert.ImportDiceCertificate | object | true | 导入DICE证书的资源路径 | |
| DiceCert.ExportDiceCertficateChain | object | true | 导出DICE证书链的资源路径 | |
| DiceCert.ExportHardwareComponentsCertficateChain | object | true | 导出融合身份认证证书链的资源路径 | |
| code | string | true | 指示消息注册表中特定消息ID的字符串。 | |
| message | string | true | 与消息注册表中的消息对应的易读的错误消息。 | |
| MessageId | string | true | 消息ID | |
| RelatedProperties | array | true | 消息相关属性 | |
| Message | string | true | 详细信息 | |
| MessageArgs | array | true | 信息参数 | |
| Severity | string | true | 严重性Redfish支持的严重级别包括:OK、Warning、Critical。 | |
| Resolution | string | true | 解决建议 | |
| Description | string | true | 任务描述 | |
| TaskState | string | true | 任务的状态 ● New ● Starting ● Running ● Suspended ● Interrupted ● Pending ● Stopping ● Completed ● Killed ● Exception ● Service | |
| TaskStatus | string | true | 指定任务的完成状态。 ● OK ● Warning ● Major ● Critical | |
| StartTime | string | true | 任务开始时间 | |
| Messages | array | true | 任务相关的消息 | |
| PercentComplete | string | true | 任务完成的百分比进度。 | |
| TaskPercentage | string | true | 任务完成率 |
supported_methods
- GET
- POST
HTTP methods
GET
命令功能
查询 DICE 证书资源信息
命令格式
URL: https://device_ip/redfish/v1/Managers/manager_id/SecurityService/DiceCert
请求头:
X-Auth-Token: auth_value请求消息体: 无
参数说明
| 参数 | 参数说明 | 取值 |
|---|---|---|
| device_ip | 登录设备的IP地址 | IPv4或IPv6地址 |
| auth_value | 请求消息的鉴权参数 | 可通过/redfish/v1/SessionService/Sessions创建会话时获得 |
使用指南
仅在BMC300 5.5.0.1以上支持
使用实例
请求样例: GET https://device_ip/redfish/v1/Managers/manager_id/SecurityService/DiceCert
X-Auth-Token: auth_value 请求消息体:无
响应样例:
{
"@odata.context": "/redfish/v1/$metadata#Managers/Members/1/SecurityService/DiceCert/$entity",
"@odata.id": "/redfish/v1/Managers/1/SecurityService/DiceCert",
"@odata.type": "#DiceCert.v1_0_0.DiceCert",
"Id": "DiceCert",
"Name": "Dice cert info",
"Actions": {
"#DiceCert.ExportDiceCSR": {
"target": "/redfish/v1/Managers/1/SecurityService/DiceCert/Actions/DiceCert.ExportDiceCSR",
"@Redfish.ActionInfo": "/redfish/v1/Managers/1/SecurityService/DiceCert/ExportDiceCSRActionInfo"
},
"#DiceCert.ImportDiceCertificate": {
"target": "/redfish/v1/Managers/1/SecurityService/DiceCert/Actions/DiceCert.ImportDiceCertificate",
"@Redfish.ActionInfo": "/redfish/v1/Managers/1/SecurityService/DiceCert/ImportDiceCertificateActionInfo"
},
"#DiceCert.ExportDiceCertficateChain": {
"target": "/redfish/v1/Managers/1/SecurityService/DiceCert/Actions/DiceCert.ExportDiceCertficateChain",
"@Redfish.ActionInfo": "/redfish/v1/Managers/1/SecurityService/DiceCert/ExportDiceCeritficateChainActionInfo"
},
"#DiceCert.ExportHardwareComponentsCertficateChain": {
"target": "/redfish/v1/Managers/1/SecurityService/DiceCert/Actions/DiceCert.ExportHardwareComponentsCertficateChain",
"@Redfish.ActionInfo": "/redfish/v1/Managers/1/SecurityService/DiceCert/ExportHardwareComponentsCertficateChainActionInfo"
}
}
}响应码:200
POST (ACTION)
ExportDiceCSR
命令功能
导出 DICE CSR
命令格式
URL: https://device_ip/redfish/v1/Managers/manager_id/SecurityService/DiceCert/Actions/DiceCert.ExportDiceCSR
请求头:
X-Auth-Token: auth_value
Content-Type: header_type请求消息体:
{
"Type": type_value,
"Content": Content
}请求头参数说明
参见 请求头参数说明
请求体参数说明
| 参数 | 参数说明 | 取值 |
|---|---|---|
| type_value | 导出类型 | ● URI |
| Content | 导出文件路径 | 支持导出到本地路径和远程路径(本地路径必须在tmp目录下,导出文件格式要求“.csr”) ● 本地导出:“/tmp/文件名”,最大长度255 ● 远程导出:“文件传输协议://用户名:密码@ip地址/目录/文件名” 文件传输协议包括五种:sftp、https、nfs、cifs、scp |
使用指南
仅在BMC300 5.5.0.1以上支持
使用实例
请求样例: POST https://device_ip/redfish/v1/Managers/manager_id/SecurityService/DiceCert/Actions/DiceCert.ExportDiceCSR
X-Auth-Token: auth_value Content-Type: header_type 请求消息体:
{
"Type": type_value,
"Content": Content
}响应样例:
{
"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"
}
]
}
}响应码:200
POST (ACTION)
ImportDiceCertificate
命令功能
导入 DICE 证书
命令格式
URL: https://device_ip/redfish/v1/Managers/manager_id/SecurityService/DiceCert/Actions/DiceCert.ImportDiceCertificate
请求头:
X-Auth-Token: auth_value
Content-Type: header_type请求消息体:
{
"Type": type_value,
"Certificate": uri_value
}请求头参数说明
参见 请求头参数说明
请求体参数说明
| 参数 | 参数说明 | 取值 |
|---|---|---|
| type_value | 导入类型 | ● URI,表明value值是URI(本地路径或者远程路径),其它类型暂不支持。 |
| uri_value | 证书路径文件 | 1. 证书支持格式为:DER格式2. 证书后缀支持列表:.der、.crt、.cer、. pem 3. 支持导出到本地路径和远程路径(本地路径必须在tmp目录下,并且最大长度为255) ● 本地导入:“/tmp/ 文件名” ● 远程导入:“文件传输协议://用户名: 密码@ip地址/目录/ 文件名” ● 文件传输协议包括五种:sftp、https、nfs、cifs、scp |
使用指南
仅在BMC300 5.5.0.1以上支持
使用实例
请求样例: POST https://device_ip/redfish/v1/Managers/manager_id/SecurityService/DiceCert/Actions/DiceCert.ImportDiceCertificate
X-Auth-Token: auth_value Content-Type: header_type 请求消息体:
{
"Type": type_value,
"Certificate": uri_value
}响应样例:
{
"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": "iBMC.1.0.CertImportOK",
"RelatedProperties": [],
"Message": "The certificate has been imported successfully.",
"MessageArgs": [],
"Severity": "OK",
"Resolution": "Restart the iBMC for the certificate to take effect."
}
]
}
}响应码:200
POST (ACTION)
ExportDiceCertficateChain
命令功能
导出 DICE 证书链
命令格式
URL: https://device_ip/redfish/v1/Managers/manager_id/SecurityService/DiceCert/Actions/DiceCert.ExportDiceCertficateChain
请求头:
X-Auth-Token: auth_value
Content-Type: header_type请求消息体:
{
"Type": type_value,
"Content": Content,
"Nonce": Nonce_string
}请求头参数说明
参见 请求头参数说明
请求体参数说明
| 参数 | 参数说明 | 取值 |
|---|---|---|
| type_value | 导出类型 | ● URI |
| Content | 导出文件路径 | 支持导出到本地路径和远程路径(本地路径必须在tmp目录下,最大长度为128)。 具体导出的文件数量以芯片能力为准。 |
| Nonce_string | 挑战随机数 | 16进制随机数值组成的字符串,字符串长度不小于15,不超过128。 单字节数据会在前置位默认补0,如某字节为0x8, 实际转换为“08”。 |
使用指南
仅在BMC300 5.5.0.1以上支持
使用实例
请求样例: POST https://device_ip/redfish/v1/Managers/manager_id/SecurityService/DiceCert/Actions/DiceCert.ExportDiceCertficateChain
X-Auth-Token: auth_value Content-Type: header_type 请求消息体:
{
"Type": type_value,
"Content": Content,
"Nonce": Nonce_string
}响应样例:
{
"@odata.context": "/redfish/v1/$metadata#TaskService/Tasks/Members/$entity",
"@odata.type": "#Task.v1_0_2.Task",
"@odata.id": "/redfish/v1/TaskService/Tasks/1",
"Id": "1",
"Name": "dice file export task",
"Description": "",
"TaskState": "Running",
"TaskStatus": "OK",
"StartTime": "2030-12-20T10:35:52+00:00",
"Messages": [],
"PercentComplete": null,
"Oem": {
"Public": {
"TaskPercentage": null
}
}
}响应码:202
POST (ACTION)
ExportHardwareComponentsCertficateChain
命令功能
导出融合身份认证证书链
命令格式
URL: https://device_ip/redfish/v1/Managers/manager_id/SecurityService/DiceCert/Actions/DiceCert.ExportHardwareComponentsCertficateChain
请求头:
X-Auth-Token: auth_value
Content-Type: header_type请求消息体:
{
"Type": type_value,
"Content": Content,
"Nonce": Nonce_string
}请求头参数说明
参见 请求头参数说明
请求体参数说明
| 参数 | 参数说明 | 取值 |
|---|---|---|
| type_value | 导出类型 | ● URI |
| Content | 导出文件路径 | 支持导出到本地路径和远程路径(本地路径必须在tmp目录下,最大长度为128)。 具体导出的文件数量以芯片能力为准。 |
| Nonce_string | 挑战随机数 | 16进制随机数值组成的字符串,字符串长度不小于15,不超过128。 单字节数据会在前置位默认补0,如某字节为0x8, 实际转换为“08”。 |
使用指南
仅在BMC300 5.7.0.1以上支持
使用实例
请求样例: POST https://device_ip/redfish/v1/Managers/manager_id/SecurityService/DiceCert/Actions/DiceCert.ExportHardwareComponentsCertficateChain
X-Auth-Token: auth_value Content-Type: header_type 请求消息体:
{
"Type": type_value,
"Content": Content,
"Nonce": Nonce_string
}响应样例:
{
"@odata.context": "/redfish/v1/$metadata#Task.Task",
"@odata.type": "#Task.v1_0_2.Task",
"@odata.id": "/redfish/v1/TaskService/Tasks/1",
"Id": "1",
"Name": "hardware components certificate chain export task",
"Description": "",
"TaskState": "Running",
"TaskStatus": "OK",
"StartTime": "2024-08-30T09:08:33+00:00",
"Messages": [],
"PercentComplete": null,
"Oem": {
"Public": {
"TaskPercentage": null
}
}
}响应码:202