代码仓
中
更新时间: 2026/11/02
在AtomGit上查看源码

CSR配置字典之SOL类 ​

📋 文档信息 ​

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

📋 变更历史记录 ​

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

🎯 类概览 ​

属性值
类名称SOL
功能描述Serial Over LAN配置管理,用于通过网络进行串口重定向和控制台访问
所属SIG组interface
所属组件rmcpd
最后更新2025-04-24
状态🟢 正常运行

📊 属性定义详表 ​

必选属性 ​

属性名类型默认值取值范围动态关联描述使用场景举例来源分类
EnabledBoolean-Boolean-CLI_SOL使能状态控制SOL功能是否启用trueCSR配置软件
ModeU8-[0, 1]-CLI_SOL会话模式0为共享模式,1为独占模式0CSR配置软件
SerialDirectU8-U8-串口方向0无方向,1系统OS串口,2 BMC串口(历史保留值,当前rmcpd实现不生效)1CSR配置软件
TimeoutU16-U16-会话超时时间单位:分钟15CSR配置软件
IdU8-U8-SOL会话ID唯一标识SOL会话1CSR配置软件
AuthenWayU8-U8-认证方式标识SOL认证方式0CSR配置软件
EncryWayU8-U8-加密方式标识SOL加密方式1CSR配置软件
PrivilegeLevelU8-U8-特权级别标识SOL访问权限级别4CSR配置软件
SendThresholdU8-U8-发送阈值字符发送缓冲阈值32CSR配置软件
SendIntervalU8-U8-发送间隔字符发送间隔(单位:5ms,默认值8表示40ms)8CSR配置软件
RetryCountU8-U8-重试次数发送失败重试次数3CSR配置软件
RetryIntervalU8-U8-重试间隔重试间隔(毫秒)20CSR配置软件
SetProgressU8-U8-设置进度配置设置进度0CSR配置软件
IPMISOLEnabledBoolean-Boolean-IPMI SOL使能IPMI SOL功能使能状态trueCSR配置软件

可选属性 ​

  • 无可选属性

🔗 动态关联机制 ​

语法规范 ​

yaml
# SOL配置
Enabled: true
Mode: 0
SerialDirect: 1
Timeout: 15
Id: 1
AuthenWay: 0
EncryWay: 1
PrivilegeLevel: 4
SendThreshold: 32
SendInterval: 8
RetryCount: 3
RetryInterval: 20
SetProgress: 0
IPMISOLEnabled: true

关联说明 ​

  • Enabled: 控制CLI_SOL功能总开关
  • Mode: 控制CLI_SOL会话模式(共享/独占)
  • SerialDirect: 控制串口数据流向
  • Timeout: 控制空闲会话超时
  • Id: 唯一标识SOL配置实例
  • AuthenWay/EncryWay: 控制认证和加密方式
  • PrivilegeLevel: 控制访问权限
  • SendThreshold/SendInterval: 控制字符发送策略
  • RetryCount/RetryInterval: 控制重传策略
  • IPMISOLEnabled: 控制IPMI SOL功能

🔢 属性取值说明 ​

会话与串口方向 ​

属性取值说明
Mode0共享模式(SHARED_MODE),多个客户端可同时连接同一 SOL 会话
Mode1独占模式(PRIVATE_MODE),同一时刻仅允许一个客户端占用会话
SerialDirect0无方向,不进行串口重定向;会话停止时 rmcpd 会恢复为该值
SerialDirect1系统 OS 串口(SYS_DIRECT),SOL 数据转发到主机系统串口,为 IPMI SOL 会话激活时的取值
SerialDirect2BMC 串口,仅在部分历史版本/产品形态中存在;当前 rmcpd 实现仅使用 0/1,配置为 2 不会生效

说明:Mode、SerialDirect 属于运行时状态量,通常由 rmcpd 在 SOL 激活/去激活时自动改写(激活时 Mode=1、SerialDirect=1,去激活时恢复为 0),CSR 中的值仅作为初始值/默认值使用。

认证与加密 ​

属性取值说明
AuthenWay0不启用 SOL 会话认证
AuthenWay1启用 SOL 会话认证(对应 IPMI Set SOL Configuration 参数中的 1 bit Auth 位)
EncryWay0不启用 SOL 数据加密
EncryWay1启用 SOL 数据加密(对应 1 bit Encryption 位)
PrivilegeLevel2User 级,允许 User 及以上权限的用户使用 SOL
PrivilegeLevel3Operator 级
PrivilegeLevel4Administrator 级,CSR 缺省值
PrivilegeLevel5OEM 级

