ResourceDefinition

uris

/redfish/v1/Managers/manager_id/SecurityService/HttpsCert

properties

名称	类型	是否只读	说明
@odata.context	string	true	SSL证书资源模型的OData描述信息
@odata.id	string	true	SSL证书资源节点的访问路径
@odata.type	string	true	SSL证书资源类型
Id	string	true	SSL证书资源的ID
Name	string	true	SSL证书资源的名称
ServerCert.Subject	string	true	证书使用者
ServerCert.Issuer	string	true	证书签发者
ServerCert.ValidNotBefore	string	true	生效起始日期
ServerCert.ValidNotAfter	string	true	生效结束日期
ServerCert.SerialNumber	string	true	证书序列号
ServerCert.SignatureAlgorithm	string	true	签名算法
ServerCert.KeyUsage	string	true	密钥用法
ServerCert.PublicKeyLengthBits	number	true	公钥长度
ServerCert.IsDefaultSSLCert	布尔类型	true	标志当前服务器证书是否是初始证书说明BMC300 5.01.00.01及以上版本支持
CertificateSigningRequest	string	true	CSR信息说明导入服务器证书后，之前生成的CSR信息清除，此处显示为“null”。
target	string	true	Actions操作路径
@Redfish.ActionInfo	string	true	操作查询路径
#HttpsCert.GenerateCSR	object	true	生成CSR文件的资源路径
#HttpsCert.ImportServerCertificate	object	true	导入服务器证书的资源路径
#HttpsCert.ImportCustomCertificate	object	true	导入自定义证书的资源路径
#HttpsCert.ExportCSR	object	true	导出CSR文件
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	任务完成率
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	解决建议

supported_methods

GET
POST

HTTP methods

GET

命令功能

查询 SSL 证书资源信息

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/SecurityService/HttpsCert

请求头:

X-Auth-Token: auth_value

请求消息体: 无

参数说明

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

使用指南

无

使用实例

请求样例： GET https://device_ip/redfish/v1/Managers/manager_id/SecurityService/HttpsCert

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

响应样例：

json

{
  "@odata.context": "/redfish/v1/$metadata#HttpsCert.HttpsCert",
  "@odata.id": "/redfish/v1/Managers/1/SecurityService/HttpsCert",
  "@odata.type": "#HttpsCert.v1_0_0.HttpsCert",
  "Id": "HttpsCert",
  "Name": "Https cert info",
  "X509CertificateInformation": {
    "ServerCert": {
      "Subject": "CN=Server, OU=IT, O=xxx, L=ShenZhen, S=GuangDong, C=CN",
      "Issuer": "CN=Server, OU=IT, O=xxx, L=ShenZhen, S=GuangDong, C=CN",
      "ValidNotBefore": "Jul 25 2014 GMT",
      "ValidNotAfter": "Jul 22 2024 GMT",
      "SerialNumber": "07 ",
      "SignatureAlgorithm": "sha256WithRSAEncryption",
      "KeyUsage": "Certificate Signing, CRL Sign",
      "PublicKeyLengthBits": 2048,
      "IsDefaultSSLCert": true
    }
  },
  "AlternativeInitialCertificate": {
    "ServerCert": {
      "Subject": "CN=Alternative Server, OU=IT, O=xxx, L=ShenZhen, S=GuangDong, C=CN",
      "Issuer": "CN=Alternative Server, OU=IT, O=xxx, L=ShenZhen, S=GuangDong, C=CN",
      "ValidNotBefore": "Jul 25 2024 GMT",
      "ValidNotAfter": "Jul 22 2034 GMT",
      "SerialNumber": "08 ",
      "SignatureAlgorithm": "sha256WithRSAEncryption",
      "KeyUsage": "Certificate Signing, CRL Sign",
      "PublicKeyLengthBits": 2048
    }
  },
  "CertificateSigningRequest": null,
  "Actions": {
    "#HttpsCert.GenerateCSR": {
      "target": "/redfish/v1/Managers/Blade8/SecurityService/HttpsCert/Actions/HttpsCert.GenerateCSR",
      "@Redfish.ActionInfo": "/redfish/v1/Managers/Blade8/SecurityService/HttpsCert/GenerateCSRActionInfo"
    },
    "#HttpsCert.ImportServerCertificate": {
      "target": "/redfish/v1/Managers/Blade8/SecurityService/HttpsCert/Actions/HttpsCert.ImportServerCertificate",
      "@Redfish.ActionInfo": "/redfish/v1/Managers/Blade8/SecurityService/HttpsCert/ImportServerCertificateActionInfo"
    },
    "#HttpsCert.ImportCustomCertificate": {
      "target": "/redfish/v1/Managers/Blade8/SecurityService/HttpsCert/Actions/HttpsCert.ImportCustomCertificate",
      "@Redfish.ActionInfo": "/redfish/v1/Managers/Blade8/SecurityService/HttpsCert/ImportCustomCertificateActionInfo"
    },
    "#HttpsCert.ExportCSR": {
      "target": "/redfish/v1/Managers/Blade8/SecurityService/HttpsCert/Actions/HttpsCert.ExportCSR",
      "@Redfish.ActionInfo": "/redfish/v1/Managers/Blade8/SecurityService/HttpsCert/ExportCSRActionInfo"
    }
  }
}

