OM SDK提供标准的RESTful接口供开发者进行查看或者调用;支持开发者进行硬件基础管理功能的二次开发或集成。
Redfish是一种基于HTTPS服务的管理标准,利用RESTful接口实现设备管理。每个HTTPS操作都以UTF-8编码的JSON的形式,提交或返回一个资源。就像Web应用程序向浏览器返回HTML一样,RESTful接口会通过同样的传输机制(HTTPS),以JSON的形式向客户端返回数据。
资源操作[object Object][object Object]
表 1 Redfish接口支持的操作
返回状态码[object Object][object Object]
表 2 状态码说明
URL参数[object Object][object Object]
调用接口时,需要输入具体接口的URL。URL都需要传入以下参数,其他的URL参数请参见每个接口的URL参数说明。
表 3 URL参数
请求头参数[object Object][object Object]
本文档涉及到的请求头参数说明如下。
表 4 请求头
[object Object]
命令功能[object Object][object Object]
查询当前使用的Redfish协议的版本号。
命令格式[object Object][object Object]
操作类型:GET
URL:https://device_ip/redfish
请求头:
请求消息体:无
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:无
响应样例:
响应码:200
输出说明[object Object][object Object]
表 1 操作输出说明
命令功能[object Object][object Object]
查询服务器当前根服务资源。
命令格式[object Object][object Object]
操作类型:GET
URL:https://device_ip/redfish/v1
请求头:
请求消息体:无
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:无
响应样例:
响应码:200
输出说明[object Object][object Object]
表 1 操作输出说明
命令功能[object Object][object Object]
查询Redfish规范里的元数据文档。
命令格式[object Object][object Object]
操作类型:GET
URL:https://device_ip/redfish/v1/$metadata
请求头:
请求消息体:无
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:无
响应样例:
响应码:200
命令功能[object Object][object Object]
查询服务器当前所有资源的Schema文件。
命令格式[object Object][object Object]
操作类型:GET
URL:https://device_ip/redfish/v1/JSONSchemas
请求头:
请求消息体:无
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:无
响应样例:
响应码:200
输出说明[object Object][object Object]
表 1 操作输出说明
命令功能[object Object][object Object]
查询服务器当前的单个Schema文件归档地址。
命令格式[object Object][object Object]
操作类型:GET
URL:https://device_ip**/redfish/v1/JSONSchemas/_<member_id_**>
请求头:
请求消息体:无
URL参数[object Object][object Object]
表 1 URL参数
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:无
响应样例:
响应码:200
输出说明[object Object][object Object]
表 2 操作输出说明
命令功能[object Object][object Object]
查询OData服务文档。
命令格式[object Object][object Object]
操作类型:GET
URL:https://device_ip/redfish/v1/odata
请求头:
请求消息体:无
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:无
响应样例:
响应码:200
输出说明[object Object][object Object]
表 1 操作输出说明
命令功能[object Object][object Object]
查询外部设备集合资源的信息。
命令格式[object Object][object Object]
操作类型:GET
URL:https://device_ip/redfish/v1/Systems/ExtendedDevices
请求头:
请求消息体:无
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:无
响应样例:
响应码:200
输出说明[object Object][object Object]
表 1 操作输出说明
命令功能[object Object][object Object]
查询外部设备资源的信息。
命令格式[object Object][object Object]
操作类型:GET
URL:https://device_ip/redfish/v1/Systems/ExtendedDevices/<extend_id>
请求头:
请求消息体:无
URL参数[object Object][object Object]
表 1 URL参数
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:无
响应样例:
响应码:200
输出说明[object Object][object Object]
表 2 操作输出说明
命令功能[object Object][object Object]
查询外部设备模组资源集合。当前OM SDK支持自定义模组扩展,具体接口扩展功能可参照模组扩展章节开发。
命令格式[object Object][object Object]
操作类型:GET
URL:https://device_ip/redfish/v1/Systems/Modules
请求头:
请求消息体:无
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:无
响应样例:
响应码:200
输出说明[object Object][object Object]
表 1 操作输出说明
命令功能[object Object][object Object]
查询外部设备模组信息。当前OM SDK支持自定义模组扩展,具体接口扩展功能可参照模组扩展章节开发。
命令格式[object Object][object Object]
操作类型:GET
URL:https://device_ip/redfish/v1/Systems/Modules/<module_id>
请求头:
请求消息体:无
URL参数[object Object][object Object]
表 1 URL参数
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:无
响应样例(当前OM SDK无可访问外设模组,当前只会返回以下错误):
响应码:404
输出说明[object Object][object Object]
表 2 操作输出说明
命令功能[object Object][object Object]
查询外部设备信息。当前OM SDK支持自定义模组扩展,具体接口扩展功能可参照模组扩展章节开发。
命令格式[object Object][object Object]
操作类型:GET
URL:https://device_ip/redfish/v1/Systems/Modules/<module_id>/<device_id>
请求头:
请求消息体:无
URL参数[object Object][object Object]
表 1 URL参数
[object Object][object Object]
[object Object]使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:无
响应样例(当前OM SDK无可访问外设设备,当前只会返回以下错误):
响应码:404
输出说明[object Object][object Object]
表 2 操作输出说明
命令功能[object Object][object Object]
修改外部设备信息。当前OM SDK支持自定义模组扩展,具体接口扩展功能可参照模组扩展章节开发。
命令格式[object Object][object Object]
操作类型:PATCH
URL:https://device_ip/redfish/v1/Systems/Modules/<module_id>/<device_id>
请求头:
请求消息体:
URL参数[object Object][object Object]
表 1 URL参数
请求参数[object Object][object Object]
表 2 请求参数
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:无
响应样例(当前OM SDK无可访问外设设备,当前只会返回以下错误):
响应码:404
输出说明[object Object][object Object]
表 3 操作输出说明
命令功能[object Object][object Object]
查询固件升级资源集合。
命令格式[object Object][object Object]
操作类型:GET
URL:https://device_ip/redfish/v1/UpdateService
请求头:
请求消息体:无
使用指南[object Object][object Object]
无
使用说明[object Object][object Object]
请求样例:
请求头:
请求消息体:无
响应样例:
响应码:200
输出说明[object Object][object Object]
表 1 操作输出说明
命令功能[object Object][object Object]
升级固件。
命令格式[object Object][object Object]
操作类型:POST
URL:https://device_ip/redfish/v1/UpdateService/Actions/UpdateService.SimpleUpdate
请求头:
请求消息体:
请求参数[object Object][object Object]
表 1 请求参数
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:
响应样例:
响应码:202
输出说明[object Object][object Object]
表 2 操作输出说明
命令功能[object Object][object Object]
查询固件升级状态信息。
命令格式[object Object][object Object]
操作类型:GET
URL:https://device_ip/redfish/v1/UpdateService/Actions/UpdateService.SimpleUpdate
请求头:
请求消息体:无
使用指南[object Object][object Object]
无
使用说明[object Object][object Object]
请求样例:
请求头:
请求消息体:无
响应样例:
响应码:200
输出说明[object Object][object Object]
表 1 操作输出说明
命令功能[object Object][object Object]
通过接口进行文件上传,上传成功后文件被统一放在“/run/web”目录下。
- zip文件放在“/run/web/zip”目录下。
- crl,cer,crt文件放在“/run/web/cert”目录下。
- conf文件放在“/run/web/conf”目录下。
- ini文件放在“/run/web/ini”目录下。
命令格式[object Object][object Object]
操作类型:POST
URL:https://device_ip/redfish/v1/UpdateService/FirmwareInventory
请求头:
请求消息体:
请求消息[object Object][object Object]
表 1 请求参数
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:
响应样例:
响应码:202
输出说明[object Object][object Object]
表 2 操作输出说明
命令功能[object Object][object Object]
查询当前日志服务集合资源信息。
命令格式[object Object][object Object]
操作类型:GET
URL:https://device_ip/redfish/v1/Systems/LogServices
请求头:
请求消息体:无
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:无
响应样例:
响应码:200
输出说明[object Object][object Object]
表 1 操作输出说明
命令功能[object Object][object Object]
下载日志信息。
命令格式[object Object][object Object]
操作类型:POST
URL:https://device_ip/redfish/v1/Systems/LogServices/Actions/download
请求头:
请求消息体:
请求参数[object Object][object Object]
表 1 参数说明
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:
响应样例:无(直接导出文件)
响应码:200
输出说明[object Object][object Object]
直接下载文件。
命令功能[object Object][object Object]
查询日志下载进度信息。
命令格式[object Object][object Object]
操作类型:GET
URL:https://device_ip/redfish/v1/Systems/LogServices/progress
请求头:
请求消息体:无
使用指南[object Object][object Object]
无
使用说明[object Object][object Object]
请求样例:
请求头:
请求消息体:无
响应样例:
响应码:200
输出说明[object Object][object Object]
表 1 操作输出说明
命令功能[object Object][object Object]
将已升级的固件文件生效。
命令格式[object Object][object Object]
操作类型:POST
URL:https://device_ip/redfish/v1/UpdateService/Actions/UpdateService.Reset
请求头:
请求消息体:
请求参数[object Object][object Object]
表 1 请求参数
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:
响应样例:
响应码:200
输出说明[object Object][object Object]
表 2 操作输出说明
命令功能[object Object][object Object]
远程恢复出厂设置。
命令格式[object Object][object Object]
操作类型:POST
URL:https://device_ip/redfish/v1/Systems/Actions/RestoreDefaults.Reset
请求头:
请求消息体:
请求参数[object Object][object Object]
表 1 参数说明
使用指南[object Object][object Object]
接口已默认开放,但功能暂未完全实现,需要开发者适配恢复出厂设置命令。
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:
响应样例:
响应码:200
输出说明[object Object][object Object]
表 2 操作输出说明
命令功能[object Object][object Object]
查询当前系统时间。
命令格式[object Object][object Object]
操作类型:GET
URL:https://device_ip/redfish/v1/Systems/SystemTime
请求头:
请求消息体:无
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:无
响应样例:
响应码:200
输出说明[object Object][object Object]
表 1 操作输出说明
命令功能[object Object][object Object]
查询无线网络顶层资源信息。
命令格式[object Object][object Object]
操作类型:GET
URL:https://device_ip/redfish/v1/Systems/LTE
请求头:
请求消息体:无
使用指南[object Object][object Object]
接口已默认开发,功能根据无线网卡适配。
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:无
响应样例:
响应码:200
输出说明[object Object][object Object]
表 1 操作输出说明
命令功能[object Object][object Object]
查询无线网络接口资源信息。
命令格式[object Object][object Object]
操作类型:GET
URL:https://device_ip/redfish/v1/Systems/LTE/StatusInfo
请求头:
请求消息体:无
使用指南[object Object][object Object]
接口已默认开发,功能根据无线网卡适配。
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:无
响应样例:
响应码:200
输出说明[object Object][object Object]
表 1 操作输出说明
命令功能[object Object][object Object]
配置无线网络接口资源信息。
命令格式[object Object][object Object]
操作类型:PATCH
URL:https://device_ip/redfish/v1/Systems/LTE/StatusInfo
请求头:
请求消息体:
请求参数[object Object][object Object]
表 1 请求参数
使用指南[object Object][object Object]
接口已默认开发,功能根据无线网卡适配。
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:
响应样例:
响应码:200
输出说明[object Object][object Object]
表 2 操作输出说明
命令功能[object Object][object Object]
查询无线网络APN接口资源信息。
命令格式[object Object][object Object]
操作类型:GET
URL:https://device_ip/redfish/v1/Systems/LTE/ConfigInfo
请求头:
请求消息体:无
使用指南[object Object][object Object]
接口已默认开发,功能根据无线网卡适配。
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:无
响应样例:
响应码:200
输出说明[object Object][object Object]
表 1 操作输出说明
命令功能[object Object][object Object]
配置无线网络APN接口资源信息。
命令格式[object Object][object Object]
操作类型:PATCH
URL:https://device_ip/redfish/v1/Systems/LTE/ConfigInfo
请求头:
请求消息体:
请求参数[object Object][object Object]
表 1 请求参数
使用指南[object Object][object Object]
接口已默认开发,功能根据无线网卡适配。
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:
响应样例:
响应码:202
输出说明[object Object][object Object]
表 2 操作输出说明
命令功能[object Object][object Object]
查询以太网集合资源的信息。
命令格式[object Object][object Object]
操作类型:GET
URL:https://device_ip/redfish/v1/Systems/EthernetInterfaces
请求头:
请求消息体:无
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:无
响应样例:
响应码:200
输出说明[object Object][object Object]
表 1 操作输出说明
命令功能[object Object][object Object]
查询指定主机以太网接口资源的信息。
命令格式[object Object][object Object]
操作类型:GET
URL:https://device_ip/redfish/v1/Systems/EthernetInterfaces/_<eth_Id_>
请求头:
请求消息体:无
URL参数[object Object][object Object]
表 1 URL参数
使用指南[object Object][object Object]
为保障边缘管理系统的正常使用,避免出现卡顿或者上传、下载任务过慢的问题,网络带宽必须满足基本要求,推荐值如下:
- 边缘管理系统所在边缘设备与Web客户端之间的带宽 ≥ 20Mbit/s
- 其他网络要求:时延 < 30ms,丢包率 < 3%
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:无
响应样例:
响应码:200
输出说明[object Object][object Object]
表 2 操作输出说明
命令功能[object Object][object Object]
配置以太网接口,目前只支持IPv4的修改,同一网口的IP列表个数最多为4个。
命令格式[object Object][object Object]
操作类型:PATCH
URL:https://device_ip/redfish/v1/Systems/EthernetInterfaces/_<eth_Id_>
请求头:
请求消息体:
URL参数[object Object][object Object]
表 1 URL参数
请求参数[object Object][object Object]
表 2 请求参数
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:
响应样例:
响应码:202
输出说明[object Object][object Object]
表 3 操作输出说明
命令功能[object Object][object Object]
获取用户配置的网口设备名称与IP对应关系列表。
命令格式[object Object][object Object]
操作类型:GET
URL:https://device_ip/redfish/v1/Systems/EthIpList
请求头:
请求消息体:无
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:无
响应样例:
响应码:200
输出说明[object Object][object Object]
表 1 操作输出说明
命令功能[object Object][object Object]
查询网管资源信息。
命令格式[object Object][object Object]
操作类型:GET
URL:https://device_ip/redfish/v1/NetManager
请求头:
请求消息体:无
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:无
响应样例:
网管模式为Web模式
[object Object]网管模式为FusionDirector模式
[object Object]
输出说明[object Object][object Object]
表 1 操作输出说明
命令功能[object Object][object Object]
查询网管节点ID。
命令格式[object Object][object Object]
操作类型:GET
URL:https://device_ip/redfish/v1/NetManager/NodeID
请求头:
请求消息体:无
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:无
响应样例:
输出说明[object Object][object Object]
表 1 操作输出说明
命令功能[object Object][object Object]
上传FusionDirector根证书。
命令格式[object Object][object Object]
操作类型:POST
URL:https://device_ip/redfish/v1/NetManager/ImportFdCert
请求头:
请求消息体:
请求参数[object Object][object Object]
表 1 参数说明
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:
响应样例:
输出说明[object Object][object Object]
表 2 操作输出说明
命令功能[object Object][object Object]
上传FusionDirector吊销列表。
命令格式[object Object][object Object]
操作类型:POST
URL:https://device_ip/redfish/v1/NetManager/ImportFdCrl
请求头:
请求消息体:
请求参数[object Object][object Object]
表 1 参数说明
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:
响应样例:
输出说明
表 2 操作输出说明
命令功能[object Object][object Object]
查询FusionDirector纳管根证书信息。
命令格式[object Object][object Object]
操作类型:GET
URL:https://device_ip/redfish/v1/NetManager/QueryFdCert
请求头:
请求消息体:无
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
响应样例:
输出说明[object Object][object Object]
表 1 操作输出说明
命令功能[object Object][object Object]
配置网管资源信息。
[object Object]
命令格式[object Object][object Object]
操作类型:POST
URL:https://device_ip/redfish/v1/NetManager
请求头:
请求消息体:
请求参数[object Object][object Object]
表 1 请求参数
使用指南[object Object][object Object]
用户使用端口号时,如果曾多次配置端口号,以最近一次配置的端口号为准。
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:
配置成Web模式:
[object Object]配置成FusionDirector模式:
[object Object]
响应样例:
网管模式为Web模式
[object Object]网管模式为FusionDirector模式
[object Object]
响应码:200
输出说明[object Object][object Object]
表 2 操作输出说明
命令功能[object Object][object Object]
查询当前存储集合资源信息。
命令格式[object Object][object Object]
操作类型:GET
URL:https://device_ip/redfish/v1/Systems/SimpleStorages
请求头:
请求消息体:无
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:无
响应样例:
响应码:200
输出说明[object Object][object Object]
表 1 操作输出说明
命令功能[object Object][object Object]
查询指定存储资源信息。
命令格式[object Object][object Object]
操作类型:GET
URL:https://device_ip/redfish/v1/Systems/SimpleStorages/_<storage_id_>
请求头:
请求消息体:无
URL参数[object Object][object Object]
表 1 URL参数
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:无
响应样例:
响应码:200
输出说明[object Object][object Object]
表 2 操作输出说明
命令功能[object Object][object Object]
查询当前磁盘分区集合资源信息。
命令格式[object Object][object Object]
操作类型:GET
URL:https://device_ip/redfish/v1/Systems/Partitions
请求头:
请求消息体:无
使用指南[object Object][object Object]
接口已默认开发,功能根据外置存储配置适配。
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:无
响应样例:
响应码:200
输出说明[object Object][object Object]
表 1 操作输出说明
命令功能[object Object][object Object]
查询指定磁盘分区资源信息。
命令格式[object Object][object Object]
操作类型:GET
URL:https://device_ip/redfish/v1/Systems/Partitions/_<partition_id_>
请求头:
请求消息体:无
URL参数[object Object][object Object]
表 1 URL参数
使用指南[object Object][object Object]
接口已默认开发,功能根据外置存储配置适配
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:无
响应样例:
响应码:200
输出说明[object Object][object Object]
表 2 操作输出说明
命令功能[object Object][object Object]
创建磁盘分区。
命令格式[object Object][object Object]
操作类型:POST
URL:https://device_ip/redfish/v1/Systems/Partitions
请求头:
请求消息体:
请求参数[object Object][object Object]
表 1 请求参数
使用指南[object Object][object Object]
接口已默认开发,功能根据外置存储配置适配。
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:
响应样例:
响应码:202
输出说明[object Object][object Object]
表 2 操作输出说明
命令功能[object Object][object Object]
删除指定的逻辑盘。
命令格式[object Object][object Object]
操作类型:DELETE
URL:https://device_ip/redfish/v1/Systems/Partitions/_<partition_id_>
请求头:
请求消息体:无
URL参数[object Object][object Object]
表 1 URL参数
使用指南[object Object][object Object]
接口已默认开发,功能根据外置存储配置适配。
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:无
响应样例:
响应码:202
输出说明[object Object][object Object]
表 2 操作输出说明
命令功能[object Object][object Object]
挂载磁盘分区到指定目录。
命令格式[object Object][object Object]
操作类型:PATCH
URL:https://device_ip/redfish/v1/Systems/Partitions/Mount
请求头:
请求消息体:
请求参数[object Object][object Object]
表 1 请求参数
使用指南[object Object][object Object]
接口已默认开发,功能根据外置存储配置适配。
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:
响应样例:
响应码:202
输出说明[object Object][object Object]
表 2 操作输出说明
命令功能[object Object][object Object]
解挂磁盘分区。
命令格式[object Object][object Object]
操作类型:PATCH
URL:https://device_ip/redfish/v1/Systems/Partitions/Unmount
请求头:
请求消息体:
请求参数[object Object][object Object]
表 1 请求参数
使用指南[object Object][object Object]
接口已默认开发,功能根据外置存储配置适配。
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:
响应样例:
响应码:202
表 2 操作输出说明
命令功能[object Object][object Object]
查询当前已配置的NFS分区信息。
命令格式[object Object][object Object]
操作类型:GET
URL:https://device_ip/redfish/v1/Systems/NfsManage
请求头:
请求消息体:无
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:无
响应样例:
响应码:200
输出说明[object Object][object Object]
表 1 操作输出说明
命令功能[object Object][object Object]
挂载NFS分区到指定目录,且NFS挂载最大目录个数为32。
命令格式[object Object][object Object]
操作类型:POST
URL:https://device_ip/redfish/v1/Systems/NfsManage/Actions/NfsManage.Mount
请求头:
请求消息体:
请求参数[object Object][object Object]
表 1 请求参数
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:
响应样例:
响应码:200
输出说明[object Object][object Object]
表 2 操作输出说明
命令功能[object Object][object Object]
解除挂载NFS分区。
命令格式[object Object][object Object]
操作类型:POST
URL:https://device_ip/redfish/v1/Systems/NfsManage/Actions/NfsManage.Unmount
请求头:
请求消息体:
请求参数[object Object][object Object]
表 1 请求参数
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:
响应样例:
响应码:200
输出说明[object Object][object Object]
表 2 操作输出说明
命令功能[object Object][object Object]
查询用户资源的集合信息。
命令格式[object Object][object Object]
操作类型:GET
URL:https://device_ip/redfish/v1/AccountService/Accounts
请求头:
请求消息体:无
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:无
响应样例:
响应码:200
输出说明[object Object][object Object]
表 1 操作输出说明
命令功能[object Object][object Object]
查询用户服务的信息。
命令格式[object Object][object Object]
操作类型:GET
URL:https://device_ip/redfish/v1/AccountService
请求头:
请求消息体:无
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:无
响应样例:
响应码:200
输出说明[object Object][object Object]
表 1 操作输出说明
命令功能[object Object][object Object]
修改用户服务信息。
命令格式[object Object][object Object]
操作类型:PATCH
URL:https://device_ip/redfish/v1/AccountService
请求头:
请求消息体:
请求参数[object Object][object Object]
表 1 请求参数
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:
响应样例:
响应码:200
输出说明[object Object][object Object]
表 2 操作输出说明
命令功能[object Object][object Object]
查询指定用户资源信息。
命令格式[object Object][object Object]
操作类型:GET
URL:https://device_ip**/redfish/v1/AccountService/Accounts/<**_member_id_>
请求头:
请求消息体:无
URL参数[object Object][object Object]
表 1 URL参数
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:无
响应样例:
响应码:200
输出说明[object Object][object Object]
表 2 操作输出说明
命令功能[object Object][object Object]
当前仅支持修改指定用户的密码信息。
命令格式[object Object][object Object]
操作类型:PATCH
URL:https://device_ip/redfish/v1/AccountService/Accounts/_<member_id_>
请求头:
请求消息体:
URL参数[object Object][object Object]
表 1 URL参数
请求参数[object Object][object Object]
表 2 请求参数
使用指南[object Object][object Object]
针对指定用户,仅支持修改请求消息体中的密码属性。
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:
响应样例:
响应码:200
输出说明[object Object][object Object]
表 3 操作输出说明
命令功能[object Object][object Object]
查询当前会话服务的信息。
命令格式[object Object][object Object]
操作类型:GET
URL:https://device_ip/redfish/v1/SessionService
请求头:
请求消息体:无
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:无
响应样例:
响应码:200
输出说明[object Object][object Object]
表 1 SessionService资源信息
命令功能[object Object][object Object]
修改当前会话服务的信息。
命令格式[object Object][object Object]
操作类型:PATCH
URL:https://device_ip/redfish/v1/SessionService
请求头:
请求消息体:
请求参数[object Object][object Object]
表 1 请求参数
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:
响应样例:
响应码:200
输出说明[object Object][object Object]
表 2 操作输出说明
命令功能[object Object][object Object]
创建新会话。
命令格式[object Object][object Object]
操作类型:POST
URL:https://device_ip/redfish/v1/SessionService/Sessions
请求头:
请求消息体:
请求参数[object Object][object Object]
表 1 请求参数
使用指南[object Object][object Object]
在Redfish操作过程中,该POST操作是首先要执行的。因为后续大部分操作,都需要在“Headers”中携带“X-Auth-Token”值用于鉴权,而“X-Auth-Token”可通过本操作获得。
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:
响应样例:
响应码:201
输出说明[object Object][object Object]
表 2 操作输出说明
命令功能[object Object][object Object]
删除指定会话。
命令格式[object Object][object Object]
操作类型:DELETE
URL:https://device_ip/redfish/v1/SessionService/Sessions/[object Object]session_id[object Object]
请求头:
请求消息体:无
URL参数[object Object][object Object]
表 1 URL参数
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:无
响应样例:
响应码:200
输出说明[object Object][object Object]
表 2 操作输出说明
命令功能[object Object][object Object]
查询当前系统集合资源的信息。
命令格式[object Object][object Object]
操作类型:GET
URL:https://device_ip/redfish/v1/Systems
请求头:
请求消息体:无
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:无
响应样例:
响应码:200
输出说明[object Object][object Object]
表 1 操作输出说明
命令功能[object Object][object Object]
修改当前系统资源属性。
命令格式[object Object][object Object]
操作类型:PATCH
URL:https://device_ip/redfish/v1/Systems
请求头:
请求消息体:
请求参数[object Object][object Object]
表 1 请求参数
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:
响应样例:
响应码:200
输出说明[object Object][object Object]
表 2 操作输出说明
命令功能[object Object][object Object]
复位系统。
命令格式[object Object][object Object]
操作类型:POST
URL:https://device_ip/redfish/v1/Systems/Actions/ComputerSystem.Reset
请求头:
请求消息体:
请求参数[object Object][object Object]
表 1 参数说明表
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:
输出说明[object Object][object Object]
响应样例:
响应码:200
表 2 操作输出说明
命令功能[object Object][object Object]
查询当前处理器资源集合信息。
命令格式[object Object][object Object]
操作类型:GET
URL:https://device_ip/redfish/v1/Systems/Processors
请求头:
请求消息体:无
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:无
响应样例:
响应码:200
输出说明[object Object][object Object]
表 1 操作输出说明
命令功能[object Object][object Object]
查询当前CPU概要信息。
命令格式[object Object][object Object]
操作类型:GET
URL:https://device_ip/redfish/v1/Systems/Processors/CPU
请求头:
请求消息体:无
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:无
响应样例:
响应码:200
输出说明[object Object][object Object]
表 1 操作输出说明
命令功能[object Object][object Object]
查询AI处理器资源信息。
命令格式[object Object][object Object]
操作类型:GET
URL:https://device_ip/redfish/v1/Systems/Processors/AiProcessor
请求头:
请求消息体:无
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:无
响应样例:
响应码:200
输出说明[object Object][object Object]
表 1 操作输出说明
命令功能[object Object][object Object]
查询内存概要信息。
命令格式[object Object][object Object]
操作类型:GET
URL:https://device_ip/redfish/v1/Systems/Memory
请求头:
请求消息体:无
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:无
响应样例:
响应码:200
输出说明[object Object][object Object]
表 1 操作输出说明
命令功能[object Object][object Object]
查询NTP配置信息。
命令格式[object Object][object Object]
操作类型:GET
URL:https://device_ip/redfish/v1/Systems/NTPService
请求头:
请求消息体:无
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:无
响应样例:
响应码:200
输出说明[object Object][object Object]
表 1 操作输出说明
命令功能[object Object][object Object]
配置NTP服务信息。
命令格式[object Object][object Object]
操作类型:PATCH
URL:https://device_ip/redfish/v1/Systems/NTPService
请求头:
请求消息体:
请求参数[object Object][object Object]
表 1 请求参数
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:
响应样例:
响应码:200
输出说明[object Object][object Object]
表 2 操作输出说明
命令功能[object Object][object Object]
查询告警资源信息。
命令格式[object Object][object Object]
操作类型:GET
URL:https://device_ip/redfish/v1/Systems/Alarm
请求头:
请求消息体:无
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:无
响应样例:
响应码:200
输出说明[object Object][object Object]
表 1 操作输出说明
命令功能[object Object][object Object]
查询告警资源服务。
命令格式[object Object][object Object]
操作类型:GET
URL:https://device_ip/redfish/v1/Systems/Alarm/AlarmInfo
请求头:
请求消息体:无
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:无
响应样例:
响应码:200
输出说明[object Object][object Object]
表 1 操作输出说明
命令功能[object Object][object Object]
查询告警屏蔽规则。
命令格式[object Object][object Object]
操作类型:GET
URL:https://device_ip/redfish/v1/Systems/Alarm/AlarmShield
请求头:
请求消息体:无
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:无
响应样例:
响应码:200
输出说明[object Object][object Object]
表 1 操作输出说明
命令功能[object Object][object Object]
创建告警屏蔽规则。
命令格式[object Object][object Object]
操作类型:PATCH
URL:https://device_ip/redfish/v1/Systems/Alarm/AlarmShield/Increase
请求头:
请求消息体:
请求参数[object Object][object Object]
表 1 请求参数
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:
响应样例:
响应码:200
输出说明[object Object][object Object]
表 2 操作输出说明
命令功能[object Object][object Object]
取消告警屏蔽规则。
命令格式[object Object][object Object]
操作类型:PATCH
URL:https://device_ip/redfish/v1/Systems/Alarm/AlarmShield/Decrease
请求头:
请求消息体:
参数说明[object Object][object Object]
表 1 参数说明
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:
响应样例:
响应码:200
输出说明[object Object][object Object]
表 2 操作输出说明
命令功能[object Object][object Object]
查询安全服务资源信息。
命令格式[object Object][object Object]
操作类型:GET
URL:https://device_ip/redfish/v1/Systems/SecurityService
请求头:
请求消息体:无
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:无
响应样例:
响应码:200
输出说明[object Object][object Object]
表 1 操作输出说明
命令功能[object Object][object Object]
查询当前支持的SSL证书资源的信息。
命令格式[object Object][object Object]
操作类型:GET
URL:https://device_ip/redfish/v1/Systems/SecurityService/HttpsCert
请求头:
请求消息体:无
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:无
响应样例:
响应码:200
输出说明[object Object][object Object]
表 1 操作输出说明
命令功能[object Object][object Object]
导入服务器证书。
命令格式[object Object][object Object]
操作类型:POST
URL:https://device_ip/redfish/v1/Systems/SecurityService/HttpsCert/Actions/HttpsCert.ImportServerCertificate
请求头:
请求消息体:
请求参数[object Object][object Object]
表 1 请求参数
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:
响应样例:
响应码:202
输出说明[object Object][object Object]
表 2 操作输出说明
命令功能[object Object][object Object]
下载证书签名请求。
命令格式[object Object][object Object]
操作类型:POST
URL:https://device_ip/redfish/v1/Systems/SecurityService/downloadCSRFile
请求头:
请求消息体:
无
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:无
响应样例:无(直接导出文件)
响应码:200
输出说明[object Object][object Object]
直接下载文件
命令功能[object Object][object Object]
导入弱字典。
[object Object]
命令格式[object Object][object Object]
操作类型:POST
URL:https://device_ip/redfish/v1/Systems/SecurityService/Actions/SecurityService.PunyDictImport
请求头:
请求消息体:
请求参数[object Object][object Object]
表 1 参数说明
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:
响应样例:
响应码:202
输出说明[object Object][object Object]
表 2 操作输出说明
命令功能[object Object][object Object]
导出弱字典。
[object Object]
命令格式[object Object][object Object]
操作类型:POST
URL:https://device_ip/redfish/v1/Systems/SecurityService/Actions/SecurityService.PunyDictExport
请求头:
请求消息体:无
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:无
响应样例:无(直接导出文件)
响应码:200
命令功能[object Object][object Object]
删除弱字典。
命令格式[object Object][object Object]
操作类型:POST
URL:https://device_ip/redfish/v1/Systems/SecurityService/Actions/SecurityService.PunyDictDelete
请求头:
请求消息体:
请求参数[object Object][object Object]
表 1 参数说明
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:
响应样例:
响应码:202
输出说明[object Object][object Object]
表 2 操作输出说明
命令功能[object Object][object Object]
查询证书有效期提醒时间。
命令格式[object Object][object Object]
操作类型:GET
URL:https://device_ip/redfish/v1/Systems/SecurityService/HttpsCertAlarmTime
请求头:
请求消息体:无
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:无
响应样例:
响应码:200
输出说明[object Object][object Object]
表 1 操作输出说明
命令功能[object Object][object Object]
修改证书有效期提醒时间。
命令格式[object Object][object Object]
操作类型:PATCH
URL:https://device_ip/redfish/v1/Systems/SecurityService/HttpsCertAlarmTime
请求头:
请求消息体:
请求参数[object Object][object Object]
表 1 参数说明
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:
响应样例:
响应码:200
输出说明[object Object][object Object]
表 2 操作输出说明
命令功能[object Object][object Object]
查询登录规则信息。
命令格式[object Object][object Object]
操作类型:GET
URL:https://device_ip/redfish/v1/Systems/SecurityService/SecurityLoad
请求头:
请求消息体:无
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:无
响应样例:
响应码:200
输出说明[object Object][object Object]
表 1 操作输出说明
命令功能[object Object][object Object]
配置登录规则信息。
命令格式[object Object][object Object]
操作类型:PATCH
URL:https://device_ip/redfish/v1/Systems/SecurityService/SecurityLoad
请求头:
请求消息体:
请求参数[object Object][object Object]
表 1 参数说明
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:
响应样例:
响应码:202
输出说明[object Object][object Object]
表 2 操作输出说明
命令功能[object Object][object Object]
导入登录规则信息。
命令格式[object Object][object Object]
操作类型:POST
URL:https://device_ip/redfish/v1/Systems/SecurityService/SecurityLoad/Actions/SecurityLoad.Import
请求头:
请求消息体:
请求参数[object Object][object Object]
表 1 参数说明
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:
响应样例:
响应码:202
输出说明[object Object][object Object]
表 2 操作输出说明
命令功能[object Object][object Object]
导出登录规则信息。
命令格式[object Object][object Object]
操作类型:POST
URL:https://device_ip/redfish/v1/Systems/SecurityService/SecurityLoad/Actions/SecurityLoad.Export
请求头:
请求消息体:无
使用指南[object Object][object Object]
无
使用实例[object Object][object Object]
请求样例:
请求头:
请求消息体:无
响应样例:无(直接导出文件)
响应码:200
表 1 Redfish资源树[object Object][object Object]