ResourceDefinition

uris

/redfish/v1/Managers/manager_id/SecurityService/CertUpdateService

properties

名称	类型	是否只读	说明
@odata.context	string	true	证书更新服务资源模型的OData描述信息
@odata.id	string	true	证书更新服务资源节点的访问路径
@odata.type	string	true	证书更新服务资源类型
Id	string	true	证书更新服务资源的ID
Name	string	true	证书更新服务资源的名称
Description	string	true	证书更新服务资源的描述信息
CAServerAddr	string	false	CA服务器地址
CAServerPort	number	false	CA服务器端口
CAServerCMPPath	string	false	CA服务器CMP路径配置
TLSAuthType	string	false	CA服务器认证方式
AutoUpdateEnabled	boolean	false	自动更新使能状态
Country	string	false	国家
State	string	false	州/省份
Location	string	false	城市
OrgName	string	false	公司
OrgUnit	string	false	部门
CommonName	string	false	常用名
InternalName	string	false	内部名
Email	string	false	邮箱
AlternativeNames	array	false	使用者可选名称说明BMC300 5.9.0.1及以上版本支持
IssueBy	string	true	颁发者
IssueTo	string	true	使用者
ValidFrom	string	true	证书有效起始日期
ValidTo	string	true	证书有效截止日期
SerialNumber	string	true	序列号
SignatureAlgorithm	string	true	签名算法
KeyUsage	string	true	密钥用法
PublicKeyLengthBits	number	true	公钥长度
FingerPrint	string	true	证书指纹
IsImportCrl	boolean	true	是否配置证书吊销列表
CrlValidFrom	string	true	证书吊销列表有效起始日期
CrlValidTo	string	true	证书吊销列表有效截止日期
ClientCert.IssueBy	string	true	颁发者
ClientCert.IssueTo	string	true	使用者
ClientCert.ValidFrom	string	true	证书有效起始日期
ClientCert.ValidTo	string	true	证书有效截止日期
ClientCert.SerialNumber	string	true	序列号
ClientCert.SignatureAlgorithm	string	true	签名算法
ClientCert.KeyUsage	string	true	密钥用法
ClientCert.PublicKeyLengthBits	number	true	公钥长度
ClientCert.FingerPrint	string	true	证书指纹
ClientCert.AlternativeNames	array	false	使用者可选名称说明BMC300 5.9.0.1及以上版本支持
target	string	true	操作路径
@Redfish.ActionInfo	string	true	操作查询路径
#CertUpdateService.DeleteCrl	string	true	删除CA服务器的证书吊销列表
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
PATCH
POST

HTTP methods

GET

命令功能

查询 SSL 证书更新服务资源信息

命令格式

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

请求头:

X-Auth-Token: auth_value

请求消息体: 无

参数说明

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

使用指南

1、1710机型BMC300 8.91及以上版本支持此功能。 2、1711机型BMC300 3.8.0.1及以上版本支持此功能。

使用实例

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

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

响应样例：

json

