文档中心
在Gitcode上查看源码

CSR配置字典之UserPayload类 ​

📋 文档信息 ​

项目内容
文档标题UserPayload类配置字典
版本v1.0
创建日期2025-04-24
最后更新2025-04-24
维护状态✅ 活跃维护

📋 变更历史记录 ​

版本发布日期变更类型变更内容影响范围维护人员
v1.02025-04-24初始版本创建UserPayload类配置字典全新文档系统管理员

🎯 类概览 ​

属性值
类名称UserPayload
功能描述用户有效载荷配置管理，用于配置IPMI/RMCP协议的用户支持载荷类型
所属SIG组interface
所属组件rmcpd
最后更新2025-04-24
状态🟢 正常运行

📊 属性定义详表 ​

必选属性 ​

属性名类型默认值取值范围动态关联描述使用场景举例来源分类
IdU8-U8-用户载荷ID唯一标识用户载荷配置1CSR配置软件
StandardPayloadSupportU16[]-U16[]-标准载荷支持列表系统支持的标准载荷类型列表[3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3]CSR配置软件
StandardPayloadEnableU16[]-U16[]-标准载荷使能列表系统启用的标准载荷类型列表[3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3]CSR配置软件

可选属性 ​

  • 无可选属性

🔗 动态关联机制 ​

语法规范 ​

yaml
# 用户载荷配置
Id: 1
StandardPayloadSupport: [3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3]
StandardPayloadEnable: [3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3]

关联说明 ​

  • Id: 唯一标识用户载荷配置实例
  • StandardPayloadSupport: 系统支持的标准载荷类型
  • StandardPayloadEnable: 系统实际启用的标准载荷类型

📂 分类标准 ​

硬件属性 ​

  • 定义：当前版本无硬件属性
  • 特点：所有属性都是软件管理相关 | 示例：无

软件属性 ​

  • 定义：由软件管理和维护的用户载荷配置参数
  • 特点：载荷类型管理、功能开关等
  • 示例：所有属性都是软件属性

📝 配置示例 ​

标准载荷配置 ​

json
{
  "UserPayload": {
    "Id": 1,
    "StandardPayloadSupport": [3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3],
    "StandardPayloadEnable": [3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3]
  }
}

🔧 使用指南 ​

配置步骤 ​

  1. 设置载荷ID：配置Id属性
  2. 设置支持列表：配置StandardPayloadSupport属性
  3. 设置使能列表：配置StandardPayloadEnable属性

载荷类型说明 ​

载荷值载荷名称说明
0保留保留值
1IPMIIPMI消息载荷
2SOL串口重定向载荷
3OEMOEM定义载荷

使用场景 ​

  • 功能扩展：通过载荷类型支持扩展IPMI功能
  • OEM功能：支持厂商自定义功能
  • 协议协商：在会话建立时协商支持的载荷

注意事项 ​

  • 数组长度：StandardPayloadSupport和StandardPayloadEnable数组长度应一致
  • 支持与使能：Enable列表中的载荷必须在Support列表中
  • 载荷ID：每个UserPayload实例的Id应唯一
  • OEM载荷：OEM载荷（3）的具体含义由厂商定义

故障排除 ​

  1. 载荷不可用：

    • 检查StandardPayloadEnable是否包含该载荷
    • 确认StandardPayloadSupport是否支持该载荷 -验证载荷类型值是否正确

  2. 协商失败：

    • 检查客户端支持列表
    • 确认载荷类型配置 -验证协议版本
上一篇Ums
下一篇UnitConfiguration