文档中心
在Gitcode上查看源码

产品信息管理功能使用指导 ​

概述 ​

本文档介绍 openUBMC 产品信息管理功能的使用方法。product_mgmt 组件主要提供产品信息管理、产品生命周期管理（DFLC）、Web 页面语言管理和产品定制（包括白牌定制和装备定制）功能。

产品信息管理 ​

认识产品信息管理 ​

product_mgmt 管理的信息主要分为以下几部分：

信息类别描述可定制
产品信息ProductName、ProductId、ProductAlias、ProductPicture可定制
软件信息SoftwareName白牌定制
联系信息版权、邮件、官网、电话、KVM下载链接等可定制

产品名 ​

资源树路径 ​

产品名用于区分不同的机型。

资源树接口：

bash
busctl --user get-property bmc.kepler.product_mgmt /bmc/kepler/Systems/1/Product bmc.kepler.Systems.Product ProductName
s "openUBMC Product"

查看产品名 ​

通过 CLI 查看：

bash
ipmcget -d version
...
----------------- Product INFO -----------------
Product                 ID:         0x0000
Product               Name:         openUBMC Product
Product          Unique ID:         0x00000000
Active BIOS        Version:         7.44
Backup BIOS        Version:         7.44
PSR                Version:         1.03
...

通过 Web 查看：

  • 登录页显示产品名

  • 首页显示产品名和产品别名

产品名来源 ​

北向接口统一使用 product_mgmt 中的 ProductName。ProductName 的读取逻辑：

  1. 优先从 FruId=0 电子标签的 System.ProductName 读取。
  2. 若为空，则从 PSR 固定配置读取。

说明

产品别名可以通过 Redfish 接口直接修改，而产品名只能通过修改电子标签或者修改 PSR 配置的方式进行修改。

修改产品名 ​

如果产品名不符合预期，可以：

  1. 修改电子标签（FruId=0）。
  2. 修改 PSR 配置。

软件名 ​

资源树路径 ​

软件名默认值为 BMC，客户可以通过白牌定制来修改。

资源树接口：

bash
busctl --user get-property bmc.kepler.product_mgmt /bmc/kepler/Managers/1/BMC bmc.kepler.Managers.BMC SoftwareName
s "BMC"

软件名应用位置 ​

  1. 首页 - "BMC 管理页签" 中的 "BMC"
  2. CLP 提示符 - SSH 登录后的提示符
  3. 日志 - 操作日志、安全日志、运行日志中的 "BMC" 字样

说明

oms 读取 product_mgmt 资源树上的软件名，修改 rsyslog 配置，将 BMC 字样强制替换为客户定制的软件名。

首页机型图 ​

资源树路径 ​

资源树接口：

bash
busctl --user get-property bmc.kepler.product_mgmt /bmc/kepler/Systems/1/Product bmc.kepler.Systems.Product ProductPicture
s "img_01"

图片路径规则 ​

如果 ProductPicture 显示为字符串 img_01，前端会读取：

text
/data/opt/pme/web/custom/img_01.png

如果环境上没有这个文件，前端会读取默认的资源文件。首页机型图同样可以用白牌包进行定制。

联系信息 ​

资源树路径 ​

联系信息包括版权信息、邮件、KVM 独立客户端下载链接、官网、联系电话、二维码是否展示、支持网站等。

资源树接口：

bash
busctl --user introspect bmc.kepler.product_mgmt /bmc/kepler/Systems/1/Contact bmc.kepler.Systems.Contact
NAME                       TYPE      SIGNATURE RESULT/VALUE                             FLAGS
.Copyright                 property  s         "xxxxxx Technologies Co., Ltd. 2022-202… emits-change writable
.Email                     property  s         "xxx@openUBMC.com"                       emits-change writable
.KVMClientDownloadLink     property  s         "https://xxxx.com/path/to/link"          emits-change writable
.OfficalWeb                property  s         ""                                       emits-change writable
.Phone                     property  s         "xxxxxx"                                 emits-change writable
.QRCodeSupported           property  b         true                                     emits-change writable
.SupportWeb                property  s         "https://xxxxxx.com"                     emits-change writable