响应码：200

POST (ACTION)

GenerateCSR

命令功能

生成 CSR

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/SecurityService/HttpsCert/Actions/HttpsCert.GenerateCSR

请求头:

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

请求消息体:

json

{
  "Country": country,
  "CommonName": commonname,
  "City": city,
  "State": state,
  "OrgName": orgname,
  "OrgUnit": orgunit
}

请求头参数说明

参见请求头参数说明

请求体参数说明

参数	参数说明	取值
country	使用者所在的国家，为必配参数。	支持字母，长度为2个字符。
commonname	使用者的名称为必配参数。	支持字母、数字、连字符、下划线、句点和空格，最大长度64个字符。
city	使用者所在的城市，非必配参数。	支持字母、数字、连字符、下划线、句点和空格，最大长度128个字符。
state	使用者所在的省份，非必配参数。	支持字母、数字、连字符、下划线、句点和空格，最大长度128个字符。
orgname	使用者所在的公司，非必配参数。	支持字母、数字、连字符、下划线、句点和空格，最大长度64个字符。
orgunit	使用者所在的部门，非必配参数。	支持字母、数字、连字符、下划线、句点和空格，最大长度64个字符。

使用指南

无

使用实例

请求样例： POST https://device_ip/redfish/v1/Managers/manager_id/SecurityService/HttpsCert/Actions/HttpsCert.GenerateCSR

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

json

{
  "Country": country,
  "CommonName": commonname,
  "City": city,
  "State": state,
  "OrgName": orgname,
  "OrgUnit": orgunit
}

响应样例：

json

{
  "@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": "csr generation task",
  "Description": "",
  "TaskState": "Running",
  "TaskStatus": "OK",
  "StartTime": "2016-07-10T11:31:02+00:00",
  "Messages": [],
  "PercentComplete": null,
  "Oem": {
    "Public": {
      "TaskPercentage": null
    }
  }
}

响应码：202

POST (ACTION)

ExportCSR

命令功能

导出 CSR

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/SecurityService/HttpsCert/Actions/HttpsCert.ExportCSR

请求头:

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

请求消息体:

json

{
  "Type": type_value,
  "Content": Content
}

请求头参数说明

参见请求头参数说明

请求体参数说明

参数	参数说明	取值
type_value	导出类型	● URI
Content	导出文件路径	支持导出到本地路径和远程路径（本地路径必须在tmp目录下）

使用指南

无

使用实例

请求样例： POST https://device_ip/redfish/v1/Managers/manager_id/SecurityService/HttpsCert/Actions/HttpsCert.ExportCSR

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

json

{
  "Type": type_value,
  "Content": Content
}

响应样例：

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"
      }
    ]
  }
}

响应码：200

POST (ACTION)

ImportServerCertificate

命令功能

导入服务器证书

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/SecurityService/HttpsCert/Actions/HttpsCert.ImportServerCertificate

请求头:

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

请求消息体:

json

{
  "Certificate": text_value
}

请求头参数说明

参见请求头参数说明

请求体参数说明

参数	参数说明	取值
text_value	服务器证书文件或证书链文件	BASE64编码的证书文件的内容

使用指南

无

使用实例

请求样例： POST https://device_ip/redfish/v1/Managers/manager_id/SecurityService/HttpsCert/Actions/HttpsCert.ImportServerCertificate

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

json

{
  "Certificate": text_value
}

响应样例：

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": "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)

ImportCustomCertificate

命令功能

导入自定义证书

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/SecurityService/HttpsCert/Actions/HttpsCert.ImportCustomCertificate

请求头:

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

请求消息体:

json

{
  "Certificate": text_value
}

请求头参数说明

参见请求头参数说明

请求体参数说明

参数	参数说明	取值
text_value	自定义证书文件或自定义证书链文件	BASE64编码的证书文件内容

使用指南

无

使用实例

请求样例： POST https://device_ip/redfish/v1/Managers/manager_id/SecurityService/HttpsCert/Actions/HttpsCert.ImportCustomCertificate

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

json

{
  "Certificate": text_value
}

响应样例：

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": "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

ResourceDefinition ​

uris ​

properties ​

supported_methods ​

HTTP methods ​

GET ​

POST (ACTION) ​

GenerateCSR ​

POST (ACTION) ​

ExportCSR ​

POST (ACTION) ​

ImportServerCertificate ​

POST (ACTION) ​

ImportCustomCertificate ​

ResourceDefinition

uris

properties

supported_methods

HTTP methods

GET

POST (ACTION)

GenerateCSR

POST (ACTION)

ExportCSR

POST (ACTION)

ImportServerCertificate

POST (ACTION)

ImportCustomCertificate