{
  "@odata.context": "/redfish/v1/$metadata#CertUpdateService.CertUpdateService",
  "@odata.id": "/redfish/v1/Managers/1/SecurityService/CertUpdateService",
  "@odata.type": "#CertUpdateService.v1_0_0.CertUpdateService",
  "Id": "CertUpdateService",
  "Name": "Cert Update Service",
  "Description": "Cert Update Service",
  "CMPConfig": {
    "CAServerAddr": "70.166.20.45",
    "CAServerPort": 443,
    "CAServerCMPPath": "/cmp/BMC",
    "TLSAuthType": "two-way",
    "AutoUpdateEnabled": true,
    "SubjectInfo": {
      "Country": "CN",
      "State": "Guangdong",
      "Location": "Dongguan",
      "OrgName": "",
      "OrgUnit": "BMC",
      "CommonName": "CA",
      "InternalName": "CA",
      "Email": "exp@exp.com",
      "AlternativeNames": [
        "email:example@domain.com",
        "DNS:www.example.com",
        "URI:http://example.com",
        "IP:x.x.x.x"
      ]
    }
  },
  "CACertChainInfo": {
    "ServerCert": {
      "IssueBy": "CN=xxx, OU=BMC, O=xxx, L=Dongguan, S=Guangdong, C=CN",
      "IssueTo": "CN=xxx, OU=BMC, O=xxx, L=Dongguan, S=Guangdong, C=CN",
      "ValidFrom": "Jul 14 2022 UTC",
      "ValidTo": "Jul 14 2032 UTC",
      "SerialNumber": "01",
      "SignatureAlgorithm": "sha1WithRSAEncryption",
      "KeyUsage": "Certificate Sign, CRL Sign",
      "PublicKeyLengthBits": 2048,
      "FingerPrint": "957bbdd67fd57e8fb430db2cca4ecc9f88b688d864e64e61692128aff66296bf",
      "IsImportCrl": true,
      "CrlValidFrom": "Jul 14 2022 UTC",
      "CrlValidTo": "Aug 13 2022 UTC"
    }
  },
  "ClientCertChainInfo": {
    "ClientCert": {
      "IssueBy": "CN=BMC, OU=COMPUTING, O=xxx, L=, S=, C=CN",
      "IssueTo": "CN=iBMC, OU=Jisuan, O=xxx, L=, S=, C=CN",
      "ValidFrom": "Sep 13 2022 UTC",
      "ValidTo": "Sep 13 2024 UTC",
      "SerialNumber": "17 8a da d4 3a b4 e4 7f d1 be 43 19 90 a8 66",
      "SignatureAlgorithm": "sha256WithRSAEncryption",
      "KeyUsage": "Digital Signature, Non Repudiation, Key Encipherment, Data Encipherment, KeyAgreement",
      "PublicKeyLengthBits": 3072,
      "FingerPrint": "fc0621d36dc5bba4246df83965b807c8a11abd75eaca399d48dd788e0d61ad61",
      "AlternativeNames": [
        "email:example@domain.com",
        "DNS:www.example.com",
        "URI:http://example.com",
        "IP:x.x.x.x"
      ]
    }
  },
  "Actions": {
    "#CertUpdateService.ImportCA": {
      "target": "/redfish/v1/Managers/1/SecurityService/CertUpdateService/Actions/CertUpdateService.ImportCA",
      "@Redfish.ActionInfo": "/redfish/v1/Managers/1/SecurityService/CertUpdateService/ImportCAActionInfo"
    },
    "#CertUpdateService.ImportCrl": {
      "target": "/redfish/v1/Managers/1/SecurityService/CertUpdateService/Actions/CertUpdateService.ImportCrl",
      "@Redfish.ActionInfo": "/redfish/v1/Managers/1/SecurityService/CertUpdateService/ImportCrlActionInfo"
    },
    "#CertUpdateService.DeleteCrl": {
      "target": "/redfish/v1/Managers/1/SecurityService/CertUpdateService/Actions/CertUpdateService.DeleteCrl",
      "@Redfish.ActionInfo": "/redfish/v1/Managers/1/SecurityService/CertUpdateService/DeleteCrlActionInfo"
    },
    "#CertUpdateService.ImportClientCert": {
      "target": "/redfish/v1/Managers/1/SecurityService/CertUpdateService/Actions/CertUpdateService.ImportClientCert",
      "@Redfish.ActionInfo": "/redfish/v1/Managers/1/SecurityService/CertUpdateService/ImportClientCertActionInfo"
    },
    "#CertUpdateService.UpdateCertFromCA": {
      "target": "/redfish/v1/Managers/1/SecurityService/CertUpdateService/Actions/CertUpdateService.UpdateCertFromCA",
      "@Redfish.ActionInfo": "/redfish/v1/Managers/1/SecurityService/CertUpdateService/UpdateCertFromCAActionInfo"
    }
  }
}

响应码：200

PATCH

命令功能

修改 SSL 证书更新服务资源信息

命令格式

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

请求头:

X-Auth-Token: auth_value
Content-Type: header_type
If-Match: ifmatch_value

请求消息体:

json