可定制的信息 ​

信息项描述
Copyright版权信息
Email邮箱地址
KVMClientDownloadLinkKVM 独立客户端下载链接
OfficalWeb官网地址
SupportWeb技术支持网站
Phone联系电话
QRCodeSupported是否支持显示文档二维码

产品生命周期管理 ​

认识产品生命周期管理 ​

根据公司要求，产品需要有生命周期管理设计（DFLC）。openUBMC 交付电子保单功能，包含以下属性的维护：

  • 首次上电时间
  • 服务起始时间
  • 服务年限

资源树接口 ​

bash
busctl --user introspect bmc.kepler.product_mgmt /bmc/kepler/Systems/1/Product bmc.kepler.Systems.Product.DigitalWarranty
NAME                                       TYPE      SIGNATURE RESULT/VALUE FLAGS
.FirstPowerOnTime                          property  s         "N/A"        emits-change
.Lifespan                                  property  y         0            emits-change writable
.StartPoint                                property  s         "1996-04-10" emits-change writable

首次上电时间 ​

FirstPowerOnTime：服务器首次上电时间

服务起始时间 ​

StartPoint：服务起始时间是指售卖设备时，合同上写的提供服务的起始时间。该属性可以被接口修改，没有法律效力，只提供参考，具体的服务起始时间以合同为准。

服务年限 ​

Lifespan：服务年限是指从服务起始时间开始，提供的后续服务时长，单位为月。

北向接口 ​

Redfish 接口 ​

https://{device_ip}/redfish/v1/Systems/{SystemId}/DigitalWarranty

Web 接口 ​

https://{device_ip}/UI/Rest/System/ProductInfo

语言管理 ​

认识语言管理 ​

openUBMC 支持多语言界面，目前语言资源已经在前端代码文件中包含。

支持的语言 ​

目前支持以下语言：

语言代码语言名称说明
zh中文默认安装，不可取消
en英文默认安装，不可取消

语言开关规则 ​

  • Web 勾选语言 - 表示安装该语言，右上角有该语言的选项
  • Web 取消勾选语言 - 表示删除该语言，右上角没有该语言的选项
  • 其中中文和英文不支持取消勾选，默认安装

资源树路径 ​

bash
busctl --user get-property bmc.kepler.product_mgmt /bmc/kepler/Systems/1/Product bmc.kepler.Systems.Product LanguageSet
as 2 "en" "zh"

接口一览 ​

接口类型描述
/redfish/v1GET获取服务根
/redfish/v1/Managers/{manager_id}GET获取管理器信息
/redfish/v1/Managers/{manager_id}PATCH更新管理器信息
/redfish/v1/Managers/{manager_id}/Actions/Oem/openUBMC/Manager.DeleteLanguagePOST删除语言
/UI/Rest/LoginGET获取登录信息
/UI/Rest/GenericInfoGET获取通用信息
/UI/Rest/BMCSettings/LanguageGET获取语言设置
/UI/Rest/BMCSettings/Language/OpenLanguagePOST开启语言
/UI/Rest/BMCSettings/Language/CloseLanguagePOST关闭语言

产品定制 ​

白牌定制 ​

白牌定制参考社区白牌包定制相关文档

装备定制 ​

装备定制参考社区装备定制相关文档

常见问题 ​

产品名显示不正确 ​

症状：产品名与预期不符

可能原因：

  1. 电子标签配置错误
  2. PSR 配置错误
  3. 产品别名被误修改

解决方法：

  1. 检查电子标签配置
  2. 检查 PSR 配置
  3. 通过接口修正产品别名

语言切换失败 ​

症状：切换语言后界面显示异常

可能原因：

  1. 语言资源未安装
  2. 浏览器缓存问题

解决方法：

  1. 确认语言已勾选安装
  2. 清除浏览器缓存

附录 ​

参考资料 ​

上一篇多层级定制配置指导
下一篇SNMP 功能使用指导