ServiceRoot
更新时间： 2026/06/26
在Gitcode上查看源码ResourceDefinition
uris
/redfish/redfish/v1
properties
| 名称 | 类型 | 是否只读 | 取值范围/枚举值 | 说明 |
|---|---|---|---|---|
| v1 | string | true | - | Redfish版本信息 |
| @odata.context | string | true | - | 根服务资源模型的OData描述信息 |
| @odata.id | string | true | - | 根服务资源节点的访问路径 |
| @odata.type | string | true | - | 根服务资源类型 |
| Id | string | true | - | 根服务资源的ID |
| Name | string | true | - | 根服务资源的名称 |
| RedfishVersion | string | true | - | Redfish的详细版本信息 |
| UUID | string | false | - | 设备的全局唯一标识符 |
| Systems | object | true | - | 系统资源 |
| Chassis | object | true | - | 机箱资源 |
| Managers | object | true | - | 管理资源 |
| Tasks | object | true | - | 任务服务资源 |
| SessionService | object | true | - | 会话服务资源 |
| AccountService | object | true | - | 账户服务资源 |
| EventService | object | true | - | 事件服务资源 |
| Links | object | true | - | 关联资源 |
| Links.Sessions | object | true | - | 会话集合资源 |
| UpdateService | object | true | - | 升级服务资源 |
| Registries | object | true | - | 消息归档资源 |
| JsonSchemas | object | true | - | 数组格式的模板资源 |
| JobService | object | true | - | 编排任务服务资源 |
| TelemetryService | object | true | - | 遥测服务资源 |
| ComponentIntegrity | object | true | - | 组件完整性报告集合资源 说明 BMC300 5.12.0.1及以上版本支持 |
| Fabrics | object | true | - | 拓扑编排资源 |
| ProtocolFeaturesSupported | object | true | - | 服务中的协议特性信息 |
| ProtocolFeaturesSupported.DeepOperations | object | true | - | 服务中的深度操作信息 |
| ProtocolFeaturesSupported.DeepOperations.DeepPATCH | boolean | true | - | 指示服务是否支持深度PATCH操作 |
| ProtocolFeaturesSupported.DeepOperations.DeepPOST | boolean | true | - | 指示服务是否支持深度POST操作 |
| ProtocolFeaturesSupported.DeepOperations.MaxLevels | number | true | - | 深度操作中所允许的最大资源深度 |
| ProtocolFeaturesSupported.ExpandQuery | object | true | - | 服务中使用 "$expand" 的信息 |
| ProtocolFeaturesSupported.ExpandQuery.ExpandAll | boolean | true | - | 指示服务是否支持查询参数 "$expand" 的 "*" 选项 |
| ProtocolFeaturesSupported.ExpandQuery.Levels | boolean | true | - | 指示服务是否支持查询参数 "$expand" 的 "$levels" 参数 |
| ProtocolFeaturesSupported.ExpandQuery.MaxLevels | number | true | - | 查询参数 "$expand" 中选项 "$levels" 的最大取值 |
| ProtocolFeaturesSupported.ExpandQuery.Links | boolean | true | - | 指示服务是否支持查询参数 "$expand" 的 "~" 选项 |
| ProtocolFeaturesSupported.ExpandQuery.NoLinks | boolean | true | - | 指示服务是否支持查询参数 "$expand" 的 "." 选项 |
| ProtocolFeaturesSupported.FilterQuery | boolean | true | - | 指示服务是否支持查询参数 "$filter" |
| ProtocolFeaturesSupported.FilterQueryComparisonOperations | boolean | true | - | 指示服务是否支持查询参数 "$filter" 的 "eq"、"ge"、"gt"、"le"、"lt" 和 "ne" 选项 |
| ProtocolFeaturesSupported.FilterQueryCompoundOperations | boolean | true | - | 指示服务是否支持查询参数 "$filter" 的 "()"、"and"、"not" 和 "or" 选项 |
| ProtocolFeaturesSupported.SelectQuery | boolean | true | - | 指示服务是否支持查询参数 "$select" |
| ProtocolFeaturesSupported.OnlyMemberQuery | boolean | true | - | 指示服务是否支持查询参数 "only" |
| ProtocolFeaturesSupported.ExcerptQuery | boolean | true | - | 指示服务是否支持摘录查询参数 "excerpt" |
| ProtocolFeaturesSupported.TopSkipQuery | boolean | true | - | 指示服务是否同时支持查询参数 "$top"和"$skip" |
| Vendor | string | true | - | 厂商名称 说明 iBMC300 5.12.0.1及以上版本支持 |
| Product | string | true | - | 产品名称 说明 iBMC300 5.12.0.1及以上版本支持 |
| Oem | object | true | - | 自定义属性 |
| Oem.Public | object | true | - | 自定义属性 |
| Oem.Public.SmsUpdateService | object | true | - | 系统管理软件升级资源 |
| Oem.Public.SmsUpdateService.@odata.id | string | true | - | 各扩展资源的访问路径 |
| Oem.Public.DataAcquisitionService | object | true | - | 数据采集服务资源 |
| Oem.Public.SystemOverview | object | true | - | 系统概览信息资源 |
| Oem.Public.PerformanceCollection | object | true | - | 性能数据采集服务资源 |
| Oem.Public.AssetService | object | true | - | 资源服务资源 |
| Oem.Public.AssetService.@odata.id | string | true | - | 各扩展资源的访问路径 |
| Oem.Public.LCNService | object | true | - | LCNService资源 说明 BMC300 5.8.3.27及以上版本，A900 A3 SuperPoD，A800T A3，A800I A3机型支持 |
| Oem.Public.LCNService.@odata.id | string | true | - | LCNService资源的访问路径 |
| Oem.Public.ObservabilityService | object | true | - | ObservabilityService资源 说明 BMC300 5.10.0.1及以上版本，当前只针对BMC系统提供可观测服务能力 |
| Oem.Public.ObservabilityService.@odata.id | string | true | - | ObservabilityService资源的访问路径 |
| Oem.Public.SecurityBanner | string | true | - | 安全公告 |
| Oem.Public.ProductName | string | true | - | 产品名称 |
| Oem.Public.ProductSerialNumber | string | true | - | 产品序列号 |
| Oem.Public.HostName | string | true | - | 主机名称 |
| Oem.Public.LanguageSet | string | true | - | 语言支持信息 |
| Oem.Public.Copyright | string | true | - | 版权信息 |
| Oem.Public.DownloadKVMLink | string | true | - | Java独立远程控制台下载链接 |
| Oem.Public.DocSupportFlag | boolean | true | - | 产品文档二维码显示使能 |
| Oem.Public.DomainName | array | true | - | LDAP域名与Kerberos域名 说明 LDAP服务端为O Base Tree时，DomainName为组织名 |
| Oem.Public.ProductPicture | string | true | - | 产品图片名称 |
| Oem.Public.AccountLockoutDuration | number | true | - | 用户登录失败后被锁定的锁定时长，单位为秒 |
| Oem.Public.ChassisHeightU | string | true | - | - |
| Oem.Public.FQDN | string | true | - | 全称域名 |
| Oem.Public.SmsName | string | true | - | 系统管理软件名称 |
| Oem.Public.SoftwareName | string | true | - | 软件名称 |
| Oem.Public.MajorVersion | string | true | - | 软件主版本号 |
| Oem.Public.StartupDurationSeconds | number | true | - | BMC启动规格时间 |
| Oem.Public.StartupState | string | true | - | BMC启动状态 |
supported_methods
- GET
- PATCH
HTTP methods
GET
命令功能
查询 Redfish 版本信息
命令格式
URL: https://device_ip/redfish
请求头:
X-Auth-Token: 123456789***********************请求消息体: 无
参数说明
| 参数 | 参数说明 | 取值 |
|---|---|---|
| device_ip | 登录设备的IP地址 | IPv4或IPv6地址 |
使用指南
无
使用实例
请求样例：
http
GET https://device_ip/redfish请求头：无
请求消息体：无
响应样例：
json
{
"v1": "/redfish/v1/"
}响应码：200
GET
命令功能
查询当前根服务资源
命令格式
URL: https://device_ip/redfish/v1
请求头:
X-Auth-Token: 123456789***********************请求消息体: 无
参数说明
| 参数 | 参数说明 | 取值 |
|---|---|---|
| device_ip | 登录设备的IP地址 | IPv4或IPv6地址 |
使用指南
无
使用实例
请求样例：
http
GET https://device_ip/redfish/v1请求头：无
请求消息体：无
响应样例：
json
{
"@odata.context": "/redfish/v1/$metadata#ServiceRoot",
"@odata.id": "/redfish/v1/",
"@odata.type": "#ServiceRoot.v1_17_0.ServiceRoot",
"Id": "RootService",
"Name": "Root Service",
"RedfishVersion": "1.20.1",
"UUID": "2BFF4014-1DD2-11B2-818C-0018E1C5D866",
"Systems": {
"@odata.id": "/redfish/v1/Systems"
},
"Chassis": {
"@odata.id": "/redfish/v1/Chassis"
},
"Managers": {
"@odata.id": "/redfish/v1/Managers"
},
"Tasks": {
"@odata.id": "/redfish/v1/TaskService"
},
"SessionService": {
"@odata.id": "/redfish/v1/SessionService"
},
"AccountService": {
"@odata.id": "/redfish/v1/AccountService"
},
"EventService": {
"@odata.id": "/redfish/v1/EventService"
},
"Links": {
"Sessions": {
"@odata.id": "/redfish/v1/SessionService/Sessions"
}
},
"UpdateService": {
"@odata.id": "/redfish/v1/UpdateService"
},
"Registries": {
"@odata.id": "/redfish/v1/Registries"
},
"JsonSchemas": {
"@odata.id": "/redfish/v1/JSONSchemas"
},
"JobService": {
"@odata.id": "/redfish/v1/JobService"
},
"Fabrics": {
"@odata.id": "/redfish/v1/Fabrics"
},
"TelemetryService": {
"@odata.id": "/redfish/v1/TelemetryService"
},
"ComponentIntegrity": {
"@odata.id": "/redfish/v1/ComponentIntegrity"
},
"Vendor": "",
"Product": "",
"Oem": {
"Public": {
"SmsUpdateService": [
{
"@odata.id": "/redfish/v1/Sms/1/UpdateService"
}
],
"SystemOverview": {
"@odata.id": "/redfish/v1/SystemOverview"
},
"PerformanceCollection": {
"@odata.id": "/redfish/v1/PerformanceCollection"
},
"AssetService": {
"@odata.id": "/redfish/v1/Oem/Public/AssetService"
},
"LCNService": {
"@odata.id": "/redfish/v1/Oem/Public/LCNService"
},
"ObservabilityService": {
"@odata.id": "/redfish/v1/Oem/Public/ObservabilityService"
},
"SecurityBanner": "WARNING! This system is PRIVATE and PROPRIETARY and may only be accessed by authorized users. Unauthorized use of the system is prohibited. The owner, or its agents, may monitor any activity or communication on the system. The owner, or its agents, may retrieve any information stored within the system. By accessing and using the system, you are consenting to such monitoring and information retrieval for law enforcement and other purposes.",
"ProductName": "RH1288 V3",
"ProductSerialNumber": "2M220100SL",
"HostName": "BMC",
"LanguageSet": "en,zh,fr,ja",
"Copyright": "",
"DownloadKVMLink": " ",
"DocSupportFlag": true,
"DomainName": [
"",
"",
"",
"",
"",
""
],
"ProductPicture": "img_01",
"AccountLockoutDuration": 300,
"ChassisHeightU": null,
"FQDN": "BMC",
"SmsName": "iBMA",
"SoftwareName": "iBMC",
"MajorVersion": "5",
"StartupDurationSeconds": 160,
"StartupState": "Completed"
}
}
}响应码：200
PATCH
命令功能
修改当前根服务资源
命令格式
URL：https://device_ip/redfish/v1
请求头:
X-Auth-Token: 123456789***********************
Content-Type: header_type
If-Match: ifmatch_value请求消息体:
json
{
"UUID": uuid_value
}请求头参数说明
参见 请求头参数说明
请求体参数说明
| 参数 | 参数说明 | 取值 |
|---|---|---|
| ifmatch_value | 请求消息的匹配参数 | 可通过对相应资源发起GET操作，从响应头中获取（对应于"ETag"参数） |
| uuid_value | UUID值 | ● 格式满足正则表达式：^[0-9A-F]{8}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{12}$ ● 00000000-0000-0000-0000-000000000000代表恢复UUID为默认值 ● 单板AC掉电后自动恢复为默认值 |
使用指南
无
使用实例
请求样例：
http
PATCH https://device_ip/redfish/v1请求头：
X-Auth-Token: 123456789***********************
Content-Type: application/json
If-Match: W/"3d607e36"请求消息体：
json
{
"UUID": "11111111-1111-1111-1111-111111111111"
}响应样例：
json
{
"@odata.context": "/redfish/v1/$metadata#ServiceRoot",
"@odata.id": "/redfish/v1/",
"@odata.type": "#ServiceRoot.v1_17_0.ServiceRoot",
"Id": "RootService",
"Name": "Root Service",
"RedfishVersion": "1.20.1",
"UUID": "11111111-1111-1111-1111-111111111111",
"Systems": {
"@odata.id": "/redfish/v1/Systems"
},
"Chassis": {
"@odata.id": "/redfish/v1/Chassis"
},
"Managers": {
"@odata.id": "/redfish/v1/Managers"
},
"Tasks": {
"@odata.id": "/redfish/v1/TaskService"
},
"SessionService": {
"@odata.id": "/redfish/v1/SessionService"
},
"AccountService": {
"@odata.id": "/redfish/v1/AccountService"
},
"EventService": {
"@odata.id": "/redfish/v1/EventService"
},
"Links": {
"Sessions": {
"@odata.id": "/redfish/v1/SessionService/Sessions"
}
},
"UpdateService": {
"@odata.id": "/redfish/v1/UpdateService"
},
"Registries": {
"@odata.id": "/redfish/v1/Registries"
},
"JsonSchemas": {
"@odata.id": "/redfish/v1/JSONSchemas"
},
"JobService": {
"@odata.id": "/redfish/v1/JobService"
},
"Fabrics": {
"@odata.id": "/redfish/v1/Fabrics"
},
"Vendor": "",
"Product": "",
"Oem": {
"Public": {
"SystemOverview": {
"@odata.id": "/redfish/v1/SystemOverview"
},
"PerformanceCollection": {
"@odata.id": "/redfish/v1/PerformanceCollection"
},
"ObservabilityService": {
"@odata.id": "/redfish/v1/Oem/Public/ObservabilityService"
},
"SecurityBanner": "WARNING! This system is PRIVATE and PROPRIETARY and may only be accessed by authorized users. Unauthorized use of the system is prohibited. The owner, or its agents, may monitor any activity or communication on the system. The owner, or its agents, may retrieve any information stored within the system. By accessing and using the system, you are consenting to such monitoring and information retrieval for law enforcement and other purposes.",
"ProductName": "RH1288 V3",
"ProductSerialNumber": "2M220100SL",
"HostName": "BMC",
"LanguageSet": "en,zh,fr,ja",
"Copyright": "",
"DownloadKVMLink": " ",
"DocSupportFlag": true,
"DomainName": [
"",
"",
"",
"",
"",
""
],
"ProductPicture": "img_01",
"AccountLockoutDuration": 300,
"KerberosEnabled": false,
"FQDN": "BMC",
"Smsname"："iBMA",
"SoftwareName": "BMC"
}
}
}响应码：200