{
  "CMPConfig": {
    "TLSAuthType": "two-way",
    "AutoUpdateEnabled": true,
    "SubjectInfo": {
      "InternalName": null,
      "Location": null,
      "State": null,
      "Country": "CN",
      "OrgName": null,
      "Email": null,
      "OrgUnit": null,
      "CommonName": "sadg",
      "AlternativeNames": [
        "email:example@domain.com",
        "DNS:www.example.com",
        "URI:http://example.com",
        "IP:x.x.x.x"
      ]
    },
    "CAServerAddr": "192.168.1.56",
    "CAServerPort": 88,
    "CAServerCMPPath": "/cmp/BMC"
  }
}

请求头参数说明

参见请求头参数说明

请求体参数说明

参数	参数说明	取值
TLSAuthType	认证方式	two-way
AutoUpdateEnabled	自动更新使能状态	true/false
CAServerAddr	CA服务器地址	Ipv4/Ipv6地址
CAServerPort	CA服务器端口	1-65535
CAServerCMPPath	CA服务器CMP路径	字符串
SubjectInfo	证书主题	Country：国家（必填） State：省份（选填） Location：城市（选填） OrgName：公司（选填） OrgUnit：部门（选填） CommonName：常用名（必填） InternalName：内部名（选填） Email：邮箱（选填）, AlternativeNames：使用者可选名称（选填）说明AlternativeNames字段仅在BMC300 5.9.0.1及以上版本支持

使用指南

1、相同的证书不允许重复导入。 2、 1710机型BMC300 8.91及以上版本支持此功能。 3、 1711机型BMC300 3.8.0.1及以上版本支持此功能。

使用实例

请求样例： PATCH https://device_ip/redfish/v1/Managers/manager_id/SecurityService/CertUpdateService

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

json

{
  "CMPConfig": {
    "TLSAuthType": "two-way",
    "AutoUpdateEnabled": true,
    "SubjectInfo": {
      "InternalName": null,
      "Location": null,
      "State": null,
      "Country": "CN",
      "OrgName": null,
      "Email": null,
      "OrgUnit": null,
      "CommonName": "sadg",
      "AlternativeNames": [
        "email:example@domain.com",
        "DNS:www.example.com",
        "URI:http://example.com",
        "IP:x.x.x.x"
      ]
    },
    "CAServerAddr": "192.168.1.56",
    "CAServerPort": 88,
    "CAServerCMPPath": "/cmp/BMC"
  }
}

响应样例：

json