说明:PrivilegeLevel 在 IPMI 命令解析时校验 2 ≤ 取值 ≤ 5,取值 0/1 或大于 5 会返回 IPMIOutOfRange;AuthenWay、EncryWay 与 PrivilegeLevel 三者由同一条 Set SOL Configuration(参数 2)写入。

设置进度 ​

取值名称说明
0set complete配置设置完成,允许其他会话再次发起设置
1set in progress配置正在设置中;若当前已是该状态,再次设置会报错,用于避免多会话并发修改
2commit write提交写入
3reserved保留

传输与会话参数 ​

属性单位说明
Timeout分钟SOL 会话空闲超时时间,超时后自动断开会话
SendThreshold字节字符发送阈值,缓冲区达到该字节数即触发发送;取值为 0 会被拒绝
SendInterval5ms字符累积发送间隔,每个计数单位代表 5ms,因底层最小调度粒度为 10ms,取值必须 ≥ 2(即 ≥ 10ms)
RetryCount次发送失败重试次数,IPMI 命令中为 3 bit(0~7)
RetryInterval毫秒两次重试之间的间隔
Id-SOL 会话/配置实例标识,用于区分多条 SOL 配置
Enabled-CLI_SOL 功能总开关,false 时 CLI 侧无法建立 SOL 会话
IPMISOLEnabled-IPMI SOL 载荷使能,false 时 IPMI 侧 SOL 会话无法激活

📂 分类标准 ​

硬件属性 ​

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

软件属性 ​

  • 定义:由软件管理和维护的SOL配置参数
  • 特点:会话管理、串口重定向、认证加密等
  • 示例:所有属性都是软件属性

📝 配置示例 ​

标准共享模式配置 ​

json
{
  "SOL": {
    "Enabled": true,
    "Mode": 0,
    "SerialDirect": 1,
    "Timeout": 15,
    "Id": 1,
    "AuthenWay": 0,
    "EncryWay": 1,
    "PrivilegeLevel": 4,
    "SendThreshold": 32,
    "SendInterval": 8,
    "RetryCount": 3,
    "RetryInterval": 20,
    "SetProgress": 0,
    "IPMISOLEnabled": true
  }
}

独占模式配置 ​

json
{
  "SOL": {
    "Enabled": true,
    "Mode": 1,
    "SerialDirect": 1,
    "Timeout": 30,
    "Id": 1,
    "AuthenWay": 0,
    "EncryWay": 1,
    "PrivilegeLevel": 4,
    "SendThreshold": 64,
    "SendInterval": 5,
    "RetryCount": 5,
    "RetryInterval": 30,
    "SetProgress": 0,
    "IPMISOLEnabled": true
  }
}

🔧 使用指南 ​

配置步骤 ​

  1. 使能SOL功能:配置Enabled和IPMISOLEnabled
  2. 选择会话模式:配置Mode属性
  3. 设置串口方向:配置SerialDirect属性
  4. 设置超时时间:配置Timeout属性
  5. 配置认证加密:配置AuthenWay和EncryWay
  6. 设置权限级别:配置PrivilegeLevel
  7. 配置传输参数:配置SendThreshold和SendInterval
  8. 配置重传策略:配置RetryCount和RetryInterval

会话模式说明 ​

模式值模式名称说明
0共享模式多用户可同时查看SOL输出
1独占模式单用户独占SOL会话

串口方向说明 ​

方向值方向名称说明
0无方向不进行串口重定向
1系统OS串口重定向到主机系统串口
2BMC串口历史保留值,当前rmcpd实现仅使用0/1,配置为2不会生效

使用场景 ​

  • 远程调试:通过网络远程访问系统串口
  • 故障诊断:查看系统启动信息和错误日志
  • 设备配置:通过串口配置设备参数
  • 应急处理:在无法通过其他方式访问系统时使用

注意事项 ​

  • 安全性:SOL传输未加密,建议配合VPN使用
  • 会话限制:共享模式下性能可能下降
  • 超时设置:合理设置Timeout避免占用资源
  • 权限控制:根据需要设置PrivilegeLevel
  • 字符丢失:调整SendThreshold和SendInterval优化传输

故障排除 ​

  1. SOL连接失败:

    • 检查Enabled和IPMISOLEnabled是否为true
    • 确认网络连接是否正常
    • 验证防火墙设置
  2. 字符显示异常:

    • 检查SerialDirect配置是否正确
    • 调整SendThreshold和SendInterval -确认串口波特率设置
  3. 会话超时:

    • 检查Timeout设置是否过短
    • 确认是否有网络中断 -验证会话保活机制