接口常用字段及使用场景归纳

背景

(必选)从最终用户视角阐述当前有什么问题,包含问题的场景、影响点,以及当前系统的差距。(提交议题时删除此引导说明)

章节 词汇 / 模式 频次 典型场景
在位 / 物理位置(FRU / 槽位) Presence 26 部件是否在槽,dev 层 Drive、Fan 等热插拔检测
Slot / SlotNumber 21 / 8 物理槽位号
Position 13 拓扑位置(如 Board 由 Position + DeviceName 拼接 Id)
Location 14 机框 / 机房位置,Redfish Location 映射
DeviceLocator / SilkText 5–7 内存定位、丝印标识
DeviceName 9 设备丝印名
健康 / 状态 / 故障(Status 子接口模式) Status 35 通用运行状态,常拆为独立 *.Status 子 interface
Health 32 健康度,对齐 Redfish Health
State 16 状态机(电源、连接、升级等流程状态)
Enabled 47 功能 / 策略开关(非 Service 级)
ServiceEnabled 6 服务总开关(AccountService、EventService、TelemetryService 等)
PowerState / PowerStatus 19 / 6 电源开关与电源健康
DiagnosticFault / PredictiveFault 8 诊断性 / 预测性故障
FaultCode / FaultState 7 / 5 故障码与故障状态
LinkStatus 5 网络 / PCIe 链路状态
电源(Power) PowerState 19 上电 / 下电状态
PowerWatts 13 功耗,Redfish 瓦特单位
PowerStatus 6 电源模块健康
PowerCapacityWatts 2 电源容量
Voltage / Current token 高频 电压、电流监测
网络(NetworkAdapters / EthernetInterfaces / NetworkPort) Protocol 13 通信协议
Port / PortId 10 端口标识
LinkStatus / LinkWidth 5 PCIe / 以太网链路状态与宽度
MACAddress / IPAddress 2 / 1 地址配置
SpeedMbps 1 链路速率
ConnectState 11 连接状态
Tx / Rx token 75 / 50 收发计数 / 带宽
域路径 Systems/NetworkAdaptersManagers/EthernetInterfacesManagers/NetworkProtocol
方法动词(Method 命名模式) Set* 272 写属性 / 配置(如 SetDateTimeSetConfigurations
Get* 195 读配置 / 数据(如 GetDataGetConfigurations
Reset 16 复位(风扇、BMC、恢复默认值)
Import / Export 30 / 26 证书、字典、配置导入导出
Connect / Disconnect 9 / 9 虚拟媒体、会话、链路连接
Delete / Add 32 / 20 资源 CRUD
Read / Write / WriteRead 10 / 7 / 4 底层 Chip / Bus 寄存器访问(dev 层)
后缀 / 前缀命名模式(Property 词法) *Id / *ID 337 资源标识
*Enabled 195 功能开关
*Type 177 类型枚举
*Status 155 健康 / 状态子资源
*Name 144 名称
*Count 106 计数 / 阈值
*State 99 状态机
*Temperature* / *Celsius/*TemperatureCelsius 120 温度相关属性词法模式
*Mode 80 工作模式
*Policy 55 策略配置
Max* / Min* 81 范围约束(密码长度、阈值上下限)
Is* / Has* 33 布尔判断
Serial 40 序列号相关
*Flag 19 标志位(如 IntrusionFlag)
*Timeout 5 超时配置