{
  "@odata.context": "/redfish/v1/$metadata#CertUpdateService.CertUpdateService",
  "@odata.id": "/redfish/v1/Managers/1/SecurityService/CertUpdateService",
  "@odata.type": "#CertUpdateService.v1_0_0.CertUpdateService",
  "Id": "CertUpdateService",
  "Name": "Cert Update Service",
  "Description": "Cert Update Service",
  "CMPConfig": {
    "CAServerCMPPath": "/cmp/BMC",
    "CAServerAddr": "192.168.1.56",
    "CAServerPort": 88,
    "TLSAuthType": "two-way",
    "AutoUpdateEnabled": true,
    "SubjectInfo": {
      "Country": "CN",
      "State": null,
      "Location": null,
      "OrgName": null,
      "OrgUnit": null,
      "CommonName": "sadg",
      "InternalName": null,
      "Email": null,
      "AlternativeNames": [
        "email:example@domain.com",
        "DNS:www.example.com",
        "URI:http://example.com",
        "IP:x.x.x.x"
      ]
    }
  },
  "CACertChainInfo": {
    "ServerCert": {
      "IssueBy": "CN=syslog4.it.bmctest.com, OU=IT, O=xxx, L=hz, S=zj, C=CN",
      "IssueTo": "CN=syslog4.it.bmctest.com, OU=IT, O=xxx, L=hz, S=zj, C=CN",
      "ValidFrom": "Sep 08 2020 UTC",
      "ValidTo": "Oct 08 2031 UTC",
      "SerialNumber": "01",
      "SignatureAlgorithm": "sha256WithRSAEncryption",
      "KeyUsage": "Digital Signature, Certificate Sign, CRL Sign",
      "PublicKeyLengthBits": 2048,
      "FingerPrint": "1a36a50c7bc64fc2d793713d5604cf6bc10187e7a64a1f9ecb66cea6e8dccc6d",
      "IsImportCrl": false,
      "CrlValidFrom": null,
      "CrlValidTo": null
    }
  },
  "Actions": {
    "#CertUpdateService.ImportCA": {
      "target": "/redfish/v1/Managers/1/SecurityService/CertUpdateService/Actions/CertUpdateService.ImportCA",
      "@Redfish.ActionInfo": "/redfish/v1/Managers/1/SecurityService/CertUpdateService/ImportCAActionInfo"
    },
    "#CertUpdateService.ImportCrl": {
      "target": "/redfish/v1/Managers/1/SecurityService/CertUpdateService/Actions/CertUpdateService.ImportCrl",
      "@Redfish.ActionInfo": "/redfish/v1/Managers/1/SecurityService/CertUpdateService/ImportCrlActionInfo"
    },
    "#CertUpdateService.DeleteCrl": {
      "target": "/redfish/v1/Managers/1/SecurityService/CertUpdateService/Actions/CertUpdateService.DeleteCrl",
      "@Redfish.ActionInfo": "/redfish/v1/Managers/1/SecurityService/CertUpdateService/DeleteCrlActionInfo"
    },
    "#CertUpdateService.ImportClientCert": {
      "target": "/redfish/v1/Managers/1/SecurityService/CertUpdateService/Actions/CertUpdateService.ImportClientCert",
      "@Redfish.ActionInfo": "/redfish/v1/Managers/1/SecurityService/CertUpdateService/ImportClientCertActionInfo"
    },
    "#CertUpdateService.UpdateCertFromCA": {
      "target": "/redfish/v1/Managers/1/SecurityService/CertUpdateService/Actions/CertUpdateService.UpdateCertFromCA",
      "@Redfish.ActionInfo": "/redfish/v1/Managers/1/SecurityService/CertUpdateService/UpdateCertFromCAActionInfo"
    }
  }
}

响应码：200

POST (ACTION)

ImportCACertificate

命令功能

导入 SSL 证书更新服务的 CA 证书

说明须知此资源已经废弃，仅供兼容性用途使用。建议使用redfish/v1/CertificateService接口进行CA证书/吊销列表管理自BMC300 5.2.0.1版本后CA证书升级为资源池，所有BMC业务共用资源池中的CA证书，此接口导入证书会影响到其他包含根证书的接口。共用CA证书业务包括： Syslog、SMTP、LDAP、SSL证书自动更新、远程HTTPS服务器、双因素登录业务

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/SecurityService/CertUpdateService/Actions/CertUpdateService.ImportCA

请求头:

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

请求消息体:

json

{
  "Type": "text",
  "Content": crt_text
}

请求头参数说明

参见请求头参数说明

请求体参数说明

参数	参数说明	取值
crt_text	CA服务器CA证书的文本	CA服务器CA证书的文本内容
tmp_uri	CA服务器CA证书的本地路径	证书的本地路径，/tmp/目录/文件名，文件扩展名必须是“.crt、.cer、.pem”
remote_uri	CA服务器CA证书的远程路径	远程导入的路径，形如：sftp://user:password@ip/ path；目前支持五种传输协议，https、scp、sftp、cifs、nfs，远程文件的扩展名必须是 “.crt、.cer、.pem”

使用指南

1、相同的证书不允许重复导入。 2、 1710机型BMC300 8.91及以上版本支持此功能。 3、 1711机型BMC300 3.8.0.1及以上版本支持此功能。

使用实例

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

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

json

{
  "Type": "text",
  "Content": crt_text
}

响应样例：

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)

ImportCrl

命令功能

导入 SSL 证书更新服务的 CA 证书吊销列表

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/SecurityService/CertUpdateService/Actions/CertUpdateService.ImportCrl

请求头:

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

请求消息体:

json

{
  "Type": "text",
  "Content": crl_text
}

请求头参数说明

