Systems
更新时间: 2026/11/04
在AtomGit上查看源码ResourceDefinition
uris
/redfish/v1/Systems/system_id
properties
| 名称 | 类型 | 是否只读 | 取值范围/枚举值 | 说明 |
|---|---|---|---|---|
| @odata.context | string | true | - | 指定系统资源模型的OData描述信息 |
| @odata.id | string | true | - | 指定系统资源的访问路径 |
| @odata.type | string | true | - | 指定系统资源的类型 |
| Id | string | true | - | 指定系统资源的ID |
| Name | string | true | - | 指定系统资源的名称 |
| AssetTag | string | false | - | 指定系统资源的资产标签 |
| Manufacturer | string | true | - | 指定系统资源的制造商 |
| Model | string | true | - | 指定系统资源的型号 |
| PowerMode | string | false | MaximumPerformance/BalancedPerformance/PowerSaving/Static/OSControlled/OEM/EfficiencyFavorPower/EfficiencyFavorPerformance | 指定系统的节能模式 |
| SerialNumber | string | true | - | 指定系统资源的序列号 |
| UUID | string | false | - | 指定系统资源的全球唯一标识 |
| SystemType | string | true | Physical | 指定系统资源的系统类型 |
| HostName | string | false | - | 指定系统资源的主机名 |
| PartNumber | string | true | - | 指定系统资源的部件号 |
| HostingRole[ ] | array | true | ApplicationServer/Switch/StorageServer | 指定系统资源的主机角色 |
| HostWatchdogTimer { | object | true | - | 指定系统资源的看门狗计时器功能 |
| HostWatchdogTimer.FunctionEnabled | boolean | true | - | 系统资源的看门狗使能 |
| HostWatchdogTimer.TimeoutAction | string | true | None/OEM/PowerCycle/PowerDown/ResetSystem | 系统资源的看门狗超时策略 |
| } | ||||
| LastResetTime | string | true | - | 上次重启时间 |
| Status { | object | true | - | 指定系统资源的状态,包括Health/State/Severity,包括: ● Health:健康状态 ● Severity:告警严重级别 ● State:静态模式 |
| Status.Health | string | true | - | 指定系统资源的健康状态,包括: ● OK:正常 ● Warning:警告 ● Critical:严重 ● null |
| Status.Oem { | object | true | - | 自定义属性 |
| Status.Oem.Public { | object | false | - | 自定义属性 |
| Status.Oem.Public.Severity | string | false | - | 指定系统资源的自定义健康状态,包括: ● Informational:正常 ● Minor:轻微 ● Major:严重 ● Critical:紧急 ● null |
| } | ||||
| } | ||||
| Status.State | string | true | - | 指定系统的状态 ● Offline:离线 ● Partiallydegraded:部分降级 ● Degraded:降级 ● Optimal:正常 ● Failed:故障 ● Not Configured:未配置 ● Interimrecovery:临时恢复 ● Readyfor recovery:准备恢复 ● Recovering:恢复中 ● Wrongdrive replaced:错误硬盘被替换 ● Driveimproperly connected:硬盘连接不正确 ● Expanding:扩容中 ● Not available:不可用 ● Queuedfor expansion:排队等待扩容 ● Disabledfrom SCSIconflict:SCSI冲突禁用 ● Ejected:已弹出 ● Erasein progress:擦除进行中 ● Unused:未使用 ● Readyto performpredictive sparerebuild:准备执行预测性热备重建 ● RPIin progress:RPI进行中 ● RPI queued:RPI排队中 ● Encryptedwithoutkey:加密但无密钥 ● Encryptionmigration:加密迁移中 ● Encrypted & re-keying:加密且正在重新密钥 ● Encryptedwith encryptionoff:加密但加密已关闭 ● Volumeencode requested:请求卷编码 ● Encryptedwithre-key request:加密且有重新密钥请求 ● Unsupported:不支持 ● Not Formatted:未格式化 ● Formatting:格式化中 ● Sanitizing:安全擦除中 |
| } | ||||
| PowerState | string | true | On/Off | 指定系统资源的上电状态 |
| PowerRestorePolicy | string | false | AlwayOn/LastState/AlwaysOff | 通电开机策略 |
| Boot { | object | false | - | 指定系统资源的启动参数 |
| Boot.BootSourceOverrideTarget | string | false | - | 系统的当前启动设备 |
| Boot.BootSourceOverrideEnabled | string | false | Disabled/Once/Continuous | 系统启动参数的使能状态 |
| Boot.BootSourceOverrideMode | string | false | Legacy/UEFI | 系统启动模式 |
Boot.BootSourceOverrideTarget@Redfish.AllowableValues[ ] | array | true | None/Pxe/Floppy/Cd/Hdd/BiosSetup | Redfish定义的启动设备 |
| } | ||||
| TrustedModules [ { | array | true | - | 指定系统资源的可信模块 |
| TrustedModules[].FirmwareVersion | string | true | - | 可信模块的固件版本 |
| TrustedModules[].InterfaceType | string | true | TPM1_2/TPM2_0/TCM1_0 | 可信模块的接口类型 |
| TrustedModules[].Status { | object | true | - | 指定系统资源的状态,包括Health/State/Severity,包括: ● Health:健康状态 ● Severity:告警严重级别 ● State:静态模式 |
| TrustedModules[].Status.Health | string | true | - | 指定系统资源的健康状态,包括: ● OK:正常 ● Warning:警告 ● Critical:严重 ● null |
| TrustedModules[].Status.Oem { | object | true | - | 自定义属性 |
| TrustedModules[].Status.Oem.Public { | object | false | - | 自定义属性 |
| TrustedModules[].Status.Oem.Public.Severity | string | false | - | 严重性级别 ● OK:正常 ● Warning:告警 ● Critical:致命 |
| } | ||||
| } | ||||
| TrustedModules[].Status.state | string | true | - | 可信模块的状态 |
| } | ||||
| } ] | ||||
| BiosVersion | string | true | - | 指定系统资源的BIOS版本 |
| ProcessorSummary { | object | true | - | 指定系统资源的CPU信息 |
| ProcessorSummary.Count | number | true | - | CPU个数 |
| ProcessorSummary.Model | string | true | - | CPU型号 |
| ProcessorSummary.CoreCount | number | true | - | 处理器核心总数 |
| ProcessorSummary.Metrics { | object | true | - | 处理器指标摘要 |
ProcessorSummary.Metrics.@odata.id | string | true | - | Metrics资源的访问路径 |
| } | ||||
| ProcessorSummary.Oem { | object | true | - | 自定义属性 |
| ProcessorSummary.Oem.Public { | object | false | - | 自定义属性 |
| ProcessorSummary.Oem.Public.Presence | string | true | Present、Absent | 在位状态 |
| } | ||||
| } | ||||
| ProcessorSummary.Status { | object | true | - | 指定系统资源的状态,包括Health/State/Severity,包括: ● Health:健康状态 ● Severity:告警严重级别 ● State:静态模式 |
| ProcessorSummary.Status.HealthRollup | string | true | - | 指定系统子资源整体运行状态,通常取值为OK,任意Job子资源JobStatus存在异常(Critical)时取值为Warning,包括: ● OK:正常 ● Warning:警告 |
| ProcessorSummary.Status.Oem { | object | true | - | 自定义属性 |
| ProcessorSummary.Status.Oem.Public { | object | false | - | 自定义属性 |
| ProcessorSummary.Status.Oem.Public.Severity | string | false | - | 错误严重级别,包括: ● OK:正常 ● Warning:警告 ● Critical:严重 |
| } | ||||
| } | ||||
| } | ||||
| } | ||||
| MemorySummary { | object | true | - | 指定系统资源的内存信息 |
| MemorySummary.TotalSystemMemoryGiB | number | true | - | 系统总内存容量,单位为GB |
| MemorySummary.Metrics { | object | true | - | 内存指标摘要 |
MemorySummary.Metrics.@odata.id | string | true | - | Metrics资源的访问路径 |
| } | ||||
| MemorySummary.Oem { | object | true | - | 自定义属性 |
| MemorySummary.Oem.Public { | object | false | - | 自定义属性 |
| MemorySummary.Oem.Public.MemoryCount | number | true | - | 内存数量 |
| } | ||||
| } | ||||
| MemorySummary.Status { | object | true | - | 指定系统资源的状态,包括Health/State/Severity,包括: ● Health:健康状态 ● Severity:告警严重级别 ● State:静态模式 |
| MemorySummary.Status.HealthRollup | string | true | - | 指定系统子资源整体运行状态,通常取值为OK,任意Job子资源JobStatus存在异常(Critical)时取值为Warning,包括: ● OK:正常 ● Warning:警告 |
| MemorySummary.Status.Oem { | object | true | - | 自定义属性 |
| MemorySummary.Status.Oem.Public { | object | false | - | 自定义属性 |
| MemorySummary.Status.Oem.Public.Severity | string | false | - | 错误严重级别,包括: ● OK:正常 ● Warning:警告 ● Critical:严重 |
| } | ||||
| } | ||||
| } | ||||
| } | ||||
| GraphicalConsole { | object | false | - | 虚拟控制台(KVM-IP)服务的信息。openUBMC 25.12 LTS及以上版本支持 |
| GraphicalConsole.ConnectTypesSupported[ ] | array | true | - | 支持的虚拟控制台连接类型 |
| GraphicalConsole.MaxConcurrentSessions | number | true | - | 最大会话数 |
| GraphicalConsole.Port | number | false | - | 服务的端口号 |
| GraphicalConsole.ServiceEnabled | boolean | false | - | 服务的使能状态 |
| } | ||||
| VirtualMediaConfig { | object | false | - | 虚拟媒体服务的信息。openUBMC 25.12 LTS及以上版本支持 |
| VirtualMediaConfig.Port | number | false | - | 服务的端口号 |
| VirtualMediaConfig.ServiceEnabled | boolean | false | - | 服务的使能状态 |
| } | ||||
| Processors { | object | true | - | 处理器资源节点的访问路径 |
Processors.@odata.id | string | true | - | Processors资源的访问路径 |
| } | ||||
| Memory { | object | true | - | 内存资源节点的访问路径 |
Memory.@odata.id | string | true | - | Memory资源的访问路径 |
| } | ||||
| EthernetInterfaces { | object | true | - | 主机网卡资源节点的访问路径 |
EthernetInterfaces.@odata.id | string | true | - | EthernetInterfaces资源的访问路径 |
| } | ||||
| Storage { | object | true | - | 存储资源节点的访问路径 |
Storage.@odata.id | string | true | - | Storage资源的访问路径 |
| } | ||||
| NetworkInterfaces { | object | true | - | 网络接口资源节点的访问路径 |
NetworkInterfaces.@odata.id | string | true | - | NetworkInterfaces资源的访问路径 |
| } | ||||
| LogServices { | object | true | - | 日志服务资源节点的访问路径 |
LogServices.@odata.id | string | true | - | LogServices资源的访问路径 |
| } | ||||
| PCIeDevices[ ] | array | true | - | PCIe设备资源节点的访问路径 |
| PCIeFunctions[ ] | array | true | - | PCIe功能资源节点的访问路径 |
| Bios | object | true | - | Bios资源节点的访问路径(只有V5服务器存在) |
| SecureBoot { | object | true | - | 安全启动资源节点的访问路径 |
SecureBoot.@odata.id | string | true | - | SecureBoot资源的访问路径 |
| } | ||||
| VirtualMedia { | object | true | - | 虚拟媒体资源访问路径 |
VirtualMedia.@odata.id | string | true | - | VirtualMedia资源的访问路径 |
| } | ||||
| Links { | object | true | - | 系统资源的资源链接 |
| Links.Chassis [ { | array | true | - | 机箱资源节点的访问路径 |
Links.Chassis[].@odata.id | string | true | - | 成员资源节点的访问路径 |
| } ] | ||||
| Links.Managers [ { | array | true | - | 管理资源的资源节点访问路径 |
Links.Managers[].@odata.id | string | true | - | 成员资源节点的访问路径 |
| } ] | ||||
| Links.TrustedComponents[ ] | array | true | - | 可信组件链接 |
| } | ||||
| Oem { | object | true | - | 系统资源的自定义属性 |
| Oem.Public { | object | false | - | 系统资源的自定义属性 |
| Oem.Public.HealthSummary { | object | true | - | 系统健康状态总览 |
| Oem.Public.HealthSummary.CriticalAlarmCount | number | true | - | 当前系统中致命告警的数量 |
| Oem.Public.HealthSummary.MajorAlarmCount | number | true | - | 当前系统中严重告警的数量 |
| Oem.Public.HealthSummary.MinorAlarmCount | number | true | - | 当前系统中轻微告警的数量 |
| } | ||||
| Oem.Public.ConfigurationModel | string | false | - | 配置型号 |
| Oem.Public.OSVersion | string | true | - | 操作系统版本 |
| Oem.Public.HostnameSyncEnabled | boolean | false | - | iBMA上报Hostname同步BMC使能开关 |
| Oem.Public.CPUUsagePercent | number | true | - | CPU占用率 |
| Oem.Public.MemoryUsagePercent | number | true | - | 内存占用率 |
| Oem.Public.LocalKvmEnabled | boolean | false | - | 本地Kvm使能 |
| Oem.Public.SafePowerOffTimeoutEnabled | boolean | false | - | 下电时限使能开关 |
| Oem.Public.SafePowerOffTimoutSeconds | number | false | - | 安全下电超时时间 |
| Oem.Public.PowerOnStrategy | string | false | TurnOn/RestorePreviousState/StayOff | 通电开机策略 |
| Oem.Public.LeakStrategy | string | false | ManualPowerOff/AutoPowerOff | 液冷服务器漏液后电源控制策略 |
| Oem.Public.PowerRestoreDelayMode | string | false | DefaultDelay/HalfDelay/FixedDelay/RandomDelay | 上电延迟模式 |
| Oem.Public.PowerRestoreDelaySeconds | number | false | - | 延迟上电的时间,单位秒 |
| Oem.Public.EnergySavingEnabled | boolean | false | - | 智能节能功能使能 |
| Oem.Public.AutoOSLockKey[ ] | array | true | - | 系统自动锁定自定义快捷键 |
| Oem.Public.BiosDynamicParamConfig | object | true | - | BIOS动态参数配置信息 |
| Oem.Public.BootupSequence[ ] | array | true | - | 系统启动顺序,Hdd,Cd,Pxe,Others四个值的任意序列 说明:只支持V3产品,V5及后续产品请使用/Systems/system_id/Bios/Settings接口 |
| Oem.Public.CPUPowerAdjustment | object | true | - | CPU节能设置 |
| Oem.Public.DigitalWarranty | object | true | - | 电子保单资源节点的访问路径 须知 此资源已经废弃,仅供兼容性用途使用。openUBMC 26.03及以上版本建议使用redfish/v1/Chassis/chassis_id/Oem/openUBMC/DigitalWarranty接口进行电子保单管理 |
| Oem.Public.Drives[ ] | array | true | - | 物理盘列表 |
| Oem.Public.FruControlType[ ] | array | true | - | 华为定义的FRU重启操作,包括: On GracefulShutdown ForceRestart Nmi ForcePowerCycle PowerCycle |
| Oem.Public.HotSpare | object | true | - | 热备盘信息 |
| Oem.Public.InfiniBandInterfaces | object | true | - | IB资源节点的访问路径 |
| Oem.Public.KVMSettings | object | true | - | 虚拟控制台(KVM-IP)服务的配置信息。 说明 openUBMC 25.12 LTS及以上版本支持 |
| Oem.Public.Link | object | true | - | Raid控制器资源的链接 |
| Oem.Public.LogicalDriveSummary | object | true | - | 指定系统资源的逻辑盘信息 |
| Oem.Public.MemoryHistoryUsageRate | object | true | - | 内存历史占用率资源节点的访问路径 |
| Oem.Public.MemoryView | object | true | - | 批量查询内存资源节点的访问路径 |
| Oem.Public.NetworkBridge | object | true | - | 网络桥接资源节点的访问路径 |
| Oem.Public.PartitionLists[ ] | array | true | - | 磁盘分区列表 说明:已屏蔽该属性值频繁变化导致的事件上报 |
| Oem.Public.PowerOnStrategyExceptions[ ] | array | true | - | 通电开机策略的例外场景,当前支持: FirmwareActive: 通过ACCycle方式生效固件 |
| Oem.Public.PresentFrus | object | true | - | 在位的Fru信息 |
| Oem.Public.ProcessorsHistoryUsageRate | object | true | - | CPU历史占用率资源节点的访问路径 |
| Oem.Public.ProcessorView | object | true | - | 批量查询CPU资源节点的访问路径 |
| Oem.Public.RaidControllers[ ] | array | true | - | Raid控制器列表 |
| Oem.Public.Spans[ ] | array | true | - | Span列表 |
| Oem.Public.StorageSubsystemSummary | object | true | - | 指定系统资源的存储子系统信息 |
| Oem.Public.StorageSummary | object | true | - | 指定系统资源的存储控制器信息 |
| Oem.Public.StorageViewsSummary | object | true | - | 存储视图信息总览 |
| Oem.Public.VncSettings | object | true | - | Vnc服务的配置信息。 说明 openUBMC 25.12 LTS及以上版本支持 |
| Oem.Public.Volumes[ ] | array | true | - | 逻辑盘列表 |
| } | ||||
| } | ||||
| Actions { | object | true | - | Redfish允许的指定系统资源可执行操作 |
| Actions.#ComputerSystem.Reset { | object | true | - | OS重启操作 |
| Actions.#ComputerSystem.Reset.target | string | true | - | 重启操作属性的访问路径 |
Actions.#ComputerSystem.Reset.@Redfish.ActionInfo | string | true | - | 操作信息查询路径 |
| } | ||||
| Actions.Oem { | object | true | - | 自定义属性 |
| Actions.Oem.Public { | object | false | - | 自定义属性 |
| Actions.Oem.Public.#ComputerSystem.FruControl { | object | true | - | FRU重启操作 |
Actions.Oem.Public.#ComputerSystem.FruControl.@Redfish.ActionInfo | string | true | - | 操作信息查询路径 |
| Actions.Oem.Public.#ComputerSystem.FruControl.target | string | true | - | 重启操作属性的访问路径 |
| } | ||||
| } | ||||
| } | ||||
| } | ||||
| ActivatedSessionsType | string | true | - | KVM会话类型 ●“Shared”:共享 ●“Private”:独占 ● null:暂无会话 |
| AutoCloseLocalDisplay | boolean | true | - | 虚拟控制台启动时自动关闭本地Kvm使能 说明:虚拟控制台关闭时会自动恢复本地Kvm |
| AutoOSLockEnabled | boolean | false | - | 系统自动锁定使能 ●“true”:支持最后一个远程登录用户离开时,业务侧OS自动锁定 ●“false”:不支持业务侧OS自动锁定 |
| AutoOSLockType | string | false | - | 系统自动锁定方式 ●“Custom”:自定义 ●“Windows”:Windows锁定 |
| BootModeConfigOverIpmiEnabled | boolean | true | - | IPMI设置启动模式可切换使能 |
| BootModeIpmiSWDisplayEnabled | boolean | true | - | Web是否显示IPMI设置启动模式可切换使能开关 |
| BSasCtrlSdkVersion | string | true | - | B厂商SAS控制器SDK包的版本号,形如“X.Y.Z”:X:大版本号。1表示V3系列,2表示V5系列,3表示V6系列 Y:次版本号,表征版本兼容性相关变更 Z:修订号,表征问题修复/特性增强相关变更 |
| BWUWaveTitle | string | false | - | 网卡标识 |
| CPUPLimit | number | true | - | CPU最高工作频率支持的范围,值为null时不支持设置CPU的最高工作频率 |
| CPUPState | number | true | - | CPU的最高工作频率,取值在0到CPUPLimit之间。设置为0时,CPU最高频率为当前支持的最大值,设置为1,2,3时,CPU最高频率依次递减,功耗和性能也随之递减 说明:已屏蔽该属性值频繁变化导致的事件上报 |
| CPUTLimit | number | true | - | CPU空闲工作时间支持的范围,值为null时不支持设置CPU的空闲工作时间 |
| CPUTotalCores | number | true | - | 所有CPU的总核数 |
| CPUTState | number | true | - | CPU的空闲工作时间,取值在0到CPUTLimit之间。设置为0时,CPU工作时间占空比为当前支持的最大值,设置为1,2,3时,CPU工作时间占空比依次递减,功耗和性能也随之递减 |
| CryptoEraseSupported | boolean | true | - | 指定驱动器是否支持加密盘数据擦除 |
| DelaySecondsAfterCpuThermalTrip | number | true | - | CPU过温保护下电再上电间隔秒数 |
| DEMTEnabled | boolean | true | - | BIOS DEMT模式使能 说明:此属性为实时生效信息,与Bios资源内PowerSaving属性值可能不同。 |
| DeviceOwnerID | string | true | - | 设备ownerID |
| DeviceSlotID | string | true | - | 设备slotID |
| DisableKeyboardDuringBiosStartup | boolean | false | - | 禁止BIOS启动阶段通过热键进入BIOS Setup菜单 |
| DomainName | string | true | - | 域名称 |
| EnclosureSN | string | true | - | 机框序列号 |
| FruType | string | true | - | OS Base Fabric FC |
| HardDiskThresholdPercent | number | true | - | 磁盘使用率告警门限 |
| HealthLedState | string | true | - | 系统健康灯状态,包括 Off Lit Blinking |
| HostDescription | string | true | - | 计算机描述 |
| iBMADriver | string | true | - | iBMA驱动版本 |
| iBMARunningStatus | string | true | - | iBMA运行状态 |
| iBMAService | string | true | - | iBMA服务 |
| KernalVersion | string | true | - | 内核版本 |
| LeakDetectionSupport | boolean | true | - | 是否支持漏液检测 |
| MajorOSVersion | string | true | - | 操作系统主版本 |
| MajorPatchVersion | string | true | - | 操作系统补丁主版本 |
| MaximumNumberOfSessions | number | true | - | VNC最大会话数 |
| MinorOSVersion | string | true | - | 操作系统次版本 |
| MinorPatchVersion | string | true | - | 操作系统补丁次版本 |
| NetBandwidthThresholdPercent | number | true | - | 网络带宽占用率门限 |
| NumberOfActiveSessions | number | true | - | KVM当前会话数 |
| PanelPowerButtonEnabled | boolean | true | - | 面板电源按钮使能 |
| PartitionName | string | true | - | 分区名称 |
| PchModel | string | true | - | PCH型号 |
| PersistentUSBConnectionEnabled | boolean | false | - | 虚拟键盘、鼠标持续连接使能 |
| PostState | string | true | - | 指定系统资源的启动状态,包括:PowerOff:服务器未启动 InPost:服务器正在启动,尚未达到发现完成 InPostDiscoveryComplete:系统已达到发现完成。发现完成是PCIe设备扫描完成点 FinishedPost:服务器已启动已安装的操作系统 说明 openUBMC 25.12 LTS及以上版本支持 |
| PowerOnAfterCpuThermalTrip | boolean | true | - | CPU过温保护下电再上电策略开启状态 |
| PreviousPowerState | string | true | - | 上次电源状态,包括 On:上电 Off:下电 |
| ProductAlias | string | true | - | 产品名称别名,支持的字符串长度0-64 |
| ProductName | string | true | - | 产品名称,支持的字符串长度0-48 |
| ProductVersion | string | true | - | 产品版本,包括:V2:V2服务器 V3:V3服务器 V5:V5服务器 |
| ProtocolType | string | true | - | 可信模块的协议类型 |
| ProtocolVersion | string | true | - | 可信模块的协议版本 |
| SafePowerOffDefaultTimeoutSeconds | number | true | - | 默认安全下电超时时间 |
| SafePowerOffMaxTimeoutSeconds | number | true | - | 安全下电超时时间上限 |
| SafePowerOffMinTimeoutSeconds | number | true | - | 安全下电超时时间下限 |
| SelfTestResult | string | true | - | 可信模块的自检结果,通过自检为OK,未通过自检为Critical |
| SelOverWritePolicy | string | true | - | SEL的记录方式,包括:RotateAfterFull:循环记录 ClearAfterFull:线性记录 |
| SlotWidth | number | true | - | 位宽,只有OSCA前插板有值,包括:65537:半宽的值 16843009:全宽的值 50529027:双胞胎的值 |
| SmsEnabled | boolean | true | - | iBMA相关信息显示使能 |
| SSDMediaLifeLeftPercentThreshold | number | false | - | 对应主机下的SSD剩余磨损率告警门限 说明 openUBMC 25.12 LTS及以上版本支持; 可设置的范围为[1,50],默认值为5; 仅在单主机环境可设置 |
| StorageConfigReady | number | true | - | Raid卡带外可配置:1:是 0:否 |
| SystemMemoryBuffersGiB | number | true | - | 系统内存缓冲区大小(在服务器OS侧安装iBMA 2.0并完全启动后有效) 说明 已屏蔽该属性值频繁变化导致的事件上报 |
| SystemMemoryCachedGiB | number | true | - | 系统内存缓存区大小(在服务器OS侧安装iBMA 2.0并完全启动后有效) 说明 已屏蔽该属性值频繁变化导致的事件上报 |
| SystemMemoryFreeGiB | number | true | - | 系统剩余内存大小(在服务器OS侧安装iBMA2.0并完全启动后有效) 说明 已屏蔽该属性值频繁变化导致的事件上报 |
| SystemSerialNumber | string | true | - | 指定系统资源的设备序列号 |
| TeeosVersion | string | true | - | 安全OS版本号 说明 openUBMC 25.12 LTS及以上版本支持 |
| TotalCapacityGB | number | true | - | 分区总容量 |
| UsagePercent | number | true | - | 分区使用率 |
| UsedCapacityGB | number | true | - | 分区使用容量 |
| VolumeSupported | boolean | true | - | Raid控制器是否支持组逻辑盘 |
| WakeOnLANStatus | boolean | true | - | 网络唤醒功能是否开启 |
supported_methods
- GET
- PATCH
- POST
HTTP methods
GET
命令功能
查询指定系统资源信息
参数说明
| 参数 | 参数说明 | 取值 |
|---|---|---|
| device_ip | 登录设备的IP地址 | IPv4或IPv6地址 |
| system_id | 系统资源的ID | 针对机架服务器取值为1;针对高密服务器取值为BladeN;针对刀片服务器取值为BladeN或SwiN;针对X6800 V5等取值还可为Enc;针对设备U位取值为UN;针对机柜取值为Rack |
| auth_value | 执行该GET请求时,必须在"Headers"中携带"X-Auth-Token"值用于鉴权 | 可通过/redfish/v1/SessionService/Sessions创建会话时获得 |
使用实例
请求样例:
http
GET <https://device_ip/redfish/v1/Systems/1>请求头:
text
X-Auth-Token: 123456789***********************请求消息体:无
响应样例:
json
{
"@odata.context": "/redfish/v1/$metadata#ComputerSystem.ComputerSystem",
"@odata.id": "/redfish/v1/Systems/1",
"@odata.type": "#ComputerSystem.v1_23_0.ComputerSystem",
"Id": "1",
"Name": "Computer System",
"AssetTag": null,
"Manufacturer": "",
"Model": null,
"PowerMode": "BalancedPerformance",
"SerialNumber": null,
"UUID": "421C1E9E-1DD2-11B2-986D-0018AC640A29",
"SystemType": "Physical",
"HostName": null,
"PartNumber": null,
"HostingRole": [
"ApplicationServer"
],
"HostWatchdogTimer": {
"FunctionEnabled": true,
"TimeoutAction": "PowerDown"
},
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"Severity": "Informational"
}
},
"State": "Enabled"
},
"PowerState": "On",
"PowerRestorePolicy": "LastState",
"Boot": {
"BootSourceOverrideTarget": "None",
"BootSourceOverrideEnabled": "Disabled",
"BootSourceOverrideMode": "Legacy",
"BootSourceOverrideTarget@Redfish.AllowableValues": [
"None",
"Pxe",
"Floppy",
"Cd",
"Hdd",
"BiosSetup"
]
},
"TrustedModules": [
{
"FirmwareVersion": "v1.0",
"InterfaceType": "TPM1_2",
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"Severity": "Informational"
}
},
"state": "Absent"
}
}
],
"BiosVersion": "3.78",
"ProcessorSummary": {
"Count": 1,
"Model": "Central Processor",
"Status": {
"Oem": {
"Public": {
"Severity": "Informational"
}
},
"HealthRollup": "OK"
},
"Metrics": {
"@odata.id": "/redfish/v1/Systems/1/Processors/Metrics"
},
"Oem": {
"Public": {
"Presence": "Present"
}
},
"CoreCount": 32
},
"MemorySummary": {
"TotalSystemMemoryGiB": 8,
"Status": {
"Oem": {
"Public": {
"Severity": "Informational"
}
},
"HealthRollup": "OK"
},
"Oem": {
"Public": {
"MemoryCount": 8
}
},
"Metrics": {
"@odata.id": "/redfish/v1/Systems/1/Memory/Metrics"
}
},
"GraphicalConsole": {
"ConnectTypesSupported": [
"KVMIP"
],
"MaxConcurrentSessions": 2,
"Port": 2198,
"ServiceEnabled": true
},
"VirtualMediaConfig": {
"Port": 8208,
"ServiceEnabled": true
},
"Processors": {
"@odata.id": "/redfish/v1/Systems/1/Processors"
},
"Memory": {
"@odata.id": "/redfish/v1/Systems/1/Memory"
},
"EthernetInterfaces": {
"@odata.id": "/redfish/v1/Systems/1/EthernetInterfaces"
},
"Storage": {
"@odata.id": "/redfish/v1/Systems/1/Storages"
},
"NetworkInterfaces": {
"@odata.id": "/redfish/v1/Systems/1/NetworkInterfaces"
},
"LogServices": {
"@odata.id": "/redfish/v1/Systems/1/LogServices"
},
"PCIeDevices": [],
"PCIeFunctions": [],
"Bios": null,
"SecureBoot": {
"@odata.id": "/redfish/v1/Systems/1/SecureBoot"
},
"VirtualMedia": {
"@odata.id": "/redfish/v1/Systems/1/VirtualMedia"
},
"Links": {
"Chassis": [
{
"@odata.id": "/redfish/v1/Chassis/1"
}
],
"Managers": [
{
"@odata.id": "/redfish/v1/Managers/1"
}
],
"TrustedComponents": []
},
"Oem": {
"Public": {
"HealthSummary": {
"CriticalAlarmCount": 0,
"MajorAlarmCount": 0,
"MinorAlarmCount": 0
},
"ConfigurationModel": "2025V1",
"OSVersion": null,
"HostnameSyncEnabled": true,
"CPUUsagePercent": 0,
"MemoryUsagePercent": 0,
"LocalKvmEnabled": true,
"SafePowerOffTimeoutEnabled": true,
"SafePowerOffTimoutSeconds": 600,
"PowerOnStrategy": "TurnOn",
"LeakStrategy": "ManualPowerOff",
"PowerRestoreDelayMode": "DefaultDelay",
"PowerRestoreDelaySeconds": 0.0,
"EnergySavingEnabled": false
}
},
"Actions": {
"#ComputerSystem.Reset": {
"target": "/redfish/v1/Systems/1/Actions/ComputerSystem.Reset",
"@Redfish.ActionInfo": "/redfish/v1/Systems/1/ResetActionInfo"
},
"Oem": {
"Public": {
"#ComputerSystem.FruControl": {
"target": "/redfish/v1/Systems/1/Actions/Oem/Public/ComputerSystem.FruControl",
"@Redfish.ActionInfo": "/redfish/v1/Systems/1/FruControlActionInfo"
}
}
}
},
"LastResetTime": "2023-01-01T00:00:00+00:00"
}响应码:200
PATCH
修改指定系统资源属性
命令功能
修改指定系统资源属性
参数说明
参见 请求头参数说明
请求消息体
json
{
"UUID": uuid_value,
"HostName": hostname_value,
"AssetTag": tag,
"Boot": {
"BootSourceOverrideEnabled": state,
"BootSourceOverrideTarget": target,
"BootSourceOverrideMode": Legacy
},
"PowerMode": power_mode,
"PowerRestorePolicy": RestorePolicy,
"GraphicalConsole": {
"Port": 2198,
"ServiceEnabled": true
},
"VirtualMediaConfig": {
"Port": 8208,
"ServiceEnabled": true
},
"Oem": {
"Public": {
"ConfigurationModel": configuration_model,
"HostnameSyncEnabled": hostname_enabled,
"CPUThresholdPercent": number,
"MemoryThresholdPercent": number,
"LocalKvmEnabled": LocalKvmEnabled_value,
"SafePowerOffTimeoutEnabled": enabled_value,
"SafePowerOffTimoutSeconds": Seconds,
"PowerOnStrategy": Strategy,
"LeakStrategy": power_control,
"PowerRestoreDelayMode": Delay_mode,
"PowerRestoreDelaySeconds": Delay_seconds,
"EnergySavingEnabled": EnergySavingEnabled_value
}
}
}请求体参数说明
| 参数 | 参数说明 | 取值 |
|---|---|---|
| UUID | UUID | 格式满足正则表达式:^[0-9A-F]{8}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{12}$ |
| HostName | HostName | 字符串 |
| AssetTag | 自定义的资产标签 | null,或1~48个字节的字符串 |
| BootSourceOverrideEnabled | 系统启动参数的使能状态 | Disabled/Once/Continuous |
| BootSourceOverrideTarget | 系统的当前启动设备 | None/Pxe/Floppy/Cd/Hdd/BiosSetup |
| PowerRestorePolicy | 通电开机策略 | AlwayOn/LastState/AlwaysOff |
| PowerMode | 系统的节能模式 | MaximumPerformance/BalancedPerformance/PowerSaving/Static/OSControlled/OEM/EfficiencyFavorPower/EfficiencyFavorPerformance |
| ConfigurationModel | 配置型号 | 字符串 |
| HostnameSyncEnabled | iBMA上报Hostname同步BMC使能开关 | true/false |
| CPUThresholdPercent | CPU使用率的百分比值 | 数字0-100 |
| MemoryThresholdPercent | 内存使用率的百分比值 | 数字0-100 |
| SafePowerOffTimeoutEnabled | 下电时限使能开关 | 布尔 |
| SafePowerOffTimoutSeconds | 安全下电超时时间 | 数字 |
| PowerOnStrategy | 通电策略 | TurnOn/RestorePreviousState/StayOff |
| LeakStrategy | 液冷服务器漏液后电源控制策略 | ManualPowerOff/AutoPowerOff |
| PowerRestoreDelayMode | 上电延迟模式 | DefaultDelay/HalfDelay/FixedDelay/RandomDelay |
| PowerRestoreDelaySeconds | 延迟上电的时间(单位秒) | 数字,保留一位小数 |
| LocalKvmEnabled | 本地Kvm使能 | true/false |
| EnergySavingEnabled | 智能节能功能使能 | true/false |
使用实例
请求样例:
http
PATCH <https://device_ip/redfish/v1/Systems/1>请求头:
text
X-Auth-Token: 123456789***********************
Content-Type: application/json
If-Match: W/"3d607e36"请求消息体:
json
{
"AssetTag": "my test",
"PowerMode": "BalancedPerformance",
"GraphicalConsole": {
"Port": 2198,
"ServiceEnabled": true
},
"VirtualMediaConfig": {
"Port": 8208,
"ServiceEnabled": true
},
"Oem": {
"Public": {
"KVMSettings": {
"PersistentUSBConnectionEnabled": true,
"AutoOSLockEnabled": false,
"AutoOSLockType": "Windows",
"AutoOSLockKey": [
""
],
"DisableKeyboardDuringBiosStartup": true
},
"VncSettings": {
"DisableKeyboardDuringBiosStartup": true
},
"SSDMediaLifeLeftPercentThreshold": 5
}
}
}响应样例:
json
{
"@odata.context": "/redfish/v1/$metadata#ComputerSystem.ComputerSystem",
"@odata.id": "/redfish/v1/Systems/1",
"@odata.type": "#ComputerSystem.v1_2_0.ComputerSystem",
"Id": "1",
"Name": "Computer System",
"AssetTag": "my test",
"Manufacturer": "",
"Model": null,
"PowerMode": "BalancedPerformance",
"SerialNumber": null,
"UUID": "421C1E9E-1DD2-11B2-986D-0018AC640A29",
"HostName": null,
"PartNumber": null,
"HostingRole": [
"ApplicationServer"
],
"HostWatchdogTimer": {
"FunctionEnabled": true,
"TimeoutAction": "PowerDown"
},
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"Severity": "Informational"
}
},
"State": "Enabled"
},
"PowerState": "On",
"PowerRestorePolicy": "LastState",
"Boot": {
"BootSourceOverrideTarget": "None",
"BootSourceOverrideEnabled": "Disabled",
"BootSourceOverrideMode": "Legacy",
"BootSourceOverrideTarget@Redfish.AllowableValues": [
"None",
"Pxe",
"Floppy",
"Cd",
"Hdd",
"BiosSetup"
]
},
"Actions": {
"#ComputerSystem.Reset": {
"target": "/redfish/v1/Systems/1/Actions/ComputerSystem.Reset",
"@Redfish.ActionInfo": "/redfish/v1/Systems/1/ResetActionInfo"
},
"Oem": {
"Public": {
"#ComputerSystem.FruControl": {
"target": "/redfish/v1/Systems/1/Actions/Oem/Public/ComputerSystem.FruControl",
"@Redfish.ActionInfo": "/redfish/v1/Systems/1/FruControlActionInfo"
}
}
}
}
}响应码:200
POST (ACTION)
Reset
命令功能
重启服务器
说明
控制FRU上下电状态。
命令格式
URL: https://device_ip/redfish/v1/Systems/system_id/Actions/ComputerSystem.Reset
请求头:
text
X-Auth-Token: 123456789***********************
Content-Type: header_type请求消息体:
json
{
"ResetType": value
}请求头参数说明
参见 请求头参数说明
请求体参数说明
| 参数 | 参数说明 | 取值 |
|---|---|---|
| value | 上下电类型 | On/ForceOff/GracefulShutdown/ForceRestart/Nmi/ForcePowerCycle/PowerCycle |
使用指南
无
使用实例
请求样例:
http
POST <https://device_ip/redfish/v1/Systems/1/Actions/ComputerSystem.Reset>请求头:
text
X-Auth-Token: 123456789***********************
Content-Type: application/json请求消息体:
json
{
"ResetType": "On"
}响应样例:
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)
FruControl
命令功能
FRU 上下电控制
命令格式
URL: https://device_ip/redfish/v1/Systems/system_id/Actions/Oem/Public/ComputerSystem.FruControl
请求头:
text
X-Auth-Token: 123456789***********************
Content-Type: header_type请求消息体:
json
{
"FruControlType": controltype,
"FruID": fruid
}请求头参数说明
参见 请求头参数说明
请求体参数说明
| 参数 | 参数说明 | 取值 |
|---|---|---|
| controltype | FRU控制类型 | On/GracefulShutdown/ForceRestart/Nmi/ForcePowerCycle/PowerCycle |
| fruid | FRU ID | 0:OS平面 1:Base平面 2:Fabric平面 3:FC平面 4:全域平面 |
使用指南
无
使用实例
请求样例:
http
POST <https://device_ip/redfish/v1/Systems/1/Actions/Oem/Public/ComputerSystem.FruControl>请求头:
text
X-Auth-Token: 123456789***********************
Content-Type: application/json请求消息体:
json
{
"FruControlType": "On",
"FruID": 0
}响应样例:
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)
ClearNetworkHistoryUsageRate
命令功能
清空网口历史占用率资源信息
命令格式
请求头:
text
X-Auth-Token: 123456789***********************
Content-Type: header_type请求消息体:
json
{
"BWUWaveTitle": network_card
}请求头参数说明
参见 请求头参数说明
请求体参数说明
| 参数 | 参数说明 | 取值 |
|---|---|---|
| network_card | 网卡标识 | 可通过/redfish/v1/Systems/1/NetworkHistoryUsageRate查询获取 |
使用指南
无
使用实例
请求样例:
http
POST <https://device_ip/redfish/v1/Systems/1/Actions/Oem/Public/ComputerSystem.ClearNetworkHistoryUsageRate>请求头:
text
X-Auth-Token: 123456789***********************
Content-Type: application/json请求消息体:
json
{
"BWUWaveTitle": "chassisNIC1(SF221Q)"
}响应样例:
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