参见请求头参数说明

请求体参数说明

参数	参数说明	取值
crl_text	CA服务器的证书吊销列表的文本	CA服务器的证书吊销列表的文本内容
tmp_uri	CA服务器的证书吊销列表的本地路径	证书吊销列表的本地路径，/tmp/目录/文件名，文件扩展名必须是“.crl”
remote_uri	CA服务器的证书吊销列表的远程路径	远程导入的路径，形如：sftp://user:password@ip/ path；目前支持五种传输协议，https、scp、sftp、cifs、nfs，远程文件的扩展名必须是“.crl”

使用指南

1、 1710机型BMC300 8.91及以上版本支持此功能。 2、 1711机型BMC300 3.8.0.1及以上版本支持此功能。

使用实例

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

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

json

{
  "Type": "text",
  "Content": crl_text
}

响应样例：

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)

DeleteCrl

命令功能

删除 SSL 证书更新服务的 CA 证书吊销列表

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/SecurityService/CertUpdateService/Actions/CertUpdateService.DeleteCrl

请求头:

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

请求消息体:

json

{
  "RootCertId": id
}

请求头参数说明

参见请求头参数说明

请求体参数说明

参数	参数说明	取值
id	CA服务器证书的id	可通过/redfish/v1/ Managers/:manager_id/ Certificates查询证书信息时获得

使用指南

BMC300 5.3.0.1及以上版本支持。

使用实例

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

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

json

{
  "RootCertId": id
}

响应样例：

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

POST (ACTION)

ImportClientCertificate

命令功能

导入 SSL 证书更新服务的客户端证书

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/SecurityService/CertUpdateService/Actions/CertUpdateService.ImportClientCert

请求头:

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

请求消息体:

json

{
  "Type": "text",
  "Content": base64_text,
  "Password": password
}

请求头参数说明

参见请求头参数说明

请求体参数说明

参数	参数说明	取值
base64_text	CA服务器的客户端证书的Base64编码文本	文本由CA服务器的客户端证书通过OpenSSL的Base64编码转换而来，例：“openssl base64 -in client.pfx”
password	解密CA服务器的客户端证书的密码	为可选参数，未输入表明密码为空
tmp_uri	CA服务器的客户端证书的本地路径	证书的本地路径，/tmp/目录/文件名，文件扩展名必须是“.pfx、.p12”
remote_uri	CA服务器的客户端证书的远程路径	远程导入的路径，形如：sftp://user:password@ip/ path；目前支持五种传输协议，https、scp、sftp、cifs、nfs，远程文件的扩展名必须是“.pfx、.p12”

使用指南

1、 1710机型BMC300 8.91及以上版本支持此功能。 2、 1711机型BMC300 3.8.0.1及以上版本支持此功能。

使用实例

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

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

json

{
  "Type": "text",
  "Content": base64_text,
  "Password": password
}

响应样例：

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)

UpdateCertFromCA

命令功能

更新 BMC 证书

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/SecurityService/CertUpdateService/Actions/CertUpdateService.UpdateCertFromCA

请求头:

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

请求消息体:

json

{}

请求头参数说明

参见请求头参数说明

请求体参数说明

无

使用指南

1、 1710机型BMC300 8.91及以上版本支持此功能。 2、 1711机型BMC300 3.8.0.1及以上版本支持此功能。

使用实例

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

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

json

{}

响应样例：

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

ResourceDefinition ​

uris ​

properties ​

supported_methods ​

HTTP methods ​

GET ​

PATCH ​

POST (ACTION) ​

ImportCACertificate ​

POST (ACTION) ​

ImportCrl ​

POST (ACTION) ​

DeleteCrl ​

POST (ACTION) ​

ImportClientCertificate ​

POST (ACTION) ​

UpdateCertFromCA ​

ResourceDefinition

uris

properties

supported_methods

HTTP methods

GET

PATCH

POST (ACTION)

ImportCACertificate

POST (ACTION)

ImportCrl

POST (ACTION)

DeleteCrl

POST (ACTION)

ImportClientCertificate

POST (ACTION)

UpdateCertFromCA