登录

欢迎user新华三退出

简体中文

  • 产品与解决方案
  • 行业解决方案
  • 服务
  • 支持
  • 合作伙伴
  • 关于我们

H3C HDM2&HDM3 Redfish参考手册-6W100

手册下载

H3C HDM2&HDM3 Redfish参考手册-6W100-整本手册.pdf  (6.62 MB)

  • 发布时间：2025/3/29 3:21:34
  • 浏览量：
  • 下载量：

 

 

 

 

 

H3C HDM2&HDM3

Redfish参考手册

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

新华三技术有限公司

http://www.h3c.com

 

资料版本：V1.14

产品版本：HDM2-1.73及以上版本，HDM2-2.10以上版本，HDM3-1.14及以上版本

Copyright © 2024 新华三技术有限公司及其许可者 版权所有，保留一切权利。

未经本公司书面许可，任何单位和个人不得擅自摘抄、复制本书内容的部分或全部，并不得以任何形式传播。

除新华三技术有限公司的商标外，本手册中出现的其它公司的商标、产品标识及商品名称，由各自权利人拥有。

由于产品版本升级或其他原因，本手册内容有可能变更。H3C保留在没有任何通知或者提示的情况下对本手册的内容进行修改的权利。本手册仅作为使用指导，H3C尽全力在本手册中提供准确的信息，但是H3C并不确保手册内容完全没有错误，本手册中的所有陈述、信息和建议也不构成任何明示或暗示的担保。

 

目录

修订记录··· xii

1 Redfish概述··· 1

2 Redfish接口通用说明··· 1

2.1 命令格式说明·· 1

2.2 ODATA属性说明·· 1

2.3 状态码说明·· 2

2.4 健康状态说明·· 2

2.5 接口权限说明·· 3

2.6 各资源主要功能说明·· 5

2.7 字段值显示空说明·· 5

2.8 支持产品·· 5

2.9 其它说明·· 5

3 使用方式··· 6

3.1 环境安装·· 6

4 Redfish接口··· 6

4.1 公共固定资源的操作·· 6

4.1.1 查询Redfish版本信息·· 6

4.1.2 查询当前根服务资源·· 7

4.1.3 查询Metadata文档·· 11

4.1.4 查询服务器当前所有资源的Schema文件·· 13

4.1.5 查询服务器单个Schema文件归档地址·· 17

4.1.6 查询所有归档资源·· 19

4.1.7 查询单个归档资源·· 20

4.1.8 查询OData服务文档·· 22

4.2 Chassis 资源的操作·· 24

4.2.1 查询机箱集合资源信息·· 24

4.2.2 查询设备信息·· 26

4.2.3 修改机箱相关资源·· 33

4.2.4 获取所有物理盘集合信息·· 38

4.2.5 查询指定物理盘信息·· 40

4.2.6 查询指定物理盘创建热备盘时可选逻辑盘列表·· 51

4.2.7 设置指定物理盘属性·· 53

4.2.8 获取所有空闲槽位集合·· 63

4.2.9 获取指定空闲槽位信息·· 64

4.2.10 设置指定空闲槽位信息·· 66

4.2.11 获取驱动器Bay的集合信息·· 68

4.2.12 查询指定驱动器Bay的信息·· 69

4.2.13 查询指定机箱散热资源信息·· 71

4.2.14 设置指定机箱散热资源信息·· 78

4.2.15 查询进风口历史温度资源信息·· 82

4.2.16 查询电源信息·· 84

4.2.17 设置电源信息·· 93

4.2.18 查询电源恢复策略信息·· 103

4.2.19 设置电源恢复策略·· 105

4.2.20 获取CPU电源节能信息·· 107

4.2.21 设置CPU电源节能信息·· 108

4.2.22 查询历史功率资源信息·· 110

4.2.23 查询传感器种类集合信息·· 112

4.2.24 查询指定类型的传感器列表信息·· 113

4.2.25 查询单个传感器资源的历史信息·· 116

4.2.26 重新统计指定传感器的最高历史温度信息·· 119

4.2.27 查询扩展卡列表·· 123

4.2.28 查询指定扩展卡信息·· 124

4.2.29 查询PCIE卡列表·· 132

4.2.30 查询指定PCIE卡设备信息·· 134

4.2.31 查询指定PCIE卡功能信息·· 139

4.2.32 查询网络适配器集合资源信息·· 142

4.2.33 查询网络适配器单个资源信息·· 144

4.2.34 查询网络端口集合资源信息·· 151

4.2.35 查询网络端口单个资源信息·· 153

4.2.36 设置网络端口单个资源信息·· 156

4.2.37 查询存储介质告警水线·· 159

4.2.38 设置存储介质告警水线·· 161

4.3 Systems 资源的操作·· 165

4.3.1 查询系统集合资源信息·· 165

4.3.2 查询指定系统资源信息·· 166

4.3.3 修改指定系统资源属性·· 176

4.3.4 查询开机自检顺序·· 184

4.3.5 查询开机自检码集合资源信息·· 185

4.3.6 查询指定开机自检码信息·· 187

4.3.7 服务器电源操作·· 189

4.3.8 重启CPLD·· 191

4.3.9 查询CPU列表·· 193

4.3.10 设置CPU占用率警告门限·· 194

4.3.11 查询指定CPU信息·· 196

4.3.12 查询内存列表·· 201

4.3.13 查询指定内存条信息·· 203

4.3.14 查询RAID卡列表·· 207

4.3.15 查询指定RAID卡信息·· 209

4.3.16 修改指定RAID卡信息·· 216

4.3.17 清除指定RAID卡下物理盘Foreign状态·· 221

4.3.18 清除指定RAID卡的所有配置·· 222

4.3.19 查询逻辑盘列表·· 224

4.3.20 创建逻辑盘·· 226

4.3.21 删除指定逻辑盘·· 234

4.3.22 查询指定逻辑盘信息·· 236

4.3.23 修改指定逻辑盘属性·· 243

4.3.24 查询BIOS选项列表·· 246

4.3.25 查询待生效的BIOS选项信息·· 248

4.3.26 设置指定的BIOS选项·· 250

4.3.27 修改BIOS密码·· 252

4.3.28 恢复BIOS属性默认值·· 254

4.3.29 查询BIOS详细配置规则信息·· 256

4.3.30 创建KVM资源信息·· 258

4.3.31 查询事件日志服务集合资源信息·· 260

4.3.32 查询指定事件日志服务资源信息·· 261

4.3.33 设置指定事件日志服务资源信息·· 263

4.3.34 查询事件日志集合资源信息·· 265

4.3.35 查询事件日志资源信息·· 272

4.3.36 导出事件日志信息·· 275

4.3.37 清空事件日志信息·· 277

4.3.38 查询GPU信息·· 279

4.3.39 设置GPU信息·· 283

4.3.40 查询安全控制面板信息·· 286

4.3.41 设置安全控制面板信息·· 288

4.3.42 网络接口集合资源信息查询·· 290

4.3.43 指定网络接口资源信息查询·· 292

4.3.44 查询网口集合信息·· 293

4.3.45 清除配置·· 295

4.3.46 下载清除配置报告·· 297

4.3.47 查询配置清除进度·· 298

4.3.48 查询系统软件清单信息·· 301

4.3.49 清除未生效的BIOS配置·· 303

4.3.50 查询主机状态迁移信息·· 305

4.3.51 查询主机资源监控信息·· 309

4.3.52 设置主机资源监控信息·· 313

4.3.53 查询CPU历史占用率资源信息·· 316

4.3.54 查询内存历史占用率资源信息·· 317

4.3.55 查询GPU历史占用率资源信息·· 319

4.3.56 查询网络带宽历史收发速率资源信息·· 321

4.3.57 查询磁盘历史占用率资源信息·· 323

4.3.58 查询磁盘IO性能历史数据信息·· 325

4.3.59 查询磁盘SVCTM历史数据信息·· 327

4.3.60 查询NFS服务端读写速率历史数据信息·· 329

4.3.61 查询NFS客户端读写速率历史数据信息·· 331

4.3.62 查询系统负载历史数据信息·· 333

4.3.63 获取性能顾问推荐信息·· 335

4.3.64 上传写入Intel On Demand License激活文件·· 338

4.3.65 导出CPU状态报告·· 340

4.4 Managers 资源的操作·· 342

4.4.1 查询管理集合资源·· 342

4.4.2 查询指定管理资源信息·· 344

4.4.3 修改服务器指定管理资源信息·· 352

4.4.4 查询NTP信息·· 356

4.4.5 设置NTP信息·· 358

4.4.6 查询SNMP信息·· 361

4.4.7 设置SNMP信息·· 365

4.4.8 发送SNMP测试警报·· 372

4.4.9 查询SMTP信息·· 374

4.4.10 设置SMTP信息·· 378

4.4.11 发送SMTP测试警报·· 384

4.4.12 获取SMTP测试警报结果信息·· 386

4.4.13 查询SYSLOG信息·· 388

4.4.14 设置SYSLOG信息·· 392

4.4.15 发送SYSLOG测试警报·· 398

4.4.16 导入Syslog根证书·· 400

4.4.17 导入本地证书·· 402

4.4.18 导入私钥证书·· 404

4.4.19 查询服务信息·· 407

4.4.20 设置服务信息·· 417

4.4.21 重启服务·· 423

4.4.22 查询可创建会话的服务列表信息·· 425

4.4.23 查询指定服务的详细会话信息·· 427

4.4.24 删除指定服务的会话信息·· 429

4.4.25 查询节能服务信息·· 431

4.4.26 设置节能服务信息·· 432

4.4.27 HDM重启·· 434

4.4.28 恢复BMC出厂设置·· 436

4.4.29 查询网口列表·· 438

4.4.30 设置网口模式·· 439

4.4.31 查询共享网口信息·· 441

4.4.32 设置共享网口信息·· 444

4.4.33 查询指定网口信息·· 447

4.4.34 设置指定网口信息·· 453

4.4.35 查询虚拟媒体集合资源·· 463

4.4.36 查询虚拟媒体资源·· 465

4.4.37 查询虚拟媒体连接状态·· 468

4.4.38 查询虚拟媒体配置·· 470

4.4.39 设置虚拟媒体配置·· 473

4.4.40 连接虚拟媒体·· 477

4.4.41 断开虚拟媒体·· 483

4.4.42 停止虚拟媒体挂载·· 484

4.4.43 查询所有操作日志列表信息·· 486

4.4.44 查询日志服务集合资源信息·· 488

4.4.45 查询指定日志服务资源信息·· 490

4.4.46 查询日志集合资源信息·· 492

4.4.47 查询日志资源信息·· 493

4.4.48 导出操作日志信息·· 495

4.4.49 清空操作日志信息·· 498

4.4.50 收集SDS日志·· 499

4.4.51 下载BMC文件·· 502

4.4.52 查询VNC信息·· 503

4.4.53 设置VNC信息·· 505

4.4.54 查询KVM信息·· 506

4.4.55 设置KVM信息·· 508

4.4.56 查询串口列表·· 509

4.4.57 查询指定串口信息·· 511

4.4.58 查询LLDP服务配置资源信息·· 513

4.4.59 修改LLDP服务资源属性·· 515

4.4.60 查询无线管理资源信息·· 517

4.4.61 修改无线管理资源属性·· 519

4.4.62 导入BIOS、BMC和RAID控制器配置·· 522

4.4.63 导出BIOS、BMC和RAID控制器配置·· 525

4.4.64 获取可信密码模块状态配置·· 527

4.4.65 查询防火墙配置信息·· 529

4.4.66 添加防火墙规则信息·· 532

4.4.67 修改防火墙规则信息·· 535

4.4.68 删除防火墙配置规则·· 539

4.4.69 查询服务器安全服务信息·· 541

4.4.70 查看SSL证书资源信息·· 543

4.4.71 生成SSL证书·· 546

4.4.72 导入 SSL 证书·· 549

4.4.73 查询登录安全性信息功能·· 552

4.4.74 设置登录安全性信息功能·· 553

4.4.75 获取平台固件保护恢复（PFR）配置·· 555

4.4.76 设置平台固件保护恢复（PFR）配置·· 556

4.4.77 获取串口重定向配置信息·· 557

4.4.78 设置串口重定向配置信息·· 559

4.4.79 获取蓝屏快照·· 560

4.4.80 删除蓝屏快照·· 562

4.4.81 获取录像回放·· 564

4.4.82 获取录像回放高级配置·· 565

4.4.83 设置录像回放高级配置·· 567

4.4.84 播放录像回放·· 569

4.4.85 导出录像回放·· 570

4.4.86 删除录像回放·· 572

4.4.87 联合管理 管理设备集合资源查询·· 574

4.4.88 联合管理 添加管理设备资源·· 577

4.4.89 联合管理 删除管理设备资源·· 579

4.4.90 联合管理 主机电源操作·· 581

4.4.91 查询服务U盘资源信息·· 583

4.4.92 设置服务U盘资源信息·· 585

4.4.93 上传BMC文件·· 586

4.4.94 复位SD卡·· 588

4.4.95 查询安全仪表信息·· 590

4.4.96 设置安全仪表信息·· 596

4.4.97 获取系统锁定资源信息·· 600

4.4.98 修改系统锁定资源信息·· 602

4.4.99 查询智能监控服务信息·· 604

4.4.100 设置智能监控服务信息·· 607

4.4.101 查询智能监控硬盘资源信息·· 609

4.4.102 查询智能监控指定硬盘信息·· 612

4.4.103 查询智能监控内存资源信息·· 620

4.4.104 查询快速安装系统配置信息·· 622

4.4.105 创建快速安装系统配置·· 624

4.4.106 获取应急诊断信息·· 626

4.4.107 设置应急诊断配置信息·· 629

4.4.108 多节点设备节点控制·· 631

4.5 AccountService 资源的操作·· 633

4.5.1 查询用户服务信息·· 633

4.5.2 修改用户服务信息·· 637

4.5.3 查询用户列表信息·· 641

4.5.4 查询指定用户信息·· 642

4.5.5 添加用户信息·· 645

4.5.6 修改用户信息·· 649

4.5.7 删除用户信息·· 652

4.5.8 查询角色集合资源信息·· 654

4.5.9 查询指定角色信息·· 655

4.5.10 修改指定角色信息·· 657

4.5.11 查询角色名称·· 660

4.5.12 修改角色名称·· 661

4.5.13 查询LDAP服务资源·· 663

4.5.14 修改LDAP服务资源·· 665

4.5.15 LDAP CA证书导入·· 668

4.5.16 查询LDAP域控制器集合资源·· 670

4.5.17 查询指定LDAP域用户集合资源·· 671

4.5.18 查询指定LDAP域的单个用户资源·· 673

4.5.19 添加指定 LDAP 域用户组·· 674

4.5.20 修改指定 LDAP 域用户组资源·· 676

4.5.21 删除指定LDAP域用户组资源·· 678

4.5.22 查询AD服务资源·· 680

4.5.23 修改AD 服务资源·· 681

4.5.24 查询AD域控制器集合资源·· 683

4.5.25 查询指定AD域用户集合资源·· 684

4.5.26 查询指定AD域的单个用户资源·· 686

4.5.27 添加指定AD 域用户组·· 688

4.5.28 修改指定AD域用户组资源·· 689

4.5.29 删除指定AD域用户组资源·· 691

4.5.30 获取用户证书管理服务信息·· 693

4.5.31 设置证书管理服务信息·· 694

4.5.32 查询用户根证书列表·· 696

4.5.33 查询指定根证书信息·· 698

4.5.34 导入根证书文件·· 700

4.5.35 删除根证书文件·· 702

4.5.36 查询与指定根证书绑定的客户端证书列表·· 703

4.5.37 导入客户端证书文件·· 705

4.5.38 查询指定客户端证书信息·· 707

4.5.39 删除指定客户端证书·· 709

4.5.40 获取客户端证书可绑定的用户列表·· 711

4.5.41 用户绑定客户端证书·· 713

4.5.42 客户端证书解绑与特定用户的关联·· 715

4.5.43 获取SSH公钥列表信息·· 717

4.5.44 获取指定SSH公钥信息·· 718

4.5.45 导入SSH公钥·· 720

4.5.46 删除指定SSH公钥·· 722

4.5.47 获取SSH公钥可绑定的用户列表·· 723

4.5.48 用户绑定指定SSH公钥·· 725

4.5.49 SSH公钥解绑与特定用户的关联·· 727

4.5.50 导入弱口令字典·· 729

4.5.51 导出弱口令字典·· 731

4.5.52 查询 Kerberos 服务资源·· 734

4.5.53 修改Kerberos服务资源·· 735

4.5.54 查询Kerberos集合资源·· 736

4.5.55 查询指定Kerberos用户组集合资源·· 738

4.5.56 修改指定 Kerberos用户组集合资源·· 740

4.5.57 上传keytab文件·· 742

4.5.58 添加指定Kerberos用户组·· 744

4.5.59 查询指定Kerberos的单个用户组资源·· 746

4.5.60 修改指定Kerberos用户组资源·· 748

4.5.61 删除指定Kerberos用户组资源·· 749

4.6 SessionService 资源的操作·· 751

4.6.1 创建Redfish会话·· 751

4.6.2 查询会话集合资源信息·· 754

4.6.3 查询指定会话资源信息·· 756

4.6.4 删除指定会话·· 758

4.6.5 查询Redfish会话服务信息·· 759

4.6.6 修改Redfish会话服务信息·· 761

4.7 UpdateService 资源的操作·· 763

4.7.1 查询服务器当前升级服务资源的信息·· 763

4.7.2 设置服务器当前升级服务资源的信息·· 766

4.7.3 查询可升级固件集合资源信息·· 769

4.7.4 查询指定的可升级固件资源的信息·· 770

4.7.5 查询镜像池列表·· 772

4.7.6 删除镜像池中指定镜像·· 773

4.7.7 升级固件·· 775

4.7.8 查询固件清单信息·· 778

4.7.9 查询单个固件清单信息·· 780

4.7.10 查询固件安装包集合信息·· 782

4.7.11 卸载指定固件安装包·· 783

4.7.12 导出BIOS固件·· 785

4.8 TaskService 资源的操作·· 787

4.8.1 查询服务器当前任务服务资源的信息·· 787

4.8.2 查询服务器当前任务集合资源的信息·· 789

4.8.3 查询服务器指定任务资源的信息·· 791

4.8.4 删除服务器指定任务资源·· 794

4.8.5 查询服务器定时任务列表信息·· 795

4.8.6 查询服务器指定定时任务信息·· 797

4.8.7 修改服务器指定定时任务信息·· 799

4.9 EventService 资源操作·· 801

4.9.1 查询事件服务资源·· 801

4.9.2 创建事件订阅资源·· 803

4.9.3 查询事件订阅资源集合·· 806

4.9.4 查询事件订阅资源信息·· 807

4.9.5 修改事件订阅资源·· 809

4.9.6 删除事件订阅资源·· 811

4.9.7 故障告警上报报文示例·· 813

4.9.8 模拟测试事件上报·· 816

4.10 LicenseService资源的操作·· 818

4.10.1 查询License服务信息·· 818

4.10.2 查询License资源集合信息·· 820

4.10.3 查询指定License资源信息·· 821

4.10.4 安装License激活文件·· 823

4.10.5 导出License文件·· 825

4.10.6 卸载Licnese激活文件·· 827

5 使用案例··· 829

5.1 使用postman查询当前根服务资源信息·· 829

6 附录··· 831

6.1 查询参数·· 831

6.1.2 筛选和分页显示（$skip, $top）·· 832

6.1.3 扩展超链接显示（$expand）·· 832

6.1.4 查询字段的列表（$select）·· 832

 

修订记录

本手册修订及版本配套表情况

版本

修订时间

HDM版本号

接口名称

接口更改内容

 

2021-5-17

0.00.11

首次发布版本

 

 

2022-6-10

0.00.14

下载BMC文件

Path改为Content

 

2022-11-29

 

查询当前根服务资源

返回体新增ProtocolFeaturesSupported对象

 

2022-12-1

 

4.4.33 查询虚拟媒体资源

将查询虚拟媒体CD资源和查询虚拟媒体HD资源合并

 

2022-12-1

 

4.4.37 连接虚拟媒体

TASK返回体修改，统一成一种形式

 

2022-12-1

 

4.4.38 断开虚拟媒体

TASK返回体修改，统一成一种形式

 

2022-12-1

 

4.4.58 导入BIOS、BMC和RAID控制器配置

TASK返回体修改，统一成一种形式，接口权限从维护诊断修改为用户配置

 

2022-12-1

 

4.4.59 导出BIOS、BMC和RAID控制器配置

TASK返回体修改，统一成一种形式，接口权限从维护诊断修改为用户配置

 

2022-12-1

 

4.6.4 删除指定Redfish会话

返回体修改，统一成一种形式

 

2022-12-1

 

4.7.6 升级固件

TASK返回体修改，统一成一种形式，升级请求体因HDM2升级流程修改，和G5有较大变动

 

2022-12-1

 

4.9.6 删除事件订阅资源

返回体修改，统一成一种形式

 

2022-12-1

 

4.3.34 查询事件日志集合资源信息

接口权限从查询模块修改为系统审计

 

2022-12-1

 

4.3.35 查询事件日志资源信息

接口权限从查询模块修改为系统审计

 

2022-12-1

 

4.3.37 清空事件日志信息

接口权限从常规配置修改为维护诊断

 

2022-12-2

 

4.4.9 查询SMTP信息

增加TLSEnabled字段

 

2022-12-2

 

4.4.10 设置SMTP信息

增加TLSEnabled字段

 

2022-12-6

 

4.2.7 设置指定物理盘属性

接口权限从“远程控制”改为“远程控制|维护诊断”

 

2022-12-6

 

4.3.3 修改指定系统资源属性

接口权限从“远程控制”改为“远程控制|常规配置|电源控制”

 

2022-12-6

 

4.3.20 创建逻辑盘

返回体修改，统一成一种形式

 

2022-12-6

 

4.3.21 删除指定逻辑盘

返回体修改，统一成一种形式

 

2022-12-6

 

4.4.49 设置VNC信息

接口权限从“安全控制”改为“远程控制”

 

2022-12-6

 

4.4.51 设置KVM信息

接口权限从“安全控制”改为“远程控制”

 

2022-12-8

 

4.2.2 查询设备信息

PCIeDevices字段放入Links内部

 

2022-12-13

 

4.3.13 查询指定内存条信息

在Oem.Public里添加OperatingSpeedMegaTransfersPerSecond、AllowedSpeedsMegaTransfersPerSecond字段

 

2022-12-13

 

4.4.13 查询SYSLOG信息

4.4.14 设置SYSLOG信息

在Oem.Public里添加RootCertificateInstalled、ClientCertificateInstalled、PrivateKeyCertificateInstalled字段

 

2022-12-16

 

4.2.15 获取CPU电源节能信息

4.2.15 设置CPU电源节能信息

新增CPUPStateValid字段

 

2022-12-16

 

4.5.1 查询用户服务信息

增加导出弱口令字典操作路径和导入弱口令字典操作路径，并新增字段Oem.Public.PasswordRule.WeakPasswordDictionaryEnabled

 

2022-12-16

 

4.5.2 修改用户服务信息

新增字段Oem.Public.PasswordRule.WeakPasswordDictionaryEnabled

 

2022-12-16

 

4.5.49 导入弱口令字典操作路径

新增接口

 

2022-12-16

 

4.5.50 导出弱口令字典操作路径

新增接口

 

2022-12-16

 

查询SNMP信息

新增SnmpV3EngineID字段；SnmpV3AuthProtocol字段新增sha256、sha384、sha512；SnmpV3PrivProtocol字段新增aes192、aes256

 

2022-12-16

 

设置SNMP信息

新增SnmpV3Enabled字段

 

2022-12-16

 

查询指定用户信息

新增Oem.Public.SnmpEncryptPwdInit、Oem.Public.SnmpV3Password字段；Oem.Public.SnmpV3AuthProtocol字段新增SHA256、SHA384、SHA512；Oem.Public.SnmpV3PrivProtocol字段新增AES192、AES256

 

2022-12-16

 

添加用户信息

新增Oem.Public.SnmpV3Password字段；Oem.Public.SnmpV3AuthProtocol字段新增SHA256、SHA384、SHA512；Oem.Public.SnmpV3PrivProtocol字段新增AES192、AES256

 

2022-12-16

 

修改用户信息

新增Oem.Public.SnmpV3Password字段；Oem.Public.SnmpV3AuthProtocol字段新增SHA256、SHA384、SHA512；Oem.Public.SnmpV3PrivProtocol字段新增AES192、AES256

 

2022-12-30

 

查询指定RAID卡信息

新增SupportedStripSize字段；

SupportedConfigurationOperation新增ConfigureAccessPolicy、ConfigureWritePolicy、ConfigureReadPolicy、ConfigureDriveCachePolicy

 

2022-12-30

 

查询指定网口信息

新增字段
Ipv4StaticAddresses.Address

Ipv4StaticAddresses.AddressOrigin

Ipv4StaticAddresses.Gateway

Ipv4StaticAddresses.SubnetMask
Ipv6StaticDefaultGateways

 

2022-12-30

 

设置指定网口信息

新增字段
Ipv4StaticAddresses.Address

Ipv4StaticAddresses.AddressOrigin

Ipv4StaticAddresses.Gateway

Ipv4StaticAddresses.SubnetMask

Ipv6StaticDefaultGateways

 

2023-1-17

 

查询指定系统资源信息

新增字段

ComputeModuleMaxCount

PresentComputeModules

 

2023-2-14

 

查询设备信息

新增字段

ChassisPartNumber

 

2023-2-20

 

查询指定物理盘信息

新增字段

PredictedMediaLifeLeftDays

 

2023-2-20

 

License相关接口

新增License相关接口

 

2023-2-23

 

获取所有物理盘集合信息

新增字段

AlarmThreshold

 

2023-2-23

 

查询指定机箱散热资源信息

新增字段

InletHistoryTemperature

 

2023-2-23

 

查询服务器当前升级服务资源的信息

#MirrorPool.DeleteImage

修改到Actions.Oem.Public下

 

#UpdateService.DumpBIOS

修改到Actions.Oem.Public下

 

新增

#UpdateService.UninstallPackage

InstalledPackages

 

2023-2-23

 

用户绑定客户端证书

URL名称更改ClientCertifcate修改为ClientCertificate

 

2023-2-23

 

客户端证书解绑与特定用户的关联

URL名称更改ClientCertifcate修改为ClientCertificate

 

2023-2-23

 

获取SSH公钥列表信息

新增Accounts对象

 

2023-2-23

 

获取用户证书管理服务信息

新增Accounts对象

 

2023-2-23

 

查询电源信息

新增PowerHistoryData对象

 

2023-2-23

 

查询事件日志服务集合资源信息

新增Actions.Oem.Public.#LogServices.ExportEventLog对象

 

2023-2-24

 

查询网络端口单个资源信息

删除PCIeAddress字段

 

2023-2-24

 

查询单个固件清单信息

新增Model字段

 

2023-2-24

 

查询内存列表

删除MemoryRankSparing字段

 

2023-2-26

 

查询SMTP信息

AlarmSeverity字段新增”Major+Critical”

 

2023-2-26

 

设置SMTP信息

AlarmSeverity字段新增”Major+Critical”

 

2023-2-27

 

查询指定CPU信息

新增ChopType和Step字段

 

2023-2-27

 

查询主机状态迁移信息

新增接口

 

2023-2-27

 

查询指定内存条信息

新增Oem.Public.DisabledCausation字段

 

2023-2-27

 

查询安全仪表信息、设置安全仪表信息

新增接口

 

2023-2-28

 

查询指定PCIE功能信息

新增字段Oem.Public.LinkWidthAbility

 

2023-2-28

 

收集SDS日志

新增字段LogType

 

2023-3-1

 

查询服务器当前升级服务资源信息

删除UpdateService.DumpBIOS与UpdateService.SimpleUpdate两个字段下面的[email protected]字段

 

2023-3-1

 

升级固件

UpgradeType添加取值

 

2023-3-2

 

查询指定系统资源信息

新增Oem.Public.HostStatus对象

 

2023-3-2

 

查询应急诊断信息

接口删除

 

2023-3-2

 

修改应急诊断信息

接口删除

 

2023-3-2

 

查询主机资源信息、设置主机资源信息

接口删除

 

2023-3-2

 

查询CPU历史占用率资源信息

接口删除

 

2023-3-2

 

查询内存历史占用率资源信息

接口删除

 

2023-3-2

 

查询IO历史占用率资源信息 

接口删除

 

2023-3-2

 

查询主机资源信息、设置主机资源信息

接口新增

 

2023-3-2

 

查询CPU历史占用率资源信息

接口新增

 

2023-3-2

 

查询内存历史占用率资源信息

接口新增

 

2023-3-2

 

查询GPU历史占用率资源信息 

接口新增

 

2023-3-2

 

查询网络带宽历史收发速率资源信息

接口新增

 

2023-3-2

 

查询磁盘历史占用率资源信息

接口新增

 

2023-3-2

 

查询磁盘IO性能历史数据信息

接口新增

 

2023-3-2

 

查询磁盘SCVTM历史数据信息

接口新增

 

2023-3-2

 

查询NFS服务端读写速率历史数据信息

接口新增

 

2023-3-2

 

查询NFS客户端读写速率历史数据信息

接口新增

 

2023-3-2

 

查询系统负载历史数据信息

接口新增

 

2023-3-2

 

查询智能监控信息

接口新增

 

2023-3-2

 

设置智能监控信息

接口新增

 

2023-3-2

 

查询支持预测的传感器种类集合

接口新增

 

2023-3-2

 

查询指定类型支持预测的传感器列表信息

接口新增

 

2023-3-2

 

查询支持预测的单个传感器信息

接口新增

 

2023-3-2

 

查询指定管理资源信息

新增字段Oem.Public.IntelligentMonitoringService

 

2023-3-7

 

查询共享网口信息

新增字段HotPlugSupported

 

2023-3-8

 

查询所有归档资源

新增字段@odata.context

 

2023-3-8

 

查询单个归档资源

新增字段@odata.context

 

2023-3-8

 

查询无线管理资源信息

新增字段IsSameSegment

 

2023-3-8

 

查询管理集合资源

修改字段@odata.context取值

 

2023-3-8

 

查询主机状态迁移信息

SDCardState字段修改为DSDCardState

 

2023-3-8

 

查询主机资源监控信息

TotalCapacityGiB改为TotalCapacityMB

FreeSpaceGiB改为FreeSpaceMB

 

2023-3-8

 

查询主机资源监控信息

DriveSCVTMHistoryData修改为DriveSVCTMHistoryData

 

2023-3-8

 

查询磁盘SVCTM历史数据信息

URL名称修改DriveSCVTMHistoryData改为DriveSVCTMHistoryData

HistorySCVTM数组修改为HistorySVCTM

 

2023-3-10

 

查询指定物理盘信息

新增字段SystemDiskNumber

 

2023-3-13

 

收集SDS日志

修改content参数说明为

“见其它说明，该接口仅支持”/mnt/sdmmc0p1/sds/bmc/文件名”

特殊符号支持@!$^&_+.;[]{}-=~“

 

2023-3-14

 

查询指定管理资源信息

新增备分区内部版本号字段InternalBackupFirmwareVersion

 

2023-3-15

 

查询主机状态迁移信息

删除DiagnosticServiceEnabled字段

 

2023-3-15

 

返回任务ID的接口

统一新增TaskUniqueID字段，代表task的唯一ID

 

2023-3-15

 

导入弱口令字段

输出说明增加name字段说明

 

2023-3-15

 

导入 SSL 证书

文本证书样例修改

V0.9.1

2023-3-16

HDM2-1.13

不涉及

同步更新小版本号

 

2023-3-17

 

查询指定License激活文件

License类型中的“试用”改为“临时”

 

2023-3-17

 

查询指定RAID卡信息

新增字段SupportedRAIDMode

 

2023-3-17

 

查询指定类型的传感器列表信息

Description和Name字段修改

 

2023-3-17

 

查询SMTP信息

删除字段Oem.Public.RSAEncryptionEnabled

 

2023-3-18

 

创建逻辑盘

修改支持的卡说明及条带大小字段说明

 

2023-3-18

 

查询指定AD域用户集合资源

功能描述中的“LDAP”改为“AD”

 

2023-3-20

 

查询指定机箱散热资源信息

InletHistoryTemperature参数说明中的“进出口”改为“进风口”

 

2023-3-20

 

查询事件服务资源

参数说明中新增“target”和“Description”字段描述

 

2023-3-20

 

查询事件服务资源

参数说明中的“EventService资源信息说明”改为“查询事件服务资源的返回参数说明”

 

2023-3-20

 

模拟测试事件上报

参数说明中“Severity”改为“MessageSeverity”

 

2023-3-21

 

查询网络端口单个资源信息

样例修改

 

2023-3-21

 

设置网络端口单个资源信息

样例修改

 

2023-3-22

 

查询指定RAID卡信息

样例中补充SpeedGTps字段及说明

 

2023-3-22

 

查询指定事件日志服务资源信息

删除Actions. #LogService.ClearLog.下的@Redfish.ActionInfo及[email protected]字段

V0.9.2

2023-3-24

HDM2-1.14

不涉及

同步更新小版本号

 

2023-3-24

 

查询主机资源监控信息

设置主机资源监控信息

应答示例新增ProcessorsUsageRate、MemoryUsageRate字段，添加输出说明

 

2023-3-24

 

创建逻辑盘

新增P460条带大小支持16KB及32KB的说明

 

2023-3-28

 

下载BMC文件

新增路径/mnt/sdmmc0p4/bsod 用于下载截屏录像

 

2023-3-29

 

查询服务信息

使用说明： G6 AMD产品暂不支持Ihdt功能

 

2023-3-29

 

设置服务信息

使用说明： G6 AMD产品暂不支持Ihdt功能

 

2023-3-29

 

查询指定服务的详细会话信息

使用说明： G6 AMD产品暂不支持Ihdt功能

 

2023-3-29

 

删除指定服务的会话信息

使用说明： G6 AMD产品暂不支持Ihdt功能

 

2023-4-4

 

创建Redfish会话

添加LoginTime字段说明

 

2023-4-4

 

查询指定Redfish会话资源信息

接口说明查由询指定Redfish会话资源信息改为查询指定会话资源信息，修改UserTag、SessionType参数说明

 

2023-4-4

 

查询Redfish会话集合资源信息

接口说明由查询Redfish会话集合资源信息改为查询会话集合资源信息

 

2023-4-4

 

删除指定Redfish会话

接口说明由删除指定Redfish会话改为删除指定会话

 

2023-4-6

 

其它说明

其它说明中新增对[email protected]的统一说明

V1.0

2023-4-11

HDM2-1.15

 

 

 

2023-4-11

 

添加用户信息

输出说明删除表格，改为“返回字段说明同【查询指定用户信息】”

 

2023-4-11

 

修改LDAP服务资源

参数说明中删除多余的SSLEncryptionEnabled字段

 

2023-4-11

 

修改指定LDAP域用户组资源

修改接口名为“修改指定LDAP域用户组资源”

 

2023-4-11

 

删除指定LDAP域用户组资源

修改接口名称为“删除指定LDAP域用户组资源”

 

2023-4-11

 

修改指定AD域用户组资源

“user_id”字段解释修改为“待修改的AD域用户组ID”

 

2023-4-11

 

删除指定AD域用户组资源

“user_id”字段解释修改为“待删除的AD域用户组ID”

 

2023-4-12

 

查询指定 LDAP 域的单个用户资源

新增字段“Name”；修改字段“MemberId”为“Id”

 

2023-4-12

 

查询指定AD域的单个用户资源

修改字段“MemberId”为“Id”

 

2023-4-12

 

导出BIOS固件

请求体“Oem.Public.ScriptName”修改为“ScriptName”

 

2023-4-14

 

创建逻辑盘

修改条带大小字段说明：更多支持的存储控制器，以实际规格为准，可通过HDM/BIOS获取支持的条带大小

V1.0.1

2023-4-15

HDM2-1.15

HDM2-1.50

不涉及

刷新最小版本号

 

2023-4-15

 

修改指定系统资源属性

功能描述中新增使用说明“设置HostName时，需同时设置HostNameSetupMode字段值为”Manual”。”；将使用实例中HostNameSetupMode字段值修改为“Manual”

V1.0.2

2023-4-21

HDM2-1.16

HDM2-1.50

不涉及

刷新最小版本号

 

2023-4-21

 

查询指定CPU信息

修改Step参数说明

 

2023-4-21

 

查询主机状态迁移信息

修改示例TPMType取值

 

2023-4-21

 

获取可信密码模块状态配置

修改示例Type取值

V1.1

2023-4-24

HDM2-1.17

HDM2-1.50

 

 

 

2023-4-24

 

查询智能监控服务信息

删除接口

 

2023-4-24

 

设置智能监控服务信息

删除接口

 

2023-4-24

 

查询支持预测的传感器种类集合

删除接口

 

2023-4-24

 

查询指定类型支持预测的传感器列表信息

删除接口

 

2023-4-24

 

查询支持预测的单个传感器信息

删除接口

 

2023-4-24

 

查询指定管理资源信息

删除查询智能监控服务信息路径

 

2023-4-24

 

修改服务器指定管理资源信息

应答示例中删除查询智能监控服务信息路径

V1.1.1

2023-4-26

HDM2-1.17

HDM2-1.51

 

 

 

2023-4-26

 

添加用户信息

将字段Id改为可选参数

V1.1.2

2023-5-9

HDM2-1.17

HDM2-1.52

 

 

 

2023-5-9

 

查询指定系统资源信息

新增字段

ChassisPartNumber

V1.1.3

2023-5-22

HDM2-1.19

HDM2-1.53

 

 

 

2023-5-26

 

查询主机状态迁移信息

DSDCardState字段新增NotSupported状态，并添加该字段输出说明

 

2023-5-26

 

添加用户信息

修改用户信息

SNMPV3独立密码删除限制字符的描述

 

2023-5-26

 

系统锁定相关接口

添加所属系统锁定类型

 

2023-5-29

 

修改BIOS密码

补充BIOS密码的复杂度检测说明

 

2023-5-29

 

新增4.5.51-4.5.60 kerberos相关接口

接口新增

V1.2

2023-6-2

HDM2-1.20

HDM2-1.53

 

 

 

2023-6-2

 

查询指定物理盘信息

对个别“字段说明”针对Trimode配置下NVMe显示情况进行补充说明；

 

2023-6-5

 

获取指定PCIe设备信息

修改FirmwareVersion字段说明

V1.3

2023-6-7

HDM2-1.21

HDM2-1.54

 

 

 

2023-6-9

 

查询智能监控硬盘资源信息

新增接口

 

2023-6-9

 

查询智能监控指定硬盘信息

新增接口

 

2023-6-9

 

查询指定物理盘信息

新增RawValue字段

 

2023-6-9

 

查询指定管理资源信息

新增IntelligentMonitoringService字段

 

2023-6-9

 

查询智能监控服务信息

重新启用此接口

 

2023-6-10

 

查询指定物理盘信息

新增字段RawCapacity

 

2023-6-15

 

查询主机资源监控信息

新增DriveUsageAlarmThreshold、MemoryUsageAlarmThreshold和ProcessorsUsageAlarmThreshold字段

 

2023-6-15

 

设置主机资源监控信息

应答示例新DriveUsageAlarmThreshold、MemoryUsageAlarmThreshold和ProcessorsUsageAlarmThreshold字段

 

2023-6-16

 

收集SDS日志

修改Content字段说明

 

2023-6-16

 

查询指定扩展板卡

修改示例中Baseboard为Motherboard

删除Oem.Public.DeviceType字段说明中SMC返回值

修改Oem.Public.DeviceType字段说明中BMCCard中文描述为‘管理板’

新增字段Oem.Public.CPLD1Version及

Oem.Public.CPLD2Version

 

2023-6-20

 

查询设备信息

新增字段Oem.Public.DeviceMaxNum.LiquidCoolerNum

 

2023-6-20

 

查询指定机箱散热资源信息

修改对象Status含义为散热模块整体状态信息；新增字段CoolingMedium、LeakStrategy、对象FanSummary.Status及其下字段、对象LiquidSummary及其下字段、对象LiquidCoolers及其下字段

 

2023-6-20

 

设置指定机箱散热资源信息

标题名称修改为设置指定机箱散热资源信息；功能描述修改为设置指定机箱散热资源信息；新增字段Oem.Public.LeakStrategy

 

2023-6-20

 

查询智能监控服务信息

新增内存监控相关字段

 

2023-6-20

 

设置智能监控服务信息

内存监控功能需要，重新支持该接口

 

2023-6-20

 

查询智能监控内存资源信息

新增接口

 

2023-6-21

 

联合管理添加管理设备资源

修改联合管理添加设备采用任务的方法返回

 

2023-6-21

 

查询智能监控服务信息

新增MemoryPageOfflineEnabled说明

 

2023-6-21

 

设置智能监控服务信息

新增MemoryPageOfflineEnabled说明

 

2023-6-21

 

查询智能监控硬盘资源信息

新增字段DriveList、HistoryDriveUsageRate、PredictedDriveUsageRate 、Name、FreeSpaceMB、UsageRatePercents、Time、TotalCapacityMB

 

2023-6-21

 

查询智能监控服务信息

新增字段DrivesPredictDays、DrivesPredictEnabled、DrivesReportEnabled和DrivesUsageThreshold

 

2023-6-21

 

设置智能监控服务信息

新增字段DrivesPredictDays、DrivesPredictEnabled、DrivesReportEnabled和DrivesUsageThreshold

V1.3.1

2023-6-27

HDM2-1.21

HDM2-1.55

 

 

 

2023-6-27

 

查询智能监控硬盘资源信息

应答示例格式修正

 

2023-7-4

 

查询指定RAID卡信息

新增Actions对象中Storage.ClearConfiguration和Storage.ClearForeignConfiguration字段

 

2023-7-4

 

查询当前根服务资源

新增LicenseService对象显示

V1.3.2

2023-7-7

HDM2-1.22

HDM2-1.56

 

 

 

2023-7-7

 

获取性能顾问信息

 

新增接口

 

2023-7-14

 

查询服务器指定任务资源的信息

修正文档中Messages.Trigger Condition对应字符串内容

 

2023-7-18

 

查询服务器当前升级服务资源的信息

新增字段Oem.Public.BMCFirmwareRestoreEnabled, Oem.Public.BIOSFirmwareRestoreEnabled和Oem.Public.UpgradeTaskRestoreEnabled

 

2023-7-18

 

设置服务器当前升级服务资源的信息

新增接口

 

2023-7-18

 

查询快速安装系统配置信息

新增接口

 

2023-7-18

 

创建快速安装系统配置

新增接口

V1.4

2023-7-22

HDM2-1.22

HDM2-1.57

 

 

 

2023-7-31

 

Redfish概述

Redfish规范版本更新为“ 1.15.1”、 Schema版本更新为“ 2020.3”

V1.5

2023-8-10

HDM2-1.23

HDM2-1.58

 

 

 

2023-8-17

 

添加指定Kerberos用户组

新增Id字段说明并更新Name和@odata.type字段说明

 

2023-8-17

 

查询指定Kerberos的单个用户组资源

新增Id字段说明并更新Name和@odata.type字段说明

 

2023-8-17

 

查询指定扩展卡信息

新增字段Oem.Public.BMCCard.ChipManufacture

Oem.Public.BMCCard.ChipModel

 

2023-8-17

 

查询电源信息

 

新增字段

PowerSupplies.Oem.Public.ManufactureDate

PowerControl.Oem.Public.MinActivePowerCount

 

2023-8-17

 

查询指定系统资源信息

新增BIOS启动最小项

新增字段Oem.Public.NodeType

 

2023-8-17

 

修改指定系统资源属性

新增BIOS启动最小项

 

2023-8-18

 

查询安全仪表信息

 

新增字段LDAPCertificateVerification、

在各配置中新增配置项ID

 

2023-8-18

 

设置安全仪表信息

新增字段LDAPCertificateVerification、

在各配置中新增配置项ID

 

2023-8-18

 

查询用户服务信息

新增字段#LDAPService.ImportLDAPCertificate

 

2023-8-18

 

查询LDAP服务资源

新增字段CertificateVerificationEnabled、CertificateVerificationLevel、 CertificateName

 

2023-8-19

 

修改LDAP服务资源

新增字段CertificateVerificationEnabled、CertificateVerificationLevel

 

2023-8-19

 

LDAP CA证书导入

新增接口

 

2023-8-19

 

查询指定CPU信息

新增字段Oem.Public.ThermalDesignPower

 

2023-8-19

 

查询指定内存条信息

新增字段Oem.Public.CapacityGiB

 

2023-8-19

 

查询指定RAID卡信息

 

新增字段StorageControllers.Oem.Public.InternalPortCount、StorageControllers.Oem.Public.ExternalPortCount

 

2023-8-19

 

查询指定物理盘信息

 

Marvell卡下逻辑盘状态Oem.Public.FirmwareStatus字段取值调整：Ready修改为Unconfigured、Online修改为Configured

 

2023-8-19

 

查询指定逻辑盘信息

 

Marvell卡下逻辑盘状态Oem.Public.FirmwareStatus字段取值调整：修改Optimal为Functional

 

2023-8-19

 

获取串口重定向配置信息

 

ConnectType字段取值调整：删除BMC、RAID取值

 

2023-8-19

 

设置串口重定向配置信息

 

ConnectType字段取值调整：删除BMC、RAID取值

V1.6

2023-9-11

HDM2-1.24

HDM2-1.60

 

 

 

2023-9-15

 

查询电源信息

新增字段PowerControl.PowerLimit.PowerLimitEnable

 

2023-9-19

 

查询指定机箱散热资源信息

查询电源信息

修改传感器阈值不可用时的返回值，从4294967295改为null

 

2023-9-19

 

获取性能顾问信息

接口描述修改为获取性能顾问推荐信息

 

2023-9-21

 

故障告警上报接口

更改名称为：故障告警上报报文示例

V1.6.1

2023-9-27

HDM2-1.24

HDM2-1.61

 

版本号为手册发布是的最新HDM版本，具体支持版本见相关接口【修改记录】

 

2023-9-27

 

获取驱动器Bay的集合信息

查询指定驱动器Bay的信息

新增接口

V1.7

2023-10-8

HDM2-1.24

HDM2-1.62

 

版本号为手册发布是的最新HDM版本，具体支持版本见相关接口【修改记录】

 

2023-10-8

 

设置指定机箱散热资源信息

新增Oem.Public.LeakStrategy字段取值说明

 

2023-10-8

 

添加指定Kerberos用户组

查询指定Kerberos的单个用户组资源

修改指定Kerberos用户组资源

删除GroupRole字段描述中的“目前只支持admin用户”

 

2023-10-8

 

查询网络端口单个资源信息

新增字段Oem.Public.CPUId、Oem.Public.Slot

 

2023-10-8

 

获取平台固件保护恢复（PFR）配置

新增字段CPLDState

 

2023-10-8

 

查询当前根服务资源

新增Oem.Public.SoftwareGenerationId字段

 

2023-10-8

 

查询电源信息

将PowerControl.Oem.Public.CurrentDiskPowerWats字段更改为PowerControl.Oem.Public.CurrentDiskPowerWatts，同时原字段也仍支持

 

2023-10-8

 

查询指定网口信息

设置指定网口信息

新增字段Oem.Public.Ipv4.StaticRoutes.Destination、.SubnetMask、.Gateway、

Oem.Public.Ipv6StaticRoutes.Destination、PrefixLength、Gateway

 

2023-10-8

 

查询指定物理盘信息

新增PMC卡物理盘状态Unsupported

 

2023-10-8

 

查询固件清单信息

将固件清单名称CPLD、SCPLD改为CPLD1、CPLD2，但CPLD、SCPLD仍兼容

 

2023-10-8

 

查询指定物理盘信息

新增Oem.Public.TriMode字段，并针对Protocol字段删除NVME取值

 

2023-10-8

 

查询指定物理盘信息

设置指定物理盘属性

新增Oem.Public.PowerState字段

 

2023-10-8

 

查询LLDP服务配置资源信息

LldpEnabled字段含义从“LLDP发送消息使能”修改为“LLDP状态使能”；WorkMode字段Rx/Tx取值修改为TxRx(并兼容Rx/Tx)，同时新增Tx取值

 

2023-10-8

 

修改LLDP服务资源属性

LldpEnabled字段含义从“LLDP发送消息使能”修改为“LLDP状态使能”，并新增WorkMode字段

 

2023-10-8

 

查询网络适配器单个资源信息

新增字段Oem.Public.CardMode

 

2023-10-8

 

查询网络端口单个资源信息

新增字段Oem.Public.FatherPortNum

 

2023-10-8

 

查询用户服务信息

新增字段WeakPasswordDictionaryName

V1.8

2023-10-20

HDM2-1.25

HDM2-1.63

 

版本号为手册发布时的最新HDM版本，具体支持版本见相关接口【修改记录】

 

2023-10-20

 

查询指定物理盘信息

新增Oem.Public.EEPROMPage1字段

 

2023-10-20

 

查询指定管理资源信息

新增EnclosureName、EnclosureNodeName字段

V1.9

2023-11-16

HDM2-1.65

HDM2-2.02

 

版本号为手册发布时的最新HDM版本，具体支持版本见相关接口【修改记录】

 

2023-11-16

 

故障告警上报报文示例

修改EventId、Oem.Public.specificProblem、Oem.Public.specificProblemID、Oem.Public.EventAssertedSeverity和Severity字段描述

 

2023-11-22

 

查询指定网口信息

Ipv4Addresses.AddressOrigin、Ipv6Addresses.AddressOrigin字段说明从协议类型改为地址获取模式

V1.10

2023-11-24

HDM2-1.66

HDM2-2.03

 

版本号为手册发布时的最新HDM版本，具体支持版本见相关接口【修改记录】

 

2023-11-24

 

查询CPU历史占用率资源信息

查询内存历史占用率资源信息

删除FIST SMS不在位时表示获取CUPS下的内存历史占用率信息

 

2023-11-30

 

查询服务信息

设置服务信息

查询指定服务的详细会话信息

删除指定服务的会话信息

G6 AMD产品支持Ihdt功能

 

2023-11-30

 

重启服务

新增接口

 

2023-12-01

 

查询服务信息

新增返回可执行的操作：重启服务

 

2023-12-01

 

添加用户信息

修改用户信息

参数UserName可设最长长度从16位改为32位

 

2023-12-02

 

查询指定CPU信息

新增Intel On Demand相关信息

 

2023-12-02

 

上传写入Intel On Demand License激活文件

导出CPU状态报告

新增接口

 

2023-12-15

 

查询指定物理盘信息

新增Oem.Public.IsNVMeM2 字段，并对相关“字段说明”增加marvell外购卡配置下NVMe显示情况说明

 

2023-12-15

 

查询指定RAID卡信息

StorageControllers.Oem.Public.ChipManufacturer字段新增Marvell厂商描述； StorageControllers.Oem.Public.SpeedGTps和StorageControllers.SpeedGbps字段新增Marvell外购卡速率显示说明

 

2023-12-15

 

查询网络适配器单个资源信息

新增Oem.Public.MCTPEnabled字段

V1.10.1

2023-12-18

HDM2-1.68

HDM2-2.04

 

版本号为手册发布时的最新HDM版本，具体支持版本见相关接口【修改记录】

 

2024-01-03

 

查询智能监控服务信息

设置智能监控服务信息

查询智能监控内存资源信息

内存智能修复相关字段说明AMD机型不支持；内存修复描述删除其他取值，只保留MRT统一取值

 

2024-01-03

 

涉及共约60个操作类接口

在返回体中Message.ExtendedInfo前添加error节点，并且在error节点下增加code和message字段

 

2024-01-05

 

查询指定物理盘信息

新增MediaErrCount和PredictiveFailureCount字段

 

2024-01-08

 

获取性能顾问推荐信息

NUMAUsageLevel及RecommendedSettings字段功能改为不支持

 

2024-01-10

 

查询指定PCIE卡设备信息

Oem.Public.PCIeCardType字段新增PCIE_AUX取值

 

2024-01-10

 

重启CPLD

更改接口描述，说明支持的CPLDl类型

 

2024-01-10

 

查询电源信息

新增字段PowerControl.Oem.Public.OtherComponentsPowerWatts

 

2024-01-10

 

查询指定扩展卡信息

新增字段Oem.Public.BackPlane.DrivesCount、Oem.Public.BackPlane.PortCount及Oem.Public.BackPlane.Type

 

2024-01-10

 

查询指定PCIE卡功能信息

新增字段Oem.Public.BDF和Oem.Public. RootBDF

 

2024-01-10

 

导出BIOS、BMC和RAID控制器配置

新增Oem.Public.ExportPasswordEnabled字段

 

2024-01-10

 

创建Redfish会话

删除ChangeDefaultPasswordEnabled字段，新增DefaultPasswordModifyPolicy字段

 

2024-01-10

 

查询指定用户信息

添加用户信息

修改用户信息

新增Oem.Public.DefaultPasswordModifyPolicy字段

V1.10.2

2024-02-07

HDM2-1.68

HDM2-2.05

 

版本号为手册发布时的最新HDM版本，具体支持版本见相关接口【修改记录】

 

2024-01-20

 

查询指定管理资源信息

新增DiagnosticService字段

 

2024-01-20

 

查询指定管理资源信息

新增Oem.Public.IsSupportSimulator字段

 

2024-01-22

 

查询指定PCIE卡设备信息

新增Oem.Public.SlotMapping字段

 

2024-01-23

 

查询指定逻辑盘信息

新增RebuildProgress字段

 

2024-01-28

 

修改服务器指定管理资源信息

新增UUID字段

 

2024-02-03

 

获取应急诊断信息

设置应急诊断配置信息

新增接口

 

2024-02-03

 

查询事件日志资源信息

新增EventType字段

 

2024-02-05

 

设置SNMP信息

新增SnmpTrapNotification对象

 

2024-02-06

 

查询NTP信息

新增MinPollingInterval和MaxPollingInterval字段

V1.10.3

2024-03-17

HDM2-1.69

HDM2-2.05

HDM3-1.06

 

版本号为手册发布时的最新HDM版本，具体支持版本见相关接口【修改记录】

 

2024-03-17

HDM3-1.06

 

发布用于HDM3软件，接口支持能力以实际HDM3软件版本为准。说明见支持产品

V1.11

2024-03-19

HDM2-1.69

HDM2-2.06

 

版本号为手册发布时的最新HDM版本，具体支持版本见相关接口【修改记录】

 

2024-03-19

 

查询指定机箱散热资源信息

屏蔽刀片机型冗余信息、健康状态字段，输出刀片机型风扇管理资源状态

 

2024-03-19

 

查询存储介质告警水线

设置存储介质告警水线

新增Life.MajorAlarmLimit字段

 

2024-03-20

 

查询指定逻辑盘信息

新增Oem.Public. RebuildProgress字段

 

2024-03-21

 

查询指定物理盘信息

修改MediaErrCount和PredictiveFailureCount字段描述

 

2024-03-21

 

查询设备信息

修改机箱相关资源

新增Oem.Public.SlotPowerSupply对象

 

2024-03-21

 

查询指定机箱散热资源信息

新增FanSummary.MaxRotorCountSupported和FanSummary.RotorCount字段

 

2024-03-21

 

查询电源信息

新增PowerSupplies.Oem.Public.PowerInputWatts字段

 

2024-03-21

 

查询指定PCIE卡设备信息

新增CardManufacturer和CardModel字段

 

2024-03-21

 

查询指定RAID卡信息

新增StorageControllers.CardManufacturer和StorageControllers.CardModel字段

 

2024-03-21

 

查询指定系统资源信息

新增Oem.Public.ConfigurationModel字段

V1.12

2024-04-22

HDM2-1.70

HDM2-2.07

HDM3-1.08

 

版本号为手册发布时的最新HDM版本，具体支持版本见相关接口【修改记录】与通用说明支持产品

 

 

 

查询电源信息

新增字段PowerControl.Oem.Public. SuggestedActivePowerCount；

V1.13

2024-05-18

HDM2-1.71

HDM2-2.08

HDM3-1.09

 

版本号为手册发布时的最新HDM版本，具体支持版本见相关接口【修改记录】与通用说明支持产品

 

 

 

创建逻辑盘

新增支持LSI 9660，并添加StripSize关于9660的说明

 

 

 

查询指定CPU信息

新增字段Oem.Public.ChipId

 

 

 

设置虚拟媒体配置

虚拟媒体Media.ShareType、Oem.Public.ShareType支持协议http、https

 

 

 

连接虚拟媒体

Image新增连接虚拟媒体支持协议http、https

V1.14

2024-07-23

HDM2-1.73

HDM2-2.10

HDM3-1.14

 

版本号为手册发布时的最新HDM版本，具体支持版本见相关接口【修改记录】与通用说明支持产品

 

 

 

查询指定管理资源信息

新增Manager.NodeSwitch 、Oem.Public.CurrentNodeId 、Oem.Public.MasterNodeId字段

 

 

 

多节点设备节点控制

新增接口

V1.15

2024-07-25

HDM2-1.73

HDM2-2.11

HDM3-1.15

 

版本号为手册发布时的最新HDM版本，具体支持版本见相关接口【修改记录】与通用说明支持产品

 

 

HDM3

查询指定管理资源信息

HDM3暂不支持无线管理资源

 

 

HDM3

查询无线管理资源信息

HDM3暂不支持无线管理资源

 

 

HDM3

修改无线管理资源属性

HDM3暂不支持无线管理资源

 

 

HDM3

修改指定逻辑盘属性

新增Oem.Public.BootEnable字段

 

 

HDM3

修改BIOS密码

UserName字段取值增加PowerOn

 

 

HDM3

修改指定系统资源属性

设置HostName时，默认设置HostNameSetupMode字段值为"Manual"”

 

 

HDM3

查询指定物理盘属性

修订记录增加HDM3 新增支持mediaerr count以及predictive failure count字段

 

 

HDM3

查询指定系统资源信息

飞腾平台不支持Legacy启动模式；

 

 

HDM3

修改指定系统资源属性

飞腾平台不支持Legacy启动模式；

 

 

HDM3

查询设备的机箱资源信息

新增对象Oem.Public.IdleDriveSlots

 

 

HDM3

获取所有空闲槽位集合信息

接口新增

 

 

HDM3

获取指定的空闲槽位信息

接口新增

 

 

HDM3

设置指定的空闲槽位状态

接口新增

 

 

HDM3

查询指定的RAID卡信息

新增对象Oem.Public.IdleDriveSlots

V1.16

2024-08-19

HDM2-1.73

HDM2-2.11

HDM3-1.16

 

版本号为手册发布时的最新HDM版本，具体支持版本见相关接口【修改记录】与通用说明支持产品

 

 

HDM2

查询智能监控服务信息

新增字段MemoryPageOfflineState、MemoryPageOfflineSizeKB、MemoryLevel；

 

 

HDM2

设置智能监控服务信息

新增字段MemoryPageOfflineState、MemoryPageOfflineSizeKB、MemoryLevel；

 

 

HDM3

设置SNMP信息

新增SnmpTrapNotification对象

 

 

HDM3

查询指定逻辑盘信息

新增字段 ["Oem"][Public]["RebuildProgress"] 表示逻辑盘的重建进度

 

 

HDM3

查询指定PCIE卡功能信息

添加新字段Oem.Public.BDF和Oem.Public. RootBDF同步HDM3

 

 

HDM2

查询指定物理盘信息

NVMe盘下Oem.Public.FirmwareStatus字段新增PMR_Failed取值

 

 

HDM3

查询虚拟媒体资源

新增Connected.Oem.Public.ImageType和NotConnected.Oem.Public.ImageType字段

 

 

HDM2

查询服务信息

修改服务信息

查询指定管理资源信息

设置指定管理资源信息

查询可创建会话的服务列表信息

删除Telnet服务字段

 

 

HDM3

查询服务信息

修改服务信息

查询指定管理资源信息

设置指定管理资源信息

查询可创建会话的服务列表信息

删除Telnet服务字段

 

 

HDM2

设置虚拟媒体配置

刷新命令格式示例

 

 

HDM2

查询指定物理盘信息

修正Oem.Public.FirmwareStatus 下Failed的说明

 

 

HDM2

获取性能顾问推荐信息

增加一周的资源利用率OneWeekInterval；增加CPUUsageLevel、MemoryBusUsagelevel、IOBusUsageLevel说明如果数据点不足则显示”N/A”

V1.17

2024-09-11

HDM2-1.73

HDM2-2.12

HDM3-1.17

 

版本号为手册发布时的最新HDM版本，具体支持版本见相关接口【修改记录】与通用说明支持产品

 

 

HDM2

查询指定RAID卡信息

新增字段StorageControllers.Oem.Public.PSOCFirmwareVersion

 

 

HDM2

查询指定机箱散热资源信息

修改刀片机型输出说明，屏蔽冗余信息、健康状态字段，输出风扇管理资源状态

 

 

HDM2

查询指定物理盘信息

新增Oem.Public.FirmwareStatus 下9300卡支持的物理盘状态；

 

 

HDM2

查询指定逻辑盘信息

新增RebuildProgress、VolumeRaidLevel、RedundantType下的功能说明；

 

 

HDM3

连接虚拟媒体

新增Oem.Public.ImageType字段

 

 

HDM3

停止虚拟媒体挂载

新增接口

 

 

HDM3

查询虚拟媒体集合资源

新增字段VirtualMedia.StopMount

V1.1x

2024-09-20

HDM2-1.7x

HDM2-2.1x

HDM3-1.1x

 

版本号为手册发布时的最新HDM版本，具体支持版本见相关接口【修改记录】与通用说明支持产品

1 Redfish概述

Redfish®是一种遵循DMTF组织定义的标准规范和架构。该标准基于RESTful架构，支持HTTP/HTTPs两种请求方式，每个Redfish请求都以UTF-8编码的JSON格式提交并返回一个资源结果。该标准具有降低开发复杂性，易于实施、易于使用而且提供了可扩展性优势，被称为“下一代数据中心管理标准”。

HDM（Hardware Device Management）是H3C自主研发的服务器远程管理系统，支持对服务器通过Redfish API接口进行管理。通过它可以实现简化服务器配置过程、查看服务器组件信息、监控服务器运行状况以及远程控制服务器等功能。

说明

本文档所有的接口仅适用于H3C服务器型号。

本文档所有的描述针对的Redfish规范版本为“ 1.15.1”、 Schema版本为“ 2020.3”。

 

2 Redfish接口通用说明

2.1  命令格式说明

Redfish命令包含请求动作和URI两部分，Redfish客户端允许使用以下通用请求动作。

·     GET，表示获取或查询。

·     POST，表示创建。

·     PATCH，表示更新或修改已有设置。

·     DELETE，表示删除。

设备使用的URI形式通常为https://device_ip/redfish/v1/path，可分为三个部分。

·     第一部分为URI地址（https://device_ip），其中device_ip表示要访问服务器的HDM IP地址。

·     第二部分是服务和版本（/redfish/v1/），当前设备的Redfish是基于redfish v1版本开发的。

·     第三部分表示唯一资源路径（/path）。

此外，部分请求还需要包含请求参数，由请求头和请求体构成，这部分将在Redfish接口中的命令格式部分进行说明。

2.2  ODATA属性说明

Redfish的输出信息中，使用OData属性提供有关资源的信息，例如URL访问的Id，类型，上下文等。下面在表2-1对ODATA属性进行说明。

表2-1 ODATA属性说明

属性

说明

@odata.context

描述上下文URL。

@odata.id

资源的唯一标识符。

@odata.type

表示绝对URL，用于指定资源的类型。

 

2.3  状态码说明

下面表2-2对状态码进行说明。

表2-2 状态码说明

状态码

说明

200

请求成功。

201

创建成功。

202

创建任务执行成功。

204

请求成功，无内容返回。

400

请求参数非法，客户端侧发生错误并返回错误消息。

401

无效的用户请求。（用户权限）

403

服务端拒绝请求。（接口权限）

404

访问请求资源不存在。

405

不支持的操作。

409

请求资源的状态之间存在冲突。

412

先决条件（如 If-Match）检查失败。

428

先决条件丢失。

500

服务端内部错误，比如超时等。

501

所请求的功能当前尚未实现。

503

服务临时过载，当前无法处理请求。

507

服务器无法存储完成请求所必须的内容。

 

2.4  健康状态说明

表2-3 健康状态说明

参数

参数说明

取值

Status.State

字符串

Absent：设备不存在或未检测到

Enabled：设备使能

UnavailableOffline：资源存在，但无法使用

（如RAID卡在位但带外信息获取不到、硬盘在位存储卡信息获取不到、存储整体状态为下电状态等）

Disabled：设备故障或禁用（如内存禁用状态等）

Starting：Bios正在初始化

StandbyOffline：设备在位，需外部操作激活

Status.Health

字符串

"OK"：设备正常

"Warning"：设备出现轻微告警

"Critical"：设备出现严重、紧急告警

注：State为Enabled时该字段才有意义，Disabled/Absent时默认为OK

Status.HealthRollup

字符串

"OK"：设备正常

"Warning"：设备出现轻微告警

"Critical"：设备出现严重、紧急告警

注：State为Enabled时该字段才有意义，Disabled/Absent时默认为OK

Status.Oem.Public.Severity

字符串

自定义健康状态等级：

"Informational"：正常

"Minor"：轻微告警

"Major"：严重告警

"Critical "：紧急告警

 

2.5  接口权限说明

各接口中的权限定义涉及到2种：

1. 【用户权限】：其权限包括：ReadOnly,Operator, Administrator。

2. 【所属权限模块】：各个接口分属不同的功能模块，各模块权限说明如下：

表2-4 权限模块说明

权限模块

权限模块说明

用户配置

ConfigureUsers

包括本地用户配置、LDAP用户配置、AD用户配置、OTP认证、证书认证、SSH密钥管理、License管理、安全擦除、导入/导出配置和HDM联合管理的操作权限。

常规配置

ConfigureComponents

包括设置资产标签、网络配置、设置LLDP、无线管理、NTP配置、SNMP配置、告警设置（SMTP、Trap和Syslog）、事件日志策略设置、清除操作日志、录像回放和安全面板的操作权限。

远程控制

OemKvm

包括存储信息管理、系统资源监控设置、BIOS设置、KVM（电源控制、镜像挂载除外）、H5 KVM（电源控制、镜像挂载除外）、VNC密码管理、系统启动项、UID灯控制、SOL串口设置、MCA策略的操作权限。

远程媒体

OemVmm

包括虚拟媒体配置、KVM镜像挂载、H5 KVM镜像挂载的操作权限。

安全配置

OemSecurityMgmt

包括服务配置、防火墙、SSL证书、PFR固件保护、登录安全性信息配置的操作权限。

电源控制

OemPowerControl

包括电源管理、NMI控制、物理电源按钮控制、风扇配置和智能节能的操作权限。

维护诊断

OemDiagnosis

包括清除事件日志、安装包管理、固件更新、固件库管理、定时任务管理、恢复HDM配置、重启HDM、重启CPLD和服务U盘设置的操作权限。

配置自身

ConfigureSelf

可以配置用户（仅限本地用户）自身的密码。

查询

Login

包括查看HDM主要信息的权限，但不包括查看事件日志、操作日志及通过一键收集下载SDS日志的权限。查询权限中的查看其他用户信息的权限仅适用于Administrator权限用户。

系统审计

OemSystemAudit

包括查看或保存事件日志、操作日志和一键收集下载SDS日志的操作权限。

ConfigureManager

【暂未支持】能够配置管理器资源

 

表2-5 用户角色权限说明

权限模块

权限模块说明

Administrator

"Login",

"ConfigureSelf", 

"ConfigureUsers",

"ConfigureComponents",

"OemKvm",

"OemVmm"",

"OemSecurityMgmt",

"OemPowerControl",

"OemDiagnosis"

"OemSystemAudit"

Operator

"Login",

"ConfigureSelf",

"ConfigureComponents",

"OemKvm",

"OemVmm",

"OemSecurityMgmt",

"OemPowerControl"

"OemSystemAudit"

User

"Login",

"ConfigureSelf"

NoAccess

无任何访问权限

CustomRole1

"Login",

除用户配置外，其他可配

CustomRole2

"Login",

除用户配置外，其他可配

CustomRole3

"Login",

除用户配置外，其他可配

CustomRole4

"Login",

除用户配置外，其他可配

CustomRole5

"Login",

除用户配置外，其他可配

 

2.6  各资源主要功能说明

资源名称

资源主要功能说明

Chassis资源

用于主机物理盘、电源、风扇、UID、PCIe、网卡等设备管理

Systems资源

用于主机CPU、内存、RAID卡、逻辑盘、GPU等设备管理，
用于BIOS选项、KVM、事件日志等资源管理

Managers 资源

用于BMC的网络(NTP、SNMP、SMTP、LLDP、SYSLOG等)，安全(证书、服务)，操作日志，虚拟媒体等资源管理

AccountService 资源

用于BMC的用户管理

SessionService 资源

用于BMC的会话管理

UpdateService 资源

用于BMC的可升级固件资源管理

TaskService 资源

用于BMC的任务管理

EventService 资源

用于BMC的告警事件上报管理

 

2.7  字段值显示空说明

1、字符串类

""：代表获取成功，内容为一个空串；前端正常显示空串；

null：不支持该属性的获取；前端不显示该字段内容，且字段属性名也不显示；

"N/A"：Not Available，不可用，表示该属性是支持获取的，但是当前获取异常，不可用；前端正常显示N/A；

2、数值类

null：不支持该属性的获取；前端不显示该字段内容，且字段属性名也不显示；

0xFFFFFFFF：代表本应该获取到，但是没有获取到；前端判断这个值，显示N/A；redfish侧显示4294967295（=0xFFFFFFFF）

补充说明：

字符串类型或数值类型，"N/A"或0xFFFFFFFF是用于支持获取但获取异常的情况，包括：

1）后端接口报错，redfish仍要显示字段内容；

2）与后端约定表示异常的值；

但对于某个功能未使能，redfish侧使用后端返回的值，比如：IPv6未使能时，redfish侧子网掩码字符串返回空串，子网前缀长度返回0；

2.8  支持产品

本文档描述接口适用于H3C服务器型号，请参考手册《H3C服务器 HDM2用户指南-1.XX》，【适用服务器】章节。

HDM3软件版本的Redfish命令，基于HDM2-1.65开发，若无额外的【修订记录】说明，该HDM2版本后的Redfish功能，在HDM3上默认不支持或暂未开发，请关注后续新版本的命令说明。

2.9  其它说明

Oem.Public.CompletionCode：表示该接口返回的CC值

Oem.Public.Description：表示该接口运行结果的描述信息，默认为"Success"

时间显示格式：2019-02-14T20:21:36+08:00

时区使用说明：仅支持整点或半点

"RSAEncryptionEnabled"：该字段表示前端使用RSA加密，获取时不需要显示

"[email protected]":  该字段表示集合资源成员个数超过100条，分页显示时的下一页链接

"Content":

1、文件传输协议：sftp、https、http、nfs、cifs、tftp，

2、操作路径：不支持中文

3、长度不超过1024，特殊符号支持 @!$^&()_+.;[]{}-=~`，不支持中文

4、本地仅支持”/tmp/web/”

5、tftp协议目录和文件名的总长度最大为240

3 使用方式

3.1  环境安装

方法一：推荐使用网管工具Postman 进行Redfish接口管理。 工具下载链接： https://www.getpostman.com/downloads/ 。

方法二：使用Firefox浏览器的httprequester-2.2-fx.xpi插件 (该插件需要Firefox浏览器版本低于56.0b3(64位))。

4 Redfish接口

4.1  公共固定资源的操作

4.1.1  查询Redfish版本信息

【功能描述】

查询当前使用的Redfish协议的版本号。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish

【请求头】

无

【请求消息体】

无

【参数说明】

表4-1 查询公共固定资源参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6地址

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish

【请求头】

无

【请求消息体】

无

【应答示例】

{

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "v1": "/redfish/v1/"

}

响应码：200

【输出说明】

表4-2 查询Redfish版本信息返回值

字段

类型

字段说明

v1

字符串

Redfish版本信息

 

4.1.2  查询当前根服务资源

【功能描述】

查询当前根服务资源信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1

【请求头】

无

【请求消息体】

无

【参数说明】

表4-3 查询当前根服务资源参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6地址

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1

【请求头】

无

【请求消息体】

无

【应答示例】

{

    "@odata.id": "/redfish/v1",

    "@odata.type": "#ServiceRoot.v1_9_0.ServiceRoot",

    "AccountService": {

        "@odata.id": "/redfish/v1/AccountService"

    },

    "Chassis": {

        "@odata.id": "/redfish/v1/Chassis"

    },

    "EventService": {

        "@odata.id": "/redfish/v1/EventService"

    },

    "Id": "RootService",

    "JsonSchemas": {

        "@odata.id": "/redfish/v1/JsonSchemas"

},

"LicenseService": {

        "@odata.id": "/redfish/v1/LicenseService"

},

    "Links": {

        "Sessions": {

            "@odata.id": "/redfish/v1/SessionService/Sessions"

        }

    },

    "Managers": {

        "@odata.id": "/redfish/v1/Managers"

    },

    "Name": "Root Service",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success",

            "HostName": "HDM222235A022B2B22",

            "Manufacturer": "H3C",

            "Model": "RS32M2C9S",

            "SerialNumber": "222235A022B2B22",

            "SoftwareGenerationId":"2"

        }

},

    "ProtocolFeaturesSupported": {

        "DeepOperations": {

            "DeepPATCH": false,

            "DeepPOST": false

        },

        "ExcerptQuery": false,

        "ExpandQuery": {

            "ExpandAll": true,

            "Levels": true,

            "Links": true,

            "MaxLevels": 5,

            "NoLinks": true

        },

        "FilterQuery": false,

        "OnlyMemberQuery": false,

        "SelectQuery": true

    },

    "RedfishVersion": "1.15.1",

    "Registries": {

        "@odata.id": "/redfish/v1/Registries"

    },

    "SessionService": {

        "@odata.id": "/redfish/v1/SessionService"

    },

    "Systems": {

        "@odata.id": "/redfish/v1/Systems"

    },

    "Tasks": {

        "@odata.id": "/redfish/v1/TaskService"

    },

    "UUID": "36538512-d02a-1000-02f2-aabbccd24718",

    "UpdateService": {

        "@odata.id": "/redfish/v1/UpdateService"

}

}

响应码：200

【输出说明】

表4-4 查询根服务资源信息返回值

字段

类型

字段说明

@odata.context

字符串

根服务资源模型的 OData 描述信息

@odata.id

字符串

根服务资源节点的访问路径

@odata.type

字符串

根服务资源类型

Id

字符串

根服务资源的 ID

Name

字符串

根服务资源的名称

RedfishVersion

字符串

Redfish 的详细版本信息

UUID

字符串

设备的全局唯一标识符

AccountService

对象

用户服务资源

Chassis

对象

机箱信息资源

EventService

对象

事件服务资源

LicenseService

对象

License服务资源

Links

关联服务资源对象

Sessions

对象

会话集合资源

Managers

对象

管理信息资源

Registries

对象

消息归档资源

SessionService

对象

会话服务资源

Systems

对象

系统资源

Tasks

对象

任务服务资源

UpdateService

对象

升级服务资源

JsonSchemas

对象

数组格式的模板资源

Oem.Public.HostName

字符串

指定系统资源的主机名

Oem.Public.Manufacturer

字符串

制造商

Oem.Public.Model

字符串

型号

Oem.Public.SerialNumber

字符串

产品序列号

Oem.Public.SoftwareGenerationId

字符串

BMC软件代次信息

@odata.id

字符串

各扩展资源的访问路径

ProtocolFeaturesSupported

对象

协议扩展功能资源

ProtocolFeaturesSupported.DeepOperations

对象

协议深度支持的操作

ProtocolFeaturesSupported.DeepOperations.DeepPATCH

布尔型

协议是否支持深度PATCH

ProtocolFeaturesSupported.DeepOperations.DeepPOST

布尔型

协议是否支持深度POST

ProtocolFeaturesSupported.ExcerptQuery

布尔型

是否支持excerpt

ProtocolFeaturesSupported.ExpandQuery

对象

协议使用$expand关键字信息

ProtocolFeaturesSupported.ExpandQuery.ExpandAll

布尔型

是否支持$expand星号（`*`）查询参数

ProtocolFeaturesSupported.ExpandQuery.Levels

布尔型

是否支持$expand的$levels查询参数

ProtocolFeaturesSupported.ExpandQuery.Links

布尔型

是否支持$expand波浪号（`~`）查询参数

ProtocolFeaturesSupported.ExpandQuery.MaxLevels

数值

支持$expand的最大$levels参数

ProtocolFeaturesSupported.ExpandQuery.NoLinks

布尔型

是否支持$expand句号（`.`）查询参数

ProtocolFeaturesSupported.FilterQuery

布尔型

是否支持filter查询

ProtocolFeaturesSupported.OnlyMemberQuery

布尔型

是否支持only查询

ProtocolFeaturesSupported.SelectQuery

布尔型

是否支持select查询

【修改记录】

(1)     HDM2-1.55：新增LicenseService对象；

(2)     HDM2-1.61：新增Oem.Public.SoftwareGenerationId字段；

 

4.1.3  查询Metadata文档

【功能描述】

查询Redfish规范里的元数据文档。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/$metadata

【请求头】

无

【请求消息体】

无

【参数说明】

表4-5 查询Metadata文档参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/$metadata

【请求头】

Content-Type:application/json

【请求消息体】

无

【应答示例】

<?xml version="1.0" encoding="UTF-8"?>

<edmx:Edmx xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx" Version="4.0">

    <edmx:Reference Uri="/redfish/v1/schema/AccountService_v1.xml">

        <edmx:Include Namespace="AccountService"/>

        <edmx:Include Namespace="AccountService.v1_0_0"/>

        <edmx:Include Namespace="AccountService.v1_0_2"/>

        <edmx:Include Namespace="AccountService.v1_0_3"/>

        <edmx:Include Namespace="AccountService.v1_0_4"/>

        <edmx:Include Namespace="AccountService.v1_0_5"/>

        <edmx:Include Namespace="AccountService.v1_0_6"/>

        <edmx:Include Namespace="AccountService.v1_0_7"/>

        <edmx:Include Namespace="AccountService.v1_0_8"/>

        <edmx:Include Namespace="AccountService.v1_0_9"/>

        <edmx:Include Namespace="AccountService.v1_0_10"/>

        <edmx:Include Namespace="AccountService.v1_0_11"/>

    ......

    <edmx:Reference Uri="/redfish/v1/schema/VLanNetworkInterface_v1.xml">

        <edmx:Include Namespace="VLanNetworkInterface"/>

        <edmx:Include Namespace="VLanNetworkInterface.v1_0_0"/>

        <edmx:Include Namespace="VLanNetworkInterface.v1_0_1"/>

        <edmx:Include Namespace="VLanNetworkInterface.v1_0_2"/>

        <edmx:Include Namespace="VLanNetworkInterface.v1_0_3"/>

        <edmx:Include Namespace="VLanNetworkInterface.v1_0_4"/>

        <edmx:Include Namespace="VLanNetworkInterface.v1_0_5"/>

        <edmx:Include Namespace="VLanNetworkInterface.v1_0_6"/>

        <edmx:Include Namespace="VLanNetworkInterface.v1_0_7"/>

        <edmx:Include Namespace="VLanNetworkInterface.v1_0_8"/>

        <edmx:Include Namespace="VLanNetworkInterface.v1_0_9"/>

        <edmx:Include Namespace="VLanNetworkInterface.v1_1_0"/>

        <edmx:Include Namespace="VLanNetworkInterface.v1_1_1"/>

        <edmx:Include Namespace="VLanNetworkInterface.v1_1_2"/>

        <edmx:Include Namespace="VLanNetworkInterface.v1_1_3"/>

        <edmx:Include Namespace="VLanNetworkInterface.v1_1_4"/>

        <edmx:Include Namespace="VLanNetworkInterface.v1_1_5"/>

        <edmx:Include Namespace="VLanNetworkInterface.v1_2_0"/>

        <edmx:Include Namespace="VLanNetworkInterface.v1_3_0"/>

    </edmx:Reference>

    <edmx:Reference Uri="/redfish/v1/schema/VLanNetworkInterfaceCollection_v1.xml">

        <edmx:Include Namespace="VLanNetworkInterfaceCollection"/>

    </edmx:Reference>

    <edmx:DataServices>

        <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Service">

            <EntityContainer Name="Service" Extends="ServiceRoot.v1_0_0.ServiceContainer"/>

        </Schema>

    </edmx:DataServices>

    <edmx:Reference Uri="/redfish/v1/schema/OemManager_v1.xml">

        <edmx:Include Namespace="OemManager"/>

    </edmx:Reference>

    <edmx:Reference Uri="/redfish/v1/schema/OemComputerSystem_v1.xml">

        <edmx:Include Namespace="OemComputerSystem"/>

    </edmx:Reference>

    <edmx:Reference Uri="/redfish/v1/schema/OemVirtualMedia_v1.xml">

        <edmx:Include Namespace="OemVirtualMedia"/>

        <edmx:Include Namespace="OemVirtualMedia.v1_0_0"/>

    </edmx:Reference>

    <edmx:Reference Uri="/redfish/v1/schema/OemAccountService_v1.xml">

        <edmx:Include Namespace="OemAccountService"/>

        <edmx:Include Namespace="OemAccountService.v1_0_0"/>

    </edmx:Reference>

    <edmx:Reference Uri="/redfish/v1/schema/OemSession_v1.xml">

        <edmx:Include Namespace="OemSession"/>

        <edmx:Include Namespace="OemSession.v1_0_0"/>

    </edmx:Reference>

</edmx:Edmx>

响应码：200

 

4.1.4  查询服务器当前所有资源的Schema文件

【功能描述】

查询服务器当前所有资源的Schema文件。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/JsonSchemas

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-6 查询服务器当前所有资源的Schema文件参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/JsonSchemas

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.id": "/redfish/v1/JsonSchemas",

    "@odata.context": "/redfish/v1/$metadata#JsonSchemaFileCollection.JsonSchemaFileCollection",

    "@odata.type": "#JsonSchemaFileCollection.JsonSchemaFileCollection",

    "Name": "JsonSchemaFile Collection",

    "Description": "Collection of JsonSchemaFiles",

    "[email protected]": 58,

    "Members": [

        {

            "@odata.id": "/redfish/v1/JsonSchemas/AccountService"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/ActionInfo"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/Assembly"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/AttributeRegistry"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/Bios"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/Certificate"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/CertificateLocations"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/CertificateService"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/Chassis"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/ComputerSystem"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/Drive"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/EthernetInterface"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/Event"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/EventDestination"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/EventService"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/IPAddresses"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/JsonSchemaFile"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/LogEntry"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/LogService"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/Manager"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/ManagerAccount"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/ManagerNetworkProtocol"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/Memory"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/Message"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/MessageRegistry"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/MessageRegistryFile"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/MetricDefinition"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/MetricReport"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/MetricReportDefinition"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/OperatingConfig"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/PCIeDevice"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/PCIeFunction"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/Power"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/Privileges"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/Processor"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/Resource"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/Role"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/Sensor"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/ServiceRoot"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/Session"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/SessionService"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/Settings"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/SoftwareInventory"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/Storage"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/StorageController"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/Task"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/TaskService"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/TelemetryService"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/Thermal"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/Triggers"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/UpdateService"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/VLanNetworkInterface"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/VirtualMedia"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/odata"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/redfish-error"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/redfish-payload-annotations"

        },

        {

            "@odata.id": "/redfish/v1/JsonSchemas/redfish-schema"

        }

    ]

}

响应码：200

【输出说明】

表4-7 查询服务器当前所有资源的Schema文件返回值

字段

类型

字段说明

@odata.context

字符串

Schemas资源模型的OData描述信息

@odata.id

字符串

Schemas资源节点的访问路径

Name

字符串

Schemas资源的名称

Description

字符串

Schemas资源描述

@odata.type

字符串

Schemas资源的类型

[email protected]

数字

当前Schemas资源的数量

Members

Schemas资源列表

@odata.id

字符串

单个Schemas资源节点的访问路径

 

【修改记录】

(1)     HDM-1.30.09 新增接口；

(2)     HDM2-1.57：删除Members中访问Redundance资源节点的路径；

 

4.1.5  查询服务器单个Schema文件归档地址

【功能描述】

查询服务器单个Schema文件归档地址。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/JsonSchemas/schema_name

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-8 查询服务器单个Schema文件归档地址参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

schema_name

Schemas资源节点的访问ID

由查询服务器当前所有资源的Schema文件获取

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/JsonSchemas/Chassis

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#JsonSchemaFile.JsonSchemaFile",

    "@odata.id": "/redfish/v1/JsonSchemas/Chassis",

    "@odata.type": "#JsonSchemaFile.v1_0_2.JsonSchemaFile",

    "Name": "Chassis Schema File",

    "Schema": "#Chassis.Chassis",

    "Description": "Chassis Schema File Location",

    "Id": "Chassis",

    "Languages": [

        "en"

    ],

    "[email protected]": 1,

    "Location": [

        {

            "Language": "en",

            "PublicationUri": "http://redfish.dmtf.org/schemas/v1/Chassis.json",

            "Uri": "/redfish/v1/JsonSchemas/Chassis/Chassis.json"

        }

    ],

    "[email protected]": 1

}

响应码：200

【输出说明】

表4-9 查询服务器单个Schema文件归档地址返回值

字段

类型

字段说明

@odata.context

字符串

归档资源模型的OData描述信息

@odata.id

字符串

归档资源节点的访问路径

@odata.type

字符串

归档资源的类型

Id

字符串

归档资源ID

Name

字符串

归档资源的名称

Description

字符串

归档资源的描述信息

Schema

字符串

归档文件名称

Languages

字符串

语言集

[email protected]

数值

语言集合数量

Location

对象数组

Language

字符串

Schema文件的编码语言

Uri

字符串

链接到该Schema本地可访问的URI

PublicationUri

字符串

链接到Schema可公开访问的URI

[email protected]

数值

Location组数量

 

4.1.6  查询所有归档资源

【功能描述】

查询服务器当前所有的归档文件资源。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Registries

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-10 查询服务器当前所有的归档文件参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Registries

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#Registries",

    "@odata.id": "/redfish/v1/Registries",

    "@odata.type": "#MessageRegistryFileCollection.MessageRegistryFileCollection",

    "Description": "Collection of MessageRegistryFiles",

    "Members": [

        {

            "@odata.id": "/redfish/v1/Registries/Base"

        },

        {

            "@odata.id": "/redfish/v1/Registries/TaskEvent"

        },

        {

            "@odata.id": "/redfish/v1/Registries/ResourceEvent"

        },

        {

            "@odata.id": "/redfish/v1/Registries/OpenBMC"

        }

    ],

    "[email protected]": 4,

    "Name": "MessageRegistryFile Collection",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    }

}

响应码：200

【输出说明】

表4-11 查询服务器当前所有的归档文件返回值

字段

类型

字段说明

@odata.context

字符串

消息归档资源模型的OData描述信息

@odata.id

字符串

消息归档资源节点的访问路径

Name

字符串

消息归档资源的名称

@odata.type

字符串

消息归档资源类型

Description

字符串

消息归档资源的描述信息

[email protected]

数值

消息归档资源包含的扩展资源数

Members

消息归档资源下的扩展资源

@odata.id

字符串

扩展资源的访问路径

 

4.1.7  查询单个归档资源

【功能描述】

查询服务器当前具体的消息归档文件资源。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Registries/registries_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-12 查询服务器当前具体的消息归档文件资源参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

registries_id

扩展资源ID

由查询所有归档资源获取

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Registries/Base

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#Registries/Members/$entity",

    "@odata.id": "/redfish/v1/Registries/Base",

    "@odata.type": "#MessageRegistryFile.v1_1_0.MessageRegistryFile",

    "Description": "DMTF Base Message Registry File Location",

    "Id": "Base",

    "Languages": [

        "en"

    ],

    "[email protected]": 1,

    "Location": [

        {

            "Language": "en",

            "PublicationUri": "https://redfish.dmtf.org/registries/Base.1.8.1.json",

            "Uri": "/redfish/v1/Registries/Base/Base"

        }

    ],

    "[email protected]": 1,

    "Name": "Base Message Registry File",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "Registry": "Base.1.8.1"

}

响应码：200

【输出说明】

表4-13 查询服务器当前具体的消息归档文件资源返回值

字段

类型

字段说明

@odata.context

字符串

消息归档资源模型的OData描述信息

@odata.id

字符串

消息归档资源节点的访问路径

Id

字符串

消息归档资源ID

Name

字符串

消息归档资源的名称

@odata.type

字符串

消息归档资源类型

Description

字符串

消息归档资源的描述信息

Languages

数组

可用模式的语言代码

Registry

字符串

归档文件名称，主要和次要版本的值

[email protected]

数值

Location组数量

Location

数组

Language

字符串

模式所在文件的语言代码

Uri

字符串

链接到本地可用的模式URI

PublicationUri

字符串

链接到Schema可公开访问的URI

 

4.1.8  查询OData服务文档

【功能描述】

查询OData服务文档。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/odata

【请求头】

无

【请求消息体】

无

【参数说明】

表4-14 查询OData服务文档参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/odata

【请求头】

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata",

    "value": [

        {

            "kind": "Singleton",

            "name": "$metadata",

            "url": "/redfish/v1/$metadata"

        },

        {

            "kind": "Singleton",

            "name": "odata",

            "url": "/redfish/v1/odata"

        },

        {

            "kind": "Singleton",

            "name": "JsonSchemas",

            "url": "/redfish/v1/JsonSchemas"

        },

        {

            "kind": "Singleton",

            "name": "Service",

            "url": "/redfish/v1/"

        },

        {

            "kind": "Singleton",

            "name": "ServiceRoot",

            "url": "/redfish/v1/ServiceRoot"

        },

        {

            "kind": "Singleton",

            "name": "Systems",

            "url": "/redfish/v1/Systems"

        },

        {

            "kind": "Singleton",

            "name": "Chassis",

            "url": "/redfish/v1/Chassis"

        },

        {

            "kind": "Singleton",

            "name": "Managers",

            "url": "/redfish/v1/Managers"

        },

        {

            "kind": "Singleton",

            "name": "SessionService",

            "url": "/redfish/v1/SessionService"

        },

        {

            "kind": "Singleton",

            "name": "AccountService",

            "url": "/redfish/v1/AccountService"

        },

        {

            "kind": "Singleton",

            "name": "UpdateService",

            "url": "/redfish/v1/UpdateService"

        }

    ]

}

响应码：200

【输出说明】

表4-15 查询服务器当前具体的消息归档文件资源返回值

字段

类型

字段说明

@odata.context

字符串

OData服务文档资源模型的OData描述信息

value

OData服务文档资源列表

name

字符串

OData服务文档资源名称

kind

字符串

OData服务文档资源类型

url

字符串

OData服务文档资源访问路径

 

4.2  Chassis 资源的操作

4.2.1  查询机箱集合资源信息

【功能描述】

查询系统内的机箱集合资源信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Chassis

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-16 查询机箱集合资源信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Chassis

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#ChassisCollection.ChassisCollection",

    "@odata.id": "/redfish/v1/Chassis",

    "@odata.type": "#ChassisCollection.ChassisCollection",

    "Members": [

        {

            "@odata.id": "/redfish/v1/Chassis/1"

        }

    ],

    "[email protected]": 1,

    "Name": "Chassis Collection",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    }

}

响应码：200

【输出说明】

表4-17 查询机箱集合资源信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

机箱集合资源模型的OData 描述信息

@odata.id

字符串

机箱集合资源的访问路径

@odata.type

字符串

机箱集合资源的类型

Members

机箱资源列表

@odata.id

字符串

单个机箱资源节点的访问路径

[email protected]

数值

机箱资源数量

Name

字符串

机箱集合资源的名称

 

4.2.2  查询设备信息

【功能描述】

查询设备的机箱资源信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Chassis/chassis_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-18 查询主机设备信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

chassis_id

机箱资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Chassis/1

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#Chassis.Chassis",

    "@odata.id": "/redfish/v1/Chassis/1",

    "@odata.type": "#Chassis.v1_14_0.Chassis",

    "AssetTag": "",

    "BoardsSummary": {

        "Count": 4,

        "MaxCountSupported": null,

        "Status": {

            "Health": "OK",

            "HealthRollup": "OK",

            "Oem": {

                "Public": {

                    "FaultDescription": "",

                    "Severity": "Informational"

                }

            },

            "State": "Enabled"

        }

    },

    "ChassisType": "Rack Mount Chassis",

    "Description": "Computer System Chassis",

    "Drives": {

        "@odata.id": "/redfish/v1/Chassis/1/Drives"

    },

    "Id": "1",

    "IndicatorLED": "Off",

    "[email protected]": [

        "Lit",

        "Blinking",

        "Off"

    ],

    "InletHistoryTemperature": {

        "@odata.id": "/redfish/v1/Chassis/1/Thermal/InletHistoryTemperature"

    },

    "Links": {

        "ComputerSystems": [

            {

                "@odata.id": "/redfish/v1/Systems/1"

            }

        ],

        "ManagedBy": [

            {

                "@odata.id": "/redfish/v1/Managers/1"

            }

        ],

        "PCIeDevices": [

            {

                "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/3"

            }

        ]

    },

    "Manufacturer": "New H3C Technologies Co., Ltd.",

    "Model": "R4900_G6",

    "Name": "Computer System Chassis",

    "NetworkAdapters": {

        "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters"

    },

    "Oem": {

        "Public": {

            "Boards": {

                "@odata.id": "/redfish/v1/Chassis/1/Boards"

            },

            "CPUEnergyEfficiency": {

                "@odata.id": "/redfish/v1/Chassis/1/Oem/Public/CPUEnergyEfficiency"

            },

            "CompletionCode": 0,

            "Description": "Success",

            "DeviceMaxNum": {

                "CPUNum": 2,

                "DiskNum": 25,

                "FanNum": 4,

                "LiquidCoolerNum": 1,

                "LogicalDriveNum": 1,

                "MemoryNum": 32,

                "MezzCardNum": null,

                "PCIeNum": 5,

                "PowerSupplyNum": 2,

                "SDCardNum": null,

                "SDContollerNum": null,

                "StorageCardNum": 4

            },

"IdleDriveSlots": {

                "@odata.id": "/redfish/v1/Chassis/1/Oem/Public/IdleDriveSlots"

            },

            "MCAPolicy": "Restart",

            "Mainboard": {

                "BoardName": "111",

                "ChassisPartNumber": "0235AQ7",

                "Manufacturer": "H3C",

                "PartNumber": "0302A5B8",

                "SerialNumber": "210231A8L0H199BI"

            },

            "PowerOnSettings": {

                "@odata.id": "/redfish/v1/Chassis/1/Oem/Public/PowerOnSettings"

            },

"SlotPowerSupply": [

                {

                    "PowerState": "Off",

                    "SlotNumber": "2"

                },

                {

                    "PowerState": "Off",

                    "SlotNumber": "3"

                },

                {

                    "PowerState": "Off",

                    "SlotNumber": "5"

                }

            ]

        }

    },

    "PCIeSummary": {

        "Count": 1,

        "MaxCountSupported": 5,

        "Status": {

            "Health": "OK",

            "HealthRollup": "OK",

            "Oem": {

                "Public": {

                    "FaultDescription": "",

                    "Severity": "Informational"

                }

            },

            "State": "Enabled"

        }

    },

    "PSUSummary": {

        "Count": 1,

        "MaxCountSupported": 2,

        "Status": {

            "Health": "OK",

            "HealthRollup": "OK",

            "Oem": {

                "Public": {

                    "FaultDescription": "",

                    "Severity": "Informational"

                }

            },

            "State": "Enabled"

        }

    },

    "PartNumber": "1234",

    "Power": {

        "@odata.id": "/redfish/v1/Chassis/1/Power"

    },

    "PowerState": "On",

    "SKU": "",

    "Sensors": {

        "@odata.id": "/redfish/v1/Chassis/1/Sensors"

    },

    "SerialNumber": "123",

    "Status": {

        "Health": "Critical",

        "HealthRollup": "Critical",

        "Oem": {

            "Public": {

                "Severity": "Major"

            }

        },

        "State": "Enabled"

    },

    "TemperatureSummary": {

        "Count": null,

        "MaxCountSupported": 28,

        "Status": {

            "Health": "OK",

            "HealthRollup": "OK",

            "Oem": {

                "Public": {

                    "FaultDescription": "",

                    "Severity": "Informational"

                }

            },

            "State": "Enabled"

        }

    },

    "Thermal": {

        "@odata.id": "/redfish/v1/Chassis/1/Thermal"

    }

}

响应码：200

【输出说明】

表4-19 查询主机设备信息输出字段说明

字段

类型

字段说明

@odata.context

字符串

指定机箱资源模型的OData 描述信息

@odata.id

字符串

指定机箱资源的访问路径

@odata.type

字符串

指定机箱资源的类型

Drives

对象

所有物理盘集合访问路径

Id

字符串

指定机箱资源的 ID， 为机箱在机箱集合中的唯一标识

Name

字符串

指定机箱资源的名称

ChassisType

字符串

机箱类型

Description

字符串

指定机箱资源描述

AssetTag

字符串

资产标签

IndicatorLED

字符串

UID灯状态：

"Lit"：常亮

"Blinking"：闪烁

"Off"：关闭

[email protected]

数组

UID灯状态取值数组：

"Lit"：常亮

"Blinking"：闪烁

"Off"：关闭

BoardsSummary/PCIeSummary/

PSUSummary/TemperatureSummary

模块汇总信息

注：X18000机型不支持”PSUSummary”模块

Count

数值

当前数量

MaxCountSupported

数值

最大支持数量

Status

对象

汇总资源的状态， 包括：

Health：汇总资源健康状态

State：汇总资源使能状态

HealthRollup：汇总健康状态[与Health一致]

Oem.Public.FaultDescription：整体故障描述

Oem.Public.Severity：自定义健康状态

说明：整体故障描述关联部件整体故障，独立于单个部件的故障信息；

Drives

对象

硬盘信息资源

InletHistoryTemperature

对象

入风口历史温度资源

Links

关联服务资源

Links.ComputerSystems

数组

系统信息资源

Links.ManagedBy

数组

系统管理资源

Links.PCIeDevices

数组

PCIe设备资源

Power

对象

电源信息资源

PowerState

字符串

当前主机状态：

On

Off

Thermal

对象

机箱散热信息

Manufacturer

字符串

制造商

Model

字符串

型号

NetworkAdapters

对象

网络适配器资源

SKU

字符串

SKU编码

SerialNumber

字符串

产品序列号

PartNumber

字符串

产品部件号

Sensors

对象

传感器资源

PowerOnSettings

对象

电源恢复策略资源

Status

对象

指定管理资源的状态， 包括：

Health：管理资源健康状态

State：管理资源使能状态

HealthRollup：整体健康状态

Oem.Public.Severity：自定义健康状态

Oem.Public

自定义属性

Oem.Public.Boards

对象

扩展板资源

Oem.Public.CPUEnergyEfficiency

对象

CPU节能资源

Oem.Public.DeviceMaxNum.CPUNum

数值

单板部件CPU最大个数

Oem.Public.DeviceMaxNum.FanNum

数值

单板部件风扇模组最大个数

Oem.Public.DeviceMaxNum.MemoryNum

数值

单板部件内存最大个数

Oem.Public.DeviceMaxNum.PowerSupplyNum

数值

单板部件电源最大个数

Oem.Public.DeviceMaxNum.PCIeNum

数值

PCIe卡最大个数

Oem.Public.DeviceMaxNum.DiskNum

数值

硬盘最大个数

Oem.Public.DeviceMaxNum.LiquidCoolerNum

数值

液冷装置最大个数

Oem.Public.DeviceMaxNum.LogicalDriveNum

数值

逻辑盘最大个数

Oem.Public.DeviceMaxNum.MezzCardNum

数值

Mezz卡最大个数

Oem.Public.DeviceMaxNum.SDCardNum

数值

SD卡最大个数

Oem.Public.DeviceMaxNum.SDContollerNum

数值

SD控制器最大个数

Oem.Public.DeviceMaxNum.StorageCardNum

数值

最大存储卡数量

Oem.Public.IdleDriveSlots

对象

空闲槽位集合资源

Oem.Public.MCAPolicy

字符串

Restart：MCA故障主机重启

NoAction：MCA故障主机不重启

Oem.Public.SlotPowerSupply

对象

智能网卡按槽位上电的上电状态与槽位号

Oem.Public.SlotPowerSupply.PowerState

字符串

上电状态

Oem.Public.SlotPowerSupply.SlotNumber

字符串

槽位号

Oem.Public.Mainboard.BoardName

字符串

主板产品名称 (R6900、R8900是中置背板的产品名称)

Oem.Public.Mainboard.ChassisPartNumber

字符串

主板chassis域部件号 (R6900、R8900是中置背板的产品名称)

Oem.Public.Mainboard.Manufacturer

字符串

主板制造商 (R6900、R8900是中置背板的产品名称)

Oem.Public.Mainboard.PartNumber

字符串

主板部件号 (R6900、R8900是中置背板的产品名称)

Oem.Public.Mainboard.SerialNumber

字符串

主板序列号(R6900、R8900是中置背板的序列号)

Oem.Public.Boards

对象

Boards资源的访问路径

 

【修改记录】

(1)     HDM2-1.54：新增字段LiquidCoolerNum；

(2)     HDM2-2.04：新增对象Oem.Public.SlotPowerSupply，修改Oem.Public.DeviceMaxNum.FanNum字段描述；

(3)     HDM3-1.15：新增对象Oem.Public.IdleDriveSlots；

 

4.2.3  修改机箱相关资源

【功能描述】

设置UID灯的状态，可设置为常亮、关闭、闪烁；设置MCA策略；

【所属权限模块】

远程控制

【所属系统锁定类型】

BMC配置锁定（仅当设置MCA时）

【命令格式】

PATCH https://device_ip/redfish/v1/Chassis/chassis_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:ifmatch_value

【请求消息体】

{

"IndicatorLED": ledstate,

"Oem":{

      "Public":{

          "MCAPolicy":policy,

"SlotPowerSupply": [

               {

                   "PowerState": "Off",

                   "SlotNumber": "2"

               },

               {

                   "PowerState": "Off",

                   "SlotNumber": "3"

               },

               {

                   "PowerState": "Off",

                   "SlotNumber": "5"

               }

            ]

}

}

}

【参数说明】

表4-20 修改机箱相关资源参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

chassis_id

机箱资源的ID

当前所有机型取值为1

ifmatch_value

请求消息的匹配参数

可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）

IndicatorLED

字符串

Lit：常亮；

Off：关闭；

Blinking：闪烁

Oem.Public.MCAPolicy

字符串

Restart 主动重启

NoAction 不主动重启

Oem.Public.SlotPowerSupply

对象

智能网卡按槽位上电的上电状态与槽位号

Oem.Public.SlotPowerSupply.PowerState

字符串

上电状态

Oem.Public.SlotPowerSupply.SlotNumber

字符串

槽位号

 

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/Chassis/1

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

  "IndicatorLED":"Lit",

  "Oem":{

      "Public":{

          "MCAPolicy":"Restart",

"SlotPowerSupply": [

                {

                    "PowerState": "Off",

                    "SlotNumber": "2"

                },

                {

                    "PowerState": "Off",

                    "SlotNumber": "3"

                },

                {

                    "PowerState": "Off",

                    "SlotNumber": "5"

                }

            ]

      }

  }

}

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#Chassis.Chassis",

    "@odata.id": "/redfish/v1/Chassis/1",

    "@odata.type": "#Chassis.v1_14_0.Chassis",

    "AssetTag": "",

    "BoardsSummary": {

        "Count": 4,

        "MaxCountSupported": null,

        "Status": {

            "Health": "OK",

            "HealthRollup": "OK",

            "Oem": {

                "Public": {

                    "FaultDescription": "",

                    "Severity": "Informational"

                }

            },

            "State": "Enabled"

        }

    },

    "ChassisType": "Rack Mount Chassis",

    "Description": "Computer System Chassis",

    "Drives": {

        "@odata.id": "/redfish/v1/Chassis/1/Drives"

    },

    "Id": "1",

    "IndicatorLED": "Lit",

    "[email protected]": [

        "Lit",

        "Blinking",

        "Off"

    ],

    "InletHistoryTemperature": {

        "@odata.id": "/redfish/v1/Chassis/1/Thermal/InletHistoryTemperature"

    },

    "Links": {

        "ComputerSystems": [

            {

                "@odata.id": "/redfish/v1/Systems/1"

            }

        ],

        "ManagedBy": [

            {

                "@odata.id": "/redfish/v1/Managers/1"

            }

        ],

        "PCIeDevices": [

            {

                "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/3"

            }

        ]

    },

    "Manufacturer": "New H3C Technologies Co., Ltd.",

    "Model": "R4900_G6",

    "Name": "Computer System Chassis",

    "NetworkAdapters": {

        "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters"

    },

    "Oem": {

        "Public": {

            "Boards": {

                "@odata.id": "/redfish/v1/Chassis/1/Boards"

            },

            "CPUEnergyEfficiency": {

                "@odata.id": "/redfish/v1/Chassis/1/Oem/Public/CPUEnergyEfficiency"

            },

            "CompletionCode": 0,

            "Description": "Success",

            "DeviceMaxNum": {

                "CPUNum": 2,

                "DiskNum": 25,

                "FanNum": 4,

                "LiquidCoolerNum": 1,

                "LogicalDriveNum": 1,

                "MemoryNum": 32,

                "MezzCardNum": null,

                "PCIeNum": 5,

                "PowerSupplyNum": 2,

                "SDCardNum": null,

                "SDContollerNum": null,

                "StorageCardNum": 4

            },

            "MCAPolicy": "Restart",

            "Mainboard": {

                "BoardName": "111",

                "ChassisPartNumber": "0235AQ7",

                "Manufacturer": "H3C",

                "PartNumber": "0302A5B8",

                "SerialNumber": "210231A8L0H199BI"

            },

            "PowerOnSettings": {

                "@odata.id": "/redfish/v1/Chassis/1/Oem/Public/PowerOnSettings"

            },

"SlotPowerSupply": [

                {

                    "PowerState": "Off",

                    "SlotNumber": "2"

                },

                {

                    "PowerState": "Off",

                    "SlotNumber": "3"

                },

                {

                    "PowerState": "Off",

                    "SlotNumber": "5"

                }

            ]

        }

    },

    "PCIeSummary": {

        "Count": 1,

        "MaxCountSupported": 5,

        "Status": {

            "Health": "OK",

            "HealthRollup": "OK",

            "Oem": {

                "Public": {

                    "FaultDescription": "",

                    "Severity": "Informational"

                }

            },

            "State": "Enabled"

        }

    },

    "PSUSummary": {

        "Count": 1,

        "MaxCountSupported": 2,

        "Status": {

            "Health": "OK",

            "HealthRollup": "OK",

            "Oem": {

                "Public": {

                    "FaultDescription": "",

                    "Severity": "Informational"

                }

            },

            "State": "Enabled"

        }

    },

    "PartNumber": "1234",

    "Power": {

        "@odata.id": "/redfish/v1/Chassis/1/Power"

    },

    "PowerState": "On",

    "SKU": "",

    "Sensors": {

        "@odata.id": "/redfish/v1/Chassis/1/Sensors"

    },

    "SerialNumber": "123",

    "Status": {

        "Health": "Critical",

        "HealthRollup": "Critical",

        "Oem": {

            "Public": {

                "Severity": "Major"

            }

        },

        "State": "Enabled"

    },

    "TemperatureSummary": {

        "Count": null,

        "MaxCountSupported": 28,

        "Status": {

            "Health": "OK",

            "HealthRollup": "OK",

            "Oem": {

                "Public": {

                    "FaultDescription": "",

                    "Severity": "Informational"

                }

            },

            "State": "Enabled"

        }

    },

    "Thermal": {

        "@odata.id": "/redfish/v1/Chassis/1/Thermal"

    }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回字段说明同【查询设备信息】

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

(2)     HDM2-2.04：新增对象Oem.Public.SlotPowerSupply；

 

4.2.4  获取所有物理盘集合信息

【功能描述】

获取所有物理盘（NVMe和HDD等）集合信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Chassis/chassis_id/Drives

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-21 获取所有物理盘集合信息

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

chassis_id

机箱资源的ID

当前所有机型取值为1

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

 

【使用实例】

【请求样例】

GET https://172.16.20.162/redfish/v1/Chassis/1/Drives

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#DriveCollection.DriveCollection(*)",

    "@odata.id": "/redfish/v1/Chassis/1/Drives",

"@odata.type": "#DriveCollection.DriveCollection",

"AlarmThreshold": {

    "@odata.id": "/redfish/v1/Chassis/1/Drives/AlarmThreshold"

},

    "Members": [

        {

            "@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront1"

        },

        {

            "@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront2"

        },

        {

            "@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront3"

        }

    ],

    "[email protected]": 3,

"Name": "Drives Collection",

"Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    }

}

响应码：200

【输出说明】

表4-22 获取所有物理盘集合输出参数说明

字段

类型

字段说明

@odata.context

字符串

物理盘集合信息模型的OData 描述信息

@odata.id

字符串

物理盘集合信息资源的访问路径

@odata.type

字符串

物理盘集合信息资源的类型

AlarmThreshold

对象

获取存储介质告警水线

Members

数组

物理盘资源的访问路径

[email protected]

数值

物理盘个数

Name

字符串

物理盘资源信息名称

 

4.2.5  查询指定物理盘信息

【功能描述】

查询指定的物理盘信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Chassis/chassis_id/Drives/driver_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-23 查询指定物理盘信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

chassis_id

机箱资源的ID

当前所有机型取值为1

driver_id

硬盘ID

由获取所有物理盘集合信息中查询

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【使用实例1】

#获取未参与逻辑盘组建的物理盘的信息

【请求样例】

GET http://192.168.18.18/redfish/v1/Chassis/1/Drives/DiskFront3

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context":"/redfish/v1/$metadata#Drive.Drive(*)",

    "@odata.id":"/redfish/v1/Chassis/1/Drives/DiskFront3",

    "@odata.type":"#Drive.v1_11_0.Drive",

    "CapableSpeedGbs":12,

    "CapacityBytes":599584145408,

    "HotspareType":"Dedicated",

    "Id":"DiskFront3",

    "IndicatorLED":"Lit",

    "Links":{

        "Volumes":[

 

        ]

    },

    "Location":[

        {

            "Info":"Front3",

            "InfoFormat":"DeviceName"

        }

    ],

"Manufacturer":"SEAGATE",

"MediaErrCount": null,

"MediaType":"HDD",

    "Model":"ST600MP0005",

    "Name":"DiskFront3",

    "NegotiatedSpeedGbs":12,

    "Oem":{

        "Public":{

            "CapableSpeedGTs":null,

"CapacityGB":"600GB",

            "CompletionCode":0,

            "ConnectionID":156,

            "Description":"Success",

            "DriveNumberInBios":"3",

            "DriveNumberInOS":"3",

"EEPROMPage1":null,

            "FirmwareStatus":"HotSpare",

            "ForeignState":false,

            "HoursOfPoweredUp":null,

"IsNVMeM2": false,

            "NegotiatedSpeedGTs":null,

            "OwnerNode":null,

            "Panel":"Front3",

"PowerState":null,

"PredictedMediaLifeLeftDays": null,

"RawCapacity":"600GB",

            "RebuildProgress":null,

            "SASAddress":[

                "5764824129363309997",

                "0000000000000000000"

            ],

            "SASSmartInformation":null,

            "SATASmartInformation ":[

                {

                    "AttributeName":"RawReadErrorRate",

                    "ID":1,

                    "Thresh":44,

                    "Value":82,

                    "Worst":63,

                    "RawValue":100

                }

            ],

            "SpareforLogicalDrives":[

                {

                    "@odata.id":"/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes/LogicalDrive0"

                }

            ],

            "SupportedConfigurationOperation":[

                "ClearHotSpare"

            ],

"SystemDiskNumber":null,

            "TemperatureCelsius":46,

"TriMode":false,

            "PatrolState":"DoneOrNotPatrolled",

            "RebuildState":"DoneOrNotRebuilt"

        }

    },

"PredictedMediaLifeLeftPercent":null,

"PredictiveFailureCount":null,

    "Protocol":" SATA",

    "Revision":"N003",

    "SerialNumber":"S7M12N93",

    "Status":{

        "Health":"OK",

        "Oem":{

            "Public":{

                "FaultDescription":"",

                "Severity":"Informational"

            }

        },

        "State":"Enabled"

    },

    "StatusIndicator":"Hotspare"

}

响应码：200

【使用实例2】

#获取参与逻辑盘组建的物理盘信息

【请求样例】

GET http://192.168.18.18/redfish/v1/Chassis/1/Drives/DiskFront0

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context":"/redfish/v1/$metadata#Drive.Drive(*)",

    "@odata.id":"/redfish/v1/Chassis/1/Drives/DiskFront0",

    "@odata.type":"#Drive.v1_4_0.Drive",

    "CapableSpeedGbs":12,

    "CapacityBytes":599584145408,

    "HotspareType":"None",

    "Id":"DiskFront0",

    "IndicatorLED":"Lit",

    "Links":{

        "Volumes":[

            {

                "@odata.id":"/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes/LogicalDrive239"

            }

        ]

    },

    "Location":[

        {

            "Info":"Front0",

            "InfoFormat":"DeviceName"

        }

    ],

"Manufacturer":"HGST",

"MediaErrCount": null,

    "MediaType":"HDD",

    "Model":"HUC101860CS4200",

    "Name":"DiskFront0",

    "NegotiatedSpeedGbs":12,

    "Oem":{

        "Public":{

            "CapableSpeedGTs":null,

"CapacityGB":"600GB",

            "CompletionCode":0,

            "ConnectionID":155,

            "Description":"Success",

            "DriveNumberInBios":"0",

            "DriveNumberInOS":"0",

"EEPROMPage1":null,

            "FirmwareStatus":"Online",

            "ForeignState":false,

            "HoursOfPoweredUp":null,

"IsNVMeM2": false,

            "NegotiatedSpeedGTs":null,

            "OwnerNode":null,

            "OwnerVolume":{

                "Name":"",

                "RaidControllerID":0,

                "Status":{

                    "Health":"OK",

                    "State":"Enabled"

                },

                "VolumeRaidLevel":"RAID0",

                "element_num":1

            },

            "Panel":"Front0",

"PowerState":null,

            "PredictedMediaLifeLeftDays": null,

"RawCapacity":"600GB",

"RebuildProgress":null,

            "SASAddress":[

                "5764832511393723981",

                "0000000000000000000"

            ],

            "SASSmartInformation":{

                "AccumulatedLoadUnloadCycles":52,

                "AccumulatedStartStopCycles":36,

                "CycleCountOverDeviceLifetime":50000,

                "DiskTemperatureCelsius":36,

                "DiskTripTemperatureCelsius":65,

                "ElementsInGrownDefectList":0,

                "LoadUnloadCountOverDeviceLifetime":600000,

                "WeekAndYearOfManufacture":"In week 44 Of Year 2022"

            },

            "SATASmartInformation":null,

            "SpareforLogicalDrives":[

 

            ],

            "SupportedConfigurationOperation":[

 

            ],

"SystemDiskNumber":null,

            "TemperatureCelsius":36,

"TriMode":false,

            "PatrolState":"DoneOrNotPatrolled",

            "RebuildState":"DoneOrNotRebuilt"

        }

    },

"PredictedMediaLifeLeftPercent":null,

"PredictiveFailureCount":null,

    "Protocol":" SAS",

    "Revision":"AD02",

    "SerialNumber":"03H3MEHA",

    "Status":{

        "Health":"OK",

        "Oem":{

            "Public":{

                "FaultDescription":"",

                "Severity":"Informational"

            }

        },

        "State":"Enabled"

    },

    "StatusIndicator":"OK"

}

响应码：200

【使用实例3】

#获取NVMe盘的信息

【请求样例】

GET http://192.168.18.18/redfish/v1/Chassis/1/Drives/DiskFront9

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context":"/redfish/v1/$metadata#Drive.Drive(*)",

    "@odata.id":"/redfish/v1/Chassis/1/Drives/DiskFront9",

    "@odata.type":"#Drive.v1_11_0.Drive",

    "CapableSpeedGbs":null,

    "CapacityBytes":299439751168,

    "Id":"DiskFront9",

    "IndicatorLED":"Off",

    "Location":[

        {

            "Info":"Front Slot 9",

            "InfoFormat":"DeviceName"

        }

    ],

"Manufacturer":"Intel",

"MediaErrCount": null,

    "MediaType":"SSD",

    "Model":"SSDPE2MX450G7",

    "Name":"P3520",

    "NegotiatedSpeedGbs":null,

    "Oem":{

        "Public":{

            "CapableSpeedGTs":8,

"CapacityGB":null,

            "CompletionCode":0,

            "Description":"Success",

            "DriveNumberInBios":"109",

            "DriveNumberInOS":"109",

"EEPROMPage1":null,

            "FirmwareStatus":"Normal",

"IsNVMeM2": false,

            "NegotiatedSpeedGTs":8,

            "OwnerNode":null,

            "Panel":"Front Slot 9",

"PowerState":null,

"PredictedMediaLifeLeftDays": 4294967295,

"RawCapacity":null,

            "SASSmartInformation":null,

            "SATASmartInformation ":null,

"SystemDiskNumber":null,

            "TemperatureCelsius":34,

"TriMode":false

        }

    },

"PredictedMediaLifeLeftPercent":95,

"PredictiveFailureCount":null,

    "Protocol":"PCIe",

    "Revision":"MDV10253",

    "SerialNumber":"",

    "Status":{

        "Health":"OK",

        "Oem":{

            "Public":{

                "FaultDescription":"",

                "Severity":"Informational"

            }

        },

        "State":"Enabled"

    }

} 

响应码：200

【输出说明】

表4-24 查询指定物理盘信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

指定物理盘资源模型的OData 描述信息

@odata.id

字符串

指定物理盘资源的访问路径

@odata.type

字符串

指定物理盘资源的类型

CapacityBytes

数值

物理盘容量

Id

字符串

物理盘ID

Location.Info

字符串

指定驱动器丝印信息

Location.InfoFormat

字符串

指定驱动器丝印格式：

DeviceName

Manufacturer

字符串

厂家

MediaType

字符串

指定物理盘介质类型：

HDD

SSD

IndicatorLED

字符串

定位指示灯状态

Off：关闭

Lit:：常亮

HotspareType

字符串

热备状态

None：未配置热备

Global：全局热备

Dedicated：局部热备

AutoReplace：漫游热备

Model

字符串

硬盘型号

Name

字符串

物理盘名称

NegotiatedSpeedGbs

数值

指定物理盘接口的协商速率(Gbs)

说明：NVMe不支持

CapableSpeedGbs

数值

指定物理盘接口的最大速率（Gbs）

说明：NVMe不支持

Protocol

字符串

指定物理盘遵循协议：

SAS

SATA

PCIe

MediaErrCount

数值

介质错误数量

说明：LSI RAID卡、LSI HBA 9540卡下物理盘支持

PredictiveFailureCount

数值

预测故障错误数量

说明：LSI RAID卡、LSI HBA 9540卡下物理盘支持

Oem.Public.CapacityGB

字符串

物理盘标识容量(GB)

说明：NVMe盘不支持，其中Trimode以及Marvell外购卡配置下的NVMe盘支持

Oem.Public.RawCapacity

字符串

物理盘标识容量

说明：NVMe盘不支持，其中Trimode以及Marvell外购卡配置下的NVMe M.2盘支持

Oem.Public.CapableSpeedGTs

数值

指定物理盘接口的最大速率(GTs)

说明：仅NVMe支持

Marvell外购卡下的NVMe M.2盘不支持

Oem.Public.NegotiatedSpeedGTs

数值

指定物理盘接口的协商速率(GTs)

说明：仅NVMe支持

Marvell外购卡下的NVMe M.2盘不支持

Oem.Public.DriveNumberInBios

字符串

Bios下编号

说明：对于NVMe，非Trimode以及非Marvell外购卡下的NVMe M.2配置时为PCIe槽位号

Oem.Public.DriveNumberInOS

字符串

系统下编号

说明：对于NVMe，非Trimode以及非Marvell外购卡下的NVMe M.2配置时为PCIe槽位号

Oem.Public.SystemDiskNumber

字符串

系统盘编号

Oem.Public.FirmwareStatus

字符串

指定物理盘状态：

LSI-9300卡

Ready：Ready

UnconfiguredBad：配置异常

Failed：故障

PFA：预故障

 

LSI其它卡

Ready：Ready

UnconfiguredGood：未配置

UnconfiguredBad：配置异常

HotSpare：热备盘

Offline：离线

Failed：故障

Rebuilding：重建

Optimal：Optimal

Online：已配置

JBOD：JBOD

Unknown：未知

PFA：预故障

Copyback：回拷

 

PMC卡

Offline：离线

Failed：故障

PFA：预故障

Raw：RAW状态

Hotspare：热备盘

Ready：准备好

Optimal：Optimal

Unsupported：不支持创建逻辑盘

Unknown：未知

 

Marvell自研卡：

Unconfigured：未配置

Configured：已配置

PFA：预故障

 

Marvell外购卡：

Idle：正常状态且不作为成员盘

Assigned：正常状态且作为成员盘

PFA：硬盘预故障

Failed：硬盘故障

 

NVMe盘：

"Spare_below"       

"Temp_Anomaly"

"Subsys_Degraded"

"Read_only"

"Cache_Failed"

"PMR_Failed"

"Normal"

"Abnormal"

"Predict_Fail"

Oem.Public.Panel

字符串

位置信息

Oem.Public.ConnectionID

数值

物理盘连接ID

说明：NVMe盘不支持，其中Trimode配置下NVMe盘支持

Oem.Public.PowerState

字符串

物理盘上下电状态

On：上电

Off：下电

说明：当前仅X18000G6支持

Oem.Public.SASSmartInformation

对象

SAS接口SMART信息

SASSmartInformation. AccumulatedLoadUnloadCycles

数值

驱动器累计Load-Unload次数

SASSmartInformation. AccumulatedStartStopCycles

数值

驱动器累计启停次数

SASSmartInformation. CycleCountOverDeviceLifetime

数值

驱动器生命周期内可以启停的次数

SASSmartInformation. DiskTemperatureCelsius

数值

驱动器当前温度

SASSmartInformation. DiskTripTemperatureCelsius

数值

驱动器温度上限值

SASSmartInformation. ElementsInGrownDefectList

数值

增长列表中的元素

SASSmartInformation. LoadUnloadCountOverDeviceLifetime

数值

驱动器生命周期内可以Load-Unload的次数

SASSmartInformation. WeekAndYearOfManufacture

字符串

生产日期

Oem.Public.SATASmartInformation

对象

SATA接口SMART信息

AttributeName

字符串

SMART属性名称

ID

数值

SMART属性ID

Thresh

数值

SMART属性阈值

Value

数值

SMART属性当前值

Worst

数值

SMART属性最差值

RawValue

数值

SMART属性原始值

Oem.Public.TemperatureCelsius

字符串

硬盘温度，单位摄氏度

Oem.Public.TriMode

布尔

物理盘是否为Trimode配置

PredictedMediaLifeLeftPercent

数值

剩余寿命，不支持显示null

Revision

字符串

硬盘版本

SerialNumber

字符串

硬盘序列号

Status.Health

字符串

物理盘健康状态

Status.State

字符串

物理盘使能状态

Status.State.Oem.Public.Severity

字符串

自定义健康状态

Status.State.Oem.Public.FaultDescription

字符串

故障描述信息

Oem.Public.OwnerVolume.Name

字符串

所属逻辑盘名称

Oem.Public.OwnerVolume.RaidControllerID

字符串

所属逻辑盘RAID卡ID

Oem.Public.OwnerVolume.Status.Health

字符串

所属逻辑盘健康状态

Oem.Public.OwnerVolume.Status.State

字符串

所属逻辑盘使能状态

Oem.Public.OwnerVolume.VolumeRaidLevel

字符串

所属逻辑盘RAID级别

Oem.Public.OwnerVolume.element_num

字符串

所属逻辑盘下物理盘数量

Oem.Public.ForeignState

布尔

物理盘foreign状态

Oem.Public.OwnerNode

字符串

硬盘所属节点信息，无节点时显示null

Oem.Public.SpareforLogicalDrives

数组

局部热备所属逻辑盘列表

SupportedConfigurationOperation

数组

支持的操作列表

MakeUnconfiguredBad

MakeUnconfiguredGood

MakeJBOD

AssignGlobalHotSpareDrive

AssignDedicatedHotSpareDrive

AssignAutoReplaceHotSpareDrive

ClearHotSpare

注：此字段只是一个参考值，不代表实际一定能够执行成功

StatusIndicator

字符串

指定驱动器的状态，包括

OK

Fail

Rebuild

PredictiveFailureAnalysis

Hotspare

InAFailedArray

InACriticalArray

Oem.Public.HoursOfPoweredUp

数值

指定驱动器上电运行时间

Oem.Public.SASAddress

数组

指定驱动器SAS地址

说明：全为0时为无效地址

NVMe M.2盘不支持SAS地址

Oem.Public.PatrolState

字符串

指定驱动器巡检状态，包括：

DoneOrNotPatrolled

Patrolling

Oem.Public.RebuildState

字符串

指定驱动器数据重建状态，包括：

DoneOrNotRebuilt

Rebuilding

Oem.Public.RebuildProgress

字符串

指定驱动器数据重建进度（百分比数据）

Oem.Public.PredictedMediaLifeLeftDays

数值

指定驱动器预测剩余寿命天数

说明：仅NVMe盘支持，其中Trimode以及Marvel外购卡配置下NVMe M.2盘不支持

Oem.Public.EEPROMPage1

字符串

NVME硬盘的切换成VPD的Page的EEPROM数据

说明：仅在X18000G6机型下，P6530RT0192M00和P6530RT0384M00两款E1.SPB6530硬盘支持

Oem.Public.IsNVMeM2

布尔

NVMe M.2盘标志

 

【修改记录】

(1)     HDM2-1.53：对个别“字段说明”针对Trimode配置下NVMe显示情况进行补充说明；

(2)     HDM2-1.54：对个别“字段说明”针对SATA盘Smart信息增加RawValue字段；

(3)     HDM2-1.54：新增RawCapacity字段；

(4)     HDM2-1.56：Marvell卡下物理盘状态Oem.Public.FirmwareStatus字段取值调整：修改Ready为Unconfigured、Online修改为Configured；

(5)     HDM2-1.58：NVMe盘下Oem.Public.FirmwareStatus字段新增Predict_Fail取值；

(6)     HDM2-1.58：新增Oem.Public.TriMode字段，并针对Protocol字段删除NVME取值；

(7)     HDM2-1.59：新增Oem.Public.PowerState字段；

(8)     HDM2-1.60：新增Oem.Public.EEPROMPage1字段，并新增PMC卡物理盘状态Unsupported；

(9)     HDM2-2.03：新增Oem.Public.IsNVMeM2 字段，并对相关“字段说明”增加marvell外购卡配置下NVMe显示情况说明；

(10)     HDM2-2.04：新增MediaErrCount和PredictiveFailureCount字段；

(11)     HDM3-1.14：新增支持MediaErrCount和PredictiveFailureCount字段；

(12)     HDM2-2.12：NVMe盘下Oem.Public.FirmwareStatus字段新增PMR_Failed取值；

(13)     HDM2-2.12：修正Oem.Public.FirmwareStatus 下Failed的说明；

(14)     HDM2-2.10：新增Oem.Public.FirmwareStatus 下9300卡支持的物理盘状态；

 

4.2.6  查询指定物理盘创建热备盘时可选逻辑盘列表

【功能描述】

查询指定物理盘创建热备盘时可选逻辑盘列表。

说明：URL后加?$filter=Type eq x，其中x为2时，获取创建局部热备时可选逻辑盘列表；x为3时获取创建漫游热备时可选逻辑盘列表；默认返回创建局部热备时的可选逻辑盘列表。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Chassis/chassis_id/Drives/driver_id/Oem/Public/OptionalLogicalDrivesforHotspare

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-25 查询指定物理盘创建热备盘时可选逻辑盘列表参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

chassis_id

机箱资源的ID

当前所有机型取值为1

driver_id

硬盘ID

由获取所有物理盘集合信息中查询

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【使用实例】

【请求样例】

GET http://192.168.18.18/redfish/v1/Chassis/1/Drives/DiskFront1/Oem/Public/ OptionalLogicalDrivesforHotspare

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#OptionalLogicalDrivesforHotspare.OptionalLogicalDrivesforHotspare(*)",

    "@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront1/Oem/Public/OptionalLogicalDrivesforHotspare",

    "@odata.type": "#OptionalLogicalDrivesforHotspareColletion.OptionalLogicalDrivesforHotspareCollection",

    "Members": [

      {

            "@odata.id":"/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes/LogicalDrive0"

        }

    ],

    "[email protected]": 1,

    "Name": "OptionalLogicalDrivesforHotspare Collection",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    }

}

响应码：200

【输出说明】

表4-26 查询指定物理盘创建热备盘时可选逻辑盘列表输出参数说明

字段

类型

字段说明

@odata.context

字符串

指定物理盘创建热备时可选逻辑盘资源模型的OData 描述信息

@odata.id

字符串

指定物理盘创建热备时可选逻辑盘资源的访问路径

@odata.type

字符串

指定物理盘创建热备时可选逻辑盘资源的类型

Members

数组

可选逻辑盘的访问路径

[email protected]

数值

可选逻辑盘个数

Name

字符串

可选逻辑盘资源信息名称

 

4.2.7  设置指定物理盘属性

【功能描述】

设置指定的物理盘状态。

【所属权限模块】

远程控制 | 维护诊断

说明：设置定位指示灯状态的权限为维护诊断，设置热备、物理盘状态、物理盘上下电状态权限为远程控制。

【所属系统锁定类型】

硬件配置锁定

【命令格式】

PATCH https://device_ip/redfish/v1/Chassis/chassis_id/Drives/driver_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:ifmatch_value

【请求消息体】

//设置定位指示灯状态

{

  "IndicatorLED": ledstate

}

//设置全局热备盘或取消热备盘

{

  "HotspareType": hotsparetype

}

//设置局部热备盘或漫游热备盘

{

  "HotspareType": "Dedicated",

  "Oem":{

      "Public":{

          "SpareforLogicalDrives":[

              {

                  "@odata.id": volumepath

              }

          ]

      }

  }

}

//设置硬盘状态

{

"Oem":{

       "Public":{

            "FirmwareStatus":diskstate

         }

}

}

//设置硬盘上下电状态

{

"Oem":{

       "Public":{

             "PowerState":powerstate 

         }

}

}

【参数说明】

表4-27 设置指定物理盘属性参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

chassis_id

机箱资源的ID

当前所有机型取值为1

driver_id

硬盘ID

由获取所有物理盘集合信息中查询

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

ifmatch_value

请求消息的匹配参数

可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）

Oem.Public.FirmwareStatus

字符串

UnconfiguredGood：未配置

UnconfiguredBad：配置异常

JBOD：JBOD

注：Unconfigured_Bad和 JBOD状态不支持相互切换。

HotspareType

驱动器的热备状态

None：未配置热备

Global：全局热备

Dedicated：局部热备

AutoReplace：漫游热备

注：LSI卡支持全局和局部热备，PMC卡支持局部和漫游热备

SpareforLogicalDrives

局部/漫游热备所属逻辑盘列表

数组

@odata.id

驱动设置为局部/漫游热备盘时，所关联的逻辑盘访问路径

可通过查询指定物理盘创建热备盘时可选逻辑盘列表获得

如：” /redfish/v1/Systems/1/Storages/RAIDStorage0/

Volumes/LogicalDrive0”

注：只支持目标逻辑盘下的热备盘设置

IndicatorLED

String

定位灯状态：

 Off：关闭

Lit:：常亮

Oem.Public.PowerState

字符串

物理盘上下电状态：

On：上电

Off：下电

说明：当前仅X18000G6支持

 

【使用实例1】

#硬盘点灯

【请求样例】

PATCH http://192.168.18.18/redfish/v1/Chassis/1/Drives/DiskFront3

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

     "IndicatorLED": "Lit"

}

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#Drive.Drive(*)",

    "@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront3",

    "@odata.type": "#Drive.v1_11_0.Drive",

    "CapableSpeedGbs": 12,

    "CapacityBytes": 599584145408,

    "HotspareType": "None",

    "Id": "DiskFront3",

    "IndicatorLED": "Lit",

    "Links": {

        "Volumes": []

    },

    "Location": [

        {

            "Info": "Front3",

            "InfoFormat": "DeviceName"

        }

    ],

"Manufacturer": "SEAGATE",

"MediaErrCount": null,

    "MediaType": "HDD",

    "Model": "ST600MP0005",

    "Name": "DiskFront3",

    "NegotiatedSpeedGbs": 12,

    "Oem": {

        "Public": {

            "CapableSpeedGTs": null,

"CapacityGB":"600GB",

"CompletionCode": 0,

            "ConnectionID": 156,

            "Description": "Success",

            "DriveNumberInBios": "3",

            "DriveNumberInOS": "3",

"EEPROMPage1":null,

            "FirmwareStatus": "Online",

            "ForeignState": false,

            "HoursOfPoweredUp": null,

"IsNVMeM2": false,

"NegotiatedSpeedGTs": null,

            "OwnerNode": null,

            "Panel": "Front3",

"PowerState":null,

"RawCapacity":"600GB",

            "RebuildProgress": null,

"PredictedMediaLifeLeftDays": null,

            "SASAddress": [

                "5764824129363309997",

                "0000000000000000000"

            ],

           "SASSmartInformation": {

                "AccumulatedLoadUnloadCycles": 52,

                "AccumulatedStartStopCycles": 36,

                "CycleCountOverDeviceLifetime": 50000,

                "DiskTemperatureCelsius": 46,

                "DiskTripTemperatureCelsius": 65,

                "ElementsInGrownDefectList": 0,

                "LoadUnloadCountOverDeviceLifetime": 600000,

                "WeekAndYearOfManufacture": "In week 44 Of Year 2022"

            },

            "SATASmartInformation": null,

            "SpareforLogicalDrives": [],

            "SupportedConfigurationOperation": [],

"SystemDiskNumber":null,

            "TemperatureCelsius": 46,

"TriMode":false,

            "PatrolState": "DoneOrNotPatrolled",

            "RebuildState": "DoneOrNotRebuilt"

        }

    },

"PredictedMediaLifeLeftPercent": null,

"PredictiveFailureCount":null,

    "Protocol": " SAS",

    "Revision": "N003",

    "SerialNumber": "S7M12N93",

    "Status": {

        "Health": "OK",

        "Oem": {

            "Public": {

                "FaultDescription": "",

                "Severity": "Informational"

            }

        },

        "State": "Enabled"

    },

    "StatusIndicator": "OK"

}

响应码：200

【使用实例2】

#修改物理盘状态

【请求样例】

PATCH http://192.168.18.18/redfish/v1/Chassis/1/Drives/DiskFront3

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"Oem":{

       "Public":{

               "FirmwareStatus": "UnconfiguredGood"

         }

}

}

【应答示例】

{

    "@odata.context":"/redfish/v1/$metadata#Drive.Drive(*)",

    "@odata.id":"/redfish/v1/Chassis/1/Drives/DiskFront3",

    "@odata.type":"#Drive.v1_4_0.Drive",

    "CapableSpeedGbs":12,

    "CapacityBytes":599584145408,

    "HotspareType":"None",

    "Id":"DiskFront3",

    "IndicatorLED":"Lit",

    "Links":{

        "Volumes":[

 

        ]

    },

    "Location":[

        {

            "Info":"Front3",

            "InfoFormat":"DeviceName"

        }

    ],

    "Manufacturer":"SEAGATE",

"MediaErrCount": null,

    "MediaType":"HDD",

    "Model":"ST600MP0005",

    "Name":"DiskFront3",

    "NegotiatedSpeedGbs":12,

    "Oem":{

        "Public":{

            "CapableSpeedGTs":null,

"CapacityGB":"600GB",

            "CompletionCode":0,

            "ConnectionID":156,

            "Description":"Success",

            "DriveNumberInBios":"3",

            "DriveNumberInOS":"3",

"EEPROMPage1":null,

            "FirmwareStatus":"UnconfiguredGood",

            "ForeignState":false,

            "HoursOfPoweredUp":null,

"IsNVMeM2": false,

            "NegotiatedSpeedGTs":null,

            "OwnerNode":null,

            "Panel":"Front3",

"PowerState":null,

"PredictedMediaLifeLeftDays": null,

"RawCapacity":"600GB",

            "RebuildProgress":null,

            "SASAddress":[

                "5764824129363309997",

                "0000000000000000000"

            ],

            "SASSmartInformation":{

                "AccumulatedLoadUnloadCycles":52,

                "AccumulatedStartStopCycles":36,

                "CycleCountOverDeviceLifetime":50000,

                "DiskTemperatureCelsius":46,

                "DiskTripTemperatureCelsius":65,

                "ElementsInGrownDefectList":0,

                "LoadUnloadCountOverDeviceLifetime":600000,

                "WeekAndYearOfManufacture":"In week 44 Of Year 2022"

            },

            "SATASmartInformation":null,

            "SpareforLogicalDrives":[

 

            ],

            "SupportedConfigurationOperation":[

                "MakeUnconfiguredBad",

                "MakeJBOD",

                "AssignGlobalHotSpareDrive",

                "AssignDedicatedHotSpareDrive"

            ],

"SystemDiskNumber":null,

            "TemperatureCelsius":46,

"TriMode":false,

            "PatrolState":"DoneOrNotPatrolled",

            "RebuildState":"DoneOrNotRebuilt"

        }

    },

    "PredictedMediaLifeLeftPercent":null,

"PredictiveFailureCount":null,

    "Protocol":" SAS",

    "Revision":"N003",

    "SerialNumber":"S7M12N93",

    "Status":{

        "Health":"OK",

        "Oem":{

            "Public":{

                "FaultDescription":"",

                "Severity":"Informational"

            }

        },

        "State":"Enabled"

    },

    "StatusIndicator":"OK"

}

响应码：200

【使用实例3】

#设置专用热备

【请求样例】

PATCH http://192.168.18.18/redfish/v1/Chassis/1/Drives/DiskFront2

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

  "HotspareType":"Dedicated",

  "Oem":{

      "Public":{

          "SpareforLogicalDrives":[

              {

                  "@odata.id":"/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes/LogicalDrive239"

                 

              }

          ]

      }

  }

}

【应答示例】

{

  "@odata.context": "/redfish/v1/$metadata#Drive.Drive(*)",

  "@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront2",

  "@odata.type": "#Drive.v1_11_0.Drive",

  "CapableSpeedGbs": 6.0,

  "CapacityBytes": 1919816826880,

  "HotspareType": "None",

  "Id": "DiskFront2",

  "IndicatorLED": "Off",

  "Links": {

    "Volumes": []

  },

  "Location": [

    {

      "Info": "Front2",

      "InfoFormat": "DeviceName"

    }

  ],

  "Manufacturer": "Seagate",

"MediaErrCount": null,

  "MediaType": "SSD",

  "Model": "XA1920LE10063",

  "Name": "DiskFront2",

  "NegotiatedSpeedGbs": 6.0,

  "Oem": {

    "Public": {

      "CapableSpeedGTs": null,

"CapacityGB":"1920GB",

      "CompletionCode": 0,

      "ConnectionID": 34,

      "Description": "Success",

      "DriveNumberInBios": "2",

      "DriveNumberInOS": "2",

"EEPROMPage1":null,

      "FirmwareStatus": "UnconfiguredGood",

      "ForeignState": false,

      "HoursOfPoweredUp": 880,

"IsNVMeM2": false,

      "NegotiatedSpeedGTs": null,

      "OwnerNode": null,

      "Panel": "Front2",

      "PatrolState": "DoneOrNotPatrolled",

"PowerState":null,

      "PredictedMediaLifeLeftDays": null,

"RawCapacity":"1.92TB",

      "RebuildProgress": null,

      "RebuildState": "DoneOrNotRebuilt",

      "SASAddress": [

        "300062B20EC1FB02",

        "0000000000000000"

      ],

      "SASSmartInformation": null,

      "SATASmartInformation": [

        {

          "AttributeName": "N/A",

          "ID": 1,

          "Thresh": 0,

          "Value": 100,

          "Worst": 100

        },

        ...

        {

          "AttributeName": "N/A",

          "ID": 243,

          "Thresh": 0,

          "Value": 37,

          "Worst": 23

        }

      ],

      "SpareforLogicalDrives": [],

      "SupportedConfigurationOperation": [

        "MakeUnconfiguredBad",

        "MakeJBOD",

        "AssignGlobalHotSpareDrive",

        "AssignDedicatedHotSpareDrive"

      ],

"SystemDiskNumber":null,

      "TemperatureCelsius": 33,

"TriMode":false

    }

  },

  "PredictedMediaLifeLeftPercent": 100,

"PredictiveFailureCount":null,

  "Protocol": "SATA",

  "Revision": "00ZU",

  "SerialNumber": "HKS015WZ",

  "Status": {

    "Health": "OK",

    "Oem": {

      "Public": {

        "FaultDescription": "",

        "Severity": "Informational"

      }

    },

    "State": "Enabled"

  },

  "StatusIndicator": "OK"

}

响应码：200

【使用实例4】

#设置物理盘上下电状态

【请求样例】

PATCH http://192.168.18.18/redfish/v1/Chassis/1/Drives/DiskFront10

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

 "Oem": {

       "Public": {

       "PowerState": "On"

       }

  }

 

}

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#Drive.Drive(*)",

   "@odata.id":"/redfish/v1/Chassis/1/Drives/DiskFront10",

    "@odata.type":"#Drive.v1_11_0.Drive",

    "CapableSpeedGbs": null,

    "CapacityBytes": 1920000000000,

    "Id": "DiskFront10",

    "IndicatorLED": "Lit",

    "Location": [

        {

           "Info": "Front Slot 10",

           "InfoFormat": "DeviceName"

        }

    ],

"Manufacturer": "Samsung",

"MediaErrCount": null,

    "MediaType": "SSD",

    "Model": "MZTL21T9HCJR-00A07",

    "Name": "PM9A3",

    "NegotiatedSpeedGbs": null,

    "Oem": {

        "Public": {

           "CapableSpeedGTs": 16,

           "CapacityGB": null,

           "CompletionCode": 0,

           "Description": "Success",

           "DriveNumberInBios": "110",

           "DriveNumberInOS": "110",

"EEPROMPage1":null,

           "FirmwareStatus": "Normal",

"IsNVMeM2": false,

           "NegotiatedSpeedGTs": 16,

           "OwnerNode": null,

           "Panel": "Front Slot 10",

           "PowerState": "On",

           "PredictedMediaLifeLeftDays": 4294967295,

           "RawCapacity": null,

           "SASSmartInformation": null,

           "SATASmartInformation":null,

           "SystemDiskNumber": null,

           "TemperatureCelsius": 37,

           "TriMode": false

        }

    },

"PredictedMediaLifeLeftPercent": 100,

"PredictiveFailureCount":null,

    "Protocol": "PCIe",

    "Revision": "GDC6102Q",

    "SerialNumber":"S6RCNG0T100136",

    "Status": {

        "Health":"OK",

        "Oem": {

           "Public": {

               "FaultDescription": "",

               "Severity": "Informational"

            }

        },

        "State":"Enabled"

    }

}

【输出说明】

返回状态码200，表示操作成功。

返回字段同【查询指定物理盘信息】。

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

(2)     HDM2-1.59：新增字段Oem.Public.PowerState；

 

4.2.8  获取所有空闲槽位集合

【功能描述】

获取所有空闲槽位集合信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Chassis/chassis_id/Oem/Public/IdleDriveSlots

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-28 获取所有物理盘集合信息

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

chassis_id

机箱资源的ID

当前所有机型取值为1

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

 

【使用实例】

【请求样例】

GET https://172.16.20.162/redfish/v1/Chassis/1/Oem/Public/IdleDriveSlots

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#IdleDriveSlotsCollection.IdleDriveSlotsCollection(*)",

    "@odata.id": "/redfish/v1/Chassis/1/Oem/Public/IdleDriveSlots",

"@odata.type": "#IdleDriveSlotsCollection.IdleDriveSlotsCollection ",

    "Members": [

        {

            "@odata.id": "/redfish/v1/Chassis/1/Oem/Public/IdleDriveSlots/Front1"

        },

        {

            "@odata.id": "/redfish/v1/Chassis/1/Oem/Public/IdleDriveSlots/Front2"

        },

        {

            "@odata.id": "/redfish/v1/Chassis/1/Oem/Public/IdleDriveSlots/Front3"

        }

    ],

    "[email protected]": 3,

"Name": "Idle Drive Slots Collection ",

"Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    }

}

响应码：200

【输出说明】

表4-29 获取所有物理盘集合输出参数说明

字段

类型

字段说明

@odata.context

字符串

空闲槽位集合信息模型的OData 描述信息

@odata.id

字符串

空闲槽位集合信息资源的访问路径

@odata.type

字符串

空闲槽位集合信息资源的类型

Members

数组

空闲槽位资源的访问路径

[email protected]

数值

空闲槽位个数

Name

字符串

空闲槽位资源信息名称

 

【修改记录】

(1)     HDM3-1.15：新增接口；

 

4.2.9  获取指定空闲槽位信息

【功能描述】

获取指定的空闲槽位信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Chassis/chassis_id/Oem/Public/IdleDriveSlots/IdleDriveSlots_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-30 获取所有物理盘集合信息

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

chassis_id

机箱资源的ID

当前所有机型取值为1

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

 

【使用实例】

【请求样例】

GET https://172.16.20.162/redfish/v1/Chassis/1/Oem/Public/IdleDriveSlots/Front1

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#IdleDriveSlot.IdleDriveSlot(*)",

    "@odata.id": "/redfish/v1/Chassis/1/Oem/Public/IdleDriveSlots/Front1",

"@odata.type": "#IdleDriveSlot.v1_0_0.IdleDriveSlot",

"Id":"Front1",

"IndicatorLED":"Lit",

"Name": "Front1",

"DrivesSizeSupported": "2.5in",

"Module": "4UniBay",

"InterfaceSupported": "SATA/SAS/U.2(NVMe)",

"Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    }

}

响应码：200

【输出说明】

表4-31 获取所有物理盘集合输出参数说明

字段

类型

字段说明

@odata.context

字符串

空闲槽位集合信息模型的OData 描述信息

@odata.id

字符串

空闲槽位集合信息资源的访问路径

@odata.type

字符串

空闲槽位集合信息资源的类型

Name

字符串

空闲槽位资源信息名称

IndicatorLED

字符串

空闲槽位的定位灯状态

l     Off：关闭

l     Lit:：常亮

DrivesSizeSupported

字符串

空闲槽位支持的硬盘尺寸

l     2.5in

l     3.5in

l     7.5mm

l     9.5mm

l     80mm

l     110mm

l     80mm/110mm

Module

字符串

空闲槽位连接模块的名称

InterfaceSupported

字符串

空闲槽位支持的硬盘接口

l     SATA/SAS

l     SATA/SAS/U.2(NVMe)

l     M.2(SATA)

l     M.2(NVMe)

l     E1.S

l     E3.S

 

【修改记录】

(1)     HDM3-1.15：新增接口；

 

4.2.10  设置指定空闲槽位信息

【功能描述】

设置指定的空闲槽位状态。

【所属权限模块】

维护诊断

【所属系统锁定类型】

硬件配置锁定

【命令格式】

PATCH  https://device_ip/redfish/v1/Chassis/chassis_id/Oem/Public/IdleDriveSlots/IdleDriveSlots_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:ifmatch_value

【请求消息体】

{

"IndicatorLED": "ledstate",

}

【参数说明】

表4-32 获取所有物理盘集合信息

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

chassis_id

机箱资源的ID

当前所有机型取值为1

IdleDriveSlots_id

空闲槽位ID

由获取所有空闲槽位集合信息中查询

ifmatch_value

请求消息的匹配参数

可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

IndicatorLED

String

定位灯状态：

Off：关闭

Lit:：常亮

 

【使用实例】

【请求样例】

PATCH

https://172.16.20.162/redfish/v1/Chassis/1/Oem/Public/IdleDriveSlots/Front1

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

     "IndicatorLED": "Lit"

}

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#IdleDriveSlot.IdleDriveSlot(*)",

    "@odata.id": "/redfish/v1/Chassis/1/Oem/Public/IdleDriveSlots/Front1",

"@odata.type": "#IdleDriveSlot.v1_0_0.IdleDriveSlot",

"Id":"Front1",

"IndicatorLED":"Lit",

"Name": "Front1",

"DrivesSizeSupported": "2.5in",

"Module": 4UniBay,

"InterfaceSupported": "SATA/SAS/U.2(NVMe)",

"Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回字段同【查询指定空闲槽位信息】。

【修改记录】

(1)     HDM3-1.15：新增接口；

 

4.2.11  获取驱动器Bay的集合信息

【功能描述】

获取驱动器Bay的集合信息。

【所属权限模块】

查询模块

【命令格式】

 GET https://device_ip/redfish/v1/Chassis/chassis_id/Oem/Public/DriveBays

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-33 获取驱动器Bay的集合信息

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

chassis_id

机箱资源的ID

当前所有机型取值为1

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

 

【使用实例】

【请求样例】

GET https://172.16.20.162/redfish/v1/Chassis/1/Oem/Public/DriveBays

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context":"/redfish/v1/$metadata#DriveBaysCollection.DriveBaysCollection(*)",

    "@odata.id": "/redfish/v1/Chassis/1/Oem/Public/DriveBays",

    "@odata.type": "#DriveBaysCollection.DriveBaysCollection",

    "Members": [

        {

            "@odata.id": "/redfish/v1/Chassis/1/Oem/Public/DriveBays/Bay5"

        },

        {

            "@odata.id": "/redfish/v1/Chassis/1/Oem/Public/DriveBays/Bay14"

        }

    ],

    "[email protected]": 2,

    "Name": "DriveBays Collection",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    }

}

响应码：200

 

【输出说明】

表4-34 获取驱动器Bay集合输出参数说明

字段

类型

字段说明

@odata.context

字符串

驱动器Bay的集合信息模型的OData 描述信息

@odata.id

字符串

驱动器Bay的集合信息资源的访问路径

@odata.type

字符串

驱动器Bay的集合信息资源的类型

Members

数组

驱动器Bay的集合资源的访问路径

[email protected]

数值

驱动器Bay的集合个数

Name

字符串

驱动器Bay的集合资源信息名称

 

【修改记录】

(1)     HDM2-1.59：新增接口；

 

4.2.12  查询指定驱动器Bay的信息

【功能描述】

查询指定驱动器Bay的信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Chassis/chassis_id/Oem/Public/DriveBays/bay_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-35 查询指定驱动器BAY信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

chassis_id

机箱资源的ID

当前所有机型取值为1

bay_id

Bay的ID

由获取所有DriveBays集合信息中查询

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

 

【使用实例】

【请求样例】

GET https://172.16.20.162/redfish/v1/Chassis/1/Oem/Public/DriveBays/Bay5

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#DriveBay.DriveBay(*)",

    "@odata.id": "/redfish/v1/Chassis/1/Oem/Public/DriveBays/Bay5",

    "@odata.type": "#DriveBay.v1_0_0.DriveBay",

    "DrivesCount": "3",

    "DrivesMaxTemperatureCelsius": "36",

    "Id": "Bay5",

    "Name": "DriveBay Instance",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "SlotNumber": "5",

    "Status": {

        "Health": "Critical",

        "Oem": {

            "Public": {

                "FaultDescription": "[Bay5_Status]Drive Fault",

                "Severity": "Major"

            }

        },

        "State": "Enabled"

    }

}

响应码：200

【输出说明】

表4-36 获取指定驱动器BAY信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

指定驱动器BAY信息模型的OData 描述信息

@odata.id

字符串

指定驱动器BAY信息资源的访问路径

@odata.type

字符串

指定驱动器BAY信息资源的类型

Id

字符串

DriveBay的ID

Name

字符串

DriveBay资源信息名称

DrivesCount

数值

DriveBay下接的硬盘数量

DrivesMaxTemperatureCelsius

数值

DriveBay下接的硬盘最高温度

Status.Health

字符串

DriveBay的健康状态

Status.State

字符串

DriveBay的使能状态

Status.State.Oem.Public.Severity

字符串

DriveBay的自定义健康状态

Status.State.Oem.Public.FaultDescription

字符串

DriveBay的故障描述信息

 

【修改记录】

(1)     HDM2-1.59：新增接口；

 

4.2.13  查询指定机箱散热资源信息

【功能描述】

查询指定服务器机箱的温度和风扇传感器信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Chassis/chassis_id/Thermal

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-37 查询指定机箱散热资源参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

chassis_id

机箱资源的ID

当前所有机型取值为1

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Chassis/1/Thermal

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#Thermal.Thermal",

    "@odata.id": "/redfish/v1/Chassis/1/Thermal",

    "@odata.type": "#Thermal.v1_6_3.Thermal",

    "FanSummary": {

        "Count": 4,

        "MaxCountSupported": 4,

"MaxRotorCountSupported": 8,

        "Redundancy": [

            {

                "Name": "FAN_Redundant",

                "Status": {

                    "Health": "OK",

                    "State": "Enabled"

                }

            }

        ],

"RotorCount": 0,

        "Status": {

            "Health": "OK",

            "HealthRollup": "OK",

            "Oem": {

                "Public": {

                    "FaultDescription": "",

                    "Severity": "Informational"

                }

            },

            "State": "Enabled"

        }

    },

    "Fans": [

        {

            "@odata.id": "/redfish/v1/Chassis/1/Thermal#/Fans/0",

            "MaxReadingRange": 15000,

            "MemberId": "0",

            "MinReadingRange": 0,

            "Name": "Fan1",

            "Oem": {

                "Public": {

                    "Position": "chassis",

                    "SlotNumber": 1,

                    "SpeedRatio": 0

                }

            },

            "PartNumber": "8038",

            "Reading": 0,

            "ReadingUnits": "RPM",

            "Status": {

                "Health": "OK",

                "Oem": {

                    "Public": {

                        "FaultDescription": "",

                        "Severity": "Informational"

                    }

                },

                "State": "Enabled"

            }

        },

…

    ],

    "Id": "Thermal",

    "InletHistoryTemperature": {

        "@odata.id": "/redfish/v1/Chassis/1/Thermal/InletHistoryTemperature"

    },

    "Name": "Thermal",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "CoolingMedium": "AirAndLiquidCooled",

            "Description": "Success",

            "FanSpeedAdjustmentMode": "Silent",

            "LeakStrategy": "ManualPowerOff",

            "LiquidCoolers": [

                {

                    "FaultDescription": "",

                    "MemberId": 0,

                    "Name": "CPU Liquid Cooler1",

                    "Severity": "Informational",

                    "Status": {

                        "Health": "OK",

                        "State": "Enabled"

                    }

                }

            ],

            "LiquidSummary": {

                "Count": 1,

                "FaultDescription": "",

                "MaxCountSupported": 1,

                "Severity": "Informational"

            }

        }

    },

    "Status": {

        "Health": "OK",

        "HealthRollup": "OK",

        "Oem": {

            "Public": {

                "FaultDescription": "",

                "Severity": "Informational"

            }

        },

        "State": "Enabled"

    },

    "Temperatures": [

        {

            "@odata.id": "/redfish/v1/Chassis/1/Thermal#/Temperatures/0",

            "LowerThresholdCritical": null,

            "LowerThresholdFatal": null,

            "LowerThresholdNonCritical": null,

            "MemberId": "0",

            "Name": "Inlet_Temp",

            "Oem": {

                "Public": {

                    "OceanTemperatureXCoordinate": 8,

                    "OceanTemperatureYCoordinate": 0,

                    "OceanTemperatureZCoordinate": 0,

                    "ThresholdMask": 16152

                }

            },

            "PhysicalContext": "Room",

            "ReadingCelsius": 4294967295,

            "SensorNumber": 1,

            "Status": {

                "Health": "OK",

                "Oem": {

                    "Public": {

                        "Severity": "Informational"

                    }

                },

                "State": "Disabled"

            },

            "UpperThresholdCritical": 52.0,

            "UpperThresholdFatal": null,

            "UpperThresholdNonCritical": 50.0

        },

…

    ]

}

响应码：200

【输出说明】

表4-38 查询指定机箱散热资源输出参数说明

字段

类型

字段说明

@odata.context

字符串

散热资源模型的 OData 描述信息

@odata.id

字符串

散热资源的访问路径

@odata.type

字符串

散热资源的类型

Id

字符串

散热资源 ID

Name

字符串

散热资源名称

InletHistoryTemperature

对象

查询进风口历史温度资源信息

Oem.Public.FanSpeedAdjustmentMode

字符串

调速模式：

"Silent"：静音模式

"Balanced"：均衡模式

"Powerful"：强劲模式

"Custom"：自定义

Oem.Public.FanSpeedLevelPercents

数值

风扇调速档位，档位越高，风扇的转速越高，设置范围1~20。

注意只有当FanSpeedAdjustmentMode 等于Custom 时此字段才存在

FanSummary.Count

数值

当前在位风扇模组数量

FanSummary.MaxCountSupported

数值

最大支持的风扇模组数量

FanSummary.MaxRotorCountSupported

数值

最大支持的风扇转子数量

FanSummary.RotorCount

数值

当前在位风扇转子数量

FanSummary.Redundancy

对象

风扇冗余信息，刀片产品此字段为空

FanSummary.Redundancy.Name

字符串

风扇冗余传感器名称

FanSummary.Redundancy.Status

对象

State：风扇冗余传感器使能状态

Health：风扇冗余状态

FanSummary.Status

对象

风扇整体状态信息

HealthRollup：风扇整体健康状态（与Health一致）

Health：风扇健康状态

State：风扇使能状态

Severity：自定义健康状态

FaultDescription：整体故障描述

说明：整体故障描述关联部件整体故障，独立于单个部件的故障信息，刀片产品除Status字段，其余为null

Status

对象

散热模块整体状态信息

HealthRollup：散热模块整体健康状态（与Health一致）

Health：散热模块健康状态

State：散热模块使能状态

Severity：自定义健康状态

FaultDescription：整体故障描述

说明：整体故障描述关联部件整体故障，独立于单个部件的故障信息，刀片产品除Status字段，其余为null

Fans

风扇控制信息

@odata.id

字符串

风扇散热资源的访问路径

Name

字符串

风扇名称

MaxReadingRange

数值

风扇转速规格最大值

MinReadingRange

数值

风扇转速最小值

MemberId

字符串

风扇ID

Reading

数值

风扇当前转速

PartNumber

字符串

部件号

ReadingUnits

字符串

指定风扇传感器读取到的风扇转速的单位，包括：

RPM

Status

对象

指定风扇管理资源的状态， 包括：

Health：风扇健康状态

State：风扇使能状态

Severity：自定义健康状态

FaultDescription：故障描述信息

说明：刀片产品除Status字段，其余为null

Oem.Public.SpeedRatio

数值

转速比

Oem.Public.Position

字符串

指定风扇传感器的容器

Oem.Public.SlotNumber

数值

指定风扇传感器的槽位号

Temperatures

温度传感器列表

@odata.id

字符串

温度传感器散热资源的访问路径

MemberId

字符串

指定温度传感器的 ID。

Name

字符串

指定温度传感器的名称

LowerThresholdCritical

数值

温度传感器的低温严重告警阈值

LowerThresholdFatal

数值

温度传感器的低温紧急告警阈值

LowerThresholdNonCritical

数值

温度传感器的低温轻微告警阈值

UpperThresholdCritical

数值

指定温度传感器的高温严重告警阈值

UpperThresholdFatal

数值

指定温度传感器的高温紧急告警阈值

UpperThresholdNonCritical

数值

指定温度传感器的高温轻微告警阈值

PhysicalContext

字符串

描述此温度测量适用的区域或设备

SensorNumber

数值

指定温度传感器的序号

ReadingCelsius

数值

指定温度传感器的当前读数

Status

对象

指定管理资源的状态， 包括：

Health：传感器健康状态

State：传感器使能状态

Severity：自定义健康状态

Oem.Public.OceanTemperatureXCoordinate

数值

海洋温度X坐标值

Oem.Public.OceanTemperatureYCoordinate

数值

海洋温度Y坐标值

Oem.Public.OceanTemperatureZCoordinate

数值

海洋温度Z坐标值

Oem.Public.ThresholdMask

数值

温度传感器阈值的掩码

Oem.Public.CoolingMedium

字符串

冷却媒介，包括：

AirCooled：风冷

LiquidCooled：液冷

AirAndLiquidCooled：风冷和液冷

Oem.Public.LeakStrategy

字符串

液冷服务器漏液后处理策略：

AutoPowerOff：自动下电

ManualPowerOff：手动下电

Oem.Public.LiquidSummary.Count

数值

当前在位液冷装置数量

Oem.Public.LiquidSummary.MaxCountSupported

数值

最大支持的液冷装置数量

Oem.Public.LiquidSummary.FaultDescription

字符串

液冷装置整体故障描述

Oem.Public.LiquidSummary.Severity

字符串

液冷装置整体健康状态

Oem.Public.LiquidCoolers.Status.Health

字符串

单个液冷装置健康状态

Oem.Public.LiquidCoolers.Status.State

字符串

单个液冷装置使能状态

Oem.Public.LiquidCoolers.MemberId

字符串

液冷装置ID

Oem.Public.LiquidCoolers.Name

字符串

液冷装置名称

Oem.Public.LiquidCoolers.Severity

字符串

单个液冷装置自定义健康状态

Oem.Public.LiquidCoolers.FaultDescription

字符串

单个液冷装置故障描述

 

【修改记录】

(1)     HDM2-1.54：修改对象Status含义为散热模块整体状态信息；新增字段CoolingMedium、LeakStrategy、对象FanSummary.Status及其下字段、对象LiquidSummary及其下字段、对象LiquidCoolers及其下字段；

(2)     HDM2-1.56：示例中当前获取到的风扇冗余传感器名称FAN_Redundancy修改为FAN_Redundant；

(3)     HDM2-1.57：修改传感器阈值不可用时的返回值，从4294967295改为null；

(4)     HDM2-2.04：新增字段FanSummary.MaxRotorCountSupported及FanSummary.RotorCount，修改FanSummary.Count及FanSummary.MaxCountSupported字段描述；

(5)     HDM2-2.05：修改刀片机型输出说明，屏蔽冗余信息、健康状态字段，输出风扇管理资源状态；

 

4.2.14  设置指定机箱散热资源信息

【功能描述】

设置指定机箱散热资源信息。

【所属权限模块】

电源控制

【所属系统锁定类型】

BMC配置锁定

【命令格式】

PATCH https://device_ip/redfish/v1/Chassis/chassis_id/Thermal

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:ifmatch_value

【请求消息体】

{

"Oem":{

       "Public":{

            "FanSpeedAdjustmentMode":speedmode,

            "FanSpeedLevelPercents":speedlevel,

            "LeakStrategy": leakstrategy

}

}

}

【参数说明】

表4-39 设置风扇模式参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

chassis_id

机箱资源的ID

当前所有机型取值为1

ifmatch_value

请求消息的匹配参数

可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

Oem.Public.FanSpeedAdjustmentMode

字符串

调速模式：

"Silent"：静音模式：

"Balanced"：均衡模式：

"Powerful"：强劲模式：

"Custom"：自定义

Oem.Public.FanSpeedLevelPercents

数值

风扇档位：1~20

注意只有当FanSpeedAdjustmentMode 等于Custom 时此字段才存在；

档位越高，风扇转速越高

Oem.Public.LeakStrategy

字符串

液冷服务器漏液后处理策略：

"AutoPowerOff"：自动下电

"ManualPowerOff"：手动下电

 

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/Chassis/1/Thermal

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

  "Oem":{

      "Public": {

      "FanSpeedAdjustmentMode":"Custom",

      "FanSpeedLevelPercents":18,

      "LeakStrategy":"ManualPowerOff"

      }

  }

}

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#Thermal.Thermal",

    "@odata.id": "/redfish/v1/Chassis/1/Thermal",

    "@odata.type": "#Thermal.v1_6_3.Thermal",

    "FanSummary": {

        "Count": 4,

        "MaxCountSupported": 4,

"MaxRotorCountSupported": 8,

        "Redundancy": [

            {

                "Name": "FAN_Redundant",

                "Status": {

                    "Health": "OK",

                    "State": "Enabled"

                }

            }

        ],

"RotorCount": 0,

        "Status": {

            "Health": "OK",

            "HealthRollup": "OK",

            "Oem": {

                "Public": {

                    "FaultDescription": "",

                    "Severity": "Informational"

                }

            },

            "State": "Enabled"

        }

    },

    "Fans": [

        {

            "@odata.id": "/redfish/v1/Chassis/1/Thermal#/Fans/0",

            "MaxReadingRange": 15000,

            "MemberId": "0",

            "MinReadingRange": 0,

            "Name": "Fan1",

            "Oem": {

                "Public": {

                    "Position": "chassis",

                    "SlotNumber": 1,

                    "SpeedRatio": 0

                }

            },

            "PartNumber": "8038",

            "Reading": 0,

            "ReadingUnits": "RPM",

            "Status": {

                "Health": "OK",

                "Oem": {

                    "Public": {

                        "FaultDescription": "",

                        "Severity": "Informational"

                    }

                },

                "State": "Enabled"

            }

        },

…

    ],

    "Id": "Thermal",

    "InletHistoryTemperature": {

        "@odata.id": "/redfish/v1/Chassis/1/Thermal/InletHistoryTemperature"

    },

    "Name": "Thermal",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "CoolingMedium": "AirAndLiquidCooled",

            "Description": "Success",

            "FanSpeedAdjustmentMode": "Custom",

            "FanSpeedLevelPercents": 18,

            "LeakStrategy": "ManualPowerOff",

            "LiquidCoolers": [

                {

                    "FaultDescription": "",

                    "MemberId": 0,

                    "Name": "CPU Liquid Cooler1",

                    "Severity": "Informational",

                    "Status": {

                        "Health": "OK",

                        "State": "Enabled"

                    }

                }

            ],

            "LiquidSummary": {

                "Count": 1,

                "FaultDescription": "",

                "MaxCountSupported": 1,

                "Severity": "Informational"

            }

        }

    },

    "Status": {

        "Health": "OK",

        "HealthRollup": "OK",

        "Oem": {

            "Public": {

                "FaultDescription": "",

                "Severity": "Informational"

            }

        },

        "State": "Enabled"

    },

    "Temperatures": [

        {

            "@odata.id": "/redfish/v1/Chassis/1/Thermal#/Temperatures/0",

            "LowerThresholdCritical": null,

            "LowerThresholdFatal": null,

            "LowerThresholdNonCritical": null,

            "MemberId": "0",

            "Name": "Inlet_Temp",

            "Oem": {

                "Public": {

                    "OceanTemperatureXCoordinate": 8,

                    "OceanTemperatureYCoordinate": 0,

                    "OceanTemperatureZCoordinate": 0,

                    "ThresholdMask": 16152

                }

            },

            "PhysicalContext": "Room",

            "ReadingCelsius": 4294967295,

            "SensorNumber": 1,

            "Status": {

                "Health": "OK",

                "Oem": {

                    "Public": {

                        "Severity": "Informational"

                    }

                },

                "State": "Disabled"

            },

            "UpperThresholdCritical": 52.0,

            "UpperThresholdFatal": null,

            "UpperThresholdNonCritical": 50.0

        },

…

    ]

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回字段说明同【查询指定机箱散热资源信息】

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

(2)     HDM2-1.54：标题名称修改为设置指定机箱散热资源信息；功能描述修改为设置指定机箱散热资源信息；新增字段Oem.Public.LeakStrategy；

(3)     HDM2-1.56：示例中当前获取到的风扇冗余传感器名称FAN_Redundancy修改为FAN_Redundant；

(4)     HDM2-1.62：新增Oem.Public.LeakStrategy字段取值说明；

 

4.2.15  查询进风口历史温度资源信息

【功能描述】

查询进风口历史温度资源信息，刀箱产品不支持该接口。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Chassis/chassis_id/Thermal/InletHistoryTemperature

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-40 查询进风口历史温度信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

chassis_id

机箱资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET http://192.168.18.18/redfish/v1/Chassis/1/Thermal/InletHistoryTemperature

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

  "@odata.context": "/redfish/v1/$metadata#InletHistoryTemperature.InletHistoryTemperature",

  "@odata.id": "/redfish/v1/Chassis/1/Thermal/InletHistoryTemperature",

  "@odata.type": "#InletHistoryTemperature.v1_0_0.InletHistoryTemperature",

  "Description": "Air Inlet Historical Temperature",

  "HistoricalInletTemp": [

      {

    "Description": "Normal",

        "avg": 50,

        "max": 50,

        "min": 50,

        "time": "2021-12-15T10:47:49+08:00"

    },

    {

      "Description": "Unavailable",

      "avg": null,

      "max": null,

      "min": null,

      "time": "2021-12-15T11:33:28+08:00"

    },

    {

      "Description": null,

      "avg": null,

      "max": null,

      "min": null,

      "time": "2021-12-15T11:38:28+08:00"

    },

...

  ],

  "Id": "InletHistoryTemperature",

  "Name": "InletHistoryTemperature",

  "Oem": {

    "Public": {

      "CompletionCode": 0,

      "Description": "Success"

    }

  } 

}

 

响应码：200

【输出说明】

表4-41 查询进风口历史温度信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

进风口历史温度资源模型的OData 描述信息

@odata.id

字符串

进风口历史温度资源的访问路径

@odata.type

字符串

进风口历史温度资源的类型

Description

字符串

进风口历史温度资源描述

Id

字符串

进风口历史温度资源ID

Name

字符串

进风口历史温度资源名称

HistoricalInletTemp.avg

数值

温度平均值

HistoricalInletTemp.max

数值

最大温度值

HistoricalInletTemp.min

数值

最小温度值

HistoricalInletTemp.time

字符串

采样时间，格式举例：

2021-12-15T11:33:28+08:00

HistoricalInletTemp. Description

字符串，null

采样点数据描述：

Normal： 正常值

Unavailable：传感器不可用

null：未采样

 

4.2.16  查询电源信息

【功能描述】

查询电源信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Chassis/chassis_id/Power

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-42 查询电源信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

chassis_id

机箱资源的ID

当前所有机型取值为1

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Chassis/1/Power

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#Power.Power(PowerControl,Voltages,Id,Name,PowerSupplies)",

    "@odata.id": "/redfish/v1/Chassis/1/Power",

"@odata.type": "#Power.v1_7_0.Power",

"AllPowerStatus": {

        "Oem": {

            "Public": {

                "HostPowerStatus": "On",

                "JBODPowerStatus": null,

                "JBOGPowerStatus": null,

                "OverallPowerStatus": "On",

                "SmartNICPowerStatus": null

        }

    }

},

    "Id": "Power",

    "Name": "Power",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success",

"StandbyPowerMonitoringEnabled": true

 

        }

},

"PowerHistoryData": {

        "@odata.id": "/redfish/v1/Chassis/1/Power/PowerHistoryData"

 },

    "PowerControl": [

        {

            "@odata.id": "/redfish/v1/Chassis/1/Power#/PowerControl/1",

            "MaxNum": 2,

            "MemberId": 1,

            "Name": "System Power Control 1",

            "Oem": {

                "Public": {

                    "CurrentBoardPowerWatts": 466,

                    "CurrentCPUPowerWatts": 214,

                    "CurrentDiskPowerWatts":29,

                    "CurrentDiskPowerWats": 29,

                    "CurrentFanPowerWatts": 144,

                    "CurrentGPUPowerWatts": null,

                    "CurrentMemoryPowerWatts": 0,

                    "MinActivePowerCount":[1],

                    "PowerGroupCount": 1,

                    "SuggestedActivePowerCount": 2,

                    "OtherComponentsPowerWatts": null

                }

            },

            "PowerAlarmInfo": {

                "MaxPowerAlarm": 10000,

                "Multiple": 4,

                "PowerAlarmEnabled": false,

                "PowerAlarmThreshold": 10000

            },

            "PowerConsumedWatts": 467,

            "PowerLimit": {

                "CorrectionInMs": 1000,

                "LimitException": "NoAction",

                "LimitInWatts": null,

                "PowerLimitEnable":false

            },

            "PowerMetrics": {

                "MaxConsumedWatts": 10000,

                "MinConsumedWatts": 150

            },

            "Status": {

                "Health": "Ok",

                "State": "Enabled"

            }

        }

    ],

    "PowerManagementEnabled": true,

    "PowerSupplies": [

        {

            "@odata.id": "/redfish/v1/Chassis/1/Power#/PowerSupplies/2",

            "FirmwareVersion": "1M.0009.0024.002",

            "LineInputVoltage": 232,

            "LineInputVoltageType": "ACandDCWideRange",

            "Manufacturer": "FSP-GROUP",

            "MemberId": "2",

            "Model": "PSR800-12A",

            "Name": "PSU2",

            "Oem": {

                "Public": {

                    "ActiveStandby": "Active",

                    "ActiveStandbySupported": true,

                    "InputAmperage": 2.058,

                    "LineInputCurrent": 2.058,

                    "LineInputVoltageType": "AC",

                    "ManufactureDate":"2023-05-31",

                    "PowerCurrentWatts": 467,

                    "PowerGroupId": "1",

                    "PowerID": "2",

"PowerInputWatts": 156,

                    "PowerMaxWatts": 800,

                    "PowerOutputVoltage": 12.1,

                    "PowerOutputWatts": 442,

                    "ReadingAmperes": 36.375,

                    "SlotNumber": 2

                }

            },

            "PartNumber": null,

            "PowerCapacityWatts": 800,

            "PowerSupplyType": "ACorDC",

            "Redundancy": [],

            "SerialNumber": "8588859",

            "Status": {

                "Health": "OK",

                "Oem": {

                    "Public": {

                        "FaultDescription": "",

                        "Severity": "Informational"

                    }

                },

                "State": "Enabled"

            }

        },

        ...

    ],

    "Redundancy": [

        {

            "@odata.id": "/redfish/v1/Chassis/1/Power#/Redundancy/1",

            "@odata.type": "#Redundancy.v1_4_1.Redundancy",

            "MaxNumSupported": 2,

            "MemberId": "1",

            "MinNumNeeded": 1,

            "Mode": "Sharing",

            "Name": "PowerSupply Redundancy Group 1",

            "RedundancySet": [

                {

                    "@odata.id": "/redfish/v1/Chassis/1/Power#/PowerSupply/2"

                }

            ],

            "[email protected]": 1,

            "Status": {

                "Health": "OK",

                "Oem": {

                    "Public": {

                        "FaultDescription": "",

                        "Severity": "Informational"

                    }

                },

                "State": "Enabled"

            }

        },

        ...

    ],

    "Voltages": [

        {

            "LowerThresholdCritical": 10.752,

            "LowerThresholdFatal": null,

            "LowerThresholdNonCritical": null,

            "MaxReadingRange": 255,

            "MinReadingRange": 0,

            "Name": "SYS_12V",

            "ReadingVolts": 11.968,

            "SensorNumber": 94,

            "Status": {

                "Health": "OK",

                "State": "Enabled"

            },

            "UpperThresholdCritical": 13.184,

            "UpperThresholdFatal": null,

            "UpperThresholdNonCritical": null

        },

        ...

    ]

}

响应码：200

【输出说明】

表4-43 查询电源信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

电源信息资源模型的 OData 描述信息

@odata.id

字符串

电源信息资源的访问路径

@odata.type

字符串

电源信息资源的类型

Id

字符串

电源资源ID

Name

字符串

电源资源名称

PowerManagementEnabled

布尔

是否支持电源管理

PowerHistoryData

对象

查询历史功率资源信息路径

Oem.Public.StandbyPowerMonitoringEnabled

布尔

冷备份电源巡检使能状态

Redundancy

电源冗余组列表

[email protected]

数值

指定电源冗余组的访问路径

[email protected]

数值

指定电源冗余组的资源类型

Redundancy.MemberId

字符串

指定电源冗余组的ID

Redundancy.Name

字符串

指定电源冗余组的名称

Redundancy.MaxNumSupported

数值

该电源冗余组中支持最大电源数

Redundancy.MinNumNeeded

数值

该电源冗余组中支持最小电源数

Redundancy.RedundancySet

对象

指定电源冗余组所包含的电源模块的列表，包括：@odata.id：指定电源模块的访问路径

Redundancy.Mode

字符串

该电源冗余组模式

Sharing ：负载均衡

Failover：主备模式

Redundancy.Status.Health

字符串

该电源冗余组的健康状态

Redundancy.Status.State

字符串

该电源冗余组的使能状态

Redundancy.Status.Oem.Public.Severity

字符串

该电源冗余组的自定义健康状态

Redundancy.Status.Oem.Public.FaultDescription

字符串

该电源冗余组故障描述信息

说明：电源组整体故障信息关联部件整体，独立于单个部件的故障信息

PowerControl

电源控制信息

PowerControl.PowerAlarmInfo.PowerAlarmEnabled

布尔

总功率告警使能状态

PowerControl.PowerAlarmInfo.PowerAlarmThreshold

数值

总功率告警阈值

PowerControl.PowerAlarmInfo.Multiple

数值

倍数

PowerControl.PowerAlarmInfo.MaxPowerAlarm

数值

总功率告警最大值

PowerControl.MaxNum

数值

电源最大数目

注：X18000不支持

PowerControl.PowerConsumedWatts

数值

电源当前功率

[email protected]

字符串

电源控制属性的访问路径

PowerControl.MemberId

数值

电源控制属性的ID

PowerControl.Name

字符串

电源控制属性的名称

PowerControl.PowerMetrics.MaxConsumedWatts

数值

最大功耗

PowerControl.PowerMetrics.MinConsumedWatts

数值

最小功耗

PowerControl.PowerLimit.CorrectionInMs

数值

功耗纠正时间（毫秒）

PowerControl.PowerLimit.LimitException

字符串

功率封顶失效动作：

"NoAction"：无操作

"HardPowerOff "：关机

PowerControl.PowerLimit.LimitInWatts

数值,null

功率限制, null 的表明是 关闭功率封顶

说明：G6 5500 AMD/Intel机型此处功率封顶相关字段表示CPU节点功率封顶；其他机型表示主板功率封顶

PowerControl.PowerLimit.PowerLimitEnable

布尔

功率封顶使能状态

说明：G6 5500 AMD/Intel机型此处功率封顶相关字段表示CPU节点功率封顶；其他机型表示主板功率封顶

PowerControl.Status.Health

字符串

电源控制器健康状态

PowerControl.Status.State

字符串

电源控制器使能状态

PowerControl.Oem.Public.PowerGroupCount

数值

当前机型支持的电源组数量

注：X18000不支持

PowerControl.Oem.Public.CurrentCPUPowerWatts

数值

当前CPU功率

PowerControl.Oem.Public.CurrentMemoryPowerWatts

数值

当前内存功率

PowerControl.Oem.Public.CurrentFanPowerWatts

数值

当前风扇功率

注：X18000不支持

PowerControl.Oem.Public.CurrentBoardPowerWatts

数值

主板总功耗

说明：G6 5500 AMD/Intel机型此字段表示CPU节点功率

PowerControl.Oem.Public.CurrentGPUPowerWatts

数值

GPU节点总功耗

说明：G6 5500 AMD/Intel机型支持

PowerControl.Oem.Public.OtherComponentsPowerWatts

数值

除CPU和GPU外其他部件总功耗

说明：G6 5500 AMD/Intel机型支持

PowerControl.Oem.Public.CurrentDiskPowerWatts

数值

硬盘功耗

注：X18000不支持；同时存在CurrentDiskPowerWats字段，和该字段用法相同，其为保持字段兼容性而保留

PowerControl.Oem.Public.MinActivePowerCount

数组

每个电源组支持的最小主电源数量

PowerControl.Oem.Public.SuggestedActivePowerCount

数值

建议主电源个数

仅R4500G6支持

PowerSupplies

电源模块信息

注：X18000不支持

PowerSupplies.FirmwareVersion

字符串

固件版本

PowerSupplies.LineInputVoltage

数值

输入电压

PowerSupplies.LineInputVoltageType

字符串

输入电压类型：

ACandDCWideRange

PowerSupplies.Manufacturer

字符串

电源模块生产商

PowerSupplies.Model

字符串

电源型号

PowerSupplies.Name

字符串

电源名称

PowerSupplies.PowerCapacityWatts

数值

电源功耗

PowerSupplies.Oem.Public.PowerID

字符串

电源ID号

PowerSupplies.Oem.Public.ActiveStandby

字符串

主备情况：

"Standby"

"Active"

PowerSupplies.Oem.Public.PowerCurrentWatts

数值

当前电源模块输入功率

PowerSupplies.Oem.Public.InputAmperage

数值

指定电源模块的输入电流

PowerSupplies.Oem.Public.ReadingAmperes

数值

指定电流传感器的当前读数

PowerSupplies.Oem.Public.SlotNumber

数值

指定电源模块的槽位号

PowerSupplies.Oem.Public.LineInputCurrent

数值

指定电源模块的输入电流

PowerSupplies.Oem.Public.LineInputVoltageType

字符串

指定电源模块的自定义输入电压类型：

"AC"

"HVDC"

"LVDC"

"No input"

PowerSupplies.Oem.Public. PowerOutputVoltage

数值

指定电源模块的输出电压

PowerSupplies.Oem.Public.PowerOutputWatts

数值

指定电源模块输出功率

PowerSupplies.Oem.Public.PowerMaxWatts

数值

电源最大功率

PowerSupplies.Oem.Public.PowerInputWatts

数值

电源输入功率

PowerSupplies.Oem.Public. ActiveStandbySupported

布尔

电源冷备份支持

PowerSupplies.Oem.Public.PowerGroupId

字符串

电源所属电源组

PowerSupplies.Oem.Public.ManufactureDate

字符串

电源生产日期

PowerSupplies.Redundancy

数组

指定电源模块实际所属的电源冗余组列表，包括：

@odata.id：指定电源 冗余组的访问路径

PowerSupplies.PowerSupplyType

字符串

电源类型：

"Unknown"

"AC"

"DC"

"ACorDC"

PowerSupplies.PartNumber

字符串

电源部件号，部分电源未实现

PowerSupplies.SerialNumber

字符串

电源序列号

PowerSupplies.Status.Health

字符串

电源健康状态

PowerSupplies.Status.State

字符串

电源使能状态

PowerSupplies.Status.Oem.Public.Severity

字符串

电源自定义状态

PowerSupplies.Status.Oem.Public. FaultDescription

字符串

电源故障描述信息

PowerSupplies.MemberId

字符串

指定电源模块的ID

Voltages

电压传感器信息

Voltages.LowerThresholdCritical

数值

严重下限阈值

Voltages.LowerThresholdFatal

数值

致命下限阈值

Voltages.LowerThresholdNonCritical

数值

警告下限阈值

Voltages.MaxReadingRange

数值

最大读取范围

Voltages.MinReadingRange

数值

最小读取范围

Voltages.Name

字符串

传感器名称

Voltages.ReadingVolts

数值、字符串

线性传感器显示：

电压数值

 

离散型传感器显示：

"Voltage fault trigger"电压故障触发

"Voltage fault release"电压故障解除

Voltages.SensorNumber

数值

传感器编号

Voltages.Status.Health

字符串

电压传感器健康状态

Voltages.Status.State

字符串

电压传感器使能状态

Voltages.UpperThresholdCritical

数值

严重上限阈值

Voltages.UpperThresholdFatal

数值

致命上限阈值

Voltages.UpperThresholdNonCritical

数值

警告上限阈值

AllPowerStatus.Oem.Public.HostPowerStatus

字符串

Off/On

AllPowerStatus.Oem.Public.JBODPowerStatus

字符串

目前为null

AllPowerStatus.Oem.Public.JBOGPowerStatus

字符串

目前为null

AllPowerStatus.Oem.Public.OverallPowerStatus

字符串

Off/On

AllPowerStatus.Oem.Public.SmartNICPowerStatus

字符串

智能网卡主电源状态，目前为null

 

【修改记录】

(1)     HDM2-1.55：新增字段PowerControl.Oem.Public.OtherComponentsPowerWatts；

(2)     HDM2-1.56：新增字段PowerControl.PowerLimit.PowerLimitEnable；

(3)     HDM2-1.57：新增字段PowerSupplies.Oem.Public.ManufactureDate；

(4)     HDM2-1.57：修改传感器阈值不可用时的返回值，从4294967295改为null；

(5)     HDM2-1.58：新增字段PowerControl.Oem.Public.MinActivePowerCount；

(6)     HDM2-1.61：将PowerControl.Oem.Public.CurrentDiskPowerWats字段更改为PowerControl.Oem.Public.CurrentDiskPowerWatts，同时原字段也仍支持；

(7)     HDM2-2.04：新增字段PowerSupplies.Oem.Public.PowerInputWatts；

(8)     HDM2-2.07：新增字段PowerControl.Oem.Public. SuggestedActivePowerCount；

 

4.2.17  设置电源信息

【功能描述】

设置电源信息。刀箱产品不支持该接口。

【所属权限模块】

电源控制

【所属系统锁定类型】

BMC配置锁定

【命令格式】

PATCH https://device_ip/redfish/v1/Chassis/chassis_id/Power

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:ifmatch_value

【请求消息体1】

//电源主备切换请求消息体：

{

  "PowerControl": [

      {

          "Oem": {

              "Public": {

                  "PowerGroupId":power_group_id,

                   "PowerID":power_id,

                   "ActiveStandby":active_standby

              }

          }

      },

      {

          "Oem": {

              "Public": {

                  "PowerGroupId":power_group_id,

                   "PowerID":power_id,

                   "ActiveStandby":active_standby

              }

          }

      }

  ]

}

【请求消息体2】

//开启关闭并设置主板/CPU节点功率封顶参数

{

  "PowerControl":[

    {

      "PowerLimit":{

        "LimitInWatts":limit_value,

        "LimitException":limit_exception

      }

    }

  ]

}

【请求消息体3】

//总功率配置，包括告警状态及总功率告警阈值

{

  "PowerControl":[

    {

      "PowerAlarmInfo":{

        "PowerAlarmEnabled":enabled,

        "PowerAlarmThreshold":threshold_value

      }

    }

  ]

}

【请求消息体4】

//设置冷备份电源巡检状态

{

  "Oem":{

      "Public":{

          "StandbyPowerMonitoringEnabled":enabled

      }

  }

}

 

【参数说明】

表4-44 设置电源信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

chassis_id

机箱资源的ID

当前所有机型取值为1

ifmatch_value

请求消息的匹配参数

可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）

PowerControl.Oem.Public.PowerGroupId

字符串

电源组ID

PowerControl.Oem.Public.PowerID

数值

电源ID

PowerControl.Oem.Public.ActiveStandby

字符串

主备设置：“Active”、“ Standby”

PowerControl.PowerLimit.LimitInWatts

数值,null

功率限定：范围150~10000W；

150~10000W会直接开启功率封顶；null 的表明是 关闭功率封顶

说明：G6 5500 AMD/Intel机型时该字段表示设置CPU节点功率限定值，其他机型表示设置主板功率限定值

PowerControl.PowerLimit.LimitException

字符串

功率封顶失效动作：

"NoAction"：无操作

"HardPowerOff "：关机

说明：G6 5500 AMD/Intel机型时该字段表示设置CPU节点功率封顶失效动作，其他机型表示设置主板功率封顶失效动作

PowerControl.PowerAlarmInfo.PowerAlarmEnabled

布尔

总功率告警使能状态

PowerControl.PowerAlarmInfo.PowerAlarmThreshold

数值

总功率告警阈值

Oem.Public.StandbyPowerMonitoringEnabled

布尔

冷备份电源巡检状态

 

【使用实例1】

#电源主备切换

【请求样例】

PATCH https://192.168.18.18/redfish/v1/Chassis/1/Power

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

  "PowerControl": [

      {

          "Oem": {

              "Public": {

                  "PowerGroupId":"1",

                    "PowerID":1,

                    "ActiveStandby":"Active"

              }

          }

      },

      {

          "Oem": {

              "Public": {

                  "PowerGroupId":"1",

                    "PowerID":2,

                    "ActiveStandby":"Standby"

              }

          }

      }

  ]

}

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#Power.Power(PowerControl,Voltages,Id,Name,PowerSupplies)",

    "@odata.id": "/redfish/v1/Chassis/1/Power",

"@odata.type": "#Power.v1_7_0.Power",

...

    "Id": "Power",

    "Name": "Power",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success",

"StandbyPowerMonitoringEnabled":true

        }

},

"PowerHistoryData": {

        "@odata.id": "/redfish/v1/Chassis/1/Power/PowerHistoryData"

 },

    "PowerControl": [

        ...

    ],

    "PowerManagementEnabled": true,

    "PowerSupplies": [

        {

            "@odata.id": "/redfish/v1/Chassis/1/Power#/PowerSupplies/1",

            "FirmwareVersion": "1M.0009.0024.002",

            "LineInputVoltage": 236,

            "LineInputVoltageType": "ACandDCWideRange",

            "Manufacturer": "FSP-GROUP",

            "MemberId": "1",

            "Model": "PSR800-12A",

            "Name": "PSU1",

            "Oem": {

                "Public": {

                    "ActiveStandby": "Active",

                    "ActiveStandbySupported": true,

                    "InputAmperage": 566,

                    "LineInputCurrent": 566,

                    "LineInputVoltageType": "AC",

                    "ManufactureDate": "2023-05-31",

                    "PowerCurrentWatts": 111,

                    "PowerGroupId": "1",

                    "PowerID": "1",

"PowerInputWatts": 156,

                    "PowerMaxWatts": 800,

                    "PowerOutputVoltage": 12.1,

                    "PowerOutputWatts": 99,

                    "ReadingAmperes": 7929,

                    "SlotNumber": 1

                }

            },

            "PartNumber": "9PA8001704 S7181402841",

            "PowerCapacityWatts": 800,

            "PowerSupplyType": "ACorDC",

            "Redundancy": [

                {

                    "@odata.id": "/redfish/v1/Chassis/1/Power#/Redundancy/1"

                }

            ],

            "SerialNumber": "210213A05PH175000850",

            "Status": {

                "Health": "OK",

                "Oem": {

                    "Public": {

                        "FaultDescription": "",

                        "Severity": "Informational"

                    }

                },

                "State": "Enabled"

            }

        },

        {

            "@odata.id": "/redfish/v1/Chassis/1/Power#/PowerSupplies/2",

            "FirmwareVersion": "1M.0009.0024.002",

            "LineInputVoltage": 231,

            "LineInputVoltageType": "ACandDCWideRange",

            "Manufacturer": "FSP-GROUP",

            "MemberId": "2",

            "Model": "PSR800-12A",

            "Name": "PSU2",

            "Oem": {

                "Public": {

                    "ActiveStandby": "Standby",

                    "ActiveStandbySupported": true,

                    "InputAmperage": 628,

                    "LineInputCurrent": 628,

                    "LineInputVoltageType": "AC",

                    "ManufactureDate":"2023-05-31",

                    "PowerCurrentWatts": 122,

                    "PowerGroupId": "1",

                    "PowerID": "2",

"PowerInputWatts": 156,

                    "PowerMaxWatts": 800,

                    "PowerOutputVoltage": 12.2,

                    "PowerOutputWatts": 107,

                    "ReadingAmperes": 8796,

                    "SlotNumber": 2

                }

            },

            "PartNumber": "9PA8001704 S6361201074",

            "PowerCapacityWatts": 800,

            "PowerSupplyType": "ACorDC",

            "Redundancy": [

                {

                    "@odata.id": "/redfish/v1/Chassis/1/Power#/Redundancy/1"

                }

            ],

            "SerialNumber": "",

            "Status": {

                "Health": "Critical",

                "Oem": {

                    "Public": {

                        "FaultDescription": "[PowerSupply]Power Supply Failure detected",

                        "Severity": "Major"

                    }

                },

                "State": "Enabled"

            }

        }

    ],

    "Redundancy": [

        ...

    ],

    "Voltages": [

        ...

    ]

}

响应码：200

【使用实例2】

#设置功率封顶

【请求样例】

PATCH https://192.168.18.18/redfish/v1/Chassis/1/Power

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

  "PowerControl": [

      {

          "PowerLimit":{

              "LimitInWatts":766,

              "LimitException":"NoAction"

          }

      }

  ]

}

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#Power.Power(PowerControl,Voltages,Id,Name,PowerSupplies)",

    "@odata.id": "/redfish/v1/Chassis/1/Power",

"@odata.type": "#Power.v1_5_0.Power",

...

    "Id": "Power",

    "Name": "Power",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success",

"StandbyPowerMonitoringEnabled":true

        }

},

"PowerHistoryData": {

        "@odata.id": "/redfish/v1/Chassis/1/Power/PowerHistoryData"

},

    "PowerControl": [

        {

            "@odata.id": "/redfish/v1/Chassis/1/Power#/PowerControl/1",

            "MaxNum": 4,

            "MemberId": 1,

            "Name": "System Power Control 1",

            "Oem": {

                "Public": {

                    "CurrentBoardPowerWatts": 0,

                    "CurrentCPUPowerWatts": 0,

"CurrentDiskPowerWatts":0,

                    "CurrentDiskPowerWats": 0,

                    "CurrentFanPowerWatts": 0,

                    "CurrentGPUPowerWatts": 0,

                    "CurrentMemoryPowerWatts": 0,

                    "PowerGroupCount": 1,

"OtherComponentsPowerWatts": null

                }

            },

            "PowerAlarmInfo": {

                "MaxPowerAlarm": 10000,

                "Multiple": 1,

                "PowerAlarmEnabled": false,

                "PowerAlarmThreshold": 1500

            },

            "PowerConsumedWatts": 0,

            "PowerLimit": {

                "CorrectionInMs": 1000,

                "LimitException": "NoAction",

                "LimitInWatts": 766,

               "PowerLimitEnable":true

            },

            "PowerMetrics": {

                "MaxConsumedWatts": 10000,

                "MinConsumedWatts": 150

            },

            "Status": {

                "Health": "Ok",

                "State": "Enabled"

            }

        }

    ],

    "PowerManagementEnabled": true,

    "PowerSupplies": [

        ...

    ],

    "Redundancy": [

        ...

    ],

    "Voltages": [

        ...

    ]

}

响应码：200

【使用实例3】

#设置总功率告警阈值

【请求样例】

PATCH https://192.168.18.18/redfish/v1/Chassis/1/Power

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

  "PowerControl": [

      {

          "PowerAlarmInfo": {

              "PowerAlarmEnabled":true,

              "PowerAlarmThreshold":1000

          }

      }

    ]

}

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#Power.Power(PowerControl,Voltages,Id,Name,PowerSupplies)",

    "@odata.id": "/redfish/v1/Chassis/1/Power",

"@odata.type": "#Power.v1_5_0.Power",

...

    "Id": "Power",

    "Name": "Power",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success",

"StandbyPowerMonitoringEnabled":true

        }

},

"PowerHistoryData": {

        "@odata.id": "/redfish/v1/Chassis/1/Power/PowerHistoryData"

},

    "PowerControl": [

        {

            "@odata.id": "/redfish/v1/Chassis/1/Power#/PowerControl/1",

            "MaxNum": 4,

            "MemberId": 1,

            "Name": "System Power Control 1",

            "Oem": {

                "Public": {

                    "CurrentBoardPowerWatts": 0,

                    "CurrentCPUPowerWatts": 0,

"CurrentDiskPowerWatts":0,

                    "CurrentDiskPowerWats": 0,

                    "CurrentFanPowerWatts": 0,

                    "CurrentGPUPowerWatts": 0,

                    "CurrentMemoryPowerWatts": 0,

                    "PowerGroupCount": 1,

"OtherComponentsPowerWatts": null

                }

            },

            "PowerAlarmInfo": {

                "MaxPowerAlarm": 2550,

                "Multiple": 10,

                "PowerAlarmEnabled": true,

                "PowerAlarmThreshold": 1000

            },

            "PowerConsumedWatts": 0,

            "PowerLimit": {

                "CorrectionInMs": 1000,

                "LimitException": "NoAction",

                "LimitInWatts": 766,

                "PowerLimitEnable":true

            },

            "PowerMetrics": {

                "MaxConsumedWatts": 10000,

                "MinConsumedWatts": 150

            },

            "Status": {

                "Health": "Ok",

                "State": "Enabled"

            }

        }

    ],

    "PowerManagementEnabled": true,

    "PowerSupplies": [

        ...

    ],

    "Redundancy": [

        ...

    ],

    "Voltages": [

        ...

    ]

}

响应码：200

【使用实例4】

#设置冷备份电源巡检状态

【请求样例】

PATCH https://192.168.18.18/redfish/v1/Chassis/1/Power

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

  "Oem":{

      "Public":{

          "StandbyPowerMonitoringEnabled":true

      }

  }

}

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#Power.Power(PowerControl,Voltages,Id,Name,PowerSupplies)",

    "@odata.id": "/redfish/v1/Chassis/1/Power",

"@odata.type": "#Power.v1_5_0.Power",

...

    "Id": "Power",

    "Name": "Power",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success",

"StandbyPowerMonitoringEnabled":true

        }

},

"PowerHistoryData": {

        "@odata.id": "/redfish/v1/Chassis/1/Power/PowerHistoryData"

},

    "PowerControl": [

        {

            "@odata.id": "/redfish/v1/Chassis/1/Power#/PowerControl/1",

            "MaxNum": 4,

            "MemberId": 1,

            "Name": "System Power Control 1",

            "Oem": {

                "Public": {

                    "CurrentBoardPowerWatts": 0,

                    "CurrentCPUPowerWatts": 0,

"CurrentDiskPowerWatts":0,

                    "CurrentDiskPowerWats": 0,

                    "CurrentFanPowerWatts": 0,

                    "CurrentGPUPowerWatts": 0,

                    "CurrentMemoryPowerWatts": 0,

                    "PowerGroupCount": 1,

"OtherComponentsPowerWatts": null

                }

            },

            "PowerAlarmInfo": {

                "MaxPowerAlarm": 2550,

                "Multiple": 10,

                "PowerAlarmEnabled": true,

                "PowerAlarmThreshold": 1000

            },

            "PowerConsumedWatts": 0,

            "PowerLimit": {

                "CorrectionInMs": 1000,

                "LimitException": "NoAction",

                "LimitInWatts": null,

"PowerLimitEnable":false

            },

            "PowerMetrics": {

                "MaxConsumedWatts": 10000,

                "MinConsumedWatts": 150

            },

            "Status": {

                "Health": "Ok",

                "State": "Enabled"

            }

        }

    ],

    "PowerManagementEnabled": true,

    "PowerSupplies": [

        ...

    ],

    "Redundancy": [

        ...

    ],

    "Voltages": [

        ...

    ]

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回字段说明同【查询电源信息】

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

 

4.2.18  查询电源恢复策略信息

【功能描述】

获取电源恢复策略信息资源。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Chassis/chassis_id/Oem/Public/PowerOnSettings

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-45 查询电源恢复策略信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

chassis_id

机箱资源的ID

当前所有机型取值为1

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

 

【使用实例】

【请求样例】

GET http://192.168.18.18/redfish/v1/Chassis/1/Oem/Public/PowerOnSettings

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#PowerDefaultSettings",

    "@odata.id": "/redfish/v1/Chassis/1/Oem/Public/PowerOnSettings",

    "@odata.type": "#PowerOnSettings.v1_0_0.PowerOnSettings",

    "Description": "Power On Settings",

    "Id": "PowerOnSettings",

    "MaxRandomDelaySeconds": 120,

    "Name": "PowerOnSettings",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "PowerOnStrategy": "RestorePreviousState",

    "PowerRestoreDelayMode": "FixedDelay",

    "PowerRestoreDelaySeconds": 0

}

响应码：200

【输出说明】

表4-46 查询电源恢复策略信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

指定系统资源模型的OData 描述信息

@odata.id

字符串

指定系统资源的访问路径

@odata.type

字符串

指定系统资源的类型

Id

字符串

指定系统资源ID

Name

字符串

指定系统资源名称

PowerOnStrategy

字符串

电源恢复配置命令

TurnOn：保持上电

RestorePreviousState：与之前保持一致

StayOff：保持下电

PowerRestoreDelaySeconds

数值

延迟时间

PowerRestoreDelayMode

字符串

延迟类型

FixedDelay：固定延时

RandomDelay：随机延时

MaxRandomDelaySeconds

数值

随机延迟最大可设置时间

 

4.2.19  设置电源恢复策略

【功能描述】

设置电源恢复策略信息资源。

【所属权限模块】

电源控制

【所属系统锁定类型】

BMC配置锁定

【命令格式】

PATCH https://device_ip/redfish/v1/Chassis/chassis_id/Oem/Public/PowerOnSettings

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:ifmatch_value

【请求消息体】

{

    "PowerOnStrategy":  power_on_strategy,

    "PowerRestoreDelayMode": delay_mode,

    "PowerRestoreDelaySeconds": delay_seconds

}

【参数说明】

表4-47 设置电源恢复策略参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

chassis_id

机箱资源的ID

当前所有机型取值为1

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

PowerOnStrategy

字符串

电源恢复配置命令

TurnOn：保持上电

RestorePreviousState：与之前保持一致

StayOff：保持下电

PowerRestoreDelaySeconds

数值

延迟时间

PowerRestoreDelayMode

字符串

延迟类型

FixedDelay：固定延时

RandomDelay：随机延时

 

【使用实例】

【请求样例】

PATCH http://192.168.18.18/redfish/v1/Chassis/1/Oem/Public/PowerOnSettings

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

    "PowerOnStrategy": "TurnOn",

    "PowerRestoreDelayMode": "RandomDelay",

    "PowerRestoreDelaySeconds": 120

}

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#PowerDefaultSettings",

    "@odata.id": "/redfish/v1/Chassis/1/Oem/Public/PowerOnSettings",

    "@odata.type": "#PowerOnSettings.v1_0_0.PowerOnSettings",

    "Description": "Power On Settings",

    "Id": "PowerOnSettings",

    "MaxRandomDelaySeconds": 120,

    "Name": "PowerOnSettings",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "PowerOnStrategy": "TurnOn",

    "PowerRestoreDelayMode": "RandomDelay",

    "PowerRestoreDelaySeconds": 120

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回字段说明同【查询电源恢复策略信息】

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

 

4.2.20  获取CPU电源节能信息

【功能描述】

获取CPU电源节能信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Chassis/chassis_id/Oem/Public/CPUEnergyEfficiency

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-48 查询CPU电源节能信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

chassis_id

机箱资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Chassis/1/Oem/Public/CPUEnergyEfficiency

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#CPUEnergyEfficiency.CPUEnergyEfficiency/$entity",

    "@odata.id": "/redfish/v1/Chassis/1/Oem/Public/CPUEnergyEfficiency",

    "@odata.type": "#CPUEnergyEfficiency.v1_0_0.CPUEnergyEfficiency",

    "CPUPowerAdjustment": {

        "CPUPLimit": 13,

        "CPUPState": 0

    },

    "Description": "Get processors energy efficiency",

    "Id": "CPUEnergyEfficiency",

    "Name": "CPUEnergyEfficiency",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

},

"CPUPStateValid": false,

    "ProcessorEPPProfile": "Balanced"

}

      注： CPU能效策略BIOS上有4种，redfish上只有3种，页面与redfish相对应有3种，

          BIOS设置Performance，redfish获取为Performance，页面显示策略为性能，

          BIOS设置Balanced Power, redfish获取为Balanced，页面显示策略为均衡，

BIOS设置Balanced Performance，redfish获取为Balanced，页面显示策略为均衡，

BIOS设置Power，redfish获取为Power，页面显示策略为节能。

【输出说明】

表4-49 查询CPU电源节能信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

系统CPU电源节能信息资源的OData 描述信息

@odata.id

字符串

系统CPU电源节能信息资源的访问路径

@odata.type

字符串

指CPU电源节能信息的类型

Id

字符串

CPU电源节能信息资源ID

Name

字符串

CPU电源节能信息资源名称

ProcessorEPPProfile

字符串

CPU能效策略选择：

性能：Performance；

均衡：Balanced；

节能：Power

Description

字符串

CPU电源节能信息资源描述

CPUPLimit

数字

代表当前平台支持的最大P-State调节等级值

CPUPState

数字

代表当前的P-State等级值

CPUPStateValid

布尔型

代表P-State等级值的有效性

 

4.2.21  设置CPU电源节能信息

【功能描述】

设置CPU电源节能信息。

【所属权限模块】

电源控制

【所属系统锁定类型】

BMC配置锁定

【命令格式】

PATCH  https://device_ip/redfish/v1/Chassis/chassis_id/Oem/Public/CPUEnergyEfficiency

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:ifmatch_value

【请求消息体】

{

    "CPUPowerAdjustment": {

        "CPUPState": 0

    },

    "ProcessorEPPProfile": "Power"

}

【参数说明】

表4-50 设置CPU电源节能信息参数说明

字段

类型

字段说明

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

chassis_id

机箱资源的ID

当前所有机型取值为1

ProcessorEPPProfile

字符串

CPU能效策略选择：

性能：Performance；

均衡：Balanced；

节能：Power

CPUPState

数字

代表当前的P-State等级值

 

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/Chassis/1/Oem/Public/CPUEnergyEfficiency

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:ifmatch_value

【请求消息体】

{

    "CPUPowerAdjustment": {

        "CPUPState": 0

    },

    "ProcessorEPPProfile": "Power"

}

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#CPUEnergyEfficiency.CPUEnergyEfficiency/$entity",

    "@odata.id": "/redfish/v1/Chassis/1/Oem/Public/CPUEnergyEfficiency",

    "@odata.type": "#CPUEnergyEfficiency.v1_0_0.CPUEnergyEfficiency",

    "CPUPowerAdjustment": {

        "CPUPLimit": 0,

        "CPUPState": 0

    },

    "Description": "Get processors energy efficiency",

    "Id": "CPUEnergyEfficiency",

    "Name": "CPUEnergyEfficiency",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

},

"CPUPStateValid": true,

    "ProcessorEPPProfile": "Power"

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回字段说明同【查询CPU电源节能信息】

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

 

4.2.22  查询历史功率资源信息

【功能描述】

查询历史功率资源信息

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Chassis/chassis_id/Power/PowerHistoryData

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-51 查询历史功率资源参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

chassis_id

机箱资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET http://172.16.13.176/redfish/v1/Chassis/1/Power/PowerHistoryData

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#PowerHistoryData.PowerHistoryData",

    "@odata.id": "/redfish/v1/Chassis/1/Power/PowerHistoryData",

    "@odata.type": "#PowerHistoryData.v1_0_0.PowerHistoryData",

    "Description": "Historical Power",

    "HistoricalCPU": [

        {

            "Description": "Normal",

            "avg": 65,

            "max": 65,

            "min": 65,

            "time": "2017-01-15T10:03:18+08:00"

        },

        {

            "Description": "Normal",

            "avg": 468,

            "max": 468,

            "min": 468,

            "time": "2022-10-27T17:11:12+08:00"

        },

      ...

  ],

  "Id": "PowerHistoryData",

  "Name": "PowerHistoryData",

  "Oem": {

    "Public": {

      "CompletionCode": 0,

      "Description": "Success"

    }

  } 

}

响应码：200

【输出说明】

表4-52 查询历史功率资源信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

历史功率资源模型的OData 描述信息

@odata.id

字符串

历史功率资源的访问路径

@odata.type

字符串

历史功率资源的类型

Id

字符串

历史功率资源ID

Name

字符串

历史功率资源名称

Description

字符串

历史功率资源描述

HistoricalCPU.avg

数值

功率平均值

HistoricalCPU.max

数值

最大功率值

HistoricalCPU.min

数值

最小功率值

HistoricalCPU.time

字符串

采样时间，格式举例：

2021-12-15T11:33:28+08:00

HistoricalCPU.Description

字符串，null

采样点数据描述：

Normal： 正常值

Unavailable：传感器不可用

null：未采样

 

4.2.23  查询传感器种类集合信息

【功能描述】

查询传感器种类列表信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Chassis/chassis_id/Sensors

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-53 查询传感器种类集合资源参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

chassis_id

机箱资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Chassis/1/Sensors

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#Sensors.Sensors",

    "@odata.id": "/redfish/v1/Chassis/1/Sensors",

    "@odata.type": "#SensorsCollection.SensorsCollection",

    "Description": "Sensors Collection",

    "Members": [

        {

            "@odata.id": "/redfish/v1/Chassis/1/Sensors/Oem/Public/Temperature"

        },

        {

            "@odata.id": "/redfish/v1/Chassis/1/Sensors/Oem/Public/Voltage"

        },

        {

            "@odata.id": "/redfish/v1/Chassis/1/Sensors/Oem/Public/Current"

        },

        {

            "@odata.id": "/redfish/v1/Chassis/1/Sensors/Oem/Public/Power"

        }

    ],

    "[email protected]": 4,

    "Name": "Sensors Collection",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    }

}

响应码：200

【输出说明】

表4-54 查询传感器种类集合信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

传感器列表模型的OData 描述信息

@odata.id

字符串

传感器列表资源的访问路径

@odata.type

字符串

传感器列表资源的类型

Name

字符串

传感器列表资源名称

Description

字符串

传感器列表资源描述

Members

数组

传感器成员所在路径

[email protected]

数字

传感器种类数量

 

4.2.24  查询指定类型的传感器列表信息

【功能描述】

查询指定类型的传感器列表信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Chassis/chassis_id/Sensors/Oem/Public/sensors_type

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-55 查询指定类型传感器列表资源参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

chassis_id

机箱资源的ID

当前所有机型取值为1

sensors_ type

传感器类型

通过查询传感器种类集合信息获取

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Chassis/1/Sensors/Oem/Public/Temperature

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#Sensors.Sensors",

    "@odata.id": "/redfish/v1/Chassis/1/Sensors/Oem/Public/Temperature",

    "@odata.type": "#SensorsCollection.SensorsCollection",

    "Description": "Temperature Sensor Collection",

    "Members": [

        {

            "@odata.id": "/redfish/v1/Chassis/1/Sensors/Oem/Public/Temperature/Inlet_Temp"

        },

        {

            "@odata.id": "/redfish/v1/Chassis/1/Sensors/Oem/Public/Temperature/CPU1_Temp"

        },

        {

            "@odata.id": "/redfish/v1/Chassis/1/Sensors/Oem/Public/Temperature/CPU2_Temp"

        },

        {

            "@odata.id": "/redfish/v1/Chassis/1/Sensors/Oem/Public/Temperature/CPU1_DTS"

        },

        {

            "@odata.id": "/redfish/v1/Chassis/1/Sensors/Oem/Public/Temperature/CPU2_DTS"

        },

        {

            "@odata.id": "/redfish/v1/Chassis/1/Sensors/Oem/Public/Temperature/CPU1_VR_Temp"

        },

        {

            "@odata.id": "/redfish/v1/Chassis/1/Sensors/Oem/Public/Temperature/CPU2_VR_Temp"

        },

        {

            "@odata.id": "/redfish/v1/Chassis/1/Sensors/Oem/Public/Temperature/PCH_Temp"

        },

        {

            "@odata.id": "/redfish/v1/Chassis/1/Sensors/Oem/Public/Temperature/PSU1_Temp"

        },

        {

            "@odata.id": "/redfish/v1/Chassis/1/Sensors/Oem/Public/Temperature/PSU2_Temp"

        },

        {

            "@odata.id": "/redfish/v1/Chassis/1/Sensors/Oem/Public/Temperature/CPU1_DIMM_Temp"

        },

        {

            "@odata.id": "/redfish/v1/Chassis/1/Sensors/Oem/Public/Temperature/CPU2_DIMM_Temp"

        },

        {

            "@odata.id": "/redfish/v1/Chassis/1/Sensors/Oem/Public/Temperature/CPU1_PMem_Temp"

        },

        {

            "@odata.id": "/redfish/v1/Chassis/1/Sensors/Oem/Public/Temperature/CPU2_PMem_Temp"

        },

        {

            "@odata.id": "/redfish/v1/Chassis/1/Sensors/Oem/Public/Temperature/Busbar_Zone"

        },

        {

            "@odata.id": "/redfish/v1/Chassis/1/Sensors/Oem/Public/Temperature/Outlet_Temp"

        }

    ],

    "[email protected]": 16,

    "Name": "Temperature Sensor Collection",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    }

}

响应码：200

【输出说明】

表4-56 查询指定类型传感器列表信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

传感器列表模型的OData 描述信息

@odata.id

字符串

传感器列表资源的访问路径

Name

字符串

传感器列表资源名称

@odata.type

字符串

传感器列表资源的类型

Description

字符串

传感器列表资源描述

Members

数组

指定类型传感器成员所在路径

[email protected]

数字

指定类型传感器种类数量

 

4.2.25  查询单个传感器资源的历史信息

【功能描述】

查询单个传感器资源的历史信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Chassis/chassis_id/Sensors/Oem/Public/sensors_type/sensors_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-57 查询单个传感器资源的历史信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

chassis_id

机箱资源的ID

当前所有机型取值为1

sensors_ type

传感器类型

通过查询传感器种类集合信息获取

sensors_id

传感器ID

通过查询指定类型传感器列表信息获取

 

【使用实例】

【请求样例】

GET https://192.168.1.18/redfish/v1/Chassis/1/Sensors/Oem/Public/Temperature/CPU1_Temp

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#Sensors_Temperature.Sensors_Temperature",

    "@odata.id": "/redfish/v1/Chassis/1/Sensors/Oem/Public/Temperature/CPU1_Temp",

"@odata.type": "#SensorsInstance.v1_0_0.SensorsInstance",

"Actions": {

        "#Sensors.ResetStatistics": {

            "target": "/redfish/v1/Chassis/1/Sensors/Actions/Oem/Public/Temperature/CPU1_Temp/Sensors.ResetStatistics"

    }

},

    "Description": "Temperature Sensor Instance",

    "HistoricalHigh": 87,

    "HistoryData": [

        {

            "Average": null,

            "Description": "Unavailable",

            "Maximum": null,

            "Minimum": null,

            "Time": "2017-01-15T11:40:07+08:00"

        },

        ...

        {

            "Average": 46,

            "Description": "Normal",

            "Maximum": 48,

            "Minimum": 46,

            "Time": "2017-01-15T12:56:07+08:00"

        },

        ...

        {

            "Average": null,

            "Description": null,

            "Maximum": null,

            "Minimum": null,

            "Time": "2017-01-15T14:27:20+08:00"

        },

        ...

    ],

    "LastDay": {

        "Average": 84,

        "Maximum": 87,

        "Minimum": 45

    },

    "LastWeek": {

        "Average": 84,

        "Maximum": 87,

        "Minimum": 42

    },

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "SpecifiedTime": {

        "Average": 4294967295,

        "EndTime": null,

        "MaxEndTime": "2017-01-15T11:44:19+08:00",

        "Maximum": 4294967295,

        "MinStartTime": "2017-01-15T11:40:07+08:00",

        "Minimum": 4294967295,

        "StartTime": null

    },

    "StartTime": "1970-01-01T08:00:00+08:00",

    "TimeStamp": "2017-01-15T12:33:54+08:00"

}

响应码：200

【输出说明】

表4-58 查询单个传感器资源的历史信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

单个传感器资源模型的OData 描述信息

@odata.id

字符串

单个传感器资源的访问路径

@odata.type

字符串

单个传感器资源的类型

Actions

Sensors资源可执行的操作

#Sensors.ResetStatistics

对象

重新统计操作访问路径

Description

字符串

单个传感器资源描述

HistoricalHigh

数值

历史最大值

TimeStamp

字符串

历史最大值产生的时间

StartTime

字符串

开始统计的时间

LastDay

对象

最近一天传感器信息

LastWeek

对象

最近一周传感器信息

SpecifiedTime

对象

指定时间段的传感器信息

Average

数值

平均值

Maximum

数值

最大值

Minimum

数值

最小值

SpecifiedTime.StartTime

字符串

统计指定时间段传感器数据的开始时间

SpecifiedTime.EndTime

字符串

统计指定时间段传感器数据的结束时间

SpecifiedTime.MinStartTime

字符串

统计指定时间段传感器数据的最小可开始时间

SpecifiedTime.MaxEndTime

字符串

统计指定时间段传感器数据的最大可结束时间

HistoryData.Description

字符串，null

采样点数据描述：

Normal： 正常值

Unavailable：传感器不可用

null：未采样

HistoryData

数组

历史数据

Time

字符串

采样时间

 

4.2.26  重新统计指定传感器的最高历史温度信息

【功能描述】

重新统计指定传感器的最高历史温度信息。

【所属权限模块】

维护诊断

【命令格式】

POST https://device_ip/redfish/v1/Chassis/chassis_id/Sensors/Actions/Oem/Public/sensors_type/sensors_id/Sensors.ResetStatistics

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

//基于当前时间重新统计最高历史温度信息

{

}

//统计指定时间段的最高历史温度信息

{

  "SpecifiedTime": {

      "StartTime": "2019-02-14T20:21:36+08:00",

      "EndTime": "2019-03-14T20:21:36+08:00"

  }

}

【参数说明】

表4-59 重新统计指定传感器的最高历史温度信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

chassis_id

机箱资源的ID

当前所有机型取值为1

sensors_ type

传感器类型

通过查询传感器种类集合信息获取

sensors_id

传感器ID

通过查询指定类型传感器列表信息获取

SpecifiedTime.StartTime

指定时间段开始时间

字符串，Redfish标准格式，如

2019-02-14T20:21:36+08:00

SpecifiedTime.EndTime

指定时间段结束时间

字符串，Redfish标准格式，如

2019-02-14T20:21:36+08:00

说明：开始时间和结束时间需同时下发，否则基于当前时间重新统计历史温度信息

 

【使用实例1】

//基于当前时间重新统计最高历史温度信息

【请求样例】

POST https://192.168.1.18/redfish/v1/Chassis/1/Sensors/Actions/Oem/Public/Temperature/TEST2_Threshold/Sensors.ResetStatistics

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

}

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#Sensors_Temperature.Sensors_Temperature",

    "@odata.id": "/redfish/v1/Chassis/1/Sensors/Oem/Public/Temperature/TEST2_Threshold",

    "@odata.type": "#SensorsInstance.v1_0_0.SensorsInstance",

    "Description": "Temperature Instance",

    "HistoricalHigh": 100,

    "HistoryData": [

        {

            "Average": null,

            "Description": "Unavailable",

            "Maximum": null,

            "Minimum": null,

            "Time": "2017-01-15T15:36:59+08:00"

        },

        ...

        {

            "Average": 46,

            "Description": "Normal",

            "Maximum": 48,

            "Minimum": 46,

            "Time": "2017-01-15T18:04:23+08:00"

        },

        ...

        {

            "Average": null,

            "Description": null,

            "Maximum": null,

            "Minimum": null,

            "Time": "2017-01-15T20:21:41+08:00"

        },

        ...

    ],

    "LastDay": {

        "Average": 50,

        "Maximum": 100,

        "Minimum": 0

    },

    "LastWeek": {

        "Average": 50,

        "Maximum": 100,

        "Minimum": 0

    },

    "SpecifiedTime": null,

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "StartTime": "1970-01-01T08:00:00+08:00",

    "TimeStamp": "2017-01-15T14:03:56+08:00"

}

响应码：200

【使用实例2】

//统计指定时间段的最高历史温度信息

【请求样例】

POST https://192.168.1.18/redfish/v1/Chassis/1/Sensors/Actions/Oem/Public/Temperature/TEST2_Threshold/Sensors.ResetStatistics

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

  "SpecifiedTime": {

      "StartTime": "2019-02-14T20:21:36+08:00",

      "EndTime": "2019-03-14T20:21:36+08:00"

  }

}

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#Sensors_Temperature.Sensors_Temperature",

    "@odata.id": "/redfish/v1/Chassis/1/Sensors/Oem/Public/Temperature/TEST2_Threshold",

    "@odata.type": "#SensorsInstance.v1_0_0.SensorsInstance",

    "Description": "Temperature Instance",

    "HistoricalHigh": 100.0,

    "HistoryData": [

        {

            "Average": null,

            "Description": "Unavailable",

            "Maximum": null,

            "Minimum": null,

            "Time": "2017-01-15T15:36:59+08:00"

        },

        ...

        {

            "Average": 46,

            "Description": "Normal",

            "Maximum": 48,

            "Minimum": 46,

            "Time": "2017-01-15T18:04:23+08:00"

        },

        ...

        {

            "Average": null,

            "Description": null,

            "Maximum": null,

            "Minimum": null,

            "Time": "2017-01-15T20:21:41+08:00"

        },

        ...

    ],

    "LastDay": {

        "Average": 50.75,

        "Maximum": 100.0,

        "Minimum": 0.0

    },

    "LastWeek": {

        "Average": 50.75,

        "Maximum": 100.0,

        "Minimum": 0.0

    },

    "SpecifiedTime": {

        "Average": 50.75,

        "Maximum": 100.0,

        "Minimum": 0.0

        "StartTime": "2019-02-14T20:21:36+08:00",

        "EndTime": "2019-03-14T20:21:36+08:00"

    },

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "StartTime": "1970-01-01T08:00:00+08:00",

    "TimeStamp": "2017-01-15T14:03:56+08:00"

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回字段说明同【查询单个传感器资源的历史信息】

 

4.2.27  查询扩展卡列表

【功能描述】

查询服务器扩展板卡列表信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Chassis/chassis_id/Boards

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-60 查询扩展卡列表信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

chassis_id

机箱资源的ID

当前所有机型取值为1

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【使用实例】

【请求样例】

GET http://172.16.13.176/redfish/v1/Chassis/1/Boards

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#BoardsCollection.BoardsCollection",

    "@odata.id": "/redfish/v1/Chassis/1/Boards/",

    "@odata.type": "#BoardsCollection.BoardsCollection",

    "Members": [

        {

            "@odata.id": "/redfish/v1/Chassis/1/Boards/Motherboard"

        },

        {

            "@odata.id": "/redfish/v1/Chassis/1/Boards/DSDCard"

        },

        {

            "@odata.id": "/redfish/v1/Chassis/1/Boards/LiquidCooler"

        },

        {

            "@odata.id": "/redfish/v1/Chassis/1/Boards/BMCCard"

        },

        {

            "@odata.id": "/redfish/v1/Chassis/1/Boards/Other"

        }

    ],

    "[email protected]": 5,

    "Name": "Boards Collection",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    }

}

响应码：200

【输出说明】

表4-61 查询扩展卡列表信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

扩展卡列表资源模型的 OData 描述信息

@odata.id

字符串

扩展卡列表资源的访问路径

@odata.type

字符串

扩展卡列表资源的类型

Members

数组

扩展卡查询路径

Name

字符串

扩展卡资源名称

[email protected]

数值

扩展卡个数

 

4.2.28  查询指定扩展卡信息

【功能描述】

查询扩展卡信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Chassis/chassis_id/Boards/board_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-62 查询指定扩展卡信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

chassis_id

机箱资源的ID

当前所有机型取值为1

board_id

扩展卡ID

根据扩展卡列表查询信息中查看

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【使用实例1】

#获取Motherboard的扩展板卡信息

【请求样例】

GET https://192.168.46.246/redfish/v1/Chassis/1/Boards/Motherboard

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#BoardsInstance.BoardsInstance",

    "@odata.id": "/redfish/v1/Chassis/1/Boards/Motherboard",

    "@odata.type": "#Boards.v1_0_0.Boards",

    "BoardId": null,

    "DeviceId": null,

    "Id": "Motherboard",

    "ManufactureDate": "2017-01-10T05:14:00+08:00",

    "Manufacturer": "N/A",

    "Model": "RS33M2C9S",

    "Name": "Motherboard",

    "Oem": {

        "Public": {

"BackPlane":null,

            "BMCCard": null,

            "CPLDVersion": "V001AD",

"CPLD1Version": "V001AD",

"CPLD2Version": "V001AC",

            "CompletionCode": 0,

            "Description": "Success",

            "DeviceType": "MainBoard",

            "ExpandedBoard": null,

            "MainBoard": null,

            "PCBVersion": "VER.B",

            "SCPLDVersion": "V001AC",

            "SubDeviceType": null,

            "iFIST": null

        }

    },

    "PartNumber": "0231A111",

    "ProductName": "RS33M2C9S",

    "SerialNumber": "210231A1110000000001",

    "Status": {

        "Health": "OK",

        "Oem": {

            "Public": {

                "FaultDescription": "",

                "Severity": "Informational"

            }

        },

        "State": "Enabled"

    },

    "Version": ""

}

响应码：200

【使用实例2】

#获取Riser2的扩展板卡信息

【请求样例】

GET http://172.16.13.176/redfish/v1/Chassis/1/Boards/Riser2

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#BoardsInstance.BoardsInstance",

    "@odata.id": "/redfish/v1/Chassis/1/Boards/Riser2",

    "@odata.type": "#Boards.v1_0_0.Boards",

    "BoardId": null,

    "DeviceId": null,

    "Id": "Riser2",

    "ManufactureDate": "2017-06-20T23:46:00+08:00",

    "Manufacturer": "H3C",

    "Model": "RS32B12L",

    "Name": "Riser2",

    "Oem": {

        "Public": {

"BackPlane":null,

            "BMCCard": null,

"CPLD1Version": null,

"CPLD2Version": null,

            "CPLDVersion": null,

            "CompletionCode": 0,

            "Description": "Success",

            "DeviceType": "PCIeConventor",

            "ExpandedBoard": null,

            "MainBoard": null,

            "PCBVersion": "VER.A",

            "SCPLDVersion": null,

            "SubDeviceType": "Riser",

            "iFIST": null

        }

    },

    "PartNumber": "0302A2N3",

    "ProductName": "RS32B12L",

    "SerialNumber": "02A2N31234567890",

    "Status": {

        "Health": "OK",

        "Oem": {

            "Public": {

                "FaultDescription": "",

                "Severity": "Informational"

            }

        },

        "State": "Enabled"

    },

    "Version": ""

}

响应码：200

【使用实例3】

#获取BMCCard信息

【请求样例】

GET http://172.16.13.176/redfish/v1/Chassis/1/Boards/BMCCard

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#BoardsInstance.BoardsInstance",

    "@odata.id": "/redfish/v1/Chassis/1/Boards/BMCCard",

    "@odata.type": "#Boards.v1_0_0.Boards",

    "BoardId": null,

    "DeviceId": null,

    "Id": "BMCCard",

    "ManufactureDate": "2017-06-20T23:46:00+08:00",

    "Manufacturer": "H3C",

    "Model": "RS32B12L",

    "Name": "BMCCard",

    "Oem": {

        "Public": {

"BackPlane":null,

            "BMCCard": {

                "BackUpMode": "Golden Image",

                "ChipManufacture":"ASPEED",

                "ChipModel":"AST2600"

                "ECCCount": 0,

                "ImageState": "Normal",

                "ProcessStartupResult": "Successful",

                "RAMState": "Normal",

                "SDCardState": "Enabled",

                "UECCCount": 0,

                "VARMSizeMB": 64

            },

"CPLD1Version": "V001A5",

"CPLD2Version": null,

            "CPLDVersion": "V001A5",

            "CompletionCode": 0,

            "Description": "Success",

            "DeviceType": "BMCCard",

            "ExpandedBoard": null,

            "MainBoard": null,

            "PCBVersion": "",

            "SCPLDVersion": null,

            "SubDeviceType": null,

            "iFIST": {

                "SDCardSizeGB": null,

                "SDCardState": "Absent",

                "Version": null,

                "iFISTState": "Absent"

            }

        }

    },

    "PartNumber": "0302A2N3",

    "ProductName": "RS32B12L",

    "SerialNumber": "210231A8L0H199BING",

    "Status": {

        "Health": "OK",

        "Oem": {

            "Public": {

                "FaultDescription": "",

                "Severity": "Informational"

            }

        },

        "State": "Enabled"

    },

    "Version": ""

}

响应码：200

"

}

响应码：200

【使用实例4】

#获取FrontBackplane1信息

【请求样例】

GET http://172.16.13.176/redfish/v1/Chassis/1/Boards/FrontBackplane1

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#BoardsInstance.BoardsInstance",

    "@odata.id": "/redfish/v1/Chassis/1/Boards/FrontBackplane1",

    "@odata.type": "#Boards.v1_0_0.Boards",

    "BoardId": null,

    "DeviceId": null,

    "Id": "FrontBackplane1",

    "ManufactureDate": "2023-01-16T17:12:00+08:00",

    "Manufacturer": "N/A",

    "Model": "RS36B08SUF",

    "Name": "FrontBackplane1",

    "Oem": {

        "Public": {

            "BMCCard": null,

            "BackPlane": {

                "DrivesCount": 1,

                "PortCount": 8,

                "Type": "Unibay"

            },

            "CPLD1Version": "V004",

            "CPLD2Version": null,

            "CPLDVersion": "V004",

            "CompletionCode": 0,

            "Description": "Success",

            "DeviceType": "BackPlane",

            "ExpandedBoard": null,

            "MainBoard": null,

            "PCBVersion": "VER.B",

            "SCPLDVersion": null,

            "SubDeviceType": null,

            "iFIST": null

        }

    },

    "PartNumber": "9803A077",

    "ProductName": "RS36B08SUF",

    "SerialNumber": "219803A0776231V00008",

    "Status": {

        "Health": "OK",

        "Oem": {

            "Public": {

                "FaultDescription": "",

                "Severity": "Informational"

            }

        },

        "State": "Enabled"

    },

    "Version": ""

}响应码：200

【输出说明】

表4-63 查询指定扩展卡信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

指定扩展卡资源模型的 OData 描述信息

@odata.id

字符串

指定扩展卡资源的访问路径

@odata.type

字符串

指定扩展卡资源的类型

BoardId

字符串

指定扩展板卡单板ID

DeviceId

字符串

设备号

Id

字符串

指定扩展卡资源ID

ManufactureDate

字符串

制造日期

Manufacturer

字符串

制造商

PartNumber

字符串

部件号

ProductName

字符串

产品名称

SerialNumber

字符串

序列号

Model

字符串

型号

Status.Health

字符串

指定扩展卡的健康状态

Status.State

字符串

指定扩展卡的使能状态

Status.Oem.Public. Severity

字符串

指定扩展卡的自定义健康状态

Status.Oem.Public. FaultDescription

字符串

指定扩展卡的故障描述信息

Version

字符串

版本号

Name

字符串

指定扩展卡资源名称

Oem.Public.DeviceType

字符串

一级扩展卡类型

MainBoard      主板

CalculationModule   计算节点

CPUBoard      CPU扣板

BackPlane      硬盘背板

PDB          电源板

MDB         中置背板

Expander   扩展板

PCIeConventor   PCIe转接卡

DiagPanel   诊断面板

GPUPanel    GPU面板

SecurityBezel     安全面板

BMCCard    管理板

BoardAdapter 转接板

Other    其他部件

Oem.Public.SubDeviceType

字符串

二级扩展卡类型

SASSwitch      SAS拓展板

PCIeSwitch       PCIE拓展板

Retimer       Retimer卡

Redriver      Redriver卡

Riser           Riser卡

M2Conventor       M.2转接卡

OPCconventor     OCP转接卡

LOMConventor    LOM转接卡

MEZZConventor   Mezz转接卡

HotPlugRiser    热插拔Riser

ClockCard    时钟卡

DeltaNextBoard  GPU模组（delta-next板）

Oem.Public.CPLDVersion

字符串

单板CPLD版本

Oem.Public.PCBVersion

字符串

PCB版本

Oem.Public.SCPLDVersion

字符串

SCPLD版本信息，比如：主板或背板的辅CPLD

Oem.Public.CPLD1Version

字符串

CPLD1版本，与CPLD版本含义相同

Oem.Public.CPLD2Version

字符串

CPLD2版本，与SCPLD版本含义相同

Oem.Public.ExpandedBoard.CurrentFirmwareVersion

字符串

扩展板卡芯片当前固件版本

Oem.Public.ExpandedBoard.CurrentConfigurationVersion

字符串

扩展板卡芯片当前配置文件版本

Oem.Public.ExpandedBoard.BootloaderVersion

字符串

扩展板卡芯片BootLooder版本

Oem.Public.ExpandedBoard.EEPROMVersion

字符串

扩展板卡芯片EEPROM版本

Oem.Public.MainBoard.PFRCPLDVersion

字符串

主板PFRCPLD版本

Oem.Public.BackPlane.DrivesCount

数值

背板硬盘在位数量

Oem.Public.BackPlane.PortCount

数值

背板端口数量

Oem.Public.BackPlane.Type

字符串

背板类型

Oem.Public.BMCCard.BackUpMode

字符串

备份方案

Oem.Public.BMCCard.ChipManufacture

字符串

BMC芯片厂商

Oem.Public.BMCCard.ChipModel

字符串

BMC芯片型号

Oem.Public.BMCCard.SDCardState

字符串

SD卡状态

Absent/Enabled/PartLose/AccessFailed

不在位/正常/分区丢失/访问失败

Oem.Public.BMCCard.ECCCount

数值

BMC卡内存状态异常时ECC数量

Oem.Public.BMCCard.UECCCount

数值

BMC卡内存状态异常时UECC数量

Oem.Public.BMCCard.RAMState

字符串

BMC卡内存状态：正常或错误Nomal/Error

Oem.Public.BMCCard.VARMSizeMB

数值

显存大小，单位MB

Oem.Public.BMCCard.ProcessStartupResult

字符串

关键进程是否启动成功 Successful/Failed

Oem.Public.BMCCard.ImageState

字符串

Image状态：正常或错误 Nomal/Error

Oem.Public.iFIST.iFISTState

字符串

iFIST状态：是否在位Absent/Enabled

Oem.Public.iFIST.SDCardState

字符串

iFIST上的sd的状态：Absent/Enabled

不在位/正常

Oem.Public.iFIST.SDCardSizeGB

数值

iFIST上的sd的容量

Oem.Public.iFIST.Version

字符串

iFIST版本信息

 

【修改记录】

(1)     HDM2-1.54：修改示例中Baseboard为Motherboard；删除Oem.Public.DeviceType字段说明中SMC返回值；修改Oem.Public.DeviceType字段说明中BMCCard中文描述为‘管理板’；新增字段Oem.Public.CPLD1Version及Oem.Public.CPLD2Version；

(2)     HDM2-1.55：DeviceType字段说明中新增类型BoardAdapter；SubDeviceType字段说明中新增类型DeltaNextBoard；

(3)     HDM2-1.58：新增字段Oem.Public.BMCCard.ChipManufacture及Oem.Public.BMCCard.ChipModel；

(4)     HDM2-2.04：新增字段Oem.Public.BackPlane.DrivesCount、Oem.Public.BackPlane.PortCount及Oem.Public.BackPlane.Type；

 

4.2.29  查询PCIE卡列表

【功能描述】

查询PCIE卡列表信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Chassis/chassis_id/PCIeDevices

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-64 查询PCIE卡列表信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

chassis_id

机箱资源的ID

当前所有机型取值为1

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【使用实例】

【请求样例】

GET http://172.16.13.176/redfish/v1/Chassis/1/PCIeDevices

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#PCIeDevicesCollection.PCIeDevicesCollection(*)",

    "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices",

    "@odata.type": "#PCIeDeviceCollection.PCIeDeviceCollection",

    "Members": [

        {

            "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/3"

        }

    ],

    "[email protected]": 1,

    "Name": "PCIeDevices Collection",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    }

}

响应码：200

【输出说明】

表4-65 查询PCIE卡列表信息输出字段说明

字段

类型

字段说明

@odata.context

字符串

PCIE列表资源模型的 OData 描述信息

@odata.id

字符串

PCIE列表资源的访问路径

@odata.type

字符串

PCIE列表资源的类型

Members

数组

PCIE设备查询路径

[email protected]

数值

PCIE设备个数

Name

字符串

PCIE设备资源名称

 

4.2.30  查询指定PCIE卡设备信息

【功能描述】

查询指定的PCIE卡设备信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Chassis/chassis_id/PCIeDevices/pciedevices_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-66 查询PCIE卡信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

chassis_id

机箱资源的ID

当前所有机型取值为1

pciedevices _id

PCIE卡ID

由PCIE卡集合中查询

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【使用实例1】

#获取NIC卡的PCIe信息

【请求样例】

GET http://172.16.13.176/redfish/v1/Chassis/1/PCIeDevices/23

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#PCIeDevice.PCIeDevice",

    "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/23",

"@odata.type": "#PCIeDevice.v1_5_0.PCIeDevice",

"CardManufacturer": null,

"CardModel": null,

    "Description": "OCP-1",

    "FirmwareVersion": "N/A",

    "Id": "PCIeCard23",

    "Links": {

        "Chassis": [

            {

                "@odata.id": "/redfish/v1/Chassis/1"

            }

        ],

        "PCIeFunctions": [

            {

                "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/23/Functions/1"

            }

        ]

    },

    "Manufacturer": "H3C",

    "Model": "NIC-ETH640F-3S-2P",

    "Name": "NIC-ETH640F-3S-2P",

    "Oem": {

        "Public": {

            "ChipManufacturer": "Mellanox",

            "ChipModel": "ConnectX-4",

            "CompletionCode": 0,

            "Description": "Success",

            "DeviceLocator": "PCIe Card23",

            "PCIeCardType": "NIC",

            "Position": 23,

            "SlotNumber": 23

        }

    },

    "PCIeInterface": {

        "LanesInUse": 8,

        "MaxLanes": 8

    },

    "PartNumber": "0302A2N4",

    "SerialNumber": "222235A022B2B221A",

    "Status": {

        "Health": "OK",

        "Oem": {

            "Public": {

                "FaultDescription": "",

                "Severity": "Informational"

            }

        },

        "State": "Enabled"

    }

}

响应码：200

【使用实例2】

#获取GPU卡的PCIe信息

【请求样例】

GET http://172.16.13.176/redfish/v1/Chassis/1/PCIeDevices/5

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#PCIeDevice.PCIeDevice",

    "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/5",

"@odata.type": "#PCIeDevice.v1_2_0.PCIeDevice",

"CardManufacturer": null,

"CardModel": null,

    "Description": "",

    "FirmwareVersion": "88.00.1A.00.03",

    "Id": "PCIeCard5",

    "Links": {

        "Chassis": [

            {

                "@odata.id": "/redfish/v1/Chassis/1"

            }

        ],

        "PCIeFunctions": [

            {

                "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/5/Functions/1"

            }

        ]

    },

    "Manufacturer": "NVIDIA",

    "Model": "Tesla V100-PCIE-16G",

    "Name": "Tesla V100-PCIE-16G",

    "Oem": {

        "Public": {

            "ChipManufacturer": "NVIDIA",

            "ChipModel": "",

            "CompletionCode": 0,

            "Description": "Success",

            "DeviceLocator": "PCIe Card5",

"DriverVersion": "N/A",

            "ECCEnable": 1,

            "GCUVoltage": 0.75,

            "GPUDeviceError": 16384,

            "GPUMemoryError": 16384,

            "HBMVoltage": 1.25,

            "MemorySizeMiB": 16384,

"PCIeBusError": 16384,

            "PCIeCardType": "GPU",

            "Position": 5,

            "PowerCapacityWatts": 70,

            "PowerWatts": 70,

"ProductDate": "20240517",

"SlotMapping":"OAM2",

            "SlotNumber": 5

        }

    },

    "PCIeInterface": {

        "LanesInUse": 16,

        "MaxLanes": null

},

"PartNumber": "0302A2N9",

    "SerialNumber": "0323617020478",

    "Status": {

        "Health": "OK",

         "Oem": {

            "Public": {

                "FaultDescription": "",

                "Severity": "Informational"

            }

        },

        "State": "Enabled"

    }

}

响应码：200

【输出说明】

表4-67 查询指定PCIE卡设备信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

指定PCIE卡资源模型的 OData 描述信息

@odata.id

字符串

指定PCIE卡资源的访问路径

@odata.type

字符串

指定PCIE卡资源的类型

CardManufacturer

字符串

指定PCIE卡资源的设备制造商

CardModel

字符串

指定PCIE卡资源的设备型号

Description

字符串

指定PCIe设备的描述

FirmwareVersion

字符串

指定PCIe设备的固件版本

Id

字符串

指定PCIe设备资源ID

Links.Chassis

数组

指定机箱资源的访问路径

Links.PCIeFunctions

数组

指定PCIe功能的访问路径

PCIeInterface.LanesInUse

数值

指定PCIe设备当前协商的PCIe lane数

PCIeInterface.MaxLanes

数值

指定PCIe设备支持的最大PCIe lane数

Manufacturer

字符串

指定PCIe设备的生产厂商

Model

字符串

指定PCIe设备的型号

Name

字符串

指定PCIe设备资源名称

SerialNumber

字符串

指定PCIe设备的序列号

PartNumber

字符串

指定PCIe设备的部件号

Oem.Public.ChipManufacturer

字符串

指定PCIe设备的芯片厂商

Oem.Public.ChipModel

字符串

指定PCIe设备的芯片型号

Oem.Public.DeviceLocator

字符串

指定PCIe设备的丝印

Oem.Public.PCIeCardType

字符串

指定PCIe设备的类型，如：

l     GPU

l     FPGA

l     NIC

l     RAID

l     SAS

l     FC

l     IB

l     OEM

l     QAT

l     SWITCH

l     PCIE_AUX

Oem.Public.Position

数值

指定PCIe设备的容器

Oem.Public.SlotNumber

数值

指定PCIe设备的槽位号

Oem.Public.FunctionType

字符串

指定PCIe设备的类型【当前未实现】

Oem.Public.McuFirmwareVersion

字符串

指定PCIe设备相关的MCU固件版本【当前未实现】

Oem.Public.PowerWatts

数值

指定PCIe设备当前功耗（GPU）

注：部分Nvidia GPU需要安装驱动并执行“nvidia-smi -pm 1”命令才能获取当前功耗

Oem.Public.PowerCapacityWatts

数值

指定PCIe设备额定功率（GPU）

Oem.Public.MemorySizeMiB

数值

指定PCIe设备显存（GPU）

Oem.Public.SlotMapping

字符串

指定PCIe设备实际物理槽位与Slot映射（GPU）

Oem.Public.DriverVersion

字符串

驱动版本号（仅燧原S60GPU支持）

Oem.Public.ECCEnable

字符串

ECC使能状态（仅燧原S60GPU支持）

Oem.Public.GCUVoltage

数值

GCU电压（仅燧原S60GPU支持），单位：V

Oem.Public.HBMVoltage

数值

HBM电压（仅燧原S60GPU支持），单位：V

Oem.Public.GPUDeviceError

数值

GPU外设错误（仅燧原S60GPU支持）

注：

0： 表示健康

16384： 表示加速卡外设发生 recoverable error

32768： 表示加速卡外设发生 Non-recoverable error

Oem.Public.PCIeBusError

数值

PCIe错误（仅燧原S60GPU支持）

注：

0：表示健康

16384：表示加速卡PCIe 总线发生 recoverable error

32768：表示加速卡PCIe 总线发生 Non-recoverable error

Oem.Public.GPUMemoryError

数值

GPU内存错误（仅燧原S60GPU支持）

注：

0：表示健康

16384：表示加速卡显存发生 recoverable error

32768：表示加速卡显存发生 Non-recoverable error

Oem.Public.ProductDate

字符串

产品生产日期（仅燧原S60GPU支持）

Status.Health

字符串

指定PCIe设备资源健康状态

Status.State

字符串

指定PCIe设备资源使能状态

Status.Oem.Public.Severity

字符串

指定PCIe设备资源的自定义健康状态

Status.Oem.Public.FaultDescription

字符串

指定PCIe设备资源的故障描述信息

 

【修改记录】

(1)     HDM2-1.53：修改FirmwareVersion字段说明；

(2)     HDM2-2.04：Oem.Public.PCIeCardType字段新增PCIE_AUX取值；

(3)     HDM2-2.04：新增Oem.Public.SlotMapping字段；

(4)     HDM2-2.04：新增字段CardManufacturer及CardModel；

(5)     HDM2-2.10：新增字段Oem.Public.DriverVersion、Oem.Public.ECCEnable、Oem.Public.GCUVoltage、Oem.Public.HBMVoltage、Oem.Public.GPUDeviceError、Oem.Public.PCIeBusError、Oem.Public.GPUMemoryError、Oem.Public.ProductDate；

 

4.2.31  查询指定PCIE卡功能信息

【功能描述】

查询指定的PCIE卡功能信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Chassis/chassis_id/PCIeDevices/pciedevices_id/Functions/1

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-68 查询指定PCIE卡功能信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

chassis_id

机箱资源的ID

当前所有机型取值为1

pciedevices _id

PCIE卡ID

由PCIE卡集合中查询

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【使用实例】

【请求样例】

GET http://172.16.13.176/redfish/v1/Chassis/1/PCIeDevices/23/Functions/1

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#PCIeDevicesFunctionsInstance.PCIeDevicesFunctionsInstance",

    "@odata.id": "/redfish/v1/Chassis/23/PCIeDevices/23/Functions/1",

    "@odata.type": "#PCIeFunction.v1_3_0.PCIeFunction",

    "DeviceId": "0x1015",

    "Id": "1",

    "Manufacturer": "H3C",

    "Name": "Function1",

    "Oem": {

        "Public": {

"BDF": null,

            "BusNumber": "0x16",

            "CPUId": "1",

            "CompletionCode": 0,

            "Datawidth": "x8",

            "Description": "Success",

            "DeviceClass": "SignalProcessingController",

            "DeviceNumber": "0",

            "FunctionNumber": "0",

            "MaxDatawidth": "x16",

            "MaxSpeed": "8.0GT/s",

            "MezzSlot": null,

            "MaxProtocol": "Gen 3",

            "Negotiatedspeed": "8.0GT/s",

            "Protocol": "Gen 3",

            "RiserId": "N/A",

"LinkWidthAbility":"x16",

"RootBDF": null

        }

    },

    "PartNumber": "0302A2N4",

    "ProductName": "NIC-ETH640F-3S-2P",

    "SerialNumber": "222235A022B2B221A",

    "Status": {

        "Health": "OK",

        "State": "Enabled"

    },

    "SubsystemId": "0x1083",

    "SubsystemVendorId": "0x193D",

    "VendorId": "0x15B3"

}

响应码：200

【输出说明】

表4-69 查询指定PCIE卡功能信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

指定PCIE卡资源模型的 OData 描述信息

@odata.id

字符串

指定PCIE卡资源的访问路径

@odata.type

字符串

指定PCIE卡资源的类型

DeviceId

字符串

指定PCIe设备的设备ID

VendorId

字符串

指定PCIe设备的厂商ID

Id

字符串

指定PCIe功能资源ID

SubsystemId

字符串

子系统ID

SubsystemVendorId

字符串

子系统供应商ID

Manufacturer

字符串

指定 PCIe 设备的生产厂商

PartNumber

字符串

部件号

ProductName

字符串

产品名称

SerialNumber

字符串

序列号

Status

对象

指定PCIe设备功能的状态， 包括：

Health：指定设备资源健康状态

State：指定设备资源使能状态

Oem.Public.BDF

字符串

设备资源属性

Oem.Public.RootBDF

字符串

端口资源属性

Oem.Public.Datawidth

字符串

协商带宽

Oem.Public.MaxDatawidth

字符串

最大带宽

Oem.Public.MaxSpeed

字符串

最大速率

Oem.Public.LinkWidthAbility

字符串

最大带宽

Oem.Public.Negotiatedspeed

字符串

协商速率

Oem.Public.Protocol

字符串

协商协议

Oem.Public.Slot

字符串

PCIe槽位号

Oem.Public.RiserId

字符串

Riser编号

Oem.Public.CPUId

字符串

所属CPU

Oem.Public.MezzSlot

字符串

Mezz槽位字段

Oem.Public.BusNumber

字符串

指定PCIe设备总线号

Oem.Public.DeviceClass

字符串

指定PCIe设备分类

Oem.Public.DeviceNumber

字符串

指定PCIe设备设备号

Oem.Public.FunctionNumber

字符串

指定PCIe设备功能号

Oem.Public.MaxProtocol

字符串

指定PCIe最高协议

Name

字符串

指定PCIe功能资源名称

 

【修改记录】

(1)     HDM2-2.04：添加新字段Oem.Public.BDF和Oem.Public.RootBDF；

(2)     HDM3-1.14：添加新字段Oem.Public.BDF和Oem.Public.RootBDF同步HDM3；

 

4.2.32  查询网络适配器集合资源信息

【功能描述】

查询设备的网络适配器集合资源信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Chassis/chassis_id/NetworkAdapters

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-70 查询网络适配器集合资源信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

chassis_id

机箱资源的ID

当前所有机型取值为1

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

 

【使用实例】

【请求样例】

GET http://172.16.13.176/redfish/v1/Chassis/1/NetworkAdapters

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#NetworkAdapterCollection.NetworkAdapterCollection",

    "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters",

    "@odata.type": "#NetworkAdapterCollection.NetworkAdapterCollection",

    "Description": "Collection of ethernet interfaces for this system",

    "Members": [

        {

            "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot1"

        }

    ],

    "[email protected]": 1,

    "Name": "NetworkAdapter Collection",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    }

}

响应码：200

【输出说明】

表4-71 查询网络适配器集合资源信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

网络适配器集合资源模型的OData 描述信息

@odata.id

字符串

网络适配器集合资源的访问路径

@odata.type

字符串

网络适配器集合资源的类型

Description

字符串

网络适配器集合资源信息的描述

Members

网络适配器资源列表

@odata.id

字符串

单个网络适配器资源节点的访问路径

[email protected]

数值

网络适配器资源数量

Name

字符串

网络适配器资源名称

 

4.2.33  查询网络适配器单个资源信息

【功能描述】

查询指定的网络适配器资源信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Chassis/chassis_id/NetworkAdapters/networkadapter_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-72 查询网络适配器单个资源信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

chassis_id

机箱资源的ID

当前所有机型取值为1

networkadapter_id

网络适配器ID

由“查询网络适配器集合资源信息”中获取

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

 

【使用实例1】

#获取指定NIC卡的信息

【请求样例】

GET http://172.16.13.176/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot16

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata",

    "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot16",

    "@odata.type": "#NetworkAdapter.v1_5_0.NetworkAdapter",

    "Controllers": [

        {

            "ControllerCapabilities": {

                "NetworkPortCount": 2

            },

            "FirmwarePackageVersion": "2.0",

            "Links": {

                "NetworkPorts": [

                    {

                        "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot16/NetworkPorts/1"

                    },

                    {

                        "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot16/NetworkPorts/2"

                    }

                ],

                "[email protected]": 2,

                "PCIeDevices": [

                    {

                        "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/16"

                    }

                ],

                "[email protected]": 1

            }

        }

    ],

    "Id": "PCIeSlot16",

    "Manufacturer": "Intel",

    "Model": "NIC-ETH660F-3S-2P",

    "Name": "PCIeSlot16",

    "NetworkPorts": {

        "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot16/NetworkPorts"

    },

    "Oem": {

        "Public": {

            "CapableSpeedGbs": "25",

            "CardManufacturer": "H3C",

"CardMode": "NPAR",

            "CardModel": "2*25GE",

            "ChipModel": "E810",

            "CompletionCode": 0,

            "Configuration":{

               "CardTypeCode": "0302A5FQ",

               "DataOrigin": 2,

               "EffectiveLink": 0,

               "MultifunctionMode": "NPAR",

               "NPARLink": 44000,

               "PortsConfig": [

                   {

                       "16GFECConfig": "Disabled",

                       "ConnectionType": "Switch",

                       "PFsInfo": [

                           {

                               "FCoEFipMACAddress": "14:58:D0:D3:00:02",

                               "ISCSIAddress": "00:0a:f7:10:d8:71",

                               "PermanentAddress": "14:58:D0:D3:00:02",

                               "Protocol": "ETHERNET",

                               "WWNN": ":14:58:D0:D3:00:02",

                               "WWPN": ":14:58:D0:D3:00:02"

                           }

                       ],

                       "PortId": "0"

                   },

                   ……

               ]

            },

            "Description": "Success",

            "DeviceLocator": "PCIe Card16",

            "FirmwareVersion": "2.0",

"MCTPEnabled":false,

            "MezzSlot":"Mezz2",

            "NetworkTechnology": [

                "Ethernet"

            ],

            "OCPFan": {

                "Status": {

                    "Health": "Critical",

                    "Oem": {

                        "Public": {

                            "FaultDescription": "[PCIe_Card16]Fault Status asserted:---fan error in slot 16",

                            "Severity": "Major"

                        }

                    },

                    "State": "Absent"

                }

            },

            "PartNumber": "0302A5L9",

            "Position": "PCIe-16",

            "RootBDF": "0000:15:01.0",

            "SerialNumber": "02A5L902110M000G",

            "SlotNumber": 16,

            "TemperatureCelsius": 41

        }

    },

    "Status": {

        "Health": "OK",

        "Oem": {

            "Public": {

                "FaultDescription": "",

                "Severity": "Informational"

            }

        },

        "State": "Enabled"

    }

}

响应码：200

【使用实例2】

#获取指定FC卡的信息

【请求样例】

GET http://172.16.13.176/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot6

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata",

    "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot6",

    "@odata.type": "#NetworkAdapter.v1_5_0.NetworkAdapter",

    "Controllers": [

        {

            "ControllerCapabilities": {

                "NetworkPortCount": 2

            },

            "FirmwarePackageVersion": "12.8.351.47",

            "Links": {

                "NetworkPorts": [

                    {

                        "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot6/NetworkPorts/1"

                    },

                    {

                        "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot6/NetworkPorts/2"

                    }

                ],

                "[email protected]": 2,

                "PCIeDevices": [

                    {

                        "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/6"

                    }

                ],

                "[email protected]": 1

            }

        }

    ],

    "Id": "PCIeSlot6",

    "Manufacturer": "Emulex",

    "Model": "FC-HBA-LPe35002-LP-32Gb-2P",

    "Name": "PCIeSlot6",

    "NetworkPorts": {

        "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot6/NetworkPorts"

    },

    "Oem": {

        "Public": {

            "CapableSpeedGbs": "32",

            "CardManufacturer": "Emulex",

"CardMode": null,

            "CardModel": "2*32GE",

            "ChipModel": "XE601",

            "CompletionCode": 0,

            "Configuration":{

               "CardTypeCode": "0302A5FQ",

               "DataOrigin": 2,

               "EffectiveLink": 0,

               "MultifunctionMode": "NPAR",

               "NPARLink": 44000,

               "PortsConfig": [

                   {

                       "16GFECConfig": "Disabled",

                       "ConnectionType": "Switch",

                       "PFsInfo": [

                           {

                               "FCoEFipMACAddress": "14:58:D0:D3:00:02",

                               "ISCSIAddress": "00:0a:f7:10:d8:71",

                               "PermanentAddress": "14:58:D0:D3:00:02",

                               "Protocol": "ETHERNET",

                               "WWNN": ":14:58:D0:D3:00:02",

                               "WWPN": ":14:58:D0:D3:00:02"

                           }

                       ],

                       "PortId": "0"

                   },

                   ……

               ]

            },

            "Description": "Success",

            "DeviceLocator": "PCIe Card6",

            "FirmwareVersion": "12.8.351.47",

"MCTPEnabled":false,

            "MezzSlot":"Mezz2",

            "NetworkTechnology": [

                "FC"

            ],

            "PartNumber": null,

            "Position": "PCIe6",

            "ProductCode": "FC HBA",

            "RootBDF": null,

            "SerialNumber": null,

            "SlotNumber": 6,

            "TemperatureCelsius": 41

        }

    },

    "Status": {

        "Health": "OK",

        "Oem": {

            "Public": {

                "FaultDescription": "",

                "Severity": "Informational"

            }

        },

        "State": "Disabled"

    }

}

响应码：200

【输出说明】

表4-73 查询网络适配器单个资源信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

指定网络适配器资源模型的OData 描述信息

@odata.id

字符串

指定网络适配器资源的访问路径

@odata.type

字符串

指定网络适配器资源的类型

Manufacturer

字符串

指定网络适配器的芯片制造商

Model

字符串

指定网络适配器的型号

Name

字符串

网络适配器资源名称

Id

字符串

网络适配器资源Id

Oem.Public

指定网络适配器自定义信息

CapableSpeedGbs

字符串

规格速率

CardManufacturer

字符串

指定网络适配器的厂商

CardMode

字符串

指定网络适配器的卡模式

CardModel

字符串

指定网络适配器的接口类型

ChipModel

字符串

芯片型号

Configuration

对象

MEZZ卡信息

Configuration.CardTypeCode

字符串

MEZZ卡类型

Configuration.DataOrigin

数值

数据来源：

1：EEPROM

2：OM

Configuration.EffectiveLink

数值

端口连接生效状态，值为 0-65535。

每一个bit位代表一个端口，连接状态对应bit置1

Configuration.MultifunctionMode

字符串

端口的多功能模式：

SF 

NPAR 

Default 

QINQ_NPAR

QINQ_Default

Configuration.NPARLink

数值

NPAR开启状态下，各端口的连接状态，值为 0-65535

Configuration.PortsConfig

数组

端口配置信息

Configuration.PortsConfig.16GFECConfig

字符串

当前16G FEC配置

Enabled：已启用

Disabled：已禁用

Configuration.PortsConfig.ConnectionType

字符串

端口连接类型：

Switch

PTM_32G

PTM_16G

Configuration.PortsConfig.PFsInfo

数组

端口的物理功能信息

Configuration.PortsConfig.PFsInfo.FCoEFipMACAddress

字符串

FCoE MAC地址

Configuration.PortsConfig.PFsInfo.ISCSIAddress

字符串

ISCSI地址

Configuration.PortsConfig.PFsInfo.PermanentAddress

字符串

固定地址

Configuration.PortsConfig.PFsInfo.Protocol

字符串

协议名称

Configuration.PortsConfig.PFsInfo.WWNN

字符串

Node WWN

Configuration.PortsConfig.PFsInfo.WWPN

字符串

Port WWN

Configuration.PortsConfig.PortId

字符串

端口ID

MezzSlot

字符串

MEZZ槽位号

DeviceLocator

字符串

指定网络适配器的丝印信息

FirmwareVersion

字符串

指定网络适配器的固件版本

MCTPEnabled

布尔

MCTP使能状态

OCPFan

对象

OCP风扇信息

说明：FC HBA卡不支持该字段

OCPFan.Status

对象

指定OCP风扇状态，包括：

·     Health：OCP风扇健康状态

·     State：OCP风扇使能状态

·     Severity：自定义健康状态

·     FaultDescription：故障描述信息

说明：当OCP风扇使能状态为Absent时，表示OCP风扇缺失，会触发严重告警（Critical/ Major）

NetworkTechnology

数组

指定网络适配器的网络协议(仅适配部分网卡)：

·     Ethernet

·     FC

·     iSCSI

·     FCoE

·     OPA

·     IB

Position

字符串

指定网络适配器的容器

有"mLOM"，"sLOM"，"Embedded"…等

SerialNumber

字符串

序列号

PartNumber

字符串

部件号

Model

字符串

设备型号

SlotNumber

数值

指定网络适配器的槽位号

TemperatureCelsius

数值

当前温度

RootBDF

字符串

指定网络适配器的root port BDF

ProductCode

字符串

产品Code

FC HBA卡支持

[email protected]

数值

指定网络适配器相关PCIe设备个数

[email protected]

数值

指定网络适配器的相关网络端口个数

Controllers

描述适配器控制器的信息

ControllerCapabilities

指定网络适配器控制器能力信息

Links

指定网络适配器的相关单个对象

NetworkPorts

指定网络适配器的相关网络端口对象集合

PCIeDevices

指定网络适配器的相关PCIe对象集合

FirmwarePackageVersion

字符串

固件包版本

Status.Health

字符串

指定网络适配器健康状态

Status.State

字符串

指定网络适配器使能状态

Status.Oem.Public.Severity

字符串

自定义健康状态

Status.Oem.Public.FaultDescription

字符串

故障描述信息

 

【修改记录】

(1)     HDM2-1.59：添加新字段Oem.Public.CardMode；

(2)     HDM2-1.59：新增MEZZ卡相关字段；

(3)     HDM2-2.03：添加新字段Oem.Public.MCTPEnabled；

 

4.2.34  查询网络端口集合资源信息

【功能描述】

查询网络端口集合资源信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Chassis/chassis_id/NetworkAdapters/networkadapters_id/NetworkPorts

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-74 查询网络端口集合资源信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

chassis_id

机箱资源的ID

当前所有机型取值为1

networkadapters_id

网络适配器ID

由“查询网络适配器集合资源信息”中获取

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

 

【使用实例】

【请求样例】

GET http://172.16.13.176/redfish/v1/Chassis/1/NetworkAdapters/Embedded/NetworkPorts

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

  "@odata.context": "/redfish/v1/$metadata#NetworkPortCollection.NetworkPortCollection(*)",

  "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/Embedded/NetworkPorts",

  "@odata.type": "#NetworkPortCollection.NetworkPortCollection",

  "Members": [

    {

      "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/Embedded/NetworkPorts/1"

    },

    {

      "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/Embedded/NetworkPorts/2"

    }

  ],

  "[email protected]": 2,

  "Name": "Network Port Collection",

"Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    }

}

响应码：200

【输出说明】

表4-75 网络端口集合资源信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

网络端口集合资源模型的

OData描述信息

@odata.id

字符串

网络端口集合资源的访问路径

@odata.type

字符串

网络端口集合资源的类型

Name

字符串

网络端口集合资源的名称

Members

网络适配器资源列表

@odata.id

字符串

单个网络端口的访问路径

[email protected]

数值

网络端口资源数量

 

4.2.35  查询网络端口单个资源信息

【功能描述】

查询指定服务器机箱的网络端口单个资源信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Chassis/chassis_id/NetworkAdapters/networkadapteras_id/NetworkPorts/networkport_id

【请求头】            

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-76 查询网络端口单个资源信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

chassis_id

机箱资源的ID

当前所有机型取值为1

networkadapters_id

网络适配器ID

由“查询网络适配器集合资源信息”中获取

networkport_id

网络端口单个资源ID

由 “查询网络端口集合资源信息”中获取

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

 

【使用实例1】

#获取指定NIC卡的端口信息

【请求样例】

GET https://192.168.18.18/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot16/NetworkPorts/1

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#NetworkPort.NetworkPort",

    "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot16/NetworkPorts/1",

    "@odata.type": "#NetworkPort.v1_3_0.NetworkPort",

    "AssociatedNetworkAddresses": [

        "78:AA:82:CB:11:18"

    ],

    "CurrentLinkSpeedMbps": null,

    "Id": "1",

    "LinkStatus": "Down",

    "Name": "1",

    "Oem": {

        "Public": {

            "AutoNeg": true,

            "BDF": "0000:16:00.0",

            "CompletionCode": 0,

"CPUId":"CPU2",

            "Description": "Success",

"FatherPortNum": "1",

            "FullDuplex": false,

            "LldpService": {

                "LldpCurrentState": "N/A",

                "LldpEnabled": null,

                "WorkMode": ""

            },

            "PortMaxSpeed": "25000Mb/s",

            "PortType": "OpticalPort",

            "Slot": "Slot24"

        }

    },

    "PhysicalPortNumber": "1"

}

响应码：200

【使用实例2】

#获取指定FC卡的端口信息

【请求样例】

GET https://192.168.18.18/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot1/NetworkPorts/1

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#NetworkPort.NetworkPort",

    "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot1/NetworkPorts/1",

    "@odata.type": "#NetworkPort.v1_2_5.NetworkPort",

    "AssociatedNetworkAddresses": [],

    "CurrentLinkSpeedMbps": 0,

    "Id": "1",

    "LinkStatus": "N/A",

    "Name": "1",

    "Oem": {

        "Public": {

            "AutoNeg": null,

            "BDF": "0000:49:00.0",

            "CompletionCode": 0,

"CPUId": null,

            "Description": "Success",

"FatherPortNum": null,

            "FullDuplex": null,

            "LldpService": {

                "LldpCurrentState":null,

                "LldpEnabled": null,

                "WorkMode": null

            },

            "PortMaxSpeed": "16000Mb/s",

            "PortType": "ElectricalPort",

"Slot": null

        }

    },

    "PhysicalPortNumber": "1"

}

响应码：200

【输出说明】

表4-77 查询网络端口单个资源信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

网络端口资源模型的OData描述信息

@odata.id

字符串

网络端口资源的访问路径

@odata.type

字符串

网络端口资源的类型

AssociatedNetworkAddresses

数组

NIC：网口MAC地址

FC：第一个为WWPN，第二个为WWNN

Id

字符串

网络端口资源ID

Name

字符串

网络端口资源名称

PhysicalPortNumber

字符串

指定网络端口的物理丝印号

LinkStatus

字符串

端口状态(仅适配部分网卡)

Up

Down

N/A：表示不支持、获取失败(如BIOS重启中，BIOS关机、NCSI禁用)

CurrentLinkSpeedMbps

数值

端口协商速率，单位Mb/s

Oem.Public

自定义属性

PortType

字符串

指定网络端口的网口类型，包括：

 OpticalPort：光口

 ElectricalPort：电口

N/A：网口类型未知

BDF

字符串

指定网络端口的BDF

CPUId

字符串

指定网络端口的所属CPU

注：仅NIC卡支持

Slot

字符串

指定网络端口的所属槽位

注：仅NIC卡支持

AutoNeg

布尔

指定端口是否自动协商

true

false

FatherPortNum

字符串

指定端口的父端口号

FullDuplex

布尔

指定端口是否全双工

true

false

PortMaxSpeed

字符串

网络端口规格速率，单位Mb/s 如"10000Mb/s"

LldpService.LldpEnabled

布尔

指定网口的LLDP使能，包括：

true：使能

false：禁止

null：不支持LldpService

LldpService.WorkMode

字符串

LLDP工作模式：

Tx：发送模式

LldpService.LldpCurrentState

字符串

LLDP状态：

Enabled：开启

Disabled：关闭

 

【修改记录】

(1)     HDM2-1.59：新增新字段Oem.Public.FatherPortNum；

(2)     HDM2-1.61：新增字段Oem.Public.CPUId、Oem.Public.Slot；

 

4.2.36  设置网络端口单个资源信息

【功能描述】

设置服务器机箱的网络端口单个资源信息。

说明：FC卡不支持

【所属权限模块】

常规配置

【所属系统锁定类型】

BMC配置锁定

【命令格式】

PATCH https://device_ip/redfish/v1/Chassis/chassis_id/NetworkAdapters/networkadapteras_id/NetworkPorts/networkport_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:ifmatch_value

【请求消息体】

{

"Oem": {

       "Public": {

"LldpService":{

"LldpEnabled": lldp_enabled

}

}

}

}

【参数说明】

表4-78 设置网络端口单个资源信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

chassis_id

机箱资源的ID

当前所有机型取值为1

networkadapters_id

网络适配器ID

由“查询网络适配器集合资源信息”中获取

networkport_id

网络端口单个资源ID

由 “查询网络端口集合资源信息”中获取

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

ifmatch_value

请求消息的匹配参数

可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）

Oem.Public.LldpService.LldpEnabled

布尔

指定网口的LLDP使能，包括：

true：使能

false：禁止

 

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot17/NetworkPorts/1

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

    "Oem":{

      "Public":{

          "LldpService":{

              "LldpEnabled":true

          }

      }

    }

}

【应答示例】

{

    "@odata.context":"/redfish/v1/$metadata#NetworkPort.NetworkPort",

    "@odata.id":"/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot17/NetworkPorts/1",

    "@odata.type":"#NetworkPort.v1_3_0.NetworkPort",

    "AssociatedNetworkAddresses":[

        "B8:59:9F:FB:44:32"

    ],

    "CurrentLinkSpeedMbps":10000,

    "Id":"1",

    "LinkStatus":"Up",

    "Name":"1",

    "Oem":{

        "Public":{

            "AutoNeg":true,

            "BDF":"0000:81:00.0",

            "CompletionCode":0,

"CPUId":"CPU2",

            "Description":"Success",

"FatherPortNum": "1",

            "FullDuplex":true,

            "LldpService":{

                "LldpCurrentState":"Disabled",

                "LldpEnabled":true,

                "WorkMode":""

            },

            "PortMaxSpeed":"25000Mb/s",

            "PortType":"OpticalPort",

            "Slot": "Slot24"

        }

    },

    "PhysicalPortNumber":"1"

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回字段说明同【查询网络端口单个资源信息】

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

 

4.2.37  查询存储介质告警水线

【功能描述】

查询存储介质告警阈值水线。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Chassis/chassis_id/Drives/AlarmThreshold

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-79 查询存储介质告警水线参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

chassis_id

机箱资源的ID

当前所有机型取值为1

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Chassis/1/Drives/AlarmThreshold

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#AlarmThreshold.AlarmThreshold",

    "@odata.id": "/redfish/v1/Chassis/1/Drives/AlarmThreshold",

    "@odata.type": "#AlarmThresholdService.v1_0_0.AlarmThresholdService",

    "BadTrack": {

        "AlarmLimit": 24810,

        "EnableFlag": false

    },

    "Life": {

        "AlarmLimit": 95,

        "EnableFlag": false,

"MajorAlarmLimit": 95

    },

    "MediaError": {

        "MediaErrorCnt": 24810,

        "MediaErrorEnableFlag": false

    },

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "PredFail": {

        "PredFailCnt": 24810,

        "PredFailEnableFlag": false

    },

    "RevBlock": {

        "AlarmLimit": 10,

        "EnableFlag": false

    },

    "UNC": {

        "AlarmLimit": 240,

        "EnableFlag": false

    }

}

【输出说明】

表4-80 查询存储介质告警水线输出参数说明

字段

类型

字段说明

@odata.context

字符串

存储介质告警资源模型的OData 描述信息

@odata.id

字符串

存储介质告警资源的访问路径

@odata.type

字符串

存储介质告警资源的类型

BadTrack

硬盘坏道。该字段仅对HDD盘有效。

AlarmLimit

数值

坏道阈值 0~65535

EnableFlag

布尔型

true:开启

false:关闭

Life

硬盘擦写寿命百分比。该字段仅对SSD、NVMe盘有效。

默认使能。AlarmLimit默认为90，MajorAlarmLimit默认为95。

AlarmLimit

数值

擦写寿命轻微告警阈值 0~100

EnableFlag

布尔型

硬盘擦写寿命告警开关

true:开启

false:关闭

MajorAlarmLimit

数值

擦写寿命严重告警阈值 0~100

MediaError

Media error。该字段仅对HDD、SSD盘有效。

MediaErrorCnt

数值

Media error 阈值 0~65535

MediaErrorEnableFlag

布尔型

true:开启

false:关闭

PredFail

Pred fail。该字段仅对HDD、SSD盘有效。

PredFailCnt

数值

Pred fail 阈值 0~255

PredFailEnableFlag

布尔型

true:开启

false:关闭

RevBlock

硬盘预留块。该字段仅对SSD盘有效。

AlarmLimit

数值

预留块 阈值 0~100

EnableFlag

布尔型

true:开启

false:关闭

UNC

UNC。该字段仅对SATA协议的HDD、SSD盘有效。

AlarmLimit

数值

UNC阈值 0~255

EnableFlag

布尔型

true:开启

false:关闭

 

【修改记录】

(1)     HDM2-1.69、HDM2-2.06：添加严重寿命告警阈值Life.MajorAlarmLimit字段；

 

4.2.38  设置存储介质告警水线

【功能描述】

设置存储介质告警水线。

【所属权限模块】

远程控制

【所属系统锁定类型】

BMC配置锁定

【命令格式】

PATCH https://device_ip/redfish/v1/Chassis/chassis_id/Drives/AlarmThreshold

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:ifmatch_value

【请求消息体】

{ 

          "BadTrack": {

        "AlarmLimit": Limit,         

        "EnableFlag": Flag

    },

    "Life": {

        "AlarmLimit": Limit,         

        "EnableFlag": Flag,

"MajorAlarmLimit":Limit

    },

    "MediaError": {

        "MediaErrorCnt": Limit,          

        "MediaErrorEnableFlag": Flag

    },

    "PredFail": {

        "PredFailCnt": Limit,        

        "PredFailEnableFlag": Flag

    },

    "RevBlock": {

        "AlarmLimit": Limit,         

        "EnableFlag": Flag

    },

    "UNC": {

        "AlarmLimit": Limit,         

        "EnableFlag": Flag

    }

}

【参数说明】

表4-81 设置存储介质告警水线参数说明

字段

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

chassis_id

机箱资源的ID

当前所有机型取值为1

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

ifmatch_value

请求消息的匹配参数

可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）

BadTrack

硬盘坏道。该字段仅对HDD盘有效。

BadTrack.AlarmLimit

数值

坏道阈值 0~65535

BadTrack.EnableFlag

布尔型

true:开启

false:关闭

Life

硬盘擦写寿命。该字段仅对SSD、NVMe盘有效。

默认使能。AlarmLimit默认为90，MajorAlarmLimit默认为95。

Life.AlarmLimit

数值

擦写寿命轻微告警阈值 0~100

Life.EnableFlag

布尔型

硬盘擦写寿命告警开关

true:开启

false:关闭

Life.MajorAlarmLimit

数值

擦写寿命严重告警阈值 0~100

MediaError

Media error。该字段仅对HDD、SSD盘有效。

MediaError.MediaErrorCnt

数值

Media error 阈值 0~65535

MediaError.MediaErrorEnableFlag

布尔型

true:开启

false:关闭

PredFail

Pred fail。该字段仅对HDD、SSD盘有效。

PredFail.PredFailCnt

数值

Pred fail 阈值 0~255

PredFail.PredFailEnableFlag

布尔型

true:开启

false:关闭

RevBlock

硬盘预留块。该字段仅对SSD盘有效。

RevBlock.AlarmLimit

数值

预留块 阈值 0~100

RevBlock.EnableFlag

布尔型

true:开启

false:关闭

UNC

UNC。该字段仅对SATA协议的HDD、SSD盘有效。

UNC.AlarmLimit

数值

UNC阈值 0~255

UNC.EnableFlag

布尔型

true:开启

false:关闭

 

【使用实例】

【请求样例】

PATCH https://192.168.20.207/redfish/v1/Chassis/1/Drives/AlarmThreshold

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

"BadTrack": {

        "AlarmLimit": 32767,

        "EnableFlag": true

    },

    "Life": {

        "AlarmLimit": 20,

        "EnableFlag": true,

"MajorAlarmLimit": 95

    },

    "MediaError": {

        "MediaErrorCnt": 32767,

        "MediaErrorEnableFlag": true

    },

    "PredFail": {

        "PredFailCnt": 213,

        "PredFailEnableFlag": true

    },

    "RevBlock": {

        "AlarmLimit": 10,

        "EnableFlag": true

    },

    "UNC": {

        "AlarmLimit": 177,

        "EnableFlag": true

    }

}

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#AlarmThreshold.AlarmThreshold",

    "@odata.id": "/redfish/v1/Chassis/1/Drives/AlarmThreshold",

    "@odata.type": "#AlarmThresholdService.v1_0_0.AlarmThresholdService",

    "BadTrack": {

        "AlarmLimit": 32767,

        "EnableFlag": true

    },

    "Life": {

        "AlarmLimit": 20,

        "EnableFlag": true,

"MajorAlarmLimit": 95

    },

    "MediaError": {

        "MediaErrorCnt": 32767,

        "MediaErrorEnableFlag": true

},

"Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

},

    "PredFail": {

        "PredFailCnt": 213,

        "PredFailEnableFlag": true

    },

    "RevBlock": {

        "AlarmLimit": 10,

        "EnableFlag": true

    },

    "UNC": {

        "AlarmLimit": 177,

        "EnableFlag": true

    }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回体字段说明同【获取存储介质告警水线】

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

(2)     HDM2-1.69、HDM2-2.06：添加严重寿命告警阈值Life.MajorAlarmLimit字段；

 

4.3  Systems 资源的操作

4.3.1  查询系统集合资源信息

【功能描述】

查询服务器当前系统集合资源信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-82 查询服务器当前系统集合资源信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#Systems",

    "@odata.id": "/redfish/v1/Systems",

    "@odata.type": "#ComputerSystemCollection.ComputerSystemCollection",

    "Description": "A collection of ComputerSystem resource instances",

    "Members": [

        {

            "@odata.id": "/redfish/v1/Systems/1"

        }

    ],

    "[email protected]": 1,

    "Name": "Computer System Collection",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    }

}

响应码：200

【输出说明】

表4-83 查询服务器当前系统集合资源信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

系统集合资源模型的OData 描述信息

@odata.id

字符串

系统集合资源的访问路径

@odata.type

字符串

系统集合资源的类型

Members

系统资源列表

@odata.id

字符串

单个系统资源节点的访问路径

Description

字符串

系统集合资源描述

[email protected]

数值

系统资源数量

Name

字符串

系统集合资源名称"Systems Collection"

 

4.3.2  查询指定系统资源信息

【功能描述】

查询服务器指定系统资源信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-84 查询指定系统资源信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

system_id

系统资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#ComputerSystem.ComputerSystem(*)",

    "@odata.id": "/redfish/v1/Systems/1",

    "@odata.type": "#ComputerSystem.v1_13_0.ComputerSystem",

    "Actions": {

        "#ComputerSystem.Reset": {

            "[email protected]": [

                "ForceOff",

                "ForcePowerCycle",

                "ForceRestart",

                "GracefulShutdown",

                "Nmi",

                "On"

            ],

            "target": "/redfish/v1/Systems/1/Actions/ComputerSystem.Reset"

        },

        "Oem": {

            "Public": {

                "#ComputerSystem.ClearConfiguration": {

                    "[email protected]": [

                        "BIOS",

                        "Storage",

                        "BMC"

                    ],

                    "target": "/redfish/v1/Systems/1/Actions/Oem/Public/Systems.ClearConfiguration"

                },

                "#ComputerSystem.ResetCPLD": {

                    "[email protected]": [

                        "ForceRestart"

                    ],

                    "target": "/redfish/v1/Systems/1/Actions/Oem/Public/ComputerSystem.ResetCPLD"

                },

                "#Systems.ExportReport": {

                    "@Redfish.AllowableValues": [

                        ""

                    ],

                    "target": "/redfish/v1/Systems/1/Actions/Oem/Public/Systems.ExportReport"

                }

            }

        }

    },

    "AssetTag": "test_123",

    "Bios": {

        "@odata.id": "/redfish/v1/Systems/1/Bios"

    },

    "BiosVersion": "6.00.01",

    "Boot": {

        "BootSourceOverrideEnabled": "Once",

        "[email protected]": [

            "Continuous",

            "Once"

        ],

        "BootSourceOverrideMode": "None",

        "[email protected]": [

            "Legacy",

            "None",

            "UEFI"

        ],

        "BootSourceOverrideTarget": "None",

        "[email protected]": [

            "BiosSetup",

            "Cd",

            "Hdd",

            "None",

            "Pxe"

        ]

},

"ChassisPartNumber": "0235AQ7",

    "Description": "System 1",

    "Healthstate": {

        "OverallHealth": "Critical",

        "board": "OK",

        "fans": "OK",

        "memory": "OK",

        "pcie": "OK",

        "power": "Critical",

        "processor": "OK",

        "storage": "OK",

        "temperature": "OK"

    },

    "HostName": "HDM",

    "Id": "1",

    "IndicatorLED": "Off",

    "Links": {

        "Chassis": [

            {

                "@odata.id": "/redfish/v1/Chassis/1"

            }

        ],

        "ManagedBy": [

            {

                "@odata.id": "/redfish/v1/Managers/1"

            }

        ],

        "PCIeDevices": [

            {

                "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/6"

            },

            {

                "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/7"

            }

        ],

        "PCIeFunctions": [

            {

                "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/6/Functions/1"

            },

            {

                "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/7/Functions/1"

            }

        ]

    },

    "LogServices": {

        "@odata.id": "/redfish/v1/Systems/1/LogServices"

    },

    "MaintenanceSerialNumber": "",

    "Manufacturer": "H3C",

    "Memory": {

        "@odata.id": "/redfish/v1/Systems/1/Memory"

    },

    "MemorySummary": {

        "Count": 1,

        "MaxCountSupported": 32,

        "Status": {

            "Health": "OK",

            "HealthRollup": "OK",

            "Oem": {

                "Public": {

                    "FaultDescription": "",

                    "Severity": "Informational"

                }

            },

            "State": "Enabled"

        },

        "TotalSystemMemoryGiB": 32

    },

    "Model": "RS33M2C9S",

    "Name": "Computer System",

    "NetworkInterfaces": {

        "@odata.id": "/redfish/v1/Systems/1/NetworkInterfaces"

    },

    "Oem": {

        "Public": {

            "AlarmEventSummary": {

                "CriticalAlarmCount": 0,

                "MajorAlarmCount": 2,

                "MinorAlarmCount": null

            },

            "BiosVendor": "AMI",

            "ClearConfigurationProgress": {

                "@odata.id": "/redfish/v1/Systems/1/Oem/Public/ClearConfigurationProgress"

            },

            "CompletionCode": 0,

"ComputeModuleMaxCount": 1,

"ConfigurationModel":null,

            "Description": "Success",

            "FirmwareInformation": {

                "BiosFirmwareBuildDate": "2022-10-13T12:12:52+08:00",

                "BiosInternalFirmwareVersion": "V100R001B01D001_DEBUG",

                "MEFirmwareVersion": "6.0.3.176"

            },

            "GPU": {

                "@odata.id": "/redfish/v1/Systems/1/GPU"

            },

            "HostNameSetupMode": "Auto",

            "HostStatus": {

                "@odata.id": "/redfish/v1/Systems/1/Oem/Public/HostStatus"

            },

            "IndependentPowerSupply": false,

            "NodeType":null,

            "POSTRoutines": {

                "@odata.id": "/redfish/v1/Systems/1/Bios/Oem/Public/POSTRoutines"

            },

            "PanelPowerButtonEnabled": true,

            "PowerOnStrategy": "RestorePreviousState",

"PresentComputeModules": [

                "CM1"

            ],

            "SecurityBezel": {

                "@odata.id": "/redfish/v1/Systems/1/Oem/Public/SecurityBezel"

            },

            "SoftwareList": {

                "@odata.id": "/redfish/v1/Systems/1/Oem/Public/SoftwareList"

            }

            "BootSmallOption":{

               "CD/DVD": {

                   ……

               },

               "Hard Disk": {

                   "BootSmallOption1": "UEFI:KingstonDataTraveler 2.0PMAP, Partition 4,0x0002",

                   ……

               },

               "Network": {

                   ……

               },

               "Other Device": {

                   ……

               }

            }

        }

    },

    "PartNumber": "",

    "PowerState": "On",

    "ProcessorSummary": {

        "Count": 1,

        "MaxCountSupported": 2,

        "Model": "Intel(R) Xeon(R) Platinum 8450H",

        "Status": {

            "Health": "OK",

            "HealthRollup": "OK",

            "Oem": {

                "Public": {

                    "FaultDescription": "",

                    "Severity": "Informational"

                }

            },

            "State": "Enabled"

        },

        "TotalCores": 28,

        "TotalThreads": 56

    },

    "Processors": {

        "@odata.id": "/redfish/v1/Systems/1/Processors"

    },

    "SerialNumber": "",

    "Status": {

        "Health": "Critical",

        "HealthRollup": "Critical",

        "Oem": {

            "Public": {

                "Severity": "Major"

            }

        },

        "State": "Enabled"

    },

    "Storage": {

        "@odata.id": "/redfish/v1/Systems/1/Storages"

    },

    "StorageControllerSummary": {

        "LogicalDriveCount": 0,

        "PhysicalDriveCount": 0,

        "Status": {

            "Health": "OK",

            "HealthRollup": "OK",

            "Oem": {

                "Public": {

                    "FaultDescription": "",

                    "Severity": "Informational"

                }

            },

            "State": "Absent"

        },

        "StorageControllerCount": 0

    },

    "SystemType": "Physical",

    "UUID": "98e83cd0-7a2c-1000-02ff-aabbccd24718",

    "Uptime_hours": "7",

    "kvm": {

        "@odata.id": "/redfish/v1/Systems/1/kvm"

    }

}

响应码：200

【输出说明】

表4-85 查询指定系统资源信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

指定系统资源模型的OData 描述信息

@odata.id

字符串

指定系统资源的访问路径

@odata.type

字符串

指定系统资源的类型

Actions

Actions指定系统资源可执行的操作

ComputerSystem.Reset

对象

主机重启操作

[email protected]

数组

允许的主机重启操作类型，包括：

"On"：上电

"ForceOff"：强制关机

"ForceRestart"：强制重启

"GracefulShutdown"：正常关机

"Nmi"：触发不可屏蔽中断

"ForcePowerCycle"：强制下电再上电

target

字符串

ComputerSystem.Reset系统操作路径

Actions.Oem.Public

自定义Actions可执行的操作

ComputerSystem.ClearConfiguration

对象

清除配置操作

[email protected]

数组

允许清除配置的类型，包括：

"BIOS",

"Storage",

"BMC"

target

字符串

清除配置操作路径

ComputerSystem.DownloadReport

对象

下载清除配置报告操作

[email protected]

数组

允许清除配置的类型，仅：""

target

字符串

下载清除报告操作路径

ComputerSystem.ResetCPLD

对象

重启CPLD操作

[email protected]

数组

重启CPLD参数，包括：

"ForceRestart"

target

字符串

重启CPLD操作路径

AssetTag

字符串

指定系统资源的资产标签，长度：1~48

Bios

对象

Bios资源操作路径

BiosVersion

字符串

BIOS版本信息

Boot

指定系统资源的启动参数

BootSourceOverrideEnabled

字符串

系统启动参数的使能状态， 包括：

Once： 仅生效一次， 即下次重启时生效

Continuous： 永久有效

[email protected]

数组

系统启动参数的使能状态操作， 包括：

Once： 仅生效一次， 即下次重启时生效

Continuous： 永久有效

BootSourceOverrideMode

字符串

系统启动模式，包括：

“None”，“Legacy”，“UEFI”

注意：飞腾平台不支持"Legacy"

[email protected]

数组

支持的启动模式，包括：

“None”，“Legacy”，“UEFI”

注意：飞腾平台不支持"Legacy"

BootSourceOverrideTarget

字符串

系统启动设备，包括：

"None"， "Hdd"， "Pxe"，

 "BiosSetup"， "Cd"

[email protected]

数组

Redfish 定义的启动设备，包括：

"None"， "Hdd"， "Pxe"，

 "BiosSetup"， "Cd"

ChassisPartNumber

字符串

主板chassis域部件号 (R6900、R8900是中置背板的产品名称)

Healthstate

对象

系统健康状态

Healthstate.OverallHealth

字符串

整体健康状态

Healthstate.storage

字符串

存储健康状态，包括存储卡、硬盘、NVMe的健康状态

Healthstate.fans

字符串

风扇健康状态

Healthstate.memory

字符串

内存健康状态

Healthstate.pcie

字符串

PCIe卡健康状态

Healthstate.power

字符串

电源健康状态

Healthstate.processor

字符串

处理器健康状态

Healthstate.temperature

字符串

温度传感器健康状态

Healthstate.board

字符串

系统板卡健康状态

Id

字符串

指定系统资源的 ID

IndicatorLED

字符串

UID灯状态：

Lit：常亮；

Off：关闭；

Blinking：闪烁

Links

关联服务资源

Chassis

对象数组

机箱资源节点的访问路径

ManagedBy

对象数组

管理资源资源节点的访问路径

PCIeDevices

对象数组

PCIe资源节点的访问路径

PCIeFunctions

对象数组

PCIe功能资源节点的访问路径

LogServices

对象

日志服务集合资源节点的访问路径

MaintenanceSerialNumber

字符串

生产序列号

Manufacturer

字符串

生产厂商

Memory

对象

内存资源节点的访问路径

MemorySummary/StorageControllerSummary/ProcessorSummary

模块汇总信息

Count

数值

当前数量

MaxCountSupported

数值

最大的支持数量

Status

对象

汇总资源的状态， 包括：

Health：汇总资源健康状态

State：汇总资源使能状态

HealthRollup：汇总健康状态[与Health一致]

Oem.Public.FaultDescription：整体故障描述

Oem.Public.Severity：自定义健康状态

说明：整体故障描述关联部件整体故障，独立于单个部件的故障信息；

MemorySummary.TotalSystemMemoryGiB

数值

内存总容量

StorageControllerSummary.StorageControllerCount

数值

存储卡控制器数量

StorageControllerSummary.LogicalDriveCount

数值

逻辑盘的数量

StorageControllerSummary.PhysicalDriveCount

数值

物理盘的数量

ProcessorSummary.TotalCores

数值

系统所有CPU的总核数

ProcessorSummary.TotalThreads

数值

系统所有CPU的总线程数

ProcessorSummary.Model

字符串

系统第一个CPU型号

SerialNumber

字符串

产品序列号

Status

对象

指定系统资源的状态， 包括：

Health：系统资源健康状态

State：系统资源使能状态

Storage

对象

存储资源节点的访问路径

Processors

对象

处理器资源节点访问路径

Model

字符串

产品型号

Name

字符串

系统资源信息名称

NetworkInterfaces

对象

网络接口资源节点的访问路径

PartNumber

字符串

产品部件号

PowerState

字符串

上电状态：

On

Off

Oem.Public

自定义属性

AlarmEventSummary

对象

告警信息汇总

CriticalAlarmCount

数值

致命告警数量

MajorAlarmCount

数值

严重告警数量

MinorAlarmCount

数值

轻微告警数量

Oem.Public.BiosVendor

字符串

指定系统资源的BIOS软件厂商

Oem.Public.PanelPowerButtonEnabled

布尔

挂耳电源按钮使能

Oem.Public.PowerOnStrategy

字符串

通电开机策略：

TurnOn： 保持上电RestorePreviousState： 与之前保持一致StayOff： 保持下电

Oem.Public.ClearConfigurationProgress

对象

查询配置清除的详细进度

Oem.Public.FirmwareInformation.MEFirmwareVersion

字符串

ME版本信息

Oem.Public.FirmwareInformation.BiosFirmwareBuildDate

字符串

BIOS固件编译时间

N/A:表示获取失败

Oem.Public.FirmwareInformation.BiosInternalFirmwareVersion

字符串

BIOS固件版本

Oem.Public.GPU

对象

CPU资源路径

Oem.Public.HostNameSetupMode

字符串

主机名设置模式:

Auto：自动模式

Manual:手动模式

Oem.Public.HostStatus

对象

查询主机状态迁移路径

Oem.Public.IndependentPowerSupply

布尔型

标准PCIe Slot是否支持独立供电

Oem.Public.POSTRoutines

对象

查询开机自检码路径

Oem.Public.SecurityBezel

对象

查询安全面板路径

Oem.Public.SoftwareList

对象

查询系统软件清单路径

Oem.Public.ComputeModuleMaxCount

数量

当前机型支持的最大节点数

Oem.Public.ConfigurationModel

字符串

定制化典配模型

Oem.Public. PresentComputeModules

数组

当前计算节点列表

Oem.Public.NodeType

字符串

产品套餐信息

Oem.Public.BootSmallOption

对象

BIOS启动最小项

BootSmallOptionX

字符串

启动最小项名称，X表示顺序，从1开始

SystemType

字符串

系统类型：

"Physical"

"Virtual"

UUID

字符串

设备的全局唯一标识符

Uptime_hours

字符串

主机上电时间

kvm

对象

KVM资源节点的访问路径

HostName

字符串

指定系统资源的主机名，长度：1~48

 

【修改记录】

(1)     HDM2-1.52: 新增字段ChassisPartNumber；

(2)     HDM2-1.57: 新增字段Oem.Public.NodeType；

(3)     HDM2-1.58: 新增BIOS启动最小项；

(4)     HDM2-2.04：新增字段Oem.Public.ConfigurationModel；

(5)     HDM3-1.07：飞腾平台不支持Legacy启动模式；

 

4.3.3  修改指定系统资源属性

【功能描述】

修改指定系统资源属性。

使用说明：

（1）BootSourceOverrideEnabled, BootSourceOverrideMode, BootSourceOverrideTarget三个参数需要一起下发。

（2）  当设置永久启动时，BootSourceOverrideMode, BootSourceOverrideTarget不能同时为None。

（3）仅设置HostName时，默认设置HostNameSetupMode字段值为"Manual"。

（4）BMC配置锁定时，Boot结构中的参数不能与其他参数混合下发。

【所属权限模块】

远程控制|常规配置|电源控制

【所属系统锁定类型】

BIOS配置锁定（仅当配置BIOS相关属性时）|BMC配置锁定（除配置BIOS相关属性时）

【命令格式】

PATCH https://device_ip/redfish/v1/Systems/system_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:ifmatch_value

【请求消息体】

{

    "AssetTag": "test_123",

    "HostName": "123",

    "Boot": {

        "BootSourceOverrideMode": mode,

        "BootSourceOverrideTarget": target,

        "BootSourceOverrideEnabled": enable

    },

    "Oem": {

        "Public": {

            "PanelPowerButtonEnabled": true,

            "HostNameSetupMode": "Manual",

            "BootSmallOption": {

               "CD/DVD": {

                   ……

               },

               "Hard Disk": {

                   "BootSmallOption1":"UEFI: KingstonDataTraveler 2.0PMAP, Partition 4,0x0002",

                   ……

               },

               "Network": {

                   ……

               },

               "Other Device": {

                   ……

               }

            }

        }

    }

}

【参数说明】

表4-86 修改指定系统资源属性选项参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

system_id

系统资源的ID

当前所有机型取值为1

ifmatch_value

请求消息的匹配参数

可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）

AssetTag

资产标签

字符串，长度：1~48

null，设置为空

HostName

主机名

字符串，长度：

移动CID：1~48，

主线：1~63

Boot.BootSourceOverrideMode

下次启动模式

支持： "None"、"UEFI"、"Legacy"

注意：飞腾平台不支持"Legacy"

Boot.BootSourceOverrideTarget

下次启动设备

支持：

"None"

"Pxe"

"Hdd"

"Cd"

"BiosSetup"(BootSourceOverrideEnabled字段为Once时有效)

Boot.BootSourceOverrideEnabled

启动设置有效期

支持："Once"、 "Continuous"

(G3刀箱产品不支持Continuous设置，G5都支持)

Oem.Public.PanelPowerButtonEnabled

布尔

挂耳电源按钮使能

Oem.Public.HostNameSetupMode

主机名设置模式

Auto：自动模式

Manual：手动模式

Oem.Public.BootSmallOption

对象

BIOS启动最小项信息

BootSmallOptionX

字符串

启动最小项名称，X表示顺序，从1开始

 

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/Systems/1

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

    "AssetTag": "test_123",

    "HostName": "HDM12315555777745557765",

    "Boot": {

        "BootSourceOverrideMode": "UEFI",

        "BootSourceOverrideTarget": "Pxe",

        "BootSourceOverrideEnabled": "Once"

    },

    "Oem": {

        "Public": {

            "HostNameSetupMode": "Manual",

            "BootSmallOption": {

               "CD/DVD": {},

               "Hard Disk": {

                   "BootSmallOption1":"UEFI: KingstonDataTraveler 2.0PMAP, Partition 4,0x0002"

               },

               "Network": {},

               "Other Device": {}

            }

        }

    }

}

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#ComputerSystem.ComputerSystem(*)",

    "@odata.id": "/redfish/v1/Systems/1",

    "@odata.type": "#ComputerSystem.v1_13_0.ComputerSystem",

    "Actions": {

        "#ComputerSystem.Reset": {

            "[email protected]": [

                "ForceOff",

                "ForcePowerCycle",

                "ForceRestart",

                "GracefulShutdown",

                "Nmi",

                "On"

            ],

            "target": "/redfish/v1/Systems/1/Actions/ComputerSystem.Reset"

        },

        "Oem": {

            "Public": {

                "#ComputerSystem.ClearConfiguration": {

                    "[email protected]": [

                        "BIOS",

                        "Storage",

                        "BMC"

                    ],

                    "target": "/redfish/v1/Systems/1/Actions/Oem/Public/Systems.ClearConfiguration"

                },

                "#ComputerSystem.ResetCPLD": {

                    "[email protected]": [

                        "ForceRestart"

                    ],

                    "target": "/redfish/v1/Systems/1/Actions/Oem/Public/ComputerSystem.ResetCPLD"

                },

                "#Systems.ExportReport": {

                    "@Redfish.AllowableValues": [

                        ""

                    ],

                    "target": "/redfish/v1/Systems/1/Actions/Oem/Public/Systems.ExportReport"

                }

            }

        }

    },

    "AssetTag": "test_123",

    "Bios": {

        "@odata.id": "/redfish/v1/Systems/1/Bios"

    },

    "BiosVersion": "6.00",

    "Boot": {

        "BootSourceOverrideEnabled": "Once",

        "[email protected]": [

            "Continuous",

            "Once"

        ],

        "BootSourceOverrideMode": "UEFI",

        "[email protected]": [

            "Legacy",

            "None",

            "UEFI"

        ],

        "BootSourceOverrideTarget": "Pxe",

        "[email protected]": [

            "BiosSetup",

            "Cd",

            "Hdd",

            "None",

            "Pxe"

        ]

},

"ChassisPartNumber": "0235AQ7",

    "Description": "System 1",

    "Healthstate": {

        "OverallHealth": "Critical",

        "board": "OK",

        "fans": "OK",

        "memory": "OK",

        "pcie": "OK",

        "power": "Critical",

        "processor": "OK",

        "storage": "OK",

        "temperature": "OK"

    },

    "HostName": "HDM12315555777745557765",

    "Id": "1",

    "IndicatorLED": "Lit",

    "Links": {

        "Chassis": [

            {

                "@odata.id": "/redfish/v1/Chassis/1"

            }

        ],

        "ManagedBy": [

            {

                "@odata.id": "/redfish/v1/Managers/1"

            }

        ],

        "PCIeDevices": [

            {

                "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/16"

            }

        ],

        "PCIeFunctions": [

            {

                "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/16/Functions/1"

            }

        ]

    },

    "LogServices": {

        "@odata.id": "/redfish/v1/Systems/1/LogServices"

    },

    "MaintenanceSerialNumber": "",

    "Manufacturer": "H3C",

    "Memory": {

        "@odata.id": "/redfish/v1/Systems/1/Memory"

    },

    "MemorySummary": {

        "Count": 1,

        "MaxCountSupported": 32,

        "Status": {

            "Health": "OK",

            "HealthRollup": "OK",

            "Oem": {

                "Public": {

                    "FaultDescription": "",

                    "Severity": "Informational"

                }

            },

            "State": "Enabled"

        },

        "TotalSystemMemoryGiB": 32

    },

    "Model": "RS33M2C9S",

    "Name": "Computer System",

    "NetworkInterfaces": {

        "@odata.id": "/redfish/v1/Systems/1/NetworkInterfaces"

    },

    "Oem": {

        "Public": {

            "AlarmEventSummary": {

                "CriticalAlarmCount": 0,

                "MajorAlarmCount": 1,

                "MinorAlarmCount": null

            },

            "BiosVendor": "AMI",

            "ClearConfigurationProgress": {

                "@odata.id": "/redfish/v1/Systems/1/Oem/Public/ClearConfigurationProgress"

            },

            "CompletionCode": 0,

"ComputeModuleMaxCount": 1,

"ConfigurationModel":null,

            "Description": "Success",

            "FirmwareInformation": {

                "BiosInternalFirmwareVersion": "V100R001B06BBIT05",

                "MEFirmwareVersion": "6.0.3.159"

            },

            "GPU": {

                "@odata.id": "/redfish/v1/Systems/1/GPU"

            },

            "HostNameSetupMode": "Manual",

            "IndependentPowerSupply": false,

            "NodeType":null,

            "POSTRoutines": {

                "@odata.id": "/redfish/v1/Systems/1/Bios/Oem/Public/POSTRoutines"

            },

            "PanelPowerButtonEnabled": true,

            "PowerOnStrategy": "RestorePreviousState",

"PresentComputeModules": [

                "CM1"

            ],

            "SecurityBezel": {

                "@odata.id": "/redfish/v1/Systems/1/Oem/Public/SecurityBezel"

            },

            "SoftwareList": {

                "@odata.id": "/redfish/v1/Systems/1/Oem/Public/SoftwareList"

            }

            "BootSmallOption": {

               "CD/DVD": {},

               "Hard Disk": {

                   "BootSmallOption1":"UEFI: KingstonDataTraveler 2.0PMAP, Partition 4,0x0002"

               },

               "Network": {},

               "Other Device": {}

            }

        }

    },

    "PartNumber": "",

    "PowerState": "Off",

    "ProcessorSummary": {

        "Count": 1,

        "MaxCountSupported": 2,

        "Model": "Genuine Intel(R) CPU 0000%@",

        "Status": {

            "Health": "OK",

            "HealthRollup": "OK",

            "Oem": {

                "Public": {

                    "FaultDescription": "",

                    "Severity": "Informational"

                }

            },

            "State": "Enabled"

        },

        "TotalCores": 48,

        "TotalThreads": 96

    },

    "Processors": {

        "@odata.id": "/redfish/v1/Systems/1/Processors"

    },

    "SerialNumber": "",

    "Status": {

        "Health": "Critical",

        "HealthRollup": "Critical",

        "Oem": {

            "Public": {

                "Severity": "Major"

            }

        },

        "State": "Enabled"

    },

    "Storage": {

        "@odata.id": "/redfish/v1/Systems/1/Storages"

    },

    "StorageControllerSummary": {

        "LogicalDriveCount": 0,

        "PhysicalDriveCount": 0,

        "Status": {

            "Health": "OK",

            "HealthRollup": "OK",

            "Oem": {

                "Public": {

                    "FaultDescription": "",

                    "Severity": "Informational"

                }

            },

            "State": "Absent"

        },

        "StorageControllerCount": 0

    },

    "SystemType": "Physical",

    "UUID": "ff777238-ec31-1000-03f2-aabbccd24718",

    "Uptime_hours": "0",

    "kvm": {

        "@odata.id": "/redfish/v1/Systems/1/kvm"

    }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回体字段说明同【查询指定系统资源信息】

【修改记录】

(1)     HDM2-1.16: 功能描述中新增使用说明“设置HostName时，需同时设置HostNameSetupMode字段值为"Manual"。”；同时将使用实例中HostNameSetupMode字段值修改为"Manual"

(2)     HDM2-1.52：添加所属系统锁定类型；

(3)     HDM2-1.58：新增BIOS启动最小项；

(4)     HDM3-1.12：设置HostName时，默认设置HostNameSetupMode字段值为"Manual"；

(5)     HDM3-1.07：飞腾平台不支持Legacy启动模式；

 

4.3.4  查询开机自检顺序

【功能描述】

获取开机自检顺序

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id/Bios/Oem/Public/POSTRoutines

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-87 查询开机自检顺序列表参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

system_id

系统资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/Bios/Oem/Public/POSTRoutines

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#POSTRoutines.POSTRoutines",

    "@odata.id": "/redfish/v1/Systems/1/Bios/Oem/Public/POSTRoutines",

    "@odata.type": "#POSTRoutines.v1_0_0.POSTRoutines",

    "Description": "A Collection of POST routines.",

    "Entries": {

        "@odata.id": "/redfish/v1/Systems/1/Bios/Oem/Public/POSTRoutines/Entries"

    },

    "Name": "POST Routines Collection",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "POSTState": "Post To Setup"

}

响应码：200

【输出说明】

表4-88 查询开机自检顺序输出参数说明

字段

类型

字段说明

@odata.context

字符串

开机自检顺序集合模型的OData 描述信息

@odata.id

字符串

开机自检顺序集合的访问路径

@odata.type

字符串

开机自检顺序集合资源的类型

Description

字符串

接口功能描述

Entries

对象

开机自检顺序资源列表

Name

字符串

开机自检顺序集合资源的名称

POSTState

字符串

POSTState描述

 

4.3.5  查询开机自检码集合资源信息

【功能描述】

查询开机自检集合资源信息

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id/Bios/Oem/Public/POSTRoutines/Entries

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-89 查询开机自检集合资源信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

system_id

系统资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/Bios/Oem/Public/POSTRoutines/Entries

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#POSTRoutinesEntryCollection.POSTRoutinesEntryCollection",

    "@odata.id": "/redfish/v1/Systems/1/Bios/Oem/Public/POSTRoutines/Entries",

    "@odata.type": "#POSTRoutinesCollection.POSTRoutinesEntryCollection",

    "Description": "A Collection of Entry routines.",

    "Members": [

        {

            "@odata.id": "/redfish/v1/Systems/1/Bios/Oem/Public/POSTRoutines/Entries/1"

        },

        {

            "@odata.id": "/redfish/v1/Systems/1/Bios/Oem/Public/POSTRoutines/Entries/2"

        },

        {

            "@odata.id": "/redfish/v1/Systems/1/Bios/Oem/Public/POSTRoutines/Entries/3"

        },

        {

            "@odata.id": "/redfish/v1/Systems/1/Bios/Oem/Public/POSTRoutines/Entries/4"

        },

        {

            "@odata.id": "/redfish/v1/Systems/1/Bios/Oem/Public/POSTRoutines/Entries/5"

        },

        …

        {

            "@odata.id": "/redfish/v1/Systems/1/Bios/Oem/Public/POSTRoutines/Entries/315"

        },

        {

            "@odata.id": "/redfish/v1/Systems/1/Bios/Oem/Public/POSTRoutines/Entries/316"

        }

    ],

    "[email protected]": 316,

    "[email protected]": "/redfish/v1/Systems/1/Bios/Oem/Public/POSTRoutines/Entries?$skip=100&$top=100",

    "Name": "POST Routines Entries Collection",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    }

}

响应码：200

【输出说明】

表4-90 查询开机自检集合资源信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

开机自检集合资源信息模型的OData 描述信息

@odata.id

字符串

开机自检集合资源信息的访问路径

@odata.type

字符串

开机自检集合资源信息的类型

Members

数组

开机自检集合资源信息列表

Description

字符串

开机自检集合资源信息描述

[email protected]

数值

开机自检集合资源信息数量

Name

字符串

开机自检集合资源信息的名称

[email protected]

字符串

分页的路径

 

4.3.6  查询指定开机自检码信息

【功能描述】

获取指定开机自检顺序详细信息

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id/Bios/Oem/Public/POSTRoutines/Entries/entries_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-91 获取指定开机自检码信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

system_id

系统资源的ID

当前所有机型取值为1

entries_id

开机自检码集合资源ID

由查询开机自检集合资源信息获取

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/Bios/Oem/Public/POSTRoutines/Entries/1

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#POSTRoutinesInstance.POSTRoutinesInstance",

    "@odata.id": "/redfish/v1/Systems/1/Bios/Oem/Public/POSTRoutines/Entries/3",

    "@odata.type": "#POSTRoutinesInstance.v1_0_0.POSTRoutinesInstance",

    "Description": "Bios POST Routines Information",

    "Id": "3",

    "Name": "Bios POST Routines Information",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "POSTCode": "0x0002",

    "POSTCodeDescription": "MICROCODE Initialization",

    "TimeStamp": "2019-02-18T17:51:02+08:00"

}

响应码：200

【输出说明】

表4-92 查询指定开机自检码信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

开机自检码资源模型的OData描述信息

@odata.id

字符串

开机自检码资源的访问路径

@odata.type

字符串

开机自检码信息的类型

Id

字符串

开机自检码资源ID

Name

字符串

开机自检码资源名称

Description

字符串

开机自检码资源描述

POSTCodeDescription

字符串

当前开机自检阶段详细描述

POSTCode

字符串

当前开机自检码

TimeStamp

字符串

时间戳

 

4.3.7  服务器电源操作

【功能描述】

服务器电源进行操作，包括上电、强制下电、正常关机、强制重启等

【所属权限模块】

电源控制

【所属系统锁定类型】

电源控制锁定

【命令格式】

POST https://device_ip/redfish/v1/Systems/system_id/Actions/ComputerSystem.Reset

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"ResetType": state

}

【参数说明】

表4-93 服务器电源操作参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

system_id

系统资源的ID

当前所有机型取值为1

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

ResetType

操作类型

·     On：上电

·     ForceOff：强制下电

·     GracefulShutdown：正常关机

·     ForceRestart：强制重启

·     Nmi：触发不可屏蔽中断

·     ForcePowerCycle：强制下电再上电

·     PowerCycle: 强制下电再上电（ForcePowerCycle与PowerCycle效果一致）

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/Systems/1/Actions/ComputerSystem.Reset

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"ResetType": "GracefulShutdown"

}

【应答示例】

{

"Oem": {

       "Public": {

           "CompletionCode": 0,

           "Description": "Success"

       }

 },

"error": {

       "@Message.ExtendedInfo": [

           {

               "@odata.type": "#Message.v1_1_1.Message",

               "Message": "Successfully Completed Request",

               "MessageArgs": [],

               "MessageId": "Base.1.8.1.Success",

               "MessageSeverity": "OK",

               "Resolution": "None"

           }

       ],

        "code":"Base.1.8.1.Success",

        "message":"Successfully Completed Request"

    }

}

}

响应码：200

【输出说明】

表4-94 服务器电源操作输出参数说明

字段

类型

字段说明

code

字符串

指示消息注册表中特定消息ID的字符串

message

字符串

与消息注册表中的消息对应的易读的错误消息

@Message.ExtendedInfo

消息扩展信息

@odata.type

字符串

消息资源的OData描述信息

MessageId

字符串

消息ID

Message

字符串

详细信息

MessageArgs

数组

信息参数

MessageSeverity

字符串

严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical

Resolution

字符串

解决建议

 

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

(2)     HDM2-1.56：新增PowerCycle字段；

(3)     HDM2-2.04：Message.ExtendedInfo前添加error节点，并且在error节点下增加code和message字段；

 

4.3.8  重启CPLD

【功能描述】

升级完成CPLD或CPLD固件出现异常需要重启CPLD时，可以通过本功能重启CPLD固件，无需断电。

说明：支持重启的CPLD类型请参考手册《H3C服务器HDM2用户指南-1.XX》。

【所属权限模块】

维护诊断

【命令格式】

POST https://device_ip/redfish/v1/Systems/system_id/Actions/Oem/Public/ComputerSystem.ResetCPLD

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"ResetType":type

}

【参数说明】

表4-95 重启CPLD参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

system_id

系统资源的ID

当前所有机型取值为1

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

ResetType

字符串

ForceRestart：重启CPLD

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/Systems/1/Actions/Oem/Public/ComputerSystem.ResetCPLD

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"ResetType":"ForceRestart"

}

【应答示例】

{

"Oem": {

       "Public": {

           "CompletionCode": 0,

           "Description": "Success"

       }

 },

"error": {

       "@Message.ExtendedInfo": [

           {

               "@odata.type": "#Message.v1_1_1.Message",

               "Message": "Successfully Completed Request",

               "MessageArgs": [],

               "MessageId": "Base.1.8.1.Success",

               "MessageSeverity": "OK",

               "Resolution": "None"

           }

       ],

        "code":"Base.1.8.1.Success",

        "message":"Successfully Completed Request"

    }

}

}

响应码：200

【输出说明】

表4-96 重启CPLD输出参数说明

字段

类型

字段说明

code

字符串

指示消息注册表中特定消息ID的字符串

message

字符串

与消息注册表中的消息对应的易读的错误消息

@Message.ExtendedInfo

消息扩展信息

@odata.type

字符串

消息资源的OData描述信息

MessageId

字符串

消息ID

Message

字符串

详细信息

MessageArgs

数组

信息参数

MessageSeverity

字符串

严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical

Resolution

字符串

解决建议

 

【修改记录】

(1)     HDM2-2.04：更改接口描述；

(2)     HDM2-2.04：Message.ExtendedInfo前添加error节点，并且在error节点下增加code和message字段；

 

4.3.9  查询CPU列表

【功能描述】

查询CPU列表信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id/Processors

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-97 查询CPU列表信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

system_id

系统资源的ID

当前所有机型取值为1

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/Processors

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#ProcessorCollection.ProcessorCollection",

    "@odata.id": "/redfish/v1/Systems/1/Processors",

    "@odata.type": "#ProcessorCollection.ProcessorCollection",

    "Description": "Collection of processors for this system",

    "Members": [

        {

            "@odata.id": "/redfish/v1/Systems/1/Processors/1"

        },

{

            "@odata.id": "/redfish/v1/Systems/1/Processors/2"

        }

    ],

    "[email protected]": 2,

    "Name": "Processors Collection",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "CpuUsageRatePercent": 60,

            "Description": "Success",

            "UsageAlarmThreshold": 75

        }

    }

}

返回码200

【输出说明】

表4-98 查询CPU列表信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

CPU列表资源模型的OData 描述信息

@odata.id

字符串

CPU列表资源的访问路径

@odata.type

字符串

CPU列表资源的类型

Description

字符串

CPU列表资源的描述信息

Members

数组

CPU查询路径

[email protected]

数值

CPU个数

Name

字符串

CPU资源信息名称

Oem.Public.CpuUsageRatePercent

数值

CPU使用率，范围：0~100（需安装FIST SMS才能正确显示使用率）

获取失败返回为null

Oem.Public. UsageAlarmThreshold

数值

CPU使用率告警门限，0~100

获取失败返回为null

 

4.3.10  设置CPU占用率警告门限

【功能描述】

设置CPU占用率警告门限。

【所属权限模块】

远程控制

【命令格式】

PATCH https://device_ip/redfish/v1/Systems/system_id/Processors

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

  "Oem": {

      "Public": {

          "UsageAlarmThreshold":value

      }

  }

}

【参数说明】

表4-99 设置CPU占用率警告门限参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

system_id

系统资源的ID

当前所有机型取值为1

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

Oem.Public.UsageAlarmThreshold

数字

CPU使用率告警门限，0~100

 

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/Systems/1/Processors

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

  "Oem": {

      "Public": {

          "UsageAlarmThreshold":75

      }

  }

}

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#ProcessorCollection.ProcessorCollection",

    "@odata.id": "/redfish/v1/Systems/1/Processors",

    "@odata.type": "#ProcessorCollection.ProcessorCollection",

    "Description": "Collection of processors for this system",

    "Members": [

        {

            "@odata.id": "/redfish/v1/Systems/1/Processors/1"

        },

{

            "@odata.id": "/redfish/v1/Systems/1/Processors/2"

        }

    ],

    "[email protected]": 2,

    "Name": "Processors Collection",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "CpuUsageRatePercent": 60,

            "Description": "Success",

            "UsageAlarmThreshold": 75

        }

    }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回体字段说明同【查询CPU列表】

 

4.3.11  查询指定CPU信息

【功能描述】

查询指定的CPU信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id/Processors/cpu_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-100 查询CPU信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

system_id

系统资源的ID

当前所有机型取值为1

cpu _id

CPU ID

由CPU集合中查询

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/Processors/1

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例1】

{

    "@odata.context": "/redfish/v1/$metadata#Processor.Processor(*)",

    "@odata.id": "/redfish/v1/Systems/1/Processors/1",

"@odata.type": "#Processor.v1_10_0.Processor",

"ChopType": "",

    "Id": "1",

    "InstructionSet": "x86-64",

    "Manufacturer": "Intel(R) Corporation",

    "MaxSpeedMHz": 4000,

    "Model": "Genuine Intel(R) CPU 0000%@",

"Name": "CPU1",

"Actions": {

"Oem": {

         "Public":{

             "#Processor.LicenseUpload": {

                  "target":"/redfish/v1/Systems/1/Processors/1/Actions/Oem/Public/Processor.LicenseUpload"

              },

              "#Processor.StateReportExport": {

                  "target":"/redfish/v1/Systems/1/Processors/1/Actions/Oem/Public/Processor.StateReportExport"

              }

}

}

},

    "Oem": {

        "Public": {

            "64BitSupported": true,

            "CompletionCode": 0,

            "Description": "Success",

            "FrequencyMHz": 1500,

            "ChipId": null,

            "L1CacheKiB": 3840,

            "L2CacheKiB": 34304,

            "L3CacheKiB": 34208,

            "SerialNumber": "07-9A-3E-43-60-E1-C5-50",

            "Temperature": 4294967295,

            "ThermalDesignPower":null,

"Capability": :[

               {

                   "Name": "CSS4",

                   "State": "Enabled" 

               },

               {

                   "Name": "AMS4",

                   "State": "Disabled"

               },

               {

                   "Name": "AMS1",

                   "State": "Disabled"

               },

               {

                   "Name": "CSS2",

                   "State": "Disabled"

               },

               {

                   "Name": "SGX512",

                   "State": "Enabled"

               }

            ]

        }

    },

    "Ppin": "07-9A-3E-43-60-E1-C5-50",

    "ProcessorArchitecture": "x86",

    "ProcessorId": {

        "IdentificationRegisters": "F3-06-08-00-FF-FB-EB-BF",

"Step": ""

    },

    "ProcessorType": "CPU",

    "Socket": 1,

    "Status": {

        "Health": "OK",

        "Oem": {

            "Public": {

                "FaultDescription": "",

                "Severity": "Informational"

            }

        },

        "State": "Enabled"

    },

    "TotalCores": 48,

    "TotalThreads": 96

}

响应码：200

 

【应答示例2-飞腾】

{

    "@odata.context": "/redfish/v1/$metadata#Processor.Processor(*)",

    "@odata.id": "/redfish/v1/Systems/1/Processors/1",

    "@odata.type": "#Processor.v1_10_0.Processor",

    "ChopType": "",

    "Id": "1",

    "InstructionSet": "Aarch64",

    "Manufacturer": "Phytium",

    "MaxSpeedMHz": 2100,

    "Model": "S5000C-64",

    "Name": "CPU1",

    "Oem": {

        "Public": {

            "64BitSupported": true,

            "ChipId": "KPA5691504160000",

            "CompletionCode": 0,

            "Description": "Success",

            "FrequencyMHz": 2100,

            "L1CacheKiB": 4096,

            "L2CacheKiB": 32768,

            "L3CacheKiB": 32768,

            "SerialNumber": "KPA5691504160000",

            "Temperature": 4294967295,

            "ThermalDesignPower": null

        }

    },

    "Ppin": null,

    "ProcessorArchitecture": "ARMv8",

    "ProcessorId": {

        "IdentificationRegisters": "20-86-0F-70-00-00-00-00",

        "Step": ""

    },

    "ProcessorType": "CPU",

    "Socket": 1,

    "Status": {

        "Health": "OK",

        "Oem": {

            "Public": {

                "FaultDescription": "",

                "Severity": "Informational"

            }

        },

        "State": "Enabled"

    },

    "TotalCores": 64,

    "TotalThreads": 64

}

响应码：200

【输出说明】

表4-101 查询CPU信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

指定CPU资源模型的OData 描述信息

@odata.id

字符串

指定CPU资源的访问路径

@odata.type

字符串

指定CPU资源的类型

Id

字符串

ID号

InstructionSet

字符串

指令集

Manufacturer

字符串

CPU厂商名称

MaxSpeedMHz

数值

CPU最大频率(intel:睿频)

Model

字符串

CPU型号

Name

字符串

CPU名称

Actions

Redfish 允许的指定CPU资源可执行操作

Actions.Oem.Public

 自定义Actions可执行的操作

#Processor.LicenseUpload

对象

上传Intel On Demand License激活文件操作

target

字符串

上传Intel On Demand License激活文件操作路径

#Processor.StateReportExport

对象

导出CPU状态报告操作

target

字符串

导出CPU状态报告路径

ProcessorType

字符串

指定 CPU 资源的类型

CPU;GPU;FPGA;DSP;Accelerator;OEM

Socket

数值

指定 CPU 资源的插槽号

Status.Health

字符串

指定CPU资源的健康状态

Status.State

字符串

指定CPU资源的使能状态

TotalCores

数值

总核数

TotalThreads

数值

总线程数

ChopType

字符串

架构类型

Oem.Public.ChipId

字符串

CPU标识符，仅飞腾CPU平台支持

Oem.Public.L1CacheKiB

数值

L1缓存大小

Oem.Public.L2CacheKiB

数值

L2缓存大小

Oem.Public.L3CacheKiB

数值

L3缓存大小

Oem.Public.SerialNumber

字符串

CPU序列号

Oem.Public.Temperature

数值

CPU温度

Oem.Public.ThermalDesignPower

数值

CPU热设计功耗

Oem.Public.FrequencyMHz

数值

CPU基频

Oem.Public.64BitSupported

布尔型

是否支持64位

Oem.Public.Capability

数组

指定CPU支持的Intel On Demand功能及状态

Oem.Public.Capability.Name

字符串

指定CPU支持的Intel On Demand功能：

CSS4

AMS4

AMS1

CSS2

SGX512

Oem.Public.Capability.State

字符串

指定CPU支持的Intel On Demand状态：

Enabled：功能已激活

Disabled：功能未激活

Ppin

字符串

Protected Processor Inventory Number

ProcessorArchitecture

字符串

CPU架构

ProcessorId

对象

指定CPU资源的Processor ID信息

Step

字符串

步频

 

【修改记录】

(1)     HDM2-1.57：新增字段Oem.Public.ThermalDesignPower；

(2)     HDM2-2.02：新增Intel On Demand信息；

(3)     HDM2-2.03：Actions字段更改为Actions.Oem.Public字段；

(4)     HDM3-1.09：新增字段Oem.Public.ChipId；

 

4.3.12  查询内存列表

【功能描述】

查询内存列表信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id/Memory

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-102 查询内存列表信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

system_id

系统资源的ID

当前所有机型取值为1

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/Memory

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#MemoryCollection.MemoryCollection",

    "@odata.id": "/redfish/v1/Systems/1/Memory",

    "@odata.type": "#MemoryCollection.MemoryCollection",

    "Description": "A Collection of memory resource instances.",

    "Members": [

        {

            "@odata.id": "/redfish/v1/Systems/1/Memory/DIMM110"

        },

{

            "@odata.id": "/redfish/v1/Systems/1/Memory/DIMM210"

        }

    ],

    "[email protected]": 2,

    "Name": "Memory Module Collection",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success",

            "PowerWatts": 0,

            "RASConfig": {

                "ADDDCSparing": "Disabled",

                "ECC": "Enabled",

                "MirrorMode": "Partial Mirror Mode",

                "PatrolScrub": "Enable at End of POST",

                "SDDC": null

            }

        }

    }

}

响应码：200

【输出说明】

表4-103 查询内存列表信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

内存集合资源模型的OData 描述信息

@odata.id

字符串

内存集合资源的访问路径

@odata.type

字符串

内存集合资源的类型

Description

字符串

接口功能描述

Members

数组

内存资源列表

[email protected]

数值

内存资源数量

Name

字符串

内存集合资源的名称

Oem.Public.PowerWatts

字符串

内存功耗，不支持显示null

RASConfig

对象

RAS配置信息

ADDDCSparing

字符串

ADDDCSparing状态

Enabled

Disabled

ECC

字符串

ECC状态

Enabled

Disabled

MirrorMode

字符串

MirrorMode状，不支持显示null

Partial Mirror Mode

Full Mirror Mode

Disabled

PatrolScrub

字符串

PatrolScrub状态

Enabled

Disabled

Enable at End of POST

SDDC

字符串

SDDC状态

Enabled

Disabled

 

4.3.13  查询指定内存条信息

【功能描述】

查询指定内存信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id/Memory/memory_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-104 查询内存信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

system_id

系统资源的ID

当前所有机型取值为1

memory_id

内存ID

由内存集合中查询

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/Memory/DIMM110

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{  

 "@odata.context": "/redfish/v1/$metadata#Systems/Members/1/Memory/Members/$entity",

    "@odata.id": "/redfish/v1/Systems/1/Memory/DIMM110",

    "@odata.type": "#Memory.v1_10_0.Memory",

    "AllowedSpeedsMHz": [

        4800

    ],

"BaseModuleType": "RDIMM",

"BusWidthBits": 80,

    "CapacityMiB": 32768,

    "DCPMMType": null,

    "DataWidthBits": 64,

    "DeviceLocator": "CPU1_CH1_D0",

    "ErrorCorrection": "NoECC",

    "FirmwareRevision": null,

    "Id": "DIMM110",

    "IsRankSpareEnabled": false,

    "IsSpareDeviceEnabled": false,

    "Manufacturer": "Micron",

    "MemoryDeviceType": "DDR5",

    "MemoryLocation": {

        "Channel": 1,

        "Controller": 0,

        "Slot": 0,

        "Socket": 1

    },

    "Name": "DIMM110",

    "Oem": {

        "Public": {

            "AccumulatedPowerOnHours": null,

            "Authenticity": "Normal",

            "CapacityGiB":32,

            "CompletionCode": 0,

            "ControllerTemperatureCelsius": null,

            "Description": "Success",

            "DisabledCausation": null,

            "MediumTemperatureCelsius": null,

            "Model": "MTC20F1045S1RC48BAX",

            "Technology": "RDIMM",

            "VDDQVolt": "1.1V",

            "OperatingSpeedMegaTransfersPerSecond": 4800,

            "AllowedSpeedsMegaTransfersPerSecond": [

                4800

            ]

        }

    },

    "OperatingSpeedMhz": 4800,

    "PartNumber": "MTC20F1045S1RC48BAX",

    "PersistentRegionSizeLimitMiB": null,

    "PowerManagementPolicy": {

        "PolicyEnabled": false

    },

    "RankCount": 1,

    "RemainingServiceLifePercent": null,

    "SecurityCapabilities": {

        "PassphraseCapable": false

    },

    "SerialNumber": "2B6BAE3E",

    "Status": {

        "Health": "OK",

        "Oem": {

            "Public": {

                "FaultDescription": "",

                "Severity": "Informational"

            }

        },

        "State": "Enabled"

    },

"VolatileRegionSizeLimitMiB": null

}

响应码：200

【输出说明】

表4-105 查询指定内存信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

指定内存资源模型的OData 描述信息

@odata.id

字符串

指定内存资源的访问路径

@odata.type

字符串

指定内存资源的类型

BaseModuleType

字符串

指定内存资源基本模块类型

DeviceLocator

字符串

指定内存丝印

CapacityMiB

数值

指定内存的容量

ErrorCorrection

字符串

错误纠正

NoECC

SingleBitECC

MultiBitECC

AddressParity

Id

字符串

ID号

IsRankSpareEnabled

布尔型

备用Rank使能(未实现，固定false)

IsSpareDeviceEnabled

布尔型

备用设备使能

MemoryDeviceType

字符串

内存类型，有：

DDR3，DDR4，SDRAM…

MemoryLocation.Channel

数值

指定内存资源的通道号

MemoryLocation.Slot

数值

指定内存资源的槽位号(DIMM号)

MemoryLocation.Controller

数值

指定内存资源的控制器编号

MemoryLocation.Socket

数值

指定内存资源所属CPU槽位号

Oem.Public.Authenticity

字符串

内存认证：

Vendor certified：厂家已经过认证

Normal：厂家未经过认证

Oem.Public.Model

字符串

指定内存资源的型号

Oem.Public.Technology

字符串

内存技术：

RDIMM

UDIMM

SODIMM

LRDIMM

NVDIMM

Oem.Public.VDDQVolt

字符串

内存电压值

Oem.Public.MediumTemperatureCelsius

数值

内存资源的介质温度

Oem.Public.ControllerTemperatureCelsius

数值

内存资源的控制器温度

Oem.Public.AccumulatedPowerOnHours

数值

累计上电时间（Hour）

Oem.Public.OperatingSpeedMegaTransfersPerSecond

数值

指定内存资源的当前运行频率

Oem.Public.AllowedSpeedsMegaTransfersPerSecond

数组

内存资源的最大频率

Oem.Public.DisabledCausation

字符串

内存禁用原因描述

Oem.Public.CapacityGiB

数值

内存容量（GiB）

Name

字符串

名称

OperatingSpeedMhz

数值

指定内存资源的当前运行频率

AllowedSpeedsMHz   

数组

内存资源的最大频率

PartNumber

字符串

部件号

PowerManagementPolicy.PolicyEnabled

布尔型

电源管理策略使能

RankCount

数值

Rank个数

SecurityCapabilities.PassphraseCapable

布尔型

支持安全加密功能

SerialNumber

字符串

指定内存序列号

Status.Health

字符串

指定内存资源的健康状态

Status.State

字符串

指定内存资源的使能状态

Enabled  在位

Disabled  禁用

Absent   不在位

Status.Oem.Public.FaultDescription

字符串

指定内存资源的故障描述

Status.Oem.Public.Severity

字符串

指定内存资源的自定义健康状态

Manufacturer

字符串

指定内存资源的厂商名称

FirmwareRevision

字符串

内存固件版本

VolatileRegionSizeLimitMiB

数值

指定内存资源的易失性容量（MiB）

PersistentRegionSizeLimitMiB

数值

指定内存资源的永久性容量（MiB）

RemainingServiceLifePercent

数值

指定内存资源的剩余寿命

DCPMMType

字符串

工作模式：

Memory Mode: 内存模式

APP Direct Mode： 应用直接访问模式

Mixed Mode：混合模式

DataWidthBits

数值

指定内存数据位宽

BusWidthBits

数值

指定内存总线位宽

 

【修改记录】

(1)     HDM2-1.57：新增字段Oem.Public.CapacityGiB；

 

4.3.14  查询RAID卡列表

【功能描述】

查询RAID卡列表。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id/Storages

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-106 查询RAID卡列表参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

Ipv4或Ipv6

system_id

系统资源的ID

当前所有机型取值为1

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/Storages

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#StorageCollection.StorageCollection",

    "@odata.id": "/redfish/v1/Systems/1/Storages",

    "@odata.type": "#StorageCollection.StorageCollection",

    "Members": [],

    "[email protected]": 0,

    "Name": "Storage Collection",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success",

            "Status": {

                "Health": "OK",

                "State": "Starting"

            }

        }

    }

}

响应码：200

【输出说明】

表4-107 查询RAID卡列表信息输出参数说明

字段

类型

字段说明

@odata.context 

字符串

RAID卡列表资源模型的Odata 描述信息

@odata.id

字符串

RAID卡列表资源的访问路径

@odata.type

字符串

RAID卡列表资源的类型

Members

数组

RAID卡信息查询路径列表

[email protected]

数值

当前存储资源数量

Name

字符串

RAID卡列表资源的名称

Oem.Public.Status.State

字符串

RAID卡的整体状态：

Starting：BIOS正在初始化

Disabled：故障或禁用

UnavailableOffline：服务器下电

Enabled：正常

Absent：不在位

UnKnow：未知状态

Oem.Public.Status.Health

字符串

RAID卡的整体健康状态

 

4.3.15  查询指定RAID卡信息

【功能描述】

查询指定的RAID卡信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id/Storages/raid_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-108 查询指定RAID卡信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

system_id

系统资源的ID

当前所有机型取值为1

raid_id

RAID卡ID

由RAID卡集合中查询

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/Storages/RAIDStorage0

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#Storage.Storage(*)",

    "@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage0",

    "@odata.type": "#Storage.v1_9_0.Storage",

    "Actions": {

        "Oem": {

            "Public": {

                "#Storage.ClearConfiguration": {

                    "target": "/redfish/v1/Systems/1/Storages/RAIDStorage0/Actions/Oem/Public/Storage.ClearConfiguration"

                },

                "#Storage.ClearForeignConfiguration": {

                    "target": "/redfish/v1/Systems/1/Storages/RAIDStorage0/Actions/Oem/Public/Storage.ClearForeignConfiguration"

                }

            }

        }

    },

    "Drives": [

        {

            "@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront3"

        },

        {

            "@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront5"

        },

        {

            "@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront6"

        }

    ],

    "[email protected]": 3,

    "Id": "RAIDStorage0",

    "Name": "RAIDStorage0",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

"IdleDriveSlots": [

{

                "@odata.id": "/redfish/v1/Chassis/1/Oem/Public/IdleDriveSlots/Front1"

            },

{

                "@odata.id": "/redfish/v1/Chassis/1/Oem/Public/IdleDriveSlots/Front2"

            },

{

                "@odata.id": "/redfish/v1/Chassis/1/Oem/Public/IdleDriveSlots/Front6"

            }

],

"IdleDriveSlots @odata.count": 3

        }

    },

    "StorageControllers": [

        {

            "@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage0#/StorageControllers/0",

            "AssetTag": "RAID-LSI-9560-LP-16i-8GB",

"CardManufacturer": "Broadcom",

"CardModel": "HBA-LSI-9500-LP-8i",

            "FirmwareVersion": "5.160.02-3415",

            "Manufacturer": "Broadcom",

            "MemberId": "0",

            "Model": "RAID-LSI-9560-LP-16i-8GB",

            "Name": "RAID-LSI-9560-LP-16i-8GB",

            "Oem": {

                "Public": {

                    "AssociatedCard": {

                        "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/5"

                    },

                    "BBUstate": "Miss",

                    "CapacitancePercent": null,

                    "CapacitanceStatus": {

                        "FaultDescription": "",

                        "Health": "OK",

                        "Severity": "Informational",

                        "State": "Absent"

                    },

                    "ChipManufacturer": "Broadcom",

                    "ChipModel": "LSI3916",

                    "ConfigurationVersion": "5.1600.00-0393",

                    "CopyBackState": true,

                    "DDRECCCount": 0,

                    "ExternalPortCount":null,

                    "FaultforLogicalDrives": [],

                    "FlashState": "Miss",

                    "InternalPortCount":16,

                    "JBODState": null,

                    "MaintainPDFailHistory": true,

                    "MaxStripeSizeBytes": 1048576,

                    "MemorySizeMiB": 8192,

                    "MinStripeSizeBytes": 65536,

                    "Mode": "RAID",

                    "PackageVersion": "52.16.0-3803",

"PSOCFirmwareVersion"："0x000C",

                    "SASAddress": "500062B208620140",

                    "SmarterCopyBackState": false,

"SpeedGTps": null

                    "SupportedConfigurationOperation": [

                        "ClearForeignConfiguration",

                        "ClearConfiguration",

                        "ModifyProperty",

                        "ManageVolumes",

                        "ModifyMode",

"ConfigureAccessPolicy",

"ConfigureWritePolicy",

"ConfigureReadPolicy",

"ConfigureDriveCachePolicy"

                    ],

                    "SupportedRAIDLevels": [

                        "RAID0",

                        "RAID1",

                        "RAID5",

                        "RAID6",

                        "RAID10",

                        "RAID50",

                        "RAID60"

                    ],

"SupportedRAIDMode": [

                        "RAID",

                        "JBOD"

                    ],

"SupportedStripSize": [

                        "64KB",

                        "128KB",

"256KB",

"512KB",

"1MB"

                    ],

                    "TemperatureCelsius": 48

                }

            },

            "SerialNumber": "SKB3980100",

            "SpeedGbps": 12,

            "Status": {

                "Health": "OK",

                "Oem": {

                    "Public": {

                        "FaultDescription": "",

                        "Severity": "Informational"

                    }

                },

                "State": "Enabled"

            },

            "SupportedDeviceProtocols": [

                "SAS/SATA"

            ]

        }

    ],

    "[email protected]": 1,

    "Volumes": {

        "@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes"

    }

}

响应码：200

【输出说明】

表4-109 查询指定RAID卡信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

指定RAID卡资源模型的OData 描述信息

@odata.id

字符串

指定RAID卡资源的访问路径

@odata.type

字符串

指定RAID卡资源的类型

Actions.Oem.Public

自定义Actions可执行的操作

Storage.ClearConfiguration

对象

清除指定RAID卡的所有配置操作

target

字符串

清除指定RAID卡的所有配置操作路径

Storage.ClearForeignConfiguration

对象

清除指定RAID卡下物理盘Foreign状态操作

target

字符串

清除指定RAID卡下物理盘Foreign状态操作路径

Drives

数组

物理盘资源访问集合

[email protected]

数值

物理盘资源数量

Id

字符串

指定存储资源的 ID

Name

字符串

指定存储资源的名称

Oem.Public

自定义属性

Oem.Public.IdleDriveSlots

数组

指定空闲槽位资源的访问路径

StorageControllers.Model

字符串

指定RAID卡型号

StorageControllers.AssetTag

字符串

资产标签

StorageControllers.CardManufacturer

字符串

存储控制器生产厂商

StorageControllers.CardModel

字符串

存储控制器型号

StorageControllers.FirmwareVersion

字符串

固件版本

StorageControllers.Manufacturer

字符串

厂商

StorageControllers.MemberId

字符串

存储控制器资源ID

StorageControllers.Name

字符串

RAID卡名称

StorageControllers.Oem.Public.BBUstate

字符串

超级电容状态

N/A

Learn

LearnFail

Over_temp

Failed

Fatal

ChargeCompleted

Charging

Miss

StorageControllers.Oem.Public.CapacitanceStatus

对象

指定存储控制器电容(BBU)状态，包括：

·     Health：电容健康状态

·     State：电容使能状态：

·     Severity：自定义健康状态

·     FaultDescription：故障描述信息

StorageControllers.Oem.Public.CapacitancePercent

字符串

超级电容电量百分比

StorageControllers.Oem.Public.ChipModel

字符串

芯片型号

StorageControllers.Oem.Public.ChipManufacturer

字符串

芯片厂商

Broadcom：LSI卡

Microchip ：PMC卡

Marvell：Marvell自研卡和外购卡

StorageControllers.Oem.Public.ConfigurationVersion

字符串

控制卡配置版本

StorageControllers.Oem.Public.CopyBackState

布尔型

回拷状态

StorageControllers.Oem.Public.DDRECCCount

数值

指定存储控制器内存可纠错错误计数

StorageControllers.Oem.Public.FlashState

字符串

Flash卡状态：

Initializing

Normal

Miss

Failed

Warning

Unknow

N/A

StorageControllers.Oem.Public.FaultforLogicalDrives

数组

当前RAID卡下故障逻辑盘列表

StorageControllers.Oem.Public.JBODState

布尔型

JBOD状态

StorageControllers.Oem.Public.MaintainPDFailHistory

布尔

指定存储驱动器故障记录功能的使能状态

StorageControllers.Oem.Public.MinStripeSizeBytes

数值

控制器支持最小条带值

StorageControllers.Oem.Public.MaxStripeSizeBytes

数值

控制器支持最大条带值

StorageControllers.Oem.Public.MemorySizeMiB

数值

缓存大小，单位MiB

StorageControllers.Oem.Public.Mode

字符串

控制卡模式：

Non-RAID

RAID

HBA

Mixed

JBOD

SimpleVolume

AutoVolume

StorageControllers.Oem.Public.PackageVersion

字符串

LSI卡的PackageVersion

StorageControllers.Oem.Public.PSOCFirmwareVersion

字符串

PSOC固件版本

StorageControllers.Oem.Public.SASAddress

字符串

指定存储控制器地址，没有显示null

StorageControllers.Oem.Public.SmarterCopyBackState

布尔型

SMART错误回拷状态

StorageControllers.Oem.Public.SupportedConfigurationOperation

数组

指定存储控制器支持的能力

StorageControllers.Oem.Public.SupportedRAIDLevels

数组

所支持raid级别

StorageControllers.Oem.Public.SupportedStripSize

数组

所支持的条带大小

StorageControllers.Oem.Public.SupportedRAIDMode

数组

当前所支持的RAID卡模式

StorageControllers.Oem.Public.TemperatureCelsius

数值

当前温度

StorageControllers.Oem.Public.AssociatedCard

对象

关联卡路径信息

StorageControllers.Oem.Public.SpeedGTps

数值

接口速率

说明：仅Marvell自研卡支持

StorageControllers.SerialNumber

字符串

序列号，没有显示null

StorageControllers.SpeedGbps

数值

接口速率

说明：非Marvell卡支持

Marvell外购卡不支持接口速率显示

StorageControllers.SupportedDeviceProtocols

数组

控制器支持协议

[email protected]

数值

存储控制器管理的驱动器个数

Volumes

对象

逻辑盘查询路径

StorageControllers.Status

对象

指定存储控制器状态，包括：

·     Health：存储控制器健康状态

·     State：存储控制器使能状态

·     Severity：自定义健康状态

·     FaultDescription：故障描述信息

StorageControllers.Oem.Public.InternalPortCount

数值

内部端口数量

StorageControllers.Oem.Public.ExternalPortCount

数值

外部端口数量

 

【修改记录】

(1)     HDM2-1.14：新增字段StorageControllers.Oem.Public.SupportedRAIDMode；

(2)     HDM2-1.55：新增Actions对象中Storage.ClearConfiguration和Storage.ClearForeignConfiguration字段；

(3)     HDM2-1.57：新增字段StorageControllers.Oem.Public.InternalPortCount和StorageControllers.Oem.Public.ExternalPortCount；

(4)     HDM2-2.03：在字段StorageControllers.Oem.Public.ChipManufacturer中新增Marvell厂商描述；

(5)     HDM2-2.03：在字段StorageControllers.Oem.Public.SpeedGTps和StorageControllers.SpeedGbps中新增Marvell外购卡速率显示说明；

(6)     HDM2-2.04：新增字段StorageControllers.CardManufacturer及StorageControllers.CardModel；

(7)     HDM3-1.15：新增自定义属性；

(8)     HDM2-2.10：新增字段StorageControllers.Oem.Public.PSOCFirmwareVersion；

 

4.3.16  修改指定RAID卡信息

【功能描述】

修改指定的RAID卡信息。

【所属权限模块】

远程控制

【所属系统锁定类型】

硬件配置锁定

【命令格式】

PATCH https://device_ip/redfish/v1/Systems/system_id/Storages/raid_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

  "StorageControllers":[

      {

          "Oem":{

              "Public":{

                  "CopyBackState":cb_state,

                  "SmarterCopyBackState":smartcb_state,

                  "JBODState": jbod_state,

                  "Mode":mode

              }

          }

      }

  ]

}

【参数说明】

表4-110 修改RAID卡信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

system_id

系统资源的ID

当前所有机型取值为1

raid_id

RAID卡ID

由RAID卡集合中查询

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

CopyBackState

回拷使能状态

(仅LSI卡支持)

true

false

SmarterCopyBackState

SMART错误回拷使能状态

(仅LSI卡支持)

true

false

JBODState

JBOD使能状态

(仅LSI卡支持)

true

false

Mode

存储控制器的模式

RAID

HBA

Mixed

JBOD

 

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/Systems/1/Storages/RAIDStorage0

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

  "StorageControllers":[

      {

          "Oem":{

              "Public":{

                  "CopyBackState":true,

                  "SmarterCopyBackState":false,

                   "Mode":"RAID"

              }

          }

      }

  ]

}

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#Storage.Storage(*)",

    "@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage0",

    "@odata.type": "#Storage.v1_9_0.Storage",

    "Actions": {

        "Oem": {

            "Public": {

                "#Storage.ClearConfiguration": {

                    "target": "/redfish/v1/Systems/1/Storages/RAIDStorage0/Actions/Oem/Public/Storage.ClearConfiguration"

                },

                "#Storage.ClearForeignConfiguration": {

                    "target": "/redfish/v1/Systems/1/Storages/RAIDStorage0/Actions/Oem/Public/Storage.ClearForeignConfiguration"

                }

            }

        }

    },

    "Drives": [

        {

            "@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront1"

        },

        {

            "@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront2"

        },

        {

            "@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront3"

        },

        {

            "@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront4"

        }

    ],

    "[email protected]": 4,

    "Id": "RAIDStorage0",

    "Name": "RAIDStorage0",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "StorageControllers": [

        {

            "@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage0#/StorageControllers/0",

            "AssetTag": "RAID-LSI-9560-LP-16i-8GB",

"CardManufacturer": "Broadcom",

"CardModel": "HBA-LSI-9500-LP-8i",

            "FirmwareVersion": "5.150.02-3377",

            "Manufacturer": "H3C",

            "MemberId": "0",

            "Model": "RAID-LSI-9560-LP-16i-8GB",

            "Name": "RAID-LSI-9560-LP-16i-8GB",

            "Oem": {

                "Public": {

                    "AssociatedCard": {

                        "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/3"

                    },

                    "BBUstate": "Miss",

                    "CapacitancePercent": null,

                    "CapacitanceStatus": {

                        "FaultDescription": "",

                        "Health": "OK",

                        "Severity": "Informational",

                        "State": "Absent"

                    },

                    "ChipManufacturer": "Broadcom",

                    "ChipModel": "LSI3108",

                    "ConfigurationVersion": "5.1500.00-0399",

                    "CopyBackState": true,

                    "DDRECCCount": 0,

                    "ExternalPortCount":null,

"FlashState": "Miss",

"InternalPortCount":16,

"FaultforLogicalDrives": [

                      {

"@odata.id":

"/redfish/v1/Chassis/1/Storages/RAIDStorage0/Volumes/LogicalDrive1"

                      },

                      {

                           "@odata.id":

"/redfish/v1/Chassis/1/Storages/RAIDStorage0/Volumes/LogicalDrive2"

                      }

                   ],

                    "JBODState": null,

                    "MaintainPDFailHistory": true,

                    "MaxStripeSizeBytes": 1048576,

                    "MemorySizeMiB": 8192,

                    "MinStripeSizeBytes": 65536,

                    "Mode": "RAID",

                    "PackageVersion": "52.15.0-3720",

                    "SASAddress": "500062B202508300",

                    "SmarterCopyBackState": false,

"SpeedGTps": null

                    "SupportedConfigurationOperation": [

                        "ClearForeignConfiguration",

                        "ClearConfiguration",

                        "ModifyProperty",

                        "ManageVolumes",

                        "ModifyMode",

"ConfigureAccessPolicy",

"ConfigureWritePolicy",

"ConfigureReadPolicy",

"ConfigureDriveCachePolicy"

                    ],

                    "SupportedRAIDLevels": [

                        "RAID0",

                        "RAID1",

                        "RAID5",

                        "RAID6",

                        "RAID10",

                        "RAID50",

                        "RAID60"

                    ],

"SupportedRAIDMode": [

                        "RAID",

                        "JBOD"

                    ],

"SupportedStripSize": [

                        "64KB",

                        "128KB",

"256KB",

"512KB",

"1MB"

                    ],

                    "TemperatureCelsius": 52

                }

            },

            "SerialNumber": "SK00977218",

            "SpeedGbps": 12,

            "Status": {

                "Health": "OK",

                "Oem": {

                    "Public": {

                        "FaultDescription": "",

                        "Severity": "Informational"

                    }

                },

                "State": "Enabled"

            },

            "SupportedDeviceProtocols": [

                "SAS"

            ]

        }

    ],

    "[email protected]": 1,

    "Volumes": {

        "@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes"

    }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回体字段说明同【查询指定RAID卡信息】

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

 

4.3.17  清除指定RAID卡下物理盘Foreign状态

【功能描述】

清除指定RAID卡下物理盘Foreign状态

【所属权限模块】

远程控制

【所属系统锁定类型】

硬件配置锁定

【命令格式】

POST https://device_ip/redfish/v1/Systems/system_id/Storages/raid_id/Actions/Oem/Public/Storage.ClearForeignConfiguration

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

}

【参数说明】

表4-111 清除指定RAID卡下物理盘Foreign状态参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

system_id

系统资源的ID

当前所有机型取值为1

raid_id

RAID卡ID

由RAID卡集合中查询

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/Systems/1/Storages/RAIDStorage0/Actions/Oem/Public/Storage.ClearForeignConfiguration

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

}

【应答示例】

{

"Oem": {

       "Public": {

           "CompletionCode": 0,

           "Description": "Success"

       }

 },

"error": {

       "@Message.ExtendedInfo": [

           {

               "@odata.type": "#Message.v1_1_1.Message",

               "Message": "Successfully Completed Request",

               "MessageArgs": [],

               "MessageId": "Base.1.8.1.Success",

               "MessageSeverity": "OK",

               "Resolution": "None"

           }

       ],

        "code":"Base.1.8.1.Success",

        "message":"Successfully Completed Request"

    }

}

}

响应码：200

【输出说明】

表4-112 清除指定RAID卡下物理盘Foreign状态操作输出参数说明

字段

类型

字段说明

code

字符串

指示消息注册表中特定消息ID的字符串

message

字符串

与消息注册表中的消息对应的易读的错误消息

@Message.ExtendedInfo

消息扩展信息

@odata.type

字符串

消息资源的OData描述信息

MessageId

字符串

消息ID

Message

字符串

详细信息

MessageArgs

数组

信息参数

MessageSeverity

字符串

严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical

Resolution

字符串

解决建议

 

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

(2)     HDM2-2.04：Message.ExtendedInfo前添加error节点，并且在error节点下增加code和message字段；

 

4.3.18  清除指定RAID卡的所有配置

【功能描述】

清除指定RAID的默认配置

【所属权限模块】

远程控制

【所属系统锁定类型】

硬件配置锁定

【命令格式】

POST https://device_ip/redfish/v1/Systems/system_id/Storages/raid_id/Actions/Oem/Public/Storage.ClearConfiguration

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

}

【参数说明】

表4-113 清除指定RAID卡的所有配置参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

system_id

系统资源的ID

当前所有机型取值为1

raid_id

RAID卡ID

由RAID卡集合中查询

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/Systems/1/Storages/RAIDStorage0/Actions/Oem/Public/Storage.ClearConfiguration

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

}

【应答示例】

{

"Oem": {

       "Public": {

           "CompletionCode": 0,

           "Description": "Success"

       }

 },

"error": {

       "@Message.ExtendedInfo": [

           {

               "@odata.type": "#Message.v1_1_1.Message",

               "Message": "Successfully Completed Request",

               "MessageArgs": [],

               "MessageId": "Base.1.8.1.Success",

               "MessageSeverity": "OK",

               "Resolution": "None"

           }

       ],

        "code":"Base.1.8.1.Success",

        "message":"Successfully Completed Request"

    }

}

}

响应码：200

【输出说明】

表4-114 清除指定RAID卡的所有配置操作输出参数说明

字段

类型

字段说明

code

字符串

指示消息注册表中特定消息ID的字符串

message

字符串

与消息注册表中的消息对应的易读的错误消息

@Message.ExtendedInfo

消息扩展信息

@odata.type

字符串

消息资源的OData描述信息

MessageId

字符串

消息ID

Message

字符串

详细信息

MessageArgs

数组

信息参数

MessageSeverity

字符串

严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical

Resolution

字符串

解决建议

 

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

(2)     HDM2-2.04：Message.ExtendedInfo前添加error节点，并且在error节点下增加code和message字段；

 

4.3.19  查询逻辑盘列表

【功能描述】

查询逻辑盘列表信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id/Storages/RAIDStorage_id/Volumes

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-115 查询逻辑盘列表信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

system_id

系统资源的ID

当前所有机型取值为1

RAIDStorage_id

RAID卡的ID

数值

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#VolumeCollection.VolumeCollection",

    "@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes",

    "@odata.type": "#VolumeCollection.VolumeCollection",

    "Members": [

        {

            "@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes/LogicalDrive239"

        }

    ],

    "[email protected]": 1,

    "Name": "Volume Collection",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    }

}

响应码：200

【输出说明】

表4-116 查询逻辑盘列表输出参数说明

字段

类型

字段说明

@odata.context

字符串

逻辑盘集合资源模型的OData 描述信息

@odata.id

字符串

逻辑盘集合资源的访问路径

@odata.type

字符串

逻辑盘集合资源的类型

Members

数组

逻辑盘查询路径

[email protected]

数值

逻辑盘个数

Name

字符串

逻辑盘集合资源的名称

 

4.3.20  创建逻辑盘

【功能描述】

创建逻辑盘。

【所属权限模块】

远程控制

【所属系统锁定类型】

硬件配置锁定

【命令格式】

POST https://device_ip/redfish/v1/Systems/system_id/Storages/storage_id/Volumes

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

//通过ConnectionID进行创建

{

  "Oem": {

      "Public":{

          "Name":name,

          "InitState": initstate,

          "StripSize":stripsize,

          "Level": raid_level,

          "SpanNum": spanname,

          "NumDrivePerSpan": num_drives,

          "DefaultReadPolicy": read_policy,

          "DefaultWritePolicy": write_policy,

          "DefaultCachePolicy": cache_policy,

          "DriveCache": drive_cache_policy,

          "AccessPolicy": access_policy,

          "Size": size,

          "SizeUnit": unit,

          "AccelerationMethod": acceleration,

          "PhysicalDiskList": [

              {

                  "group_id":group_id,

                  "id":connnection_id

              },

              ...

          ]

      }

  }

}

//通过LocationInfo进行创建

{

  "Oem": {

      "Public":{

          "Name":name,

          "InitState": initstate,

          "StripSize":stripsize,

          "Level": raid_level,

          "SpanNum": spanname,

          "NumDrivePerSpan": num_drives,

          "DefaultReadPolicy": read_policy,

          "DefaultWritePolicy": write_policy,

          "DefaultCachePolicy": cache_policy,

          "DriveCache": drive_cache_policy,

          "AccessPolicy": access_policy,

          "Size": size,

          "SizeUnit": unit,

          "AccelerationMethod": acceleration,

          "PhysicalDiskList": [

              {

                  "group_id":group_id,

                  "LocationInfo":location_info

              },

              ...

          ]

      }

  }

}

 

【支持卡说明】

LSI卡：9560，9540，9660

PMC卡：H460，P460，3254，且需支持MCTP

【参数说明】

表4-117 创建逻辑盘信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

system_id

系统资源的ID

当前所有机型取值为1

Oem.Public

对象

自定义属性，需要兼容B05没有Public的情况

Name

逻辑盘名称

字符串

InitState

初始化类型

初始化类型

LSI卡：

No：不进行初始化

Fast：快速初始化

Full：完全初始化

PMC卡：

Default：不进行初始化

RapidParity：快速初始化

说明：可选字段，若不下发，默认按不进行初始化处理

StripSize

条带大小

说明：

1、     LSI 9540只支持"64KB"

2、     LSI 9560支持"64KB"、"128KB"、"256KB"、"512KB"、"1MB"

3、     LSI 9660支持"64KB"、"256KB"

4、     PMC H460 3254支持"64KB"、"128KB"、"256KB"、"512KB"、"1MB"

5、     PMC P460 支持"16KB"、"32KB"、"64KB"、"128KB"、"256KB"、"512KB"、"1MB

6、     更多支持的存储控制器，以实际规格为准，可通过HDM/BIOS获取支持的条带大小

Level

RAID级别

说明：PMC卡不支持RAID00；

支持"RAID0", "RAID1", "RAID5", "RAID6", "RAID10", "RAID50", "RAID60",

"RAID1ADM"(仅支持3个盘),"RAID10ADM"

SpanNum

组个数

该字段为数值，若不下发，默认按0处理

说明：

PMC卡：

1）   当级别为0/1/5/6/10 , "RAID1 ADM","RAID10ADM"时，PMC卡下组个数为0

2）   当级别为50/60时 ，组个数需大于1

LSI卡：

1）     当级别是0/1/5/6，组个数为1

2）     当级别为00/10/50/60时，组个数需大于1

NumDrivePerSpan

每个组成员盘数

该字段为数值，若不下发，默认按0处理

LSI卡说明：

1） 当级别为0时，每个组成员盘数需大于0，且不能超过当前物理盘个数

2） 当级别为1时，每个组成员盘数需大于0的偶数，且不能超过当前物理盘个数

3） 当级别为5时，每个组成员数需大于2，且不能超过当前物理盘个数

4） 当级别为6时，每个组成员数需大于2，且不能超过当前物理盘个数

5） 当级别为00时，每个组成员盘数需大于0，且与组个数的乘积在当前物理盘个数范围内

6） 当级别为10时，每个组成员盘数需为大于0的偶数，且与组个数的乘积在当前物理盘个数范围内

7） 当级别为50时，每个组成员盘数需大于2，且与组个数的乘积在当前物理盘个数范围内

8）当级别为60时，每个组成员盘数需大于2，且与组个数的乘积在当前物理盘个数范围内

PMC卡说明：

1） 当级别为0时，每个组的成员盘数需大于0，且在当前物理盘的个数范围内

2） 当级别为1时，每个组的成员盘数为2，且在当前物理盘的个数范围内

3） 当级别为5时，每个组的成员盘数需大于2，且在当前物理盘的个数范围内

4） 当级别为6时，每个组的成员盘数需大于3，且在当前物理盘的个数范围内

5） 当级别为10时，每个组的成员盘数需大于3的偶数，且在当前物理盘的个数范围内

4）当级别为50时，每个组的成员盘数需大于2，且为3的倍数，与组个数的乘积在当前物理盘个数范围内

4）当级别为60时，每个组的成员盘数需大于3，且为4的倍数，与组个数的乘积在当前物理盘个数范围内

4）当级别为1ADM时，每个组的成员盘数为3，且在当前物理盘的个数范围内

5）当级别为10ADM时，每个组的成员盘数需大于5，且为6的倍数，在当前物理盘的个数范围内

DefaultWritePolicy

写策略

支持"WriteThrough", "WriteBack", "Always WriteBack"

说明：

1、PMC卡不支持该字段；

2、可选字段，若不下发，默认"WriteBack"

DefaultReadPolicy

读策略

支持"NoReadAhead", "ReadAhead"

说明：

1、PMC卡不支持该字段；

2、可选字段，若不下发，默认"ReadAhead"

DefaultCachePolicy

Cache策略

仅支持"DirectIO"

说明：

1、PMC卡不支持该字段；

2、可选字段，若不下发，默认"DirectIO"

DriveCache

物理盘缓存策略

支持"Unchanged", "Enable", "Disable"

说明：

1、PMC卡不支持该字段；

2、可选字段，若不下发，默认"Unchanged"

AccessPolicy

访问策略

支持"Read/Write", "Read only", "Blocked"

说明：

1、PMC卡不支持该字段；

2、可选字段，若不下发，默认"Read/Write"

Size

容量数值

说明

1、该字段为数值

2、当填写内容为0，以实际默认最大容量创建逻辑盘

SizeUnit

容量单位

说明

1、     支持"MiB", "GiB", "TiB"

2、     LSI卡：≥100MiB；PMC卡：≥1GiB

AccelerationMethod

加速策略

说明：

1、该字段类型为字符串；

2、该字段仅适用于PMC 且固件支持 MCTP的卡 ，可选类型为："ControllerCache"（PMC 且固件支持 MCTP的卡）

"None"

"IOBypass" (仅适用于SSD)

3、 可选字段，若不下发，默认"ControllerCache"

PhysicalDiskList

创建逻辑盘的物理盘列表

group_id

创建时物理盘所在的组ID

说明

PMC卡不支持该字段，若下发该字段，实际不生效；

该字段为数值

LSI卡当级别为00/10/50/60时，多组创建时，每组的硬盘个数需相等

id

物理盘索引ID

物理盘ConnectionID，可通过查询指定物理盘信息获取

LocationInfo

物理盘丝印

物理盘丝印，可通过查询指定物理盘信息获取

说明：

1、用户仅能通过索引或丝印一种形式进行创建，若两者都下发，则优先以丝印进行创建。

 

【使用实例1】

#通过LSI卡创建逻辑盘

【请求样例】

POST https://192.168.18.18/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

  "Oem": {

      "Public": {

          "Name":"LogicalDisk0",

          "InitState": "No",

          "StripSize":"64KB",

          "Level":"RAID0",

          "SpanNum": 1,

          "NumDrivePerSpan": 1,

          "DefaultReadPolicy": "Read Ahead",

          "DefaultWritePolicy": "Write Through",

          "DefaultCachePolicy": "Direct",

          "DriveCache": "Disable",

          "AccessPolicy": "Blocked",

          "Size": 199,

          "SizeUnit": "GiB",

          "PhysicalDiskList": [

              {

                  "group_id":0,

                  "id":11

              }

          ]

      }

  }

}

【应答示例】

{

"Oem": {

       "Public": {

           "CompletionCode": 0,

           "Description": "Success"

       }

 },

"error": {

       "@Message.ExtendedInfo": [

           {

               "@odata.type": "#Message.v1_1_1.Message",

               "Message": "Successfully Completed Request",

               "MessageArgs": [],

               "MessageId": "Base.1.8.1.Success",

               "MessageSeverity": "OK",

               "Resolution": "None"

           }

       ],

        "code":"Base.1.8.1.Success",

        "message":"Successfully Completed Request"

    }

}

}

响应码：200

【使用实例2】

#通过PMC卡创建逻辑盘

【请求样例】

POST https://192.168.18.18/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

  "Oem": {

      "Public": {

          "Name":"LogicalDisk1",

          "StripSize":"32KB",

          "Level":"RAID0",

          "SpanNum": 0,

          "NumDrivePerSpan": 1,

          "Size": 199,

          "SizeUnit": "GiB",

          "AccelerationMethod":"None",

          "PhysicalDiskList": [

              {

                  "LocationInfo":"DiskFront1"

                 

              }

          ]

      }

  }

}

【应答示例】

{

"Oem": {

       "Public": {

           "CompletionCode": 0,

           "Description": "Success"

       }

 },

"error": {

       "@Message.ExtendedInfo": [

           {

               "@odata.type": "#Message.v1_1_1.Message",

               "Message": "Successfully Completed Request",

               "MessageArgs": [],

               "MessageId": "Base.1.8.1.Success",

               "MessageSeverity": "OK",

               "Resolution": "None"

           }

       ],

        "code":"Base.1.8.1.Success",

        "message":"Successfully Completed Request"

    }

}

}

响应码：200

【使用实例3】

#通过PMC卡创建级别为RAID50的逻辑盘

【请求样例】

POST https://192.168.18.18/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

  "Oem": {

      "Public": {

          "Name":"LogicalDisk1",

          "StripSize":"32KB",

          "Level":"RAID50",

          "SpanNum": 2,

          "NumDrivePerSpan": 3,

          "Size": 0,

          "SizeUnit": "GiB",

          "AccelerationMethod":"None",

          "PhysicalDiskList": [

              {

                  "LocationInfo":"DiskFront1"

              },

              {

                  "LocationInfo":"DiskFront2"

              },

              {

                  "LocationInfo":"DiskFront3"

              },

              {

                  "LocationInfo":"DiskFront4"

              },

              {

                  "LocationInfo":"DiskFront5"

              },

              {

                  "LocationInfo":"DiskFront6"

              }

          ]

      }

  }

}

【应答示例】

{

"Oem": {

       "Public": {

           "CompletionCode": 0,

           "Description": "Success"

       }

 },

"error": {

       "@Message.ExtendedInfo": [

           {

               "@odata.type": "#Message.v1_1_1.Message",

               "Message": "Successfully Completed Request",

               "MessageArgs": [],

               "MessageId": "Base.1.8.1.Success",

               "MessageSeverity": "OK",

               "Resolution": "None"

           }

       ],

        "code":"Base.1.8.1.Success",

        "message":"Successfully Completed Request"

    }

}

}

响应码：200

【输出说明】

表4-118 创建逻辑盘操作输出参数说明

字段

类型

字段说明

code

字符串

指示消息注册表中特定消息ID的字符串

message

字符串

与消息注册表中的消息对应的易读的错误消息

@Message.ExtendedInfo

消息扩展信息

@odata.type

字符串

消息资源的OData描述信息

MessageId

字符串

消息ID

Message

字符串

详细信息

MessageArgs

数组

信息参数

MessageSeverity

字符串

严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical

Resolution

字符串

解决建议

 

【修改记录】

(1)     HDM2-1.14：修改支持卡说明及条带大小字段说明；

(2)     HDM2-1.14：修改条带大小字段说明：新增P460卡对16/32KB条带大小的支持；

(3)     HDM2-1.15：修改条带大小字段说明：更多支持的存储控制器，以实际规格为准，可通过HDM/BIOS获取支持的条带大小；

(4)     HDM2-1.53：添加所属系统锁定类型；

(5)     HDM2-2.04：Message.ExtendedInfo前添加error节点，并且在error节点下增加code和message字段；

(6)     HDM2-2.08：新增支持LSI 9660，并添加StripSize关于9660的说明；

 

4.3.21  删除指定逻辑盘

【功能描述】

删除指定逻辑盘。

【所属权限模块】

远程控制

【所属系统锁定类型】

硬件配置锁定

【命令格式】

DELETE https://device_ip/redfish/v1/Systems/system_id/Storages/storage_id/Volumes/volume_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-119 删除指定逻辑盘信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

system_id

系统资源的ID

当前所有机型取值为1

storage_id

RAID卡所在ID

如：RAIDStorage0

volume_id

逻辑盘编号

如：LogicalDrive0

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【使用实例】

【请求样例】

DELETE https://192.168.18.18/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes/LogicalDrive0

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

"Oem": {

       "Public": {

           "CompletionCode": 0,

           "Description": "Success"

       }

 },

"error": {

       "@Message.ExtendedInfo": [

           {

               "@odata.type": "#Message.v1_1_1.Message",

               "Message": "Successfully Completed Request",

               "MessageArgs": [],

               "MessageId": "Base.1.8.1.Success",

               "MessageSeverity": "OK",

               "Resolution": "None"

           }

       ],

        "code":"Base.1.8.1.Success",

        "message":"Successfully Completed Request"

    }

}

}

响应码：200

【输出说明】

表4-120 删除指定逻辑盘操作输出参数说明

字段

类型

字段说明

code

字符串

指示消息注册表中特定消息ID的字符串

message

字符串

与消息注册表中的消息对应的易读的错误消息

@Message.ExtendedInfo

消息扩展信息

@odata.type

字符串

消息资源的OData描述信息

MessageId

字符串

消息ID

Message

字符串

详细信息

MessageArgs

数组

信息参数

MessageSeverity

字符串

严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical

Resolution

字符串

解决建议

 

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

(2)     HDM2-2.04：Message.ExtendedInfo前添加error节点，并且在error节点下增加code和message字段；

 

4.3.22  查询指定逻辑盘信息

【功能描述】

查询指定的逻辑盘信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id/Storages/storage_id/Volumes/logical_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-121 查询指定逻辑盘信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

system_id

系统资源的ID

当前所有机型取值为1

storage_id

存储资源的 ID

由RAID卡列表中查询

logical_id

逻辑盘 ID

由逻辑盘集合中查询

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【使用实例1】

#查询LSI卡下逻辑盘信息

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes/LogicalDrive239

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#Volume.Volume(*)",

    "@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes/LogicalDrive239",

    "@odata.type": "#Volume.v1_5_0.Volume",

    "CapacityBytes": 600127266816,

    "Encrypted": false,

    "Id": "LogicalDrive239",

    "Links": {

        "Drives": [

           {

                "@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront4"

            }

        ],

        "[email protected]": 1

    },

    "Name": "",

    "Oem": {

        "Public": {

            "AccessPolicy": "Blocked",

            "BGIEnable": true,

            "BootEnable": false,

            "CompletionCode": 0,

            "ConsistencyCheck": false,

            "CurrentCachePolicy": "DirectIO",

            "CurrentReadPolicy": "ReadAhead",

            "CurrentWritePolicy": "WriteThrough",

            "DefaultCachePolicy": "DirectIO",

            "DefaultReadPolicy": "ReadAhead",

            "DefaultWritePolicy": "WriteThrough",

            "Description": "Success",

            "DriveCache": "Disabled",

            "FirmwareStatus": "Optimal",

            "NumDrivePerSpan": 1,

            "OptimumIOSizeBytes": 65536,

            "RaidControllerID": 0,

            "ReadPolicy": "ReadAhead",

"RebuildProgress":"2",

            "SSDCachecadeVolume": null,

            "SSDCachingEnable": null,

            "SpanNumber": 1,

            "VolumeRaidLevel": "RAID0",

            "WritePolicy": "WriteThrough"

        }

    },

    "RedundantType": "NonRedundant",

    "Status": {

        "Health": "OK",

        "Oem": {

            "Public": {

                "FaultDescription": "",

                "Severity": "Informational"

            }

        },

        "State": "Enabled"

    }

}

响应码：200

【使用实例2】

#查询PMC卡下逻辑盘信息

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes/LogicalDrive0

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#Volume.Volume(*)",

    "@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes/LogicalDrive0",

    "@odata.type": "#Volume.v1_0_3.Volume",

    "CapacityBytes": 53686272000,

    "Encrypted": false,

    "Id": "LogicalDrive0",

    "Links": {

        "Drives": [

            {

                "@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront2"

            },

            {

                "@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront3"

            }

        ],

        "[email protected]": 2

    },

    "Name": "flapper2",

    "Oem": {

        "Public": {

            "AccelerationMethod": "None",

            "BootEnable": false,

            "CompletionCode": 0,

            "Description": "Success",

            "FirmwareStatus": "Optimal",

            "OptimumIOSizeBytes": 32768,

            "RaidControllerID": 0,

"RebuildProgress":"2",

            "SSDCachecadeVolume": null,

            "SSDCachingEnable": null,

            "SpanNumber": 1,

            "NumDrivePerSpan":2,

            "VolumeRaidLevel": "RAID1"

        }

    },

    "RedundantType": "Mirrored ",

    "Status": {

        "Health": "",

        "Oem": {

            "Public": {

                "FaultDescription": "",

                "Severity": "Informational"

            }

        },

        "State": "Enabled"

    }

}

响应码：200

【输出说明】

表4-122 查询逻辑盘信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

指定逻辑盘资源模型的OData 描述信息

@odata.id

字符串

指定逻辑盘资源的访问路径

@odata.type

字符串

指定逻辑盘资源的类型

CapacityBytes

数值

逻辑盘容量，单位Bytes

Encrypted

布尔型

是否加密

Id

字符串

逻辑盘ID

Links.Drives

数组

逻辑盘下成员盘资源路径

[email protected]

数值

逻辑盘下物理盘个数

Name

字符串

逻辑盘名称

Oem.Public

指定逻辑盘自定义信息

AccessPolicy

字符串

访问策略

支持"Read/Write", "ReadOnly", "Blocked"

说明：PMC卡不支持该字段；

Marvell 外购卡不支持该字段；

BootEnable

布尔型

是否是启动盘

DriveCache

字符串

物理盘缓存策略

支持"Unchanged", "Enable", "Disable"

说明：PMC卡不支持该字段；

Marvell 外购卡不支持该字段；

DefaultCachePolicy

字符串

Cache策略

支持"DirectIO", "CachedIO"

说明：PMC卡不支持该字段；

Marvell 外购卡不支持该字段；

原IOPolicy，兼容支持

CurrentCachePolicy

字符串

Cache策略

支持"DirectIO", "CachedIO"

说明：PMC卡不支持该字段；

Marvell 外购卡不支持该字段；

NumDrivePerSpan

数值

组中成员盘个数

RaidControllerID

数值

逻辑盘所属控制器的 ID

CurrentReadPolicy

字符串

当前读策略

支持"NoReadAhead", "Read Ahead"

说明：PMC卡不支持该字段；

Marvell 外购卡不支持该字段；

ReadPolicy

字符串

当前读策略

支持"NoReadAhead", "Read Ahead"

说明：PMC卡不支持该字段；

Marvell 外购卡不支持该字段；

RebuildProgress

字符串

逻辑盘重建进度（百分比数据）

说明：LSI卡9500不支持该字段；

Marvell 卡不支持该字段；

DefaultReadPolicy

字符串

默认读策略

支持"NoReadAhead", "Read Ahead"

说明：PMC卡不支持该字段；

Marvell 外购卡不支持该字段；

SpanNumber

数值

逻辑盘包含的组个数

VolumeRaidLevel

字符串

RAID 级别：

说明：

1.PMC卡不支持RAID00；

2.支持"RAID0", "RAID1", "RAID5", "RAID6", "RAID00", "RAID10", "RAID50", "RAID60", “RAID1E”

3.Marvell外购卡仅支持RAID0、RAID1和RAID JBOD

DefaultWritePolicy

字符串

默认写策略

支持"WriteThrough", "Write Back", "AlwaysWriteBack"

说明：PMC卡不支持该字段；

Marvell外购卡不支持该字段；

CurrentWritePolicy

字符串

当前写策略

支持"WriteThrough", "Write Back", "AlwaysWriteBack"

说明：PMC卡不支持该字段；

Marvell外购卡不支持该字段；

WritePolicy

字符串

当前写策略

支持"WriteThrough", "Write Back", "AlwaysWriteBack"

说明：PMC卡不支持该字段；

Marvell外购卡不支持该字段；

FirmwareStatus

字符串

逻辑盘状态：

PMC卡逻辑盘状态：

"Optimal"

"Creating"

"Scrubbing"

"Zeroing"

"Rebuilding"

"Morphing"

"Verifying"

"Copying"

"Suboptimal"

"Degraded"

"Offline"

 

LSI卡逻辑盘状态：

"Optimal"

"Offline"

"Degraded"

"Rebuilding"

"Unknown"

 

Marvell自研卡逻辑盘状态：

"Foreign"

"Functional"

"Offline"

"Degraded"

"Rebuilding"

 

Marvell外购卡逻辑盘状态：

"Functional”

"Offline"

"Degraded"

OptimumIOSizeBytes

数值

条带大小

说明：

1、     LSI 9440只支持"64KB"

2、      LSI 9361和LSI 9460支持"64KB"、"128KB"、"256KB"、"512KB"、"1MB"

3、     PMC卡支持"16KB"、"32KB"、"64KB"、"128KB"、"256KB"、"512KB"、"1MB"

4、     更多支持的存储控制器，以实际规格为准，不再逐一列举

 

16384,    -- 16KB

32768,    -- 32KB

65536,    -- 64KB

131072,   -- 128KB

262144,   -- 256KB

524288,   -- 512KB

1048576,  -- 1MB

AccelerationMethod

字符串

加速策略，该字段仅PMC卡有效，可选类型为：

"ControllerCache",

"None"

"IOBypass"(仅适用于SSD)

"MaxCache"

BGIEnable

布尔

后台初始化使能状态

SSDCachecadeVolume

布尔

是否为CacheCade逻辑盘

ConsistencyCheck

布尔

一致性检查功能的启用状态

SSDCachingEnable

布尔

是否可使用CacheCade逻辑盘

RedundantType

字符串

逻辑盘冗余类型

RawDevice

NonRedundant(raid0, raid00)

Mirrored(raid1, raid1E)

StripedWithParity(raid5, raid6)

SpannedMirrors(raid10)

SpannedStripesWithParity(raid50, raid60)

Unknown

Status.Health

字符串

逻辑盘健康状态

Status.State

字符串

逻辑盘使能状态

Status.Oem.Public.Severity

字符串

自定义健康状态

Status.Oem.Public.FaultDescription

字符串

故障描述信息

 

【修改记录】

(1)     HDM2-1.56：Marvell卡下逻辑盘状态Oem.Public.FirmwareStatus字段取值调整：修改Optimal为Functional；

(2)     HDM2-2.03：对相关“字段说明”增加marvell外购卡说明；

(3)     HDM2-2.05：新增字段Oem.Public. RebuildProgress；

(4)     HDM3-1.15：新增字段 Oem.Public.RebuildProgress 表示逻辑盘的重建进度，同步HDM3；

(5)     HDM2-2.10：新增RebuildProgress、VolumeRaidLevel、RedundantType下的功能说明；

 

4.3.23  修改指定逻辑盘属性

【功能描述】

修改指定逻辑盘的属性。

【命令格式】

PATCH https://device_ip/redfish/v1/Systems/system_id/Storages/storage_id/Volumes/logical_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

  "Oem":{

      "Public":{

"BootEnable":boot_enable,

          "DefaultWritePolicy": write_policy,

          "DefaultReadPolicy": read_policy,

          "AccessPolicy":access_policy,

          "DriveCache":drive_cache

      }

    }

}

【所属权限模块】

远程控制

【所属系统锁定类型】

硬件配置锁定

【参数说明】

表4-123 修改逻辑盘信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

system_id

系统资源的ID

当前所有机型取值为1

storage_id

存储资源的 ID

由RAID卡列表中查询

logical_id

逻辑盘 ID

由逻辑盘集合中查询

BootEnable

布尔型

是否是启动盘

说明：PMC卡在PBSI通道不支持该字段；

DefaultWritePolicy

默认写策略

支持"WriteThrough", "WriteBack", "AlwaysWriteBack"

说明：PMC卡不支持该字段；

DefaultReadPolicy

默认读策略

支持"NoReadAhead", "ReadAhead"

说明：PMC卡不支持该字段；

AccessPolicy

字符串

访问策略

支持"Read/Write", "ReadOnly", "Blocked"

说明：PMC卡不支持该字段；

DriveCache

字符串

物理盘缓存策略

支持"Unchanged", "Enable", "Disable"

说明：PMC卡不支持该字段；

 

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes/LogicalDrive239

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

  "Oem":{

      "Public":{

"BootEnable":false,

          "DefaultWritePolicy": "WriteThrough",

          "DefaultReadPolicy": "ReadAhead",

          "AccessPolicy":"Blocked",

          "DriveCache":"Disabled"

      }

    }

}

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#Volume.Volume(*)",

    "@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes/LogicalDrive239",

    "@odata.type": "#Volume.v1_5_0.Volume",

    "CapacityBytes": 600127266816,

    "Encrypted": false,

    "Id": "LogicalDrive239",

    "Links": {

        "Drives": [

           {

                "@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront4"

            }

        ],

        "[email protected]": 1

    },

    "Name": "",

    "Oem": {

        "Public": {

            "AccessPolicy": "Blocked",

            "BGIEnable": true,

            "BootEnable": false,

            "CompletionCode": 0,

            "ConsistencyCheck": false,

            "CurrentCachePolicy": "DirectIO",

            "CurrentReadPolicy": "ReadAhead",

            "CurrentWritePolicy": "WriteThrough",

            "DefaultCachePolicy": "DirectIO",

            "DefaultReadPolicy": "ReadAhead",

            "DefaultWritePolicy": "WriteThrough",

            "Description": "Success",

            "DriveCache": "Disabled",

            "FirmwareStatus": "Optimal",

            "NumDrivePerSpan": 1,

            "OptimumIOSizeBytes": 65536,

            "RaidControllerID": 0,

            "ReadPolicy": "ReadAhead",

"RebuildProgress":"2",

            "SSDCachecadeVolume": null,

            "SSDCachingEnable": null,

            "SpanNumber": 1,

            "VolumeRaidLevel": "RAID0",

            "WritePolicy": "WriteThrough"

        }

    },

    "RedundantType": "NonRedundant",

    "Status": {

        "Health": "OK",

        "Oem": {

            "Public": {

                "FaultDescription": "",

                "Severity": "Informational"

            }

        },

        "State": "Enabled"

    }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回体同【查询指定逻辑盘信息】

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

(2)     HDM2-2.06：新增Oem.Public.BootEnable字段；

(3)     HDM3-1.14：新增Oem.Public.BootEnable字段；

 

4.3.24  查询BIOS选项列表

【功能描述】

查询BIOS选项信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id/Bios

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-124 查询BIOS选项列表说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

system_id

系统资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/Bios

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@Redfish.Settings": {

        "@odata.type": "#Settings.v1_1_2.Settings",

        "SettingsObject": {

            "@odata.id": "/redfish/v1/Systems/1/Bios/Settings"

        }

    },

    "@odata.context": "/redfish/v1/$metadata#Systems/Members/1/Bios/$entity",

    "@odata.id": "/redfish/v1/Systems/1/Bios",

    "@odata.type": "#Bios.v1_1_2.Bios",

    "Actions": {

        "#Bios.ChangePassword": {

            "target": "/redfish/v1/Systems/1/Bios/Actions/Bios.ChangePassword"

        },

        "#Bios.ResetBios": {

            "[email protected]": [

                "Reset"

            ],

            "target": "/redfish/v1/Systems/1/Bios/Actions/Bios.ResetBios"

        },

        "#Settings.Revoke": {

            "target": "/redfish/v1/Systems/1/Bios/Settings/Actions/Oem/Public/Settings.Revoke"

        }

    },

    "AttributeRegistry": "BiosAttributeRegistry",

    "Attributes": null,

    "BiosRegistry": {

        "@odata.id": "/redfish/v1/Systems/1/Bios/BiosRegistry"

    },

    "BscBootInfo": null,

    "Description": "BIOS Configuration Current Settings",

    "Id": "Bios",

    "Name": "BIOS Configuration Current Settings",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    }

}

响应码：200

【输出说明】

表4-125 查询BIOS选项列表输出参数说明

字段

类型

字段说明

SettingsObject

配置BIOS属性

@odata.id

字符串

配置BIOS属性的访问路径

@odata.context

字符串

BIOS 资源模型的 OData描述信息

@odata.id

字符串

BIOS 资源的访问路径

@odata.type

字符串

BIOS 资源的类型

AttributeRegistry

字符串

BIOS 属性注册资源 ID

Actions

Redfish 允许的指定 BIOS 资源可执行操作

Bios.ResetBios

对象

恢复 BIOS 项默认配置

[email protected]

数组

恢复BIOS项默认值可选择值

"Reset"

target

字符串

恢复BIOS属性默认值的路径

Bios.ChangePassword

对象

修改BIOS密码

target

字符串

修改BIOS 密码的路径

Settings.Revoke

对象

清除未生效BIOS配置

target

字符串

清除未生效BIOS的路径

Attributes

对象

支持修改的BIOS选项及对应的参数，可参考官网BIOS用户指南：

Intel平台：《H3C服务器 Eagle Stream平台 BIOS用户指南-6.XX》

AMD平台：《H3C服务器 AMD EPYC系列 Genoa处理器 BIOS用户指南-6.XX》

BscBootInfo.CurrentBootMode

字符串

系统当前启动模式

BscBootInfo.CurrentFirstBootDevice

字符串

系统当前第一启动设备

BiosRegistry

对象

BIOS详细配置规则信息访问路径

Description

字符串

BIOS选项列表资源描述信息

Id

字符串

BIOS选项列表资源Id

Name

字符串

BIOS选项列表资源名称

 

4.3.25  查询待生效的BIOS选项信息

【功能描述】

查询待生效的BIOS选项信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id/Bios/Settings

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-126 查询待生效的BIOS选项信息说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

system_id

系统资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/Bios/Settings

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#Systems/Members/1/Bios/Settings/$entity",

    "@odata.id": "/redfish/v1/Systems/1/Bios/Settings",

    "@odata.type": "#Bios.v1_1_2.Bios",

    "AttributeRegistry": "BiosAttributeRegistryP18.5.15",

    "Attributes": {

      ......

    },

    "Description": "BIOS Configuration Pending Settings",

    "Id": "Settings",

    "Name": "BIOS Configuration Pending Settings",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    }

}

响应码：200

【输出说明】

表4-127 查询待生效的BIOS选项信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

BIOS 资源模型的 OData描述信息

@odata.id

字符串

BIOS 资源的访问路径

@odata.type

字符串

BIOS 资源的类型

AttributeRegistry

字符串

BIOS 属性注册资源 ID

Attributes

对象

待生效的BIOS选项信息，可参考官网BIOS用户指南：

Intel平台：《H3C服务器 Eagle Stream平台 BIOS用户指南-6.XX》

AMD平台：《H3C服务器 AMD EPYC系列 Genoa处理器 BIOS用户指南-6.XX》

Description

字符串

待生效的BIOS选项列表资源描述信息

Id

字符串

待生效的BIOS选项列表资源Id

Name

字符串

待生效的BIOS选项列表资源名称

 

4.3.26  设置指定的BIOS选项

【功能描述】

修改指定的BIOS选项。

【所属权限模块】

远程控制

【所属系统锁定类型】

BIOS配置锁定

【命令格式】

PATCH https://device_ip/redfish/v1/Systems/system_id/Bios/Settings

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:ifmatch_value

【请求消息体】

{

  "Attributes": {

"BootOrder1": BootOrder1,

    "BootOrder2": BootOrder2,

    "BootOrder3": BootOrder3,

    "BootOrder4": BootOrder4

  }

}

【参数说明】

表4-128 设置指定BIOS选项参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

system_id

系统资源的ID

当前所有机型取值为1

ifmatch_value

请求消息的匹配参数

可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）

Attributes

指定要设置的BIOS选项

支持修改的BIOS选项及对应的参数，可参考官网BIOS用户指南：

Intel平台：《H3C服务器 Eagle Stream平台 BIOS用户指南-6.XX》

AMD平台：《H3C服务器 AMD EPYC系列 Genoa处理器 BIOS用户指南-6.XX》

说明：关于永久启动项：

1)     4个启动项需要同时下发

2)     下发不同启动项的值要唯一

 

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/Systems/1/Bios/Settings

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:ifmatch_value

【请求消息体】

{

  "Attributes": {

"BootOrder1": "Hard Disk",

    "BootOrder2": "Network",

    "BootOrder3": "CD/DVD",

    "BootOrder4": "Other Device"

  }

}

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#Systems/Members/1/Bios/Settings/$entity",

    "@odata.id": "/redfish/v1/Systems/1/Bios/Settings",

    "@odata.type": "#Bios.v1_1_1.Bios",

    "AttributeRegistry": "BiosAttributeRegistryP18.5.15",

    "Attributes": {

        "BootOrder1": "Hard Disk",

        "BootOrder2": "Network",

        "BootOrder3": "CD/DVD",

        "BootOrder4": "Other Device"

    },

    "Description": "BIOS Configuration Pending Settings",

    "Id": "Settings",

    "Name": "BIOS Configuration Pending Settings",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回字段说明同【查询待生效的BIOS选项信息】

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

 

4.3.27  修改BIOS密码

【功能描述】

修改BIOS密码

注：修改密码后，BIOS需重启1~2次生效，请勿在重启过程中进行服务器操作，以避免出现密码不生效等情况。若启用密码复杂度检测，复杂度由BIOS进行校验。

【所属权限模块】

远程控制

【所属系统锁定类型】

BIOS配置锁定

【命令格式】

POST https://device_ip/redfish/v1/Systems/system_id/Bios/Actions/Bios.ChangePassword

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"UserName":name,

"Password":password

}

【参数说明】

表4-129 设置BIOS密码参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

system_id

系统资源的ID

当前所有机型取值为1

UserName

指定要设置用户名称

支持“Admin”、“User”、“PowerOn”

Password

字符串

BIOS密码设置需符合以下要求：

·     密码长度为8～20个字符，仅支持字母、数字、空格和特殊字符`~!@#$%^&*()_+-=[]\{}|;':",./<>?，区分大小写；

若BIOS下启用了密码复杂度校验，基于上述要求前提下，符合以下要求：

·     至少包含大写字母、小写字母和数字中的两种字符；

·     至少包含一个空格或特殊字符。

·     注意：本接口不做密码复杂度校验，设置后，请重启BIOS后，在BIOS下检查是否生效。

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/Systems/1/Bios/Actions/Bios.ChangePassword

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"UserName":"User",

"Password":"Password@_"

}

【应答示例】

{

"Oem": {

       "Public": {

           "CompletionCode": 0,

           "Description": "Success"

       }

 },

"error": {

       "@Message.ExtendedInfo": [

           {

               "@odata.type": "#Message.v1_1_1.Message",

               "Message": "Successfully Completed Request",

               "MessageArgs": [],

               "MessageId": "Base.1.8.1.Success",

               "MessageSeverity": "OK",

               "Resolution": "None"

           }

       ],

        "code":"Base.1.8.1.Success",

        "message":"Successfully Completed Request"

    }

}

}

响应码：200

【输出说明】

表4-130 修改BIOS密码操作输出参数说明

字段

类型

字段说明

code

字符串

指示消息注册表中特定消息ID的字符串

message

字符串

与消息注册表中的消息对应的易读的错误消息

@Message.ExtendedInfo

消息扩展信息

@odata.type

字符串

消息资源的OData描述信息

MessageId

字符串

消息ID

Message

字符串

详细信息

MessageArgs

数组

信息参数

MessageSeverity

字符串

严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical

Resolution

字符串

解决建议

 

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

(2)     HDM2-1.53：补充BIOS密码的复杂度检测说明；

(3)     HDM2-2.04：Message.ExtendedInfo前添加error节点，并且在error节点下增加code和message字段；

(4)     HDM3-1.14：UserName字段取值增加PowerOn；

 

4.3.28  恢复BIOS属性默认值

【功能描述】

恢复BIOS属性默认值

【所属权限模块】

远程控制

【所属系统锁定类型】

BIOS配置锁定

【命令格式】

POST https://device_ip/redfish/v1/Systems/system_id/Bios/Actions/Bios.ResetBios

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"ResetType": "Reset"

}

【参数说明】

表4-131 恢复BIOS属性默认值参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

system_id

系统资源的ID

当前所有机型取值为1

ResetType

恢复默认值名称

“Reset”

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/Systems/1/Bios/Actions/Bios.ResetBios

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"ResetType": "Reset"

}

【应答示例】

{

"Oem": {

       "Public": {

           "CompletionCode": 0,

           "Description": "Success"

       }

 },

"error": {

       "@Message.ExtendedInfo": [

           {

               "@odata.type": "#Message.v1_1_1.Message",

               "Message": "Successfully Completed Request",

               "MessageArgs": [],

               "MessageId": "Base.1.8.1.Success",

               "MessageSeverity": "OK",

               "Resolution": "None"

           }

       ],

        "code":"Base.1.8.1.Success",

        "message":"Successfully Completed Request"

    }

}

}

响应码：200

【输出说明】

表4-132 恢复BIOS属性默认值输出参数说明

字段

类型

字段说明

code

字符串

指示消息注册表中特定消息ID的字符串

message

字符串

与消息注册表中的消息对应的易读的错误消息

@Message.ExtendedInfo

消息扩展信息

@odata.type

字符串

消息资源的OData描述信息

MessageId

字符串

消息ID

Message

字符串

详细信息

MessageArgs

数组

信息参数

MessageSeverity

字符串

严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical

Resolution

字符串

解决建议

 

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

(2)     HDM2-2.04：Message.ExtendedInfo前添加error节点，并且在error节点下增加code和message字段；

 

4.3.29  查询BIOS详细配置规则信息

【功能描述】

查询BIOS详细配置规则信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id/Bios/BiosRegistry

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-133 查询BIOS详细配置规则信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

system_id

系统资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/Bios/BiosRegistry

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#AttributeRegistry.AttributeRegistry",

    "@odata.id": "/redfish/v1/Systems/1/Bios/BiosRegistry",

    "@odata.type": "#AttributeRegistry.v1_3_6.AttributeRegistry",

    "Description": "This registry defines a representation of BIOS Attribute instances",

    "Id": "BiosAttributeRegistry",

    "Language": "en-US",

"Name": "BIOS Attribute Registry",

"Oem": {

    "Public": {

         "CompletionCode": 0,

         "Description": "Success"

    }

},

    "OwningEntity": "AMI",

    "RegistryEntries": {

        "Attributes": [

            {

                "AttributeName": "SetupMode",

                "DefaultValue": "Graphic",

                "DisplayName": "SetupMode",

                "Type": "Enumeration",

                "Value": [

                    {

                        "ValueDisplayName": "Text",

                        "ValueName": "Text"

                    },

                    {

                        "ValueDisplayName": "Graphic",

                        "ValueName": "Graphic"

                    }

                ]

            }

          ......

        ]

    },

    "RegistryVersion": null

}

响应码：200

【输出说明】

表4-134 查询BIOS详细配置规则信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

BIOS详细配置规则模型的 OData描述信息

@odata.id

字符串

BIOS详细配置规则的访问路径

@odata.type

字符串

BIOS详细配置规则资源的类型

Description

字符串

BIOS详细配置规则资源描述

Id

字符串

BIOS详细配置规则资源的ID

RegistryEntries

对象

BIOS配置规则条目

Attributes

对象

BIOS选项信息，可参考官网BIOS用户指南：

Intel平台：《H3C服务器 Eagle Stream平台 BIOS用户指南-6.XX》

AMD平台：《H3C服务器 AMD EPYC系列 Genoa处理器 BIOS用户指南-6.XX》

AttributeName

字符串

BIOS属性名称

DisplayName

字符串

展示名称

DefaultValue

字符串

默认配置

Value

对象

取值范围

 

4.3.30  创建KVM资源信息

【功能描述】

创建KVM资源信息。

【所属权限模块】

远程控制

【命令格式】

POST https://device_ip/redfish/v1/Systems/system_id/kvm

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-135 创建KVM资源信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

system_id

系统资源的ID

当前所有机型取值为1

 

【使用实例1】

【请求样例】

POST https://192.168.18.18/redfish/v1/Systems/1/kvm

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadataSystems/1",

    "@odata.id": "/redfish/v1/Systems/1/kvm",

    "@odata.type": "#ComputerSystemCollection.ComputerSystemCollection",

    "H5_KVM_Authority": {

        "@odata.id": "/redfish/v1/Systems/1/kvm/saxow7fnqUBgRa1"

    },

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    }

}

响应码：200

【使用实例2】

【示例目的】

使用redfish获取的kvm资源信息进行免密登录

【使用方法】

使用【应答示例1】中获取的H5 KVM资源访问路径，在浏览中登录

https://192.168.18.18/redfish/v1/Systems/1/kvm/GlPxiEitqy7QM0D

即可获取对访问服务器进行H5 KVM的远程控制。

【输出说明】

表4-136 创建KVM资源信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

KVM资源模型的OData 描述信息

@odata.id

字符串

KVM资源的访问路径

@odata.type

字符串

KVM资源的类型

H5_KVM_Authority

对象

KVM免加密资源访问路径

使用说明：

http://+路径中表明是H5 KVM非加密，

https://+路径表明是H5 KVM加密

仅创建H5Kvm会话返回，否则为null

 

4.3.31  查询事件日志服务集合资源信息

【功能描述】

查询事件日志服务集合资源信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id/LogServices

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-137 查询事件日志服务集合资源说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

system_id

系统资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/LogServices

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#Systems/Members/1/LogServices/$entity",

    "@odata.id": "/redfish/v1/Systems/1/LogServices",

    "@odata.type": "#LogServiceCollection.LogServiceCollection",

    "Actions": {

        "Oem": {

            "Public": {

                "#LogServices.ExportEventLog": {

                    "target": "/redfish/v1/Systems/1/LogServices/Actions/Oem/Public/LogServices.ExportEventLog"

                }

            }

        }

    },

    "Description": "Collection of LogServices for this Computer System",

    "Members": [

        {

            "@odata.id": "/redfish/v1/Systems/1/LogServices/Log1"

        }

    ],

    "[email protected]": 1,

    "Name": "System Log Services Collection",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    }

}

响应码：200

【输出说明】

表4-138 查询事件日志服务集合输出参数说明

字段

类型

字段说明

@odata.context

字符串

事件日志服务集合资源模型的 OData描述信息

@odata.id

字符串

事件日志服务集合资源的访问路径

@odata.type

字符串

事件日志服务集合资源的类型

Name

字符串

事件日志服务集合资源的名称

Description

字符串

事件日志服务集合资源描述

[email protected]

数值

当前事件日志服务资源数量

Members

事件日志服务资源列表

Actions

LogServices可执行的操作

Oem.Public. LogServices.ExportEventLog

对象

导出事件日志信息路径

 

4.3.32  查询指定事件日志服务资源信息

【功能描述】

查询指定事件日志服务资源信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id/LogServices/LogService_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-139 查询指定事件日志服务资源信息说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

system_id

系统资源的ID

当前所有机型取值为1

LogService_id

查询事件日志服务集合资源ID

 

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/LogServices/Log1

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#Systems/Members/1/LogServices/Members/$entity",

    "@odata.id": "/redfish/v1/Systems/1/LogServices/Log1",

    "@odata.type": "#LogService.v1_2_0.LogService",

    "Actions": {

        "#LogService.ClearLog": {

            "target": "/redfish/v1/Systems/1/LogServices/Log1/Actions/LogService.ClearLog"

        }

    },

    "DateTime": "2022-02-19T15:30:04+08:00",

    "DateTimeLocalOffset": "UTC+08:00",

    "Description": "System Service Log for this Computer System",

    "Entries": {

        "@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries"

    },

    "Id": "Log1",

    "MaxNumberOfRecords": 1500,

    "Name": "System Service Log",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "OverWritePolicy": "WrapsWhenFull",

    "[email protected]": [

        "WrapsWhenFull",

        "NeverOverWrites"

    ],

    "ServiceEnabled": true

}

响应码：200

【输出说明】

表4-140 查询指定事件日志服务资源输出参数说明

字段

类型

字段说明

@odata.context

字符串

指定事件日志服务资源模型的 OData描述信息

@odata.id

字符串

指定事件日志服务资源的访问路径

@odata.type

字符串

指定事件日志服务资源的类型

Id

字符串

指定事件日志服务资源的ID

Name

字符串

指定事件日志服务资源的名称

Description

字符串

指定事件日志服务资源的描述

MaxNumberOfRecords

数值

指定事件日志服务资源的最大可记录事件日志条数

OverWritePolicy

字符串

指定事件日志服务资源的覆盖策略：

WrapsWhenFull

NeverOverWrites

[email protected]

数组

覆盖策略允许值列表

DateTime

字符串

指定事件日志服务资源的系统时间

DateTimeLocalOffset

字符串

指定事件日志服务资源的时区

ServiceEnabled

布尔

指定事件日志服务资源的启用状态

true

false

Actions.#LogService.ClearLog

对象

清空事件日志操作的访问路径

Entries

对象

事件日志集合资源的访问路径

 

4.3.33  设置指定事件日志服务资源信息

【功能描述】

设置服务器当前事件日志服务资源信息。

【所属权限模块】

常规配置

【所属系统锁定类型】

BMC配置锁定

【命令格式】

PATCH https://device_ip/redfish/v1/Systems/system_id/LogServices/LogService_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{ 

  "OverWritePolicy": "WrapsWhenFull"

}

【参数说明】

表4-141 设置指定事件日志服务资源信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

system_id

系统资源的ID

当前所有机型取值为1

ifmatch_value

请求消息的匹配参数

可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）

LogService_id

查询事件日志服务集合资源ID

 

OverWritePolicy

字符串

指定事件日志服务资源的覆盖策略：

WrapsWhenFull

NeverOverWrites

 

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/Systems/1/LogServices/Log1

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{ 

  "OverWritePolicy": "WrapsWhenFull"

}

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#Systems/Members/1/LogServices/Members/$entity",

    "@odata.id": "/redfish/v1/Systems/1/LogServices/Log1",

    "@odata.type": "#LogService.v1_2_0.LogService",

    "Actions": {

        "#LogService.ClearLog": {

            "target": "/redfish/v1/Systems/1/LogServices/Log1/Actions/LogService.ClearLog"

        }

    },

    "DateTime": "2022-02-19T15:30:04+08:00",

    "DateTimeLocalOffset": "UTC+08:00",

    "Description": "System Service Log for this Computer System",

    "Entries": {

        "@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries"

    },

    "Id": "Log1",

    "MaxNumberOfRecords": 1500,

    "Name": "System Service Log",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "OverWritePolicy": "WrapsWhenFull",

    "[email protected]": [

        "WrapsWhenFull",

        "NeverOverWrites"

    ],

    "ServiceEnabled": true

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回字段说明同【查询指定事件日志服务资源信息】

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

 

4.3.34  查询事件日志集合资源信息

【功能描述】

查询事件日志集合资源信息。

【所属权限模块】

系统审计

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id/LogServices/LogService_id/Entries

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-142 查询事件日志集合资源信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

system_id

系统资源的ID

当前所有机型取值为1

LogService_id

查询事件日志服务集合资源ID

由查询事件日志服务集合资源信息获取

 

【使用实例1】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/LogServices/Log1/Entries

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#Systems/Members/1/LogServices/Log1/Entries/$entity",

    "@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries",

    "@odata.type": "#LogEntryCollection.LogEntryCollection",

    "Description": "Collection of System Event Log Entries",

    "Members": [

        {

            "@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/642"

        },

        …

        {

            "@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/543"

        }

    ],

    "[email protected]": 642,

    "[email protected]": "/redfish/v1/Systems/1/LogServices/Log1/Entries?$skip=100&$top=100",

    "Name": "System Event Log Entries",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    }

}

响应码：200

【使用实例2】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/LogServices/Log1/Entries?$skip=10&$top=10&$expand=*

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#Systems/Members/1/LogServices/Log1/Entries/$entity",

    "@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries",

    "@odata.type": "#LogEntryCollection.LogEntryCollection",

    "Description": "Collection of System Event Log Entries",

    "Members": [

        {

            "@odata.context": "/redfish/v1/$metadata#Systems/Members/1/LogServices/Log1/Entries/Members/$entity",

            "@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/164",

            "@odata.type": "#LogEntry.v1_6_1.LogEntry",

            "Created": "2022-04-11T11:56:27+08:00",

            "Description": "System Event Log",

            "EntryCode": "Asserted",

            "EntryType": "Event",

            "EventTimestamp": "2022-04-11T11:56:27+08:00",

            "Id": "164",

            "Level": "Info",

            "Message": "Transition to Off Line",

            "MessageArgs": [

                1

            ],

            "Name": "Log Entry 164",

            "Oem": {

                "Public": {

                    "EventCode": "0x04400014"

                }

            },

            "SensorName": "FAN7_F_Status",

            "SensorType": "Fan",

            "Severity": "OK"

        },

        {

            "@odata.context": "/redfish/v1/$metadata#Systems/Members/1/LogServices/Log1/Entries/Members/$entity",

            "@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/163",

            "@odata.type": "#LogEntry.v1_6_1.LogEntry",

            "Created": "2022-04-11T11:56:27+08:00",

            "Description": "System Event Log",

            "EntryCode": "Asserted",

            "EntryType": "Event",

            "EventTimestamp": "2022-04-11T11:56:27+08:00",

            "Id": "163",

            "Level": "Info",

            "Message": "Transition to Off Line",

            "MessageArgs": [

                1

            ],

            "Name": "Log Entry 163",

            "Oem": {

                "Public": {

                    "EventCode": "0x04400014"

                }

            },

            "SensorName": "FAN6_F_Status",

            "SensorType": "Fan",

            "Severity": "OK"

        },

        {

            "@odata.context": "/redfish/v1/$metadata#Systems/Members/1/LogServices/Log1/Entries/Members/$entity",

            "@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/162",

            "@odata.type": "#LogEntry.v1_6_1.LogEntry",

            "Created": "2022-04-11T11:56:27+08:00",

            "Description": "System Event Log",

            "EntryCode": "Asserted",

            "EntryType": "Event",

            "EventTimestamp": "2022-04-11T11:56:27+08:00",

            "Id": "162",

            "Level": "Info",

            "Message": "Transition to Off Line",

            "MessageArgs": [

                1

            ],

            "Name": "Log Entry 162",

            "Oem": {

                "Public": {

                    "EventCode": "0x04400014"

                }

            },

            "SensorName": "FAN5_F_Status",

            "SensorType": "Fan",

            "Severity": "OK"

        },

        {

            "@odata.context": "/redfish/v1/$metadata#Systems/Members/1/LogServices/Log1/Entries/Members/$entity",

            "@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/161",

            "@odata.type": "#LogEntry.v1_6_1.LogEntry",

            "Created": "2022-04-11T11:56:27+08:00",

            "Description": "System Event Log",

            "EntryCode": "Asserted",

            "EntryType": "Event",

            "EventTimestamp": "2022-04-11T11:56:27+08:00",

            "Id": "161",

            "Level": "Info",

            "Message": "Transition to Off Line",

            "MessageArgs": [

                1

            ],

            "Name": "Log Entry 161",

            "Oem": {

                "Public": {

                    "EventCode": "0x04400014"

                }

            },

            "SensorName": "FAN4_F_Status",

            "SensorType": "Fan",

            "Severity": "OK"

        },

        {

            "@odata.context": "/redfish/v1/$metadata#Systems/Members/1/LogServices/Log1/Entries/Members/$entity",

            "@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/160",

            "@odata.type": "#LogEntry.v1_6_1.LogEntry",

            "Created": "2022-04-11T11:56:27+08:00",

            "Description": "System Event Log",

            "EntryCode": "Asserted",

            "EntryType": "Event",

            "EventTimestamp": "2022-04-11T11:56:27+08:00",

            "Id": "160",

            "Level": "Info",

            "Message": "Transition to Off Line",

            "MessageArgs": [

                1

            ],

            "Name": "Log Entry 160",

            "Oem": {

                "Public": {

                    "EventCode": "0x04400014"

                }

            },

            "SensorName": "FAN3_F_Status",

            "SensorType": "Fan",

            "Severity": "OK"

        },

        {

            "@odata.context": "/redfish/v1/$metadata#Systems/Members/1/LogServices/Log1/Entries/Members/$entity",

            "@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/159",

            "@odata.type": "#LogEntry.v1_6_1.LogEntry",

            "Created": "2022-04-11T11:56:27+08:00",

            "Description": "System Event Log",

            "EntryCode": "Asserted",

            "EntryType": "Event",

            "EventTimestamp": "2022-04-11T11:56:27+08:00",

            "Id": "159",

            "Level": "Info",

            "Message": "Transition to Off Line",

            "MessageArgs": [

                1

            ],

            "Name": "Log Entry 159",

            "Oem": {

                "Public": {

                    "EventCode": "0x04400014"

                }

            },

            "SensorName": "FAN2_F_Status",

            "SensorType": "Fan",

            "Severity": "OK"

        },

        {

            "@odata.context": "/redfish/v1/$metadata#Systems/Members/1/LogServices/Log1/Entries/Members/$entity",

            "@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/158",

            "@odata.type": "#LogEntry.v1_6_1.LogEntry",

            "Created": "2022-04-11T11:56:27+08:00",

            "Description": "System Event Log",

            "EntryCode": "Asserted",

            "EntryType": "Event",

            "EventTimestamp": "2022-04-11T11:56:27+08:00",

            "Id": "158",

            "Level": "Info",

            "Message": "Transition to Off Line",

            "MessageArgs": [

                1

            ],

            "Name": "Log Entry 158",

            "Oem": {

                "Public": {

                    "EventCode": "0x04400014"

                }

            },

            "SensorName": "FAN1_F_Status",

            "SensorType": "Fan",

            "Severity": "OK"

        },

        {

            "@odata.context": "/redfish/v1/$metadata#Systems/Members/1/LogServices/Log1/Entries/Members/$entity",

            "@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/157",

            "@odata.type": "#LogEntry.v1_6_1.LogEntry",

            "Created": "2022-04-11T11:56:15+08:00",

            "Description": "System Event Log",

            "EntryCode": "Deasserted",

            "EntryType": "Event",

            "EventTimestamp": "2022-04-11T11:56:15+08:00",

            "Id": "157",

            "Level": "Info",

            "Message": "CPU1 triggered an uncorrectable error",

            "MessageArgs": [

                1

            ],

            "Name": "Log Entry 157",

            "Oem": {

                "Public": {

                    "EventCode": "0x07b201df"

                }

            },

            "SensorName": "CPU1_Status",

            "SensorType": "Processor",

            "Severity": "OK"

        },

        {

            "@odata.context": "/redfish/v1/$metadata#Systems/Members/1/LogServices/Log1/Entries/Members/$entity",

            "@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/156",

            "@odata.type": "#LogEntry.v1_6_1.LogEntry",

            "Created": "2022-04-11T11:56:15+08:00",

            "Description": "System Event Log",

            "EntryCode": "Asserted",

            "EntryType": "Event",

            "EventTimestamp": "2022-04-11T11:56:15+08:00",

            "Id": "156",

            "Level": "Info",

            "Message": "LPC Reset occurred",

            "MessageArgs": [

                1

            ],

            "Name": "Log Entry 156",

            "Oem": {

                "Public": {

                    "EventCode": "0x22d000de"

                }

            },

            "SensorName": "ACPI_State",

            "SensorType": "System ACPI Power State",

            "Severity": "OK"

        },

        {

            "@odata.context": "/redfish/v1/$metadata#Systems/Members/1/LogServices/Log1/Entries/Members/$entity",

            "@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/155",

            "@odata.type": "#LogEntry.v1_6_1.LogEntry",

            "Created": "2022-04-11T11:56:10+08:00",

            "Description": "System Event Log",

            "EntryCode": "Asserted",

            "EntryType": "Event",

            "EventTimestamp": "2022-04-11T11:56:10+08:00",

            "Id": "155",

            "Level": "Info",

            "Message": "Initiated by hard reset",

            "MessageArgs": [

                1

            ],

            "Name": "Log Entry 155",

            "Oem": {

                "Public": {

                    "EventCode": "0x1d1000de"

                }

            },

            "SensorName": "BMC_Boot_Up",

            "SensorType": "System Boot / Restart Initiated",

            "Severity": "OK"

        }

    ],

"[email protected]": 174,

"[email protected]": "/redfish/v1/Systems/1/LogServices/Log1/Entries?$skip=20&$top=100",

    "Name": "System Event Log Entries",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    }

}

响应码：200

【输出说明】

表4-143 查询事件日志集合资源信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

事件日志集合资源模型的 OData描述信息

@odata.id

字符串

事件日志集合资源的访问路径

@odata.type

字符串

事件日志集合资源的类型

Name

字符串

事件日志集合资源的名称

Description

字符串

事件日志集合资源的描述

[email protected]

数字

当前事件日志资源数量

[email protected]

字符串

分页的路径

Members

事件日志资源列表

 

4.3.35  查询事件日志资源信息

【功能描述】

查询事件日志资源信息。

【所属权限模块】

系统审计

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id/LogServices/LogService_id/Entries/Entries_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-144 查询事件日志资源信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

system_id

系统资源的ID

当前所有机型取值为1

LogService_id

查询事件日志服务集合资源ID

由查询事件日志服务集合资源信息获取

Entries_id

查询事件日志集合资源ID

由查询事件日志集合资源信息获取

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/LogServices/Log1/Entries/1

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#Systems/Members/1/LogServices/Log1/Entries/Members/$entity",

    "@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/1",

    "@odata.type": "#LogEntry.v1_7_0.LogEntry",

    "Created": "2022-02-19T11:40:55+08:00",

    "Description": "System Event Log",

"EntryCode": "Asserted",

    "EntryType": "Event",

"EventTimestamp": "2022-02-19T11:40:55+08:00",

"EventType": "StatusChange",

    "Id": "1",

    "Level": "Info",

    "Message": "Dropped_below_the_lower_major_threshold",

    "MessageArgs": [

        1

    ],

    "Name": "Log Entry 1",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success",

            "EventCode": "0x02200002"

        }

    },

    "SensorName": "Voltage",

"SensorType": "Voltage",

"Severity": "OK"

}

响应码：200

【输出说明】

表4-145 查询事件日志资源信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

事件日志资源模型的 OData描述信息

@odata.id

字符串

事件日志资源的访问路径

@odata.type

字符串

事件日志资源的类型

Name

字符串

事件日志资源的名称

Description

字符串

事件日志资源描述信息

Severity

字符串

严重性，Redfish支持的严重级别，包括：

OK、 Warning、Critical

Level

字符串

自定义安全级别：

Info

Minor

Major

Critical

Created

字符串

事件日志创建时间

EntryType

字符串

事件日志类型：

Event

SEL

Oem

EventTimestamp

字符串

事件产生时间

EventType

字符串

事件类型：

StatusChange

ResourceUpdated

ResourceAdded

ResourceRemoved

Alert

Message

字符串

事件日志描述信息

Id

字符串

事件ID

EntryCode

字符串

Asserted：触发

Deasserted ：解除

MessageArgs

数组

消息参数

SensorName

字符串

传感器名称

SensorType

字符串

传感器类型

Oem.Public.EventCode

字符串

事件码

 

【修改记录】

(1)     HDM2-2.04：新增EventType字段；

 

4.3.36  导出事件日志信息

【功能描述】

导出事件日志信息。

【所属权限模块】

系统审计

【命令格式】

POST https://device_ip/redfish/v1/Systems/system_id/LogServices/Actions/Oem/Public/LogServices.ExportEventLog

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

//本地导出

{

  "Type":"URI",

  "Content": "/tmp/web/dump.csv"

}

//远程导出

cifs或sftp

{

"Type":"URI",

"Content": "sftp://username:[email protected]/usr/dump.tar.gz"

}

//http、tftp、nfs或https

{

  "Type":"URI",

"Content": "http://ip/filename",

"Oem": {

    "Public": {

        "ScriptName":"1.php"

    }

}

}

【参数说明】

表4-146 导出事件日志信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

system_id

系统资源的ID

当前所有机型取值为1

Type

字符串

URI

Content

导出配置文件路径

见其它说明

Oem.Public.ScriptName

字符串

通过http/https协议导出时，需指定的脚本文件的名称

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/Systems/1/LogServices/Actions/Oem/Public/LogServices.ExportEventLog

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

  "Type":"URI",

  "Content": "/tmp/web/dump.csv"

}

【应答示例】

{

"Oem": {

       "Public": {

           "CompletionCode": 0,

           "Description": "Success"

       }

 },

"error": {

       "@Message.ExtendedInfo": [

           {

               "@odata.type": "#Message.v1_1_1.Message",

               "Message": "Successfully Completed Request",

               "MessageArgs": [],

               "MessageId": "Base.1.8.1.Success",

               "MessageSeverity": "OK",

               "Resolution": "None"

           }

       ],

        "code":"Base.1.8.1.Success",

        "message":"Successfully Completed Request"

    }

}

}

响应码：200

【输出说明】

表4-147 导出事件日志信息输出参数说明

字段

类型

字段说明

code

字符串

指示消息注册表中特定消息ID的字符串

message

字符串

与消息注册表中的消息对应的易读的错误消息

@Message.ExtendedInfo

消息扩展信息

@odata.type

字符串

消息资源的OData描述信息

MessageId

字符串

消息ID

Message

字符串

详细信息

MessageArgs

数组

信息参数

MessageSeverity

字符串

严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical

Resolution

字符串

解决建议

 

【修改记录】

(1)     HDM2-2.04：Message.ExtendedInfo前添加error节点，并且在error节点下增加code和message字段；

 

4.3.37  清空事件日志信息

【功能描述】

清空事件日志信息。

【所属权限模块】

维护诊断

【命令格式】

POST https://device_ip/redfish/v1/Systems/system_id/LogServices/LogService_id/Actions/LogService.ClearLog

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

}

【参数说明】

表4-148 清空事件日志参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

system_id

系统资源的ID

当前所有机型取值为1

LogService_id

数值

查询事件日志服务集合资源ID

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/Systems/1/LogServices/Log1/Actions/LogService.ClearLog【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{}

【应答示例】

{

"Oem": {

       "Public": {

           "CompletionCode": 0,

           "Description": "Success"

       }

 },

"error": {

       "@Message.ExtendedInfo": [

           {

               "@odata.type": "#Message.v1_1_1.Message",

               "Message": "Successfully Completed Request",

               "MessageArgs": [],

               "MessageId": "Base.1.8.1.Success",

               "MessageSeverity": "OK",

               "Resolution": "None"

           }

       ],

        "code":"Base.1.8.1.Success",

        "message":"Successfully Completed Request"

    }

}

}

响应码：200

【输出说明】

表4-149 清空事件日志信息输出参数说明

字段

类型

字段说明

code

字符串

指示消息注册表中特定消息ID的字符串

message

字符串

与消息注册表中的消息对应的易读的错误消息

@Message.ExtendedInfo

消息扩展信息

@odata.type

字符串

消息资源的OData描述信息

MessageId

字符串

消息ID

Message

字符串

详细信息

MessageArgs

数组

信息参数

MessageSeverity

字符串

严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical

Resolution

字符串

解决建议

 

【修改记录】

(1)     HDM2-2.04：Message.ExtendedInfo前添加error节点，并且在error节点下增加code和message字段；

 

4.3.38  查询GPU信息

【功能描述】

查询GPU信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id/GPU

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-150 查询GPU信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

system_id

系统资源的ID

当前所有机型取值为1

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

 

【使用实例】

【请求样例】

GET http://172.16.13.176/redfish/v1/Systems/1/GPU

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata",

"@odata.id": "/redfish/v1/Systems/1/GPU",

"@odata.type": "#GPU.v1_0_0.GPU",

    "Description": "Get GPU info for this system",

    "GPUMaxNum":4,

    "Healthstate":{

      "OverallHealth":"OK"

    },

    "GPU": [

        {

            "FirmwareVersion": "88.00.1A.00.03",

            "ID": "0x1",

            "Manufacture": "NVIDIA",

            "Model": "Tesla V100-PCIE-16GB",

            "Name": "Tesla V100-PCIE-16GB",

"Oem": {

                "Public": {

                    "DriverVersion": "N/A",

                    "ECCEnable": 1,

                    "GCUVoltage": 0.75,

                    "GPUDeviceError": 16384,

                    "GPUMemoryError": 16384,

                    "HBMVoltage": 1.25,

                    "PCIeBusError": 16384,

                    "ProductDate": "20240517"

                }

            },

            "PartNumber": "1DB4-893-A1",

            "PowerConsumedWatts": 0,

            "SerialNumber": "0323617020478",

            "SlotNum": 2,

            "Status": {

                "Health": "OK",

                "State": "Enable",

                "Oem": {

                  "Public": {

                      "FaultDescription": "",

                      "Severity": "Informational"

                  }

                }

            },

            "TemperatureCelsius": 50

        }

    ],

"[email protected]": 1,

"Oem":{

      "Public":{

          "PowerControl": [

              {

                  "PowerLimit": {

                      "CorrectionInMs": 30000,

                      "LimitException": "NoAction",

                      "LimitInWatts": 2000

                  },           

                  "PowerMetrics": {

                      "MaxConsumedWatts": 10000,

                      "MinConsumedWatts": 1000

                  }

              }

          ],

          "CompletionCode":0,

          "Description":"Success"

      }

  }

}

响应码：200

【输出说明】

表4-151 查询GPU信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

指定GPU资源模型的OData 描述信息

@odata.id

字符串

指定GPU资源的访问路径

@odata.type

字符串

指定GPU资源的类型

Description

字符串

接口功能描述

GPUMaxNum

数值

最大数量

Healthstate.OverallHealth

字符串

总体健康状态

GPU.FirmwareVersion

字符串

固件版本

GPU.ID

字符串

GPU编号

GPU.Manufacture

字符串

厂商名称

GPU.Model

字符串

产品型号

GPU.Name

字符串

产品名称

GPU.Oem.Public.DriverVersion

字符串

驱动版本号（仅燧原S60GPU支持）

GPU.Oem.Public.ECCEnable

字符串

ECC使能状态（仅燧原S60GPU支持）

GPU.Oem.Public.GCUVoltage

数值

GCU电压（仅燧原S60GPU支持），单位：V

GPU.Oem.Public.HBMVoltage

数值

HBM电压（仅燧原S60GPU支持），单位：V

GPU.Oem.Public.GPUDeviceError

数值

GPU外设错误（仅燧原S60GPU支持）

注：

0： 表示健康

16384： 表示加速卡外设发生 recoverable error

32768： 表示加速卡外设发生 Non-recoverable error

GPU.Oem.Public.PCIeBusError

数值

PCIe错误（仅燧原S60GPU支持）

注：

0：表示健康

16384：表示加速卡PCIe 总线发生 recoverable error

32768：表示加速卡PCIe 总线发生 Non-recoverable error

GPU.Oem.Public.GPUMemoryError

数值

GPU内存错误（仅燧原S60GPU支持）

注：

0：表示健康

16384：表示加速卡显存发生 recoverable error

32768：表示加速卡显存发生 Non-recoverable error

GPU.Oem.Public.ProductDate

字符串

产品生产日期（仅燧原S60GPU支持）

GPU.PartNumber

字符串

部件号

GPU.PowerConsumedWatts

数值

功率；当功率为0时需要在OS下安装驱动

GPU.SerialNumber

字符串

序列号

GPU.SlotNum

数值

槽位号

GPU.Status.Health

字符串

健康状态

GPU.Status.State

字符串

在位状态

GPU.Status.Oem.Public.Severity

字符串

自定义健康状态

GPU.Status.Oem.Public.FaultDescription

字符串

故障描述信息

GPU.TemperatureCelsius

数值

温度，单位摄氏度

[email protected]

数值

GPU数量

PowerControl.PowerLimit.CorrectionInMs

数值

GPU节点功率封顶调整的时间，时间ms

PowerControl.PowerLimit.LimitException

字符串

GPU节点功率封顶失效动作：

"NoAction"：无操作

"HardPowerOff "：关机（G6不支持）

PowerControl.PowerLimit.LimitInWatts

数值

GPU节点功率封顶值，null 的表明是关闭功率封顶

PowerControl.PowerLimit.PowerLimitEnable

布尔型

GPU节点功率封顶使能

PowerControl.PowerMetrics.MaxConsumedWatts

数值

GPU节点功率封顶的最大值

PowerControl.PowerMetrics.MinConsumedWatts

数值

GPU节点功率封顶的最小值

说明：GPU节点功率封顶仅G6 5500 AMD/Intel机型支持

 

【修改记录】

(1)     HDM2-1.58：PowerControl.PowerLimit.LimitException字段针对G6不支持HardPowerOff取值；

(2)     HDM2-2.10：新增字段GPU.Oem.Public.DriverVersion、GPU.Oem.Public.ECCEnable、GPU.Oem.Public.GCUVoltage、GPU.Oem.Public.HBMVoltage、GPU.Oem.Public.GPUDeviceError、GPU.Oem.Public.PCIeBusError、GPU.Oem.Public.GPUMemoryError、GPU.Oem.Public.ProductDate；

 

4.3.39  设置GPU信息

【功能描述】

设置GPU节点功率封顶。

说明：GPU节点功率封顶仅G6 5500 AMD/Intel机型支持；

【所属权限模块】

远程控制

【所属系统锁定类型】

BMC配置锁定

【命令格式】

PATCH https://device_ip/redfish/v1/Systems/system_id/GPU

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

  "Oem":{

      "Public":{

          "PowerControl":[

              {

                  "PowerLimit":{

                      "LimitInWatts":limit_watts,

                      "LimitException":"limit_exception

                  }

              }

          ]      

      }     

  }

}

【参数说明】

表4-152 设置GPU信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

system_id

系统资源的ID

当前所有机型取值为1

PowerControl.PowerLimit.LimitException

字符串

功率封顶失效动作：

"NoAction"：无操作

"HardPowerOff "：关机（G6不支持）

PowerControl.PowerLimit.LimitInWatts

数值

功率封顶值, 范围1000~10000W；

设置1000~10000W会直接开启功率封顶；null 的表明是 关闭功率封顶，且封顶值和失效动作维持上一次状态

 

【使用实例】

【请求样例】

PATCH http://172.16.13.176/redfish/v1/Systems/1/GPU

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

//开启并设置GPU功率封顶参数

{

  "Oem":{

      "Public":{

          "PowerControl":[

              {

                  "PowerLimit":{

                      "LimitInWatts":2000,

                      "LimitException":"NoAction"

                  }

              }

          ]      

      }     

  }

}

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata",

"@odata.id": "/redfish/v1/Systems/1/GPU",

"@odata.type": "#GPU.v1_0_0.GPU",

    "Description": "Get GPU info for this system",

    "GPUMaxNum":4,

    "Healthstate":{

      "OverallHealth":"OK"

    },

    "GPU": [

        {

            "FirmwareVersion": "88.00.1A.00.03",

            "ID": "0x1",

            "Manufacture": "NVIDIA",

            "Model": "Tesla V100-PCIE-16GB",

            "Name": "Tesla V100-PCIE-16GB",

            "PartNumber": "1DB4-893-A1",

            "PowerConsumedWatts": 0,

            "SerialNumber": "0323617020478",

            "SlotNum": 2,

            "Status": {

                "Health": "OK",

                "State": "Enable",

                "Oem": {

                  "Public": {

                      "FaultDescription": "",

                      "Severity": "Informational"

                  }

                }

            },

            "TemperatureCelsius": 50

        }

    ],

"[email protected]": 1,

"Oem":{

      "Public":{

          "PowerControl": [

              {

                  "PowerLimit": {

                      "CorrectionInMs": 30000,

                      "LimitException": "NoAction",

                      "LimitInWatts": 2000,

                      "PowerLimitEnable": true

                  },           

                  "PowerMetrics": {

                      "MaxConsumedWatts": 10000,

                      "MinConsumedWatts": 1000

                  }

              }

          ],

          "CompletionCode":0,

          "Description":"Success"

      }

  }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回参数说明同【查询GPU信息】

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

(2)     HDM2-1.58：PowerControl.PowerLimit.LimitException字段针对G6不支持HardPowerOff取值；

 

4.3.40  查询安全控制面板信息

【功能描述】

查询安全控制面板信息。X18000产品不支持该接口。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id/Oem/Public/SecurityBezel

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-153 查询安全控制面板信息说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

system_id

系统资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/Oem/Public/SecurityBezel

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#SecurityBezel/$entity",

    "@odata.id": "/redfish/v1/Systems/1/Oem/Public/SecurityBezel",

    "@odata.type": "#SecurityBezel.v1_0_0.SecurityBezel",

    "Description": "Security Bezel Control",

    "Id": "SecurityBezel",

    "Name": "SecurityBezel",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "SecurityBezelEnabled": true,

    "SecurityBezelSettings": {

        "DecorativeLEDMode": {

            "RelatedOemMode": {

                "Color": "White",

                "LEDFlashingMode": "Breathing"

            },

            "RelatedStatusMode": null

        },

        "DecorativeLEDType": "Bright",

        "LogoLEDEnabled": true

    }

}

响应码：200

【输出说明】

表4-154 查询安全控制面板信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

控制面板资源模型的OData 描述信息

@odata.id

字符串

控制面板资源的访问路径

@odata.type

字符串

控制面板资源的类型

Description

字符串

控制面板资源的描述

Id

字符串

控制面板资源的ID

Name

字符串

控制面板资源的名称

SecurityBezelEnabled

布尔

安全面板使能

SecurityBezelSettings

对象

面板设置

SecurityBezelSettings.DecorativeLEDType

字符串

Bright：明亮

Soft：柔和

Off：关闭

SecurityBezelSettings.LogoLEDEnabled

布尔

Logo灯使能状态 

SecurityBezelSettings.DecorativeLEDMode

对象

氛围灯模式

SecurityBezelSettings.DecorativeLEDMode.RelatedStatusMode

对象

氛围灯状态关联模式

SecurityBezelSettings.DecorativeLEDMode.RelatedStatusMode.RelatedHealthEnabled

布尔

健康状态关联使能状态

true:状态关联，false:自定义

SecurityBezelSettings.DecorativeLEDMode.RelatedOemMode

对象

氛围灯自定义模式

SecurityBezelSettings.DecorativeLEDMode.RelatedOemMode. LEDFlashingMode

字符串

氛围灯自定义效果 

Breathing：呼吸

Flow：流动

Steady On：常亮

SecurityBezelSettings.DecorativeLEDMode.RelatedOemMode.Color

字符串

自定义灯光颜色

White：白色

Amber：橙色

Red：红色

 

4.3.41  设置安全控制面板信息

【功能描述】

设置安全控制面板信息。X18000产品不支持该接口。

【所属权限模块】

常规配置

【所属系统锁定类型】

BMC配置锁定

【命令格式】

PATCH https://device_ip/redfish/v1/Systems/system_id/Oem/Public/SecurityBezel

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:ifmatch_value

【请求消息体】

{

    "SecurityBezelSettings": {

        "DecorativeLEDMode": {

            "RelatedOemMode": {

                "Color": "White",

                "LEDFlashingMode": "Breathing"

            },

            "RelatedStatusMode": null

        },

        "DecorativeLEDType": "Bright",

        "LogoLEDEnabled": true

    }

}

【参数说明】

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

system_id

系统资源的ID

当前所有机型取值为1

SecurityBezelSettings

对象

面板设置

SecurityBezelSettings.DecorativeLEDType

字符串

Bright：明亮

Soft：柔和

Off：关闭

SecurityBezelSettings.LogoLEDEnabled

布尔

Logo灯使能状态

SecurityBezelSettings.DecorativeLEDMode

对象

氛围灯模式

SecurityBezelSettings.DecorativeLEDMode.RelatedStatusMode

对象

氛围灯状态关联模式

SecurityBezelSettings. DecorativeLEDMode. RelatedStatusMode. RelatedHealthEnabled

布尔

健康状态关联使能状态

SecurityBezelSettings.DecorativeLEDMode.RelatedOemMode

对象

氛围灯自定义模式

SecurityBezelSettings.DecorativeLEDMode.RelatedOemMode.LEDFlashingMode

字符串

氛围灯效果

Breathing：呼吸

Flow：流动

Steady On：常亮

SecurityBezelSettings.DecorativeLEDMode.RelatedOemMode.Color

字符串

灯光颜色

White：白色

Amber：橙色

Red：红色

 

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/Systems/1/Oem/Public/SecurityBezel

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:ifmatch_value

【请求消息体】

{

    "SecurityBezelSettings": {

        "DecorativeLEDMode": {

            "RelatedOemMode": {

                "Color": "White",

                "LEDFlashingMode": "Breathing"

            }

        },

        "DecorativeLEDType": "Bright",

        "LogoLEDEnabled": true

}

}

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#SecurityBezel/$entity",

    "@odata.id": "/redfish/v1/Systems/1/Oem/Public/SecurityBezel",

    "@odata.type": "#SecurityBezel.v1_0_0.SecurityBezel",

    "Description": "Security Bezel Control",

    "Id": "SecurityBezel",

    "Name": "SecurityBezel",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "SecurityBezelEnabled": true,

    "SecurityBezelSettings": {

        "DecorativeLEDMode": {

            "RelatedOemMode": {

                "Color": "White",

                "LEDFlashingMode": "Breathing"

            },

            "RelatedStatusMode": null

        },

        "DecorativeLEDType": "Bright",

        "LogoLEDEnabled": true

    }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回参数说明同【查询安全控制面板信息】

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

 

4.3.42  网络接口集合资源信息查询

【功能描述】

网络接口集合资源信息查询。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id/NetworkInterfaces

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求体】

无

【参数说明】

表4-155 网络接口集合资源信息查询参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

system_id

系统资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/NetworkInterfaces

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#Systems/Members/1/NetworkInterfaces/$entity",

    "@odata.id": "/redfish/v1/Systems/1/NetworkInterfaces",

    "@odata.type": "#NetworkInterfaceCollection.NetworkInterfaceCollection",

    "Members": [

        {

            "@odata.id": "/redfish/v1/Systems/1/NetworkInterfaces/PCIeSlot3"

        }

    ],

    "[email protected]": 1,

    "Name": "Network Interface Collection",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    }

}

响应码：200

【输出说明】

表4-156 网络接口集合资源信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

网络接口资源模型的OData 描述信息

@odata.id

字符串

网络接口资源的访问路径

@odata.type

字符串

网络接口资源的类型

Name

字符串

网络接口资源名称

[email protected]

数值

网络接口资源数量

Members

网络接口资源列表

 

4.3.43  指定网络接口资源信息查询

【功能描述】

指定网络接口资源信息查询。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id/NetworkInterfaces/networkinterfaces_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求体】

无

【参数说明】

表4-157 指定网络接口资源信息查询参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

system_id

系统资源的ID

当前所有机型取值为1

networkinterfaces_id

网络接口资源的 ID

由网络接口集合资源信息查询

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/NetworkInterfaces/PCIeSlot3

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#Systems/Members/1/NetworkInterfaces/Members/$entity",

    "@odata.id": "/redfish/v1/Systems/1/NetworkInterfaces/PCIeSlot3",

    "@odata.type": "#NetworkInterface.v1_2_1.NetworkInterface",

    "Id": "PCIeSlot3",

    "Links": {

        "NetworkAdapter": {

            "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot3"

        }

    },

    "Name": "PCIeSlot3",

    "NetworkPorts": {

        "@odata.id": "/redfish/v1/Systems/1/NetworkInterfaces/PCIeSlot3/NetworkPorts"

    },

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    }

}

响应码：200

【输出说明】

表4-158 指定网络接口资源信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

指定网络接口资源模型的OData 描述信息

@odata.id

字符串

指定网络接口资源的访问路径

@odata.type

字符串

指定网络接口资源的类型

Id

字符串

指定网络接口资源的ID

Name

字符串

指定网络接口资源的名称

Links.NetworkAdapter

对象

网络适配器资源节点的访问路径

NetworkPorts

对象

网络端口资源节点的访问路径

 

4.3.44  查询网口集合信息

【功能描述】

查询网口集合信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id/NetworkInterfaces/networkinterfaces_id/NetworkPorts

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求体】

无

【参数说明】

表4-159 网络接口集合资源信息查询参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

system_id

系统资源的ID

当前所有机型取值为1

networkinterfaces_id

网络接口资源的 ID

由网络接口集合资源信息查询

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/NetworkInterfaces/PCIeSlot3/NetworkPorts

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#Systems/Members/1/NetworkInterfaces/Members/mainboardNIC1/NetworkPorts/$entity",

    "@odata.id": "/redfish/v1/Systems/1/NetworkInterfaces/PCIeSlot3/NetworkPorts",

    "@odata.type": "#NetworkPortCollection.NetworkPortCollection",

    "Members": [

        {

            "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot3/NetworkPorts/1"

        },

        {

            "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot3/NetworkPorts/2"

        }

    ],

    "[email protected]": 2,

    "Name": "Network Port Collection",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    }

}

响应码：200

【输出说明】

表4-160 查询网口集合信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

指定系统资源模型的OData 描述信息

@odata.id

字符串

指定系统资源的访问路径

@odata.type

字符串

指定系统资源的类型

[email protected]

数值

当前系统资源的的数量

Name

字符串

指定系统资源的名称

Members

网络端口资源列表

@odata.id

字符串

单个网络端口资源节点的访问路径

 

4.3.45  清除配置

【功能描述】

清除BMC、BIOS和存储配置。

【所属权限模块】

用户配置

【所属系统锁定类型】

硬件配置锁定（清除存储配置时）|BIOS配置锁定（清除BIOS配置时）|BMC配置锁定（清除BMC配置时）

【命令格式】

POST https://device_ip/redfish/v1/Systems/system_id/Actions/Oem/Public/Systems.ClearConfiguration

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

  "SecureErase":[                      

      "erase_option1",

      "erase_option2",

      "erase_option3"

]

}

【参数说明】

表4-161 清除配置参数说明

字段

类型

字段说明

IP

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

system_id

系统资源的ID

当前所有机型取值为1

SecureErase

数组

可选填

BIOS

Storage

BMC

注：X18000不支持”Storage”字段

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/Systems/1/Actions/Oem/Public/Systems.ClearConfiguration

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

  "SecureErase":[                      

      "BIOS",

      "Storage",

      "BMC"

]

}

【应答示例】

{

"Oem": {

       "Public": {

           "CompletionCode": 0,

           "Description": "Success"

       }

 },

"error": {

       "@Message.ExtendedInfo": [

           {

               "@odata.type": "#Message.v1_1_1.Message",

               "Message": "Successfully Completed Request",

               "MessageArgs": [],

               "MessageId": "Base.1.8.1.Success",

               "MessageSeverity": "OK",

               "Resolution": "None"

           }

       ],

        "code":"Base.1.8.1.Success",

        "message":"Successfully Completed Request"

    }

}

}

响应码：200

【输出说明】

表4-162 清除配置操作输出参数说明

字段

类型

字段说明

code

字符串

指示消息注册表中特定消息ID的字符串

message

字符串

与消息注册表中的消息对应的易读的错误消息

@Message.ExtendedInfo

消息扩展信息

@odata.type

字符串

消息资源的OData描述信息

MessageId

字符串

消息ID

Message

字符串

详细信息

MessageArgs

数组

信息参数

MessageSeverity

字符串

严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical

Resolution

字符串

解决建议

 

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

(2)     HDM2-2.04：Message.ExtendedInfo前添加error节点，并且在error节点下增加code和message字段；

 

4.3.46  下载清除配置报告

【功能描述】

下载清除配置的报告。

【所属权限模块】

用户配置

【命令格式】

POST https://device_ip/redfish/v1/Systems/system_id/Actions/Oem/Public/Systems.ExportReport

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{}

【参数说明】

表4-163 下载清除配置报告参数说明

参数

参数说明

取值

IP

登录设备的IP地址

IPv4或IPv6

system_id

系统资源的ID

当前所有机型取值为1

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/Systems/1/Actions/Oem/Public/Systems.ExportReport

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{}

【应答示例】

{

"@odata.context": "/redfish/v1/$Systems.ClearExportReport",

    "@odata.type": "#Systems.ClearExportReport",

      "@odata.id": "/redfish/v1/Systems/1/Actions/Oem/Public/Systems.ExportReport",

    "Description": "ClearConfigurationDownload",

      "FileName":"/mnt/sdmmc0p4/secure_erase_result.csv"

}

响应码：200

【输出说明】

表4-164 下载清除配置报告输出参数说明

字段

类型

字段说明

@odata.context

字符串

服务器可升级固件集合资源模型的OData描述信息

@odata.id

字符串

服务器可升级固件集合资源节点的访问路径

@odata.type

字符串

服务器可升级固件集合资源类型

FileName

字符串

导出的文件路径和名字

Description

字符串

服务器可升级固件集合资源描述

 

4.3.47  查询配置清除进度

【功能描述】

查询配置清除的详细进度。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id/Oem/Public/ClearConfigurationProgress

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-165 查询配置清除进度参数说明

参数

参数说明

取值

IP

登录设备的IP地址

IPv4或IPv6

system_id

系统资源的ID

当前所有机型取值为1

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/Oem/Public/ClearConfigurationProgress

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

  "@odata.context": "/redfish/v1/$metadata#ClearConfigurationProgress.ClearConfigurationProgress",

  "@odata.id": "/redfish/v1/Systems/1/Oem/Public/ClearConfigurationProgress",

  "@odata.type": "#ClearConfigurationProgress.v1_0_0.ClearConfigurationProgress",

  "TotalProgress": 60,

"ClearStatus": "Waiting",

  "Storage":

   {

      "SD":{

          "Progress": 100,

          "Message": ""

      },

      "NVDIMM":{

          "Progress": 100,

          "Message": ""

      },

      "StorageController":[

          {

              "Model":"RSTe&VROC",

              "Slot":null,

              "Mode":null,

              "Drives":[

                  {

                      "DriveType": "SATA",     

                      "MediaType": "HDD",     

                      "Progress": 99,     

                      "Position": "[11:0:0:0]",

                      "Message": ""             

                  },

                  {   

                      "DriveType": "SATA",

                      "MediaType": "HDD",

                      "Progress": 100,

                      "Position": "[12:0:0:0]",

                      "Message": ""

                  }

              ]

          },

          {

              "Model": "P460-M2",   

              "Slot": "1",

              "Mode": "RAID",

              "Drives": [

                  {

                      "DriveType": "NVME", 

                      "MediaType": "SSD",

                      "Position": "Controller:1, Channel:1, Device:1",

                      "Progress": 10,

                      "Message": ""

                  }

              ]

          }

      ]

   },

   "BIOS":

   {

      "Progress": 10,

      "Message": ""

   }

}

响应码：200

【输出说明】

表4-166 查询清除配置进度输出参数说明

字段

类型

字段说明

@odata.context

字符串

服务器可升级固件集合资源模型的OData描述信息

@odata.id

字符串

服务器可升级固件集合资源节点的访问路径

@odata.type

字符串

服务器可升级固件集合资源类型

TotalProgress

数字

总体进度

ClearStatus

字符串

状态类型

Idle:空闲中

Waiting:等待中

In Progress:擦除中

Storage.SD.Progress

数字

存储SD卡的清除进度

Storage.SD.Message

字符串

报错信息，清除成功为空

Storage.NVDIMM.Progress

数字

存储NVDIMM的清除进度

Storage.NVDIMM.Message

字符串

存储NVDIMM的报错信息，清除成功为空

Storage.StorageController

数组

Storage.StorageController.Model

字符串

卡的型号

Storage.StorageController.Slot

数字

Slot号

Storage.StorageController.Mode

字符串

模式

Storage.StorageController.Drives

数组

Storage.StorageController.Drives.DriveType

字符串

接口类型

Storage.StorageController.Drives.MediaType

字符串

介质类型
SSD
HDD

Storage.StorageController.Drives.Progress

数字

进度0-100

Storage.StorageController.Drives.Position

字符串

位置信息

Storage.StorageController.Drives.Message

字符串

报错信息，清除成功为空

BIOS.Progress

数字

进度0-100

BIOS.Message

字符串

报错信息，清除成功为空

 

4.3.48  查询系统软件清单信息 

【功能描述】

查询系统软件清单信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id/Oem/Public/SoftwareList

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-167 查询系统软件清单信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

system_id

系统资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/Oem/Public/SoftwareList

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#SoftwareList/$entity",

    "@odata.id": "/redfish/v1/Systems/1/Oem/Public/SoftwareList",

"@odata.type": "#SoftwareList.v1_0_0.SoftwareList",

"AgentState": "Enabled",

    "Description": "Get software list",

    "Id": "SoftwareList",

    "Name": "SoftwareList",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "SoftwareInfoList": {

        "Details": [

            {

                "Index": 0,

                "Locations": "/usr/local/sbin",

                "Name": "Test1",

                "UpdateTimes": "2021-02-14T18:15:25+08:00",

                "Version": "5.7.24"

            },

            ……

        ],

        "TotalNumber": 5

    },

    "SystemType": "Windows",

    "SystemVersion": "CentOS release 6.9 (Final)",

    "Version": "V001"

}

响应码：200

【输出说明】

表4-168 查询系统软件清单信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

系统软件清单资源模型的OData 描述信息

@odata.id

字符串

系统软件清单资源的访问路径

@odata.type

字符串

系统软件清单资源的类型

Id

字符串

系统软件清单资源ID

Name

字符串

系统软件清单资源名称

Description

字符串

系统软件清单资源描述

SoftwareInfoList

对象

系统软件清单详细信息

SoftwareInfoList.Details

数组

软件详细信息

SoftwareInfoList.Details.Index

数字

软件索引

SoftwareInfoList.Details.Locations

字符串

位置

SoftwareInfoList.Details.Name

字符串

名称

SoftwareInfoList.Details.UpdateTimes

字符串

更新时间

SoftwareInfoList.Details.Version

字符串

软件版本信息

SoftwareInfoList.TotalNumber

数字

软件数量

SystemType

字符串

系统类型

SystemVersion

字符串

系统版本

Version

字符串

版本信息

AgentState

布尔

FIST SMS是否在位

Enabled :在位

Absent:不在位

 

4.3.49  清除未生效的BIOS配置

【功能描述】

清除未生效的BIOS配置属性。

【所属权限模块】

远程控制

【所属系统锁定类型】

BIOS配置锁定

【命令格式】

POST https://device_ip/redfish/v1/Systems/system_id/Bios/Settings/Actions/Oem/Public/Settings.Revoke

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

}

【参数说明】

表4-169 清除未生效的 BIOS 配置属性参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

system_id

系统资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/Systems/1/Bios/Settings/Actions/Oem/Public/Settings.Revoke

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

}

【应答示例】

{

"Oem": {

       "Public": {

           "CompletionCode": 0,

           "Description": "Success"

       }

 },

"error": {

       "@Message.ExtendedInfo": [

           {

               "@odata.type": "#Message.v1_1_1.Message",

               "Message": "Successfully Completed Request",

               "MessageArgs": [],

               "MessageId": "Base.1.8.1.Success",

               "MessageSeverity": "OK",

               "Resolution": "None"

           }

       ],

        "code":"Base.1.8.1.Success",

        "message":"Successfully Completed Request"

    }

}

}

响应码：200

【输出说明】

表4-170 清除未生效的 BIOS 配置输出参数说明

字段

类型

字段说明

code

字符串

指示消息注册表中特定消息ID的字符串

message

字符串

与消息注册表中的消息对应的易读的错误消息

@Message.ExtendedInfo

消息扩展信息

@odata.type

字符串

消息资源的OData描述信息

MessageId

字符串

消息ID

Message

字符串

详细信息

MessageArgs

数组

信息参数

MessageSeverity

字符串

严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical

Resolution

字符串

解决建议

 

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

(2)     HDM2-2.04：Message.ExtendedInfo前添加error节点，并且在error节点下增加code和message字段；

 

4.3.50  查询主机状态迁移信息

【功能描述】

查询主机状态迁移信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id/Oem/Public/HostStatus

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-171 查询主机状态迁移信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

system_id

系统资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/Oem/Public/HostStatus

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#HostStatus.HostStatus",

    "@odata.id": "/redfish/v1/Systems/1/Oem/Public/HostStatus",

    "@odata.type": "#HostStatus.v1_0_0.HostStatus",

    "AgentState": "Absent",

    "CurrentStartupRecords": {

        "BIOSStage": {

            "BiosVersion": "",

            "ComponentIsolated": false,

            "CurrentStageDurationSeconds": 0,

            "DurationSeconds": 0,

            "EndTime": "",

            "ErrorCount": 0,

            "FaultList": [],

            "MEFirmwareVersion": "",

            "POSTCode": "0x0000",

            "POSTCodeDescription": "",

            "StartTime": "",

            "VersionChanged": false

        },

        "CurrentStage": "PowerDown",

        "OSStage": {

            "ErrorCount": 0,

            "FaultList": [],

            "ReadyTime": "",

            "StartTime": "",

            "UCECount": 0

        },

        "PowerDownStage": {

            "PowerDownCause": "",

            "StartTime": ""

        },

        "PowerUpStage": {

            "DurationSeconds": 0,

            "PowerUpCause": "",

            "StartTime": ""

        }

    },

    "DSDCardState": "Enabled",

    "HostSummary": {

        "DurationSeconds": 0,

        "RunningState": "PowerOff"

    },

    "Id": "HostStatus",

    "LastStartupRecords": {

        "BIOSStage": {

            "BiosVersion": "",

            "ComponentIsolated": false,

            "CurrentStageDurationSeconds": 0,

            "DurationSeconds": 0,

            "EndTime": "",

            "ErrorCount": 0,

            "FaultList": [],

            "MEFirmwareVersion": "",

            "POSTCode": "0x0000",

            "POSTCodeDescription": "",

            "StartTime": "",

            "VersionChanged": false

        },

        "CurrentStage": "PowerUp",

        "OSStage": {

            "ErrorCount": 0,

            "FaultList": [],

            "ReadyTime": "",

            "StartTime": "",

            "UCECount": 0

        },

        "PowerDownStage": {

            "PowerDownCause": "",

            "StartTime": ""

        },

        "PowerUpStage": {

            "DurationSeconds": 0,

            "PowerUpCause": "",

            "StartTime": ""

        }

    },

    "Name": "Host Status",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "SystemVersion": "Not detected",

    "TPMState": "Absent",

    "TPMType": null

}

响应码：200

【输出说明】

表4-172 查询主机状态迁移信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

主机状态资源模型的OData 描述信息

@odata.id

字符串

主机状态资源的访问路径

@odata.type

字符串

主机状态资源的类型

Id

字符串

主机状态资源的 ID

Name

字符串

主机状态资源的名称

AgentState

字符串

Agent在位状态：

Enabled、Absent

DSDCardState

字符串

DSDCard在位状态：

Enabled：使能

Absent：不在位

NotSupported：不支持

TPMState

字符串

TPM状态：

Enabled：使能

Disabled：禁用

Absent：不在位

NotSupported：不支持

TPMType

字符串

可信密码模块名称：

TPM/TCM

SystemVersion

字符串

系统版本

HostSummary

对象

主机汇总信息

RunningState

字符串

当前运行状态

PowerOn

PowerOff

DurationSeconds

数值

当前状态持续时间

CurrentStageDurationSeconds

数值

BIOS阶段持续时间

LastStartupRecords

对象

上一次启动状态记录数据

CurrentStartupRecords

对象

当前启动状态记录数据

CurrentStage

字符串

当次主机迁移状态所处阶段

PowerUp

BIOS_Starting

BIOS_Ending

OS

PowerDown

PowerUpStage

对象

开机阶段状态信息

BIOSStage

对象

BIOS阶段状态信息

OSStage

对象

OS阶段状态信息

PowerDownStage

对象

关机阶段

StartTime

字符串

当前状态开始时间

EndTime

字符串

当前状态结束时间

PowerUpCause

字符串

上电原因

PowerDownCause

字符串

下电原因

VersionChanged

布尔

BIOS版本是否更改

ComponentIsolated

布尔

是否存在部件隔离

POSTCode

字符串

当前开机自检码

POSTCodeDescription

字符串

开机自检码描述信息

ErrorCount

数值

故障数量

BiosVersion

字符串

BIOS版本

MEFirmwareVersion

字符串

ME版本（AMD不支持）

ReadyTime

字符串

OS系统就绪时间

UCECount

数值

UCE数量

FaultList

数组

故障日志列表

Id

字符串

日志ID

TimeStamp

字符串

时间戳

EventCode

字符串

事件码

Message

字符串

日志信息

 

【修改记录】

(1)     HDM2-1.53：DSDCardState字段新增NotSupported状态，并添加该字段输出说明

 

4.3.51  查询主机资源监控信息 

【功能描述】

查询主机资源监控信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id/Oem/Public/PerformanceMonitoring

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-173 查询主机资源监控信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

system_id

系统资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#PerformanceMonitoring.PerformanceMonitoring",

    "@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring",

    "@odata.type": "#PerformanceMonitoring.v1_0_0.PerformanceMonitoring",

    "AgentState": "Absent",

    "Description": "The system performance monitoring",

    "DriveHistoryUsageRate": {

        "@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/DriveHistoryUsageRate"

    },

    "DriveIOPSHistoryData": {

        "@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/DriveIOPSHistoryData"

    },

    "DriveSVCTMHistoryData": {

        "@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/DriveSVCTMHistoryData"

},

"DriveUsageAlarmThreshold": 0,

    "DriveUsageRateAlarmThreshold": 0,

    "ExternalDevice": [

        {

            "FreeSpaceMB": 4868,

            "Model": "Kingston_DataTraveler_2.0_C86000BDB7B8EF306A25DA0C",

            "SpeedMbps": 480.0,

            "TotalCapacityMB": 7792

        },

        {

            "FreeSpaceMB": 1395,

            "Model": "USB_SanDisk_3.2Gen1_010140fc9d2cd08aa332d1f13eed2cb7248bf3bfba8419ddfd79063f84b189dbe33000000000000000000000689ec8130084450091558107a22aad68",

            "SpeedMbps": 480.0,

            "TotalCapacityMB": 1652

        }

    ],

    "FullDuplexThroughputHistoryData": {

        "@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/FullDuplexThroughputHistoryData"

    },

    "GPUHistoryUsageRate": {

        "@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/GPUHistoryUsageRate"

    },

    "Id": "PerformanceMonitoring",

    "MemoryHistoryUsageRate": {

        "@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/MemoryHistoryUsageRate"

},

"MemoryUsageAlarmThreshold": 0,

"MemoryUsageRate": 11,

    "MemoryUsageRateAlarmThreshold": 0,

    "NFSClientIOSpeedHistoryData": {

        "@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/NFSClientIOSpeedHistoryData"

    },

    "NFSServerIOSpeedHistoryData": {

        "@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/NFSServerIOSpeedHistoryData"

    },

    "Name": "PerformanceMonitoring",

    "NetworkUsageRateAlarmThreshold": 0,

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "ProcessorsHistoryUsageRate": {

        "@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/ProcessorsHistoryUsageRate"

},

"ProcessorsUsageAlarmThreshold": 0,

"ProcessorsUsageRate": 0,

    "ProcessorsUsageRateAlarmThreshold": 0,

    "SystemLoadHistoryData": {

        "@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/SystemLoadHistoryData"

    }

}

响应码：200

【输出说明】

表4-174 查询主机资源监控信息输出参数

字段

类型

字段说明

@odata.context

字符串

主机资源监控资源模型的OData 描述信息

@odata.id

字符串

主机资源监控资源的访问路径

@odata.type

字符串

主机资源监控资源的类型

AgentState

字符串

Agent在位状态：

Enabled、Absent

Id

字符串

资源ID

Name

字符串

资源名称

Description

字符串

接口功能描述

ProcessorsUsageRateAlarmThreshold

数值

CPU使用率告警水线

MemoryUsageRateAlarmThreshold

数值

内存使用率告警水线

DriveUsageRateAlarmThreshold

数值

硬盘使用率告警水线

NetworkUsageRateAlarmThreshold

数值

网络使用率告警水线

MemoryHistoryUsageRate

对象

内存历史占用率资源访问路径

ProcessorsHistoryUsageRate

对象

CPU历史占用率资源访问路径

FullDuplexThroughputHistoryData

对象

网络历史收发速率资源访问路径

GPUHistoryUsageRate

对象

GPU历史占用率资源访问路径

DriveHistoryUsageRate

对象

磁盘历史占用率资源访问路径

DriveIOPSHistoryData

对象

磁盘IO性能历史数据访问路径

DriveSVCTMHistoryData

对象

磁盘SVCTM历史数据访问路径

NFSServerIOSpeedHistoryData

对象

NFS服务端读写速率历史数据访问路径

NFSClientIOSpeedHistoryData

对象

NFS客户端读写速率历史数据访问路径

SystemLoadHistoryData

对象

系统负载信息历史数据访问路径

ExternalDevice

数组

外置设备信息

Model

字符串

设备型号

SpeedMbps

数值

设备速率

TotalCapacityMB

数值

设备总容量

FreeSpaceMB

数值

设备可用容量

MemoryUsageRate

数值

内存使用率

ProcessorsUsageRate

数值

CPU使用率

DriveUsageAlarmThreshold

数值

硬盘使用率告警水线

MemoryUsageAlarmThreshold

数值

内存使用率告警水线

ProcessorsUsageAlarmThreshold

数值

CPU使用率告警水线

 

【修改记录】

(1)     HDM2-1.14：新增MemoryUsageRate、ProcessorsUsageRate字段，添加输出说明

(2)     HDM2-1.54：新增DriveUsageAlarmThreshold、MemoryUsageAlarmThreshold和ProcessorsUsageAlarmThreshold字段

 

4.3.52  设置主机资源监控信息 

【功能描述】

设置主机资源监控信息。

【所属权限模块】

远程控制

【命令格式】

PATCH https://device_ip/redfish/v1/Systems/system_id/Oem/Public/PerformanceMonitoring

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:ifmatch_value

【请求消息体】

{

  "ProcessorsUsageAlarmThreshold": processors_usage_alarm_threshold,

  "MemoryUsageAlarmThreshold": memory_usage_alarm_threshold,

  "NetworkUsageAlarmThreshold": network_usage_alarm_threshold,

  "DriveUsageAlarmThreshold": dirve_usage_alarm_threshold

}

【参数说明】

表4-175 设置主机资源监控信息说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

system_id

系统资源的ID

当前所有机型取值为1

ProcessorsUsageAlarmThreshold

数值

CPU使用率告警水线

MemoryUsageAlarmThreshold

数值

内存使用率告警水线

DriveUsageAlarmThreshold

数值

硬盘使用率告警水线

NetworkUsageAlarmThreshold

数值

网口使用率告警水线

注：该字段暂不支持设置

 

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:ifmatch_value

【请求消息体】

{

  "ProcessorsUsageAlarmThreshold": 20,

  "MemoryUsageAlarmThreshold": 10,

  "DriveUsageAlarmThreshold": 20

}

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#PerformanceMonitoring.PerformanceMonitoring",

    "@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring",

    "@odata.type": "#PerformanceMonitoring.v1_0_0.PerformanceMonitoring",

    "AgentState": "Absent",

    "Description": "The system performance monitoring",

    "DriveHistoryUsageRate": {

        "@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/DriveHistoryUsageRate"

    },

    "DriveIOPSHistoryData": {

        "@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/DriveIOPSHistoryData"

    },

    "DriveSVCTMHistoryData": {

        "@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/DriveSVCTMHistoryData"

},

"DriveUsageAlarmThreshold": 20,

    "DriveUsageRateAlarmThreshold": 20,

    "ExternalDevice": [

        {

            "FreeSpaceMB": 4868,

            "Model": "Kingston_DataTraveler_2.0_C86000BDB7B8EF306A25DA0C",

            "SpeedMbps": 480.0,

            "TotalCapacityMB": 7792

        },

        {

            "FreeSpaceMB": 1395,

            "Model": "USB_SanDisk_3.2Gen1_010140fc9d2cd08aa332d1f13eed2cb7248bf3bfba8419ddfd79063f84b189dbe33000000000000000000000689ec8130084450091558107a22aad68",

            "SpeedMbps": 480.0,

            "TotalCapacityMB": 1652

        }

    ],

    "FullDuplexThroughputHistoryData": {

        "@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/FullDuplexThroughputHistoryData"

    },

    "GPUHistoryUsageRate": {

        "@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/GPUHistoryUsageRate"

    },

    "Id": "PerformanceMonitoring",

    "MemoryHistoryUsageRate": {

        "@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/MemoryHistoryUsageRate"

},

"MemoryUsageAlarmThreshold": 10,

"MemoryUsageRate": 11,

    "MemoryUsageRateAlarmThreshold": 10,

    "NFSClientIOSpeedHistoryData": {

        "@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/NFSClientIOSpeedHistoryData"

    },

    "NFSServerIOSpeedHistoryData": {

        "@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/NFSServerIOSpeedHistoryData"

    },

    "Name": "PerformanceMonitoring",

    "NetworkUsageRateAlarmThreshold": 0,

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "ProcessorsHistoryUsageRate": {

        "@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/ProcessorsHistoryUsageRate"

},

"ProcessorsUsageAlarmThreshold": 20,

"ProcessorsUsageRate": 0,

    "ProcessorsUsageRateAlarmThreshold": 20,

    "SystemLoadHistoryData": {

        "@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/SystemLoadHistoryData"

    }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回字段说明同【查询主机资源监控信息】

【修改记录】

(1)     HDM2-1.14：应答示例新增MemoryUsageRate、ProcessorsUsageRate字段

(2)     HDM2-1.54：应答示例新增DriveUsageAlarmThreshold、MemoryUsageAlarmThreshold和ProcessorsUsageAlarmThreshold字段

 

4.3.53  查询CPU历史占用率资源信息

【功能描述】

查询CPU历史占用率资源信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id/Oem/Public/PerformanceMonitoring/ProcessorsHistoryUsageRate

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-176 查询CPU历史占用率信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

system_id

系统资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/ProcessorsHistoryUsageRate

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#ProcessorsHistoryUsageRate.ProcessorsHistoryUsageRate",

    "@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/ProcessorsHistoryUsageRate",

    "@odata.type": "#ProcessorsHistoryUsageRate.v1_0_0.ProcessorsHistoryUsageRate",

    "Description": "The historical usage rate of processors",

    "HistoricalUsageRate": [

        {

            "Time": "2023-02-19T02:36:42+08:00",

            "UsageRatePercents": 5.27

        },

        {

            "Time": "2023-02-19T02:41:42+08:00",

            "UsageRatePercents": 5.27

        },

        {

            "Time": "2023-02-19T02:46:42+08:00",

            "UsageRatePercents": 5.29

        },

…

    ],

    "Id": "ProcessorsHistoryUsageRate",

    "Name": "Processors History Usage Rate",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    }

}

响应码：200

【输出说明】

表4-177 查询CPU历史资源占用率信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

CPU历史资源占用率资源模型的OData 描述信息

@odata.id

字符串

CPU历史资源占用率资源的访问路径

@odata.type

字符串

CPU历史资源占用率资源的类型

Description

字符串

CPU历史资源占用率资源的描述

HistoricalUsageRate

数组

历史数据

UsageRatePercents

数值

数据产生时的使用率

Time

字符串

数据产生时的时间

 

4.3.54  查询内存历史占用率资源信息

【功能描述】

查询内存历史占用率资源信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id/Oem/Public/PerformanceMonitoring/MemoryHistoryUsageRate

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-178 查询内存历史占用率信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

system_id

系统资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/MemoryHistoryUsageRate

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#MemoryHistoryUsageRate.MemoryHistoryUsageRate",

    "@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/MemoryHistoryUsageRate",

    "@odata.type": "#MemoryHistoryUsageRate.v1_0_0.MemoryHistoryUsageRate",

    "Description": "The historical usage rate of memory",

    "HistoricalUsageRate": [

        {

            "Time": "2023-05-24T05:55:05+08:00",

            "UsageRatePercents": 9.35

        },

        {

            "Time": "2023-05-24T06:00:05+08:00",

            "UsageRatePercents": 9.36

        }

      ...

    ],

    "Id": "MemoryHistoryUsageRate",

    "Name": "Memory History Usage Rate",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    }

}

响应码：200

【输出说明】

表4-179 查询内存历史占用率信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

内存历史占用率资源模型的OData 描述信息

@odata.id

字符串

内存历史占用率资源的访问路径

@odata.type

字符串

内存历史占用率资源的类型

Description

字符串

内存历史占用率资源的描述

Name

字符串

内存历史占用率资源的名称

Id

字符串

内存历史占用率资源的ID

HistoricalUsageRate

数组

历史数据

UsageRatePercents

数值

数据产生时的使用率

Time

字符串

数据产生时的时间

 

4.3.55  查询GPU历史占用率资源信息 

【功能描述】

查询GPU历史占用率资源信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id/Oem/Public/PerformanceMonitoring/GPUHistoryUsageRate

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-180 查询GPU历史占用率信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

system_id

系统资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/Oem/Public/ PerformanceMonitoring/GPUHistoryUsageRate

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#GPUHistoryUsageRate.GPUHistoryUsageRate",

    "@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/GPUHistoryUsageRate",

    "@odata.type": "#GPUHistoryUsageRate.v1_0_0.GPUHistoryUsageRate",

    "Description": "The historical usage rate of GPU",

    "GPUList": [

        {

            "HistoricalUsageRate": [

                {

                    "Time": "2022-07-29T10:55:00--03:00",

                    "UsageRatePercents": 0.5

                },

                {

                    "Time": "2022-07-29T10:55:00--03:00",

                    "UsageRatePercents": 10.5

                },

                ...

            ],

            "Name": "GeForce GT 720"

        }

    ],

    "Id": "GPUHistoryUsageRate",

    "Name": "GPU History Usage Rate",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    }

}

响应码：200

【输出说明】

表4-181 查询GPU历史占用率信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

GPU历史占用率资源模型的OData 描述信息

@odata.id

字符串

GPU历史占用率资源的访问路径

@odata.type

字符串

GPU历史占用率资源的类型

Description

字符串

GPU历史占用率资源的描述

Name

字符串

GPU历史占用率资源的名称

Id

字符串

GPU历史占用率资源的ID

GPUList

数组

GPU历史数据

Name

字符串

指定GPU名称

HistoricalUsageRate

数组

历史数据

UsageRate

数值

数据产生时的使用率

Time

字符串

数据产生时的时间

 

4.3.56  查询网络带宽历史收发速率资源信息

【功能描述】

查询网络带宽历史收发速率资源信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id/Oem/Public/PerformanceMonitoring/FullDuplexThroughputHistoryData

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-182 查询网络带宽历史收发速率信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

system_id

系统资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/FullDuplexThroughputHistoryData

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#FullDuplexThroughputHistoryData.FullDuplexThroughputHistoryData",

    "@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/FullDuplexThroughputHistoryData",

    "@odata.type": "#FullDuplexThroughputHistoryData.v1_0_0.FullDuplexThroughputHistoryData",

    "Description": "Historical data of full-duplex throughput",

    "Id": "FullDuplexThroughputHistoryData",

    "Name": "Full Duplex Throughput History Data",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "PortList":[

  {

      "HistoricalData": [

          {

              "ReceiveRate": 0.8,

              "Time": "2021-01-26T04:49:30-03:00",

              "TransmitRate": 0.9

          },

          {

              "ReceiveRate": 0.8,

              "Time": "2021-01-26T04:49:30-03:00",

              "TransmitRate": 0.9

          },

          ...

      ],

      "PortId": "0",

      "PortName": "60:DA:83:80:3F:37"

  },

  {

      "HistoricalData": [

          {

              "ReceiveRate": 0.8,

              "Time": "2021-01-26T04:49:30-03:00",

              "TransmitRate": 0.9

          },

          {

              "ReceiveRate": 0.8,

              "Time": "2021-01-26T04:49:30-03:00",

              "TransmitRate": 0.9

          },

          ...

      ],

      "PortId": "1",

      "PortName": "60:DA:83:80:3F:38"

  }

  ...

    ]

}

响应码：200

【输出说明】

表4-183 查询网络带宽历史资源收发速率信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

网络历史资源收发速率资源模型的OData 描述信息

@odata.id

字符串

网络历史资源收发速率资源的访问路径

@odata.type

字符串

网络历史资源收发速率资源的类型

Description

字符串

网络历史资源收发速率资源的描述

PortList

数组

网络端口列表信息

PortName

字符串

网络端口名称

PortId

字符串

网络端口ID

HistoricalData

数组

历史数据

TransmitRate

数值

数据产生时的网络接收速率，单位bps

ReceiveRate

数值

数据产生时的网络发送速率，单位bps

Time

字符串

数据产生时的时间

 

4.3.57  查询磁盘历史占用率资源信息

【功能描述】

查询磁盘历史占用率资源信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id/Oem/Public/PerformanceMonitoring/DriveHistoryUsageRate

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-184 查询磁盘历史占用率信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

system_id

系统资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/DriveHistoryUsageRate

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#DriveHistoryUsageRate.DriveHistoryUsageRate",

    "@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/DriveHistoryUsageRate",

    "@odata.type": "#DriveHistoryUsageRate.v1_0_0.DriveHistoryUsageRate",

    "Description": "The historical usage rate of drive",

    "HistoricalUsageRate": [

        {

            "Time": "2021-01-26T04:49:30-03:00",

            "TotalCapacityMB": 47897200,

            "UsageRatePercents": 4.04,

            "UsedCapacityGB": 1934608

        },

        {

            "Time": "2021-01-26T04:49:30-03:00",

            "TotalCapacityMB": 47897200,

            "UsageRatePercents": 4.04,

            "UsedCapacityGB": 1934608

        },

      ...

    ],

    "Id": "DriveHistoryUsageRate",

    "Name": "Drive History Usage Rate",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    }

}

响应码：200

【输出说明】

表4-185 查询磁盘历史占用率信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

磁盘历史占用率资源模型的OData 描述信息

@odata.id

字符串

磁盘历史占用率资源的访问路径

@odata.type

字符串

磁盘历史占用率资源的类型

Description

字符串

磁盘历史占用率资源的描述

HistoricalUsageRate

数组

历史数据

UsageRatePercents

数值

数据产生时的使用率

TotalCapacityMB

数值

数据产生时的分区总容量

UsedCapacityGB

数值

数据产生时的分区已使用容量

Time

字符串

数据产生时的时间

 

4.3.58  查询磁盘IO性能历史数据信息

【功能描述】

查询磁盘IO性能历史数据信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id/Oem/Public/PerformanceMonitoring/DriveIOPSHistoryData

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-186 查询磁盘IO性能历史数据信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

system_id

系统资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/DriveHistoryUsageRate

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#DriveIOPSHistoryData.DriveIOPSHistoryData",

    "@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/DriveIOPSHistoryData",

    "@odata.type": "#DriveIOPSHistoryData.v1_0_0.DriveIOPSHistoryData",

    "Description": "The historical IOPS of drive",

    "Id": "DriveIOPSHistoryData",

    "Name": "Drive IOPS History Data",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "PartitionList": [

        {

            "HistoricalInputOperations": [

                {

                    "OperationsPerSecond": 4.1,

                    "Time": "2021-01-26T04:49:35-03:00"

                },

                {

                    "OperationsPerSecond": 4.1,

                    "Time": "2021-01-26T04:49:35-03:00"

                },

              ...

            ],

            "HistoricalOutputOperations": [

                {

                    "OperationsPerSecond": 3.1,

                    "Time": "2021-01-26T04:49:35-03:00"

                },

                {

                    "OperationsPerSecond": 3.1,

                    "Time": "2021-01-26T04:49:35-03:00"

                },

              ...

            ],

            "PartitionId": "1",

            "PartitionName": "sdb"

        },

        …

    ]

}

响应码：200

【输出说明】

表4-187 查询磁盘IO性能历史数据信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

磁盘IO性能资源模型的OData 描述信息

@odata.id

字符串

磁盘IO性能资源的访问路径

@odata.type

字符串

磁盘IO性能资源的类型

Description

字符串

磁盘IO性能资源的描述

PartitionList

数组

磁盘分区列表

PartitionName

字符串

分区名称

PartitionId

字符串

分区ID

HistoricalInputOperations

数组

写操作历史数据

HistoricalOutputOperations

数组

读操作历史数据

OperationsPerSecond

数值

数据产生时的每秒读/写次数

Time

字符串

数据产生时的时间

 

4.3.59  查询磁盘SVCTM历史数据信息

【功能描述】

查询磁盘SVCTM（快慢盘）历史数据信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id/Oem/Public/PerformanceMonitoring/DriveSVCTMHistoryData

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-188 查询磁盘SVCTM历史数据信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

system_id

系统资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/DriveSVCTMHistoryData

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

   "@odata.context": "/redfish/v1/$metadata#DriveSVCTMHistoryData.DriveSVCTMHistoryData",

    "@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/DriveSVCTMHistoryData",

    "@odata.type": "#DriveSVCTMHistoryData.v1_0_0.DriveSVCTMHistoryData",

    "Description": "The historical SVCTM of drive",

    "Id": "DriveSVCTMHistoryData",

    "Name": "Drive SVCTM History Data",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "PartitionList": [

        {

            "HistorySVCTM": [

                {

                    "ServiceTimeMs": 0.8,

                    "Time": "2021-01-26T04:49:35-03:00"

                },

                {

                    "ServiceTimeMs": 0.8,

                    "Time": "2021-01-26T04:49:35-03:00"

                },

              ...

            ],

            "PartitionId": "0",

            "PartitionName": "sda"

        },

        {

            "HistorySVCTM": [

                {

                    "ServiceTimeMs": 0.8,

                    "Time": "2021-01-26T04:49:35-03:00"

                },

                {

                    "ServiceTimeMs": 0.8,

                    "Time": "2021-01-26T04:49:35-03:00"

                },

              ...

            ],

            "PartitionId": "1",

            "PartitionName": "sdb"

        }

    ]

}

响应码：200

【输出说明】

表4-189 查询磁盘SVCTM信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

磁盘SVCTM资源模型的OData 描述信息

@odata.id

字符串

磁盘SVCTM资源的访问路径

@odata.type

字符串

磁盘SVCTM资源的类型

Description

字符串

磁盘SVCTM资源的描述

PartitionList

数组

磁盘分区列表

PartitionName

字符串

分区名称

PartitionId

字符串

分区ID

HistorySVCTM

数组

历史SVCTM数据

ServiceTimeMs

数值

数据产生时的SVCTM值

Time

字符串

数据产生时的时间

 

4.3.60  查询NFS服务端读写速率历史数据信息

【功能描述】

查询NFS服务端读写速率历史数据信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id/Oem/Public/PerformanceMonitoring/NFSServerIOSpeedHistoryData

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-190 查询NFS服务端读写速率历史数据信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

system_id

系统资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/NFSServerIOSpeedHistoryData

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#NFSServerIOSpeedHistoryData.NFSServerIOSpeedHistoryData",

    "@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/NFSServerIOSpeedHistoryData",

    "@odata.type": "#NFSServerIOSpeedHistoryData.v1_0_0.NFSServerIOSpeedHistoryData",

    "Description": "The historical IOSpeed of NFS Server",

    "HistoricalReadOperations": [

        {

            "SpeedMbps": 221.1,

            "Time": "2022-07-29T10:55:00-03:00"

        },

        {

            "SpeedMbps": 221.1,

            "Time": "2022-07-29T10:55:00-03:00"

        },

      ...

    ],

    "HistoricalWriteOperations": [

        {

            "SpeedMbps": 21.1,

            "Time": "2022-07-29T10:55:00-03:00"

        },

        {

            "SpeedMbps": 21.1,

            "Time": "2022-07-29T10:55:00-03:00"

        },

      ...

    ],

    "Id": "NFSServerIOSpeedHistoryData",

    "Name": "NFS Server IOSpeed History Data",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    }

}

响应码：200

【输出说明】

表4-191 查询NFS服务端读写速率信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

NFS服务端读写速率资源模型的OData 描述信息

@odata.id

字符串

NFS服务端读写速率资源的访问路径

@odata.type

字符串

NFS服务端读写速率资源的类型

Description

字符串

NFS服务端读写速率资源的描述

HistoricalWriteOperations

数组

历史写操作数据

HistoricalReadOperations

数组

历史读操作数据

SpeedMbps

数值

数据产生时的读/写速率，单位KB/s

Time

字符串

数据产生时的时间

 

4.3.61  查询NFS客户端读写速率历史数据信息

【功能描述】

查询NFS客户端读写速率历史数据信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id/Oem/Public/PerformanceMonitoring/NFSClientIOSpeedHistoryData

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-192 查询NFS客户端读写速率历史数据信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

system_id

系统资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/NFSClientIOSpeedHistoryData

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#NFSClientIOSpeedHistoryData.NFSClientIOSpeedHistoryData",

    "@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/NFSClientIOSpeedHistoryData",

    "@odata.type": "#NFSClientIOSpeedHistoryData.v1_0_0.NFSClientIOSpeedHistoryData",

    "ClientList": [

        {

            "HistoricalReadOperations": [

                {

                    "SpeedMbps": 1.2,

                    "Time": "2022-07-29T10:55:30-03:00"

                },

                {

                    "SpeedMbps": 1.2,

                    "Time": "2022-07-29T10:55:30-03:00"

                },

...

"Name": "/mnt/share2"

            ],

            "HistoricalWriteOperations": [

                {

                    "SpeedMbps": 21.1,

                    "Time": "2022-07-29T10:55:30-03:00"

                },

                {

                    "SpeedMbps": 21.1,

                    "Time": "2022-07-29T10:55:30-03:00"

                },

              ...

            ],

            "Name": "/mnt/share1"

        },

      ...

    ],

    "Description": "The historical IOSpeed of NFS Server",

    "Id": "NFSClientIOSpeedHistoryData",

    "Name": "NFS Client IOSpeed History Data",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    }

}

响应码：200

【输出说明】

表4-193 查询NFS客户端读写速率信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

NFS客户端读写速率资源模型的OData 描述信息

@odata.id

字符串

NFS客户端读写速率资源的访问路径

@odata.type

字符串

NFS客户端读写速率资源的类型

Description

字符串

NFS客户端读写速率资源的描述

HistoricalReadOperations

数组

历史读操作数据

HistoricalWriteOperations

数组

历史写操作数据

Name

字符串

客户端名称

SpeedMbps

数值

数据产生时的读/写速率，单位KB/s

Time

字符串

数据产生时的时间

 

4.3.62  查询系统负载历史数据信息

【功能描述】

查询系统负载历史数据信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id/Oem/Public/PerformanceMonitoring/SystemLoadHistoryData

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-194 查询系统负载历史数据信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

system_id

系统资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/SystemLoadHistoryData

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#SystemLoadHistoryData.SystemLoadHistoryData",

    "@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/SystemLoadHistoryData",

    "@odata.type": "#SystemLoadHistoryData.v1_0_0.SystemLoadHistoryData",

    "Description": "The historical system load",

    "HistoricalSystemLoad": [

        {

            "LastFifteenMinutes": 0.12,

            "LastFiveMinutes": 0.07,

            "LastMinute": 0.07,

            "Time": "2021-01-26T04:49:30-03:00"

        },

        {

            "LastFifteenMinutes": 0.12,

            "LastFiveMinutes": 0.07,

            "LastMinute": 0.07,

            "Time": "2021-01-26T04:49:30-03:00"

        },

      ...

    ],

    "Id": "SystemLoadHistoryData",

    "Name": "System Load History Data",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    }

}

响应码：200

【输出说明】

表4-195 查询系统负载信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

系统负载资源模型的OData 描述信息

@odata.id

字符串

系统负载资源的访问路径

@odata.type

字符串

系统负载资源的类型

Description

字符串

系统负载资源的描述

HistoricalSystemLoad

数组

历史数据

LoadRatePercents

数值

数据产生时的负载率

Time

字符串

数据产生时的时间

LastMinute

数值

数据产生时，最近一分钟的平均系统负载

LastFifteenMinutes

数值

数据产生时，最近十五分钟的平均系统负载

LastFiveMinutes

数值

数据产生时，最近五分钟的平均系统负载

 

4.3.63  获取性能顾问推荐信息

【功能描述】

获取性能顾问推荐信息。

本资源受许可证控制，需要通过许可证授权后才能使用。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id/Oem/Public/WorkloadPerformanceAdvisor

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-196 获取性能顾问推荐信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

system_id

系统资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/Oem/Public/WorkloadPerformanceAdvisor

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#WorkloadPerformanceAdvisor.WorkloadPerformanceAdvisor",

    "@odata.id": "/redfish/v1/Systems/1/Oem/Public/WorkloadPerformanceAdvisor",

    "@odata.type": "#WorkloadPerformanceAdvisor.v1_0_0.WorkloadPerformanceAdvisor",

    "Description": "Get the workload performance advisor information",

    "Id": "WorkloadPerformanceAdvisor",

    "Name": "WorkloadPerformanceAdvisor",

    "WorkloadProfileConfiguration": "Custom",

"TenMinutesInterval": {

    "ResourceUsageLevel": {

            "CPUUsageLevel": "High",

            "MemoryBusUsagelevel": "Low",

            "IOBusUsageLevel": "Low",

            "NUMAUsageLevel": null

        },

    "RecommendedSettings": null

        },

    "OneHourInterval": {

    "ResourceUsageLevel": {

            "CPUUsageLevel": "High",

            "MemoryBusUsagelevel": "Low",

            "IOBusUsageLevel": "Low",

            "NUMAUsageLevel": null

        },

    "RecommendedSettings": null

        },

    "OneDayInterval": {

    "ResourceUsageLevel": {

            "CPUUsageLevel": "High",

            "MemoryBusUsagelevel": "Low",

            "IOBusUsageLevel": "Low",

            "NUMAUsageLevel": null

        },

    "RecommendedSettings": null

        },

    "OneWeekInterval": {

        "ResourceUsageLevel": {

            "CPUUsageLevel": "High",

            "MemoryBusUsagelevel": "Low",

            "IOBusUsageLevel": "Low",

            "NUMAUsageLevel": null

        },

    "RecommendedSettings": null

        }

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success",

      }

    }

}

响应码：200

【输出说明】

表4-197 获取性能顾问推荐信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

性能顾问推荐信息的OData描述信息

@odata.id

字符串

性能顾问推荐信息的访问路径

@odata.type

字符串

性能顾问推荐信息的类型

TenMinutesInterval

对象

10分钟时间间隔

OneHourInterval

对象

1小时时间间隔

OneDayInterval

对象

1天（24小时）时间间隔

OneWeekInterval

对象

1周时间间隔

WorkloadProfileConfiguration

字符串

推荐的应用场景配置模板

1、     High Performance Compute（高性能计算）

2、     Custom（自定义）

说明：如果为null表示不推荐

ResourceUsageLevel

对象

资源利用率等级

说明：主机关机则为null

CPUUsageLevel

字符串

CPU利用率等级

"High"：高

"Middle"：中

"Low"：低

说明：如果为”N/A”表示数据点不足

MemoryBusUsagelevel

字符串

内存总线利用率等级

"High"：高

"Middle"：中

"Low"：低

说明：如果为”N/A”表示数据点不足

IOBusUsageLevel

字符串

IO总线利用率等级

"High"：高

"Middle"：中

"Low"：低

说明：如果为”N/A”表示数据点不足

NUMAUsageLevel

字符串

NUMA识别等级

"High"：高

"Middle"：中

"Low"：低

注：该字段暂不支持

RecommendedSettings

对象

推荐设置

说明：该对象暂不支持，为null表示不推荐

Description

字符串

性能顾问推荐信息列表资源描述信息

Id

字符串

性能顾问推荐信息列表资源Id

Name

字符串

性能顾问推荐信息列表资源名称

 

【修改记录】

(1)     HDM2-1.55：新增获取性能顾问推荐信息接口

(2)     HDM2-1.60：接口描述修改为获取性能顾问推荐信息

(3)     HDM2-2.04：NUMAUsageLevel及RecommendedSettings字段功能改为不支持

(4)     HDM2-2.08：增加一周的资源利用率OneWeekInterval；增加CPUUsageLevel、MemoryBusUsagelevel、IOBusUsageLevel说明如果数据点不足则显示”N/A”

 

4.3.64  上传写入Intel On Demand License激活文件

【功能描述】

上传写入Intel On Demand License激活文件。

【所属权限模块】

用户配置

【命令格式】

POST https://device_ip/redfish/v1/Systems/system_id/Processors/cpu_id/Actions/Oem/Public/Processor.LicenseUpload/

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"Type":"URI",

"Content": "license file path"

}

【参数说明】

表4-198 上传写入Intel On Demand License激活文件资源属性选项参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

Type

字符串

URI

Content

LicenseFile文件路径

1、操作路径：不支持中文

2、长度不超过1024，特殊符号支持 @!$^&()_+.;[]{}-=~`，不支持中文

3、仅支持“/tmp/web/”及其子目录

4、支持远程导入

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/Systems/1/Processors/1/Actions/Oem/Public/Processor.LicenseUpload/

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"Type":"URI",

"Content": "/tmp/web/LAC-B1BFB71B8395F812-00000001-FA8BD7DA7307E6-SGX512.json"

}

【应答示例】

{

  "@odata.context": "/redfish/v1/$metadata#TaskCollection.TaskCollection",

  "@odata.type": "#TaskCollection.TaskCollection",

  "Members": [

    {

      "@odata.id": "/redfish/v1/TaskService/Tasks/2"

    }

  ],

  "[email protected]": 1,

  "Name": "Task Collection",

  "Oem": {

    "Public": {

      "CompletionCode": 0,

      "Description": "Success",

      "TaskUniqueID": 1678656297

    }

  }

}

响应码：202

【输出说明】

返回状态码202，表示操作成功。

表4-199 上传写入Intel On Demand License激活文件输出说明

字段

类型

字段说明

@odata.context

字符串

上传写入Intel On Demand License激活文件TaskService的OData 描述信息

@odata.type

字符串

上传写入Intel On Demand License激活文件TaskService的类型

Name

字符串

上传写入Intel On Demand License激活文件的名称

[email protected]

数字

上传写入Intel On Demand License激活文件生成的Task个数

Members

数组

上传写入Intel On Demand License激活文件生成的Task链接集合

@odata.id

字符串

上传写入Intel On Demand License激活文件TaskService的访问路径

Oem.Public.TaskUniqueID

数值

上传写入Intel On Demand License激活文件TaskService的唯一ID

 

【修改记录】

(1)     HDM2-2.02：新增接口

 

4.3.65  导出CPU状态报告

【功能描述】

导出CPU状态报告。

【所属权限模块】

用户配置

【命令格式】

POST https://device_ip/redfish/v1/Systems/system_id/Processors/cpu_id/Actions/Oem/Public/Processor.StateReportExport/

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"Type":"URI",

"Content": "/tmp/web/CPU1_report_20290901T164036+0800.json"

}

【参数说明】

表4-200 导出CPU状态报告资源属性选项参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

Type

字符串

URI

Content

CPU状态报告文件路径

1、操作路径：不支持中文

2、长度不超过1024，特殊符号支持 @!$^&()_+.;[]{}-=~`，不支持中文

3、仅支持“/tmp/web/”及其子目录

4、支持远程导出

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/Systems/1/Processors/1/Actions/Oem/Public/Processor.StateReportExport/

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"Type":"URI",

"Content": "/tmp/web/CPU1_report_20290901T164036+0800.json"

}

【应答示例】

{

  "@odata.context": "/redfish/v1/$metadata#TaskCollection.TaskCollection",

  "@odata.type": "#TaskCollection.TaskCollection",

  "Members": [

    {

      "@odata.id": "/redfish/v1/TaskService/Tasks/3"

    }

  ],

  "[email protected]": 1,

  "Name": "Task Collection",

  "Oem": {

    "Public": {

      "CompletionCode": 0,

      "Description": "Success",

      "TaskUniqueID": 1678656299

    }

  }

}

响应码：202

【输出说明】

返回状态码202，表示操作成功。

表4-201 导出CPU状态报告输出说明

字段

类型

字段说明

@odata.context

字符串

导出CPU状态报告TaskService的OData 描述信息

@odata.type

字符串

导出CPU状态报告TaskService的类型

Name

字符串

导出CPU状态报告的名称

[email protected]

数字

导出CPU状态报告生成的Task个数

Members

数组

导出CPU状态报告生成的Task链接集合

@odata.id

字符串

导出CPU状态报告TaskService的访问路径

Oem.Public.TaskUniqueID

数值

导出CPU状态报告TaskService的唯一ID

 

【修改记录】

(1)     HDM2-2.02：新增接口

 

4.4  Managers 资源的操作

4.4.1  查询管理集合资源

【功能描述】

查询服务器当前管理集合资源信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-202 查询管理资源信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Managers

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#Managers",

    "@odata.id": "/redfish/v1/Managers",

    "@odata.type": "#ManagerCollection.ManagerCollection",

    "Members": [

        {

            "@odata.id": "/redfish/v1/Managers/1"

        }

    ],

    "[email protected]": 1,

    "Name": "Manager Collection",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    }

}

响应码：200

【输出说明】

表4-203 查询管理资源信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

管理集合资源模型的OData 描述信息

@odata.id

字符串

管理集合资源的访问路径

@odata.type

字符串

管理集合资源的类型

Members

管理资源列表

@odata.id

字符串

管理资源节点的访问路径

[email protected]

数值

当前管理资源数量

Name

字符串

管理集合资源的名称

 

4.4.2  查询指定管理资源信息

【功能描述】

查询服务器指定管理资源信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-204 查询指定管理资源信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Managers/1

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#Manager.Manager(*)",

    "@odata.id": "/redfish/v1/Managers/1",

    "@odata.type": "#Manager.v1_10_0.Manager",

    "Actions": {

        "#LogService.ClearOperationLog": {

            "@Redfish.AllowableValues": [

                ""

            ],

            "target": "/redfish/v1/Managers/1/LogServices/Actions/LogService.ClearOperationLog"

        },

        "#Manager.Reset": {

            "[email protected]": [

                "ForceRestart"

            ],

            "target": "/redfish/v1/Managers/1/Actions/Manager.Reset"

        },

        "Oem": {

            "Public": {

                "#Manager.Dump": {

                    "target": "/redfish/v1/Managers/1/Actions/Oem/Public/Manager.Dump"

                },

                "#Manager.ExportConfiguration": {

                    "target": "/redfish/v1/Managers/1/Actions/Oem/Public/Manager.ExportConfiguration"

                },

                "#Manager.GeneralDownload": {

                    "target": "/redfish/v1/Managers/1/Actions/Oem/Public/Manager.GeneralDownload"

                },

                "#Manager.GeneralUpload": {

                    "target": "/redfish/v1/Managers/1/Actions/Oem/Public/Manager.GeneralUpload"

                },

                "#Manager.ImportConfiguration": {

                    "target": "/redfish/v1/Managers/1/Actions/Oem/Public/Manager.ImportConfiguration"

                },

                "#Manager.NodeSwitch": {

                    "target": "/redfish/v1/Managers/1/Actions/Oem/Public/Manager.NodeSwitch"

                },

                "#Manager.ResetSD": {

                    "target": "/redfish/v1/Managers/1/Actions/Oem/Public/Manager.ResetSD"

                },

                "#Manager.RestoreFactory": {

                    "[email protected]": [

                        "BMC"

                    ],

                    "target": "/redfish/v1/Managers/1/Actions/Oem/Public/Manager.RestoreFactory"

                }

            }

        }

    },

    "CommandShell": {

        "ConnectTypesSupported": [

            "SSH"

        ],

        "MaxConcurrentSessions": 20,

        "ServiceEnabled": true

    },

    "DateTime": "2017-04-17T08:28:22+08:00",

    "DateTimeLocalOffset": "UTC+08:00",

"Description": "BMC",

"DiagnosticService": {

    "@odata.id": "/redfish/v1/Managers/1/DiagnosticService"

},

    "EthernetInterfaces": {

        "@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces"

    },

    "FirmwareVersion": "0.00.14",

    "GraphicalConsole": {

        "ConnectTypesSupported": [

            "KVMIP"

        ],

        "MaxConcurrentSessions": 20,

        "ServiceEnabled": true

    },

    "Id": "1",

    "KvmService": {

        "@odata.id": "/redfish/v1/Managers/1/KvmService"

    },

    "Links": {

        "ManagerForChassis": [

            {

                "@odata.id": "/redfish/v1/Chassis/1"

            }

        ],

        "ManagerForServers": [

            {

                "@odata.id": "/redfish/v1/Systems/1"

            }

        ]

    },

    "LldpService": {

        "@odata.id": "/redfish/v1/Managers/1/LldpService"

    },

    "LogServices": {

        "@odata.id": "/redfish/v1/Managers/1/LogServices"

    },

    "ManagerType": "BMC",

    "Model": "AST2600",

    "Name": "Manager",

    "NetworkProtocol": {

        "@odata.id": "/redfish/v1/Managers/1/NetworkProtocol"

    },

    "NtpService": {

        "@odata.id": "/redfish/v1/Managers/1/NtpService"

    },

    "Oem": {

        "Public": {

            "BackupFirmwareBuildDate": "",

            "BackupFirmwareVersion": "",

            "CompletionCode": 0,

            "CurrentNodeId": "2",

            "CurrentRunningPartition": "PrimaryPartition",

            "CustomizedConfigurationModel": "",

            "DefaultLanguage": "CN",

            "Description": "Success",

"EnclosureName":"Chassis-01",

            "EnclosureNodeName": "SLOT6",

            "FirewallRules": {

                "@odata.id": "/redfish/v1/Managers/1/Oem/Public/FirewallRules"

            },

"EnergySavingService": {

                "@odata.id": "/redfish/v1/Managers/1/Oem/Public/EnergySavingService"

            },

            "FirmwareBuildDate": "2022-07-01T10:02:35+08:00",

            "FirmwareVendor": "BMC",

"IntelligentMonitoringService": {

"@odata.id": "/redfish/v1/Managers/1/Oem/Public/IntelligentMonitoringService"

},

            "InternalFirmwareVersion": "V100R001B01BBIT14_RELEASE",

            "InternalBackupFirmwareVersion": "",

"IsSupportSimulator": false,

            "JointManagement": {

                "@odata.id": "/redfish/v1/Managers/1/Oem/Public/JointManagement"

            },

            "LanguageSet": "EN, CN",

            "LoginSecurityInformation": {

                "@odata.id": "/redfish/v1/Managers/1/Oem/Public/LoginSecurityInformation"

            },

            "MaintenanceFunctionEnabled": false,

            "MasterNodeId": "2",

            "OperationLog": {

                "@odata.id": "/redfish/v1/Managers/1/Oem/Public/OperationLog"

            },

            "PFRSettings": {

                "@odata.id": "/redfish/v1/Managers/1/Oem/Public/PFRSettings"

            },

            "RestoreFactorySupported":true,

            "SOLMode": {

                "@odata.id": "/redfish/v1/Managers/1/Oem/Public/SOLMode"

            },

            "TrustedModuleConfiguration": {

                "@odata.id": "/redfish/v1/Managers/1/Oem/Public/TrustedModuleConfiguration"

            },

            "USBDeviceService": {

                "@odata.id": "/redfish/v1/Managers/1/Oem/Public/USBDeviceService"

            },

            "Wireless": {

                "@odata.id": "/redfish/v1/Managers/1/Oem/Public/Wireless"

            }

        }

    },

    "SecurityService": {

        "@odata.id": "/redfish/v1/Managers/1/SecurityService"

    },

    "SerialConsole": {

        "ConnectTypesSupported": [

            "SSH"

        ],

        "MaxConcurrentSessions": 20,

        "ServiceEnabled": true

    },

    "SerialInterfaces": {

        "@odata.id": "/redfish/v1/Managers/1/SerialInterfaces"

    },

    "ServiceEntryPointUUID": "7f673460-22e7-1000-03fe-aabbccd23552",

    "SmtpService": {

        "@odata.id": "/redfish/v1/Managers/1/SmtpService"

    },

    "SnmpService": {

        "@odata.id": "/redfish/v1/Managers/1/SnmpService"

    },

    "Status": {

        "Health": "Enabled",

        "State": "OK"

},

    "SyslogService": {

        "@odata.id": "/redfish/v1/Managers/1/SyslogService"

    },

    "UUID": "7f673460-22e7-1000-03fe-aabbccd23552",

    "VirtualMedia": {

        "@odata.id": "/redfish/v1/Managers/1/VirtualMedia"

    },

    "VncService": {

        "@odata.id": "/redfish/v1/Managers/1/VncService"

    }

}

响应码：200

【输出说明】

表4-205 查询指定管理资源信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

指定管理集合资源模型的OData 描述信息

@odata.id

字符串

指定管理集合资源的访问路径

@odata.type

字符串

指定管理集合资源的类型

Actions

Actions指定管理资源可执行的操作

Manager.Reset

对象

HDM重启

LogService.ClearOperationLog

对象

清空操作日志

Actions.Oem.Public

Actions指定管理资源自定义可执行的操作

Manager.Dump

对象

一键收集SDS

Manager.ExportConfiguration

对象

导出BIOS、BMC和RAID控制器配置

Manager.GeneralDownload

对象

下载BMC文件

Manager.GeneralUpload

对象

上传BMC文件

Manager.ImportConfiguration

对象

导入BIOS、BMC和RAID控制器配置

Manager.NodeSwitch

对象

节点控制

仅E3300G6支持

Manager.ResetSD

对象

重置SD卡

Manager.RestoreFactory

对象

恢复BMC出厂设置

CommandShell

命令控制台属性

ConnectTypesSupported

数组

支持连接类型：

"SSH"

MaxConcurrentSessions

数值

最大连接数

ServiceEnabled

布尔型

服务使能状态

DateTime

字符串

指定管理资源的系统时间

DateTimeLocalOffset

字符串

指定管理资源的时区

Description

字符串

指定管理资源的描述信息，如AST2600

DiagnosticService

对象

应急诊断信息的访问路径

EthernetInterfaces

对象

网口信息的访问路径

FirmwareVersion

字符串

HDM固件版本信息

GraphicalConsole

图形控制台属性

ConnectTypesSupported

数组

支持连接类型：

"KVMIP"

MaxConcurrentSessions

数值

最大连接数

ServiceEnabled

布尔型

服务使能状态

Id

字符串

指定管理集合资源的ID

KvmService

字符串

KVM信息资源的访问路径

Links

对象

指定管理资源的关联对象

LogServices

对象

日志服务集合资源节点的访问路径

LldpService

对象

LLDP服务资源信息访问路径

ManagerType

字符串

指定管理资源的类型：

"BMC"

Model

字符串

指定管理资源的型号：如AST2600

Name

字符串

指定管理集合资源的名称

NetworkProtocol

对象

服务信息访问路径

NtpService

对象

NTP信息访问路径

Oem.Public.BackupFirmwareBuildDate

字符串

备份区固件版本编译时间

Oem.Public.BackupFirmwareVersion

字符串

备份区固件版本

Oem.Public.CurrentRunningPartition

字符串

备分区生效 AlternatePartition

主分区生效 PrimaryPartition

Oem.Public.CustomizedConfigurationModel

字符串

定制化配置模型

Oem.Public.CurrentNodeId

字符串

当前节点编号

仅E3300G6支持

Oem.Public.RestoreFactorySupported

布尔型

是否支持恢复出厂配置

Oem.Public.DefaultLanguage

字符串

默认语言

Oem.Public.EnclosureName

字符串

刀箱名称

说明：仅刀箱支持

Oem.Public.EnclosureNodeName

字符串

刀箱BMC节点名称

说明：仅刀箱支持

Oem.Public.FirewallRules

对象

防火墙资源路径

Oem.Public.EnergySavingService

对象

节能服务信息资源路径

Oem.Public.FirmwareVendor

字符串

指定系统管理资源的FW的厂商

Oem.Public.FirmwareBuildDate

字符串

固件编译时间

Oem.Public.InternalFirmwareVersion

字符串

内部固件版本（主分区）

Oem.Public.InternalBackupFirmwareVersion

字符串

内部固件版本（备分区）

Oem.Public.IsSupportSimulator

布尔

模拟器标志

Oem.Public.LanguageSet

字符串

可支持语言

Oem.Public.JointManagement

对象

联合管理资源路径

Oem.Public.LoginSecurityInformation

对象

安全登录信息资源路径

Oem.Public.MaintenanceFunctionEnabled

布尔

维护开关使能状态

Oem.Public.MasterNodeId

字符串

主节点编号

仅E3300G6支持

Oem.Public.IntelligentMonitoringService

字符串

智能监控服务资源路径

Oem.Public.OperationLog

对象

所有操作日志列表资源路径

Oem.Public.PFRSettings

对象

平台固件保护恢复（PFR）配置路径

Oem.Public.SOLMode

对象

串口重定向配置资源路径

Oem.Public.TrustedModuleConfiguration

对象

可信密码模块状态配置资源路径

Oem.Public.USBDeviceService

对象

服务U盘资源路径

Oem.Public.Wireless

对象

无线管理资源的访问路径，仅G5部分产品支持，HDM3软件暂不支持

SerialConsole

串口控制台属性

 

ConnectTypesSupported

数组

支持连接类型：

"SSH"

MaxConcurrentSessions

数值

最大连接数

ServiceEnabled

布尔型

服务使能状态

SecurityService

对象

安全服务资源路径

SerialInterfaces

对象

串口信息访问路径

ServiceEntryPointUUID

字符串

服务入口点标识符

SmtpService

对象

SMTP信息访问路径

SnmpService

对象

SNMP信息访问路径

Status

对象

指定管理资源的状态， 包括：

Health：管理资源健康状态

State：管理资源使能状态

SyslogService

对象

Syslog信息访问路径

UUID

字符串

指定管理资源的全局唯一标识符

VirtualMedia

对象

VirtualMedia信息访问路径

VncService

对象

VNC信息访问路径

 

【修改记录】

(1)     HDM2-1.54：对个别“字段说明”，针对智能预测服务增加IntelligentMonitoringService字段；

(2)     HDM2-1.59：新增EnclosureName、EnclosureNodeName字段；

(3)     HDM2-2.04：修改Model字段说明；

(4)     HDM2-2.05：新增Oem.Public.IsSupportSimulator字段；

(5)     HDM2-2.05：新增DiagnosticService字段；

(6)     HDM2-2.09：新增Manager.NodeSwitch 、Oem.Public.CurrentNodeId 、Oem.Public.MasterNodeId字段

(7)     HDM3-1.14：HDM3暂不支持无线管理资源Oem.Public.Wireless

(8)     HDM2-2.12：删除Telnet字段；

(9)     HDM3-1.16：删除Telnet字段；

 

4.4.3  修改服务器指定管理资源信息

【功能描述】

修改服务器指定管理资源(时区)信息。

【所属权限模块】

常规配置

【所属系统锁定类型】

BMC配置锁定

【命令格式】

PATCH https://device_ip/redfish/v1/Managers/manager_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:ifmatch_value

【请求消息体】

{ 

  "DateTimeLocalOffset": local_offset,

"UUID": uuid_value

}

【参数说明】

表4-206 修改服务器指定管理资源信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

ifmatch_value

请求消息的匹配参数

可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）

DateTimeLocalOffset

字符串

时区信息

UUID

字符串

管理资源的UUID

 

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/Managers/1

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

"DateTimeLocalOffset": "UTC-04:30",

"UUID":"7f673460-22e7-1000-03fe-aabbccd23552"

}

【应答示例】

{

    "@odata.context":"/redfish/v1/$metadata#Manager.Manager(*)",

    "@odata.id":"/redfish/v1/Managers/1",

    "@odata.type":"#Manager.v1_10_0.Manager",

    "Actions":{

        "#LogService.ClearOperationLog":{

            "@Redfish.AllowableValues":[

                ""

            ],

            "target":"/redfish/v1/Managers/1/LogServices/Actions/LogService.ClearOperationLog"

        },

        "#Manager.Reset":{

            "[email protected]":[

                "ForceRestart"

            ],

            "target":"/redfish/v1/Managers/1/Actions/Manager.Reset"

        },

        "Oem":{

            "Public":{

                "#Manager.Dump":{

                    "target":"/redfish/v1/Managers/1/Actions/Oem/Public/Manager.Dump"

                },

                "#Manager.ExportConfiguration":{

                    "target":"/redfish/v1/Managers/1/Actions/Oem/Public/Manager.ExportConfiguration"

                },

                "#Manager.GeneralDownload":{

                    "target":"/redfish/v1/Managers/1/Actions/Oem/Public/Manager.GeneralDownload"

                },

                "#Manager.GeneralUpload":{

                    "target":"/redfish/v1/Managers/1/Actions/Oem/Public/Manager.GeneralUpload"

                },

                "#Manager.ImportConfiguration":{

                    "target":"/redfish/v1/Managers/1/Actions/Oem/Public/Manager.ImportConfiguration"

                },

                "#Manager.ResetSD":{

                    "target":"/redfish/v1/Managers/1/Actions/Oem/Public/Manager.ResetSD"

                },

                "#Manager.RestoreFactory":{

                    "[email protected]":[

                        "BMC"

                    ],

                    "target":"/redfish/v1/Managers/1/Actions/Oem/Public/Manager.RestoreFactory"

                }

            }

        }

    },

    "CommandShell":{

        "ConnectTypesSupported":[

            "SSH"

        ],

        "MaxConcurrentSessions":20,

        "ServiceEnabled":true

    },

    "DateTime":"2017-04-16T19:59:23-04:30",

    "DateTimeLocalOffset":"UTC-04:30",

"Description":"BMC",

"DiagnosticService": {

    "@odata.id": "/redfish/v1/Managers/1/DiagnosticService"

},

    "EthernetInterfaces":{

        "@odata.id":"/redfish/v1/Managers/1/EthernetInterfaces"

    },

    "FirmwareVersion":"0.00.14",

    "GraphicalConsole":{

        "ConnectTypesSupported":[

            "KVMIP"

        ],

        "MaxConcurrentSessions":20,

        "ServiceEnabled":true

    },

    "Id":"1",

    "KvmService":{

        "@odata.id":"/redfish/v1/Managers/1/KvmService"

    },

    "Links":{

        "ManagerForChassis":[

            {

                "@odata.id":"/redfish/v1/Chassis/1"

            }

        ],

        "ManagerForServers":[

            {

                "@odata.id":"/redfish/v1/Systems/1"

            }

        ]

    },

    "LldpService":{

        "@odata.id":"/redfish/v1/Managers/1/LldpService"

    },

    "LogServices":{

        "@odata.id":"/redfish/v1/Managers/1/LogServices"

    },

    "ManagerType":"BMC",

    "Model":"AST2600",

    "Name":"Manager",

    "NetworkProtocol":{

        "@odata.id":"/redfish/v1/Managers/1/NetworkProtocol"

    },

    "NtpService":{

        "@odata.id":"/redfish/v1/Managers/1/NtpService"

    },

    "Oem":{

        "Public":{

            "BackupFirmwareBuildDate":"",

            "BackupFirmwareVersion":"",

            "CompletionCode":0,

            "CurrentRunningPartition":"PrimaryPartition",

            "CustomizedConfigurationModel":"",

            "DefaultLanguage":"CN",

            "Description":"Success",

"EnclosureName":null,

"EnclosureNodeName":null,

            "FirewallRules":{

                "@odata.id":"/redfish/v1/Managers/1/Oem/Public/FirewallRules"

            },

            "EnergySavingService":{

                "@odata.id":"/redfish/v1/Managers/1/Oem/Public/EnergySavingService"

            },

            "FirmwareBuildDate":"2022-06-30T21:32:35-04:30",

            "FirmwareVendor":"BMC",

            "InternalFirmwareVersion":"V100R001B01BBIT14_RELEASE",

            "InternalBackupFirmwareVersion": "",

"IsSupportSimulator": false,

            "JointManagement":{

                "@odata.id":"/redfish/v1/Managers/1/Oem/Public/JointManagement"

            },

            "LanguageSet":"EN, CN",

            "LoginSecurityInformation":{

                "@odata.id":"/redfish/v1/Managers/1/Oem/Public/LoginSecurityInformation"

            },

            "MaintenanceFunctionEnabled":false,

            "OperationLog":{

                "@odata.id":"/redfish/v1/Managers/1/Oem/Public/OperationLog"

            },

            "PFRSettings":{

                "@odata.id":"/redfish/v1/Managers/1/Oem/Public/PFRSettings"

            },

            "RestoreFactorySupported":true,

            "SOLMode":{

                "@odata.id":"/redfish/v1/Managers/1/Oem/Public/SOLMode"

            },

            "TrustedModuleConfiguration":{

                "@odata.id":"/redfish/v1/Managers/1/Oem/Public/TrustedModuleConfiguration"

            },

            "USBDeviceService":{

                "@odata.id":"/redfish/v1/Managers/1/Oem/Public/USBDeviceService"

            },

            "Wireless":{

                "@odata.id":"/redfish/v1/Managers/1/Oem/Public/Wireless"

            }

        }

    },

    "SecurityService":{

        "@odata.id":"/redfish/v1/Managers/1/SecurityService"

    },

    "SerialConsole":{

        "ConnectTypesSupported":[

            "SSH"

        ],

        "MaxConcurrentSessions":20,

        "ServiceEnabled":true

    },

    "SerialInterfaces":{

        "@odata.id":"/redfish/v1/Managers/1/SerialInterfaces"

    },

    "ServiceEntryPointUUID":"7f673460-22e7-1000-03fe-aabbccd23552",

    "SmtpService":{

        "@odata.id":"/redfish/v1/Managers/1/SmtpService"

    },

    "SnmpService":{

        "@odata.id":"/redfish/v1/Managers/1/SnmpService"

    },

    "Status":{

        "Health":"Enabled",

        "State":"OK"

},

    "SyslogService":{

        "@odata.id":"/redfish/v1/Managers/1/SyslogService"

    },

    "UUID":"7f673460-22e7-1000-03fe-aabbccd23552",

    "VirtualMedia":{

        "@odata.id":"/redfish/v1/Managers/1/VirtualMedia"

    },

    "VncService":{

        "@odata.id":"/redfish/v1/Managers/1/VncService"

}

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回参数说明同【查询指定管理资源信息】

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

(2)     HDM2-2.05：新增UUID字段；

(3)     HDM2-2.12：删除Telnet服务字段；

(4)     HDM3-1.16：删除Telnet服务字段；

 

4.4.4  查询NTP信息

【功能描述】

查询NTP信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/NtpService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-207 查询NTP信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Managers/1/NtpService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#NtpService.NtpService",

    "@odata.id": "/redfish/v1/Managers/1/NtpService",

    "@odata.type": "#NtpService.v1_0_0.NtpService",

    "AlternateNtpServer": "2.cn.pool.ntp.org",

"Description": "NtpService Gettings",

"MaxPollingInterval": 2592000,

"MinPollingInterval": 600,

    "NtpAddressOrigin": "Static",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "DateTime": "2019-02-18T17:51:02+08:00",

            "Description": "Success",

            "RefreshInterval": 3600,

"SynchronousResult": "Failed",

            "TertiaryNtpServer": "",

            "TimeZone": "UTC+08:00"

        }

    },

    "PreferredNtpServer": "1.cn.pool.ntp.org",

    "ServiceEnabled": true

}

响应码：200

【输出说明】

表4-208 查询NTP信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

NTP信息资源模型的OData 描述信息

@odata.id

字符串

NTP信息资源的访问路径

@odata.type

字符串

NTP信息资源的类型

AlternateNtpServer

字符串

次选NTP服务地址

PreferredNtpServer

字符串

首选NTP服务地址

Description

字符串

NTP服务资源描述

MaxPollingInterval

数值

最大轮询间隔值，单位秒

MinPollingInterval

数值

最小轮询间隔值，单位秒

NtpAddressOrigin

字符串

NTP服务器地址模式，当前只支持Static

ServiceEnabled

布尔型

NTP服务器是否使能

Oem.Public.TimeZone

字符串

时区格式举例：

UTC+08:00

Oem.Public.SynchronousResult

字符串

时间同步结果

Failed：同步失败

Successful：同步成功

Not Synchronized：未执行同步

Oem.Public.TertiaryNtpServer

字符串

三级NTP服务地址

Oem.Public.RefreshInterval

数值

NTP刷新周期，单位秒,最小600秒，最大2592000秒

Oem.Public.DateTime

字符串

时间戳格式举例：

2019-02-14T20:21:36+08:00

 

【修改记录】

(1)     HDM2-2.04：新增MaxPollingInterval和MinPollingInterval字段；

 

4.4.5  设置NTP信息

【功能描述】

设置NTP信息。

【所属权限模块】

常规配置

【所属系统锁定类型】

BMC配置锁定

【命令格式】

PATCH https://device_ip/redfish/v1/Managers/manager_id/NtpService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:ifmatch_value

【请求消息体】

{

    "AlternateNtpServer": AlternateNtpServer,

"PreferredNtpServer": PreferredNtpServer,

    "ServiceEnabled": true,

    "Oem":{

     "Public":{

               "TimeZone":"UTC+03:00",

"TertiaryNtpServer": TertiaryNtpServer,

"RefreshInterval":652

               }

           }

}

【参数说明】

表4-209 设置NTP信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

ifmatch_value

请求消息的匹配参数

可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）

PreferredNtpServer

字符串

首选NTP服务地址

AlternateNtpServer

字符串

次选NTP服务地址

ServiceEnabled

布尔型

NTP服务器是否使能

Oem.Public.TimeZone

字符串

时区格式为："UTC+03:00"

[需要兼容原有的风格"UTC+3"]

Oem.Public.TertiaryNtpServer

字符串

三级NTP服务地址

Oem.Public.RefreshInterval

数值

NTP刷新周期，单位秒,最小600秒，最大2592000秒

 

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/Managers/1/NtpService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

    "AlternateNtpServer": "2.cn.pool.ntp.org",

"PreferredNtpServer": "1.cn.pool.ntp.org",

    "ServiceEnabled": true,

    "Oem":{

     "Public":{

               "TimeZone":"UTC+08:00",

"TertiaryNtpServer": "192.168.1.3",

"RefreshInterval":3600

               }

           }

}

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#NtpService.NtpService",

    "@odata.id": "/redfish/v1/Managers/1/NtpService",

    "@odata.type": "#NtpService.v1_0_0.NtpService",

    "AlternateNtpServer": "2.cn.pool.ntp.org",

"Description": "NtpService Gettings",

"MaxPollingInterval": 2592000,

"MinPollingInterval": 600,

    "NtpAddressOrigin": "Static",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "DateTime": "2019-02-18T17:51:02+08:00",

            "Description": "Success",

            "RefreshInterval": 3600,

"SynchronousResult": "Failed",

            "TertiaryNtpServer": "192.168.1.3",

            "TimeZone": "UTC+08:00"

        }

    },

    "PreferredNtpServer": "1.cn.pool.ntp.org",

    "ServiceEnabled": true

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回参数说明同【查询NTP信息】

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

 

4.4.6  查询SNMP信息

【功能描述】

查询SNMP信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/SnmpService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-210 查询SNMP信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

manager_id

管理资源的ID

当前所有机型取值为1

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Managers/1/SnmpService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#SnmpService.SnmpService",

    "@odata.id": "/redfish/v1/Managers/1/SnmpService",

    "@odata.type": "#SnmpService.v1_0_0.SnmpService",

    "Actions": {

        "#SnmpService.SubmitTestEvent": {

            "target": "/redfish/v1/Managers/1/SnmpService/Actions/SnmpService.SubmitTestEvent"

        }

    },

    "Description": "SnmpService Gettings",

    "Id": "SnmpService",

    "LongPasswordEnabled": false,

    "Name": "SNMP",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "ReadOnlyCommunity": "",

    "ReadWriteCommunity": null,

    "SnmpTrapNotification": {

        "AlarmSeverity": "Minor+Major+Critical",

        "CommunityName": "public",

        "Oem": {

            "Public": {

                "SystemContact": "",

                "SystemLocation": ""

            }

        },

        "ServiceEnabled": true,

        "TrapMode": "NodeMode",

        "TrapServer": [

            {

                "Enabled": true,

                "MemberId": "1",

                "TrapServerAddress": "",

                "TrapServerPort": 162

            },

            {

                "Enabled": true,

                "MemberId": "2",

                "TrapServerAddress": "",

                "TrapServerPort": 162

            },

            {

                "Enabled": true,

                "MemberId": "3",

                "TrapServerAddress": "",

                "TrapServerPort": 162

            },

            {

                "Enabled": true,

                "MemberId": "4",

                "TrapServerAddress": "",

                "TrapServerPort": 162

            },

            {

                "Enabled": true,

                "MemberId": "5",

                "TrapServerAddress": "",

                "TrapServerPort": 162

            },

            {

                "Enabled": true,

                "MemberId": "6",

                "TrapServerAddress": "",

                "TrapServerPort": 162

            },

            {

                "Enabled": true,

                "MemberId": "7",

                "TrapServerAddress": "",

                "TrapServerPort": 162

            },

            {

                "Enabled": true,

                "MemberId": "8",

                "TrapServerAddress": "",

                "TrapServerPort": 162

            }

        ],

        "TrapServerIdentity": "HDM",

        "TrapV3User": "",

        "TrapVersion": "v1"

    },

    "SnmpV1Enabled": false,

    "SnmpV2CEnabled": true,

    "SnmpV3AuthProtocol": "",

"SnmpV3Enabled": true,

"SnmpV3EngineID": "80001f8880a933392964005259",

    "SnmpV3PrivProtocol": ""

}

响应码：200

【输出说明】

表4-211 查询SNMP信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

SNMP信息资源模型的OData 描述信息

@odata.id

字符串

SNMP信息资源的访问路径

@odata.type

字符串

SNMP信息资源的类型

Actions

Actions指定管理资源可执行的操作

SnmpService.SubmitTestEvent

对象

SNMP测试报警操作

Description

字符串

SNMP资源描述

Id

字符串

SNMP资源的ID

LongPasswordEnabled

布尔型

超长口令使能状态

Name

字符串

SNMP资源的名称

ReadOnlyCommunity

字符串

只读团体名，最大长度32

字符串为空表明是删除

ReadWriteCommunity

字符串

读写团体名，最大长度32

字符串为空表明是删除

SnmpTrapNotification.CommunityName

字符串

Trap团体名

SnmpTrapNotification.ServiceEnabled

布尔型

Trap服务使能状态

SnmpTrapNotification.TrapMode

字符串

Trap模式：

NodeMode：模块OID模式

EventMode：事件OID模式

EventCodeMode：事件码模式

SnmpTrapNotification.AlarmSeverity

字符串

可修改的告警等级，包括：

"Critical"

"Major+Critical"

"Minor+Major+Critical"

"All"

为腾讯CID时，等级包括：

"Critical"

"Warning+Critical"

"All"

SnmpTrapNotification.TrapServer

Trap服务器参数数组集合

TrapServer.Enabled

布尔型

Trap服务器使能

TrapServer.MemberId

字符串

Trap服务器ID：1~8

TrapServer.TrapServerAddress

字符串

Trap服务器地址

TrapServer.TrapServerPort

数值

Trap服务器端口号

SnmpTrapNotification.TrapServerIdentity

字符串

主机标识

SnmpTrapNotification.TrapV3User

字符串

V3用户

SnmpTrapNotification.TrapVersion

字符串

Trap版本

SnmpTrapNotification.Oem.Public.SystemLocation

字符串

节点位置

SnmpTrapNotification.Oem.Public.SystemContact

字符串

联系方式

SnmpV1Enabled

布尔型

Snmp V1使能

SnmpV2CEnabled

布尔型

Snmp V2C使能

SnmpV3AuthProtocol

字符串

SnmpV3鉴权算法：

sha

md5

sha256

sha384

sha512

SnmpV3Enabled

布尔型

Snmp V3使能

SnmpV3EngineID

字符串

引擎ID

SnmpV3PrivProtocol

字符串

SnmpV3加密算法：

des

aes

aes192

aes256

 

4.4.7  设置SNMP信息

【功能描述】

设置SNMP信息。

说明：设置SNMP V3用户前需使能对应用户的SNMP扩展权限。

【所属权限模块】

常规配置

【所属系统锁定类型】

BMC配置锁定

【命令格式】

PATCH https://device_ip/redfish/v1/Managers/manager_id/SnmpService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:ifmatch_value

【请求消息体】

{

  "SnmpV1Enabled":v1_enabled,

  "SnmpV2CEnabled":v2c_enabled,

  "SnmpV3Enabled":v3_enabled,

  "LongPasswordEnabled":long_password_enabled,

  "ReadOnlyCommunity":read_only_community,

  "ReadWriteCommunity":read_write_community,

  "CommunityName":community_name,

  "ServiceEnabled":service_enabled,

  "TrapVersion":trap_version,

  "TrapV3User":user_name,

  "AlarmSeverity": alarm_severity,

  "TrapMode": trap_mode,

  "Oem": {

      "Public": {

          "SystemLocation": location,

          "SystemContact": contact

      }

  },

  "TrapServer":[

      {

          "MemberId":"1",

          "Enabled":true,

          "TrapServerPort":TrapServer1_portnumber,

          "TrapServerAddress": TrapServer1_address

      },

      ...

  ]

}

或

{

  "SnmpV1Enabled":v1_enabled,

  "SnmpV2CEnabled":v2c_enabled,

  "SnmpV3Enabled":v3_enabled,

  "LongPasswordEnabled":long_password_enabled,

  "ReadOnlyCommunity":read_only_community,

  "ReadWriteCommunity":read_write_community,

  "SnmpTrapNotification": {

      "AlarmSeverity": alarm_severity,

      "CommunityName":community_name,

      "Oem": {

          "Public": {

              "SystemLocation": location,

              "SystemContact": contact

          }

      },

      "ServiceEnabled":service_enabled,

      "TrapMode": trap_mode,

      "TrapServer":[

          {

              "MemberId":"1",

              "Enabled":true,

              "TrapServerPort":TrapServer1_portnumber,

              "TrapServerAddress": TrapServer1_address

          },

          ...

      ],

      "TrapV3User":user_name,

      "TrapVersion":trap_version

  },

}

【参数说明】

表4-212 设置SNMP信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

manager_id

管理资源的ID

当前所有机型取值为1

ifmatch_value

请求消息的匹配参数

可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

SnmpV1Enabled

布尔型

SNMP协议版本1使能状态

SnmpV2CEnabled

布尔型

SNMP协议版本2使能状态

SnmpV3Enabled

布尔型

SNMP协议版本3使能状态

LongPasswordEnabled

布尔型

超长口令使能状态

ReadOnlyCommunity

字符串

只读团体名，最大长度32

字符串为空表明是删除

ReadWriteCommunity

字符串

读写团体名，最大长度32

字符串为空表明是删除

SnmpTrapNotification

告警Trap属性

SnmpTrapNotification.CommunityName

字符串

Trap团体名，最大长度31

V3用户时，设置团体名成功，但不会生效

SnmpTrapNotification.ServiceEnabled

布尔型

Trap服务使能

SnmpTrapNotification.TrapVersion

字符串

Trap版本：v1、v2c、v3

注：选择v3时，不需要携带CommunityName参数

SnmpTrapNotification.TrapV3User

字符串

Trap V3用户

SnmpTrapNotification.AlarmSeverity

字符串

告警等级：

可修改的告警等级，包括：

"Critical"

"Major+Critical"

"Minor+Major+Critical"

"All"

为腾讯CID时，等级包括：

"Critical"

"Warning+Critical"

"All"

SnmpTrapNotification.TrapMode

字符串

Trap模式：

NodeMode：模块OID模式

EventMode：事件OID模式

EventCodeMode：事件码模式

SnmpTrapNotification.TrapServer

Trap服务器参数数组集合

注：设置V3的TrapServer时，需要设置TrapV3User选项

SnmpTrapNotification.TrapServer.MemberId

字符串

Trap服务器ID：1~8

SnmpTrapNotification.TrapServer.Enabled

布尔型

Trap服务器使能

SnmpTrapNotification.TrapServer.TrapServerPort

数值

Trap服务器端口号

SnmpTrapNotification.TrapServer.TrapServerAddress

字符串

Trap服务器地址，支持IPv4、IPv6和域名格式

SnmpTrapNotification.Oem.Public.SystemLocation

字符串

节点位置

SnmpTrapNotification.Oem.Public.SystemContact

字符串

联系方式

 

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/Managers/1/SnmpService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

  "ServiceEnabled":true,

  "TrapVersion":"v3",

  "TrapV3User":"User3",

  "AlarmSeverity": "All",

  "TrapMode": "NodeMode",

  "Oem": {

      "Public": {

          "SystemLocation": "HangZhou",

          "SystemContact": "www.h3c.com"

      }

  },

  "TrapServer":[

      {

          "MemberId":"1",

          "Enabled":true,

          "TrapServerPort":162,

          "TrapServerAddress": "192.168.30.111"

      },

      {

          "MemberId":"2",

          "Enabled":true,

          "TrapServerPort":162,

          "TrapServerAddress": "192.168.30.112"

      },

      {

          "MemberId":"3",

          "Enabled":true,

          "TrapServerPort":162,

          "TrapServerAddress": "192.168.30.113"

      },

      {

          "MemberId":"4",

          "Enabled":true,

          "TrapServerPort":162,

          "TrapServerAddress": "192.168.30.114"

      },

      {

          "MemberId":"5",

          "Enabled":true,

          "TrapServerPort":162,

          "TrapServerAddress": "192.168.30.115"

      },

      {

          "MemberId":"6",

          "Enabled":true,

          "TrapServerPort":162,

          "TrapServerAddress": "192.168.30.116"

      },

      {

          "MemberId":"7",

          "Enabled":true,

          "TrapServerPort":162,

          "TrapServerAddress": "192.168.30.117"

      },

      {

          "MemberId":"8",

          "Enabled":true,

          "TrapServerPort":162,

          "TrapServerAddress": "192.168.30.118"

      }

  ]

}

或

{

  "SnmpTrapNotification":{

      "ServiceEnabled":true,

      "TrapVersion":"v3",

      "TrapV3User":"User3",

      "AlarmSeverity": "All",

      "TrapMode": "NodeMode",

      "Oem": {

          "Public": {

              "SystemLocation": "HangZhou",

              "SystemContact": "www.h3c.com"

          }

      },

      "TrapServer":[

          {

              "MemberId":"1",

              "Enabled":true,

              "TrapServerPort":162,

              "TrapServerAddress": "192.168.30.111"

          },

          {

              "MemberId":"2",

              "Enabled":true,

              "TrapServerPort":162,

              "TrapServerAddress": "192.168.30.112"

          },

          {

              "MemberId":"3",

              "Enabled":true,

              "TrapServerPort":162,

              "TrapServerAddress": "192.168.30.113"

          },

          {

              "MemberId":"4",

              "Enabled":true,

              "TrapServerPort":162,

              "TrapServerAddress": "192.168.30.114"

          },

          {

              "MemberId":"5",

              "Enabled":true,

              "TrapServerPort":162,

              "TrapServerAddress": "192.168.30.115"

          },

          {

              "MemberId":"6",

              "Enabled":true,

              "TrapServerPort":162,

              "TrapServerAddress": "192.168.30.116"

          },

          {

              "MemberId":"7",

              "Enabled":true,

              "TrapServerPort":162,

              "TrapServerAddress": "192.168.30.117"

          },

          {

              "MemberId":"8",

              "Enabled":true,

              "TrapServerPort":162,

              "TrapServerAddress": "192.168.30.118"

          }

      ]

  }

}

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#SnmpService.SnmpService",

    "@odata.id": "/redfish/v1/Managers/1/SnmpService",

    "@odata.type": "#SnmpService.v1_0_0.SnmpService",

    "Actions": {

        "#SnmpService.SubmitTestEvent": {

            "target": "/redfish/v1/Managers/1/SnmpService/Actions/SnmpService.SubmitTestEvent"

        }

    },

    "Description": "SnmpService Gettings",

    "Id": "SnmpService",

    "LongPasswordEnabled": false,

    "Name": "SNMP",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "ReadOnlyCommunity": "",

    "ReadWriteCommunity": "",

    "SnmpTrapNotification": {

        "AlarmSeverity": "All",

        "CommunityName": "public",

        "Oem": {

            "Public": {

                "SystemContact": "www.h3c.com",

                "SystemLocation": "HangZhou"

            }

        },

        "ServiceEnabled": true,

        "TrapMode": "NodeMode",

        "TrapServer": [

            {

                "Enabled": true,

                "MemberId": "1",

                "TrapServerAddress": "192.168.30.111",

                "TrapServerPort": 162

            },

            {

                "Enabled": true,

                "MemberId": "2",

                "TrapServerAddress": "192.168.30.112",

                "TrapServerPort": 162

            },

            {

                "Enabled": true,

                "MemberId": "3",

                "TrapServerAddress": "192.168.30.113",

                "TrapServerPort": 162

            },

            {

                "Enabled": true,

                "MemberId": "4",

                "TrapServerAddress": "192.168.30.114",

                "TrapServerPort": 162

            },

            {

                "Enabled": true,

                "MemberId": "5",

                "TrapServerAddress": "192.168.30.115",

                "TrapServerPort": 162

            },

            {

                "Enabled": true,

                "MemberId": "6",

                "TrapServerAddress": "192.168.30.116",

                "TrapServerPort": 162

            },

            {

                "Enabled": true,

                "MemberId": "7",

                "TrapServerAddress": "192.168.30.117",

                "TrapServerPort": 162

            },

            {

                "Enabled": true,

                "MemberId": "8",

                "TrapServerAddress": "192.168.30.118",

                "TrapServerPort": 162

            }

        ],

        "TrapServerIdentity": "HDM123456123456123456123456123456123456123456123456123456123456",

        "TrapV3User": "User3",

        "TrapVersion": "v3"

    },

    "SnmpV1Enabled": false,

    "SnmpV2CEnabled": true,

    "SnmpV3AuthProtocol": "SHA",

"SnmpV3Enabled": true,

"SnmpV3EngineID": "80001f8880a933392964005259",

    "SnmpV3PrivProtocol": "DES"

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回体同【查询SNMP信息】

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

(2)     HDM2-2.04、HDM3-1.10：新增SnmpTrapNotification对象，该对象可选存在，相同字段不在该对象下的值比在该对象下的值优先生效；

 

4.4.8  发送SNMP测试警报

【功能描述】

发送SNMP测试警报。

【所属权限模块】

常规配置

【命令格式】

POST https://device_ip/redfish/v1/Managers/manager_id/SnmpService/Actions/SnmpService.SubmitTestEvent

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"MemberId": id                             

}

【参数说明】

表4-213 发送SNMP测试警报参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

manager_id

管理资源的ID

当前所有机型取值为1

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

MemberId

字符串

Trap成员ID：1~8

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/Managers/1/SnmpService/Actions/SnmpService.SubmitTestEvent

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"MemberId":"1"

}

【应答示例】

{

"Oem": {

       "Public": {

           "CompletionCode": 0,

           "Description": "Success"

       }

 },

"error": {

       "@Message.ExtendedInfo": [

           {

               "@odata.type": "#Message.v1_1_1.Message",

               "Message": "Successfully Completed Request",

               "MessageArgs": [],

               "MessageId": "Base.1.8.1.Success",

               "MessageSeverity": "OK",

               "Resolution": "None"

           }

       ],

        "code":"Base.1.8.1.Success",

        "message":"Successfully Completed Request"

    }

}

}

响应码：200

【输出说明】

表4-214 发送SNMP测试警报输出参数说明

字段

类型

字段说明

code

字符串

指示消息注册表中特定消息ID的字符串

message

字符串

与消息注册表中的消息对应的易读的错误消息

@Message.ExtendedInfo

消息扩展信息

@odata.type

字符串

消息资源的OData描述信息

MessageId

字符串

消息ID

Message

字符串

详细信息

MessageArgs

数组

信息参数

MessageSeverity

字符串

严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical

Resolution

字符串

解决建议

 

【修改记录】

(1)     HDM2-2.04：Message.ExtendedInfo前添加error节点，并且在error节点下增加code和message字段；

 

4.4.9  查询SMTP信息

【功能描述】

查询SMTP信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/SmtpService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-215 查询SMTP信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Managers/1/SmtpService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【响应样例】

{

  "@odata.context": "/redfish/v1/$metadata#SmtpService.SmtpService(AnonymousLoginEnabled,ServerPort,Name,ServiceEnabled,Id,RecipientAddresses,TLSEnabled,SenderAddress,Description,AlarmSeverity,Actions,ServerAddress)",

  "@odata.id": "/redfish/v1/Managers/1/SmtpService",

  "@odata.type": "#SmtpService.v1_0_0.SmtpService",

  "Actions": {

    "#SmtpService.SubmitTestEvent": {

      "target": "/redfish/v1/Managers/1/SmtpService/Actions/SmtpService.SubmitTestEvent"

    }

  },

  "AlarmSeverity": "Critical",

  "AnonymousLoginEnabled": false,

  "Description": "Smtpservice Gettings",

  "Id": "Smtp",

  "Name": "Smtp",

  "Oem": {

    "Public": {

      "CompletionCode": 0,

      "Description": "Success",

      "Subject": [

        "ProductName",

        "HostName",

        "AssetTag",

        "BoardSerialNumber"

      ]

    }

  },

  "RecipientAddresses": [

    {

      "EmailAddress": "[email protected]",

      "EmailSubject": "111",

      "Enabled": true,

      "MemberId": "1"

    },

    {

      "EmailAddress": "",

      "EmailSubject": "",

      "Enabled": false,

      "MemberId": "2"

    },

    {

      "EmailAddress": "",

      "EmailSubject": "",

      "Enabled": false,

      "MemberId": "3"

    },

    {

      "EmailAddress": "",

      "EmailSubject": "",

      "Enabled": false,

      "MemberId": "4"

    },

    {

      "EmailAddress": "",

      "EmailSubject": "",

      "Enabled": false,

      "MemberId": "5"

    },

    {

      "EmailAddress": "",

      "EmailSubject": "",

      "Enabled": false,

      "MemberId": "6"

    },

    {

      "EmailAddress": "",

      "EmailSubject": "",

      "Enabled": false,

      "MemberId": "7"

    },

    {

      "EmailAddress": "",

      "EmailSubject": "",

      "Enabled": false,

      "MemberId": "8"

    },

    {

      "EmailAddress": "",

      "EmailSubject": "",

      "Enabled": false,

      "MemberId": "9"

    },

    {

      "EmailAddress": "",

      "EmailSubject": "",

      "Enabled": false,

      "MemberId": "10"

    },

    {

      "EmailAddress": "",

      "EmailSubject": "",

      "Enabled": false,

      "MemberId": "11"

    },

    {

      "EmailAddress": "",

      "EmailSubject": "",

      "Enabled": false,

      "MemberId": "12"

    },

    {

      "EmailAddress": "",

      "EmailSubject": "",

      "Enabled": false,

      "MemberId": "13"

    },

    {

      "EmailAddress": "",

      "EmailSubject": "",

      "Enabled": false,

      "MemberId": "14"

    },

    {

      "EmailAddress": "",

      "EmailSubject": "",

      "Enabled": false,

      "MemberId": "15"

    }

  ],

  "SenderAddress": "",

  "SenderPassword": null,

  "SenderUserName": "",

  "ServerAddress": "",

  "ServerPort": 25,

  "ServiceEnabled": true,

  "TLSEnabled": true

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-216 查询SMTP输出参数说明

字段

类型

字段说明

 

@odata.context

字符串

SMTP信息资源模型的OData 描述信息

 

@odata.id

字符串

SMTP信息资源的访问路径

 

@odata.type

字符串

SMTP信息资源的类型

 

Actions

Actions指定管理资源可执行的操作

SmtpService.SubmitTestEvent

对象

SMTP测试报警操作

AlarmSeverity

字符串

可修改的告警等级，包括：

"Critical"

"Major+Critical"

"Minor+Major+Critical"

"All"

为腾讯CID时，等级包括：

"Critical"

"Warning+Critical"

"All"

 

AnonymousLoginEnabled

布尔型

匿名登录使能

 

SenderAddress

字符串

发送者地址

 

ServerAddress

字符串

服务地址

 

ServerPort

数值

服务端口

 

ServiceEnabled

布尔型

服务使能

 

TLSEnabled

布尔型

TLS使能

 

SenderUserName

字符串

发送者用户名

 

RecipientAddresses.EmailAddress

字符串

接收者邮件地址

 

RecipientAddresses.Enabled

布尔型

接收者邮件使能

 

RecipientAddresses.MemberId

字符串

接收告警邮件地址的ID

 

RecipientAddresses.EmailSubject

字符串

主题

 

Oem.Public.Subject

数组

邮件主题定制：

产品名称"ProductName"

主机名称"HostName"

资产标签"AssetTag"

主板序列号"BoardSerialNumber"

 

 

4.4.10  设置SMTP信息

【功能描述】

设置SMTP信息。

【所属权限模块】

常规配置

【所属系统锁定类型】

BMC配置锁定

【命令格式】

PATCH https://device_ip/redfish/v1/Managers/manager_id/SmtpService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:ifmatch_value

【请求消息体】

{

    "ServiceEnabled":true,

    "ServerAddress":serveraddress,

    "ServerPort":portnumber,

    "TLSEnabled":true,

    "AnonymousLoginEnabled":false,

    "SenderUserName":username,

    "SenderPassword":password,

"SenderAddress":senderaddress,

"AlarmSeverity": AlarmSeverity_value,

"Oem": {

        "Public": {

            "Subject":[

                "ProductName",

                "AssetTag",

                "BoardSerialNumber",

                "HostName"

] ,

"RSAEncryptionEnabled":true

        }

},

"RecipientAddresses":[

      {

          "MemberId":"1",

          "Enabled":true,

          "EmailSubject":"1",

"EmailAddress":""

      }

      ……

]

}

【参数说明】

表4-217 设置SMTP信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

ifmatch_value

请求消息的匹配参数

可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）

ServiceEnabled

布尔型

SMTP使能

ServerAddress

字符串

服务地址

ServerPort

数值

服务端口

TLSEnabled

布尔型

TLS使能

AnonymousLoginEnabled

布尔型

匿名登录使能

SenderUserName

字符串

发送者用户名；

允许设置的最大长度为64位

SenderPassword

字符串

发送者密码；

允许设置的最大长度为64位

SenderAddress

字符串

发送者地址；

该字段允许下发的最大长度为64位

Oem.Public.Subject

数组对象

邮件主题定制；

产品名称"ProductName"

主机名称"HostName"

资产标签"AssetTag"

主板序列号"BoardSerialNumber"

Oem.Public.RSAEncryptionEnabled

布尔型

是否支持RSA加密，仅限于Web页面设置发送者密码时使用

AlarmSeverity

字符串

可修改的告警等级，包括：

"Critical"

"Major+Critical"

"Minor+Major+Critical"

"All"

为腾讯CID时，等级包括：

"Critical"

"Warning+Critical"

"All"

RecipientAddresses

PEF/告警邮件/设置接收告警的邮件地址

RecipientAddresses.MemberId

字符串

成员ID (1~15)

RecipientAddresses.Enabled

布尔型

添加删除改成员ID的告警邮件配置

RecipientAddresses.EmailSubject

字符串

告警邮件主题；

该字段允许下发的最大长度为32位，且下发Enabled字段值为false时，该字段不支持设置

RecipientAddresses.EmailAdress

字符串

邮件地址；

该字段允许下发的最大长度为64位，且下发Enabled字段值为false时，该字段不支持设置

 

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/Managers/1/SmtpService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

  "AlarmSeverity": "Critical",

  "AnonymousLoginEnabled": false,

  "Description": "Smtpservice Gettings",

  "Id": "Smtp",

  "Name": "Smtp",

  "Oem": {

    "Public": {

      "CompletionCode": 0,

      "Description": "Success",

      "Subject": [

        "ProductName",

        "AssetTag",

        "BoardSerialNumber",

        "HostName"

      ]

    }

  },

  "RecipientAddresses": [

    {

      "EmailAddress": "[email protected]",

      "EmailSubject": "111",

      "Enabled": true,

      "MemberId": "1"

    }

  ],

  "SenderPassword": "",

  "SenderUserName": "",

  "ServerAddress": "",

  "ServerPort": 25,

  "ServiceEnabled": true,

  "TLSEnabled": true

}

【应答示例】

{

  "@odata.context": "/redfish/v1/$metadata#SmtpService.SmtpService(AnonymousLoginEnabled,ServerPort,Name,ServiceEnabled,Id,RecipientAddresses,TLSEnabled,SenderAddress,Description,AlarmSeverity,Actions,ServerAddress)",

  "@odata.id": "/redfish/v1/Managers/1/SmtpService",

  "@odata.type": "#SmtpService.v1_0_0.SmtpService",

  "Actions": {

    "#SmtpService.SubmitTestEvent": {

      "target": "/redfish/v1/Managers/1/SmtpService/Actions/SmtpService.SubmitTestEvent"

    }

  },

  "AlarmSeverity": "Critical",

  "AnonymousLoginEnabled": false,

  "Description": "Smtpservice Gettings",

  "Id": "Smtp",

  "Name": "Smtp",

  "Oem": {

    "Public": {

      "CompletionCode": 0,

      "Description": "Success",

      "Subject": [

        "ProductName",

        "HostName",

        "AssetTag",

        "BoardSerialNumber"

      ]

    }

  },

  "RecipientAddresses": [

    {

      "EmailAddress": "[email protected]",

      "EmailSubject": "111",

      "Enabled": true,

      "MemberId": "1"

    },

    {

      "EmailAddress": "",

      "EmailSubject": "",

      "Enabled": false,

      "MemberId": "2"

    },

    {

      "EmailAddress": "",

      "EmailSubject": "",

      "Enabled": false,

      "MemberId": "3"

    },

    {

      "EmailAddress": "",

      "EmailSubject": "",

      "Enabled": false,

      "MemberId": "4"

    },

    {

      "EmailAddress": "",

      "EmailSubject": "",

      "Enabled": false,

      "MemberId": "5"

    },

    {

      "EmailAddress": "",

      "EmailSubject": "",

      "Enabled": false,

      "MemberId": "6"

    },

    {

      "EmailAddress": "",

      "EmailSubject": "",

      "Enabled": false,

      "MemberId": "7"

    },

    {

      "EmailAddress": "",

      "EmailSubject": "",

      "Enabled": false,

      "MemberId": "8"

    },

    {

      "EmailAddress": "",

      "EmailSubject": "",

      "Enabled": false,

      "MemberId": "9"

    },

    {

      "EmailAddress": "",

      "EmailSubject": "",

      "Enabled": false,

      "MemberId": "10"

    },

    {

      "EmailAddress": "",

      "EmailSubject": "",

      "Enabled": false,

      "MemberId": "11"

    },

    {

      "EmailAddress": "",

      "EmailSubject": "",

      "Enabled": false,

      "MemberId": "12"

    },

    {

      "EmailAddress": "",

      "EmailSubject": "",

      "Enabled": false,

      "MemberId": "13"

    },

    {

      "EmailAddress": "",

      "EmailSubject": "",

      "Enabled": false,

      "MemberId": "14"

    },

    {

      "EmailAddress": "",

      "EmailSubject": "",

      "Enabled": false,

      "MemberId": "15"

    }

  ],

  "SenderAddress": "",

  "SenderPassword": null,

  "SenderUserName": "",

  "ServerAddress": "",

  "ServerPort": 25,

  "ServiceEnabled": true,

  "TLSEnabled": true

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回字段说明同【查询SMTP信息】

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

 

4.4.11  发送SMTP测试警报

【功能描述】

发送SMTP测试警报。

【所属权限模块】

常规配置

【命令格式】

POST https://device_ip/redfish/v1/Managers/manager_id/SmtpService/Actions/SmtpService.SubmitTestEvent

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"MemberId": "id"

}

【参数说明】

表4-218 发送SMTP测试警报参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

MemberId

字符串

接收告警邮件地址的ID

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/Managers/1/SmtpService/Actions/SmtpService.SubmitTestEvent

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"MemberId": "1"

}

【响应样例】

{

"Oem": {

       "Public": {

           "CompletionCode": 0,

           "Description": "Success"

       }

 },

"error": {

       "@Message.ExtendedInfo": [

           {

               "@odata.type": "#Message.v1_1_1.Message",

               "Message": "Successfully Completed Request",

               "MessageArgs": [],

               "MessageId": "Base.1.8.1.Success",

               "MessageSeverity": "OK",

               "Resolution": "None"

           }

       ],

        "code":"Base.1.8.1.Success",

        "message":"Successfully Completed Request"

    }

}

}

响应码 200

【输出说明】

返回状态码200，表示操作成功。

表4-219 发送SMTP测试警报输出参数说明

字段

类型

字段说明

code

字符串

指示消息注册表中特定消息ID的字符串

message

字符串

与消息注册表中的消息对应的易读的错误消息

@Message.ExtendedInfo

消息扩展信息

@odata.type

字符串

消息资源的OData描述信息

MessageIds

字符串

消息ID

Message

字符串

详细信息

MessageArgs

数组

信息参数

MessageSeverity

字符串

严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical

Resolution

字符串

解决建议

 

【修改记录】

(1)     HDM2-2.04：Message.ExtendedInfo前添加error节点，并且在error节点下增加code和message字段；

 

4.4.12  获取SMTP测试警报结果信息

【功能描述】

获取SMTP测试警报结果信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/SmtpService/Oem/Public/SubmitTestResult/email_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求体】

无

【参数说明】

表4-220 获取SMTP测试警报结果信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

email_id

接收告警邮件地址的ID

 

 

【使用实例】

【请求样例】

GET https://device_ip/redfish/v1/Managers/1/SmtpService/Oem/Public/SubmitTestResult/1

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【响应样例】

{

"@odata.context": "/redfish/v1/$metadata#SmtpService.TestResult",

"@odata.id":"/redfish/v1/Managers/1/SmtpService/Oem/Public/SubmitTestResult/1",

"@odata.type": "#SmtpTestResult.v1_0_0.SmtpTestResult",

"Oem": {

      "Public": {

              "CompletionCode": 0,

              "Description": "Success"

      }

},

"SMTPTestResult":"success"

}

      返回码：200

【输出说明】

返回状态码200，表示操作成功。

表4-221 查询SMTP测试警报结果信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

SMTP信息资源模型的OData 描述信息

@odata.id

字符串

SMTP信息资源的访问路径

@odata.type

字符串

SMTP信息资源的类型

SMTPTestResult

字符串

SMTP测试是否是否成功

失败："fail"

成功："success"

 

4.4.13  查询SYSLOG信息

【功能描述】

查询SYSLOG信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/SyslogService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-222 查询SYSLOG信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Managers/1/SyslogService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【响应样例】

{

    "@odata.context": "/redfish/v1/$metadata#SyslogService.SyslogService(*)",

    "@odata.id": "/redfish/v1/Managers/1/SyslogService",

    "@odata.type": "#SyslogService.v1_0_0.SyslogService",

    "Actions": {

        "#SyslogService.ImportClientCertificate": {

            "@Redfish.ActionInfo": "/redfish/v1/Managers/1/SyslogService/ImportClientCertificateActionInfo",

            "target": "/redfish/v1/Managers/1/SyslogService/Actions/SyslogService.ImportClientCertificate"

        },

        "#SyslogService.ImportPrivateKeyCertificate": {

            "@Redfish.ActionInfo": "/redfish/v1/Managers/1/SyslogService/ImportPrivateKeyCertificateActionInfo",

            "target": "/redfish/v1/Managers/1/SyslogService/Actions/SyslogService.ImportPrivateKeyCertificate"

        },

        "#SyslogService.ImportRootCertificate": {

            "@Redfish.ActionInfo": "/redfish/v1/Managers/1/SyslogService/ImportRootCertificateActionInfo",

            "target": "/redfish/v1/Managers/1/SyslogService/Actions/SyslogService.ImportRootCertificate"

        },

        "#SyslogService.SubmitTestEvent": {

            "@Redfish.ActionInfo": "/redfish/v1/Managers/1/SyslogService/Actions/SyslogService.SubmitTestEvent",

            "target": "/redfish/v1/Managers/1/SyslogService/Actions/SyslogService.SubmitTestEvent"

        }

    },

    "AuthenticateMode": "TwoWay",

    "CustomOptions": [

        "TimeStamp",

        "HostName",

        "Message"

    ],

    "Id": "SyslogService",

    "MessageFormat": "Custom",

    "Name": "Syslog Service",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success",

            "ClientCertificateInstalled": false,

            "PrivateKeyCertificateInstalled": false,

            "RootCertificateInstalled": false

        }

    },

    "ServerIdentitySource": "HostName",

    "ServiceEnabled": true,

    "SyslogServers": [

        {

            "Address": "192.168.10.11",

            "Enabled": true,

            "LogLevel": "Critical",

            "LogType": [

                "OperationLog",

                "SDRLog"

            ],

            "MemberId": "1",

            "Name": "Channel1",

            "Port": 514

        },

        {

            "Address": "0.0.0.0",

            "Enabled": false,

            "LogLevel": "Informational",

            "LogType": [],

            "MemberId": "2",

            "Name": "channel2",

            "Port": 514

        },

        {

            "Address": "0.0.0.0",

            "Enabled": false,

            "LogLevel": "Informational",

            "LogType": [],

            "MemberId": "3",

            "Name": "channel3",

            "Port": 514

        },

        {

            "Address": "0.0.0.0",

            "Enabled": false,

            "LogLevel": "Informational",

            "LogType": [],

            "MemberId": "4",

            "Name": "channel4",

            "Port": 514

        },

        {

            "Address": "0.0.0.0",

            "Enabled": false,

            "LogLevel": "Informational",

            "LogType": [],

            "MemberId": "5",

            "Name": "channel5",

            "Port": 514

        },

        {

            "Address": "0.0.0.0",

            "Enabled": false,

            "LogLevel": "Informational",

            "LogType": [],

            "MemberId": "6",

            "Name": "channel6",

            "Port": 514

        },

        {

            "Address": "0.0.0.0",

            "Enabled": false,

            "LogLevel": "Informational",

            "LogType": [],

            "MemberId": "7",

            "Name": "channel7",

            "Port": 514

        },

        {

            "Address": "0.0.0.0",

            "Enabled": false,

            "LogLevel": "Informational",

            "LogType": [],

            "MemberId": "8",

            "Name": "channel8",

            "Port": 514

        }

    ],

    "TimeInterval": 60,

    "TransmissionProtocol": "UDP"

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-223 查询SYSLOG信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

SYSLOG信息资源模型的OData 描述信息

@odata.id

字符串

SYSLOG信息资源的访问路径

@odata.type

字符串

SYSLOG信息资源的类型

Id

字符串

SYSLOG信息资源ID

Name

字符串

SYSLOG信息资源名称

ServiceEnabled

布尔型

SYSLOG服务是否使能

TransmissionProtocol

字符串

SYSLOG服务传输协议:

"UDP"、

"TCP"、

"TLS"

AuthenticateMode

字符串

认证模式:

"OneWay"

"TwoWay"

ServerIdentitySource

字符串

SYSLOG主机标识：

主机名"HostName"

主板序列号"BoardSN"

产品资产标签"ProductAssetTag"

产品序列号"ProductSN"

TimeInterval

数值

时间间隔：10~ 2592000

MessageFormat

字符串

消息格式

精简格式  Custom

RFC3164 格式  RFC3164

RFC5424格式  RFC5424

CustomOptions

数组

自定义格式选项

消息 Message

时间戳 TimeStamp

主机名 HostName

说明：自定义格式选项只在精简格式下有效

SyslogServers.Address

字符串

SyslogServers服务地址

SyslogServers.Enabled

布尔型

SyslogServers服务是否使能

SyslogServers.MemberId

字符串

SyslogServers服务序列号：1~8

SyslogServers.Port

数值

SyslogServers服务端口

SyslogServers.LogType

数组

SyslogServers服务日志类型：

操作日志"OperationLog",

事件日志 "EventLog",

安全日志"SecurityLog"

串口日志”SerialLog”

传感器日志 “SDRLog”

SyslogServers.LogLevel

字符串

日志级别：

正常"Informational"

轻微"Minor"

严重"Major"

紧急"Critical"

SyslogServers.Name

字符串

通道名称

Actions

Syslog 资源的 action 相关操作

SyslogService.ImportRootCertificate

对象

导入 syslog 根证书

target

字符串

操作路径

Redfish.ActionInfo

字符串

操作信息查询路径

SyslogService.ImportClientCertificate

对象

导入 syslog 本地证书

Oem.Public.RootCertificateInstalled

布尔型

syslog 根证书的导入标志

Oem.Public.ClientCertificateInstalled

布尔型

syslog 本地证书的导入标志

Oem.Public.PrivateKeyCertificateInstalled

布尔型

syslog 私钥的导入标志

 

4.4.14  设置SYSLOG信息

【功能描述】

设置SYSLOG信息。

【所属权限模块】

常规配置

【所属系统锁定类型】

BMC配置锁定

【命令格式】

PATCH https://device_ip/redfish/v1/Managers/manager_id/SyslogService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:ifmatch_value

【请求消息体】

{

  "ServiceEnabled":true,

  "ServerIdentitySource":"HostName",

  "TransmissionProtocol":"UDP",

  "TimeInterval":60,

  "AuthenticateMode":"TwoWay",

  "MessageFormat":"Custom",

  "CustomOptions":[

      "HostName",

      "Message",

      "TimeStamp"

  ],

  "SyslogServers": [

      {

          "Address": "192.168.10.11",

          "Enabled": true,

          "LogLevel":"Critical",

          "LogType": [

              "OperationLog",

              "SDRLog"

          ],

          "MemberId": "1",

          "Name":"Channel1",

          "Port": 514

      },

  ...

  ]

}

【参数说明】

表4-224 设置SYSLOG信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

ifmatch_value

请求消息的匹配参数

可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）

ServiceEnabled

布尔型

SYSLOG服务是否使能

TransmissionProtocol

字符串

SYSLOG服务传输协议："UDP"、"TCP"、"TLS"

AuthenticateMode

字符串

认证模式：

"OneWay"

"TwoWay"

ServerIdentitySource

字符串

SYSLOG主机标识：

主机名"HostName"

主板序列号"BoardSN"

产品资产标签"ProductAssetTag"

产品序列号"ProductSN"

TimeInterval

数值

时间间隔：10~ 2592000

MessageFormat

字符串

消息格式

精简格式  Custom

RFC3164格式  RFC3164

RFC5424格式  RFC5424

CustomOptions

数组

自定义格式选项

消息 Message

时间戳 TimeStamp

主机名 HostName

说明：自定义格式选项只在精简格式下生效，且Message选项为必选配置项；

SyslogServers.Address

字符串

SyslogServers服务地址

SyslogServers.Enabled

布尔型

SyslogServers服务是否使能

SyslogServers.MemberId

字符串

SyslogServers服务序列号：1~8

SyslogServers.Port

数值

SyslogServers服务端口

SyslogServers.Name

字符串

服务器名称；

该字段最大允许下发31个字符

SyslogServers.LogType

数组

SyslogServers服务日志类型：

操作日志"OperationLog",

事件日志 "EventLog",

安全日志"SecurityLog"

串口日志"SerialLog"

SDR日志"SDRLog"

SyslogServers.LogLevel

字符串

日志等级：

正常"Informational"

轻微"Minor"

严重"Major"

紧急"Critical"

 

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/Managers/1/SyslogService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

  "ServiceEnabled":true,

  "ServerIdentitySource":"HostName",

  "TransmissionProtocol":"UDP",

  "TimeInterval":60,

  "AuthenticateMode":"TwoWay",

  "MessageFormat":"Custom",

  "CustomOptions":[

      "HostName",

      "Message",

      "TimeStamp"

  ],

  "SyslogServers": [

      {

          "Address": "192.168.10.11",

          "Enabled": true,

          "LogLevel":"Critical",

          "LogType": [

              "OperationLog",

              "SDRLog"

          ],

          "MemberId": "1",

          "Name":"Channel1",

          "Port": 514

      },

  ...

  ]

}

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#SyslogService.SyslogService(*)",

    "@odata.id": "/redfish/v1/Managers/1/SyslogService",

    "@odata.type": "#SyslogService.v1_0_0.SyslogService",

    "Actions": {

        "#SyslogService.ImportClientCertificate": {

            "@Redfish.ActionInfo": "/redfish/v1/Managers/1/SyslogService/ImportClientCertificateActionInfo",

            "target": "/redfish/v1/Managers/1/SyslogService/Actions/SyslogService.ImportClientCertificate"

        },

        "#SyslogService.ImportPrivateKeyCertificate": {

            "@Redfish.ActionInfo": "/redfish/v1/Managers/1/SyslogService/ImportPrivateKeyCertificateActionInfo",

            "target": "/redfish/v1/Managers/1/SyslogService/Actions/SyslogService.ImportPrivateKeyCertificate"

        },

        "#SyslogService.ImportRootCertificate": {

            "@Redfish.ActionInfo": "/redfish/v1/Managers/1/SyslogService/ImportRootCertificateActionInfo",

            "target": "/redfish/v1/Managers/1/SyslogService/Actions/SyslogService.ImportRootCertificate"

        },

        "#SyslogService.SubmitTestEvent": {

            "@Redfish.ActionInfo": "/redfish/v1/Managers/1/SyslogService/Actions/SyslogService.SubmitTestEvent",

            "target": "/redfish/v1/Managers/1/SyslogService/Actions/SyslogService.SubmitTestEvent"

        }

    },

    "AuthenticateMode": "TwoWay",

    "CustomOptions": [

        "TimeStamp",

        "HostName",

        "Message"

    ],

    "Id": "SyslogService",

    "MessageFormat": "Custom",

    "Name": "Syslog Service",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success",

            "ClientCertificateInstalled": false,

            "PrivateKeyCertificateInstalled": false,

            "RootCertificateInstalled": false

        }

    },

    "ServerIdentitySource": "HostName",

    "ServiceEnabled": true,

    "SyslogServers": [

        {

            "Address": "192.168.10.11",

            "Enabled": true,

            "LogLevel": "Critical",

            "LogType": [

                "OperationLog",

                "SDRLog"

            ],

            "MemberId": "1",

            "Name": "Channel1",

            "Port": 514

        },

        {

            "Address": "0.0.0.0",

            "Enabled": false,

            "LogLevel": "Informational",

            "LogType": [],

            "MemberId": "2",

            "Name": "channel2",

            "Port": 514

        },

        {

            "Address": "0.0.0.0",

            "Enabled": false,

            "LogLevel": "Informational",

            "LogType": [],

            "MemberId": "3",

            "Name": "channel3",

            "Port": 514

        },

        {

            "Address": "0.0.0.0",

            "Enabled": false,

            "LogLevel": "Informational",

            "LogType": [],

            "MemberId": "4",

            "Name": "channel4",

            "Port": 514

        },

        {

            "Address": "0.0.0.0",

            "Enabled": false,

            "LogLevel": "Informational",

            "LogType": [],

            "MemberId": "5",

            "Name": "channel5",

            "Port": 514

        },

        {

            "Address": "0.0.0.0",

            "Enabled": false,

            "LogLevel": "Informational",

            "LogType": [],

            "MemberId": "6",

            "Name": "channel6",

            "Port": 514

        },

        {

            "Address": "0.0.0.0",

            "Enabled": false,

            "LogLevel": "Informational",

            "LogType": [],

            "MemberId": "7",

            "Name": "channel7",

            "Port": 514

        },

        {

            "Address": "0.0.0.0",

            "Enabled": false,

            "LogLevel": "Informational",

            "LogType": [],

            "MemberId": "8",

            "Name": "channel8",

            "Port": 514

        }

    ],

    "TimeInterval": 60,

    "TransmissionProtocol": "UDP"

}

    响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回字段说明同【查询SYSLOG信息】。

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

 

4.4.15  发送SYSLOG测试警报

【功能描述】

发送SYSLOG测试事件。

【所属权限模块】

常规配置

【命令格式】

POST https://device_ip/redfish/v1/Managers/manager_id/SyslogService/Actions/SyslogService.SubmitTestEvent

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"MemberId": id                             

}

【参数说明】

表4-225 发送SYSLOG测试警报参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

MemberId

字符串

告警日志服务器序号

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/Managers/1/SyslogService/Actions/SyslogService.SubmitTestEvent

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"MemberId":"1"

}

【应答示例】

{

"Oem": {

       "Public": {

           "CompletionCode": 0,

           "Description": "Success"

       }

 },

"error": {

       "@Message.ExtendedInfo": [

           {

               "@odata.type": "#Message.v1_1_1.Message",

               "Message": "Successfully Completed Request",

               "MessageArgs": [],

               "MessageId": "Base.1.8.1.Success",

               "MessageSeverity": "OK",

               "Resolution": "None"

           }

       ],

        "code":"Base.1.8.1.Success",

        "message":"Successfully Completed Request"

    }

}

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-226 发送Syslog测试警报输出参数说明

字段

类型

字段说明

code

字符串

指示消息注册表中特定消息ID的字符串

message

字符串

与消息注册表中的消息对应的易读的错误消息

@Message.ExtendedInfo

消息扩展信息

@odata.type

字符串

消息资源的OData描述信息

MessageId

字符串

消息ID

Message

字符串

详细信息

MessageArgs

数组

信息参数

MessageSeverity

字符串

严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical

Resolution

字符串

解决建议

 

【修改记录】

(1)     HDM2-2.04：Message.ExtendedInfo前添加error节点，并且在error节点下增加code和message字段；

 

4.4.16  导入Syslog根证书

【功能描述】

导入Syslog根证书。

【所属权限模块】

安全配置

【所属系统锁定类型】

BMC配置锁定

【命令格式】

POST https://device_ip/redfish/v1/Managers/manager_id/SyslogService/Actions/SyslogService.ImportRootCertificate

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

1、本地导入

{

"Type":"URI",

"Content": "/tmp/web/filename"

}

2、远程导入

{

"Type":"URI",

"Content": "sftp://username:[email protected]/filename"

}

3、文本内容导入

{

"Type":"text",

"Content":value

}

【参数说明】

表4-227 导入Syslog根证书参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

type

导入syslog证书的方式

text，表明value值是证书内容

URI，表明value值是URI（本地或者远程）

value

内容

1：可以是证书的内容

2：可以是证书远程路径（支持的文件传输的协议有sftp）

3：可以是证书本地路径

4：value的含义由type表示

Content

导入Syslog根证书路径

见其它说明

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/Managers/1/SyslogService/Actions/SyslogService.ImportRootCertificate

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"Type": "URI",

"Content":"sftp://y17057:[email protected]/cacert.pem"

}

【应答示例】

{

"Oem": {

       "Public": {

           "CompletionCode": 0,

           "Description": "Success"

       }

 },

"error": {

       "@Message.ExtendedInfo": [

           {

               "@odata.type": "#Message.v1_1_1.Message",

               "Message": "Successfully Completed Request",

               "MessageArgs": [],

               "MessageId": "Base.1.8.1.Success",

               "MessageSeverity": "OK",

               "Resolution": "None"

           }

       ],

        "code":"Base.1.8.1.Success",

        "message":"Successfully Completed Request"

    }

}

}

响应码：200

【输出说明】

表4-228 导入Syslog根证书信息返回值

字段

类型

字段说明

code

字符串

指示消息注册表中特定消息ID的字符串

message

字符串

与消息注册表中的消息对应的易读的错误消息

@Message.ExtendedInfo

消息扩展信息

@odata.type

字符串

消息资源的OData描述信息

MessageId

字符串

消息ID

Message

字符串

详细信息

MessageArgs

数组

信息参数

MessageSeverity

字符串

严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical

Resolution

字符串

解决建议

 

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

(2)     HDM2-2.04：Message.ExtendedInfo前添加error节点，并且在error节点下增加code和message字段；

 

4.4.17  导入本地证书

【功能描述】

导入Syslog本地证书。

【所属权限模块】

安全配置

【所属系统锁定类型】

BMC配置锁定

【命令格式】

POST https://device_ip/redfish/v1/Managers/manager_id/SyslogService/Actions/SyslogService.ImportClientCertificate

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"Type":type,

"Content":value

}

请求体同【导入根证书文件】

【参数说明】

表4-229 导入本地证书参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

type

导入syslog证书的方式

text，表明value值是证书内容

URI，表明value值是URI（本地或者远程）

value

内容

1：可以是证书的内容

2：可以是证书远程路径（支持的文件传输的协议有sftp）

3： value的含义由type表示

Content

导入本地证书路径

见其它说明

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/Managers/1/SyslogService/Actions/SyslogService.ImportClientCertificate

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"Type": "URI",

"Content":"sftp://y17057:[email protected]/cert.pem"

}

【应答示例】

{

"Oem": {

       "Public": {

           "CompletionCode": 0,

           "Description": "Success"

       }

 },

"error": {

       "@Message.ExtendedInfo": [

           {

               "@odata.type": "#Message.v1_1_1.Message",

               "Message": "Successfully Completed Request",

               "MessageArgs": [],

               "MessageId": "Base.1.8.1.Success",

               "MessageSeverity": "OK",

               "Resolution": "None"

           }

       ],

        "code":"Base.1.8.1.Success",

        "message":"Successfully Completed Request"

    }

}

}

响应码：200

【输出说明】

表4-230 导入本地证书信息返回值

字段

类型

字段说明

code

字符串

指示消息注册表中特定消息ID的字符串

message

字符串

与消息注册表中的消息对应的易读的错误消息

@Message.ExtendedInfo

消息扩展信息

@odata.type

字符串

消息资源的OData描述信息

MessageId

字符串

消息ID

Message

字符串

详细信息

MessageArgs

数组

信息参数

MessageSeverity

字符串

严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical

Resolution

字符串

解决建议

 

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

(2)     HDM2-2.04：Message.ExtendedInfo前添加error节点，并且在error节点下增加code和message字段；

 

4.4.18  导入私钥证书

【功能描述】

导入私钥证书。

【所属权限模块】

安全配置

【所属系统锁定类型】

BMC配置锁定

【命令格式】

POST https://device_ip/redfish/v1/Managers/manager_id/SyslogService/Actions/SyslogService.ImportPrivateKeyCertificate

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"Type":type,

"Content":value

}

请求体同【导入根证书】

【参数说明】

表4-231 导入私钥证书信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

type

导入syslog证书的方式

text，表明value值是证书内容

URI，表明value值是URI（本地或者远程）

value

内容

1：可以是证书的内容

2：可以是证书远程路径（支持的文件传输的协议有sftp）

3： value的含义由type表示

Content

导入私钥证书路径

见其它说明

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/Managers/1/SyslogService/Actions/SyslogService.ImportPrivateKeyCertificate

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"Type": "URI",

"Content":"sftp://y17057:[email protected]/key.pem"

}

【应答示例】

{

"Oem": {

       "Public": {

           "CompletionCode": 0,

           "Description": "Success"

       }

 },

"error": {

       "@Message.ExtendedInfo": [

           {

               "@odata.type": "#Message.v1_1_1.Message",

               "Message": "Successfully Completed Request",

               "MessageArgs": [],

               "MessageId": "Base.1.8.1.Success",

               "MessageSeverity": "OK",

               "Resolution": "None"

           }

       ],

        "code":"Base.1.8.1.Success",

        "message":"Successfully Completed Request"

    }

}

}

响应码：200

【输出说明】

表4-232 导入私钥证书信息返回值

字段

类型

字段说明

code

字符串

指示消息注册表中特定消息ID的字符串

message

字符串

与消息注册表中的消息对应的易读的错误消息

@Message.ExtendedInfo

消息扩展信息

@odata.type

字符串

消息资源的OData描述信息

MessageId

字符串

消息ID

Message

字符串

详细信息

MessageArgs

数组

信息参数

MessageSeverity

字符串

严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical

Resolution

字符串

解决建议

 

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

(2)     HDM2-2.04：Message.ExtendedInfo前添加error节点，并且在error节点下增加code和message字段；

 

4.4.19  查询服务信息

【功能描述】

查询HTTPS、IPMI、KVM、SNMP、SSDP、SSH、虚拟媒体、ASD|iHDT、VNC等服务的端口信息及使能情况等。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/NetworkProtocol

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-233 查询服务信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

manager_id

管理资源的ID

当前所有机型取值为1

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Managers/1/NetworkProtocol

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#ManagerNetworkProtocol.ManagerNetworkProtocol",

    "@odata.id": "/redfish/v1/Managers/1/NetworkProtocol",

    "@odata.type": "#ManagerNetworkProtocol.v1_7_0.ManagerNetworkProtocol",

    "ASD": {

        "Oem": {

            "Public": {

                "MaxSessionCountSupported": 1,

                "NonSecurePort": 6868,

                "NonSecurePortEnabled": true,

                "SecurePort": null,

                "SecurePortEnabled": null,

                "SessionCount": 0,

                "SessionType": "ASD(Remote_XDP)",

                "TimeOut": null

            }

        },

        "Port": 6868,

        "ProtocolEnabled": false

},

"Actions": {

        "Oem": {

            "Public": {

                "#Manager.RestartService": {

                    "target": "/redfish/v1/Managers/1/NetworkProtocol/Actions/Oem/Public/Manager.RestartService"

                }

            }

        }

},

    "CD-Media": {

        "Oem": {

            "Public": {

                "MaxSessionCountSupported": 2,

                "NonSecurePort": 5120,

                "NonSecurePortEnabled": false,

                "SecurePort": 5124,

                "SecurePortEnabled": true,

                "SessionCount": 0,

                "SessionType": "CD-Media",

                "TimeOut": null

            }

        },

        "Port": 5124,

        "ProtocolEnabled": true

    },

    "Description": "Network Protocol Details",

    "FD-Media": {

        "Oem": {

            "Public": {

                "MaxSessionCountSupported": 1,

                "NonSecurePort": 5122,

                "NonSecurePortEnabled": false,

                "SecurePort": 5126,

                "SecurePortEnabled": true,

                "SessionCount": 0,

                "SessionType": "FD-Media",

                "TimeOut": null

            }

        },

        "Port": 5126,

        "ProtocolEnabled": true

    },

    "FQDN": null,

    "HD-Media": {

        "Oem": {

            "Public": {

                "MaxSessionCountSupported": 2,

                "NonSecurePort": 5123,

                "NonSecurePortEnabled": false,

                "SecurePort": 5127,

                "SecurePortEnabled": true,

                "SessionCount": 0,

                "SessionType": "HD-Media",

                "TimeOut": null

            }

        },

        "Port": 5127,

        "ProtocolEnabled": true

    },

    "HTTP": {

        "Oem": {

            "Public": {

                "MaxSessionCountSupported": 20,

                "NonSecurePort": 80,

                "NonSecurePortEnabled": true,

                "SecurePort": null,

                "SecurePortEnabled": null,

                "SessionCount": 0,

                "SessionType": "HTTP",

                "TimeOut": 30

            }

        },

        "Port": 80,

        "ProtocolEnabled": true

    },

    "HTTPS": {

        "Oem": {

            "Public": {

                "MaxSessionCountSupported": 20,

                "NonSecurePort": null,

                "NonSecurePortEnabled": null,

                "SecurePort": 443,

                "SecurePortEnabled": true,

                "SessionCount": 0,

                "SessionType": "HTTPS",

                "TimeOut": 30

            }

        },

        "Port": 443,

        "ProtocolEnabled": true

    },

    "HostName": "HDM",

    "IPMI": {

        "Oem": {

            "Public": {

                "MaxSessionCountSupported": null,

                "NonSecurePort": 624,

                "NonSecurePortEnabled": true,

                "SecurePort": 623,

                "SecurePortEnabled": false,

                "SessionCount": null,

                "SessionType": "IPMI",

                "TimeOut": null

            }

        },

        "Port": 624,

        "ProtocolEnabled": true

    },

    "Id": "NetworkProtocol",

    "KVMIP": {

        "Oem": {

            "Public": {

                "MaxSessionCountSupported": 4,

                "NonSecurePort": 7578,

                "NonSecurePortEnabled": false,

                "SecurePort": 7582,

                "SecurePortEnabled": true,

                "SessionCount": 0,

                "SessionType": "KVM",

                "TimeOut": 30

            }

        },

        "Port": 7582,

        "ProtocolEnabled": true

    },

    "Name": "Manager Network Protocol",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

"Sessions": {

                "@odata.id": "/redfish/v1/Managers/1/NetworkProtocol/Oem/Public/Sessions"

            }

        }

    },

    "SNMP": {

        "Oem": {

            "Public": {

                "MaxSessionCountSupported": null,

                "NonSecurePort": 161,

                "NonSecurePortEnabled": true,

                "SecurePort": null,

                "SecurePortEnabled": null,

                "SessionCount": null,

                "SessionType": "SNMP",

                "TimeOut": null

            }

        },

        "Port": 161,

        "ProtocolEnabled": true

},

    "SSDP": {

        "Oem": {

            "Public": {

                "MaxSessionCountSupported": null,

                "NonSecurePort": 1900,

                "NonSecurePortEnabled": true,

                "SecurePort": null,

                "SecurePortEnabled": null,

                "SessionCount": null,

                "SessionType": "SSDP",

                "TimeOut": null

            }

        },

        "Port": 1900,

        "ProtocolEnabled": true

    },

    "SSH": {

        "Oem": {

            "Public": {

                "MaxSessionCountSupported": 3,

                "NonSecurePort": null,

                "NonSecurePortEnabled": null,

                "SecurePort": 22,

                "SecurePortEnabled": true,

                "SessionCount": 0,

                "SessionType": "SSH",

                "TimeOut": 10

            }

        },

        "Port": 22,

        "ProtocolEnabled": true

    },

    "Status": {

        "Health": "OK",

        "State": "Enabled"

    },

    "VNC": {

        "Oem": {

            "Public": {

                "MaxSessionCountSupported": 2,

                "NonSecurePort": 5900,

                "NonSecurePortEnabled": true,

                "SecurePort": null,

                "SecurePortEnabled": null,

                "SessionCount": 0,

                "SessionType": "VNC",

                "TimeOut": 10

            }

        },

        "Port": 5900,

        "ProtocolEnabled": false

    }

}

响应码：200

【输出说明】

表4-234 查询服务信息返回值

字段

类型

字段说明

@odata.context

字符串

服务信息资源模型的OData 描述信息

@odata.id

字符串

服务信息资源的访问路径

@odata.type

字符串

服务信息资源的类型

Actions.Oem.Public

Actions自定义可执行的操作

Manager.RestartService

对象

重启服务

Description

字符串

服务信息资源的描述

HTTPS.Port

数值

HTTPS服务当前启用端口

HTTPS.ProtocolEnabled

布尔型

HTTPS服务使能

HTTPS.Oem.Public.SecurePort

数值

HTTPS服务安全端口

HTTPS.Oem.Public.NonSecurePort

数值

HTTPS服务非安全端口

HTTPS.Oem.Public.SecurePortEnabled

布尔

HTTPS服务安全端口使能状态

HTTPS.Oem.Public.NonSecurePortEnabled

布尔

HTTPS服务非安全端口使能状态

HTTPS.Oem.Public.MaxSessionCount

数值

HTTPS服务最大支持会话数量

HTTPS.Oem.Public.SessionCount

数值

HTTPS服务当前会话数量

HTTPS.Oem.Public.TimeOut

数值

HTTPS服务超时时间，单位：分钟

HTTPS.Oem.Public.SessionType

字符串

HTTPS服务会话类型信息

HTTP.Port

数值

HTTP服务当前启用端口

HTTP.ProtocolEnabled

布尔型

HTTP服务使能

HTTP.Oem.Public.SecurePort

数值

HTTP服务安全端口

HTTP.Oem.Public.NonSecurePort

数值

HTTP服务非安全端口

HTTP.Oem.Public.MaxSessionCount

数值

HTTP服务最大支持会话数量

HTTP.Oem.Public.SessionCount

数值

HTTP服务当前会话数量

HTTP.Oem.Public.TimeOut

数值

HTTP服务超时时间，单位：分钟

HTTP.Oem.Public.SessionType

字符串

HTTP服务会话类型信息

HTTP.Oem.Public.NonSecurePortEnabled

布尔

HTTP服务非安全端口使能状态

HTTP.Oem.Public.SecurePortEnabled

布尔

HTTP服务安全端口使能状态

IPMI.Port

数值

IPMI服务当前启用端口

IPMI.ProtocolEnabled

布尔型

IPMI服务使能

IPMI.Oem.Public.SecurePort

数值

IPMI服务安全端口（RMCP+）

IPMI.Oem.Public.NonSecurePort

数值

IPMI服务非安全端口（RMCP）

IPMI.Oem.Public.MaxSessionCount

数值

IPMI服务最大支持会话数量

IPMI.Oem.Public.SessionCount

数值

IPMI服务当前会话数量

IPMI.Oem.Public.TimeOut

数值

IPMI服务超时时间，单位：分钟

IPMI.Oem.Public.SessionType

字符串

IPMI服务会话类型信息

IPMI.Oem.Public.NonSecurePortEnabled

布尔

IPMI服务非安全端口（RMCP）使能状态

IPMI.Oem.Public.SecurePortEnabled

布尔

IPMI服务安全端口（RMCP+）使能状态

KVMIP.Port

数值

KVM当前启动端口

KVMIP.ProtocolEnabled

布尔型

KVM服务使能

KVMIP.Oem.Public.SecurePort

数值

KVMIP服务安全端口

KVMIP.Oem.Public.NonSecurePort

数值

KVMIP服务非安全端口

KVMIP.Oem.Public.MaxSessionCount

数值

KVMIP服务最大支持会话数量

KVMIP.Oem.Public.SessionCount

数值

KVMIP服务当前会话数量

KVMIP.Oem.Public.TimeOut

数值

KVMIP服务超时时间，单位：分钟

KVMIP.Oem.Public.SessionType

字符串

KVMIP服务会话类型信息

KVMIP.Oem.Public.NonSecurePortEnabled

布尔

KVMIP服务非安全端口使能状态

KVMIP.Oem.Public.SecurePortEnabled

布尔

KVMIP服务安全端口使能状态

ASD.Port或

iHDT.Port

数值

ASD或iHDT当前启用端口

Intel机型显示ASD

AMD机型显示iHDT

ASD.ProtocolEnabled或

iHDT.ProtocolEnabled

布尔型

ASD或iHDT服务使能

Intel机型显示ASD

AMD机型显示iHDT

ASD.Oem.Public.SecurePort或iHDT.Oem.Public.SecurePort

数值

ASD或iHDT服务安全端口

Intel机型显示ASD

AMD机型显示iHDT

ASD.Oem.Public.NonSecurePort或iHDT.Oem.Public.NonSecurePort

数值

ASD或iHDT服务非安全端口

Intel机型显示ASD

AMD机型显示iHDT

ASD.Oem.Public.MaxSessionCount或iHDT.Oem.Public.MaxSessionCount

数值

ASD或iHDT服务最大支持会话数量

Intel机型显示ASD

AMD机型显示iHDT

ASD.Oem.Public.SessionCount或iHDT.Oem.Public.SessionCount

数值

ASD或iHDT服务当前会话数量

Intel机型显示ASD

AMD机型显示iHDT

ASD.Oem.Public.TimeOut或iHDT. Oem.Public.TimeOut

数值

ASD或iHDT服务超时时间，单位：分钟

Intel机型显示ASD

AMD机型显示iHDT

ASD.Oem.Public.SessionType或iHDT.Oem.Public.SessionType

字符串

ASD或iHDT服务会话类型信息

Intel机型显示ASD

AMD机型显示iHDT

ASD.Oem.Public. NonSecurePortEnabled或iHDT.Oem.Public. NonSecurePortEnabled

布尔

ASD或iHDT服务非安全端口使能状态

Intel机型显示ASD

AMD机型显示iHDT

ASD.Oem.Public.SecurePortEnabled或

iHDT.Oem.Public.SecurePortEnabled

布尔

ASD或iHDT服务安全端口使能状态

Intel机型显示ASD

AMD机型显示iHDT

SNMP.Port

数值

SNMP服务当前启用端口

SNMP.ProtocolEnabled

布尔型

SNMP服务使能

SNMP.Oem.Public.SecurePort

数值

SNMP服务安全端口

SNMP.Oem.Public.NonSecurePort

数值

SNMP服务非安全端口

SNMP.Oem.Public.MaxSessionCount

数值

SNMP服务最大支持会话数量

SNMP.Oem.Public.SessionCount

数值

SNMP服务当前会话数量

SNMP.Oem.Public.TimeOut

数值

SNMP服务超时时间，单位：分钟

SNMP.Oem.Public.SessionType

字符串

SNMP服务会话类型信息

SNMP.Oem.Public.NonSecurePortEnabled

布尔

SNMP服务非安全端口使能状态

SNMP.Oem.Public.SecurePortEnabled

布尔

SNMP服务安全端口使能状态

SSDP.Port

数值

SSDP服务当前启用端口

SSDP.ProtocolEnabled

布尔型

SSDP服务使能

SSDP.Oem.Public.SecurePort

数值

SSDP服务安全端口

SSDP.Oem.Public.NonSecurePort

数值

SSDP服务非安全端口

SSDP.Oem.Public.MaxSessionCount

数值

SSDP服务最大支持会话数量

SSDP.Oem.Public.SessionCount

数值

SSDP服务当前会话数量

SSDP.Oem.Public.TimeOut

数值

SSDP服务超时时间，单位：分钟

SSDP.Oem.Public.SessionType

字符串

SSDP服务会话类型信息

SSDP.Oem.Public.NonSecurePortEnabled

布尔

SSDP服务非安全端口使能状态

SSDP.Oem.Public.SecurePortEnabled

布尔

SSDP服务安全端口使能状态

SSH.Port

数值

SSH服务当前启用端口

SSH.ProtocolEnabled

布尔型

SSH服务使能

SSH.Oem.Public.SecurePort

数值

SSH服务安全端口

SSH.Oem.Public.NonSecurePort

数值

SSH服务非安全端口

SSH.Oem.Public.MaxSessionCount

数值

SSH服务最大支持会话数量

SSH.Oem.Public.SessionCount

数值

SSH服务当前会话数量

SSH.Oem.Public.TimeOut

数值

SSH服务超时时间，单位：分钟

SSH.Oem.Public.SessionType

字符串

SSH服务会话类型信息

SSH.Oem.Public.NonSecurePortEnabled

布尔

SSH服务非安全端口使能状态

SSH.Oem.Public.SecurePortEnabled

布尔

SSH服务安全端口使能状态

FD-Media.Port

数值

FD媒体当前启用端口

FD-Media.ProtocolEnabled

布尔型

FD媒体使能

FD-Media.Oem.Public.SecurePort

数值

FD媒体服务安全端口

FD-Media.Oem.Public.NonSecurePort

数值

FD媒体服务非安全端口

FD-Media.Oem.Public.MaxSessionCount

数值

FD媒体服务最大支持会话数量

FD-Media.Oem.Public.SessionCount

数值

FD媒体服务当前会话数量

FD-Media.Oem.Public.TimeOut

数值

FD媒体服务超时时间，单位：分钟

FD-Media.Oem.Public.SessionType

字符串

FD媒体服务会话类型信息

FD-Media.Oem.Public.NonSecurePortEnabled

布尔

FD媒体服务非安全端口使能状态

FD-Media.Oem.Public.SecurePortEnabled

布尔

FD媒体服务安全端口使能状态

CD-Media.Port

数值

CD媒体服务当前启用端口

CD-Media.ProtocolEnabled

布尔型

CD媒体服务使能

CD-Media.Oem.Public.SecurePort

数值

CD媒体服务安全端口

CD-Media.Oem.Public.NonSecurePort

数值

CD媒体服务非安全端口

CD-Media.Oem.Public.MaxSessionCount

数值

CD媒体服务最大支持会话数量

CD-Media.Oem.Public.SessionCount

数值

CD媒体服务当前会话数量

CD-Media.Oem.Public.TimeOut

数值

CD媒体服务超时时间，单位：分钟

CD-Media.Oem.Public.SessionType

字符串

CD媒体服务会话类型信息

CD -Media.Oem.Public.

NonSecurePortEnabled

布尔

CD媒体服务非安全端口使能状态

CD -Media.Oem.Public. SecurePortEnabled

布尔

CD媒体服务安全端口使能状态

HD-Media.Port

数值

HD媒体当前启用端口

HD-Media.ProtocolEnabled

布尔型

HD媒体使能

HD-Media.Oem.Public.NonSecurePort

数值

HD媒体服务非安全端口

HD-Media.Oem.Public. MaxSessionCount

数值

HD媒体服务最大支持会话数量

HD-Media.Oem.Public. SessionCount

数值

HD媒体服务当前会话数量

HD-Media.Oem.Public. TimeOut

数值

HD媒体服务超时时间，单位：分钟

HD-Media.Oem.Public. SessionType

字符串

HD媒体服务会话类型信息

HD-Media.Oem.Public. NonSecurePortEnabled

布尔

HD媒体服务非安全端口使能状态

HD-Media.Oem.Public. SecurePortEnabled

布尔

HD媒体服务安全端口使能状态

VNC.Port

数值

VNC服务当前启用端口

VNC.ProtocolEnabled

布尔型

VNC服务使能

VNC.Oem.Public.SecurePort

数值

VNC服务安全端口

VNC.Oem.Public.NonSecurePort

数值

VNC服务非安全端口

VNC.Oem.Public. MaxSessionCount

数值

VNC服务最大支持会话数量

VNC.Oem.Public. SessionCount

数值

VNC服务当前会话数量

VNC.Oem.Public. TimeOut

数值

VNC服务超时时间，单位：分钟

VNC.Oem.Public. SessionType

字符串

VNC服务会话类型信息

VNC.Oem.Public. NonSecurePortEnabled

布尔

VNC服务非安全端口使能状态

VNC.Oem.Public. SecurePortEnabled

布尔

VNC服务安全端口使能状态

HostName

字符串

主机名

FQDN

字符串

HDM的全称域名

说明：若未配置DNS上级域名时，返回null

Id

字符串

服务信息的ID名称

Name

字符串

服务集合资源名称

Status.Health

字符串

健康状态

Status.State

字符串

使能状态

Oem.Public.Sessions

对象

可创建会话的服务列表访问路径

 

【修改记录】

(1)     HDM2-1.62：G6 AMD产品支持iHDT功能；

(2)     HDM2-2.02：新增Actions.Oem.Public和对象Manager.RestartService；

(3)     HDM2-2.12：删除Telnet服务字段；

(4)     HDM3-1.16：删除Telnet服务字段；

 

4.4.20  设置服务信息

【功能描述】

设置IPMI、KVM、SNMP、SSDP、SSH、虚拟媒体、ASD|iHDT、VNC等服务的端口信息及使能状态。

【所属权限模块】

安全配置

【所属系统锁定类型】

BMC配置锁定

【命令格式】

PATCH https://device_ip/redfish/v1/Managers/manager_id/NetworkProtocol

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:ifmatch_value

【请求消息体】

{

  "ServerType": {

        "Oem": {

            "Public": {

                "NonSecurePortEnabled": nonsecure_port_enabled,

                "SecurePortEnabled": port_enabled,

                "TimeOut": time_out

            }

        },

        "Port": port,

        "ProtocolEnabled": protocol_enabled

  }

}

【参数说明】

表4-235 设置服务信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

ifmatch_value

请求消息的匹配参数

可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）

ServerType

待设置的服务类型

可修改的服务类型，包括： IPMI、KVMIP、SNMP、SSDP、SSH、CD-Media、VNC、ASD|iHDT等

ServerType.ProtocolEnabled

布尔型

服务的使能状态：true或者false

ServerType.Port

数值

服务启用端口号

ServerType .Oem.Public.SecurePortEnabled

布尔

安全端口使能状态：true或者false

ServerType .Oem.Public.NonSecurePortEnabled

布尔

非安全端口使能状态：true或者false

ServerType.Oem.Public.TimeOut

数值

超时时间，单位：分钟

 

【使用指南】

可修改一个或多个服务的参数。HTTPS服务不支持关闭。

IPMI服务默认开启安全端口，安全端口和非安全端口只能设置相同的端口号。

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/Managers/1/NetworkProtocol

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

    "KVMIP":{

        "Oem":{

            "Public":{

                "NonSecurePortEnabled":false,

                "SecurePortEnabled":true,

                "TimeOut":30

            }

        },

        "Port":7582,

        "ProtocolEnabled":true

    }

}

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#ManagerNetworkProtocol.ManagerNetworkProtocol",

    "@odata.id": "/redfish/v1/Managers/1/NetworkProtocol",

    "@odata.type": "#ManagerNetworkProtocol.v1_7_0.ManagerNetworkProtocol",

    "ASD": {

        "Oem": {

            "Public": {

                "MaxSessionCountSupported": 1,

                "NonSecurePort": 6868,

                "NonSecurePortEnabled": true,

                "SecurePort": null,

                "SecurePortEnabled": null,

                "SessionCount": 0,

                "SessionType": "ASD(Remote_XDP)",

                "TimeOut": null

            }

        },

        "Port": 6868,

        "ProtocolEnabled": false

},

"Actions": {

        "Oem": {

            "Public": {

                "#Manager.RestartService": {

                    "target": "/redfish/v1/Managers/1/NetworkProtocol/Actions/Oem/Public/Manager.RestartService"

                }

            }

        }

},

    "CD-Media": {

        "Oem": {

            "Public": {

                "MaxSessionCountSupported": 2,

                "NonSecurePort": 5120,

                "NonSecurePortEnabled": false,

                "SecurePort": 5124,

                "SecurePortEnabled": true,

                "SessionCount": 0,

                "SessionType": "CD-Media",

                "TimeOut": null

            }

        },

        "Port": 5124,

        "ProtocolEnabled": true

    },

    "Description": "Network Protocol Details",

    "FD-Media": {

        "Oem": {

            "Public": {

                "MaxSessionCountSupported": 1,

                "NonSecurePort": 5122,

                "NonSecurePortEnabled": false,

                "SecurePort": 5126,

                "SecurePortEnabled": true,

                "SessionCount": 0,

                "SessionType": "FD-Media",

                "TimeOut": null

            }

        },

        "Port": 5126,

        "ProtocolEnabled": true

    },

    "FQDN": null,

    "HD-Media": {

        "Oem": {

            "Public": {

                "MaxSessionCountSupported": 2,

                "NonSecurePort": 5123,

                "NonSecurePortEnabled": false,

                "SecurePort": 5127,

                "SecurePortEnabled": true,

                "SessionCount": 0,

                "SessionType": "HD-Media",

                "TimeOut": null

            }

        },

        "Port": 5127,

        "ProtocolEnabled": true

    },

    "HTTP": {

        "Oem": {

            "Public": {

                "MaxSessionCountSupported": 20,

                "NonSecurePort": 80,

                "NonSecurePortEnabled": true,

                "SecurePort": null,

                "SecurePortEnabled": null,

                "SessionCount": 0,

                "SessionType": "HTTP",

                "TimeOut": 30

            }

        },

        "Port": 80,

        "ProtocolEnabled": true

    },

    "HTTPS": {

        "Oem": {

            "Public": {

                "MaxSessionCountSupported": 20,

                "NonSecurePort": null,

                "NonSecurePortEnabled": null,

                "SecurePort": 443,

                "SecurePortEnabled": true,

                "SessionCount": 0,

                "SessionType": "HTTPS",

                "TimeOut": 30

            }

        },

        "Port": 443,

        "ProtocolEnabled": true

    },

    "HostName": "HDM",

    "IPMI": {

        "Oem": {

            "Public": {

                "MaxSessionCountSupported": null,

                "NonSecurePort": 624,

                "NonSecurePortEnabled": true,

                "SecurePort": 623,

                "SecurePortEnabled": false,

                "SessionCount": null,

                "SessionType": "IPMI",

                "TimeOut": null

            }

        },

        "Port": 624,

        "ProtocolEnabled": true

    },

    "Id": "NetworkProtocol",

    "KVMIP": {

        "Oem": {

            "Public": {

                "MaxSessionCountSupported": 4,

                "NonSecurePort": 7578,

                "NonSecurePortEnabled": false,

                "SecurePort": 7582,

                "SecurePortEnabled": true,

                "SessionCount": 0,

                "SessionType": "KVM",

                "TimeOut": 30

            }

        },

        "Port": 7582,

        "ProtocolEnabled": true

    },

    "Name": "Manager Network Protocol",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

"Sessions": {

                "@odata.id": "/redfish/v1/Managers/1/NetworkProtocol/Oem/Public/Sessions"

            }

        }

    },

    "SNMP": {

        "Oem": {

            "Public": {

                "MaxSessionCountSupported": null,

                "NonSecurePort": 161,

                "NonSecurePortEnabled": true,

                "SecurePort": null,

                "SecurePortEnabled": null,

                "SessionCount": null,

                "SessionType": "SNMP",

                "TimeOut": null

            }

        },

        "Port": 161,

        "ProtocolEnabled": true

},

    "SSDP": {

        "Oem": {

            "Public": {

                "MaxSessionCountSupported": null,

                "NonSecurePort": 1900,

                "NonSecurePortEnabled": true,

                "SecurePort": null,

                "SecurePortEnabled": null,

                "SessionCount": null,

                "SessionType": "SSDP",

                "TimeOut": null

            }

        },

        "Port": 1900,

        "ProtocolEnabled": true

    },

    "SSH": {

        "Oem": {

            "Public": {

                "MaxSessionCountSupported": 3,

                "NonSecurePort": null,

                "NonSecurePortEnabled": null,

                "SecurePort": 22,

                "SecurePortEnabled": true,

                "SessionCount": 0,

                "SessionType": "SSH",

                "TimeOut": 10

            }

        },

        "Port": 22,

        "ProtocolEnabled": true

    },

    "Status": {

        "Health": "OK",

        "State": "Enabled"

    },

    "VNC": {

        "Oem": {

            "Public": {

                "MaxSessionCountSupported": 2,

                "NonSecurePort": 5900,

                "NonSecurePortEnabled": true,

                "SecurePort": null,

                "SecurePortEnabled": null,

                "SessionCount": 0,

                "SessionType": "VNC",

                "TimeOut": 10

            }

        },

        "Port": 5900,

        "ProtocolEnabled": false

    }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回体同【查询服务信息】

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

(2)     HDM2-1.62：G6 AMD产品支持iHDT功能；

(3)     HDM2-2.12：删除Telnet服务字段；

(4)     HDM3-1.16：删除Telnet服务字段；

 

4.4.21  重启服务

【功能描述】

重启服务。

【所属权限模块】

安全配置

【命令格式】

POST https://device_ip/redfish/v1/Managers/manager_id/NetworkProtocol/Actions/Oem/Public/Manager.RestartService/

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"ResetType": "SNMP"

}

【参数说明】

表4-236 重启服务资源属性选项参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

ResetType

字符串

重启的服务类型，IPMI、KVMIP、SNMP、SSDP、SSH、CD-Media、VNC、ASD|iHDT等

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/Managers/1/NetworkProtocol/Actions/Oem/Public/Manager.RestartService/

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"ResetType": "SNMP"

}

【应答示例】

{

"Oem": {

       "Public": {

           "CompletionCode": 0,

           "Description": "Success"

       }

 },

"error": {

       "@Message.ExtendedInfo": [

           {

               "@odata.type": "#Message.v1_1_1.Message",

               "Message": "Successfully Completed Request",

               "MessageArgs": [],

               "MessageId": "Base.1.8.1.Success",

               "MessageSeverity": "OK",

               "Resolution": "None"

           }

       ],

        "code":"Base.1.8.1.Success",

        "message":"Successfully Completed Request"

    }

}

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-237 重启服务输出说明

字段

类型

字段说明

code

字符串

指示消息注册表中特定消息ID的字符串

message

字符串

与消息注册表中的消息对应的易读的错误消息

@Message.ExtendedInfo

消息扩展信息

@odata.type

字符串

消息资源的OData描述信息

MessageId

字符串

消息ID

Message

字符串

详细信息

MessageArgs

数组

信息参数

MessageSeverity

字符串

严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical

Resolution

字符串

解决建议

 

【修改记录】

(1)     HDM2-2.02：新增接口；

(2)     HDM2-2.04：Message.ExtendedInfo前添加error节点，并且在error节点下增加code和message字段；

 

4.4.22  查询可创建会话的服务列表信息

【功能描述】

查询可创建会话的服务列表信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/NetworkProtocol/Oem/Public/Sessions

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-238 查询可创建会话的服务列表信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

manager_id

管理资源的ID

当前所有机型取值为1

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Managers/1/NetworkProtocol/Oem/Public/Sessions

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#NetworkProtocolSessionsCollection.NetworkProtocolSessionsCollection",

    "@odata.id": "/redfish/v1/Managers/1/NetworkProtocol/Oem/Public/Sessions",

    "@odata.type": "#NetworkProtocolSessionsCollection.v1_0_0.NetworkProtocolSessionsCollection",

    "Description": "NetworkProtocol Sessions Collection",

    "Members": [

        {

            "@odata.id": "/redfish/v1/Managers/1/NetworkProtocol/Oem/Public/Sessions/HTTP"

        },

        {

            "@odata.id": "/redfish/v1/Managers/1/NetworkProtocol/Oem/Public/Sessions/HTTPS"

        },

        {

            "@odata.id": "/redfish/v1/Managers/1/NetworkProtocol/Oem/Public/Sessions/KVMIP"

        },

        {

            "@odata.id": "/redfish/v1/Managers/1/NetworkProtocol/Oem/Public/Sessions/CD-Media"

        },

        {

            "@odata.id": "/redfish/v1/Managers/1/NetworkProtocol/Oem/Public/Sessions/FD-Media"

        },

        {

            "@odata.id": "/redfish/v1/Managers/1/NetworkProtocol/Oem/Public/Sessions/HD-Media"

        },

        {

            "@odata.id": "/redfish/v1/Managers/1/NetworkProtocol/Oem/Public/Sessions/SSH"

        },

        {

            "@odata.id": "/redfish/v1/Managers/1/NetworkProtocol/Oem/Public/Sessions/ASD"

        },

        {

            "@odata.id": "/redfish/v1/Managers/1/NetworkProtocol/Oem/Public/Sessions/VNC"

        }

    ],

    "[email protected]": 10,

    "Name": "Manager Network Protocol",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    }

}

响应码：200

【输出说明】

表4-239 查询可创建会话的服务列表返回值

字段

类型

字段说明

@odata.context

字符串

服务会话列表资源模型的OData 描述信息

@odata.id

字符串

服务会话列表资源的访问路径

@odata.type

字符串

服务会话列表资源的类型

Description

字符串

服务会话列表资源的描述

Name

字符串

服务会话列表资源名称

Members

数组

服务会话列表资源列表

[email protected]

数值

服务会话列表资源数量

 

【修改记录】

(1)     HDM2-2.12：删除Telnet服务字段；

(2)     HDM3-1.16：删除Telnet服务字段；

 

4.4.23  查询指定服务的详细会话信息

【功能描述】

查询HTTPS、KVM、SSH、虚拟媒体、ASD|iHDT、VNC等服务的详细会话信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/NetworkProtocol/Oem/Public/Sessions/protocol_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-240 查询指定服务详细会话信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

manager_id

管理资源的ID

当前所有机型取值为1

protocol_id

服务类型

通过查询可创建会话的服务列表接口获取

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Managers/1/NetworkProtocol/Oem/Public/Sessions/HTTP

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#NetworkProtocolSessions.NetworkProtocolSessions",

    "@odata.id": "/redfish/v1/Managers/1/NetworkProtocol/Oem/Public/Sessions/HTTP",

    "@odata.type": "#NetworkProtocolSessions.v1_0_0.NetworkProtocolSessions",

    "Description": "NetworkProtocol Sessions",

    "Name": "HTTP",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "Sessions": [

        {

            "IPAddress": "192.168.247.19",

            "MySession": true,

            "RoleId": "Administrator",

            "SessionId": "16",

            "SessionType": "HTTP",

            "UserId": "1",

            "UserName": "admin"

        }

    ]

}

响应码：200

【输出说明】

表4-241 查询指定服务会话详细信息返回值

字段

类型

字段说明

@odata.context

字符串

服务会话详细信息资源模型的OData 描述信息

@odata.id

字符串

服务会话详细信息资源的访问路径

@odata.type

字符串

服务会话详细信息资源的类型

Description

字符串

服务会话详细信息资源的描述

Name

字符串

服务会话详细信息资源名称

Sessions

数组

服务会话详细信息

SessionId

字符串

会话ID

SessionType

字符串

会话类型

UserId

字符串

用户ID

UserName

字符串

用户名

IPAddress

字符串

IP地址

RoleId

字符串

用户角色

MySession

布尔

是否为本地会话

 

【修改记录】

(1)     HDM2-1.62： G6 AMD产品支持iHDT功能；

 

4.4.24  删除指定服务的会话信息

【功能描述】

删除HTTPS、KVM、SSH、虚拟媒体、ASD|iHDT、VNC等服务的会话信息。

【所属权限模块】

安全配置

【所属系统锁定类型】

BMC配置锁定

【命令格式】

DELETE https://device_ip/redfish/v1/Managers/manager_id/NetworkProtocol/Oem/Public/Sessions/protocol_id/session_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-242 删除服务详细会话信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

manager_id

管理资源的ID

当前所有机型取值为1

protocol_id

服务类型

通过查询可创建会话的服务列表接口获取

session_id

会话ID

通过查询指定服务的详细会话信息获取

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【使用实例】

【请求样例】

DELETE https://192.168.18.18/redfish/v1/Managers/1/NetworkProtocol/Oem/Public/Sessions/HTTPS/16

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

"Oem": {

       "Public": {

           "CompletionCode": 0,

           "Description": "Success"

       }

 },

"error": {

       "@Message.ExtendedInfo": [

           {

               "@odata.type": "#Message.v1_1_1.Message",

               "Message": "Successfully Completed Request",

               "MessageArgs": [],

               "MessageId": "Base.1.8.1.Success",

               "MessageSeverity": "OK",

               "Resolution": "None"

           }

       ],

        "code":"Base.1.8.1.Success",

        "message":"Successfully Completed Request"

    }

}

}

响应码：200

【输出说明】

表4-243 删除指定会话服务信息返回值

字段

类型

字段说明

code

字符串

指示消息注册表中特定消息ID的字符串

message

字符串

与消息注册表中的消息对应的易读的错误消息

@Message.ExtendedInfo

消息扩展信息

@odata.type

字符串

消息资源的OData描述信息

MessageId

字符串

消息ID

Message

字符串

详细信息

MessageArgs

数组

信息参数

MessageSeverity

字符串

严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical

Resolution

字符串

解决建议

 

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

(2)     HDM2-1.62：G6 AMD产品支持iHDT功能；

(3)     HDM2-2.04：Message.ExtendedInfo前添加error节点，并且在error节点下增加code和message字段；

 

4.4.25  查询节能服务信息

【功能描述】

查询节能服务信息。

【所属权限模块】

查询模块

【命令格式】

GET  https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/EnergySavingService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-244 查询节能服务信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Managers/1/Oem/Public/EnergySavingService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【响应样例】

{

    "@odata.context":"/redfish/v1/$metadata#EnergySavingService.EnergySavingService(*)",

    "@odata.id":"/redfish/v1/Managers/1/Oem/Public/EnergySavingService",

    "@odata.type":"#EnergySavingService.v1_0_0.EnergySavingService",

    "ServiceEnabled":true,

    "SavingComponents":[

        "PSU"

    ],

    "Name":"EnergySavingService",

    "Id":"EnergySavingService",

    "Oem":{

        "Public":{

            "CompletionCode":0,

            "Description":"Success"

        }

    }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-245 查询节能服务信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

节能服务信息的OData 描述信息

@odata.id

字符串

节能服务信息资源的访问路径

@odata.type

字符串

节能服务信息资源的类型

ServiceEnabled

布尔

节能服务使能状态

SavingComponents

数组

节能部件类型：

"PSU"

Name

字符串

节能服务信息资源名称

Id

字符串

节能服务信息资源ID

 

4.4.26  设置节能服务信息

【功能描述】

设置节能服务信息。

【所属权限模块】

电源控制

【所属系统锁定类型】

BMC配置锁定

【命令格式】

PATCH  https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/EnergySavingService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{  

"ServiceEnabled":true,

"SavingComponents": [

      "PSU"

]

}

【参数说明】

表4-246 设置节能服务信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

ServiceEnabled

布尔

节能服务使能状态

SavingComponents

数组

节能部件类型：

"PSU"

 

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/Managers/1/Oem/Public/EnergySavingService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"ServiceEnabled":true,

"SavingComponents": [

        "PSU"

    ]

}

【响应样例】

{

    "@odata.context":"/redfish/v1/$metadata#EnergySavingService.EnergySavingService(*)",

    "@odata.id":"/redfish/v1/Managers/1/Oem/Public/EnergySavingService",

    "@odata.type":"#EnergySavingService.v1_0_0.EnergySavingService",

    "ServiceEnabled":true,

    "SavingComponents":[

        "PSU"

    ],

    "Name":"EnergySavingService",

    "Id":"EnergySavingService",

    "Oem":{

        "Public":{

            "CompletionCode":0,

            "Description":"Success"

        }

    }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回字段说明同【查询节能服务信息】

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

 

4.4.27  HDM重启

【功能描述】

HDM重启。

【所属权限模块】

维护诊断

【命令格式】

POST https://device_ip/redfish/v1/Managers/manager_id/Actions/Manager.Reset

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"ResetType":type

}

【参数说明】

表4-247 HDM重启参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

ResetType

字符串

ForceRestart重启HDM

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/Managers/1/Actions/Manager.Reset

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"ResetType":"ForceRestart"

}

【应答示例】

{

"Oem": {

       "Public": {

           "CompletionCode": 0,

           "Description": "Success"

       }

 },

"error": {

       "@Message.ExtendedInfo": [

           {

               "@odata.type": "#Message.v1_1_1.Message",

               "Message": "Successfully Completed Request",

               "MessageArgs": [],

               "MessageId": "Base.1.8.1.Success",

               "MessageSeverity": "OK",

               "Resolution": "None"

           }

       ],

        "code":"Base.1.8.1.Success",

        "message":"Successfully Completed Request"

    }

}

}

响应码：200

【输出说明】

表4-248 HDM重启操作返回值

字段

类型

字段说明

code

字符串

指示消息注册表中特定消息ID的字符串

message

字符串

与消息注册表中的消息对应的易读的错误消息

@Message.ExtendedInfo

消息扩展信息

@odata.type

字符串

消息资源的OData描述信息

MessageId

字符串

消息ID

Message

字符串

详细信息

MessageArgs

数组

信息参数

MessageSeverity

字符串

严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical

Resolution

字符串

解决建议

 

【修改记录】

(1)     HDM2-2.04：Message.ExtendedInfo前添加error节点，并且在error节点下增加code和message字段；

 

4.4.28  恢复BMC出厂设置

【功能描述】

恢复BMC出厂设置。

【所属权限模块】

维护诊断

【所属系统锁定类型】

BMC配置锁定

【命令格式】

POST https://device_ip/redfish/v1/Managers/manager_id/Actions/Oem/Public/Manager.RestoreFactory

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

    "ConfigurationType": "BMC"

}

【参数说明】

表4-249 HDM恢复出厂参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

ConfigurationType

字符串

配置类型：当前仅支持BMC

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/Managers/1/Actions/Oem/Public/Manager.RestoreFactory

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

    "ConfigurationType": "BMC"

}

【应答示例】

{

"Oem": {

       "Public": {

           "CompletionCode": 0,

           "Description": "Success"

       }

 },

"error": {

       "@Message.ExtendedInfo": [

           {

               "@odata.type": "#Message.v1_1_1.Message",

               "Message": "Successfully Completed Request",

               "MessageArgs": [],

               "MessageId": "Base.1.8.1.Success",

               "MessageSeverity": "OK",

               "Resolution": "None"

           }

       ],

        "code":"Base.1.8.1.Success",

        "message":"Successfully Completed Request"

    }

}

}

响应码：200

【输出说明】

表4-250 恢复BMC出厂设置返回值

字段

类型

字段说明

code

字符串

指示消息注册表中特定消息ID的字符串

message

字符串

与消息注册表中的消息对应的易读的错误消息

@Message.ExtendedInfo

消息扩展信息

@odata.type

字符串

消息资源的OData描述信息

MessageId

字符串

消息ID

Message

字符串

详细信息

MessageArgs

数组

信息参数

MessageSeverity

字符串

严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical

Resolution

字符串

解决建议

 

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

(2)     HDM2-2.04：Message.ExtendedInfo前添加error节点，并且在error节点下增加code和message字段；

 

4.4.29  查询网口列表

【功能描述】

查询网口列表。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/EthernetInterfaces

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-251 查询网口列表信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Managers/1/EthernetInterfaces

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#EthernetInterfaceCollection.EthernetInterfaceCollection",

    "@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces",

    "@odata.type": "#EthernetInterfaceCollection.EthernetInterfaceCollection",

    "Description": "Collection of Ethernet Interfaces for this Manager",

    "Members": [

        {

            "@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces/eth0"

        },

        {

            "@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces/eth1"

        }

    ],

    "[email protected]": 2,

    "Name": "Ethernet Network Interface Collection",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success",

            "NcsiEnabled": true,

            "PortMode": "Normal",

            "SharedNetworkPort": {

                "@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces/Oem/Public/SharedNetworkPort"

            }

        }

    }

}

响应码：200

【输出说明】

表4-252 查询网口列表信息返回值

字段

类型

字段说明

@odata.context

字符串

网口列表资源的OData描述信息

@odata.id

字符串

网口集合资源的访问路径

@odata.type

字符串

网口集合资源类型

Description

字符串

网络列表资源信息的描述

Name

字符串

网络列表资源名称

Members

数组

网口列表信息查询路径

[email protected]

数值

网口设备个数

Oem.Public.PortMode

字符串

网口模式：

Normal： 正常模式

Bonding：bonding模式(B05支持)

Activestandby：网口自适应模式

Oem.Public.NcsiEnabled

布尔

指定端口NCSI使能：

true

false

Oem.Public.SharedNetworkPort

对象

共享网口资源访问路径

 

4.4.30  设置网口模式

【功能描述】

设置BMC网口模式

【所属权限模块】

常规配置

【所属系统锁定类型】

BMC配置锁定

【命令格式】

PATCH https://device_ip/redfish/v1/Managers/manager_id/EthernetInterfaces

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:ifmatch_value

【请求消息体】

{

"Oem":{

"Public":{

"PortMode":value,

"NcsiEnabled"：true

}

}

}

【参数说明】

表4-253 设置网口模式参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

ifmatch_value

请求消息的匹配参数

可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）

Oem.Public.PortMode

字符串

网口模式：

Normal：正常模式

Bonding：bonding模式(B05支持)

Activestandby：G6为自适应模式，B05为网口自适应模式

Oem.Public.NcsiEnabled

布尔

Ncsi是否开启：

true

false

 

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/Managers/1/EthernetInterfaces

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

"Oem":{

"Public":{

"PortMode": "Activestandby",

"NcsiEnabled": true

}

}

}

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#EthernetInterfaceCollection.EthernetInterfaceCollection",

    "@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces",

    "@odata.type": "#EthernetInterfaceCollection.EthernetInterfaceCollection",

    "Description": "Collection of Ethernet Interfaces for this Manager",

    "Members": [

        {

            "@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces/eth0"

        },

        {

            "@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces/eth1"

        }

    ],

    "[email protected]": 2,

    "Name": "Ethernet Network Interface Collection",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success",

            "NcsiEnabled": true,

            "PortMode": "Activestandby",

            "SharedNetworkPort": {

                "@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces/Oem/Public/SharedNetworkPort"

            }

        }

    }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

输出字段说明同【查询网口列表】

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

 

4.4.31  查询共享网口信息

【功能描述】

获取BMC共享网口信息

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/EthernetInterfaces/Oem/Public/SharedNetworkPort

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【参数说明】

表4-254 查询共享网口信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Managers/1/EthernetInterfaces/Oem/Public/SharedNetworkPort

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【应答示例】

{

  "@odata.context": "/redfish/v1/$metadata#SharedNetworkPort.SharedNetworkPort",

  "@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces/Oem/Public/SharedNetworkPort",

  "@odata.type": "#SharedNetworkPort.v1_0_0.SharedNetworkPort",

  "AdaptiveEnabled": false,

  "CardAdaptiveEnabled": false,

  "CardPriorityList": [

    "OCP1 Nic",

    "OCP2 Nic",

    "OCP3/PCIe Nic"

  ],

  "LastSharedPort": 1,

  "[email protected]": [

    {

      "OCP1 Nic": {

        "HotPlugSupported": true,

        "PortAllowableValues": [

          "Port1",

          "Port2"

        ],

        "State": true

      }

    },

    {

      "OCP2 Nic": {

        "HotPlugSupported": true,

        "PortAllowableValues": [

          "Port1",

          "Port2"

        ],

        "State": false

      }

    },

    {

      "OCP3/PCIe Nic": {

        "HotPlugSupported": false,

        "PortAllowableValues": [

          "Port1",

          "Port2"

        ],

        "State": false

      }

    }

  ],

  "NetworkCardType": "OCP1 Nic",

  "Oem": {

    "Public": {

      "CompletionCode": 0,

      "Description": "Success"

    }

  },

  "SharedPortInUse": 1,

  "SharedPortLinkState": [

    {

      "Port1": "Down"

    },

    {

      "Port2": "Down"

    }

  ]

}

响应码：200

【输出说明】

表4-255 查询共享网口信息输出参数说明

参数

参数说明

取值

SharedPortInUse

数值

共享口使用的端口

SharedPortLinkState

字符串

共享网卡的所有端口的link状态，如：

Down

Up

NetworkCardType

字符串

网卡类型

AdaptiveEnabled

布尔

端口自适应使用

True

False

[email protected]

数组

State

字符串

在位状态

HotPlugSupported

布尔

是否支持热拔插

true

false

LinkStatus

字符串

网口连接状态

PortAllowableValues

数组

所有端口

CardAdaptiveEnabled

布尔

网卡自适应是否开启

LastSharedPort

数值

上一次端口号

 

4.4.32  设置共享网口信息

【功能描述】

设置共享网口信息

【所属权限模块】

常规配置

【所属系统锁定类型】

BMC配置锁定

【命令格式】

PATCH https://device_ip/redfish/v1/Managers/manager_id/EthernetInterfaces/Oem/Public/SharedNetworkPort

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:ifmatch_value

【请求消息体】

{

  "AdaptiveEnabled":true,

  "NetworkCardType":"Onboard Nic",

  "SharedPortInUse":1,

  "CardAdaptiveEnabled"：true,

  "CardPriorityList"：[

      "OCP3/PCIe Nic",

      "OCP2 Nic",

      "OCP1 Nic"

  ]

}

【参数说明】

表4-256 设置共享网口模式参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

ifmatch_value

请求消息的匹配参数

可通过对相应资源发起GET 操作，从响应头中获取（对应于”ETag”参数）

AdaptiveEnabled

布尔

端口自适应是否开启

NetworkCardType

字符串

字符串网卡类型

Onboard Nic

OCP Nic

PCIe Nic

SharedPortInUse

数字

端口号

CardAdaptiveEnabled

布尔

网卡自适应使能

CardPriorityList

数组

网卡优先级列表

 

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/Managers/1/EthernetInterfaces/Oem/Public/SharedNetworkPort

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{ 

    "AdaptiveEnabled": false,

    "SharedPortInUse":2,

    "CardAdaptiveEnabled":true,

    "CardPriorityList":[

        "OCP1 Nic",

        "OCP2 Nic",

        "OCP3/PCIe Nic"

    ]

}

【返回示例】

{

    "@odata.context": "/redfish/v1/$metadata#SharedNetworkPort.SharedNetworkPort",

    "@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces/Oem/Public/SharedNetworkPort",

    "@odata.type": "#SharedNetworkPort.v1_0_0.SharedNetworkPort",

    "AdaptiveEnabled": false,

    "CardAdaptiveEnabled": true,

    "CardPriorityList": [

        "OCP1 Nic",

        "OCP2 Nic",

        "OCP3/PCIe Nic"

    ],

    "LastSharedPort": 2,

    "[email protected]": [

        {

            "OCP1 Nic": {

                "HotPlugSupported": true,

                "PortAllowableValues": [

                    "Port1",

                    "Port2"

                ],

                "State": true

            }

        },

        {

            "OCP2 Nic": {

                "HotPlugSupported": true,

                "PortAllowableValues": [

                    "Port1",

                    "Port2"

                ],

                "State": true

            }

        },

        {

            "OCP3/PCIe Nic": {

                "HotPlugSupported": true,

                "PortAllowableValues": [

                    "Port1",

                    "Port2"

                ],

                "State": true

            }

        }

    ],

    "NetworkCardType": "OCP1 Nic",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "SharedPortInUse": 2,

    "SharedPortLinkState": [

        {

            "Port1": "Down"

        },

        {

            "Port2": "Up"

        }

    ]

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

输出字段说明同【查询共享网口信息】

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

 

4.4.33  查询指定网口信息

【功能描述】

查询指定网口信息。X18000产品不支持网口为专用口。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/EthernetInterfaces/networkinterface_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-257 查询指定网口信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

networkinterface_id

指定网口的ID名称

由网口列表中查询

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Managers/1/EthernetInterfaces/eth0

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context":"/redfish/v1/$metadata#EthernetInterface.EthernetInterface",

    "@odata.id":"/redfish/v1/Managers/1/EthernetInterfaces/eth0",

    "@odata.type":"#EthernetInterface.v1_6_0.EthernetInterface",

    "AutoNeg":true,

    "Description":"Ethernet Interface eth0",

    "FQDN":null,

    "FullDuplex":true,

    "HostName":"HDM2019",

    "IPv4Addresses":[

        {

            "Address":"192.168.188.198",

            "AddressOrigin":"Static",

            "Gateway":"",

            "SubnetMask":"255.255.0.0"

        }

    ],

    "IPv4StaticAddresses":[

        {

            "Address":"192.168.188.198",

            "AddressOrigin":"Static",

            "Gateway":"",

            "SubnetMask":"255.255.0.0"

        }

    ],

    "IPv6Addresses":[

        {

            "Address":"fe80::a8bb:ccff:fed2:4718",

            "AddressOrigin":"LinkLocal",

            "AddressState":"Preferred",

            "PrefixLength":64

        },

        {

            "Address":"2015::1",

            "AddressOrigin":"Static",

            "AddressState":"Preferred",

            "PrefixLength":64

        },

        {

            "Address":"3ffe:501:eeee:2:a8bb:ccff:fed2:4718",

            "AddressOrigin":"SLAAC",

            "AddressState":"Preferred",

            "PrefixLength":64

        }

    ],

    "IPv6DefaultGateway":"2015::123",

    "IPv6StaticAddresses":{

        "Address":"2015::1",

        "PrefixLength":64

    },

    "IPv6StaticDefaultGateways":[

        "2015::123"

    ],

    "Id":"eth0",

    "InterfaceEnabled":true,

    "MACAddress":"aa:bb:cc:d2:47:18",

    "MTUSize":1500,

    "MaxIPv6StaticAddresses":16,

    "Name":"eth0",

    "NameServers":[

        null,

        null,

        null,

        null,

        null,

        null

    ],

    "Oem":{

        "Public":{

            "AdaptiveFlag":false,

            "ChannelNumber":1,

            "CompletionCode":0,

            "DNS":{

                "IPv4DNS":{

                    "DNSEnabled":false,

                    "DNSMode":null,

                    "SuperiorDomain":""

                },

                "IPv6DNS":{

                    "DNSEnabled":true,

                    "DNSMode":"Manual",

                    "SuperiorDomain":""

                }

            },

            "Description":"Success",

            "IPv4": {

               "StaticRoutes": [

                   {

                       "Destination": "",

                       "Gateway": "",

                       "SubnetMask": ""

                   },

                   {

                       "Destination": "",

                       "Gateway": "",

                       "SubnetMask": ""

                   }

               ]

            },

            "IPv4Enabled":true,

            "IPv6": {

               "StaticRoutes": [

                   {

                       "Destination": "",

                       "Gateway": "",

                       "PrefixLength": 0

                   },

                   {

                       "Destination": "",

                       "Gateway": "",

                       "PrefixLength": 0

                   }

               ]

            },

            "IPv6Enabled":true,

            "[email protected]":[

                {

                    "LinkStatus":"Connected",

                    "Location":"mainboard",

                    "Type":"Dedicated"

                }

            ],

            "PreferredPortId":"0",

            "SameSegmentCode":0

        }

    },

    "PermanentMACAddress":"aa:bb:cc:d2:47:18",

    "SpeedMbps":1000,

    "Status":{

        "Health":"OK",

        "State":"Enabled"

    },

    "VLAN":{

        "VLANEnable":false,

        "VLANId":0,

        "VLANPriority":0

    }

}

响应码：200

【输出说明】

表4-258 查询指定网口信息返回值

字段

类型

字段说明

@odata.context

字符串

指定网口资源模型的OData描述信息

@odata.id

字符串

指定网口资源的访问路径

@odata.type

字符串

指定网口资源类型

Description

字符串

指定网口资源信息的描述

AutoNeg

布尔型

自动协商是否开启

FQDN

字符串

HDM的全称域名

说明：若未配置DNS上级域名时，返回null

FullDuplex

布尔型

全双工是否开启

HostName

字符串

主机名

IPv4Addresses.Address

字符串

IPv4地址

IPv4Addresses.AddressOrigin

字符串

IPv4地址获取模式

IPv4Addresses.Gateway

字符串

IPv4网关

IPv4Addresses.SubnetMask

字符串

IPv4子网掩码

IPv4StaticAddresses.Address

字符串

静态IPv4地址

IPv4StaticAddresses.AddressOrigin

字符串

静态IPv4协议类型

IPv4StaticAddresses.Gateway

字符串

静态IPv4网关

IPv4StaticAddresses.SubnetMask

字符串

静态IPv4子网掩码

IPv6Addresses.Address

字符串

IPv6地址

IPv6Addresses.AddressOrigin

字符串

IPv6地址获取模式

IPv6Addresses.PrefixLength

数值

IPv6前缀长度

IPv6Addresses.AddressState

字符串

IPV6地址状态：

Preferred：成功

Failed：失败

Tentative：挂起

IPv6DefaultGateway

字符串

IPv6默认网关

IPv6StaticAddresses

数组

IPv6静态地址

IPv6StaticDefaultGateways

数组

IPv6静态网关

Id

字符串

网口ID

[email protected]  数组

LinkStatus

字符串

端口连接状态：

Connected

Disconnected

Location

字符串

网卡位置：主板显示“mainboard”其余显示PCIeSlot+slot

PortNumber

数值

共享端口的端口号

Type

字符串

端口类型：

Dedicated专用口

Shared 共享口

InterfaceEnabled

布尔型

网口是否使能

MACAddress

字符串

MAC地址

MTUSize

字符串

MTU最大值

MaxIPv6StaticAddresses

字符串

IPv6静态地址最大长度

Name

字符串

网口名称

NameServers

数组

DNS服务器IP地址信息列表，前三个是IPv4地址，后三个是IPv6地址

Oem.Public.AdaptiveFlag

布尔型

端口自适应模式

true：打开

false：关闭

Oem.Public.ChannelNumber

数值

指定网口通道号

Oem.Public.IPv4Enabled

布尔

IPv4是否启用

Oem.Public.IPv4.StaticRoutes.Destination

字符串

IPv4目的网络地址

Oem.Public.IPv4.StaticRoutes.SubnetMask

字符串

ipv4地址的子网掩码

Oem.Public.IPv4.StaticRoutes.Gateway

字符串

IPv4静态路由网关地址

Oem.Public.IPv6.StaticRoutes.Destination

字符串

IPv6目的网络地址

Oem.Public.IPv6.StaticRoutes.PrefixLength

数值

IPv6地址的子网前缀长度

Oem.Public.IPv6.StaticRoutes.Gateway

字符串

IPv6静态路由网关

Oem.Public.IPv6Enabled

布尔

IPv6是否启用

Oem.Public.IPv6LocalLinkAddress

字符串

IPv6本地链路地址

Oem.Public.IPv6StatelessAddress

字符串

IPv6无状态地址

Oem.Public.DNS.IPv4DNS.DNSMode

字符串

IPV4dns服务器自动配置

"Manual"

"Auto"

Oem.Public.DNS.IPv4DNS.DNSEnabled

布尔

IPV4DNS是否开启

Oem.Public.DNS.IPv4DNS.SuperiorDomain

字符串

IPV4上级域名

Oem.Public.DNS.IPv6DNS.DNSMode

字符串

IPV6dns服务器自动配置

"Manual"

"Auto"

Oem.Public.DNS.IPv6DNS.DNSEnabled

布尔

IPV6DNS是否开启

Oem.Public.DNS.IPv6DNS.SuperiorDomain

字符串

IPV6上级域名

Oem.Public.PreferredPortId

字符串

0 主用eth0 1主用eth1

Oem.Public.SameSegmentCode

数值

是否同网段

0 没有冲突

1代表v4冲突

2代表v6冲突

3代表全部冲突

PermanentMACAddress

字符串

固定MAC地址

SpeedMbps

字符串

传输速率，单位Mbps

VLAN.VLANEnable

字符串

VLAN是否使能

VLAN.VLANId

数值

VLAN ID

Status.Health

字符串

健康状态

Status.State

字符串

健康状态使能

 

【修改记录】

(1)     HDM2-1.60：新增字段Oem.Public.IPv4.StaticRoutes.Destination、

(2)     Oem.Public.IPv4.StaticRoutes.SubnetMask、Oem.Public.IPv4.StaticRoutes.Gateway、Oem.Public.IPv6StaticRoutes.Destination、Oem.Public.IPv6.StaticRoutes.Gateway、Oem.Public.IPv6StaticRoutes.PrefixLength

 

4.4.34  设置指定网口信息

【功能描述】

设置指定的网口信息。

【所属权限模块】

常规配置

【所属系统锁定类型】

BMC配置锁定

【命令格式】

PATCH https://device_ip/redfish/v1/Managers/manager_id/EthernetInterfaces/networkinterface_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:ifmatch_value

【请求消息体】

{

    "AutoNeg":false,

    "FullDuplex":true,

    "SpeedMbps":1000,

    "IPv4Addresses":[

        {

            "Address":"192.168.188.198",

            "SubnetMask":"255.255.0.0",

            "Gateway":"192.168.1.2",

            "AddressOrigin":"Static"

        }

    ],

    "IPv4StaticAddresses":[

        {

            "Address":"192.168.188.198",

            "SubnetMask":"255.255.0.0",

            "Gateway":"",

            "AddressOrigin":"Static"

        }

    ],

    "IPv6Addresses":[

        {

            "Address":"2015::1",

            "PrefixLength":64,

            "AddressOrigin":"Static"

        }

    ],

    "IPv6StaticAddresses":[

        {

            "Address":"2015::1",

            "PrefixLength":64

        }

    ],

    "IPv6DefaultGateway":"2015::9",

    "IPv6StaticDefaultGateways":[

        "2015::123"

    ],

    "HostName":"HDM2019",

    "VLAN":{

        "VLANEnable":false

    },

    "NameServers":[

        "192.168.1.2",

        "192.168.12.25",

        null,

        "6061::2220:8ff:fe07:1348",

        null,

        null

    ],

    "Oem":{

        "Public":{

            "IPv4Enabled":true,

            "IPv6Enabled":true,

"IPv4": {

               "StaticRoutes": [

                   {

                       "Destination": "172.168.0.0",

                       "Gateway": "192.168.2.2",

                       "SubnetMask": "255.255.0.0"

                   },

                   {

                       "Destination": "",

                       "Gateway": "",

                       "SubnetMask": ""

                   }

               ]

            },

"           IPv6": {

               "StaticRoutes": [

                   {

                       "Destination": "9001::",

                       "Gateway": "3001::123",

                       "PrefixLength": 64

                   },

                   {

                       "Destination": "",

                       "Gateway": "",

                       "PrefixLength": 0

                   }

               ]

            },

            "DNS":{

                "IPv4DNS":{

                    "DNSMode":"Manual",

                    "DNSEnabled":true,

                    "SuperiorDomain":"www.li.com"

                },

                "IPv6DNS":{

                    "DNSMode":"Manual",

                    "DNSEnabled":true,

                    "SuperiorDomain":"www.hai.com"

                }

            }

        }

    }

}

【参数说明】

表4-259 设置指定网口信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

ifmatch_value

请求消息的匹配参数

可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）

AutoNeg

布尔

是否自动协商

FullDuplex

布尔

是否全双工

SpeedMbps

数值

网口速率（共享口不支持），仅支持专用口在关闭自动协商时配置，且只有10/100/1000三种速率

networkinterface_id

网络名称

由网口列表中查询

IPv4Addresses.Address

字符串

IPv4地址

IPv4Addresses.Gateway

字符串

IPv4网关

IPv4Addresses.SubnetMask

字符串

IPv4子网掩码

IPv4Addresses.AddressOrigin

字符串

IPv4地址获取模式：

“Static”或“DHCP”

IPv4StaticAddresses.Address

字符串

静态IPv4地址

IPv4StaticAddresses.Gateway

字符串

静态IPv4网关

IPv4StaticAddresses.SubnetMask

字符串

静态IPv4子网掩码

IPv4StaticAddresses.AddressOrigin

字符串

静态IPv4地址获取模式：

“Static”

IPv6Addresses.Address

字符串

IPv6地址

IPv6Addresses.PrefixLength

数值

ipv6地址前缀长度

IPv6Addresses.AddressOrigin

字符串

IPv6地址获取模式“Static”或“DHCPv6”

IPv6StaticAddresses

数组

IPv6静态地址

IPv6DefaultGateway

字符串

IPv6默认网关

IPv6StaticDefaultGateways

数组

IPv6静态网关

HostName

字符串

主机名

Vlan

数值

VLAN ID

NameServers

数组

BMC管理网口地址为动态模式时，所需的DNS服务器信息。格式为：

[

"主DNS服务器IPv4或IPv6地址",

"备DNS服务器IPv4或IPv6地址"

]

G6新增需求，需要同时下发6个，前三个为IPv4，后三个为IPv6，设置为空则下发null

Oem.Public.ChannelNumber

数值

指定网口通道号

Oem.Public.IPv4Enabled

布尔

IPv4是否启用

Oem.Public.IPv4.StaticRoutes.Destination

字符串

IPv4目的网络地址

Oem.Public.IPv4.StaticRoutes.SubnetMask

字符串

ipv4地址的子网掩码

Oem.Public.IPv4.StaticRoutes.Gateway

字符串

IPv4静态路由网关地址

Oem.Public.IPv6.StaticRoutes.Destination

字符串

IPv6目的网络地址

Oem.Public.IPv6.StaticRoutes.PrefixLength

字符串

IPv6地址的子网前缀长度

Oem.Public.IPv6.StaticRoutes.Gateway

字符串

IPv6静态路由网关

Oem.Public.IPv6Enabled

布尔

IPv6是否启用

Oem.Public.DNS.IPv4DNS.HostConfig

数值

IPV4主机设置参数

Oem.Public.DNS.IPv4DNS.DNSMode

字符串

IPV4dns服务器自动配置

"Manual"

"Auto"

Oem.Public.DNS.IPv4DNS.DNSEnabled

布尔

IPV4DNS是否开启

Oem.Public.DNS.IPv4DNS.SuperiorDomain

字符串

IPV4上级域名

Oem.Public.DNS.IPv6DNS.HostConfig

数值

IPV6主机设置参数

Oem.Public.DNS.IPv6DNS.DNSMode

字符串

IPV6dns服务器自动配置

"Manual"

"Auto"

Oem.Public.DNS.IPv6DNS.DNSEnabled

布尔

IPV6DNS是否开启

Oem.Public.DNS.IPv6DNS.SuperiorDomain

字符串

IPV6上级域名

 

【使用说明】

当设置IP地址获取模式为“DHCP” 、“DHCPv6”时，不可同时设置其他参数。

IPv4、IPv6、IPv6静态地址 数组大小只能为1。

Oem.Public.{IPv4Enabled,IPv6Enabled}两个字段，全部设置为false时，可用于关闭该网口。注意：共享口和专用口不能同时禁用，另外G5暂不支持该方式禁用专用口。

【使用实例1】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/Managers/1/EthernetInterfaces/eth0

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

    "IPv4Addresses":[

        {

            "Address":"192.168.77.77",

            "SubnetMask":"255.255.0.0",

            "Gateway":"",

            "AddressOrigin":"Static"

        }

    ],

    "IPv6Addresses":[

        {

            "Address":"2015::1",

            "PrefixLength":64,

            "AddressOrigin":"Static"

        }

    ],

    "IPv6StaticAddresses":[

        {

            "Address":"2015::1",

            "PrefixLength":64

        }

    ],

    "IPv6DefaultGateway":"2015::9",

    "IPv6StaticDefaultGateways":[

        "2015::123"

    ]

}

【应答示例】

{

    "@odata.context":"/redfish/v1/$metadata#EthernetInterface.EthernetInterface",

    "@odata.id":"/redfish/v1/Managers/1/EthernetInterfaces/eth0",

    "@odata.type":"#EthernetInterface.v1_6_0.EthernetInterface",

    "AutoNeg":true,

    "Description":"Ethernet Interface eth0",

    "FQDN":null,

    "FullDuplex":true,

    "HostName":"HDM2019",

    "IPv4Addresses":[

        {

            "Address":"192.168.77.77",

            "AddressOrigin":"Static",

            "Gateway":"",

            "SubnetMask":"255.255.0.0"

        }

    ],

    "IPv4StaticAddresses":[

        {

            "Address":"192.168.77.77",

            "AddressOrigin":"Static",

            "Gateway":"",

            "SubnetMask":"255.255.0.0"

        }

    ],

    "IPv6Addresses":[

        {

            "Address":"fe80::a8bb:ccff:fed2:4718",

            "AddressOrigin":"LinkLocal",

            "AddressState":"Preferred",

            "PrefixLength":64

        },

        {

            "Address":"2015::1",

            "AddressOrigin":"Static",

            "AddressState":"Preferred",

            "PrefixLength":64

        },

        {

            "Address":"3ffe:501:eeee:2:a8bb:ccff:fed2:4718",

            "AddressOrigin":"SLAAC",

            "AddressState":"Preferred",

            "PrefixLength":64

        }

    ],

    "IPv6DefaultGateway":"2015::123",

    "IPv6StaticAddresses":{

        "Address":"2015::1",

        "PrefixLength":64

    },

    "IPv6StaticDefaultGateways":[

        "2015::123"

    ],

    "Id":"eth0",

    "InterfaceEnabled":true,

    "MACAddress":"aa:bb:cc:d2:47:18",

    "MTUSize":1500,

    "MaxIPv6StaticAddresses":16,

    "Name":"eth0",

    "NameServers":[

        null,

        null,

        null,

        null,

        null,

        null

    ],

    "Oem":{

        "Public":{

            "AdaptiveFlag":false,

            "ChannelNumber":1,

            "CompletionCode":0,

            "DNS":{

                "IPv4DNS":{

                    "DNSEnabled":false,

                    "DNSMode":null,

                    "SuperiorDomain":""

                },

                "IPv6DNS":{

                    "DNSEnabled":true,

                    "DNSMode":"Manual",

                    "SuperiorDomain":""

                }

            },

            "Description":"Success",

            "IPv4": {

               "StaticRoutes": [

                   {

                       "Destination": "",

                       "Gateway": "",

                       "SubnetMask": ""

                   },

                   {

                       "Destination": "",

                       "Gateway": "",

                       "SubnetMask": ""

                   }

               ]

            },

            "IPv4Enabled":true,

            "IPv6": {

               "StaticRoutes": [

                   {

                       "Destination": "",

                       "Gateway": "",

                       "PrefixLength": 0

                   },

                   {

                       "Destination": "",

                       "Gateway": "",

                       "PrefixLength": 0

                   }

               ]

            },

            "IPv6Enabled":true,

            "[email protected]":[

                {

                    "LinkStatus":"Connected",

                    "Location":"mainboard",

                    "Type":"Dedicated"

                }

            ],

            "PreferredPortId":"0",

            "SameSegmentCode":0

        }

    },

    "PermanentMACAddress":"aa:bb:cc:d2:47:18",

    "SpeedMbps":1000,

    "Status":{

        "Health":"OK",

        "State":"Enabled"

    },

    "VLAN":{

        "VLANEnable":false,

        "VLANId":0,

        "VLANPriority":0

    }

}

响应码：200

【使用实例2-关闭网口】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/Managers/1/EthernetInterfaces/eth1

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

  "Oem":{

      "Public":{

          "IPv4Enabled":false,

          "IPv6Enabled":false

      }

  }

}

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#EthernetInterface.EthernetInterface",

    "@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces/eth1",

    "@odata.type": "#EthernetInterface.v1_6_0.EthernetInterface",

    "AutoNeg": true,

    "Description": "Ethernet Interface eth1",

    "FQDN": null,

    "FullDuplex": true,

    "HostName": "HDM",

    "IPv4Addresses": [

        {

            "Address": "",

            "AddressOrigin": "DHCP",

            "Gateway": "",

            "SubnetMask": ""

        }

    ],

    "IPv4StaticAddresses": [],

    "IPv6Addresses": [

        {

            "Address": "fe80::2223:5ff:fe24:1147",

            "AddressOrigin": "LinkLocal",

            "AddressState": "Tentative",

            "PrefixLength": 0

        },

        {

            "Address": "",

            "AddressOrigin": "DHCPv6",

            "AddressState": "N/A",

            "PrefixLength": 0

        },

        {

            "Address": "",

            "AddressOrigin": "SLAAC",

            "AddressState": "N/A",

            "PrefixLength": 0

        }

    ],

    "IPv6DefaultGateway": "",

    "IPv6StaticAddresses": null,

    "IPv6StaticDefaultGateways": [],

    "Id": "eth1",

    "InterfaceEnabled": false,

    "MACAddress": "",

    "MTUSize": 1500,

    "MaxIPv6StaticAddresses": 16,

    "Name": "eth1",

    "NameServers": [

        null,

        null,

        null,

        null,

        null,

        null

    ],

    "Oem": {

        "Public": {

            "AdaptiveFlag": false,

            "ChannelNumber": 8,

            "CompletionCode": 0,

            "DNS": {

                "IPv4DNS": {

                    "DNSEnabled": false,

                    "DNSMode": "Auto",

                    "SuperiorDomain": ""

                },

                "IPv6DNS": {

                    "DNSEnabled": false,

                    "DNSMode": "Auto",

                    "SuperiorDomain": ""

                }

            },

            "Description": "Success",

            "IPv4": {

               "StaticRoutes": [

                   {

                       "Destination": "",

                       "Gateway": "",

                       "SubnetMask": ""

                   },

                   {

                       "Destination": "",

                       "Gateway": "",

                       "SubnetMask": ""

                   }

               ]

            },

            "IPv4Enabled":false,

            "IPv6": {

               "StaticRoutes": [

                   {

                       "Destination": "",

                       "Gateway": "",

                       "PrefixLength": 0

                   },

                   {

                       "Destination": "",

                       "Gateway": "",

                       "PrefixLength": 0

                   }

               ]

            },

            "IPv6Enabled": false,

            "[email protected]": [],

            "PreferredPortId": "1",

            "SameSegmentCode": 0

        }

    },

    "PermanentMACAddress": "",

    "SpeedMbps": 1000,

    "Status": {

        "Health": "OK",

        "State": "Disabled"

    },

    "VLAN": {

        "VLANEnable": false,

        "VLANId": 0,

        "VLANPriority": 0

    }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

输出字段说明同【查询指定网口信息】

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

(2)     HDM2-1.54：补充说明与示例【使用实例2-关闭网口】，Oem.Public.{IPv4Enabled,IPv6Enabled}对网口全部设置false时，可关闭该网口；

(3)     HDM2-1.60：新增字段Oem.Public.IPv4.StaticRoutes.Destination、

(4)     Oem.Public.IPv4.StaticRoutes.SubnetMask、Oem.Public.IPv4.StaticRoutes.Gateway、Oem.Public.IPv6StaticRoutes.Destination、Oem.Public.IPv6.StaticRoutes.Gateway、Oem.Public.IPv6StaticRoutes.PrefixLength

 

4.4.35  查询虚拟媒体集合资源

【功能描述】

查询虚拟媒体集合资源。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/VirtualMedia

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求体】

无

【参数说明】

表4-260 查询虚拟媒体集合资源参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Managers/1/VirtualMedia

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#VirtualMediaCollection.VirtualMediaCollection",

    "@odata.id": "/redfish/v1/Managers/1/VirtualMedia",

    "@odata.type": "#VirtualMediaCollection.VirtualMediaCollection",

    "Actions": {

        "Oem": {

            "Public": {

                "#VirtualMedia.Config": {

                    "target": "/redfish/v1/Managers/1/VirtualMedia/Oem/Public/Actions/VirtualMedia.Config"

                },

"#VirtualMedia.StopMount": {

                    "target": "/redfish/v1/Managers/1/VirtualMedia/Oem/Public/Actions/VirtualMedia.StopMount"

                },

 

                "#VirtualMedia.VmmControl": [

                    {

                        "target": "/redfish/v1/Managers/1/VirtualMedia/CD/Oem/Public/Actions/VirtualMedia.VmmControl"

                    },

                    {

                        "target": "/redfish/v1/Managers/1/VirtualMedia/FD/Oem/Public/Actions/VirtualMedia.VmmControl"

                    },

                    {

                        "target": "/redfish/v1/Managers/1/VirtualMedia/HD/Oem/Public/Actions/VirtualMedia.VmmControl"

                    }

                ]

            }

        }

    },

    "Description": "Collection of Virtual Media redirected to host via this Manager",

    "Members": [

        {

            "@odata.id": "/redfish/v1/Managers/1/VirtualMedia/CD"

        },

        {

            "@odata.id": "/redfish/v1/Managers/1/VirtualMedia/FD"

        },

        {

            "@odata.id": "/redfish/v1/Managers/1/VirtualMedia/HD"

        }

    ],

    "[email protected]": 3,

    "Name": "Virtual Media Collection",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success",

            "MountStatus": {

                "@odata.id": "/redfish/v1/Managers/1/VirtualMedia/Oem/Public/MountStatus"

            }

        }

    }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-261 查询虚拟媒体集合资源输出参数说明

字段

类型

字段说明

@odata.context

字符串

虚拟媒体集合资源模型的OData 描述信息

@odata.id

字符串

虚拟媒体集合资源的访问路径

@odata.type

字符串

虚拟媒体集合资源的类型

Description

字符串

虚拟媒体集合资源的描述

Name

字符串

虚拟媒体集合资源的名称

Members

已开启的虚拟媒体类型访问列表

@odata.id

字符串

单个虚拟媒体节点的访问路径

[email protected]

数值

当前可以连接的虚拟媒体资源数量

Actions.Oem.Public.#VirtualMedia.Config

对象

虚拟媒体配置

Actions.Oem.Public.#VirtualMedia.VmmControl

对象

连接虚拟媒体

Oem.Public.MountStatus

对象

查询虚拟媒体连接状态

Actions.Oem.Public.#VirtualMedia.StopMount

对象

停止虚拟媒体挂载

 

4.4.36  查询虚拟媒体资源

【功能描述】

查询虚拟媒体资源。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/VirtualMedia/Virtualmedia_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求体】

无

【参数说明】

表4-262 查询虚拟媒体资源参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

Virtualmedia_id

虚拟媒体类型

支持三种类型：CD、HD、FD

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Managers/1/VirtualMedia/CD

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#VirtualMedia.VirtualMedia(*)",

    "@odata.id": "/redfish/v1/Managers/1/VirtualMedia/CD",

    "@odata.type": "#VirtualMedia.v1_4_0.VirtualMedia",

    "Connected": [

        {

            "ImageName": "CentOS.iso",

"Oem": {

"Public": {

"ImageType": "ImageFile"

                }

            },

            "MediaIndex": 0,

            "MediaTypes": "CD",

            "SessionIndex": 0

        }

    ],

    "Id": "CD",

    "Name": "VirtualMedia",

    "NotConnected": [

        {

            "ImageName": "Test1.iso",

"Oem": {

                "Public": {

                      "ImageType": "ImageFile"

                }

            },

            "Index": 0,

            "MediaTypes": "CD"

        },

        {

            "ImageName": "Test2.iso",

"Oem": {

                "Public": {

                      "ImageType": "ImageFile"

                }

            },

            "Index": 1,

            "MediaTypes": "CD"

        },

        {

            "ImageName": "ZBC.iso",

            "Index": 2,

"Oem": {

                "Public": {

                      "ImageType": "ImageFile"

                }

            },

            "MediaTypes": "CD"

        },

        {

            "ImageName": "Zwe.iso",

            "Index": 3,

"Oem": {

                "Public": {

                      "ImageType": "ImageFile"

                }

            },

            "MediaTypes": "CD"

        }

    ],

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-263 查询虚拟媒体资源输出参数说明

字段

类型

字段说明

@odata.context

字符串

虚拟媒体CD资源模型的OData 描述信息

@odata.id

字符串

虚拟媒体CD资源的访问路径

@odata.type

字符串

虚拟媒体CD资源的类型

Id

字符串

虚拟媒体资源的ID

Name

字符串

虚拟媒体资源的名称

Connected

数组

已连接的镜像

Connected.MediaTypes

字符串

媒体镜像类型：

CD、HD、FD

Connected.ImageName

字符串

镜像名称

Connected.MediaIndex

数值

媒体实例

Connected.SessionIndex

数值

会话索引

Connected.Oem.Public.ImageType

字符串

镜像类型

NotConnected

数组

未连接镜像

NotConnected.ImageName

字符串

镜像名称

NotConnected.Oem.Public.ImageType

字符串

镜像类型

NotConnected.Index

数值

未连接镜像序号

NotConnected.MediaTypes

字符串

媒体镜像类型

 

【修改记录】

HDM3-1.15：新增Connected.Oem.Public.ImageType和NotConnected.Oem.Public.ImageType字段，该字段仅在HDM3 1.15及之后的版本支持，HDM2版本尚不支持。

 

4.4.37  查询虚拟媒体连接状态

【功能描述】

查询虚拟媒体连接状态。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/VirtualMedia/Oem/Public/MountStatus

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求体】

无

【参数说明】

表4-264 查询虚拟媒体连接状态参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Managers/1/VirtualMedia/Oem/Public/MountStatus

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#VirtualMediaMountStatus.VirtualMediaMountStatus",

    "@odata.id": "/redfish/v1/Managers/1/VirtualMedia/Oem/Public/MountStatus",

    "@odata.type": "#VirtualMediaMountStatus.v1_0_0.VirtualMediaMountStatus",

    "CD": [

        {

            "MediaIndex": 0,

            "Status": "Access permitted"

        },

        {

            "MediaIndex": 1,

            "Status": "Not started"

        }

    ],

    "FD": [

        {

            "MediaIndex": 0,

            "Status": "Not started"

        }

    ],

    "HD": [

        {

            "MediaIndex": 0,

            "Status": "Not started"

        },

        {

            "MediaIndex": 1,

            "Status": "Not started"

        }

    ],

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-265 查询虚拟媒体连接状态输出参数说明

字段

类型

字段说明

@odata.context

字符串

虚拟媒体资源连接状态模型的OData 描述信息

@odata.id

字符串

虚拟媒体资源的连接状态的访问路径

@odata.type

字符串

虚拟媒体资源的连接状态的类型

CD.MediaIndex

数值

媒体实例

CD.Status

字符串

连接状态

Not started：未启动

Access permitted：连接被接受

Access denied：连接被拒绝

Login failed：登录失败

Connection in use：在使用连接

Unauthorized：没有权限

Unknown error：未知错误

Access permitted：媒体分离阶段

Max number of login sessions reached：达到最大用户数

Access error;：无法连接

Invalid image：无效的镜像

Installation error：安装错误

Opening error：无法打开

Expired license：媒体许可证过期

Connection lost：连接丢失

Mount canceled by user：用户取消挂载

Device popped open：设备弹出

Session terminated：会话终止

 

4.4.38  查询虚拟媒体配置

【功能描述】

获取虚拟媒体配置。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/VirtualMedia/Oem/Public/Actions/VirtualMedia.Config

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求体】

无

【参数说明】

表4-266 查询虚拟媒体配置参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Managers/1/VirtualMedia/Oem/Public/Actions/VirtualMedia.Config

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#VirtualMediaConfig.VirtualMediaConfig",

    "@odata.id": "/redfish/v1/Managers/1/VirtualMedia/Oem/Public/Actions/VirtualMedia.Config",

    "@odata.type": "#VirtualMediaConfig.v1_0_0.VirtualMediaConfig",

    "Media": [

        {

            "DomainName": "",

            "FromPath": "/Share1",

            "MediaType": "CD",

            "ServerAddress": "192.168.27.14",

            "ShareType": "nfs",

            "State": "Enabled",

            "UserName": ""

        },

        {

            "DomainName": "",

            "FromPath": "",

            "MediaType": "FD",

            "ServerAddress": "",

            "ShareType": "",

            "State": "Disabled",

            "UserName": ""

        },

        {

            "DomainName": "",

            "FromPath": "",

            "MediaType": "HD",

            "ServerAddress": "",

            "ShareType": "",

            "State": "Disabled",

            "UserName": ""

        }

    ],

    "MediaSupport": true,

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success",

            "DomainName": "",

            "FromPath": "",

            "MediaType": "ALL",

            "ServerAddress": "",

            "ShareType": "",

            "State": "Disabled",

            "UserName": ""

        }

    }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-267 查询虚拟媒体配置输出参数说明

字段

类型

字段说明

@odata.context

字符串

虚拟媒体配置描述信息

@odata.type

字符串

虚拟媒体配置的类型

@odata.id

字符串

虚拟媒体配置访问路径

MediaSupport

布尔

远程媒体支持

Media.MediaType

字符串

媒体类型

Media.ShareType

字符串

挂载方式

Media.ServerAddress

字符串

服务器地址

Media.FromPath

字符串

源路径

Media.UserName

字符串

用户名

Media.State

字符串

Enabled：开启
Disabled：关闭
WrongSetting ：设置有误

Mounting：挂载中

Media.DomainName

字符串

域名

 

4.4.39  设置虚拟媒体配置

【功能描述】

 设置虚拟媒体配置。

【所属权限模块】

远程媒体

【命令格式】

PATCH https://device_ip/redfish/v1/Managers/manager_id/VirtualMedia/Oem/Public/Actions/VirtualMedia.Config

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求体】

{

  "MediaSupport":true,

"Media":[

{

        "MediaType":"CD",

        "State":"Enabled",

"ShareType":sharetype,

          "ServerAddress":ip,

"FromPath":"",

"UserName":"",

"Password":"",

"DomainName":DomainName

},

{

        "MediaType":"HD",

        "State":"Enabled",

"ShareType": sharetype,

          "ServerAddress":ip,

"FromPath":"",

"UserName":"",

"Password":"",

"DomainName":DomainName

},

{

        "MediaType":"FD",

        "State":"",

"ShareType": sharetype,

          "ServerAddress": ip,

"FromPath":"",

"UserName":"",

"Password":"",

"DomainName":DomainName

}

] ,

"Oem":{

   "Public":{

        "MediaType":"ALL",

        "State":"",

"ShareType":"",

          "ServerAddress":"",

"FromPath":"",

"UserName":"",

"DomainName":DomainName

}

}

}

【参数说明】

表4-268 配置虚拟媒体参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

MediaSupport

布尔

远程媒体支持，false时不下发其他参数

Media.MediaType

字符串

挂载类型

CD

HD

FD

Media.ShareType

字符串

分享类型

nfs

cifs

http

https

Media.ServerAddress

字符串

服务器地址

Media.FromPath

字符串

源路径

最大长度256

Media.UserName

字符串

用户名

最大长度256

分享类型为cifs生效

Media.Password

字符串

密码

最大长度32

分享类型为cifs生效

Media.State

字符串

Enabled：开启
Disabled：关闭

Media.DomainName

字符串

域名

最大长度255

分享类型为cifs生效

Oem.Public.MediaType

字符串

挂载类型

ALL

Oem.Public.State

字符串

Enabled：开启
Disabled：关闭

Oem.Public.ShareType

字符串

分享类型

nfs

cifs

http

https

Oem.Public.ServerAddress

字符串

服务器地址

Oem.Public.FromPath

字符串

源路径

最大长度256

Oem.Public.UserName

字符串

用户名

最大长度256

分享类型为cifs生效

Oem.Public.DomainName

字符串

域名

最大长度255

分享类型为cifs生效

 

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/Managers/1/VirtualMedia/Oem/Public/Actions/VirtualMedia.Config

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

  "MediaSupport":true,

    "Media": [

    {

        "MediaType":"CD",

        "State":"Enabled",

        "ShareType":"cifs",

        "ServerAddress":"192.168.44.56",

        "FromPath":"/Share1/config/CD",

        "UserName":"admin",

        "Password":"Password@_",

        "DomainName":"www.h3c.com"

    },

    {

        "MediaType":"HD",

        "State":"Enabled",

        "ShareType":"cifs",

        "ServerAddress":"192.168.44.56",

        "FromPath":"/Share1/config/HD",

        "UserName":"admin",

        "Password":"Password@_",

        "DomainName":"www.h3c.com"

    },

    {

        "MediaType":"FD",

        "State":"Enabled",

        "ShareType":"cifs",

        "ServerAddress":"192.168.44.56",

        "FromPath":"/Share1/config/FD",

        "UserName":"admin",

        "Password":"Password@_",

        "DomainName":"www.h3c.com"

    }

    ] ,

    "Oem":{

        "Public":{

            "MediaType":"ALL",

            "State":"Enabled",

            "ShareType":"cifs",

            "ServerAddress":"192.168.44.56",

            "FromPath":"/Share1/config/FD",

            "UserName":"admin",

            "Password":"Password@_",

            "DomainName":"www.h3c.com"

    }

    }

}

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#VirtualMediaConfig.VirtualMediaConfig",

    "@odata.id": "/redfish/v1/Managers/1/VirtualMedia/Oem/Public/Actions/VirtualMedia.Config",

    "@odata.type": "#VirtualMediaConfig.v1_0_0.VirtualMediaConfig",

    "Media": [

        {

            "DomainName": "www.h3c.com",

            "FromPath": "/Share1/config/FD",

            "MediaType": "CD",

            "ServerAddress": "192.168.44.56",

            "ShareType": "cifs",

            "State": "Mounting",

            "UserName": "admin"

        },

        {

            "DomainName": "www.h3c.com",

            "FromPath": "/Share1/config/FD",

            "MediaType": "FD",

            "ServerAddress": "192.168.44.56",

            "ShareType": "cifs",

            "State": "Mounting",

            "UserName": "admin"

        },

        {

            "DomainName": "www.h3c.com",

            "FromPath": "/Share1/config/FD",

            "MediaType": "HD",

            "ServerAddress": "192.168.44.56",

            "ShareType": "cifs",

            "State": "Mounting",

            "UserName": "admin"

        }

    ],

    "MediaSupport": true,

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success",

            "DomainName": "www.h3c.com",

            "FromPath": "/Share1/config/FD",

            "MediaType": "ALL",

            "ServerAddress": "192.168.44.56",

            "ShareType": "cifs",

            "State": "Mounting",

            "UserName": "admin"

        }

    }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

输出字段说明同【查询虚拟媒体配置】

【修改记录】

(1)     HDM2-2.08：虚拟媒体Media.ShareType、Oem.Public.ShareType支持协议http、https

(2)     HDM2-2.12：刷新命令格式示例

 

4.4.40  连接虚拟媒体

【功能描述】

连接虚拟媒体。

【所属权限模块】

远程媒体

【命令格式】

POST https://device_ip/redfish/v1/Managers/manager_id/VirtualMedia/Virtualmedia_id/Oem/Public/Actions/VirtualMedia.VmmControl

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求体】

nfs:

{

"VmmControlType":"Connect",

  "Image":"nfs://IP/Share/ERP.iso",

"Oem": {

        "Public": {

            "MediaIndex": value,

"ImageType": image_type

        }

    }

}

cifs:

{

"VmmControlType":"Connect",

  "Image":"cifs://user:password@IP/img/ERP.iso",

"Oem": {

        "Public": {

            "MediaIndex": value

        }

    }

}

https:

{

"VmmControlType":"Connect",

"Image":"https://IP/img/ERP.iso",

"Oem": {

        "Public": {

            "MediaIndex": value

        }

}

}

http:

{

"VmmControlType":"Connect",

"Image":"http://IP/img/ERP.iso",

"Oem": {

        "Public": {

            "MediaIndex": value

        }

}

}

【参数说明】

表4-269 连接虚拟媒体参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

Virtualmedia_id

挂载媒体类型

CD、HD、FD

VmmControlType

虚拟媒体操作类型

Connect： 连接虚拟媒体

Image

虚拟媒体镜像 uri

uri连接：支持协议： nfs、cifs、http、https，

长度最长1024，其中分项长度参考【设置虚拟媒体配置】

Oem.Public.MediaIndex

数字

媒体实例

Oem.Public.ImageType

字符串

镜像类型

 

【使用实例1】

【请求样例】

POST https://192.168.18.18/redfish/v1/Managers/1/VirtualMedia/CD/Oem/Public/Actions/VirtualMedia.VmmControl

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"VmmControlType":"Connect",    

  "Image":"nfs://192.168.190.51/Share/image.iso",

"Oem": {

        "Public": {

            "MediaIndex": 1,

"ImageType": "ImageFile"

        }

    }

}

【返回示例】

{

    "@odata.context": "/redfish/v1/$metadata#TaskCollection.TaskCollection",

    "@odata.type": "#TaskCollection.TaskCollection",

    "Members": [

        {

            "@odata.id": "/redfish/v1/TaskService/Tasks/3"

        }

    ],

    "[email protected]": 1,

    "Name": "Task Collection",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success",

            "TaskUniqueID": 1678656297

        }

    }

}

返回码202

【使用实例2】

【请求样例】

POST https://192.168.18.18/redfish/v1/Managers/1/VirtualMedia/CD/Oem/Public/Actions/VirtualMedia.VmmControl

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"VmmControlType":"Connect",

"Image":"cifs://user123:[email protected]/img/image.iso",

"Oem": {

        "Public": {

            "MediaIndex": 1,

"ImageType": "ImageFile"

        }

    }

}

【返回示例】

{

    "@odata.context": "/redfish/v1/$metadata#TaskCollection.TaskCollection",

    "@odata.type": "#TaskCollection.TaskCollection",

    "Members": [

        {

            "@odata.id": "/redfish/v1/TaskService/Tasks/3"

        }

    ],

    "[email protected]": 1,

    "Name": "Task Collection",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success",

            "TaskUniqueID": 1678656297

        }

    }

}

返回码202

 

【使用实例3】

【请求样例】

POST https://192.168.18.18/redfish/v1/Managers/1/VirtualMedia/CD/Oem/Public/Actions/VirtualMedia.VmmControl

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"VmmControlType":"Connect",

"Image":"http://192.168.190.51/img/image.iso",

"Oem": {

        "Public": {

            "MediaIndex": 1,

"ImageType": "ImageFile"

        }

    }

}

【返回示例】

{

    "@odata.context": "/redfish/v1/$metadata#TaskCollection.TaskCollection",

    "@odata.type": "#TaskCollection.TaskCollection",

    "Members": [

        {

            "@odata.id": "/redfish/v1/TaskService/Tasks/3"

        }

    ],

    "[email protected]": 1,

    "Name": "Task Collection",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success",

            "TaskUniqueID": 1678656297

        }

    }

}

返回码202

【使用实例4】

【请求样例】

POST https://192.168.18.18/redfish/v1/Managers/1/VirtualMedia/CD/Oem/Public/Actions/VirtualMedia.VmmControl

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"VmmControlType":"Connect",

"Image":"https://192.168.190.51/img/image.iso",

"Oem": {

        "Public": {

            "MediaIndex": 1,

"ImageType": "ImageFile"

        }

    }

}

【返回示例】

{

    "@odata.context": "/redfish/v1/$metadata#TaskCollection.TaskCollection",

    "@odata.type": "#TaskCollection.TaskCollection",

    "Members": [

        {

            "@odata.id": "/redfish/v1/TaskService/Tasks/3"

        }

    ],

    "[email protected]": 1,

    "Name": "Task Collection",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success",

            "TaskUniqueID": 1678656297

        }

    }

}

返回码202

【输出说明】

返回状态码202，表示操作成功。

表4-270 连接虚拟媒体输出说明

字段

类型

字段说明

@odata.context

字符串

任务服务资源模型的OData描述信息

@odata.type

字符串

任务服务资源的类型

Name

字符串

任务集合资源的名称

[email protected]

数值

当前运行的任务数量

Members

任务列表

@odata.id

字符串

指定任务的访问路径

Oem.Public.TaskUniqueID

数值

指定任务的唯一ID

 

【修改记录】

(1)     HDM2-2.08：Image新增连接虚拟媒体支持协议http、https

(2)     HDM3-1.15：请求体中Oem.Public.ImageType字段仅在HDM3 1.15及之后的版本支持，HDM2版本尚不支持

 

4.4.41  断开虚拟媒体

【功能描述】

断开虚拟媒体。

【所属权限模块】

远程媒体

【命令格式】

POST https://device_ip/redfish/v1/Managers/manager_id/VirtualMedia/Virtualmedia_id/Oem/Public/Actions/VirtualMedia.VmmControl

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求体】

{

"VmmControlType": value,

"Oem": {

        "Public": {

            "MediaIndex": value

        }

    }

}

【参数说明】

表4-271 断开虚拟媒体参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

Virtualmedia_id

挂载媒体类型

CD、HD、FD

VmmControlType

断开连接

Disconnect： 断开虚拟媒体

Oem.Public.MediaIndex

断开第几个虚拟媒体

可选参数，取值范围：0~1

默认断开MediaIndex为0的镜像

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/Managers/1/VirtualMedia/CD/Oem/Public/Actions/VirtualMedia.VmmControl

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

    "VmmControlType":"Disconnect",

    "Oem":{

        "Public":{

            "MediaIndex":1

        }

    }

}

【返回示例】

{

    "@odata.context": "/redfish/v1/$metadata#TaskCollection.TaskCollection",

    "@odata.type": "#TaskCollection.TaskCollection",

    "Members": [

        {

            "@odata.id": "/redfish/v1/TaskService/Tasks/2"

        }

    ],

    "[email protected]": 1,

    "Name": "Task Collection",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success",

            "TaskUniqueID": 1678656297

        }

    }

}

返回码202

【输出说明】

返回状态码202，表示操作成功。

表4-272 断开虚拟媒体操作输出参数说明

字段

类型

字段说明

@odata.context

字符串

任务服务资源模型的OData描述信息

@odata.type

字符串

任务服务资源的类型

Name

字符串

任务集合资源的名称

[email protected]

数值

当前运行的任务数量

Members

任务列表

@odata.id

字符串

指定任务的访问路径

Oem.Public.TaskUniqueID

数值

指定任务的唯一ID

 

4.4.42  停止虚拟媒体挂载

【功能描述】

停止正在挂载的路径

【所属权限模块】

远程媒体

【命令格式】

POST https://device_ip/redfish/v1/Managers/manager_id/VirtualMedia/Oem/Public/Actions/VirtualMedia.StopMount

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求体】

{

}

【参数说明】

表4-273 停止虚拟媒体挂载参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

manager_id

系统资源的ID

当前所有机型取值为1

 

【使用实例】

POST https://192.168.33.66/redfish/v1/Managers/1/VirtualMedia/Oem/Public/Actions/VirtualMedia.StopMount

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【应答示例】

{

  "Oem": {

    "Public": {

      "CompletionCode": 0,

      "Description": "Success"

    }

  },

  "error": {

    "@Message.ExtendedInfo": [

      {

        "@odata.type": "#Message.v1_1_1.Message",

        "Message": "Successfully Completed Request",

        "MessageArgs": [],

        "MessageId": "Base.1.8.1.Success",

        "MessageSeverity": "OK",

        "Resolution": "None"

      }

    ],

    "code": "Base.1.8.1.Success",

    "message": "Successfully Completed Request"

  }

}

响应码：200

【输出说明】

表4-274 停止虚拟媒体挂载输出参数说明

字段

类型

字段说明

@Message.ExtendedInfo

错误消息扩展信息

@odata.type

字符串

消息资源的OData描述信息

MessageId

字符串

消息ID

Message

字符串

详细信息

MessageArgs

数组

信息参数

MessageSeverity

字符串

严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical

Resolution

字符串

解决建议

 

4.4.43  查询所有操作日志列表信息

【功能描述】

查询所有操作日志列表信息。

【所属权限模块】

系统审计

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/OperationLog

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-275 查询所有操作日志列表资源说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Managers/1/Oem/Public/OperationLog

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#OperationLogCollection.OperationLogCollection",

    "@odata.id": "/redfish/v1/Managers/1/Oem/Public/OperationLog",

    "@odata.type": "#OperationLogCollection.OperationLogCollection",

    "Description": "Collection of entries for this operation log",

    "Members": [

        {

            "@odata.id": "/redfish/v1/Managers/1/LogServices/ConfigurationLog/Entries/6"

        },

        {

            "@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/5"

        },

        {

            "@odata.id": "/redfish/v1/Managers/1/LogServices/ConfigurationLog/Entries/4"

        },

        {

            "@odata.id": "/redfish/v1/Managers/1/LogServices/ConfigurationLog/Entries/3"

        },

        {

            "@odata.id": "/redfish/v1/Managers/1/LogServices/ConfigurationLog/Entries/2"

        },

        {

            "@odata.id": "/redfish/v1/Managers/1/LogServices/ConfigurationLog/Entries/1"

        }

    ],

    "[email protected]": 6,

    "Name": "Operate Log Collection",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-276 查询所有操作日志列表输出说明

字段

类型

字段说明

@odata.context

字符串

所有操作日志集合资源模型的 OData描述信息

@odata.id

字符串

所有操作日志服务集合资源的访问路径

@odata.type

字符串

所有操作日志集合资源的类型

Name

字符串

所有操作日志集合资源的名称

[email protected]

数字

当前所有操作日志资源数量

Members

所有操作日志资源列表

@odata.id

字符串

指定操作日志资源节点的访问路径

 

4.4.44  查询日志服务集合资源信息

【功能描述】

查询服务器当前日志服务集合资源信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/LogServices

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求体】

无

【参数说明】

表4-277 查询日志服务集合资源参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Managers/1/LogServices

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#Managers/Members/1/LogServices/$entity",

    "@odata.id": "/redfish/v1/Managers/1/LogServices",

    "@odata.type": "#LogServiceCollection.LogServiceCollection",

"Actions": {

"Oem": {

            "Public": {

                    "#LogService.ClearOperationLog": {

                      "target": "/redfish/v1/Managers/1/LogServices/Actions/Oem/Public/LogService.ClearOperationLog"

        },

                "#LogService.ExportOperationLog": {

                    "target": "/redfish/v1/Managers/1/LogServices/Actions/Oem/Public/LogService.ExportOperationLog"

                }

            }

        }

    },

    "Description": "Collection of LogServices resource",

    "Members": [

        {

            "@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog"

        },

        {

            "@odata.id": "/redfish/v1/Managers/1/LogServices/FirmwareUpdateLog"

        },

        {

            "@odata.id": "/redfish/v1/Managers/1/LogServices/ConfigurationLog"

        },

        {

            "@odata.id": "/redfish/v1/Managers/1/LogServices/HardwareUpdateLog"

        }

    ],

    "[email protected]": 4,

    "Name": "LogServices Collection",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-278 查询日志服务集合资源输出参数说明

字段

类型

字段说明

@odata.context

字符串

日志服务集合资源模型OData 描述信息

@odata.id

字符串

日志服务集合资源模型的访问路径

@odata.type

字符串

日志服务集合资源模型的类型

Name

字符串

日志服务集合资源模型的名称

[email protected]

数值

当前日志服务资源数量

Members

日志服务资源列表

@odata.id

字符串

单个日志服务资源节点的访问路径

Actions.Oem.Public.#LogService.ExportOperationLog

对象

导出操作日志的访问路径

Actions.Oem.Public.#LogService.ClearOperationLog

对象

清除操作日志的访问路径

 

4.4.45  查询指定日志服务资源信息

【功能描述】

查询服务器当前日志服务资源信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/LogServices/LogService_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-279 查询指定日志服务资源说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

LogService_id

日志类型

AuditLog

FirmwareUpdateLog

ConfigurationLog

HardwareUpdateLog

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Managers/1/LogServices/ConfigurationLog

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#Managers/Members/1/LogServices/Members/$entity",

    "@odata.id": "/redfish/v1/Managers/1/LogServices/ConfigurationLog",

    "@odata.type": "#LogService.v1_2_0.LogService",

    "DateTime": "2022-02-19T14:59:34+08:00",

    "DateTimeLocalOffset": "UTC+08:00",

    "Description": "Managers ServiceLog Instance for this Computer System",

    "Entries": {

        "@odata.id": "/redfish/v1/Managers/1/LogServices/ConfigurationLog/Entries"

    },

    "Id": "ConfigurationLog",

    "LogEntryType": "Multiple",

    "MaxNumberOfRecords": 1000,

    "Name": "ConfigurationLog",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "ServiceEnabled": true,

    "Status": {

        "Health": "OK",

        "State": "Enabled"

    }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-280 查询指定日志服务资源输出参数说明

字段

类型

字段说明

@odata.context

字符串

指定日志服务资源模型的OData描述信息

@odata.id

字符串

指定日志服务资源的访问路径

@odata.type

字符串

指定日志服务资源的类型

Id

字符串

指定日志服务资源的ID

Name

字符串

指定日志服务资源的名称

Description

字符串

指定日志服务资源的描述信息

MaxNumberOfRecords

数值

指定日志服务资源的最大可记录日志条数

DateTime

字符串

指定日志服务资源的系统时间

DateTimeLocalOffset

字符串

指定日志服务资源的时区

ServiceEnabled

字符串

指定日志服务资源的启用状态：

true

false

Entries

对象

日志集合资源的访问路径

 

4.4.46  查询日志集合资源信息

【功能描述】

查询服务器当前日志集合资源信息。

【所属权限模块】

系统审计

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/LogServices/LogService_id/Entries

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-281 查询日志集合资源信息说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

LogService_id

日志类型

AuditLog

FirmwareUpdateLog

ConfigurationLog

HardwareUpdateLog

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Managers/1/LogServices/ConfigurationLog/Entries

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#LogEntryCollection.LogEntryCollection",

    "@odata.id": "/redfish/v1/Managers/1/LogServices/ConfigurationLog/Entries",

    "@odata.type": "#LogEntryCollection.LogEntryCollection",

    "Description": "Collection of entries for this log service",

    "Members": [

        {

            "@odata.id": "/redfish/v1/Managers/1/LogServices/ConfigurationLog/Entries/6"

        },

        {

            "@odata.id": "/redfish/v1/Managers/1/LogServices/ConfigurationLog/Entries/4"

        },

        {

            "@odata.id": "/redfish/v1/Managers/1/LogServices/ConfigurationLog/Entries/3"

        },

        {

            "@odata.id": "/redfish/v1/Managers/1/LogServices/ConfigurationLog/Entries/2"

        },

        {

            "@odata.id": "/redfish/v1/Managers/1/LogServices/ConfigurationLog/Entries/1"

        }

    ],

    "[email protected]": 5,

    "Name": "Log Service Entries Collection",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-282 查询日志集合资源信息说明

字段

类型

字段说明

@odata.context

字符串

日志集合资源模型的 OData描述信息

@odata.id

字符串

日志服务集合资源的访问路径

@odata.type

字符串

日志集合资源的类型

Name

字符串

日志集合资源的名称

[email protected]

数字

当前日志资源数量

Members

日志资源列表

@odata.id

字符串

单个日志资源节点的访问路径

 

4.4.47  查询日志资源信息

【功能描述】

查询服务器当前日志资源信息。

【所属权限模块】

系统审计

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/LogServices/LogService_id/Entries/Entries_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-283 查询日志资源信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

LogService_id

日志类型

AuditLog

FirmwareUpdateLog

ConfigurationLog

HardwareUpdateLog

Entries_id

日志编号

从查询日志资源信息中获取

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Managers/1/LogServices/AuditLog/Entries/3

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#Systems/Members/1/LogServices/Log1/Entries/Members/$entity",

    "@odata.id": "/redfish/v1/Managers/1/LogServices/ConfigurationLog/Entries/3",

    "@odata.type": "#LogEntry.v1_7_0.LogEntry",

    "Created": "2022-02-19T12:11:18+08:00",

    "Description": "Instance of entries for this log service",

    "EntryType": "Multiple",

    "Id": 3,

    "Message": "Remote media settings configured successfully. Remote IP: 192.168.17.17, soure path: /Share1, server type: nfs, media type: CD/DVD.",

    "Modified": "2022-02-19T12:11:18+08:00",

    "Name": "ConfigurationLog",

    "Oem": {

        "Public": {

            "Address": "192.168.17.17",

            "CompletionCode": 0,

            "Description": "Success",

            "Hostname": "HDM",

            "Interface": "redfish",

            "User": "admin"

        }

    }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-284 查询日志资源信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

日志资源模型的 OData描述信息

@odata.id

字符串

日志资源的访问路径

@odata.type

字符串

日志资源的类型

Name

字符串

日志资源的名称

Created

字符串

日志创建时间

EntryType

字符串

日志类型

Message

字符串

日志描述信息

Modified

字符串

修改时间

Id

数字

日志ID

Oem.Public.Address

字符串

主机地址

Oem.Public.Hostname

字符串

主机名

Oem.Public.Interface

字符串

接口类型

Oem.Public.User

字符串

用户名

 

4.4.48  导出操作日志信息

【功能描述】

导出操作日志信息。

【所属权限模块】

系统审计

【命令格式】

POST https://device_ip/redfish/v1/Managers/manager_id/LogServices/Actions/Oem/Public/LogService.ExportOperationLog

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

本地导出

{

  "Type":"URI",

  "Content": "/tmp/web/dump.tar.gz"

}

远程导出

cifs或sftp

{

"Type":"URI",

"Content": "sftp://username:[email protected]/usr/dump.tar.gz"

}

http、tftp、nfs或https

{

  "Type":"URI",

"Content": "http://ip/filename",

"Oem": {

    "Public": {

        "ScriptName":"1.php"

    }

}

}

【参数说明】

表4-285 导出操作日志参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

Type

字符串

URI

Content

导出路径

见其它说明

Oem.Public.ScriptName

字符串

通过http/https协议导出时，需指定的脚本文件的名称

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/Managers/1/LogServices/Actions/Oem/Public/LogService.ExportOperationLog

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

本地导出

{

  "Type":"URI",

  "Content": "/tmp/web/OperateLog.csv"

}

远程导出

{

"Type":"URI",

"Content": "sftp://username:[email protected]/usr/OperateLog.csv"

}

【应答示例】

{

"Oem": {

       "Public": {

           "CompletionCode": 0,

           "Description": "Success"

       }

 },

"error": {

       "@Message.ExtendedInfo": [

           {

               "@odata.type": "#Message.v1_1_1.Message",

               "Message": "Successfully Completed Request",

               "MessageArgs": [],

               "MessageId": "Base.1.8.1.Success",

               "MessageSeverity": "OK",

               "Resolution": "None"

           }

       ],

        "code":"Base.1.8.1.Success",

        "message":"Successfully Completed Request"

    }

}

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-286 导出操作日志输出参数说明

字段

类型

字段说明

code

字符串

指示消息注册表中特定消息ID的字符串

message

字符串

与消息注册表中的消息对应的易读的错误消息

@Message.ExtendedInfo

消息扩展信息

@odata.type

字符串

消息资源的OData描述信息

MessageId

字符串

消息ID

Message

字符串

详细信息

MessageArgs

数组

信息参数

MessageSeverity

字符串

严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical

Resolution

字符串

解决建议

 

【修改记录】

(1)     HDM2-2.04：Message.ExtendedInfo前添加error节点，并且在error节点下增加code和message字段；

 

4.4.49  清空操作日志信息

【功能描述】

清空操作日志信息。

【所属权限模块】

常规配置

【命令格式】

POST https://device_ip/redfish/v1/Managers/manager_id/LogServices/Actions/Oem/Public/LogService.ClearOperationLog

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-287 清空操作日志参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/Managers/1/LogServices/Actions/Oem/Public/LogService.ClearOperationLog

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

"Oem": {

       "Public": {

           "CompletionCode": 0,

           "Description": "Success"

       }

 },

"error": {

       "@Message.ExtendedInfo": [

           {

               "@odata.type": "#Message.v1_1_1.Message",

               "Message": "Successfully Completed Request",

               "MessageArgs": [],

               "MessageId": "Base.1.8.1.Success",

               "MessageSeverity": "OK",

               "Resolution": "None"

           }

       ],

        "code":"Base.1.8.1.Success",

        "message":"Successfully Completed Request"

    }

}

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-288 清空操作日志输出参数说明

字段

类型

字段说明

code

字符串

指示消息注册表中特定消息ID的字符串

message

字符串

与消息注册表中的消息对应的易读的错误消息

@Message.ExtendedInfo

消息扩展信息

@odata.type

字符串

消息资源的OData描述信息

MessageId

字符串

消息ID

Message

字符串

详细信息

MessageArgs

数组

信息参数

MessageSeverity

字符串

严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical

Resolution

字符串

解决建议

 

【修改记录】

(1)     HDM2-2.04：Message.ExtendedInfo前添加error节点，并且在error节点下增加code和message字段；

 

4.4.50  收集SDS日志

【功能描述】

收集和打包SDS日志，并放到用户指定的目录下。

【所属权限模块】

系统审计

【命令格式】

POST https://device_ip/redfish/v1/Managers/manager_id/Actions/Oem/Public/Manager.Dump

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"StartTime":time,

"EndTime": time,

"Name":name,

"Telephone":phone,

"EmailAddress":address

"Type":"URI",

"Content": content,

"LogType":logtype,

"Oem": {

"Public": {

    "ScriptName":"xxxxx"

}

}

}

另：

"Content": "/mnt/sdmmc0p1/sds/bmc/dump.tar.gz", //本地导出，仅支持"/mnt/sdmmc0p1/sds/bmc/文件名"

"Content": "sftp://username:password@ip/usr/dump.tar.gz", //远程导出

【参数说明】

表4-289 收集SDS日志参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

StartTime

字符串

SDS日志开始时间，如：2017-04-05；

当请求体中有"StartTime"和"EndTime"时，收集这两个时间段的SDS日志，当两个时间都没有时，收集全部SDS日志

EndTime

字符串

SDS日志结束时间

Name

字符串

联系人姓名

（不对外提供，仅页面使用）

Telephone

字符串

联系人电话

（不对外提供，仅页面使用）

EmailAddress

字符串

联系人电子邮件

（不对外提供，仅页面使用）

Type

导出文件的方法

URI

Content

收集SDS日志路径

见其它说明，该接口仅支持"/mnt/sdmmc0p1/sds/bmc/文件名"

除_.之外的特殊符号会被忽略

LogType

字符串

下载日志类型：

事件日志”EventLog”

注：不下发默认下载全部日志

Oem.Public.ScriptName

字符串

通过http/https协议导出时，需指定的脚本文件的名称

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/Managers/1/Actions/Oem/Public/Manager.Dump

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"StartTime":"2022-04-05",

"EndTime":"2022-04-20",

"Type":"URI",

"Content": "/mnt/sdmmc0p1/sds/bmc/dump.tar.gz"

}

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#TaskCollection.TaskCollection",

    "@odata.type": "#TaskCollection.TaskCollection",

    "Members": [

        {

            "@odata.id": "/redfish/v1/TaskService/Tasks/1"

        }

    ],

    "[email protected]": 1,

    "Name": "Task Collection",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success",

            "FileName": "dump__20220219T082103-0400.tar.gz",

            "TaskUniqueID": 1678656297

        }

    }

}

 

响应码：202

【输出说明】

表4-290 收集SDS资源返回值

字段

类型

字段说明

@odata.context

字符串

任务服务资源模型的OData描述信息

@odata.type

字符串

任务服务资源的类型

Name

字符串

任务集合资源的名称

[email protected]

数值

当前运行的任务数量

Members

任务列表

@odata.id

字符串

指定任务的访问路径

Oem.Public.FileName

字符串

文件名

Oem.Public.TaskUniqueID

数值

指定任务的唯一ID

 

【修改记录】

(1)     HDM2-1.54：修改Content字段说明

 

4.4.51  下载BMC文件

【功能描述】

使用PostMan显示指定的BMC文件内容，用户可以自行使用Postman或搭配curl命令下载文件。

注：如果SDS文件较大，建议使用远程导出方式

【所属权限模块】

常规配置

【命令格式】

POST https://device_ip/redfish/v1/Managers/manager_id/Actions/Oem/Public/Manager.GeneralDownload

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

  "TransferProtocol":value,

"Content"：path

}

【参数说明】

表4-291 下载BMC文件说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

TransferProtocol

字符串

支持的协议仅包括：HTTPS

Content

字符串

见其它说明

该接口支持以下目录中的文件下载

1、/conf/secure_erase

2、/tmp/web

3、/mnt/sdmmc0p1/sds/bmc

4、/mnt/sdmmc0p4/bsod

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/Managers/1/Actions/Oem/Public/Manager.GeneralDownload

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

本地导出

{

    "TransferProtocol":"HTTPS",

    "Content":"/tmp/web/web.pem"

}

【应答示例说明】

显示文件内容

响应码：200

 

4.4.52  查询VNC信息

【功能描述】

查询VNC信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/VncService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-292 查询VNC信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Managers/1/VncService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【响应样例】

{

    "@odata.context": "/redfish/v1/$metadata#VncService.VncService(ComplexityCheck,NumberOfActivatedSessions,SessionTimeoutMinutes,MaximumNumberOfSessions)",

    "@odata.id": "/redfish/v1/Managers/1/VncService",

    "@odata.type": "#VncService.v1_0_0.VncService",

    "ComplexityCheck": false,

    "MaximumNumberOfSessions": 2,

    "NumberOfActivatedSessions": 0,

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "Password": null,

    "SessionTimeoutMinutes": 10

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-293 查询VNC信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

VNC信息资源模型的OData 描述信息

@odata.id

字符串

VNC信息资源的访问路径

@odata.type

字符串

VNC信息资源的类型

MaximumNumberOfSessions

数值

VNC最大会话数

NumberOfActivatedSessions

数值

VNC当前会话数

ComplexityCheck

布尔型

VNC密码复杂度检查

SessionTimeoutMinutes

数值

会话超时时间

Password

null

密码；

GET时返回null

 

4.4.53  设置VNC信息

【功能描述】

设置VNC信息。

【所属权限模块】

远程控制

【命令格式】

PATCH https://device_ip/redfish/v1/Managers/manager_id/VncService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:ifmatch_value

【请求消息体】

{

  "SessionTimeoutMinutes": 6,

  "ComplexityCheck": false,

  "Password":"Pass1234"

}

【参数说明】

表4-294 设置VNC信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

ifmatch_value

请求消息的匹配参数

可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）

SessionTimeoutMinutes

数值

会话超时时间（分钟），5~30

ComplexityCheck

布尔型

使能VNC密码复杂度检查

关闭该功能时，密码要求如下：

·     密码长度为1～8个字符；

·     仅支持字母、数字、空格和特殊字符`~!@#$%^&*()_+-=[]\{}|;':",./<>?，区分大小写。

·     开启该功能时，密码要求如下：

·     密码长度为8个字符，仅支持字母、数字、空格和特殊字符`~!@#$%^&*()_+-=[]\{}|;':",./<>?，区分大小写；

·     至少包含大写字母、小写字母和数字中的两种字符；

·     至少包含一个空格或特殊字符；

Password

字符串

密码；

允许下发的最大密码长度为8位

 

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/Managers/1/VncService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

  "SessionTimeoutMinutes":10,

  "ComplexityCheck": false,

  "Password":"root"

}

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#VncService.VncService(ComplexityCheck,NumberOfActivatedSessions,SessionTimeoutMinutes,MaximumNumberOfSessions)",

    "@odata.id": "/redfish/v1/Managers/1/VncService",

    "@odata.type": "#VncService.v1_0_0.VncService",

    "ComplexityCheck": false,

    "MaximumNumberOfSessions": 2,

    "NumberOfActivatedSessions": 0,

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "Password": null,

    "SessionTimeoutMinutes": 10

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回字段说明同【查询VNC信息】

 

4.4.54  查询KVM信息

【功能描述】

查询KVM信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/KvmService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-295 查询KVM信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Managers/1/KvmService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【响应样例】

{

    "@odata.context": "/redfish/v1/$metadata#KvmService.KvmService",

    "@odata.id": "/redfish/v1/Managers/1/KvmService",

"@odata.type": "#KvmService.v1_0_0.KvmService",

"ActivatedSessionsType": "Shared",

"H5ActivatedSessionsType": "Private",

"H5EncryptionEnabled": true,

    "MaximumNumberOfSessions": 4,

"NumberOfActivatedSessions": 0,

"Oem": {

"Public": {

"CompletionCode": 0,

  "Description": "Success"

    }

  },

"PersistentUSBConnectionEnabled": false,

"SessionTimeoutMinutes": 13

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-296 查询KVM信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

KVM信息资源模型的OData 描述信息

@odata.id

字符串

KVM信息资源的访问路径

@odata.type

字符串

KVM信息资源的类型

ActivatedSessionsType

字符串

KVM 会话类型

“Shared”：共享

“Private”：独占

H5ActivatedSessionsType

字符串

H5 KVM 会话类型

“Shared”：共享

“Private”：独占

H5EncryptionEnabled

布尔

H5 KVM 加密使能

MaximumNumberOfSessions

数值

KVM最大会话数

NumberOfActivatedSessions

数值

KVM当前会话数

PersistentUSBConnectionEnabled

布尔

虚拟鼠标持续连接使能

当前仅支持false

SessionTimeoutMinutes

数值

会话超时时间

 

4.4.55  设置KVM信息

【功能描述】

设置KVM信息。

【所属权限模块】

远程控制

【命令格式】

PATCH https://device_ip/redfish/v1/Managers/manager_id/KvmService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:ifmatch_value

【请求消息体】

{

    "SessionTimeoutMinutes": SessionTimeoutMinutes_value,

"ActivatedSessionsType": "Shared",

"H5ActivatedSessionsType": "Private"

}

【参数说明】

表4-297 设置KVM信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

ifmatch_value

请求消息的匹配参数

可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）

SessionTimeoutMinutes

数值

会话超时时间（分钟）

ActivatedSessionsType

字符串

KVM 会话类型

“Shared”：共享

“Private”：独占

H5ActivatedSessionsType

字符串

H5 KVM 会话类型

“Shared”：共享

“Private”：独占

 

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/Managers/1/KvmService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

    "SessionTimeoutMinutes":10,

"ActivatedSessionsType": "Shared",

"H5ActivatedSessionsType": "Private"

}

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#KvmService.KvmService",

    "@odata.id": "/redfish/v1/Managers/1/KvmService",

    "@odata.type": "#KvmService.v1_0_0.KvmService",

    "ActivatedSessionsType": "Shared",

    "H5ActivatedSessionsType": "Private",

    "H5EncryptionEnabled": false,

    "MaximumNumberOfSessions": 4,

    "NumberOfActivatedSessions": 0,

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "PersistentUSBConnectionEnabled": false,

    "SessionTimeoutMinutes": 10

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回字段说明同【查询KVM信息】

 

4.4.56  查询串口列表

【功能描述】

查询串口列表。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/SerialInterfaces

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-298 查询串口列表信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET http://192.168.25.83/redfish/v1/Managers/1/SerialInterfaces

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#SerialInterfaceCollection.SerialInterfaceCollection",

    "@odata.id": "/redfish/v1/Managers/1/SerialInterfaces",

"@odata.type": "#SerialInterfaceCollection.SerialInterfaceCollection",

"Description": "Collection of Serial Interfaces for this System",

    "Members": [

        {

            "@odata.id": "/redfish/v1/Managers/1/SerialInterfaces/IPMI-SOL"

        }

    ],

    "[email protected]": 1,

    "Name": "Serial Interface Collection",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    }

}

响应码：200

【输出说明】

表4-299 查询串口列表信息返回值

字段

类型

字段说明

@odata.context

字符串

串口集合资源模型

@odata.id

字符串

串口集合资源的访问路径

@odata.type

字符串

串口集合资源类型

Description

字符串

串口集合资源描述信息

Members

数组

串口信息查询路径

[email protected]

数值

串口个数

Name

字符串

名称

 

4.4.57  查询指定串口信息

【功能描述】

查询指定串口信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/SerialInterfaces/serialinterface_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-300 查询指定串口信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

serialinterface_id

串口id

由串口列表中查询

 

【使用实例】

【请求样例】

GET http://192.168.18.18/redfish/v1/Managers/1/SerialInterfaces/IPMI-SOL

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#SerialInterface.SerialInterface",

    "@odata.id": "/redfish/v1/Managers/1/SerialInterfaces/IPMI-SOL",

    "@odata.type": "#SerialInterface.v1_1_8.SerialInterface",

    "BitRate": "115200",

    "DataBits": "8",

    "Description": "IPMI Serial over LAN",

    "FlowControl": "Hardware",

    "Id": "IPMI-SOL",

    "InterfaceEnabled": true,

"Name": "IPMI-SOL",

"Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

},

    "Parity": "None",

    "StopBits": "1"

}

响应码：200

【输出说明】

表4-301 查询指定串口信息返回值

字段

类型

字段说明

@odata.context

字符串

指定串口资源模型的OData描述信息

@odata.id

字符串

指定串口资源的访问路径

@odata.type

字符串

指定串口资源类型

BitRate

字符串

波特率：

"1200", "2400", "4800", "9600", "19200", "38400", "57600", "115200", "230400"

DataBits

字符串

数据位：

"5", "6", "7", "8"

Description

字符串

串口描述信息

FlowControl

字符串

流控制方式：

"None", "Software", "Hardware"

Id

字符串

串口id

InterfaceEnabled

布尔型

串口是否开启

Name

字符串

串口名称

Parity

字符串

校验方式：

"None", "Even", "Odd", "Mark", "Space"

StopBits

字符串

停止位：

"1", "2"

 

4.4.58  查询LLDP服务配置资源信息

【功能描述】

查询LLDP服务配置资源信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/LldpService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-302 查询LLDP服务配置资源信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

manager_id

管理资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Managers/1/LldpService

请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context":"/redfish/v1/$metadata#LldpService.LldpService",

    "@odata.id":"/redfish/v1/Managers/1/LldpService",

    "@odata.type":"#LldpService.v1_0_0.LldpService",

    "Description":"Lldp Service",

    "Id":"LldpService",

    "LLDP":[

        {

            "ChassisMac":"N/A",

            "ChassisName":"N/A",

            "EthIndex":"eth0",

            "PortDesc":"N/A",

            "PortIfName":"N/A",

            "VlanId":4294967295

        },

        {

            "ChassisMac":"N/A",

            "ChassisName":"N/A",

            "EthIndex":"eth1",

            "PortDesc":"N/A",

            "PortIfName":"N/A",

            "VlanId":4294967295

        }

    ],

    "LldpEnabled":true,

    "Name":"LldpService",

    "Oem":{

        "Public":{

            "CompletionCode":0,

            "Description":"Success"

        }

    },

    "WorkMode":"TxRx"

}

响应码：200

【输出说明】

表4-303 查询LLDP服务配置资源信息参数说明

字段

类型

字段说明

@odata.context

字符串

LLDP服务配置资源模型的OData 描述信息

@odata.id

字符串

LLDP服务配置资源的访问路径

@odata.type

字符串

LLDP服务配置资源的 OData 描述信息

Description

字符串

LLDP服务配置资源接口功能描述

Id

字符串

LldpService ID

ChassisMac

字符串

交换机MAC地址

ChassisName

字符串

交换机系统名字

EthIndex

字符串

服务器接收LLDP信息的网络接口

PortDesc

字符串

上联交换机端口的信息

PortIfName

字符串

上联交换机端口号

VlanId

数值

Vlan ID号

LldpEnabled

布尔型

LLDP状态使能

WorkMode

字符串

LLDP工作模式

Rx：接收模式

Tx：发送模式

TxRx：发送接收模式

Name

字符串

LldpService名称

 

【修改记录】

(1)     HDM2-1.59：LldpEnabled字段含义从“LLDP发送消息使能”修改为“LLDP状态使能”；

(2)     HDM2-1.59：WorkMode字段Rx/Tx取值修改为TxRx(并兼容Rx/Tx)，同时新增Tx取值；

 

4.4.59  修改LLDP服务资源属性

【功能描述】

修改LLDP服务资源属性

【所属权限模块】

常规配置

【所属系统锁定类型】

BMC配置锁定

【命令格式】

PATCH https://device_ip/redfish/v1/Managers/manager_id/LldpService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:ifmatch_value

【请求消息体】

{

  "LldpEnabled": true,

"WorkMode": "TxRx"

}

 

【参数说明】

表4-304 设置LLDP服务配置资源信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

manager_id

管理资源的ID

当前所有机型取值为1

ifmatch_value

请求消息的匹配参数

可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）

LldpEnabled

布尔型

LLDP状态使能：

true  false

WorkMode

字符串

LLDP工作模式

Rx：接收模式

Tx：发送模式

TxRx：发送接收模式

 

【使用实例】

【请求样例】

PATCH http://192.168.18.18/redfish/v1/Managers/1/LldpService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

  "LldpEnabled": true,

  "WorkMode": "TxRx"

}

【应答示例】

{

    "@odata.context":"/redfish/v1/$metadata#LldpService.LldpService",

    "@odata.id":"/redfish/v1/Managers/1/LldpService",

    "@odata.type":"#LldpService.v1_0_0.LldpService",

    "Description":"Lldp Service",

    "Id":"LldpService",

    "LLDP":[

        {

            "ChassisMac":"N/A",

            "ChassisName":"N/A",

            "EthIndex":"eth0",

            "PortDesc":"N/A",

            "PortIfName":"N/A",

            "VlanId":4294967295

        },

        {

            "ChassisMac":"N/A",

            "ChassisName":"N/A",

            "EthIndex":"eth1",

            "PortDesc":"N/A",

            "PortIfName":"N/A",

            "VlanId":4294967295

        }

    ],

    "LldpEnabled":true,

    "Name":"LldpService",

    "Oem":{

        "Public":{

            "CompletionCode":0,

            "Description":"Success"

        }

    },

    "WorkMode":"TxRx"

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回字段说明同【查询LLDP服务配置资源信息】

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

(2)     HDM2-1.59：LldpEnabled字段含义从“LLDP发送消息使能”修改为“LLDP状态使能”，并新增WorkMode字段；

 

4.4.60  查询无线管理资源信息

【功能描述】

查询无线管理资源信息。X18000产品不支持该接口。HDM3软件暂不支持。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/Wireless

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-305 查询无线管理资源信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

manager_id

管理资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.33.120/redfish/v1/Managers/1/Oem/Public/Wireless

请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context":"/redfish/v1/$metadata#Wireless.Wireless",

    "@odata.id":"/redfish/v1/Managers/1/Oem/Public/Wireless",

    "@odata.type":"#Wireless.v1_0_0.Wireless",

    "Clients":[

 

    ],

    "DHCPServers":[

        {

            "DHCPAddrEnd":"192.168.199.254",

            "DHCPAddrStart":"192.168.199.2",

            "IPAddress":"192.168.199.1",

            "Id":0

        }

    ],

    "IsSameSegment":false,

    "Oem":{

        "Public":{

            "CompletionCode":0,

            "Description":"Success"

        }

    },

    "Ssids":[

        {

            "ClientMaxNum":2,

            "EncryptionMode":"None",

            "Id":0,

            "Name":"BMC_WIFI_162022",

            "Password":""

        }

    ],

    "Status":{

        "Health":"OK",

        "State":"Absent"

    },

    "USBDeviceEnabled":true,

    "WlanChannel":11,

    "WlanCurrentState":"Closed",

    "WlanEnabled":false,

    "WlanTimeout":1

}

响应码：200

【输出说明】

表4-306 查询无线管理资源信息参数说明

字段

类型

字段说明

@odata.context

字符串

无线管理资源信息模型的OData 描述信息

@odata.id

字符串

无线管理资源信息的访问路径

@odata.type

字符串

无线管理资源信息资源类型

WlanChannel

数值

无线信道，默认为11

WlanCurrentState

字符串

当前无线状态

Open 开启

Closed 关闭

WlanEnabled

布尔型

无线是否开启

WlanTimeout

数值

无线定时关闭时间，范围0~200，单位：小时，0表示不关闭

IsSameSegment

布尔

无线同网段检查

Clients.ClientId

数值

客户端的ID

Clients.MacAddress

字符串

客户端的MAC地址

Clients.IPAddress

字符串

客户端的IPV4地址

Clients.HostName

字符串

客户端的主机名

DHCPServers.Id

数值

无线DHCP地址池的ID

DHCPServers.IPAddress

字符串

无线的IP地址

DHCPServers.DHCPAddrStart

字符串

无线DHCP地址池

DHCPServers.DHCPAddrEnd

字符串

无线DHCP地址池

Ssids.ClientMaxNum

数值

客户端的最大连接数量

Ssids.EncryptionMode

字符串

无线加密方式

“None”,

“WPA2-PSK”

Ssids.Id

数值

无线的ID

Ssids.Name

字符串

无线名称

Ssids.Password

字符串

无线密码，此密码需要使用明文

Status.Health

字符串

无线的健康状态

Status.State

字符串

无线设备的在位状态

Enabled：在位

Absent：不在位

USBDeviceEnabled

布尔

USB物理接口使能状态

 

【修改记录】

(1)     HDM3-1.14：HDM3暂不支持本接口。

 

4.4.61  修改无线管理资源属性

【功能描述】

修改无线管理资源属性，X18000产品不支持该接口。HDM3软件暂不支持。

【所属权限模块】

常规配置

【所属系统锁定类型】

BMC配置锁定

【命令格式】

PATCH https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/Wireless

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:ifmatch_value

【请求消息体】

{

    "DHCPServers": [

        {

            "DHCPAddrEnd": "192.168.155.189",

            "DHCPAddrStart": "192.168.155.35",

            "IPAddress": "192.168.155.30"

        }

    ],

    "Ssids": [

        {

            "EncryptionMode": "WPA2-PSK",

            "Name": "test",

            "Password": "123456789"

        }

],   

"USBDeviceEnabled": true,

    "WlanEnabled": true,

    "WlanTimeout": 0

} 

【参数说明】

表4-307 修改无线管理资源信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

manager_id

管理资源的ID

当前所有机型取值为1

ifmatch_value

请求消息的匹配参数

可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）

WlanEnabled

布尔型

无线使能

WlanTimeout

数值

无线定时关闭时间，范围0~200，单位：小时，0表示不关闭

DHCPServers.IPAddress

字符串

无线的IP地址，仅支持IPv4

DHCPServers.DHCPAddrStart

字符串

无线DHCP地址池，仅支持IPv4

DHCPServers.DHCPAddrEnd

字符串

无线DHCP地址池，仅支持IPv4

Ssids.EncryptionMode

字符串

无线加密方式

“None”： 不加密

“WPA2-PSK”

Ssids.Name

字符串

无线名称，缺省名称为：BMC_WIFI_BMC专用网口MAC地址后6位。

长度1～31个字符，仅支持字母、数字、句点（.）、连接符（-）和下划线（_），区分大小写。

Ssids.Password

字符串

无线密码，加密方式为“加密”时，需要设置密码。长度支持8～63个字符，仅支持字母、数字、空格和特殊字符`~!@#$%^&*()_+-=[]\{}|;':,./<>?，区分大小写

USBDeviceEnabled

布尔

USB物理接口使能状态，false时不下发其他参数

 

【使用实例】

【请求样例】

PATCH https://192.168.30.85/redfish/v1/Managers/1/Oem/Public/Wireless

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match: W/"1043aaa69f0ade5f8a7a7e0d987a274b"

【请求消息体】

{

    "DHCPServers":[

        {

            "DHCPAddrEnd":"192.168.199.254",

            "DHCPAddrStart":"192.168.199.2",

            "IPAddress":"192.168.199.1"

        }

    ],

    "Ssids":[

        {

            "EncryptionMode":"None",

            "Name":"BMC_WIFI_162022",

            "Password":""

        }

    ],

    "WlanEnabled":false,

    "WlanTimeout":1,

    "USBDeviceEnabled":true

}

【应答示例】

{

    "@odata.context":"/redfish/v1/$metadata#Wireless.Wireless",

    "@odata.id":"/redfish/v1/Managers/1/Oem/Public/Wireless",

    "@odata.type":"#Wireless.v1_0_0.Wireless",

    "Clients":[

 

    ],

    "DHCPServers":[

        {

            "DHCPAddrEnd":"192.168.199.254",

            "DHCPAddrStart":"192.168.199.2",

            "IPAddress":"192.168.199.1",

            "Id":0

        }

    ],

    "IsSameSegment":false,

    "Oem":{

        "Public":{

            "CompletionCode":0,

            "Description":"Success"

        }

    },

    "Ssids":[

        {

            "ClientMaxNum":2,

            "EncryptionMode":"None",

            "Id":0,

            "Name":"BMC_WIFI_162022",

            "Password":""

        }

    ],

    "Status":{

        "Health":"OK",

        "State":"Absent"

    },

    "USBDeviceEnabled":true,

    "WlanChannel":11,

    "WlanCurrentState":"Closed",

    "WlanEnabled":false,

    "WlanTimeout":1

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回字段说明同【查询无线管理资源信息】

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

(2)     HDM3-1.14：HDM3暂不支持本接口。

 

4.4.62  导入BIOS、BMC和RAID控制器配置

【功能描述】

导入BIOS、BMC和RAID控制器配置

【所属权限模块】

用户配置

【所属系统锁定类型】

BIOS配置锁定（导入BIOS配置时）|BMC配置锁定（导入BMC配置时）|硬件配置锁定（导入RAID配置时）

【命令格式】

POST https://device_ip/redfish/v1/Managers/manager_id/Actions/Oem/Public/Manager.ImportConfiguration

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

本地导入

先通过【上传BMC文件】将文件传输到/tmp/web/目录下，再调用本接口

{

"Type":"URI",

"Content": "/tmp/web/filename",

"Oem": {

        "Public": {

            "ConfigType":type

       }

}

}

 

远程导入

cifs或sftp

{

  "Type":"URI",

"Content":"cifs://username:password@ip/filename",

"Oem": {

        "Public": {

            "ConfigType":type

       }

}

}

http、tftp、nfs或https

{

  "Type":"URI",

"Content":"http://ip/filename",

"Oem": {

        "Public": {

            "ConfigType":type

       }

}

}

【参数说明】

表4-308 导入BIOS、BMC和RAID控制器配置参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

manager_id

管理资源的ID

当前所有机型取值为1

Type

导入配置文件的方法

URI

Content

导入配置文件路径

见其它说明

Oem.Public.ConfigType

导入配置类别

“BMC”，”BIOS”，”RAID”

 

【使用实例】

【请求样例】

POST https://192.168.188.188/redfish/v1/Managers/1/Actions/Oem/Public/Manager.ImportConfiguration

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

  "Type":"URI",

  "Content": "nfs://192.168.20.177/Share1/bios-config.json",

  "Oem": {

      "Public": {

          "ConfigType":"BIOS"

      }

  }

}

【应答示例】

{

  "@odata.context": "/redfish/v1/$metadata#TaskCollection.TaskCollection",

  "@odata.type": "#TaskCollection.TaskCollection",

  "Members": [

    {

      "@odata.id": "/redfish/v1/TaskService/Tasks/2"

    }

  ],

  "[email protected]": 1,

  "Name": "Task Collection",

  "Oem": {

    "Public": {

      "CompletionCode": 0,

      "Description": "Success",

      "TaskUniqueID": 1678656297

    }

  }

}

响应码：202

【输出说明】

返回状态码202，表示操作成功。

表4-309 导入BIOS、BMC和RAID控制器配置输出说明

字段

类型

字段说明

@odata.context

字符串

配置导入TaskService的OData 描述信息

@odata.type

字符串

配置导入TaskService的类型

[email protected]

字符串

配置导入生成的Task链接

Oem.Public.TaskUniqueID

数值

配置导入TaskService的唯一ID

 

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

 

4.4.63  导出BIOS、BMC和RAID控制器配置

【功能描述】

导出BIOS、BMC和RAID控制器配置

【所属权限模块】

用户配置

【命令格式】

POST https://device_ip/redfish/v1/Managers/manager_id/Actions/Oem/Public/Manager.ExportConfiguration

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

本地导出

{

"Type":"URI",

"Content": "/tmp/web/filename",

"Oem": {

        "Public": {

            "ConfigType":type,

"ExportPasswordEnabled":true

       }

}

}

 

远程导出

cifs或sftp

{

  "Type":"URI",

"Content":"cifs://username:password@ip/filename",

"Oem": {

        "Public": {

            "ConfigType":type,

"ExportPasswordEnabled":true

       }

}

}

http、tftp、nfs或https

{

  "Type":"URI",

"Content":"http://ip/filename",

"Oem": {

        "Public": {

            "ConfigType":type,

            "ScriptName":"1.php",

"ExportPasswordEnabled":true

       }

}

}

 

【参数说明】

表4-310 导出BIOS、BMC和RAID控制器配置参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

manager_id

管理资源的ID

当前所有机型取值为1

Type

导出配置文件的方法

URI

Content

导出配置文件路径

见其它说明

Oem.Public.ConfigType

导出配置类别

“BMC”，”BIOS”，”RAID”

Oem.Public.ScriptName

字符串

通过http/https协议导出时，需指定的脚本文件的名称

Oem.Public.ExportPasswordEnabled

布尔型

是否导出本地用户密码

 

【使用实例】

【请求样例】

POST https://192.168.188.188/redfish/v1/Managers/1/Actions/Oem/Public/Manager.ExportConfiguration

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

  "Type":"URI",

  "Content": "nfs://192.168.20.177/Share1/bios-config.json",

  "Oem": {

      "Public": {

          "ConfigType":"BIOS"

      }

  }

}

【应答示例】

{

  "@odata.context": "/redfish/v1/$metadata#TaskCollection.TaskCollection",

  "@odata.type": "#TaskCollection.TaskCollection",

  "Members": [

    {

      "@odata.id": "/redfish/v1/TaskService/Tasks/2"

    }

  ],

  "[email protected]": 1,

  "Name": "Task Collection",

  "Oem": {

    "Public": {

      "CompletionCode": 0,

      "Description": "Success",

      "TaskUniqueID": 1678656297

    }

  }

}

响应码：202

【输出说明】

返回状态码202，表示操作成功。

表4-311 导出BIOS、BMC和RAID控制器配置输出说明

字段

类型

字段说明

@odata.context

字符串

配置导出TaskService的OData 描述信息

@odata.type

字符串

配置导出TaskService的类型

[email protected]

字符串

配置导出生成的Task链接

Oem.Public.TaskUniqueID

数值

配置导出TaskService的唯一ID

 

【修改记录】

(1)     HDM2-2.04：新增Oem.Public.ExportPasswordEnabled字段；

 

4.4.64  获取可信密码模块状态配置

【功能描述】

获取TPM/TCM配置信息

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/TrustedModuleConfiguration

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-312 获取可信密码模块状态配置信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

manager_id

管理资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET

https://192.168.18.18/redfish/v1/Managers/1/Oem/Public/TrustedModuleConfiguration

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#TrustedModuleConfiguration.TrustedModuleConfiguration",

    "@odata.id": "/redfish/v1/Managers/1/Oem/Public/TrustedModuleConfiguration",

    "@odata.type": "#TrustedModuleConfiguration.v1_0_0.TrustedModuleConfiguration",

    "Description": "Get trusted module configuration.",

    "Id": "TrustedModule Configuration",

    "Name": "TrustedModule Configuration",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "State": "NotSupported",

    "Type": null

}

响应码：200

【输出说明】

表4-313 获取可信密码模块状态配置信息参数说明

字段

类型

字段说明

@odata.context

字符串

可信密码模块资源模型的OData 描述信息

@odata.id

字符串

可信密码模块资源的访问路径

@odata.type

字符串

可信密码模块资源的类型

Type

字符串

可信密码模块名称：

TPM/TCM

State

字符串

状态

Enabled：使能

Disabled：禁用

Absent：不在位

NotSupported：不支持

 

4.4.65  查询防火墙配置信息

【功能描述】

查询防火墙配置信息

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/FirewallRules

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-314 查询防火墙配置信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

manager_id

管理资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.77.77/redfish/v1/Managers/1/Oem/Public/FirewallRules

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【响应样例】

{

    "@odata.context": "/redfish/v1/$metadata#FirewallRules.FirewallRules",

    "@odata.id": "/redfish/v1/Managers/1/Oem/Public/FirewallRules",

"@odata.type": "#FirewallRules.v1_0_0.FirewallRules",

"Actions": {

      "#Firewall.AddRules": {

"target":

"redfish/v1/Managers/manager_id/Actions/Oem/Public/Firewall.AddRules"

  },

"#Firewall.DeleteRules": {

"target":

"redfish/v1/Managers/manager_id/Actions/Oem/Public/Firewall.DeleteRules"

  }

},

    "BlacklistRules": [

        {

            "EndDateTime": "2019-02-15T20:21:36+08:00",

            "EndIPAddress": "10.33.255.255",

            "EndPort":6567,

            "MACAddress": "C4:36:6B:3E:7C:2B",

            "MemberId": "1",

            "StartDateTime": "2019-02-14T20:21:36+08:00",

            "StartIPAddress": "10.33.40.0",

            "StartPort": 5677,

            "Protocol": ["UDP","TCP"]

        },

        {

            "EndDateTime": "2019-02-15T20:21:36+08:00",

            "EndIPAddress": "10.99.255.255",

            "EndPort":6567,

            "MACAddress": "C4:36:6B:3E:7A:2B",

            "MemberId": "2",

            "StartDateTime": "2019-02-14T20:21:36+08:00",

            "StartIPAddress": "10.99.40.0",

            "StartPort": 5677,

            "Protocol": ["UDP","TCP"]

        },

        {

            "EndDateTime": null,

            "EndIPAddress": "11.99.255.255",

            "EndPort":6567,

            "MACAddress": "C6:36:6B:3E:7A:2B",

            "MemberId": "3",

            "StartDateTime": null,

            "StartIPAddress": "10.99.40.0",

            "StartPort": 5677,

            "Protocol": ["UDP","TCP"]

        }

……

         

    ],

    "[email protected]": 3,

    "Name": "FirewallConfig Collection",

"Oem": {

  "Public": {

        "CompletionCode": 0,

        "Description": "Success"

      }

    },

    "WhitelistRules": [

        {

            "EndDateTime": null,

            "EndIPAddress": "192.168.30.255",

            "EndPort":6567,

            "MACAddress": "C6:36:6B:3E:7A:2B",

            "MemberId": "1",

            "StartDateTime": null,

            "StartIPAddress": "192.168.30.40",

            "StartPort": 5677,

            "Protocol": ["UDP","TCP"]

        },

        {

            "EndDateTime": "2019-02-15T20:21:36+08:00",

            "EndIPAddress": "192.168.30.255",

            "EndPort":6567,

            "MACAddress": "C6:36:6B:3E:7A:2B",

            "MemberId": "2",

            "StartDateTime": "2019-02-14T20:21:36+08:00",

            "StartIPAddress": "192.168.30.40",

            "StartPort": 5677,

            "Protocol": ["UDP","TCP"]

        }

        

],

……

    "[email protected]": 2

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-315 查询防火墙配置信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

指定角色资源模型的OData 描述信息

@odata.id

字符串

指定角色资源的访问路径

@odata.type

字符串

指定角色资源的类型

BlacklistRules

对象数组

黑名单成员列表

WhitelistRules

对象数组

白名单成员列表

MemberId

字符串

本规则Id

StartIPAddress

布尔型

本规则起始IP地址

EndIPAddress

字符串

本规则终止IP地址

MACAddress

字符串

MAC地址

StartDateTime

字符串

本规则起始时间

EndDateTime

字符串

本规则终止时间

EndPort

数值

本规则终止端口号

null表示该字段未设置

StartPort

数值

本规则起始端口号

null表示该字段未设置

Protocol

数组

本规则支持的协议

TCP

UDP

 

4.4.66  添加防火墙规则信息

【功能描述】

添加防火墙配置规则信息

【所属权限模块】

安全模块

【所属系统锁定类型】

BMC配置锁定

【命令格式】

POST https://device_ip/redfish/v1/Managers/manager_id/Actions/Oem/Public/Firewall.AddRules

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

    "BlacklistRules": [

        {

            "EndDateTime": "2019-02-15T20:21:36+08:00",

            "EndIPAddress": "10.33.255.255",

            "EndPort":6567,

            "MACAddress": "C4:36:6B:3E:7C:2B",

            "StartDateTime": "2019-02-14T20:21:36+08:00",

            "StartIPAddress": "10.33.40.0",

            "StartPort": 5677,

            "Protocol": ["UDP","TCP"]

        },

      ...

    ],

    "WhitelistRules": [

        {

            "EndDateTime": "2019-02-15T20:21:36+08:00",

            "EndIPAddress": "192.168.30.255",

            "EndPort":6567,

            "MACAddress": "C6:36:6B:3E:7A:2B",

            "StartDateTime": "2019-02-14T20:21:36+08:00",

            "StartIPAddress": "192.168.30.40",

            "StartPort": 5677,

            "Protocol": ["UDP","TCP"]

        },

        ...

    ]

}

【参数说明】

表4-316 添加防火墙规则信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

manager_id

管理资源的ID

当前所有机型取值为1

BlacklistRules

对象数组

黑名单成员列表

WhitelistRules

对象数组

白名单成员列表

StartIPAddress

布尔型

本规则起始IP地址

EndIPAddress

字符串

本规则终止IP地址

MACAddress

字符串

MAC地址

StartDateTime

字符串

本规则起始时间

null表示该字段不设置

EndDateTime

字符串

本规则终止时间

null表示该字段不设置

EndPort

数值

本规则终止端口号：1-65535

null表示该字段不设置

StartPort

数值

本规则起始端口号：1-65535

null表示该字段不设置

Protocol

数组

本规则支持的协议

"TCP"

"UDP"

 

【使用实例】

【请求样例】

POST https://192.168.77.77/redfish/v1/Managers/1/Actions/Oem/Public/Firewall.AddRules

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

    "BlacklistRules": [

        {

            "EndDateTime": "2019-02-15T21:21:36+08:00",

            "EndIPAddress": "10.33.255.255",

            "EndPort":6567,

            "MACAddress": "C4:36:6B:3E:7C:2B",

            "StartDateTime": "2019-02-14T20:21:36+08:00",

            "StartIPAddress": "10.33.40.0",

            "StartPort": 5677,

            "Protocol": ["UDP","TCP"]

        },

      ...

    ],

    "WhitelistRules": [

        {

            "EndDateTime": "2019-02-15T21:21:36+08:00",

            "EndIPAddress": "192.168.30.255",

            "EndPort":6567,

            "MACAddress": "C6:36:6B:3E:7A:2B",

            "StartDateTime": "2019-02-14T20:21:36+08:00",

            "StartIPAddress": "192.168.30.40",

            "StartPort": 5677,

            "Protocol": ["UDP","TCP"]

        },

        ...

    ]

}

【响应样例】

{

"Oem": {

       "Public": {

           "CompletionCode": 0,

           "Description": "Success"

       }

 },

"error": {

       "@Message.ExtendedInfo": [

           {

               "@odata.type": "#Message.v1_1_1.Message",

               "Message": "Successfully Completed Request",

               "MessageArgs": [],

               "MessageId": "Base.1.8.1.Success",

               "MessageSeverity": "OK",

               "Resolution": "None"

           }

       ],

        "code":"Base.1.8.1.Success",

        "message":"Successfully Completed Request"

    }

}

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-317 添加防火墙规则信息输出参数说明

字段

类型

字段说明

code

字符串

指示消息注册表中特定消息ID的字符串

message

字符串

与消息注册表中的消息对应的易读的错误消息

@Message.ExtendedInfo

消息扩展信息

@odata.type

字符串

消息资源的OData描述信息

MessageId

字符串

消息ID

Message

字符串

详细信息

MessageArgs

数组

信息参数

MessageSeverity

字符串

严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical

Resolution

字符串

解决建议

 

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

(2)     HDM2-2.04：Message.ExtendedInfo前添加error节点，并且在error节点下增加code和message字段；

 

4.4.67  修改防火墙规则信息

【功能描述】

修改防火墙规则信息

【所属权限模块】

安全模块

【所属系统锁定类型】

BMC配置锁定

【命令格式】

PATCH https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/FirewallRules

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:ifmatch_value

【请求消息体】

{

    "BlacklistRules": [

        {

            "EndDateTime": "2019-02-15T20:21:36+08:00",

            "EndIPAddress": "10.33.255.255",

            "EndPort":6567,

            "MACAddress": "C4:36:6B:3E:7C:2B",

            "MemberId": "1",

            "StartDateTime": "2019-02-14T20:21:36+08:00",

            "StartIPAddress": "10.33.40.0",

            "StartPort": 5677,

            "Protocol": ["UDP","TCP"]

        },

      ...

    ],

    "WhitelistRules": [

        {

            "EndDateTime": "2019-02-15T20:21:36+08:00",

            "EndIPAddress": "192.168.30.255",

            "EndPort":6567,

            "MACAddress": "C6:36:6B:3E:7A:2B",

            "MemberId": "1",

            "StartDateTime": "2019-02-14T20:21:36+08:00",

            "StartIPAddress": "192.168.30.40",

            "StartPort": 5677,

            "Protocol": ["UDP","TCP"]

        },

        ...

    ]

}

【参数说明】

表4-318 修改防火墙规则信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

manager_id

管理资源的ID

当前所有机型取值为1

BlacklistRules

对象数组

黑名单成员列表

WhitelistRules

对象数组

白名单成员列表

MemberId

字符串

本规则Id

StartIPAddress

布尔型

本规则起始IP地址

EndIPAddress

字符串

本规则终止IP地址

MACAddress

字符串

MAC地址

StartDateTime

字符串

本规则起始时间

null表示该字段不设置

EndDateTime

字符串

本规则终止时间

null表示该字段不设置

EndPort

数值

本规则终止端口号：1~65535

null表示该字段不设置

StartPort

数值

本规则起始端口号：1~65535

null表示该字段不设置

Protocol

数组

本规则支持的协议

"TCP"

"UDP"

 

【使用实例】

【请求样例】

PATCH https://192.168.77.77/redfish/v1/Managers/1/Oem/Public/FirewallRules

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

    "BlacklistRules": [

        {

            "EndDateTime": "2022-04-27T20:21:36+08:00",

            "EndIPAddress": "10.33.255.255",

            "EndPort":6568,

            "MACAddress": "C4:36:6B:3E:7C:2B",

            "MemberId": "1",

            "StartDateTime": "2022-03-26T12:39:36+08:00",

            "StartIPAddress": "10.33.255.253",

            "StartPort": 5678,

            "Protocol": ["UDP","TCP"]

        }

    ],

    "WhitelistRules": [

        {

            "EndDateTime": "2022-04-27T20:21:36+08:00",

            "EndIPAddress": "192.168.30.255",

            "EndPort":6567,

            "MACAddress": "C6:36:6B:3E:7A:2B",

            "MemberId": "1",

            "StartDateTime": "2022-03-26T12:39:36+08:00",

            "StartIPAddress": "192.168.30.40",

            "StartPort": 5677,

            "Protocol": ["UDP","TCP"]

        }

    ]

}

 

【响应样例】

{

    "@odata.context": "/redfish/v1/$metadata#FirewallRules.FirewallRules",

    "@odata.id": "/redfish/v1/Managers/1/Oem/Public/Manager.FirewallRules",

    "@odata.type": "#FirewallRules.v1_0_0.FirewallRules",

    "BlacklistRules": [

        {

            "EndDateTime": "2022-04-27T20:21:36+08:00",

            "EndIPAddress": "10.33.255.255",

            "EndPort":6568,

            "MACAddress": "C4:36:6B:3E:7C:2B",

            "MemberId": "1",

            "StartDateTime": "2022-03-26T12:39:36+08:00",

            "StartIPAddress": "10.33.255.253",

            "StartPort": 5678,

            "Protocol": ["UDP","TCP"]

        },

        {

            "EndDateTime": "2019-02-15T20:21:36+08:00",

            "EndIPAddress": "10.99.255.255",

            "EndPort":6567,

            "MACAddress": "C4:36:6B:3E:7A:2B",

            "MemberId": "2",

            "StartDateTime": "2019-02-14T20:21:36+08:00",

            "StartIPAddress": "10.99.40.0",

            "StartPort": 5677,

            "Protocol": ["UDP","TCP"]

        },

        {

            "EndDateTime": null,

            "EndIPAddress": "11.99.255.255",

            "EndPort":6567,

            "MACAddress": "C6:36:6B:3E:7A:2B",

            "MemberId": "3",

            "StartDateTime": null,

            "StartIPAddress": "11.99.40.0",

            "StartPort": 5677,

            "Protocol": ["UDP","TCP"]

        }

         

    ],

    "[email protected]": 3,

    "Name": "FirewallConfig Collection",

    "Oem": {

        "CompletionCode": 0,

        "Description": "Success"

    },

    "WhitelistRules": [

        {

            "EndDateTime": "2022-04-27T20:21:36+08:00",

            "EndIPAddress": "192.168.30.255",

            "EndPort":6567,

            "MACAddress": "C6:36:6B:3E:7A:2B",

            "MemberId": "1",

            "StartDateTime": "2022-03-26T12:39:36+08:00",

            "StartIPAddress": "192.168.30.40",

            "StartPort": 5677,

            "Protocol": ["UDP","TCP"]

        },

        {

            "EndDateTime": "2019-02-15T20:21:36+08:00",

            "EndIPAddress": "192.168.30.255",

            "EndPort":6567,

            "MACAddress": "C6:36:6B:3E:7A:2B",

            "MemberId": "2",

            "StartDateTime": "2019-02-14T20:21:36+08:00",

            "StartIPAddress": "192.168.30.40",

            "StartPort": 5677,

            "Protocol": ["UDP","TCP"]

        }

    ],

    "[email protected]": 2

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回字段说明同【查询防火墙配置信息】

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

 

4.4.68  删除防火墙配置规则

【功能描述】

删除防火墙配置规则

【所属权限模块】

安全模块

【所属系统锁定类型】

BMC配置锁定

【命令格式】

POST https://device_ip/redfish/v1/Managers/manager_id/Actions/Oem/Public/Firewall.DeleteRules

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"BlacklistRules": [

{

"MemberId": "1",

              },

          {

   “MemberId”: "2",

}

        ……

],

"WhitelistRules": [

{

"MemberId": "1",

              },

          {

   “MemberId”: "2",

}

        ……

],

}

【参数说明】

表4-319 删除防火墙信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

manager_id

管理资源的ID

当前所有机型取值为1

BlacklistRules

对象数组

黑名单成员列表

WhitelistRules

对象数组

白名单成员列表

MemberId

字符串

本规则Id

 

【使用实例】

【请求样例】

POST https://192.168.77.77/redfish/v1/Managers/1/Actions/Oem/Public/Firewall.DeleteRules

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

    "BlacklistRules":[

        {

            "MemberId":"1"

        },

        {

            "MemberId":"2"

        }

    ],

    "WhitelistRules":[

        {

            "MemberId":"1"

        },

        {

            "MemberId":"2"

        }

    ]

}

【响应样例】

{

"Oem": {

       "Public": {

           "CompletionCode": 0,

           "Description": "Success"

       }

 },

"error": {

       "@Message.ExtendedInfo": [

           {

               "@odata.type": "#Message.v1_1_1.Message",

               "Message": "Successfully Completed Request",

               "MessageArgs": [],

               "MessageId": "Base.1.8.1.Success",

               "MessageSeverity": "OK",

               "Resolution": "None"

           }

       ],

        "code":"Base.1.8.1.Success",

        "message":"Successfully Completed Request"

    }

}

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-320 删除防火墙配置规则输出参数说明

字段

类型

字段说明

code

字符串

指示消息注册表中特定消息ID的字符串

message

字符串

与消息注册表中的消息对应的易读的错误消息

@Message.ExtendedInfo

消息扩展信息

@odata.type

字符串

消息资源的OData描述信息

MessageId

字符串

消息ID

Message

字符串

详细信息

MessageArgs

数组

信息参数

MessageSeverity

字符串

严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical

Resolution

字符串

解决建议

 

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

(2)     HDM2-2.04：Message.ExtendedInfo前添加error节点，并且在error节点下增加code和message字段；

 

4.4.69  查询服务器安全服务信息

【功能描述】

获取服务器安全服务信息

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/SecurityService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-321 查询服务器安全服务信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

manager_id

管理资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.77.77/redfish/v1/Managers/1/SecurityService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【响应样例】

{

    "@odata.context": "/redfish/v1/$metadata#Managers/Members/1/SecurityService/$entity",

    "@odata.id": "/redfish/v1/Managers/1/SecurityService",

    "@odata.type": "#SecurityService.v1_0_0.SecurityService",

    "Actions": {

        "#HttpsCert.GenerateCSR": {

            "@Redfish.ActionInfo": "/redfish/v1/Managers/1/SecurityService/HttpsCert/GenerateCSRActionInfo",

            "target": "/redfish/v1/Managers/1/SecurityService/HttpsCert/Actions/HttpsCert.GenerateCSR"

        }

    },

    "Description": "Security Service",

    "Id": "SecurityService",

    "Links": {

        "HttpsCert": {

            "@odata.id": "/redfish/v1/Managers/1/SecurityService/HttpsCert"

        }

    },

    "Name": "Security Service",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success",

            "PublicKeyExponent": "010001",

            "PublicKeyModulus": "EBAD25A6352D93B7DC9273DDE0C0CB92694E00BCCCE7648F508F21E9A276446E183B9A4F13B95566B7318AD046A4C350B2B5CEB0566733A75A340A040D924EA70FADE5C44D0B1B48F729997A24EDD5D148DF50A49AA98037B00CF353FF3F25D4BFF132A86205D95F1063A050706F3FA7823857250EAD57F0F8725274E376CE7D",

            "RSAIndex": 1

        }

    }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-322 查询器安全服务信息输出参数说明

字段

类型

字段说明

@odata.context 

字符串

安全服务信息模型的 OData 描述信息

@odata.id

字符串

安全服务信息节点的访问路径

@odata.type

字符串

安全服务信息类型

Description

字符串

安全服务信息描述信息

Id

字符串

安全服务信息资源的 ID

Name

字符串

安全服务信息资源的名称

Links.HttpsCert

对象

SSL 证书服务的访问路径

Actions.#HttpsCert.GenerateCSR

对象

生成SSL证书信息资源

Oem.Public.RSAIndex

数字

用户登录对应的RSA index，范围1-40，

需要设置到响应头中

Oem.Public.PublicKeyExponent

字符串

RSA公钥指数e

Oem.Public.PublicKeyModulus

字符串

RSA公钥模数n

 

4.4.70  查看SSL证书资源信息

【功能描述】

获取SSL证书资源信息

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/SecurityService/HttpsCert

【请求头】             

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-323 查看SSL证书资源信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

manager_id

管理资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.77.77/redfish/v1/Managers/1/SecurityService/HttpsCert

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【响应样例】

{

    "#HttpsCert.ImportServerCertificate": {

        "#HttpsCert.GenerateCSR": {

            "@Redfish.ActionInfo": "/redfish/v1/Managers/1/SecurityService/HttpsCert/ImportServerCertificateActionInfo",

            "target": "/redfish/v1/Managers/1/SecurityService/HttpsCert/Actions/HttpsCert.ImportServerCertificate"

        }

    },

    "@odata.context": "/redfish/v1/$metadata#Managers/Members/1/SecurityService/HttpsCert/$entity",

    "@odata.id": "/redfish/v1/Managers/1/SecurityService/HttpsCert",

    "@odata.type": "#HttpsCert.v1_0_0.HttpsCert",

    "Actions": {

        "#HttpsCert.GenerateCSR": {

            "@Redfish.ActionInfo": "/redfish/v1/Managers/1/SecurityService/HttpsCert/GenerateCSRActionInfo",

            "target": "/redfish/v1/Managers/1/SecurityService/HttpsCert/Actions/HttpsCert.GenerateCSR"

        }

    },

    "CertificateSigningRequest": null,

    "Id": "HttpsCert",

    "Name": "Https cert info",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "CurrentHttpsCert": {

                "DateOfCertificate": "2023-03-31T18:43:04+08:00",

                "DateOfPrivateKey": "2023-03-31T18:43:04+08:00"

            },

            "Description": "Success"

        }

    },

    "Version": "3",

    "X509CertificateInformation": {

        "ServerCert": {

            "CertificateString": null,

            "CertificateType": null,

            "Issuer": {

                "City": "Hangzhou",

                "CommonName": "H3C",

                "Country": "CN",

                "Organization": "New H3C Technologies Co.,Ltd",

                "OrganizationalUnit": "Compute and Storage Product Line",

                "State": "Zhejiang"

            },

            "IssuerAddress": "[email protected]",

            "KeyUsage": "Digital Signature, Non Repudiation, Key Encipherment",

            "PublicKey": "",

            "PublicKeyLengthBits": 2048,

            "SerialNumber": "4FF5D2D1B5A683DE8616801FAE92BA0D888DA5F9",

            "SignatureAlgorithm": "sha256WithRSAEncryption",

            "Subject": {

                "City": "Hangzhou",

                "CommonName": "H3C",

                "Country": "CN",

                "Organization": "New H3C Technologies Co.,Ltd",

                "OrganizationalUnit": "Compute and Storage Product Line",

                "State": "Zhejiang"

            },

            "SubjectAddress": "[email protected]",

            "ValidNotAfter": "2036-04-26T09:49:41+08:00",

            "ValidNotBefore": "2021-04-30T09:49:41+08:00"

        }

    }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-324 生成SSL证书资源信息输出参数说明

字段

类型

字段说明

@odata.context 

字符串

OData 描述信息

@odata.id

字符串

访问路径

@odata.type

字符串

类型

Description

字符串

描述信息

Id

字符串

资源 ID

Name

字符串

资源名称

DateOfCertificate

字符串

当前证书

DateOfPrivateKey

字符串

当前私钥

Version

字符串

版本

CertificateString

字符串

证书内容；该字段暂不支持

CertificateType

字符串

证书类型；该字段暂不支持

IssuerAddress

字符串

颁发者邮件地址

KeyUsage

字符串

证书用途

PublicKey

字符串

公钥

PublicKeyLengthBits

字符串

公钥长度

SerialNumber

字符串

序列号

SignatureAlgorithm

字符串

签名算法

Issuer

对象

证书颁发者

Subject

对象

证书接收者

City

字符串

城市或地区

CommonName

字符串

通用名称

Country

字符串

国家

Organization

字符串

组织

OrganizationalUnit

字符串

组织单元

State

字符串

省(州)

SubjectAddress

字符串

接收者邮件地址

ValidNotAfter

字符串

证书生效日期

ValidNotBefore

字符串

证书过期日期

 

4.4.71  生成SSL证书

【功能描述】

生成SSL证书的CSR

【所属权限模块】

安全模块

【命令格式】

POST https://device_ip/redfish/v1/Managers/manager_id/SecurityService/HttpsCert/Actions/HttpsCert.GenerateCSR

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"Country":"CN",

"CommonName":"iBMC",

"City":"Shenzhen",

"State":"Guangdong",

"OrgName":"h3c",

"OrgUnit":"IT",

"EmailAddress":"[email protected]",

"PublicKeyLengthBits":1024,

"ValidityDays":30

}

【参数说明】

表4-325 生成SSL证书参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

manager_id

管理资源的ID

当前所有机型取值为1

Country

字符串

国家；

只允许下发2个字符

CommonName

字符串

通用名称；

最多允许下发64个字符

City

字符串

城市或地区；

最多允许下发128个字符

State

字符串

省（州）；

最多允许下发128个字符

OrgName

字符串

组织；

最多允许下发64个字符

OrgUnit

字符串

组织单元；

最多允许下发64个字符

EmailAddress

字符串

邮件地址；

最多允许下发128个字符

PublicKeyLengthBits

数值

秘钥长度；

目前只支持1024和2048

ValidityDays

数值

有效天数；

取值范围1~5475

 

【使用实例】

【请求样例】

POST https://192.168.188.188/redfish/v1/Managers/1/SecurityService/HttpsCert/Actions/HttpsCert.GenerateCSR

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"Country":"CN",

"CommonName":"iBMC",

"City":"Shenzhen",

"State":"Guangdong",

"OrgName":"h3c",

"OrgUnit":"IT",

"EmailAddress":"[email protected]",

"PublicKeyLengthBits":1024,

"ValidityDays":30

}

【响应样例】

{

"Oem": {

       "Public": {

           "CompletionCode": 0,

           "Description": "Success"

       }

 },

"error": {

       "@Message.ExtendedInfo": [

           {

               "@odata.type": "#Message.v1_1_1.Message",

               "Message": "Successfully Completed Request",

               "MessageArgs": [],

               "MessageId": "Base.1.8.1.Success",

               "MessageSeverity": "OK",

               "Resolution": "None"

           }

       ],

        "code":"Base.1.8.1.Success",

        "message":"Successfully Completed Request"

    }

}

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-326 生成SSL证书输出参数说明

字段

类型

字段说明

code

字符串

指示消息注册表中特定消息ID的字符串

message

字符串

与消息注册表中的消息对应的易读的错误消息

@Message.ExtendedInfo

消息扩展信息

@odata.type

字符串

消息资源的OData描述信息

MessageId

字符串

消息ID

Message

字符串

详细信息

MessageArgs

数组

信息参数

MessageSeverity

字符串

严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical

Resolution

字符串

解决建议

 

【修改记录】

(1)     HDM2-2.04：Message.ExtendedInfo前添加error节点，并且在error节点下增加code和message字段；

 

4.4.72  导入 SSL 证书

【功能描述】

导入SSL证书

【所属权限模块】

安全模块

【所属系统锁定类型】

BMC配置锁定

【命令格式】

POST https://device_ip/redfish/v1/Managers/manager_id/SecurityService/HttpsCert/Actions/HttpsCert.ImportServerCertificate

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

1、本地导入

先通过【上传BMC文件】将文件传输到/tmp/web/目录下，再调用本接口

{

"Certificate": "/tmp/web/server.pem",

"Privatekey": "/tmp/web/privkey.pem"

}

 

2、远程导入

cifs或sftp

{

"Certificate": "sftp://username:[email protected]/server.pem",

"Privatekey": "sftp://username:[email protected]/privkey.pem"

}

http、tftp、nfs或https

{

"Certificate": "tftp://192.168.170.57/server.pem",

"Privatekey": "tftp://192.168.170.57/privkey.pem"

}

 

3、直接上传文本内容

{

"Certificate":"-----BEGIN CERTIFICATE----- \nMIIDrzCCApegAwIBAgIUC9Bj/YPQNv0SjljzLuEQVVPj83EwDQYJKoZIhvcNAQEL \nBQAwZzELMAkGA1UEBhMCY2QxDDAKBgNVBAgMA2ZkZjEMMAoGA1UEBwwDZmRmMQ4w \nDAYDVQQKDAVkZmRmZDELMAkGA1UECwwCZmQxCzAJBgNVBAMMAmZkMRIwEAYJKoZI \nhvcNAQkBFgNmZGYwHhcNMjIwMTA1MDMyMzAxWhcNMjMwMTA1MDMyMzAxWjBnMQsw \nCQYDVQQGEwJjZDEMMAoGA1UECAwDZmRmMQwwCgYDVQQHDANmZGYxDjAMBgNVBAoM \nBWRmZGZkMQswCQYDVQQLDAJmZDELMAkGA1UEAwwCZmQxEjAQBgkqhkiG9w0BCQEW \nA2ZkZjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAOkN3vbmceJ1MCdt \nEW3/V8x0Rxc/L4iYFLP2fNZmn4ANrEEyQ0AIuIbCUml1ehK02wREN36cdmoz5xKD \n7swLxNNDHoJr4jASAma4IFX77M7Ro9uFOxOBHdSvY7fuTPRXCC+V0ttU3NQg9XbG \nUvB6ZtV+YEX7x6XD0SAgHPWgesHcxpfwkaBimZ83NaU/Jdjv+fEDk8LqoFeX4OQT \n5Fpz19dqgyAkoxc7LBOAN1UEipIgIQ4v2zsjcF9+7EQevso6oDKPgllZoOQ5SR9o \neHJ1PFTbuz0EzMICfsLL0yZ8gjW/tjjszxAlntpIc9JIhefnmBX7yAo16AtNdb1V \n7DanjlsCAwEAAaNTMFEwHQYDVR0OBBYEFKNIPyVAN+J2fkQX9bFuYtUZQ9Q1MB8G \nA1UdIwQYMBaAFKNIPyVAN+J2fkQX9bFuYtUZQ9Q1MA8GA1UdEwEB/wQFMAMBAf8w \nDQYJKoZIhvcNAQELBQADggEBAC3BIyK5DLzN7f33dw7C0RDFeV/L+bUc4qJXH4Le \npYJmLY2zWKOC4BSuhoJy6f+EfgbI+nOPcISSxzJM/2nr5XsWslyXLon+dO4D8QlZ \nDuaNjgERCCcy99xwiR6JPkQheF5Fs5EF8sLj2BEAFYf3dArXkugRg0jqTA6Q7ZUG \ngQUCH4fHyBd7LyB9XRUp7TXhYh0M3m3JJ4vqWli7KiQMTc9lWOfB1Kp3TxsmFKXw \noUiAb44TSeJBuPv41sc5PXsGnPu0REM2qSsWccstUAXeI1aw/2aWY+a05yDPIOke \nAHR7hdjLURsNAjCCUh/IHv6R4uy1koOt0wrLen3+UT9w1dg= \n-----END CERTIFICATE-----\n",

"Privatekey":"-----BEGIN PRIVATE KEY----- \nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDpDd725nHidTAn \nbRFt/1fMdEcXPy+ImBSz9nzWZp+ADaxBMkNACLiGwlJpdXoStNsERDd+nHZqM+cS \ng+7MC8TTQx6Ca+IwEgJmuCBV++zO0aPbhTsTgR3Ur2O37kz0VwgvldLbVNzUIPV2 \nxlLwembVfmBF+8elw9EgIBz1oHrB3MaX8JGgYpmfNzWlPyXY7/nxA5PC6qBXl+Dk \nE+Rac9fXaoMgJKMXOywTgDdVBIqSICEOL9s7I3BffuxEHr7KOqAyj4JZWaDkOUkf \naHhydTxU27s9BMzCAn7Cy9MmfII1v7Y47M8QJZ7aSHPSSIXn55gV+8gKNegLTXW9 \nVew2p45bAgMBAAECggEALQ8Yf8YYWL9tmwHUb98Bm68Tm6QEzbURs6XBhzZ6Oijq \nmAReyj+lZbCmfGtROdKr0cxaqmkX3/q+/25wuhTAblQ4zuCK795bhn6tCdLWezo/ \nIw9EV8YL/XYXopU5XbiCBalDBlMHCyCANQGtQX946GgxtvYyKJOOmFZ9IuRvN5HY \ncz/elp8kdRi3hS/xEeiq8g8wKFXb74v39s9ZQlDSvUDMg2dY9O6h/5SWC+blKphN \n86eMyW8N8IViF3l3YqyeKhekhfcsK+SWjVQmm04gp925p1wr+BqDjlXBs8vYBZ20 \nOe09Kv7LDSskweZk77dnxSv/9jTiommEphGEImtLQQKBgQD9j5rd/GTJ01HKYQY7 \nWVx8bNg14njxnZ/ChLZguhTRDLkTMcLI5QmiOlMNrm/U1A0TfuhQD59T/FeF9Mf9 \nuZBeluGuCe4HcWfbp4q9mEZEeaq0xt/CImoVWRb04mErjg7gvijJMxkQhbQo6hnS \ns0Lt2ze5zNGC47KW0InA115buwKBgQDrS8SaRm8XfohzIKzCInFZYKYUPoMDAfoR \nbS2hVSGbPxNEkfQZWM+Xvn7vK+0J68kjGPonpbXyFutNPXe1hqdzhFPZpuNNlSYc \nt0+9fV+ZXTGuc+0CngJ81OaMVEdi1BqVMvkOM+zlXksTgf1ONJ25rHTLTRLBaymr \nMR9x0tJd4QKBgHdqd4ROhuUqed23PikbV9xdoqIWC+G223PP7ti1KnKd7Ffm2pak \nj5nwoAbUfWSdjZ796Mkz4lS6hjnXY4zSJPT3WEgP8yNcPI6NZGEQYx+CsWu8McuL \nS6zMLWydZSgPGmCsDidbwlUusv+F6S17MW02DhOaK53aQNSYWBgTFiRbAoGBAMt9 \nXWwm2dCxx4P5kC7c5rZrVXZQkbE6NnB3wWyzWTsQE7PLnhWFrxMG1nQ1wuw/lFXc \nNguvzmit1ZWZQTwmVg8bNAEZyZ7BDJLtHfM8yD60UFEVRLZsvK4E2dYm1Q3tbYf2 \n61mTIp9DKx6V3uGRs45uTRu9bikEaqb49r7TmsdBAoGBAK0bRD8BdrsFKlpsTAW4 \nYCrLTlSQtQ4ggjOVKqh5kaorhpPS8MBXLMYgvdunYcRu9MafIQn8YmClZrvUHula \nNckI0KcibnguWxQ3KFuFTbrYz60HRwNsVMKT4XcQUbfO/WUfOY2T2Q+pmrmQlb6B \nf0O0j3Q0L1ZrLGuinUBj8XvW \n-----END PRIVATE KEY-----\n"

}

【参数说明】

表4-327 导入SSL证书参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

manager_id

管理资源的ID

当前所有机型取值为1

Certificate

字符串

服务器证书文件或证书链文件

Privatekey

字符串

私钥证书文件或证书链文件

 

【使用实例】

【请求样例】

POST https://192.168.188.188/redfish/v1/Managers/1/SecurityService/HttpsCert/Actions/HttpsCert.ImportServerCertificate

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"Certificate": "/tmp/web/server.pem",

"Privatekey": "/tmp/web/privkey.pem"

}

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#TaskCollection.TaskCollection",

    "@odata.type": "#TaskCollection.TaskCollection",

    "Members": [

        {

            "@odata.id": "/redfish/v1/TaskService/Tasks/3"

        }

    ],

    "[email protected]": 1,

    "Name": "Task Collection",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success",

            "TaskUniqueID": 1678656297

        }

    }

}

返回码：202

【输出说明】

返回状态码202，表示操作成功。

表4-328 导入SSL证书输出说明

字段

类型

字段说明

@odata.context

字符串

导入 SSL 证书资源TaskService的OData 描述信息

@odata.type

字符串

导入 SSL 证书资源TaskService的类型

@odata.id

字符串

导入 SSL 证书资源TaskService的访问路径

[email protected]

字符串

导入 SSL 证书生成的Task链接

Oem.Public.TaskUniqueID

数值

导入 SSL 证书资源TaskService的唯一ID

 

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

 

4.4.73  查询登录安全性信息功能

【功能描述】

获取登录安全性信息功能信息

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/LoginSecurityInformation

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-329 查询登录安全性信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

manager_id

管理资源的ID

当前所有机型取值为1

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

 

【使用实例】

【请求样例】

GET

https://192.168.18.18/redfish/v1/Managers/1/Oem/Public/LoginSecurityInformation

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#LoginSecurityInformation.LoginSecurityInformation",

    "@odata.id": "/redfish/v1/Managers/1/Oem/Public/LoginSecurityInformation",

    "@odata.type": "#LoginSecurityInformation.v1_0_0.LoginSecurityInformation",

    "Name": "LoginSecurity Information",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "SecurityEnabled": false,

    "SecurityInformation": ""

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-330 查询登录安全性信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

指定角色资源模型的OData 描述信息

@odata.id

字符串

指定角色资源的访问路径

@odata.type

字符串

指定角色资源的类型

SecurityEnabled

布尔型

使能状态：

false表示关闭

true表示开启

SecurityInformation

字符串

登录安全性信息内容

 

4.4.74  设置登录安全性信息功能

【功能描述】

设置登录安全性信息功能信息

【所属权限模块】

安全配置

【命令格式】

PATCH

https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/LoginSecurityInformation

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

    "SecurityEnabled": security_enabled,

    "SecurityInformation": security_infomation

}

【参数说明】

表4-331 设置登录安全性信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

manager_id

管理资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

PATCH

https://192.168.18.18/redfish/v1/Managers/1/Oem/Public/LoginSecurityInformation

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

    "SecurityEnabled": true,

    "SecurityInformation": "G6 6900"

}

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#LoginSecurityInformation.LoginSecurityInformation",

    "@odata.id": "/redfish/v1/Managers/1/Oem/Public/LoginSecurityInformation",

    "@odata.type": "#LoginSecurityInformation.v1_0_0.LoginSecurityInformation",

    "Name": "LoginSecurity Information",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "SecurityEnabled": true,

    "SecurityInformation": "G6 6900"

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回字段同【查询登录安全性信息】

 

4.4.75  获取平台固件保护恢复（PFR）配置

【功能描述】

获取平台固件保护恢复（PFR）配置。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/PFRSettings

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-332 获取平台固件保护恢复（PFR）配置参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

manager_id

管理资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Managers/1/Oem/Public/PFRSettings

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#PFRFirmwareProtect.PFRFirmwareProtect",

    "@odata.id": "/redfish/v1/Managers/1/Oem/Public/PFRSettings",

    "@odata.type": "#PFRFirmwareProtect.v1_0_0.PFRFirmwareProtect",

"BootFromSubareaEnabled": false,

"CPLDState": "Absent",

    "Enabled": true,

    "FirmwareStatus": "normal",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

}

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-333 获取平台固件保护恢复（PFR）配置输出参数说明

字段

类型

字段说明

@odata.context

字符串

指定角色资源模型的OData 描述信息

@odata.id

字符串

指定角色资源的访问路径

@odata.type

字符串

指定角色资源的类型

CPLDState

字符串

PRFCPLD在位状态

Enabled

布尔型

PFR固件保护功能开关状态

BootFromSubareaEnabled

布尔型

校验失败是否从备分区启动

FirmwareStatus

字符串

显示当次启动的固件校验状态，如果PFR固件保护功能不开启则为N/A.

 

【修改记录】

(1)     HDM2-1.61：新增字段CPLDState；

 

4.4.76  设置平台固件保护恢复（PFR）配置

【功能描述】

设置平台固件保护恢复（PFR）配置信息

【所属权限模块】

安全配置

【所属系统锁定类型】

BMC配置锁定

【命令格式】

PATCH https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/PFRSettings

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

    "BootFromSubareaEnabled":true

}

【参数说明】

表4-334 设置平台固件保护恢复（PFR）配置参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

manager_id

管理资源的ID

当前所有机型取值为1

BootFromSubareaEnabled

布尔型

校验失败是否从备分区启动

 

【使用实例】

【请求样例】

PATCH

https://192.168.18.18/redfish/v1/Managers/1/Oem/Public/PFRSettings

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"BootFromSubareaEnabled": true

}

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#PFRFirmwareProtect.PFRFirmwareProtect",

    "@odata.id": "/redfish/v1/Managers/1/Oem/Public/PFRSettings",

    "@odata.type": "#PFRFirmwareProtect.v1_0_0.PFRFirmwareProtect",

"BootFromSubareaEnabled": true,

"CPLDState": "Absent",

    "Enabled": true,

    "FirmwareStatus": "normal",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

}

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回字段同【获取平台固件保护恢复（PFR）配置】

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

 

4.4.77  获取串口重定向配置信息

【功能描述】      

获取串口重定向配置信息，X18000产品不支持该接口。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/SOLMode

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-335 获取串口重定向配置信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Managers/1/Oem/Public/SOLMode

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

  "@odata.context": "/redfish/v1/$metadata#SOLMode.SOLMode",

  "@odata.id": "/redfish/v1/Managers/1/Oem/Public/SOLMode",

  "@odata.type": "#SOLMode.v1_0_0.SOLMode",

  "BitRate": "115200",

  "ConnectType": "BIOS",

  "Name": "Serial Over Lan Mode",

  "Oem": {

    "Public": {

      "CompletionCode": 0,

      "Description": "Success"

    }

  }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-336 获取串口重定向配置信息参数说明

字段

类型

字段说明

@odata.context

字符串

串口重定向配置资源模型的 OData描述信息

@odata.id

字符串

串口重定向配置资源的访问路径

@odata.type

字符串

串口重定向配置资源的类型

ConnectType

字符串

BIOS

IntelligentNIC

BitRate

字符串

波特率

目前只支持"115200"

 

【修改记录】

(1)     HDM2-1.56：ConnectType字段删除RAID取值；

(2)     HDM2-1.58：ConnectType字段删除BMC取值；

 

4.4.78  设置串口重定向配置信息

【功能描述】

设置串口重定向配置信息，X18000产品不支持该接口。

【所属权限模块】

远程控制

【命令格式】

PATCH  https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/SOLMode

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:ifmatch_value

【请求消息体】

{

"ConnectType":mode

}

【参数说明】

表4-337 设置串口重定向配置信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

ConnectType

字符串

BIOS

IntelligentNIC

 

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/Managers/manager_id/Oem/Public/SOLMode

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:ifmatch_value

【请求消息体】

{

"ConnectType" : "BIOS"

}

【应答示例】

{

  "@odata.context": "/redfish/v1/$metadata#SOLMode.SOLMode",

  "@odata.id": "/redfish/v1/Managers/1/Oem/Public/SOLMode",

  "@odata.type": "#SOLMode.v1_0_0.SOLMode",

  "BitRate": "115200",

  "ConnectType": "BIOS",

  "Name": "Serial Over Lan Mode",

  "Oem": {

    "Public": {

      "CompletionCode": 0,

      "Description": "Success"

    }

  }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回字段同【获取串口重定向配置信息】

【修改记录】

(1)     HDM2-1.56：ConnectType字段删除RAID取值；

(2)     HDM2-1.58：ConnectType字段删除BMC取值；

 

4.4.79  获取蓝屏快照

【功能描述】   

获取蓝屏快照信息

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/DiagnosticService/ScreenShot

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-338 获取蓝屏快照参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Managers/1/DiagnosticService/ScreenShot

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "redfish/v1/$metadata#Managers/Members/1/DiagnosticService/ScreenShot/$entity",

    "@odata.id": "/redfish/v1/Managers/1/DiagnosticService/ScreenShot",

    "@odata.type": "#ScreenShot.v1_0_0.ScreenShot",

    "Members": [

        {

            "FileName": "BSOD_20211111T172700+0800_01.jpeg"

        }

    ],

    "[email protected]": 1,

    "Name": "CaptureScreenShot",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-339 获取蓝屏快照输出说明

字段

类型

字段说明

@odata.context

字符串

蓝屏快照资源模型的 OData描述信息

@odata.id

字符串

蓝屏快照资源的访问路径

@odata.type

字符串

蓝屏快照资源的类型

FileName

字符串

截屏文件名

 

4.4.80  删除蓝屏快照

【功能描述】

删除蓝屏快照

【所属权限模块】

常规配置

【命令格式】

POST https://device_ip/redfish/v1/Managers/manager_id/DiagnosticService/Actions/DiagnosticService.DeleteScreenShot

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"FileName": filename

}

【参数说明】

表4-340 删除蓝屏快照参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

FileName

字符串

待删除的文件快照名，若置为"deleteAll"，则全部删除

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/Managers/1/DiagnosticService/Actions/DiagnosticService.DeleteScreenShot

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"FileName": "BSOD_20211111T172700+0800_01.jpeg"

}

 

【应答示例】

{

"Oem": {

       "Public": {

           "CompletionCode": 0,

           "Description": "Success"

       }

 },

"error": {

       "@Message.ExtendedInfo": [

           {

               "@odata.type": "#Message.v1_1_1.Message",

               "Message": "Successfully Completed Request",

               "MessageArgs": [],

               "MessageId": "Base.1.8.1.Success",

               "MessageSeverity": "OK",

               "Resolution": "None"

           }

       ],

        "code":"Base.1.8.1.Success",

        "message":"Successfully Completed Request"

    }

}

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-341 删除蓝屏快照操作输出参数说明

字段

类型

字段说明

code

字符串

指示消息注册表中特定消息ID的字符串

message

字符串

与消息注册表中的消息对应的易读的错误消息

@Message.ExtendedInfo

消息扩展信息

@odata.type

字符串

消息资源的OData描述信息

MessageId

字符串

消息ID

Message

字符串

详细信息

MessageArgs

数组

信息参数

MessageSeverity

字符串

严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical

Resolution

字符串

解决建议

 

【修改记录】

(1)     HDM2-2.04：Message.ExtendedInfo前添加error节点，并且在error节点下增加code和message字段；

 

4.4.81  获取录像回放

【功能描述】

获取录像回放信息

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/DiagnosticService/Videos

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-342 获取录像回放信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Managers/1/DiagnosticService/Videos

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#Managers/Members/1/DiagnosticService/Videos/$entity",

    "@odata.id": "/redfish/v1/Managers/1/DiagnosticService/Videos",

    "@odata.type": "#RecordedVideos.v1_0_0.RecordedVideos",

    "Members": [

        {

            "CreateTime": "2022-06-02T23:09:47+08:00",

            "FileName": "pre_shutdown_video_20210918T142531+0800.dat",

            "VideoType": "PoweroffVideo"

        }

    ],

    "[email protected]": 1,

    "Name": "RecordedVideos",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-343 获取录像回放信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

获取录像回放模型的 OData描述信息

@odata.id

字符串

获取录像回放的访问路径

@odata.type

字符串

获取录像回放的类型

Members

对象

录像信息

FileName

字符串

录像文件名称

VideoType

字符串

视频类型
CrashVideo       崩溃录像
OsresetVideo    重启录像
PoweroffVideo   关机录像

CreateTime

字符串

录像文件时间戳

[email protected]

数值

录像个数

Name

字符串

录像资源的名称

 

4.4.82  获取录像回放高级配置

【功能描述】

获取录像回放高级配置

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/DiagnosticService/VideoConfig

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-344 获取录像回放高级配置参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Managers/1/DiagnosticService/VideoConfig

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#Managers/Members/1/DiagnosticService/VideosConfig/$entity",

    "@odata.id": "/redfish/v1/Managers/1/DiagnosticService/VideoConfig",

    "@odata.type": "#RecordedVideosConfig.v1_0_0.RecordedVideosConfig",

    "Name": "RecordedVideos Config",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "RecordingStrategy": {

        "PreCrashEnabled": false,

        "PreRestartEnabled": false,

        "PreShutdownEnabled": false

    },

    "RecordingTime": 15,

    "VideoRecordingEnabled": true

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-345 获取录像回放高级配置输出说明

字段

类型

字段说明

@odata.context

字符串

录像回放设置资源模型的 OData描述信息

@odata.id

字符串

录像回放设置资源的访问路径

@odata.type

字符串

录像回放设置资源的类型

Name

字符串

录像回放设置资源的名称

VideoRecordingEnabled

布尔

录像功能开启状态

RecordingTime

数值

视频录制时间的长度
现在限制为15~255s

RecordingStrategy.PreCrashEnabled

布尔

崩溃前录制是否开启

RecordingStrategy.PreRestartEnabled

布尔

重置前录制是否开启

RecordingStrategy.PreShutdownEnabled

布尔

关机前录制是否开启

 

4.4.83  设置录像回放高级配置

【功能描述】

配置录像回放参数

【所属权限模块】

常规配置

【命令格式】

PATCH  https://device_ip/redfish/v1/Managers/manager_id/DiagnosticService/VideoConfig

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"VideoRecordingEnabled": true,

"RecordingTime": time_s,

"RecordingStrategy": {

    "PreCrashEnabled": true,

    "PreRestartEnabled": false,

    "PreShutdownEnabled": true

  }

}

【参数说明】

表4-346 设置录像回放高级配置参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

VideoRecordingEnabled

布尔

录像功能开启状态

RecordingTime

数值

视频录制时间的长度
现在限制为15~255s

RecordingStrategy.PreCrashEnabled

布尔

崩溃前录制是否开启

RecordingStrategy.PreRestartEnabled

布尔

重置前录制是否开启

RecordingStrategy.PreShutdownEnabled

布尔

关机前录制是否开启

 

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/Managers/1/DiagnosticService/VideoConfig

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

  "VideoRecordingEnabled": true,

  "RecordingTime": 120,

  "RecordingStrategy": {

    "PreCrashEnabled": true,

    "PreRestartEnabled": false,

    "PreShutdownEnabled": true

  }

}

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#Managers/Members/1/DiagnosticService/VideosConfig/$entity",

    "@odata.id": "/redfish/v1/Managers/1/DiagnosticService/VideoConfig",

    "@odata.type": "#RecordedVideosConfig.v1_0_0.RecordedVideosConfig",

    "Name": "RecordedVideos Config",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "RecordingStrategy": {

        "PreCrashEnabled": true,

        "PreRestartEnabled": false,

        "PreShutdownEnabled": true

    },

    "RecordingTime": 120,

    "VideoRecordingEnabled": true

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回字段同【获取录像回放高级配置】

 

4.4.84  播放录像回放

【功能描述】

播放一个录像回放

【所属权限模块】

常规配置

【命令格式】

POST https://device_ip/redfish/v1/Managers/manager_id/DiagnosticService/Actions/DiagnosticService.PlayVideo

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"FileName": filename

}

【参数说明】

表4-347 播放录像回放参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

FileName

字符串

待播放的文件名

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/Managers/1/DiagnosticService/Actions/DiagnosticService.PlayVideo

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"FileName": "pre_crash_video_20211111T172700+0800.dat"

}

【应答示例】

 {

    "@odata.context": "/redfish/v1/$metadata#Managers/Members/1/DiagnosticService/Actions/$entity",

    "@odata.id": "/redfish/v1/Managers/1/DiagnosticService/Actions/DiagnosticService.PlayVideo",

    "@odata.type": "#RecordedVideos.v1_0_0.RecordedVideos",

    "FilePath":"/usr/local/www/video/HDM/pre_crash_video_20211111T172700+0800.dat",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-348 播放录像回放输出说明

字段

类型

字段说明

@odata.context

字符串

录像回放设置资源模型的 OData描述信息

@odata.id

字符串

录像回放设置资源的访问路径

@odata.type

字符串

录像回放设置资源的类型

FilePath

字符串

录像回放文件路径

 

4.4.85  导出录像回放

【功能描述】

导出录像回放

【所属权限模块】

常规配置

【命令格式】

POST https://device_ip/redfish/v1/Managers/manager_id/DiagnosticService/Actions/DiagnosticService.ExportVideo

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

本地导出

{

  "Type":"URI",

  "Content": "/tmp/web/dump.tar.gz",

"Oem": {

      "Public": {

          "FileName": FileName

      }

  }

}

远程导出

cifs或sftp

{

"Type":"URI",

"Content": "sftp://username:[email protected]/usr/dump.tar.gz",

"Oem": {

      "Public": {

          "FileName": FileName

      }

  }

}

http、tftp、nfs或https

{

  "Type":"URI",

"Content": http://ip/filename,

"Oem": {

      "Public": {

          "FileName": FileName,

          "ScriptName":"1.php"

      }

  }

}

【参数说明】

表4-349 导出录像回放参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

manager_id

管理资源的ID

当前所有机型取值为1

Type

导出录像回放的方法

URI

Content

导出录像回放路径

见其它说明

Oem.Public.ScriptName

字符串

通过http/https协议导出时，需指定的脚本文件的名称

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/Managers/1/DiagnosticService/Actions/DiagnosticService.ExportVideo

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

  "Type":"URI",

  "Content": "nfs://192.168.20.177/Share1/pre.dat ",

  "Oem": {

      "Public": {

          "FileName":"pre_crash_video_20211111T172700+0800.dat"

      }

  }

}

【应答示例】

{

  "@odata.context": "/redfish/v1/$metadata#TaskCollection.TaskCollection",

  "@odata.type": "#TaskCollection.TaskCollection",

  "Members": [

    {

      "@odata.id": "/redfish/v1/TaskService/Tasks/2"

    }

  ],

  "[email protected]": 1,

  "Name": "Task Collection",

  "Oem": {

    "Public": {

      "CompletionCode": 0,

      "Description": "Success",

      "TaskUniqueID": 1678656297

    }

  }

}

响应码：202

【输出说明】

返回状态码202，表示操作成功。

表4-350 导出录像回放输出说明

字段

类型

字段说明

@odata.context

字符串

导出录像TaskService的OData 描述信息

@odata.type

字符串

导出录像TaskService的类型

@odata.id

字符串

导出录像TaskService的访问路径

Members

数组

导出录像生成的Task链接

[email protected]

数值

导出录像生成的Task链接个数

Oem.Public.TaskUniqueID

数值

导出录像TaskService的唯一ID

 

4.4.86  删除录像回放

【功能描述】

删除录像回放

【所属权限模块】

常规配置

【命令格式】

POST https://device_ip/redfish/v1/Managers/manager_id/DiagnosticService/Actions/DiagnosticService.DeleteVideo

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"FileName": filename

}

【参数说明】

表4-351 删除录像回放参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

FileName

字符串

待删除的录像名，若置为"deleteAll"，则全部删除

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/Managers/1/DiagnosticService/Actions/DiagnosticService.DeleteVideo

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"FileName": "pre_crash_video_20211111T172700+0800.dat"

}

【应答示例】

{

"Oem": {

       "Public": {

           "CompletionCode": 0,

           "Description": "Success"

       }

 },

"error": {

       "@Message.ExtendedInfo": [

           {

               "@odata.type": "#Message.v1_1_1.Message",

               "Message": "Successfully Completed Request",

               "MessageArgs": [],

               "MessageId": "Base.1.8.1.Success",

               "MessageSeverity": "OK",

               "Resolution": "None"

           }

       ],

        "code":"Base.1.8.1.Success",

        "message":"Successfully Completed Request"

    }

}

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-352 删除录像回放操作输出参数说明

字段

类型

字段说明

code

字符串

指示消息注册表中特定消息ID的字符串

message

字符串

与消息注册表中的消息对应的易读的错误消息

@Message.ExtendedInfo

消息扩展信息

@odata.type

字符串

消息资源的OData描述信息

MessageId

字符串

消息ID

Message

字符串

详细信息

MessageArgs

数组

信息参数

MessageSeverity

字符串

严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical

Resolution

字符串

解决建议

 

【修改记录】

(1)     HDM2-2.04：Message.ExtendedInfo前添加error节点，并且在error节点下增加code和message字段；

 

4.4.87  联合管理 管理设备集合资源查询

【功能描述】

管理设备集合信息查询。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/JointManagement

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-353 联合管理 查询管理设备集合资源参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Managers/1/Oem/Public/JointManagement

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

  "@odata.context": "/redfish/v1/$metadata#JointManagement.JointManagement",

  "@odata.id": "/redfish/v1/Managers/1/Oem/Public/JointManagement",

  "@odata.type": "#JointManagement.v1_0_0.JointManagement",

  "Actions": {

    "Oem": {

      "Public": {

        "#JointManagement.AddDevices": {

          "target": "/redfish/v1/Managers/1/Actions/Oem/Public/JointManagement.AddDevices"

        },

        "#JointManagement.ComputerSystemReset": {

          "target": "/redfish/v1/Managers/1/Actions/Oem/Public/JointManagement.ComputerSystemReset"

        },

        "#JointManagement.RemoveDevices": {

          "target": "/redfish/v1/Managers/1/Actions/Oem/Public/JointManagement.RemoveDevices"

        }

      }

    }

  },

  "Description": "Joint management information",

  "Members": [

    {

      "AssignedPrivileges": [],

      "IPAddress": "192.168.7.23",

      "IndicatorLED": "N/A",

      "MemberId": "0",

      "OemPrivileges": [],

      "OnlineEnabled": false,

      "PowerState": "N/A",

      "ProductName": "N/A",

      "SerialNumber": "N/A",

      "Severity": "N/A"

    },

    {

      "AssignedPrivileges": [

        "ConfigureUsers",

        "ConfigureComponents",

        "Login",

        "ConfigureSelf"

      ],

      "IPAddress": "192.168.188.187",

      "IndicatorLED": "Off",

      "MemberId": "1",

      "OemPrivileges": [

        "OemKvm",

        "OemVmm",

        "OemSecurityMgmt",

        "OemPowerControl",

        "OemDiagnosis",

        "OemSystemAudit"

      ],

      "OnlineEnabled": true,

      "PowerState": "On",

      "ProductName": "RS33M2C9S",

      "SerialNumber": "",

      "Severity": "Critical"

    }

  ],

  "[email protected]": 2,

  "Name": "JointManagement Collection",

  "Oem": {

    "Public": {

      "CompletionCode": 0,

      "Description": "Success"

    }

  }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-354 联合管理 管理设备集合资源输出说明

字段

类型

字段说明

@odata.context

字符串

管理设备集合信息资源模型的OData 描述信息

@odata.id

字符串

管理设备集合信息资源的访问路径

@odata.type

字符串

管理设备集合信息资源的类型

Members

对象

成员列表

Members.AssignedPrivileges

数组

指定权限

Members.OemPrivileges

数组

服务器自定义的权限

Members.MemberId

字符串

设备成员ID

Members.OnlineEnabled

布尔

是否在线

Members.IPAddress

字符串

设备IP

Members.ProductName

字符串

设备名称

Members.Severity

字符串

健康状态

Members.PowerState

字符串

电源状态

Members.IndicatorLED

字符串

UID灯状态

Members.SerialNumber

字符串

序列号

[email protected]

数字

当前设备管理个数

Actions.Oem.Public#JointManagement.ComputerSystemReset

对象

主机电源操作

Actions.Oem.Public#JointManagement.RemoveDevices

对象

删除管理设备

Actions.Oem.Public #JointManagement.AddDevices

对象

添加设备管理

Name

字符串

管理设备集合信息资源的名称

 

4.4.88  联合管理 添加管理设备资源

【功能描述】

添加管理设备资源。

【所属权限模块】

用户配置

【命令格式】

POST https://device_ip/redfish/v1/Managers/manager_id/Actions/Oem/Public/JointManagement.AddDevices

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"StartIPAddress": StartIPAddress,

"EndIPAddress": EndIPAddress,

"UserName": UserName,

"Password": Password

}

【参数说明】

表4-355 联合管理 添加管理设备资源信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

StartIPAddress

字符串

起始IP

EndIPAddress

字符串

结束IP

UserName

字符串

添加设备的用户名

Password

字符串

添加设备的密码

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/Managers/1/Actions/Oem/Public/JointManagement.AddDevices

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

  "StartIPAddress": "192.168.122.178",

  "EndIPAddress": "192.168.122.178",

  "UserName": "admin",

  "Password": "Password@_"

}

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#TaskCollection.TaskCollection",

    "@odata.type": "#TaskCollection.TaskCollection",

    "Members": [

        {

            "@odata.id": "/redfish/v1/TaskService/Tasks/2"

        }

    ],

    "[email protected]": 1,

    "Name": "Task Collection",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success",

            "TaskUniqueID": 1685303949

        }

    }

}

响应码：202

【输出说明】

返回状态码202，表示操作成功。

表4-356 联合管理 添加管理设备资源输出参数说明

字段

类型

字段说明

@odata.context

字符串

添加管理设备TaskService的OData 描述信息

@odata.type

字符串

添加管理设备TaskService的类型

@odata.id

字符串

添加管理设备TaskService的访问路径

[email protected]

字符串

添加管理设备生成的Task链接

Name

字符串

添加管理设备TaskService的名称

 

【修改记录】

(1)     HDM2-1.54：修改 联合管理添加设备采用任务的方法返回；

 

4.4.89  联合管理 删除管理设备资源

【功能描述】

删除管理设备资源。

【所属权限模块】

用户配置

【命令格式】

POST https://device_ip/redfish/v1/Managers/manager_id/Actions/Oem/Public/JointManagement.RemoveDevices

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"ServerList":[

{

"MemberId": MemberId,

"IPAddress": ip

},

{

"MemberId": MemberId,

"IPAddress": ip

}

]

}

【参数说明】

表4-357 联合管理 删除管理设备资源信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

ServerList

数组

设备列表

ServerList.MemberId

字符串

设备成员ID

ServerList.IPAddress

待删除的设备IP

IP地址范围不能超过255个

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/Managers/1/Actions/Oem/Public/JointManagement.RemoveDevices

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"ServerList":[

{

"MemberId": "1",

"IPAddress": "192.168.18.20"

},

{

"MemberId": "2",

"IPAddress": "192.168.18.21"

}

]

}

【应答示例】

{

"Oem": {

       "Public": {

           "CompletionCode": 0,

           "Description": "Success"

       }

 },

"error": {

       "@Message.ExtendedInfo": [

           {

               "@odata.type": "#Message.v1_1_1.Message",

               "Message": "Successfully Completed Request",

               "MessageArgs": [],

               "MessageId": "Base.1.8.1.Success",

               "MessageSeverity": "OK",

               "Resolution": "None"

           }

       ],

        "code":"Base.1.8.1.Success",

        "message":"Successfully Completed Request"

    }

}

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-358 联合管理 删除管理设备资源输出参数说明

字段

类型

字段说明

code

字符串

指示消息注册表中特定消息ID的字符串

message

字符串

与消息注册表中的消息对应的易读的错误消息

@Message.ExtendedInfo

消息扩展信息

@odata.type

字符串

消息资源的OData描述信息

MessageId

字符串

消息ID

Message

字符串

详细信息

MessageArgs

数组

信息参数

MessageSeverity

字符串

严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical

Resolution

字符串

解决建议

 

【修改记录】

(1)     HDM2-2.04：Message.ExtendedInfo前添加error节点，并且在error节点下增加code和message字段；

 

4.4.90  联合管理 主机电源操作

【功能描述】

主机电源操作。

【所属权限模块】

用户配置

【命令格式】

POST https://device_ip/redfish/v1/Managers/manager_id/Actions/Oem/Public/JointManagement.ComputerSystemReset

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"MemberId": MemberId,

"PowerState": PowerState

}

【参数说明】

表4-359 联合管理  主机电源操作参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

MemberId

字符串

设备ID

PowerState

修改电源状态

字符串类型

·     On：上电

·     ForceOff：强制下电

·     GracefulShutdown：正常关机

·     ForceRestart：强制重启

·     ForcePowerCycle：强制下电再上电

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/Managers/1/Actions/Oem/Public/JointManagement.ComputerSystemReset

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"MemberId": "1",

"PowerState": "On"

}

 

【应答示例】

{

"Oem": {

       "Public": {

           "CompletionCode": 0,

           "Description": "Success"

       }

 },

"error": {

       "@Message.ExtendedInfo": [

           {

               "@odata.type": "#Message.v1_1_1.Message",

               "Message": "Successfully Completed Request",

               "MessageArgs": [],

               "MessageId": "Base.1.8.1.Success",

               "MessageSeverity": "OK",

               "Resolution": "None"

           }

       ],

        "code":"Base.1.8.1.Success",

        "message":"Successfully Completed Request"

    }

}

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-360 联合管理 主机电源操作输出参数说明

字段

类型

字段说明

code

字符串

指示消息注册表中特定消息ID的字符串

message

字符串

与消息注册表中的消息对应的易读的错误消息

@Message.ExtendedInfo

消息扩展信息

@odata.type

字符串

消息资源的OData描述信息

MessageId

字符串

消息ID

Message

字符串

详细信息

MessageArgs

数组

信息参数

MessageSeverity

字符串

严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical

Resolution

字符串

解决建议

 

【修改记录】

(1)     HDM2-2.04：Message.ExtendedInfo前添加error节点，并且在error节点下增加code和message字段；

 

4.4.91  查询服务U盘资源信息

【功能描述】

查询服务U盘资源信息。X18000产品不支持该接口。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/USBDeviceService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-361 查询服务U盘资源信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

manager_id

管理资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Managers/1/Oem/Public/USBDeviceService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#USBDeviceService/$entity",

    "@odata.id": "/redfish/v1/Managers/1/Oem/Public/USBDeviceService",

    "@odata.type": "#USBDeviceService.v1_0_0.USBDeviceService",

    "AutomaticDownloadEnabled": false,

"Description": "USB Device Service",

"USBDeviceEnabled": true,

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "ServiceEnabled": true,

    "State": "Absent"

}

响应码：200

【输出说明】

表4-362 查询服务U盘资源信息参数说明

字段

类型

字段说明

@odata.context

字符串

查询服务U盘资源模型的OData 描述信息

@odata.id

字符串

查询服务U盘资源信息的访问路径

@odata.type

字符串

查询服务U盘资源信息的类型

Description

字符串

查询服务U盘资源信息的描述

State

字符串

U盘状态：

Enabled：在位

Absent：不在位

Starting：运行中

ServiceEnabled

布尔

是否启用服务U盘

AutomaticDownloadEnabled

布尔

是否开启自动下载SDS功能

USBDeviceEnabled

布尔

USB物理接口使能状态

 

4.4.92  设置服务U盘资源信息

【功能描述】

设置服务U盘资源信息。X18000产品不支持该接口。

【所属权限模块】

维护诊断模块

【命令格式】

PATCH https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/USBDeviceService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:ifmatch_value

【请求消息体】

{

"ServiceEnabled": true,

"USBDeviceEnabled": true,

"AutomaticDownloadEnabled": true

}

【参数说明】

表4-363 设置服务U盘资源信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

manager_id

管理资源的ID

当前所有机型取值为1

ServiceEnabled

布尔

服务U盘使能状态

AutomaticDownloadEnabled

布尔

自动下载SDS功能使能状态

USBDeviceEnabled

布尔

USB物理接口使能状态

 

【使用实例】

【请求样例】

Patch https://192.168.18.18/redfish/v1/Managers/1/Oem/Public/USBDeviceService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:ifmatch_value

【请求消息体】

{

"ServiceEnabled": true,

"USBDeviceEnabled": true,

"AutomaticDownloadEnabled": true

}

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#USBDeviceService/$entity",

    "@odata.id": "/redfish/v1/Managers/1/Oem/Public/USBDeviceService",

    "@odata.type": "#USBDeviceService.v1_0_0.USBDeviceService",

    "AutomaticDownloadEnabled": true,

    "Description": "USB Device Service",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

},

"USBDeviceEnabled": true,

    "ServiceEnabled": true,

    "State": "Absent"

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回字段同【查询服务U盘资源信息】

 

4.4.93  上传BMC文件

【功能描述】

使用PostMan显示指定的BMC文件内容，用户可以自行使用Postman或搭配curl命令上传文件。

【所属权限模块】

常规配置

【命令格式】

POST https://device_ip/redfish/v1/Managers/manager_id/Actions/Oem/Public/Manager.GeneralUpload

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

<form enctype="multipart/form-data" action="

https://192.168.188.188/redfish/v1/Managers/1/Actions/Oem/Public/Manager.GeneralUpload" method="POST">

<input name="对应文件名字" type="file">

【参数说明】

表4-364 查询日志资源说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/Managers/1/Actions/Oem/Public/Manager.GeneralUpload

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

<form enctype="multipart/form-data" action="

https://192.168.188.188/redfish/v1/Managers/1/Actions/Oem/Public/Manager.GeneralUpload" method="POST">

<input name="BIOSConfiguration" type="file">

【应答示例】

{

"Oem": {

       "Public": {

           "CompletionCode": 0,

           "Description": "Success"

       }

 },

"error": {

       "@Message.ExtendedInfo": [

           {

               "@odata.type": "#Message.v1_1_1.Message",

               "Message": "Successfully Completed Request",

               "MessageArgs": [],

               "MessageId": "Base.1.8.1.Success",

               "MessageSeverity": "OK",

               "Resolution": "None"

           }

       ],

        "code":"Base.1.8.1.Success",

        "message":"Successfully Completed Request"

    }

}

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-365 上传BMC文件输出参数说明

字段

类型

字段说明

code

字符串

指示消息注册表中特定消息ID的字符串

message

字符串

与消息注册表中的消息对应的易读的错误消息

@Message.ExtendedInfo

消息扩展信息

@odata.type

字符串

消息资源的OData描述信息

MessageId

字符串

消息ID

Message

字符串

详细信息

MessageArgs

数组

信息参数

MessageSeverity

字符串

严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical

Resolution

字符串

解决建议

 

【修改记录】

(1)     HDM2-2.04：Message.ExtendedInfo前添加error节点，并且在error节点下增加code和message字段；

 

4.4.94  复位SD卡

【功能描述】

复位SD卡

【所属权限模块】

远程控制

【命令格式】

POST

https://device_ip/redfish/v1/Managers/manager_id/Actions/Oem/Public/Manager.ResetSD

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

}

【参数说明】

表4-366 复位SD卡参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/Managers/1/Actions/Oem/Public/Manager.ResetSD

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

}

【应答示例】

{

"Oem": {

       "Public": {

           "CompletionCode": 0,

           "Description": "Success"

       }

 },

"error": {

       "@Message.ExtendedInfo": [

           {

               "@odata.type": "#Message.v1_1_1.Message",

               "Message": "Successfully Completed Request",

               "MessageArgs": [],

               "MessageId": "Base.1.8.1.Success",

               "MessageSeverity": "OK",

               "Resolution": "None"

           }

       ],

        "code":"Base.1.8.1.Success",

        "message":"Successfully Completed Request"

    }

}

}

响应码：200

【输出说明】

表4-367 复位SD卡参数说明

字段

类型

字段说明

code

字符串

指示消息注册表中特定消息ID的字符串

message

字符串

与消息注册表中的消息对应的易读的错误消息

@Message.ExtendedInfo

消息扩展信息

@odata.type

字符串

消息资源的OData描述信息

MessageId

字符串

消息ID

Message

字符串

详细信息

MessageArgs

数组

信息参数

MessageSeverity

字符串

严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical

Resolution

字符串

解决建议

 

【修改记录】

(1)     HDM2-2.04：Message.ExtendedInfo前添加error节点，并且在error节点下增加code和message字段；

 

4.4.95  查询安全仪表信息

【功能描述】

查询安全仪表信息。

【所属权限模块】

查询模块

【命令格式】

GET

https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/SecurityDashboard

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-368 查询安全仪表信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Managers/1/Oem/Public/SecurityDashboard

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#SecurityDashboard.SecurityDashboard",

    "@odata.id": "/redfish/v1/Managers/1/Oem/Public/SecurityDashboard",

    "@odata.type": "#SecurityDashboard.v1_0_0.SecurityDashboard",

    "AccountAuthenticationSecurity": {

        "AccountLockoutDuration": {

            "ConfigurationStatus": "OK",

            "ConfigurationValue": "5",

            "Id":"4",

            "IgnoreRiskSupported": "Disabled"

        },

        "AccountLockoutThreshold": {

            "ConfigurationStatus": "OK",

            "ConfigurationValue": "1",

            "Id":"3",

            "IgnoreRiskSupported": "Disabled"

        },

        "LDAPCertificateVerification":{

           "ConfigurationStatus": "OK",

           "ConfigurationValue": "Enabled",

           "Id": "7",

           "IgnoreRiskSupported": "Disabled"

        },

        "PasswordComplexityCheck": {

            "ConfigurationStatus": "OK",

            "ConfigurationValue": "Enabled",

            "Id":"1",

            "IgnoreRiskSupported": "Disabled"

        },

        "PasswordHistoryCount": {

            "ConfigurationStatus": "Risky",

            "ConfigurationValue": "0",

            "Id":"5",

            "IgnoreRiskSupported": "Disabled"

        },

        "PasswordValidityDays": {

            "ConfigurationStatus": "Risky",

            "ConfigurationValue": "0",

            "Id":"6",

            "IgnoreRiskSupported": "Disabled"

        },

        "WeakPasswordVerification": {

            "ConfigurationStatus": "Risky",

            "ConfigurationValue": "Disabled",

            "Id":"2",

            "IgnoreRiskSupported": "Disabled"

        }

    },

    "Description": "SecurityDashboard Gettings",

    "Id": "SecurityDashboard",

    "IgnoreRiskAllocationsCount": 0,

    "Name": "SecurityDashboard",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "RiskAllocationsCount": 9,

    "ServiceEnabled": true,

    "ServiceSecurity": {

        "CertificateRemainingTime": {

            "ConfigurationStatus": "OK",

            "ConfigurationValue": "805",

            "Id":"10",

            "IgnoreRiskSupported": "Disabled"

        },

        "CommunityComplexityCheck": {

            "ConfigurationStatus": "Risky",

            "ConfigurationValue": "Disabled",

            "Id": "1",

            "IgnoreRiskSupported": "Disabled"

        },

        "DefaultCertificateEnabled": {

            "ConfigurationStatus": "Risky",

            "ConfigurationValue": "Enabled",

            "Id":"8",

            "IgnoreRiskSupported": "Disabled"

        },

        "KVMEncryption": {

            "ConfigurationStatus": "OK",

            "ConfigurationValue": "Enabled",

            "Id":"5",

            "IgnoreRiskSupported": "Disabled"

        },

        "RMCPPlusEnabled": {

            "ConfigurationStatus": "OK",

            "ConfigurationValue": "Enabled",

            "Id":"3",

            "IgnoreRiskSupported": "Disabled"

        },

        "SMTPTLSEncryption": {

            "ConfigurationStatus": "Risky",

            "ConfigurationValue": "Disabled",

            "Id":"7",

            "IgnoreRiskSupported": "Disabled"

        },

        "SNMPV1V2CEnabled": {

            "ConfigurationStatus": "Risky",

            "ConfigurationValue": "Enabled",

            "Id":"2",

            "IgnoreRiskSupported": "Disabled"

        },

        "SyslogTLSEnabled": {

            "ConfigurationStatus": "Risky",

            "ConfigurationValue": "Disabled",

            "Id":"6",

            "IgnoreRiskSupported": "Disabled"

        },

        "TLSVersion": {

            "ConfigurationStatus": "OK",

            "ConfigurationValue": "TLSv1.2",

            "Id":"9",

            "IgnoreRiskSupported": "Disabled"

        },

        "VNCPasswordComplexityCheck": {

            "ConfigurationStatus": "Risky",

            "ConfigurationValue": "Disabled",

            "Id":"4",

            "IgnoreRiskSupported": "Disabled"

        }

    }

}

响应码：200

【输出说明】

表4-369 查询安全仪表信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

安全仪表信息资源模型的OData 描述信息

@odata.id

字符串

安全仪表信息资源的访问路径

@odata.type

字符串

安全仪表信息资源的类型

Description

字符串

安全仪表资源描述

Id

字符串

安全仪表资源的ID

Name

字符串

安全仪表资源的名称

RiskAllocationsCount

数值

风险配置项，关闭时为0

IgnoreRiskAllocationsCount

数值

忽略风险项，关闭时为0

ServiceEnabled

布尔

安全检测功能，开启为true，关闭为false

AccountAuthenticationSecurity

账号认证安全

 

AccountLockoutThreshold

对象

允许错误密码次数

AccountLockoutThreshold.ConfigurationValue

字符串

配置值

AccountLockoutThreshold.ConfigurationStatus

字符串

状态（OK，Risky）

AccountLockoutThreshold.IgnoreRiskSupported

字符串

是否忽略（Enabled，Disabled）

AccountLockoutThreshold.Id

字符串

配置项ID

PasswordComplexityCheck

对象

密码复杂度检查

PasswordComplexityCheck.ConfigurationValue

字符串

配置值

PasswordComplexityCheck.ConfigurationStatus

字符串

状态（OK，Risky）

PasswordComplexityCheck.IgnoreRiskSupported

字符串

是否忽略（Enabled，Disabled）

PasswordComplexityCheck.Id

字符串

配置项ID

AccountLockoutDuration

对象

用户登录失败锁定时长

AccountLockoutDuration.ConfigurationValue

字符串

配置值

AccountLockoutDuration.ConfigurationStatus

字符串

状态（OK，Risky）

AccountLockoutDuration.IgnoreRiskSupported

字符串

是否忽略（Enabled，Disabled）

AccountLockoutDuration.Id

字符串

配置项ID

WeakPasswordVerification

对象

弱口令校验

WeakPasswordVerification.ConfigurationValue

字符串

配置值

WeakPasswordVerification.ConfigurationStatus

字符串

状态（OK，Risky）

WeakPasswordVerification.IgnoreRiskSupported

字符串

是否忽略（Enabled，Disabled）

WeakPasswordVerification.Id

字符串

配置项ID

PasswordHistoryCount

对象

禁用历史密码

PasswordHistoryCount.ConfigurationValue

字符串

配置值

PasswordHistoryCount.ConfigurationStatus

字符串

状态（OK，Risky）

PasswordValidityDays.IgnoreRiskSupported

字符串

是否忽略（Enabled，Disabled）

PasswordHistoryCount.Id

字符串

配置项ID

PasswordValidityDays

对象

密码有效期

PasswordValidityDays.ConfigurationValue

字符串

配置值

PasswordValidityDays.ConfigurationStatus

字符串

状态（OK，Risky）

PasswordValidityDays.IgnoreRiskSupported

字符串

是否忽略（Enabled，Disabled）

PasswordValidityDays.Id

字符串

配置项ID

LDAPCertificateVerification

对象

LDAP证书校验使能

LDAPCertificateVerification.ConfigurationValue

字符串

配置值

LDAPCertificateVerification.ConfigurationStatus

字符串

状态（OK，Risky）

LDAPCertificateVerification.IgnoreRiskSupported

字符串

是否忽略（Enabled，Disabled）

LDAPCertificateVerification.Id

字符串

配置项ID

ServiceSecurity

应用服务安全

 

CommunityComplexityCheck

对象

团体名复杂度检查

CommunityComplexityCheck.ConfigurationValue

字符串

配置值

CommunityComplexityCheck.ConfigurationStatus

字符串

状态（OK，Risky）

CommunityComplexityCheck.IgnoreRiskSupported

字符串

是否忽略（Enabled，Disabled）

CommunityComplexityCheck.Id

字符串

配置项ID

SNMPV1V2CEnabled

对象

V1/V2C开启状态

SNMPV1V2CEnabled.ConfigurationValue

字符串

配置值

SNMPV1V2CEnabled.ConfigurationStatus

字符串

状态（OK，Risky）

SNMPV1V2CEnabled.IgnoreRiskSupported

字符串

是否忽略（Enabled，Disabled）

SNMPV1V2CEnabled.Id

字符串

配置项ID

RMCPPlusEnabled

对象

IPMI RMCP+配置

RMCPPlusEnabled.ConfigurationValue

字符串

配置值

RMCPPlusEnabled.ConfigurationStatus

字符串

状态（OK，Risky）

RMCPPlusEnabled.IgnoreRiskSupported

字符串

是否忽略（Enabled，Disabled）

RMCPPlusEnabled.Id

字符串

配置项ID

VNCPasswordComplexityCheck

对象

VNC密码复杂度检查

VNCPasswordComplexityCheck.ConfigurationValue

字符串

配置值

VNCPasswordComplexityCheck.ConfigurationStatus

字符串

状态（OK，Risky）

VNCPasswordComplexityCheck.IgnoreRiskSupported

字符串

是否忽略（Enabled，Disabled）

VNCPasswordComplexityCheck.Id

字符串

配置项ID

KVMEncryption

对象

KVM加密

KVMEncryption.ConfigurationValue

字符串

配置值

KVMEncryption.ConfigurationStatus

字符串

状态（OK，Risky）

KVMEncryption.IgnoreRiskSupported

字符串

是否忽略（Enabled，Disabled）

KVMEncryption.Id

字符串

配置项ID

CertificateRemainingTime

对象

证书剩余有效期

CertificateRemainingTime.ConfigurationValue

字符串

配置值

CertificateRemainingTime.ConfigurationStatus

字符串

状态（OK，Risky）

CertificateRemainingTime.IgnoreRiskSupported

字符串

是否忽略（Enabled，Disabled）

CertificateRemainingTime.Id

字符串

配置项ID

TLSVersion

对象

TLS版本

TLSVersion.ConfigurationValue

字符串

配置值

TLSVersion.ConfigurationStatus

字符串

状态（OK，Risky）

TLSVersion.IgnoreRiskSupported

字符串

是否忽略（Enabled，Disabled）

TLSVersion.Id

字符串

配置项ID

DefaultCertificateEnabled

对象

使用默认证书

DefaultCertificateEnabled.ConfigurationValue

字符串

配置值

DefaultCertificateEnabled.ConfigurationStatus

字符串

状态（OK，Risky）

DefaultCertificateEnabled.IgnoreRiskSupported

字符串

是否忽略（Enabled，Disabled）

DefaultCertificateEnabled.Id

字符串

配置项ID

SMTPTLSEncryption

对象

SMTP TLS加密

SMTPTLSEncryption.ConfigurationValue

字符串

配置值

SMTPTLSEncryption.ConfigurationStatus

字符串

状态（OK，Risky）

SMTPTLSEncryption.IgnoreRiskSupported

字符串

是否忽略（Enabled，Disabled）

SMTPTLSEncryption.Id

字符串

配置项ID

SyslogTLSEnabled

对象

Syslog TLS使能

SyslogTLSEnabled.ConfigurationValue

字符串

配置值

SyslogTLSEnabled.ConfigurationStatus

字符串

状态（OK，Risky）

SyslogTLSEnabled.IgnoreRiskSupported

字符串

是否忽略（Enabled，Disabled）

SyslogTLSEnabled.Id

字符串

配置项ID

 

【修改记录】

(1)     HDM2-1.57：新增LDAP证书校验，即字段LDAPCertificateVerification、LDAPCertificateVerification.ConfigurationValue、LDAPCertificateVerification.ConfigurationStatus、LDAPCertificateVerification.IgnoreRiskSupported，及各配置项ID；

 

4.4.96  设置安全仪表信息

【功能描述】

设置安全仪表信息。

【所属权限模块】

安全配置

【所属系统锁定类型】

BMC配置锁定

【命令格式】

PATCH https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/SecurityDashboard

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:ifmatch_value

【请求消息体】

{

  "ServiceEnabled": false,

  "AccountAuthenticationSecurity":{

  "AccountSecurityType":{

        "IgnoreRiskSupported": "Enabled"}

  },

" ServiceSecurity":{

  "ServiceSecurityType":{

        "IgnoreRiskSupported": "Disabled"}

  }

}

【参数说明】

表4-370 设置安全仪表信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

manager_id

管理资源的ID

当前所有机型取值为1

ServiceEnabled

布尔

安全检测功能

AccountAuthenticationSecurity. AccountSecurityType

待设置的账号认证安全类型

可设置的账号认证安全类型包括：AccountLockoutDuration、AccountLockoutThreshold、PasswordComplexityCheck、PasswordHistoryCount、PasswordValidityDays、WeakPasswordVerification

AccountAuthenticationSecurity. AccountSecurityType. IgnoreRiskSupported

字符串

是否忽略（Enabled，Disabled）

ServiceSecurity. ServiceSecurityType

待设置的应用服务安全类型

可设置的应用服务安全类型包括：CertificateRemainingTime、CommunityComplexityCheck、DefaultCertificateEnabled、KVMEncryption、RMCPPlusEnabled、SMTPTLSEncryption、SNMPV1V2CEnabled、SyslogTLSEnabled、TLSVersion、VNCPasswordComplexityCheck

ServiceSecurity. ServiceSecurityType. IgnoreRiskSupported

字符串

是否忽略（Enabled，Disabled）

 

【使用实例】

【请求样例】

Patch https://192.168.18.18/redfish/v1/Managers/1/Oem/Public/SecurityDashboard

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:ifmatch_value

【请求消息体】

{

  "ServiceEnabled": false,

  "AccountAuthenticationSecurity":{

  "PasswordComplexityCheck":{

        "IgnoreRiskSupported": "Enabled"}

  }

}

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#SecurityDashboard.SecurityDashboard",

    "@odata.id": "/redfish/v1/Managers/1/Oem/Public/SecurityDashboard",

    "@odata.type": "#SecurityDashboard.v1_0_0.SecurityDashboard",

    "AccountAuthenticationSecurity": {

        "AccountLockoutDuration": {

            "ConfigurationStatus": "OK",

            "ConfigurationValue": "5",

            "Id":"4",

            "IgnoreRiskSupported": "Disabled"

        },

        "AccountLockoutThreshold": {

            "ConfigurationStatus": "OK",

            "ConfigurationValue": "1",

            "Id":"3",

            "IgnoreRiskSupported": "Disabled"

        },

        "LDAPCertificateVerification":{

           "ConfigurationStatus": "Risky",

           "ConfigurationValue": "Disabled",

           "Id": "7",

           "IgnoreRiskSupported": "Disabled"

        },

        "PasswordComplexityCheck": {

            "ConfigurationStatus": "OK",

            "ConfigurationValue": "Enabled",

            "Id":"1",

            "IgnoreRiskSupported": "Enabled"

        },

        "PasswordHistoryCount": {

            "ConfigurationStatus": "Risky",

            "ConfigurationValue": "0",

            "Id":"5",

            "IgnoreRiskSupported": "Disabled"

        },

        "PasswordValidityDays": {

            "ConfigurationStatus": "Risky",

            "ConfigurationValue": "0",

            "Id":"6",

            "IgnoreRiskSupported": "Disabled"

        },

        "WeakPasswordVerification": {

            "ConfigurationStatus": "Risky",

            "ConfigurationValue": "Disabled",

            "Id":"2",

            "IgnoreRiskSupported": "Disabled"

        }

    },

    "Description": "SecurityDashboard Gettings",

    "Id": "SecurityDashboard",

    "IgnoreRiskAllocationsCount": 1,

    "Name": "SecurityDashboard",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "RiskAllocationsCount": 9,

    "ServiceEnabled": false,

    "ServiceSecurity": {

        "CertificateRemainingTime": {

            "ConfigurationStatus": "OK",

            "ConfigurationValue": "4848",

            "Id": "10",

            "IgnoreRiskSupported": "Disabled"

        },

        "CommunityComplexityCheck": {

            "ConfigurationStatus": "Risky",

            "ConfigurationValue": "Disabled",

            "Id":"1",

            "IgnoreRiskSupported": "Disabled"

        },

        "DefaultCertificateEnabled": {

            "ConfigurationStatus": "Risky",

            "ConfigurationValue": "Enabled",

            "Id":"8",

            "IgnoreRiskSupported": "Disabled"

        },

        "KVMEncryption": {

            "ConfigurationStatus": "OK",

            "ConfigurationValue": "Enabled",

            "Id":"5",

            "IgnoreRiskSupported": "Disabled"

        },

        "RMCPPlusEnabled": {

            "ConfigurationStatus": "OK",

            "ConfigurationValue": "Enabled",

            "Id":"3",

            "IgnoreRiskSupported": "Disabled"

        },

        "SMTPTLSEncryption": {

            "ConfigurationStatus": "Risky",

            "ConfigurationValue": "Disabled",

            "Id":"7",

            "IgnoreRiskSupported": "Disabled"

        },

        "SNMPV1V2CEnabled": {

            "ConfigurationStatus": "Risky",

            "ConfigurationValue": "Enabled",

            "Id":"2",

            "IgnoreRiskSupported": "Disabled"

        },

        "SyslogTLSEnabled": {

            "ConfigurationStatus": "Risky",

            "ConfigurationValue": "Disabled",

            "Id": "6",

            "IgnoreRiskSupported": "Disabled"

        },

        "TLSVersion": {

            "ConfigurationStatus": "OK",

            "ConfigurationValue": "TLSv1.2",

            "Id":"9",

            "IgnoreRiskSupported": "Disabled"

        },

        "VNCPasswordComplexityCheck": {

            "ConfigurationStatus": "Risky",

            "ConfigurationValue": "Disabled",

            "Id":"4",

            "IgnoreRiskSupported": "Disabled"

        }

    }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回字段同【查询安全仪表信息】

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

 

4.4.97  获取系统锁定资源信息

【功能描述】

获取服务器当前系统锁定资源信息。本资源受许可证控制，需要通过许可证授权后才能使用。

锁定范围参考联机帮助，具体请参考每一条命令描述。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/SystemLockResource

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-371 查询系统锁定资源信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Managers/1/Oem/Public/SystemLockResource

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#SystemLockState.SystemLockState"

"@odata.id": "/redfish/v1/Managers/1/Oem/Public/SystemLockResource"

"@odata.type": "#SystemLockResource.v1_0_0.SystemLockResource"

"AccessIsolationEnabled": false

"BIOSLockEnabled": false

"BMCLockEnabled": false

"Description": "Resources Locked By The System"

"HardwareLockEnabled": false

"Oem": {

"Public": {

"CompletionCode": 0,

"Description": "Success"

}

}

"PowerControlLockEnabled": false

"ServiceEnabled": false

"UpgradeLockEnabled": false

}

响应码：200

【输出说明】

表4-372 获取系统锁定资源信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

系统锁定资源模型的OData 描述信息

@odata.id

字符串

系统锁定资源的访问路径

@odata.type

字符串

系统锁定资源的类型

Description

字符串

系统锁定资源描述信息

ServiceEnabled

布尔

系统锁定使能状态

PowerControlLockEnabled

布尔

电源控制锁定状态

UpgradeLockEnabled

布尔

固件版本锁定状态

HardwareLockEnabled

布尔

硬件配置锁定状态

BIOSLockEnabled

布尔

BIOS配置锁定状态

BMCLockEnabled

布尔

BMC锁定状态

AccessIsolationEnabled

布尔

带内外访问隔离状态

 

4.4.98  修改系统锁定资源信息

【功能描述】

修改服务器当前系统锁定资源信息。本资源受许可证控制，需要通过许可证授权后才能使用。

锁定范围参考联机帮助，具体请参考每一条命令描述。

【所属权限模块】

用户配置

【命令格式】

PATCH https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/SystemLockResource

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:ifmatch_value

【请求消息体】

{

"ServiceEnabled": true,

"PowerControlLockEnabled": true,

"UpgradeLockEnabled":true,

"HardwareLockEnabled": true,

"BIOSLockEnabled": true,

"BMCLockEnabled": true,

"AccessIsolationEnabled": true

}

【参数说明】

表4-373 修改系统锁定资源属性参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

ifmatch_value

请求消息的匹配参数

可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）

ServiceEnabled

布尔

系统锁定使能状态

PowerControlLockEnabled

布尔

电源控制锁定状态

UpgradeLockEnabled

布尔

固件版本锁定状态

HardwareLockEnabled

布尔

硬件配置锁定状态

BIOSLockEnabled

布尔

BIOS配置锁定状态

BMCLockEnabled

布尔

BMC锁定状态

AccessIsolationEnabled

布尔

带内外访问隔离状态

 

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/Managers/1/Oem/Public/SystemLockResource

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match: ifmatch_value

【请求消息体】

{

"ServiceEnabled": true,

  "PowerControlLockEnabled": true,

    "UpgradeLockEnabled":true,

    "HardwareLockEnabled": true,

    "BIOSLockEnabled": true,

    "BMCLockEnabled": true,

    "AccessIsolationEnabled": true

}

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#SystemLockState.SystemLockState"

"@odata.id": "/redfish/v1/Managers/1/Oem/Public/SystemLockResource"

"@odata.type": "#SystemLockResource.v1_0_0.SystemLockResource"

"AccessIsolationEnabled": true

"BIOSLockEnabled": true

"BMCLockEnabled": true

"Description": "Resources Locked By The System"

"HardwareLockEnabled": true

"Oem": {

"Public": {

"CompletionCode": 0,

"Description": "Success"

}

}

"PowerControlLockEnabled": true

"ServiceEnabled": true

"UpgradeLockEnabled": true

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回体字段说明同【获取系统锁定资源信息】

 

4.4.99  查询智能监控服务信息

【功能描述】

查询智能监控服务信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/IntelligentMonitoringService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-374 查询智能监控服务信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

manager_id

管理资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Managers/1/Oem/Public/IntelligentMonitoringService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#IntelligentMonitoringService.IntelligentMonitoringService",

    "@odata.id": "/redfish/v1/Managers/1/Oem/Public/IntelligentMonitoringService",

    "@odata.type": "#IntelligentMonitoringService.v1_0_0.IntelligentMonitoringService",

    "Description": "Dynamic monitoring of system resources",

    "Drives": {

        "@odata.id": "/redfish/v1/Managers/1/Oem/Public/IntelligentMonitoringService/Drives"

    },

    "DrivesPredictDays": 4294967295,

    "DrivesPredictEnabled": false,

    "DrivesReportEnabled": false,

    "DrivesUsageThreshold": 4294967295,

    "Id": "IntelligentMonitoringService",

    "Memory": {

        "@odata.id": "/redfish/v1/Managers/1/Oem/Public/IntelligentMonitoringService/Memory"

    },

    "MemoryAlertReportingEnabled": true,

    "MemoryPageOfflineEnabled": true,

    "MemoryLevel": 2,

    "MemoryPageOfflineSizeKB": 1024,

    "MemoryPageOfflineState": "Enabled",

    "Name": "IntelligentMonitoring Service",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "ServiceEnabled": true,

    "Status": {

        "Health": "OK",

        "State": "Enabled"

    }

}

响应码：200

【输出说明】

表4-375 查询智能监控服务信息输出参数

字段

类型

字段说明

@odata.context

字符串

智能监控服务模型的OData 描述信息

@odata.id

字符串

智能监控服务资源的访问路径

@odata.type

字符串

智能监控服务资源的类型

Description

字符串

智能监控服务资源描述信息

Id

字符串

智能监控服务资源的 ID

Name

字符串

智能监控服务资源的名称

ServiceEnabled

布尔型

服务使能

SensorsPreServiceEnabled

布尔型

传感器预测使能（预留）

MemoryAlertReportingEnabled

布尔型

内存预警上报使能状态

注：AMD机型不支持该字段，显示null

MemoryAlertReportingEnabled

布尔型

内存预警上报使能状态

注：仅支持Intel机型，非Intel机型不支持该字段，显示null

MemoryPageOfflineEnabled

布尔型

内存智能修复使能

注：仅支持Intel机型，非Intel机型不支持该字段，显示null

MemoryPageOfflineState

字符串

内存智能修复状态

注：仅支持Intel机型，非Intel机型不支持该字段，显示null

MemoryPageOfflineSizeKB

数值

内存隔离页大小

注：仅支持Intel机型，非Intel机型不支持该字段，显示null

Status.Health

字符串

智能监控服务信息健康状态

Status.State

字符串

智能监控服务信息使能状态

Memory

对象

内存资源的访问路径

Drives

对象

磁盘资源的访问路径。X18000不支持该字段

Sensors

对象

传感器资源访问路径（预留）

DrivesPredictDays

数值

硬盘智能预测天数

DrivesPredictEnabled

布尔型

硬盘智能预测开关

DrivesReportEnabled

布尔型

硬盘智能预测上报开关

DrivesUsageThreshold

数值

硬盘占用率告警阈值

 

【修改记录】

(1)     HDM2-1.54：重新支持此接口；

(2)     HDM2-1.54：新增内存监控相关字段；

(3)     HDM2-1.54：MemoryPageOfflineEnabled字段增加说明；

(4)     HDM2-1.54：新增字段DrivesPredictDays、DrivesPredictEnabled、DrivesReportEnabled和DrivesUsageThreshold；

(5)     HDM2-1.55：更改接口为不受许可证控制；

(6)     HDM2-2.04：MemoryAlertReportingEnabled字段增加说明，MemoryPageOfflineEnabled字段描述从“OS下内存页隔离状态”更改为“内存智能修复”；

(7)     HDM2-1.72、HDM2-2.11：新增字段MemoryPageOfflineState、MemoryPageOfflineSizeKB、MemoryLevel；

 

4.4.100  设置智能监控服务信息

【功能描述】

设置智能监控服务信息，该接口受许可证的限制，需要通过许可证授权后才能设置。

【所属权限模块】

常规配置

【命令格式】

PATCH https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/IntelligentMonitoringService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"MemoryAlertReportingEnabled":alert_reporting_enabled,

"MemoryPageOfflineEnabled":page_offline_enabled,

"MemoryLevel": level_value,

"MemoryPageOfflineSizeKB": page_offline_size_value,

"DrivesPredictDays":drives_predictdays_value,

"DrivesPredictEnabled":drives_predict_enabled,

"DrivesReportEnabled":drives_report_enabled,

"DrivesUsageThreshold":drives_usagethreshold_value

}

 

【参数说明】

表4-376 设置智能监控服务信息说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

manager_id

管理资源的ID

当前所有机型取值为1

MemoryAlertReportingEnabled

布尔型

内存预警上报使能状态

注：仅支持Intel机型，非Intel机型不支持该字段设置

MemoryPageOfflineEnabled

布尔型

内存智能修复使能

注：仅支持Intel机型，非Intel机型不支持该字段设置

MemoryPageOfflineSizeKB

数值

内存隔离页大小

注：仅支持Intel机型，非Intel机型不支持该字段设置

设置该字段可能会改变MemoryPageOfflineState字段的状态

MemoryLevel

数值

内存隔离挡位

1档（每增加一根内存条，隔离总量增加10MB）

2档（每增加一根内存条，隔离总量增加15MB）

3档（每增加一根内存条，隔离总量增加30MB）

注：仅支持Intel机型，非Intel机型不支持该字段设置

DrivesPredictDays

数值

硬盘智能预测天数

DrivesPredictEnabled

布尔型

硬盘智能预测开关

DrivesReportEnabled

布尔型

硬盘智能预测上报开关

DrivesUsageThreshold

数值

硬盘占用率告警阈值

 

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/Managers/manager_id/Oem/Public/IntelligentMonitoringService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

    "DrivesPredictDays": 7,

    "DrivesPredictEnabled": true,

    "DrivesReportEnabled": true,

    "DrivesUsageThreshold": 30,

    "MemoryLevel": 2,

    "MemoryPageOfflineSizeKB": 1024,

    "MemoryPageOfflineEnabled": "true",

}

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#IntelligentMonitoringService.IntelligentMonitoringService",

    "@odata.id": "/redfish/v1/Managers/1/Oem/Public/IntelligentMonitoringService",

    "@odata.type": "#IntelligentMonitoringService.v1_0_0.IntelligentMonitoringService",

    "Description": "Dynamic monitoring of system resources",

    "Drives": {

        "@odata.id": "/redfish/v1/Managers/1/Oem/Public/IntelligentMonitoringService/Drives"

    },

    "DrivesPredictDays": 7,

    "DrivesPredictEnabled": true,

    "DrivesReportEnabled": true,

    "DrivesUsageThreshold": 30,

    "Id": "IntelligentMonitoringService",

    "Memory": {

        "@odata.id": "/redfish/v1/Managers/1/Oem/Public/IntelligentMonitoringService/Memory"

    },

    "MemoryAlertReportingEnabled": true,

    "MemoryPageOfflineEnabled": true,

    "MemoryLevel": 2,

    "MemoryPageOfflineSizeKB": 1024,

    "MemoryPageOfflineState": "Enabled",

    "Name": "IntelligentMonitoring Service",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "ServiceEnabled": true,

    "Status": {

        "Health": "OK",

        "State": "Enabled"

    }

}

响应码：200                                 

【输出说明】

返回状态码200，表示操作成功。

返回字段说明同【查询智能监控服务信息】

【修改记录】

(1)     HDM2-1.54：重新支持此接口；

(2)     HDM2-1.54：MemoryPageOfflineEnabled字段增加说明；

(3)     HDM2-1.54：新增字段DrivesPredictDays、DrivesPredictEnabled、DrivesReportEnabled和DrivesUsageThreshold；

(4)     HDM2-2.04：MemoryAlertReportingEnabled字段增加说明，MemoryPageOfflineEnabled字段描述从“OS下内存页隔离状态”更改为“内存智能修复”；

(5)     HDM2-1.72、HDM2-2.11：新增字段MemoryPageOfflineState、MemoryPageOfflineSizeKB、MemoryLevel；

 

4.4.101  查询智能监控硬盘资源信息

【功能描述】

查询智能监控硬盘资源信息。X18000产品不支持该接口。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/IntelligentMonitoringService/Drives

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

 

【参数说明】

表4-377 查询智能监控硬盘资源监控信息说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

manager_id

系统资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.55.66/redfish/v1/Managers/1/Oem/Public/IntelligentMonitoringService/Drives/

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#IntelligentMonitoringServiceDrives.IntelligentMonitoringServiceDrives",

    "@odata.id": "/redfish/v1/Managers/1/Oem/Public/IntelligentMonitoringService/Drives",

    "@odata.type": "#IntelligentMonitoringServiceDrives.v1_0_0.IntelligentMonitoringServiceDrives",

    "AccumulatedPreWarningCount": 2,

    "AccumulatedRepairedCount": 1,

    "DriveList": [

        {

            "HistoryDriveUsageRate": [

                {

                    "FreeSpaceMB": 0,

                    "Time": "2018-06-22T07:08:00-05:00",

                    "TotalCapacityMB": 1813,

                    "UsageRatePercents": 100.0

                },

                …

            ],

            "Name": "/dev/loop0",

            "PredictedDriveUsageRate": [

                {

                    "FreeSpaceMB": 0,

                    "Time": "2018-06-22T07:29:00-05:00",

                    "TotalCapacityMB": 1813,

                    "UsageRatePercents": 100.0

                },

                …

            ]

        },

        …

    ],

    "Id": "IntelligentMonitoringServiceDrives",

    "Name": "Intelligent Monitoring Service Drives",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

"PredictableDrives": [

{

"@odata.id": "/redfish/v1/Managers/1/Oem/Public/IntelligentMonitoringService/Drives/DiskFront7"

}

],

"RepairedRecords": [

{

"CurrentStatus": Early warning,

"Location": "Front12",

"Manufacturer": "Seagate",

"SerialNumber": "S4713TM0",

"TimeStamp": "2018-06-22T07:29:00+00:00"

}

]

}

响应码：200

【输出说明】

表4-378 查询智能监控硬盘资源信息输出参数

字段

类型

字段说明

@odata.context

字符串

智能监控硬盘资源模型的OData 描述信息

@odata.id

字符串

智能监控硬盘资源的访问路径

@odata.type

字符串

智能监控硬盘资源的类型

Id

字符串

智能监控硬盘资源的 ID

Name

字符串

智能监控硬盘资源的名称

RepairedRecords

数组

硬盘修复记录

TimeStamp

字符串

时间

Location

字符串

物理盘槽位号

SerialNumber

字符串

序列号

Manufacturer

字符串

厂商

CurrentStatus

字符串

硬盘预测状态

Repaired：已修复

Early warning：预故障

AccumulatedRepairedCount

数值

已修复数量

AccumulatedPreWarningCount

数值

预告警数量

PredictableDrives

数组

支持预测的硬盘列表

DriveList

数组

硬盘使用率数据

HistoryDriveUsageRate

数组

历史硬盘使用率数据

PredictedDriveUsageRate

数组

预测硬盘使用率数据

Name

字符串

指定硬盘名称

FreeSpaceMB

数值

硬盘可用容量

UsageRatePercents

数值

硬盘使用率

Time

字符串

记录指定数据时间

TotalCapacityMB

数值

硬盘总容量

 

【修改记录】

(1)     HDM2-1.54：新增接口；

(2)     HDM2-1.54：新增字段DriveList、HistoryDriveUsageRate、PredictedDriveUsageRate 、Name、FreeSpaceMB、UsageRatePercents、Time、TotalCapacityMB；

(3)     HDM2-1.54：应答示例格式修正；

(4)     HDM2-1.55：更改接口为不受许可证控制；

 

4.4.102  查询智能监控指定硬盘信息

【功能描述】

查询智能监控指定硬盘资源信息。X18000产品不支持该接口。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/IntelligentMonitoringService/Drives/drive_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-379 查询智能监控指定硬盘资源信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

manager_id

系统资源的ID

当前所有机型取值为1

driver_id

硬盘ID

由查询智能监控硬盘资源信息中查询

 

【使用实例】

【请求样例】

GET https://192.168.55.66/redfish/v1/Managers/1/Oem/Public/IntelligentMonitoringService/Drives/DiskFront0/

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

SATA盘响应信息：

{

    "@odata.context": "/redfish/v1/$metadata#IntelligentMonitoringServiceDrives.IntelligentMonitoringServiceDrives",

    "@odata.id": "/redfish/v1/Managers/1/Oem/Public/IntelligentMonitoringService/Drives/DiskFront0",

    "@odata.type": "#IntelligentMonitoringServiceDrives.v1_0_0.IntelligentMonitoringServiceDrives",

    "Id": "DiskFront0",

    "LoadUnloadCycles": {

        "HistoryDataList": [

            {

                "Time": "2029-07-27T03:31:51+00:00",

                "Value": 30

            },

            …

            {

                "Time": "2029-07-30T21:30:33+00:00",

                "Value": 30

            }

        ],

        "PredictedDataList": [

            {

                "Time": "2029-07-31T03:30:33+00:00",

                "Value": 30

            },

            {

                "Time": "2029-07-31T09:30:33+00:00",

                "Value": 30

            }

        ],

        "Threshold": 0

    },

    "Manufacturer": "Seagate",

    "MediaType": "HDD",

    "Name": "DiskFront0",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "PowerOnHours": {

        "HistoryDataList": [

            {

                "Time": "2029-07-27T03:31:51+00:00",

                "Value": 8854

            },

            …

            {

                "Time": "2029-07-30T21:30:33+00:00",

                "Value": 8855

            }

        ],

        "PredictedDataList": [

            {

                "Time": "2029-07-31T03:30:33+00:00",

                "Value": 8855

            },

            {

                "Time": "2029-07-31T09:30:33+00:00",

                "Value": 8855

            }

        ],

        "Threshold": null

    },

    "Protocol": "SATA",

    "ReadErrorRate": {

        "HistoryDataList": [

            {

                "Time": "2029-07-27T03:31:51+00:00",

                "Value": 81

            },

            …

            {

                "Time": "2029-07-30T21:30:33+00:00",

                "Value": 81

            }

        ],

        "PredictedDataList": [

            {

                "Time": "2029-07-31T03:30:33+00:00",

                "Value": 81

            },

            {

                "Time": "2029-07-31T09:30:33+00:00",

                "Value": 81

            }

        ],

        "Threshold": 44

    },

    "ReadTimes": {

        "HistoryDataList": [

            {

                "Time": "2029-07-27T03:31:51+00:00",

                "Value": 336398914824

            },

            …

            {

                "Time": "2029-07-30T21:30:33+00:00",

                "Value": 336398914824

            }

        ],

        "PredictedDataList": [

            {

                "Time": "2029-07-31T03:30:33+00:00",

                "Value": 336398914824

            },

            {

                "Time": "2029-07-31T09:30:33+00:00",

                "Value": 336398914824

            }

        ],

        "Threshold": null

    },

    "SerialNumber": "ZAD29G96",

    "StartStopCycles": {

        "HistoryDataList": [

            {

                "Time": "2029-07-27T03:31:51+00:00",

                "Value": 99

            },

            …

            {

                "Time": "2029-07-30T21:30:33+00:00",

                "Value": 99

            }

        ],

        "PredictedDataList": [

            {

                "Time": "2029-07-31T03:30:33+00:00",

                "Value": 99

            },

            {

                "Time": "2029-07-31T09:30:33+00:00",

                "Value": 99

            }

        ],

        "Threshold": 20

    },

    "Temperature": {

        "HistoryDataList": [

            {

                "Time": "2029-07-27T03:31:51+00:00",

                "Value": 32

            },

            …

            {

                "Time": "2029-07-30T21:30:33+00:00",

                "Value": 33

            }

        ],

        "PredictedDataList": [

            {

                "Time": "2029-07-31T03:30:33+00:00",

                "Value": 33

            },

            {

                "Time": "2029-07-31T09:30:33+00:00",

                "Value": 33

            }

        ],

        "Threshold": null

    },

    "WriteTimes": {

        "HistoryDataList": [

            {

                "Time": "2029-07-27T03:31:51+00:00",

                "Value": 65391908603

            },

            …

            {

                "Time": "2029-07-30T21:30:33+00:00",

                "Value": 65391908603

            }

        ],

        "PredictedDataList": [

            {

                "Time": "2029-07-31T03:30:33+00:00",

                "Value": 65391908603

            },

            {

                "Time": "2029-07-31T09:30:33+00:00",

                "Value": 65391908603

            }

        ],

        "Threshold": null

    }

}

SAS盘响应信息：

{

    "@odata.context": "/redfish/v1/$metadata#IntelligentMonitoringServiceDrives.IntelligentMonitoringServiceDrives",

    "@odata.id": "/redfish/v1/Managers/1/Oem/Public/IntelligentMonitoringService/Drives/DiskFront0",

    "@odata.type": "#IntelligentMonitoringServiceDrives.v1_0_0.IntelligentMonitoringServiceDrives",

    "Id": "DiskFront0",

    "LoadUnloadCycles": {

        "HistoryDataList": [

            {

                "Time": "2029-07-27T03:31:51+00:00",

                "Value": 30

            },

            …

            {

                "Time": "2029-07-30T21:30:33+00:00",

                "Value": 30

            }

        ],

        "PredictedDataList": [

            {

                "Time": "2029-07-31T03:30:33+00:00",

                "Value": 30

            },

            {

                "Time": "2029-07-31T09:30:33+00:00",

                "Value": 30

            }

        ],

        "Threshold": 300000

    },

    "Manufacturer": "Seagate",

    "MediaType": "HDD",

    "Name": "DiskFront0",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "PowerOnHours": {

        "HistoryDataList": null,

        "PredictedDataList": null,

        "Threshold": null

    },

    "Protocol": "SAS",

    "ReadErrorRate": {

        "HistoryDataList": null,

        "PredictedDataList": null,

        "Threshold": null

    },

    "ReadTimes": {

        "HistoryDataList": null,

        "PredictedDataList": null,

        "Threshold": null

    },

    "SerialNumber": "S7K1LSPS",

    "StartStopCycles": {

        "HistoryDataList": [

            {

                "Time": "2029-07-27T03:31:51+00:00",

                "Value": 99

            },

            …

            {

                "Time": "2029-07-30T21:30:33+00:00",

                "Value": 99

            }

        ],

        "PredictedDataList": [

            {

                "Time": "2029-07-31T03:30:33+00:00",

                "Value": 99

            },

            {

                "Time": "2029-07-31T09:30:33+00:00",

                "Value": 99

            }

        ],

        "Threshold": 10000

    },

    "Temperature": {

        "HistoryDataList": [

            {

                "Time": "2029-07-27T03:31:51+00:00",

                "Value": 32

            },

            …

            {

                "Time": "2029-07-30T21:30:33+00:00",

                "Value": 33

            }

        ],

        "PredictedDataList": [

            {

                "Time": "2029-07-31T03:30:33+00:00",

                "Value": 33

            },

            {

                "Time": "2029-07-31T09:30:33+00:00",

                "Value": 33

            }

        ],

        "Threshold": 60

    },

    "WriteTimes": {

        "HistoryDataList": null,

        "PredictedDataList": null,

        "Threshold": null

    }

}

响应码：200

【输出说明】

表4-380 查询智能监控指定硬盘信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

智能监控指定硬盘资源模型的OData 描述信息

@odata.id

字符串

智能监控指定硬盘资源的访问路径

@odata.type

字符串

智能监控指定硬盘资源的类型

Id

字符串

智能监控指定硬盘资源的 ID

Name

字符串

智能监控指定硬盘资源的名称

MediaType

字符串

指定物理盘介质类型：

HDD

Protocol

字符串

指定物理盘遵循协议：

SAS

SATA

SerialNumber

字符串

硬盘序列号

Manufacturer

字符串

厂家

PowerOnHours

对象

硬盘上电使用时间及预测数据

StartStopCycles

对象

硬盘上电次数监测及预测数据

LoadUnloadCycles

对象

硬盘加载次数监测及预测数据

WriteTimes

对象

硬盘写次数监测及预测数据

ReadTimes

对象

硬盘读次数监测及预测数据

ReadErrorRate

对象

硬盘读错误率检测及预测数据

Temperature

对象

硬盘温度检测及预测数据

Threshold

数值

阈值

HistoryDataList

数组

历史监测数据

PredictedDataList

数组

预测数据

Time

字符串

记录指定数据的时间

Value

数值

记录指定数据的值

 

【修改记录】

(1)     HDM2-1.54：新增接口；

(2)     HDM2-1.55：更改接口为不受许可证控制；

 

4.4.103  查询智能监控内存资源信息 

【功能描述】

查询智能监控内存资源信息。本资源受许可证控制，需要通过许可证授权后才能使用。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/IntelligentMonitoringService/Memory

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

 

【参数说明】

表4-381 查询智能监控内存资源监控信息说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

manager_id

管理资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Managers/1/Oem/Public/IntelligentMonitoringService/ Memory

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

  "@odata.context": "/redfish/v1/$metadata#IntelligentMonitoringServiceMemory.IntelligentMonitoringServiceMemory",

  "@odata.id": "/redfish/v1/Managers/1/Oem/Public/IntelligentMonitoringService/Memory",

  "@odata.type": "#IntelligentMonitoringServiceMemory.v1_0_0.IntelligentMonitoringServiceMemory",

  "Id": "IntelligentMonitoringServiceMemory",

  "Name": "Intelligent Monitoring Service Memory",

  "Description": "Intelligent Monitoring Memory Source Getting",

  "RepairedMemoryCount":7,

  "TotalRepairdCount":132,

  "RepairedRecords": [

      {

          "TimeStamp":"2022-06-08T09:55:43+08:00",

          "RepairedCount":3,

          "DeviceLocator": "CPU1_CH1_D0",

          "SerialNumber": "2B6BAE3E",

          "Manufacturer": "Micron",

          "Description": "MTR"

          "CurrentStatus": "Repaired"

      },

      ...

  ],

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    }

}

响应码：200

【输出说明】

表4-382 查询智能监控内存信息输出参数

字段

类型

字段说明

@odata.context

字符串

智能监控内存资源模型的OData 描述信息

@odata.id

字符串

智能监控内存资源的访问路径

@odata.type

字符串

智能监控内存资源的类型

Description

字符串

智能监控内存资源描述信息

Id

字符串

智能监控内存资源的 ID

Name

字符串

智能监控内存资源的名称

RepairedMemoryCount

数值

已修复内存数

注：AMD机型不支持该字段，显示null

TotalRepairdCount

数值

总计修复次数

注：AMD机型不支持该字段，显示null

RepairedRecords

数组

内存修复记录

注：AMD机型不支持该字段，显示[]

TimeStamp

字符串

修复时间

RepairedCount

数值

已修复次数

DeviceLocator

字符串

内存丝印

SerialNumber

字符串

序列号

Manufacturer

字符串

厂商

Description

字符串

修复描述

MRT

CurrentStatus

字符串

当前状态

Repaired 已修复

Unrepaired 未修复

 

【修改记录】

(1)     HDM2-1.54：新增接口；

(2)     HDM2-2.04：RepairedMemoryCount、TotalRepairdCount、RepairedRecords字段增加说明，Description字段只保留MRT统一取值；

 

4.4.104  查询快速安装系统配置信息

【功能描述】

查询服务器快速安装系统配置信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/OSInstallService

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-383 查询服务器快速安装系统配置信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【使用实例】

【请求样例】

GET https://192.168.18.188/redfish/v1/Managers/1/Oem/Public/OSInstallService

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【响应样例】

{

    "@odata.context": "/redfish/v1/$metadata#OSInstallService.OSInstallService",

    "@odata.id": "/redfish/v1/Managers/1/Oem/Public/OSInstallService",

    "@odata.type": "#OSInstallService.v1_0_0.OSInstallService",

    "Description": "OS Install Service",

    "Id": "OSInstallService",

    "Image": {

        "ImageName": "CentOS-8.5.2111-x86_64-dvd1.iso",

        "Path": "/data/share",

        "ServerAddress": "172.14.81.158",

        "ServerType": "nfs",

        "UserName": ""

    },

    "Name": "OS Install Service",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "ServiceEnabled": true,

    "ServiceStatus": "Pending"

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-384 查询服务器快速安装系统配置信息参数说明

字段

类型

字段说明

@odata.context 

字符串

快速安装系统服务资源模型的 OData 描述信息

@odata.id

字符串

快速安装系统服务资源节点的访问路径

@odata.type

字符串

快速安装系统服务资源类型

Description

字符串

快速安装系统服务资源描述信息

Id

字符串

快速安装系统服务资源的 ID

Name

字符串

快速安装系统服务资源的名称

ServiceEnabled

布尔型

服务使能

ServiceStatus

字符串

当前服务状态，目前有四种状态。

1、Initial（镜像传输未启动）

2、Completed（镜像传输完成）

3、Pending（等待镜像传输）

4、Running（正在传输镜像）

Image

对象

Image.Path

字符串

镜像所在文档路径

Image.ImageName

字符串

镜像名称

Image.ServerAddress

字符串

服务器地址

Image.ServerType

字符串

服务器类型，支持cifs/nfs

Image.UserName

字符串

用户名

 

4.4.105  创建快速安装系统配置

【功能描述】

创建快速安装系统配置信息。

【所属权限模块】

远程媒体

【命令格式】

PATCH https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/OSInstallService

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"ServiceEnabled": true,

"Image":{

            "Path": path,

            "ImageName": imagename,

            "ServerAddress": serveraddress,

            "ServerType": servertype,

            "UserName": username,

            "Password": password

}

}

【参数说明】

表4-385 创建快速安装系统配置信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

ServiceEnabled

布尔

服务使能

Image

对象

Image.Path

字符串

镜像所在文档路径

Image.ImageName

字符串

镜像名称

Image.ServerAddress

字符串

服务器地址

Image.ServerType

字符串

服务器类型，支持cifs/nfs

Image.UserName

字符串

用户名（仅cifs支持）

Image.Password

字符串

用户密码（仅cifs支持）

 

【使用实例】

【请求样例】

PATCH https://192.168.18.188/redfish/v1/Managers/1/Oem/Public/OSInstallService

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

    "ServiceEnabled":true,

    "Image":{

        "Path":"/homes",

        "ImageName":"rhel-baseos-9.0-x86_64-dvd.iso",

        "ServerAddress":"172.14.81.158",

        "ServerType":"cifs",

        "UserName":"gfy",

        "Password":"111111"

    }

}

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#OSInstallService.OSInstallService",

    "@odata.id": "/redfish/v1/Managers/1/Oem/Public/OSInstallService",

    "@odata.type": "#OSInstallService.v1_0_0.OSInstallService",

    "Description": "OS Install Service",

    "Id": "OSInstallService",

    "Image": {

        "ImageName": "rhel-baseos-9.0-x86_64-dvd.iso",

        "Path": "/homes",

        "ServerAddress": "172.14.81.158",

        "ServerType": "cifs",

        "UserName": "gfy"

    },

    "Name": "OS Install Service",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "ServiceEnabled": true,

    "ServiceStatus": "Pending"

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回字段说明同【查询快速安装系统配置信息】

 

4.4.106  获取应急诊断信息

【功能描述】

应急诊断信息配置获取

【所属权限模块】

查询模块

【命令格式】

GET   https://device_ip/redfish/v1/Managers/manager_id/DiagnosticService

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-386 获取应急诊断信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

manager_id

管理资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Managers/1/DiagnosticService

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#Managers/Members/1/DiagnosticService/$entity",

    "@odata.id": "/redfish/v1/Managers/1/DiagnosticService",

    "@odata.type": "#DiagnosticService.v1_0_0.DiagnosticService",

    "Actions": {

        "#DiagnosticService.DeleteScreenShot": {

            "target": "/redfish/v1/Managers/1/DiagnosticService/Actions/DiagnosticService.DeleteScreenShot"

        },

        "#DiagnosticService.DeleteVideo": {

            "target": "/redfish/v1/Managers/1/DiagnosticService/Actions/DiagnosticService.DeleteVideo"

        },

        "#DiagnosticService.ExportVideo": {

            "target": "/redfish/v1/Managers/1/DiagnosticService/Actions/DiagnosticService.ExportVideo"

        },

        "#DiagnosticService.PlayVideo": {

            "target": "/redfish/v1/Managers/1/DiagnosticService/Actions/DiagnosticService.PlayVideo"

        }

    },

    "DiagnosticDescription": "",

    "DiagnosticDeviceList": {

        "Memory": "Healthy",

        "PCH": "Healthy",

        "PCIe": "Healthy",

        "PCIeUnderPCH": "Healthy",

        "Processor": "Healthy",

        "SATAController": "Healthy",

        "USB": "Healthy",

        "sSATAController": "Healthy",

        "tSATAController": "Healthy"

    },

    "DiagnosticResult": "Failed",

    "FDIStartupMode": "Disabled",

    "Id": "Diagnostic Configuration Information",

    "MiniModeEnabled": true,

    "Name": "Diagnostic Configuration Information",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "ScreenShot": {

        "@odata.id": "/redfish/v1/Managers/1/DiagnosticService/ScreenShot"

    },

    "VideoConfig": {

        "@odata.id": "/redfish/v1/Managers/1/DiagnosticService/VideoConfig"

    },

    "Videos": {

        "@odata.id": "/redfish/v1/Managers/1/DiagnosticService/Videos"

    }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-387 获取应急诊断信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

诊断资源模型的 OData描述信息

@odata.id

字符串

诊断资源的访问路径

@odata.type

字符串

诊断资源的类型

MiniModeEnabled

布尔型

最小启动方式

true：开启

flase：关闭

FDIStartupMode

字符串

诊断隔离启动

Disabled表示关闭

DiagnosticMode表示仅诊断

FDI表示诊断+隔离

DiagnosticResult

字符串

诊断结果

Success：成功

Failed：失败

DiagnosticDeviceList

对象

诊断设备列表

Processor

字符串

CPU诊断结果

Healthy： 健康

Unhealthy：不健康

(null表示未检测到错误)

Memory

字符串

内存诊断结果

Healthy： 健康

Unhealthy：不健康

(null表示未检测到错误)

PCIe

字符串

CPU根端口下的PCIe设备诊断结果

Healthy： 健康

Unhealthy：不健康

(null表示未检测到错误)

PCH

字符串

PCH下设备诊断结果

Healthy： 健康

Unhealthy：不健康

(null表示未检测到错误)

SATAController

字符串

PCH SATA控制器下的设备诊断结果

Healthy： 健康

Unhealthy：不健康

(null表示未检测到错误)

sSATAController

字符串

PCH sSATA控制器下的设备诊断结果

Healthy： 健康

Unhealthy：不健康

(null表示未检测到错误)

tSATAController

字符串

PCH tSATA控制器下的设备诊断结果

Healthy： 健康

Unhealthy：不健康

(null表示未检测到错误)

USB

字符串

USB设备诊断结果

Healthy： 健康

Unhealthy：不健康

(null表示未检测到错误)

PCIeUnderPCH

字符串

PCH根端口下的PCIe设备诊断结果

Healthy： 健康

Unhealthy：不健康

(null表示未检测到错误)

DiagnosticDescription

字符串

诊断描述，字符串信息

 

【修改记录】

(1)     HDM2-2.04：新增接口；

 

4.4.107  设置应急诊断配置信息

【功能描述】

设置应急诊断信息配置

【所属权限模块】

常规配置

【命令格式】

PATCH https://device_ip/redfish/v1/Managers/manager_id/DiagnosticService

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"MiniModeEnabled":true,

"FDIStartupMode":"Disabled"

}

【参数说明】

表4-388 设置应急诊断信息配置参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

system_id

系统资源的ID

当前所有机型取值为1

MiniModeEnabled

布尔型

最小启动方式

FDIStartupMode

字符串

诊断隔离启动

Disabled表示关闭

DiagnosticMode表示仅诊断

FDI表示诊断+隔离

 

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/Managers/1/DiagnosticService

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"MiniModeEnabled":true,

"FDIStartupMode": "Disabled"

}

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#Managers/Members/1/DiagnosticService/$entity",

    "@odata.id": "/redfish/v1/Managers/1/DiagnosticService",

    "@odata.type": "#DiagnosticService.v1_0_0.DiagnosticService",

    "Actions": {

        "#DiagnosticService.DeleteScreenShot": {

            "target": "/redfish/v1/Managers/1/DiagnosticService/Actions/DiagnosticService.DeleteScreenShot"

        },

        "#DiagnosticService.DeleteVideo": {

            "target": "/redfish/v1/Managers/1/DiagnosticService/Actions/DiagnosticService.DeleteVideo"

        },

        "#DiagnosticService.ExportVideo": {

            "target": "/redfish/v1/Managers/1/DiagnosticService/Actions/DiagnosticService.ExportVideo"

        },

        "#DiagnosticService.PlayVideo": {

            "target": "/redfish/v1/Managers/1/DiagnosticService/Actions/DiagnosticService.PlayVideo"

        }

    },

    "DiagnosticDescription": "",

    "DiagnosticDeviceList": {

        "Memory": "Healthy",

        "PCH": "Healthy",

        "PCIe": "Healthy",

        "PCIeUnderPCH": "Healthy",

        "Processor": "Healthy",

        "SATAController": "Healthy",

        "USB": "Healthy",

        "sSATAController": "Healthy",

        "tSATAController": "Healthy"

    },

    "DiagnosticResult": "Failed",

    "FDIStartupMode": "Disabled",

    "Id": "Diagnostic Configuration Information",

    "MiniModeEnabled": true,

    "Name": "Diagnostic Configuration Information",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "ScreenShot": {

        "@odata.id": "/redfish/v1/Managers/1/DiagnosticService/ScreenShot"

    },

    "VideoConfig": {

        "@odata.id": "/redfish/v1/Managers/1/DiagnosticService/VideoConfig"

    },

    "Videos": {

        "@odata.id": "/redfish/v1/Managers/1/DiagnosticService/Videos"

    }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回字段同【获取应急诊断信息】

【修改记录】

(1)     HDM2-2.04：新增接口；

 

4.4.108  多节点设备节点控制

【功能描述】

多节点设备节点控制，目前仅E3300G6支持

【所属权限模块】

维护诊断

【命令格式】

POST

https://device_ip/redfish/v1/Managers/manager_id/Actions/Oem/Public/Manager.NodeSwitch

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

}

【参数说明】

表4-389 多节点设备节点控制参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

manager_id

管理资源的ID

当前所有机型取值为1

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/Managers/<str>/Actions/Oem/<str>/Manager.NodeSwitch/

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

}

【应答示例】

{

"Oem": {

       "Public": {

           "CompletionCode": 0,

           "Description": "Success"

       }

},

"error": {

       "@Message.ExtendedInfo": [

           {

               "@odata.type": "#Message.v1_1_1.Message",

               "Message": "Successfully Completed Request",

               "MessageArgs": [],

               "MessageId": "Base.1.8.1.Success",

               "MessageSeverity": "OK",

               "Resolution": "None"

           }

       ],

        "code":"Base.1.8.1.Success",

        "message":"Successfully Completed Request"

    }

}

}

响应码：200

【输出说明】

表4-390 节点控制参数说明

字段

类型

字段说明

code

字符串

指示消息注册表中特定消息ID的字符串

message

字符串

与消息注册表中的消息对应的易读的错误消息

@Message.ExtendedInfo

消息扩展信息

@odata.type

字符串

消息资源的OData描述信息

MessageId

字符串

消息ID

Message

字符串

详细信息

MessageArgs

数组

信息参数

MessageSeverity

字符串

严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical

Resolution

字符串

解决建议

 

【修改记录】

(1)     HDM2-2.09：新增接口；HDM3暂不支持

 

4.5  AccountService 资源的操作

4.5.1  查询用户服务信息

【功能描述】

查询服务器当前用户服务信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/AccountService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-391 查询用户服务信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/AccountService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【响应样例】

{

    "@odata.context": "/redfish/v1/$metadata#AccountService.AccountService",

    "@odata.id": "/redfish/v1/AccountService",

    "@odata.type": "#AccountService.v1_7_0.AccountService",

    "ADService": {

        "@odata.id": "/redfish/v1/AccountService/ADService"

    },

    "AccountLockoutDuration": 5,

    "AccountLockoutThreshold": 5,

    "Accounts": {

        "@odata.id": "/redfish/v1/AccountService/Accounts"

    },

     "Actions": {

        "Oem": {

            "Public": {

                "#CertificateService.ImportRootCertificate": {

"#AccountService.ExportWeakPasswordDictionary": {

                    "target": "/redfish/v1/AccountService/Actions/Oem/Public/AccountService.ExportWeakPasswordDictionary"

                },

                "#AccountService.ImportWeakPasswordDictionary": {

                    "target": "/redfish/v1/AccountService/Actions/Oem/Public/AccountService.ImportWeakPasswordDictionary"

              },

                    "target": "/redfish/v1/AccountService/Actions/Oem/Public/CertificateService.ImportRootCertificate"

                },

                "#SSHCiphers.BindUser": {

                    "target": "/redfish/v1/AccountService/Actions/Oem/Public/SSHCiphers/SSHCiphers.BindUser"

                },

                "#SSHCiphers.DeleteUser": {

                    "target": "/redfish/v1/AccountService/Actions/Oem/Public/SSHCiphers/SSHCiphers.DeleteUser"

                },

                "#SSHCiphers.ImportSSHCiphers": {

                    "target": "/redfish/v1/AccountService/Actions/Oem/Public/SSHCiphers/SSHCiphers.ImportSSHCiphers"

                }

                "#LDAPService.ImportLDAPCertificate":{

                    "target":"/redfish/v1/AccountService/Actions/Oem/Public/LDAPService.ImportLDAPCertificate"

               }

            }

        }

},   

"Description": "BMC User Accounts",

    "Id": "AccountService",

    "LDAPService": {

        "@odata.id": "/redfish/v1/AccountService/LDAPService"

    },

    "MaxPasswordLength": 40,

    "MinPasswordLength": 8,

    "Name": "Account Service",

    "Oem": {

        "Public": {

            "CertificateService": {

                "@odata.id": "/redfish/v1/AccountService/Oem/Public/CertificateService"

            },

"CompletionCode": 0,

            "RoleNames": {

                "@odata.id": "/redfish/v1/AccountService/Roles/Oem/Public/RoleNames"

            },

            "Description": "Success",

            "PasswordRule": {

                "PasswordComplexityCheckEnabled": true,

                "PasswordValidityDays": 0,

                "PreviousPasswordsDisallowedCount": 0,

"WeakPasswordDictionaryEnabled": false

            },

"WeakPasswordDictionaryName":"pw_dict_default.txt",

            "TwoFactorAuthenticationInformation": {

                "OTPServerAddress": "",

                "OTPServerPort": 1812,

                "OTPServerSharedKey": "",

                "TwoFactorAuthenticationStateEnabled": false

            }

        }

    },

    "Roles": {

        "@odata.id": "/redfish/v1/AccountService/Roles"

    },

    "SSHCiphers": {

        "@odata.id": "/redfish/v1/AccountService/Oem/Public/SSHCiphers"

    },

    "ServiceEnabled": true,

    "Status": {

        "Health": "OK",

        "State": "Enabled"

    }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-392 查询用户服务信息输出参数说明

字段

类型

字段说明

@odata.context 

字符串

AccountService 资源模型的 OData 描述信息

@odata.id

字符串

AccountService 资源节点的访问路径

@odata.type

字符串

AccountService 资源类型

Description

字符串

用户服务资源描述信息

Id

字符串

AccountService 资源的 ID

Name

字符串

AccountService 资源的名称

LDAPService

对象

LDAPService资源节点的访问路径

MinPasswordLength

数值

密码最小长度

MaxPasswordLength

数值

密码最大长度

AccountLockoutThreshold

数值

允许错误密码次数，即输入错误密码次数超过此参数时，用户被锁定。

AccountLockoutDuration

数值

用户登录失败后被锁定的锁定时长。

ADService

对象

ADService资源节点的访问路径

Accounts

对象

Account资源节点的访问路径

Actions.Oem.Public

AccountService资源自定义可执行的操作

#CertificateService.ImportRootCertificate

对象

导入根证书文件操作路径

#SSHCiphers.BindUser

对象

用户绑定指定SSH公钥操作路径

#SSHCiphers.DeleteUser

对象

SSH公钥解绑与特定用户的关联操作路径

#SSHCiphers.ImportSSHCiphers

对象

导入SSH公钥操作路径

#LDAPService.ImportLDAPCertificate

对象

导入LDAP CA证书文件

Oem.Public

用户服务自定义信息

CertificateService

对象

CertificateService资源节点的访问路径

RoleNames

对象

角色配置资源节点的访问路径

PasswordRule.PasswordComplexityCheckEnabled

布尔型

密码复杂度使能

PasswordRule.PreviousPasswordsDisallowedCount

数值

用户修改密码时，禁止使用设置次数内的历史密码

取值范围为 0~5，取值为 0 时表示不限制使用历史密码

PasswordRule.PasswordValidityDays

数值

密码有效期

PasswordRule.WeakPasswordDictionaryEnabled

布尔型

弱口令字典开启

WeakPasswordDictionaryName

字符串

弱口令字典名称

TwoFactorAuthenticationInformation

对象，刀箱产品不支持

TwoFactorAuthenticationStateEnabled

布尔型

双因素认证使能

OTPServerAddress

字符串

OTP Server网络地址

OTPServerPort

数值

OTP Server的服务端口号

OTPServerSharedKey

字符串

OTP Server的共享密钥，长度为1-64

Roles

对象

Roles资源节点的访问路径

SSHCiphers

对象

SSHCiphers资源节点的访问路径

ServiceEnabled

布尔型

服务使能

Status.Health

字符串

用户服务信息健康状态

Status.State

字符串

用户服务信息使能状态

 

【修改记录】

(1)     HDM2-1.57：新增字段#LDAPService.ImportLDAPCertificate；

(2)     HDM2-1.59：新增字段WeakPasswordDictionaryName；

 

4.5.2  修改用户服务信息

【功能描述】

修改服务器当前用户服务信息。

【所属权限模块】

用户配置

【所属系统锁定类型】

BMC配置锁定

【命令格式】

PATCH https://device_ip/redfish/v1/AccountService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:ifmatch_value

【请求消息体】

{

    "AccountLockoutDuration": 5,

    "AccountLockoutThreshold": 5,

    "Oem": {

        "Public": {

            "PasswordRule": {

                "PasswordComplexityCheckEnabled": true,

                "PreviousPasswordsDisallowedCount": 5,

"PasswordValidityDays": 15,

"WeakPasswordDictionaryEnabled": false

            },

"TwoFactorAuthenticationInformation": {

"TwoFactorAuthenticationStateEnabled": false,

"OTPServerAddress": "192.168.1.36",

"OTPServerPort": 1812,

"OTPServerSharedKey": "admin"

          }

        }

    }

}

【参数说明】

表4-393 修改用户服务信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

ifmatch_value

请求消息的匹配参数

可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）

AccountLockoutDuration

数值

用户登录失败后被锁定的锁定时长。

AccountLockoutThreshold

数值

允许错误密码次数，即输入错误密码次数超过此参数时，用户被锁定。

PassWordRule

对象

PasswordComplexityCheckEnabled

布尔型

密码复杂度使能

PreviousPasswordsDisallowedCount

数值

用户修改密码时，禁止使用设置次数内的历史密码

取值范围为 0~5，取值为0时表示不限制使用历史

PasswordValidityDays

数值

密码有效期

WeakPasswordDictionaryEnabled

布尔型

弱口令字典使能

TwoFactorAuthenticationInformation

对象，刀箱产品不支持

TwoFactorAuthenticationStateEnabled

布尔型

双因素认证使能

OTPServerAddress

字符串

OTP Server网络地址

OTPServerPort

数值

OTP Server的服务端口号

OTPServerSharedKey

字符串

OTP Server的共享密钥，长度为1~64

 

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/AccountService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

    "Oem":{

        "Public":{

            "PassWordRule":{

                "PasswordComplexityCheckEnabled":true

            },

            "TwoFactorAuthenticationInformation":{

                "TwoFactorAuthenticationStateEnabled":false,

                "OTPServerAddress":"192.168.1.36",

                "OTPServerPort":1812,

                "OTPServerSharedKey":"admin"

            }

        }

    }

}

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#AccountService.AccountService",

    "@odata.id": "/redfish/v1/AccountService",

    "@odata.type": "#AccountService.v1_7_0.AccountService",

    "ADService": {

        "@odata.id": "/redfish/v1/AccountService/ADService"

    },

    "AccountLockoutDuration": 5,

    "AccountLockoutThreshold": 5,

    "Accounts": {

        "@odata.id": "/redfish/v1/AccountService/Accounts"

    },

    "Actions": {

        "Oem": {

            "Public": {

"#AccountService.ExportWeakPasswordDictionary": {

                    "target": "/redfish/v1/AccountService/Actions/Oem/Public/AccountService.ExportWeakPasswordDictionary"

                },

                "#AccountService.ImportWeakPasswordDictionary": {

                    "target": "/redfish/v1/AccountService/Actions/Oem/Public/AccountService.ImportWeakPasswordDictionary"

              },

                "#CertificateService.ImportRootCertificate": {

                    "target": "/redfish/v1/AccountService/Actions/Oem/Public/CertificateService.ImportRootCertificate"

                },

                "#SSHCiphers.BindUser": {

                    "target": "/redfish/v1/AccountService/Actions/Oem/Public/SSHCiphers/SSHCiphers.BindUser"

                },

                "#SSHCiphers.DeleteUser": {

                    "target": "/redfish/v1/AccountService/Actions/Oem/Public/SSHCiphers/SSHCiphers.DeleteUser"

                },

                "#SSHCiphers.ImportSSHCiphers": {

                    "target": "/redfish/v1/AccountService/Actions/Oem/Public/SSHCiphers/SSHCiphers.ImportSSHCiphers"

                }

                "#LDAPService.ImportLDAPCertificate":{

                    "target": "/redfish/v1/AccountService/Actions/Oem/Public/LDAPService.ImportLDAPCertificate"

               }

            }

        }

    },

    "Description": "BMC User Accounts",

    "Id": "AccountService",

    "LDAPService": {

        "@odata.id": "/redfish/v1/AccountService/LDAPService"

    },

    "MaxPasswordLength": 40,

    "MinPasswordLength": 8,

    "Name": "Account Service",

    "Oem": {

        "Public": {

            "CertificateService": {

                "@odata.id": "/redfish/v1/AccountService/Oem/Public/CertificateService"

            },

            "CompletionCode": 0,

            "RoleNames": {

                "@odata.id": "/redfish/v1/AccountService/Roles/Oem/Public/RoleNames"

            },

            "Description": "Success",

            "PasswordRule": {

                "PasswordComplexityCheckEnabled": true,

                "PasswordValidityDays": 0,

                "PreviousPasswordsDisallowedCount": 0,

"WeakPasswordDictionaryEnabled": false

            },

"WeakPasswordDictionaryName":"pw_dict_default.txt",

            "TwoFactorAuthenticationInformation": {

                "OTPServerAddress": "192.168.1.36",

                "OTPServerPort": 1812,

                "OTPServerSharedKey": "admin",

                "TwoFactorAuthenticationStateEnabled": false

            }

        }

    },

    "Roles": {

        "@odata.id": "/redfish/v1/AccountService/Roles"

    },

    "SSHCiphers": {

        "@odata.id": "/redfish/v1/AccountService/Oem/Public/SSHCiphers"

    },

    "ServiceEnabled": true,

    "Status": {

        "Health": "OK",

        "State": "Enabled"

    }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回字段说明同【查询用户服务信息】

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

 

4.5.3  查询用户列表信息

【功能描述】

查询用户列表信息。非admin用户只能查询自身。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/AccountService/Accounts

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-394 查询用户列表信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【请求样例】

GET https://192.168.18.18/redfish/v1/AccountService/Accounts

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

          "@odata.context": "/redfish/v1/$metadata#ManagerAccountCollection.ManagerAccountCollection",

    "@odata.id": "/redfish/v1/AccountService/Accounts",

    "@odata.type": "#ManagerAccountCollection.ManagerAccountCollection",

"Members": [

{

            "@odata.id": "/redfish/v1/AccountService/Accounts/1"

    },

        {

            "@odata.id": "/redfish/v1/AccountService/Accounts/2"

        }

      ],

      "[email protected]": 2,

"Name": "Accounts Collection",

"Oem": {

      "Public": {

        "CompletionCode": 0,

         "Description": "Success"

      }

    }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-395 查询用户列表信息输出参数说明

字段

类型

字段说明

@odata.context 

字符串

用户集合资源模型的 OData 描述信息

@odata.id

字符串

用户集合资源节点的访问路径

@odata.type

字符串

用户集合资源类型

Name

字符串

用户资源集合的名称

Members

数组

用户信息查询路径

[email protected]

数值

用户个数

[email protected]

字符串

指定用户资源节点的访问路径

 

4.5.4  查询指定用户信息

【功能描述】

查询指定的用户信息。非admin用户只能查询自身。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/AccountService/Accounts/user_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-396 查询指定的用户信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

user_id

用户ID

由用户集合中查询

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/AccountService/Accounts/2

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【响应样例】

{

    "@odata.context": "/redfish/v1/$metadata#ManagerAccount.ManagerAccount",

    "@odata.id": "/redfish/v1/AccountService/Accounts/2",

    "@odata.type": "#ManagerAccount.v1_6_0.ManagerAccount",

    "Description": "Default Account",

    "Enabled": true,

    "Id": "2",

    "Links": {

        "Roles": {

            "@odata.id": "/redfish/v1/AccountService/Roles/Administrator"

        }

    },

    "Locked": false,

    "Name": "Default Account",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success",

            "IPMIEnable": true,

            "SnmpEncryptPwdInit": true,

            "SnmpV3AccessPermission": "read_only",

            "SnmpV3AuthProtocol": "SHA",

            "SnmpV3Enable": false,

            "SnmpV3Password": null,

            "SnmpV3PrivProtocol": "DES",

            "WebEnable": true,

"DefaultPasswordModifyPolicy":"NotModify"

        }

    },

    "Password": null,

    "RoleId": "Administrator",

    "UserName": "admin"

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-397 查询指定用户信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

指定用户信息资源模型的 OData 描述信息

@odata.id        

字符串

指定用户信息资源节点的访问路径

@odata.type

字符串

指定用户信息 资源类型

Description

字符串

指定用户信息描述

Enabled

布尔型

是否启用

Id

数值

用户ID

Links.Roles

字符串

所在权限的查询路径

Locked

布尔型

账户是否被锁定

Name

字符串

指定用户资源名称

Oem.Public.IPMIEnable

布尔型

IPMI扩展权限使能

Oem.Public.WebEnable

布尔型

Web扩展权限使能

RoleId

字符串

角色资源ID：

Administrator、Operator、User、None

自定义1，默认CustomRole1

自定义2，默认CustomRole2

自定义3，默认CustomRole3

自定义4，默认CustomRole4

自定义5，默认CustomRole5

UserName

字符串

用户名

Password

null

GET时返回null

Oem.Public.SnmpV3Enable

布尔型

SnmpV3扩展权限使能

Oem.Public.SnmpEncryptPwdInit

布尔型

是否单独配置独立密码

注：true表示单独配置独立密码

false表示独立密码未单独配置

Oem.Public.SnmpV3Password

字符串

SnmpV3独立密码

注：该字段固定显示null

Oem.Public.SnmpV3AccessPermission

字符串

SnmpV3读写权限：

read_only

read_write

注：Oem.Public.SnmpV3Enable为false时，该字段默认返回read_only

Oem.Public.SnmpV3AuthProtocol

字符串

SnmpV3鉴权算法：

SHA

MD5

SHA256

SHA384

SHA512

注：Oem.Public.SnmpV3Enable为false时，该字段默认返回SHA

Oem.Public.SnmpV3PrivProtocol

字符串

SnmpV3加密算法：

DES

AES

AES192

AES256

注：Oem.Public.SnmpV3Enable为false时，该字段默认返回DES

Oem.Public.DefaultPasswordModifyPolicy

字符串

默认密码修改策略

NotModify：不修改

ForcedModify：强制修改

Optional：可选弹框

 

【修改记录】

(1)     HDM2-2.04：新增Oem.Public.DefaultPasswordModifyPolicy字段；

 

4.5.5  添加用户信息

【功能描述】

添加用户信息。

【所属权限模块】

用户配置

【所属系统锁定类型】

BMC配置锁定

【命令格式】

POST https://device_ip/redfish/v1/AccountService/Accounts

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"Enabled": true,

 "Password": password,

 "UserName": name,

"Id": userid,

"RoleId": role,

 "Locked": false,

    "Oem": {

        "Public": {

          "RSAEncryptionEnabled": true,

"IPMIEnable": true,

            "WebEnable": true,

            "SnmpV3Enable": true,

            "SnmpV3AccessPermission": "read_only",

            "SnmpV3AuthProtocol": "SHA",

            "SnmpV3PrivProtocol": "DES",

            "SnmpV3Password": snmpv3password,

"DefaultPasswordModifyPolicy":"NotModify"

        }

 }

 }

【参数说明】

表4-398 添加用户信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

Enabled

布尔型

用户账户是否启用

UserName

字符串

用户名

注：用户名最长可设32位

Id

字符串

用户序号

可选参数，取值范围：1-16

不能和已存在用户的Id重复

RSAEncryptionEnabled

布尔型

用户是否支持RSA加密，仅限Web页面设置密码时使用

Password

字符串

用户密码

注：密码最长40位

RoleId

字符串

角色资源ID：

Administrator、Operator、User、None

自定义1，默认CustomRole1

自定义2，默认CustomRole2

自定义3，默认CustomRole3

自定义4，默认CustomRole4

自定义5，默认CustomRole5

Locked

布尔型

账户是否被锁定。目前仅支持false

Oem.Public.IPMIEnable

布尔型

IPMI扩展权限使能

注：RoleId为Administrator或Operator时，该字段只能下发true

Oem.Public.WebEnable

布尔型

Web扩展权限使能

注：RoleId为Administrator或Operator时，该字段只能下发true

Oem.Public.SnmpV3Enable

布尔型

SnmpV3扩展权限使能

Oem.Public.SnmpV3AccessPermission

字符串

SnmpV3读写权限：

read_only

read_write

Oem.Public.SnmpV3Password

字符串

SnmpV3独立密码

注：独立密码最长为40位

Oem.Public.SnmpV3AuthProtocol

字符串

SnmpV3鉴权算法：

SHA

MD5

SHA256

SHA384

SHA512

Oem.Public.SnmpV3PrivProtocol

字符串

SnmpV3加密算法：

DES

AES

AES192

AES256

注：加密算法AES192和AES256只能与鉴权算法SHA256、SHA384或SHA512搭配使用

Oem.Public.DefaultPasswordModifyPolicy

字符串

默认密码修改策略

NotModify：不修改

ForcedModify：强制修改

Optional：可选弹框

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/AccountService/Accounts

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

 "Enabled": true,

 "Password": "test@test123",

 "UserName": "User123",

 "Id":"3",

 "RoleId": "Administrator",

 "Locked": false,

    "Oem": {

        "Public": {

"IPMIEnable": true,

            "WebEnable": true,

            "SnmpV3Enable": false,

            "SnmpV3AccessPermission": "read_only",

            "SnmpV3AuthProtocol": "SHA",

            "SnmpV3PrivProtocol": "DES"

           }

      }

}

【响应样例】

{

    "@odata.context": "/redfish/v1/$metadata#ManagerAccount.ManagerAccount",

    "@odata.id": "/redfish/v1/AccountService/Accounts/2",

    "@odata.type": "#ManagerAccount.v1_6_0.ManagerAccount",

    "Description": "Default Account",

    "Enabled": true,

    "Id": "3",

    "Links": {

        "Roles": {

            "@odata.id": "/redfish/v1/AccountService/Roles/Administrator"

        }

    },

    "Locked": false,

    "Name": "Default Account",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success",

            "IPMIEnable": true,

            "SnmpEncryptPwdInit": false,

            "SnmpV3AccessPermission": "read_only",

            "SnmpV3AuthProtocol": "SHA",

            "SnmpV3Enable": false,

            "SnmpV3Password": null,

            "SnmpV3PrivProtocol": "DES",

            "WebEnable": true,

"DefaultPasswordModifyPolicy":"NotModify"

        }

    },

    "Password": null,

    "RoleId": "Administrator",

    "UserName": "User123"

}

响应码：201

【输出说明】

返回状态码201，表示创建成功。

返回字段说明同【查询指定用户信息】

【修改记录】

(1)     HDM2-1.14：输出说明删除表格，改为“返回字段说明同【查询指定用户信息】”

(2)     HDM2-1.18：字段Id改为可选参数

(3)     HDM2-1.19：SNMPV3独立密码删除限制字符的描述

(4)     HDM2-1.53：添加所属系统锁定类型；

(5)     HDM2-2.02：参数UserName可设最长长度从16位改为32位；

(6)     HDM2-2.04：新增Oem.Public.DefaultPasswordModifyPolicy字段；

 

4.5.6  修改用户信息

【功能描述】

修改指定用户信息。非admin用户只能修改自身密码，修改其它字段不生效。

【所属权限模块】

用户配置|配置自身

【所属系统锁定类型】

BMC配置锁定（除用户配置自身时）

【命令格式】

PATCH https://device_ip/redfish/v1/AccountService/Accounts/userid

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:ifmatch_value

【请求消息体】

{

 "Enabled": true,

 "Password": password,

 "UserName": name,

 "RoleId": role,

 "Locked": false,

"Oem": {

        "Public": {

"RSAEncryptionEnabled": true,

"IPMIEnable": true,

            "WebEnable": true,

            "SnmpV3Enable": true,

            "SnmpV3AccessPermission": "read_only",

            "SnmpV3Password": snmpv3password,

            "SnmpV3AuthProtocol": "SHA",

            "SnmpV3PrivProtocol": "DES",

"DefaultPasswordModifyPolicy":"NotModify"

        }

 }

}

【参数说明】

表4-399 修改用户信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或Ipv6

userid

修改用户的userid

用户的userid数值

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

ifmatch_value

请求消息的匹配参数

可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）

Enabled

布尔型

用户账户是否启用

UserName

字符串

用户名,

注：用户名最长32位

RSAEncryptionEnabled

布尔型

是否支持RSA加密，仅限Web页面修改密码时使用

Password

字符串

用户密码

注：密码最长40位

RoleId

字符串

角色资源ID：

Administrator、Operator、User、None

自定义1，默认CustomRole1

自定义2，默认CustomRole2

自定义3，默认CustomRole3

自定义4，默认CustomRole4

自定义5，默认CustomRole5

Locked

布尔型

账户是否被锁定。目前仅支持false

Oem.Public.IPMIEnable

布尔型

IPMI扩展权限使能

Oem.Public.WebEnable

布尔型

Web扩展权限使能

Oem.Public.SnmpV3Enable

布尔型

SnmpV3扩展权限使能

Oem.Public.SnmpV3AccessPermission

字符串

SnmpV3读写权限：

read_only

read_write

Oem.Public.SnmpV3Password

字符串

SnmpV3独立密码

注：独立密码最长为40位

Oem.Public.SnmpV3AuthProtocol

字符串

SnmpV3鉴权算法：

SHA

MD5

SHA256

SHA384

SHA512

Oem.Public.SnmpV3PrivProtocol

字符串

SnmpV3加密算法：

DES

AES

AES192

AES256

注：加密算法AES192和AES256只能与鉴权算法SHA256、SHA384或SHA512搭配使用

Oem.Public.DefaultPasswordModifyPolicy

字符串

默认密码修改策略

NotModify：不修改

ForcedModify：强制修改

Optional：可选弹框

 

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/AccountService/Accounts/3

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

 "Enabled": true,

 "Password": "test@test123",

     "RoleId": "User",

"UserName": "User123",

 "Locked": false,

    "Oem": {

        "Public": {

"IPMIEnable": true,

            "WebEnable": true,

            "SnmpV3Enable": true,

            "SnmpV3AccessPermission": "read_only",

            "SnmpV3Password": "Password@_",

            "SnmpV3AuthProtocol": "SHA",

            "SnmpV3PrivProtocol": "DES"

          }

     }

}

【响应样例】

{

    "@odata.context": "/redfish/v1/$metadata#ManagerAccount.ManagerAccount",

    "@odata.id": "/redfish/v1/AccountService/Accounts/1",

    "@odata.type": "#ManagerAccount.v1_6_0.ManagerAccount",

    "Description": "Default Account",

    "Enabled": true,

    "Id": "3",

    "Links": {

        "Roles": {

            "@odata.id": "/redfish/v1/AccountService/Accounts/1"

        }

    },

    "Locked": false,

    "Name": "Default Account",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success",

            "IPMIEnable": true,

            "SnmpEncryptPwdInit": true,

            "SnmpV3AccessPermission": "read_only",

            "SnmpV3AuthProtocol": "SHA",

            "SnmpV3Enable": true,

            "SnmpV3Password": null,

            "SnmpV3PrivProtocol": "DES",

            "WebEnable": true,

"DefaultPasswordModifyPolicy":"NotModify"

        }

    },

    "Password": null,

    "RoleId": "User",

"UserName": "User123"

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回字段说明同【查询指定用户信息】

【修改记录】

(1)     HDM2-1.19：SNMPV3独立密码删除限制字符的描述

(2)     HDM2-1.53：添加所属系统锁定类型；

(3)     HDM2-2.02：参数UserName可设最长长度从16位改为32位；

(4)     HDM2-2.04：新增Oem.Public.DefaultPasswordModifyPolicy字段；

 

4.5.7  删除用户信息

【功能描述】

删除用户信息。

【所属权限模块】

用户配置

【所属系统锁定类型】

BMC配置锁定

【命令格式】

DELETE https://device_ip/redfish/v1/AccountService/Accounts/id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-400 删除用户信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【使用实例】

【请求样例】

DELETE https://192.168.18.18/redfish/v1/AccountService/Accounts/3

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【响应样例】

{

"Oem": {

       "Public": {

           "CompletionCode": 0,

           "Description": "Success"

       }

 },

"error": {

       "@Message.ExtendedInfo": [

           {

               "@odata.type": "#Message.v1_1_1.Message",

               "Message": "The account was successfully removed.",

               "MessageArgs": [],

               "MessageId": "Base.1.8.1.AccountRemoved",

               "MessageSeverity": "OK",

               "Resolution": "No resolution is required."

           }

       ],

        "code":"Base.1.8.1.AccountRemoved",

        "message":"The account was successfully removed."

    }

}

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-401 删除用户信息输出参数说明

字段

类型

字段说明

code

字符串

指示消息注册表中特定消息ID的字符串

message

字符串

与消息注册表中的消息对应的易读的错误消息

@Message.ExtendedInfo

消息扩展信息

@odata.type

字符串

消息资源的OData描述信息

MessageId

字符串

消息ID

Message

字符串

详细信息

MessageArgs

数组

信息参数

MessageSeverity

字符串

严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical

Resolution

字符串

解决建议

 

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

(2)     HDM2-2.04：Message.ExtendedInfo前添加error节点，并且在error节点下增加code和message字段；

 

4.5.8  查询角色集合资源信息

【功能描述】

查询角色集合资源信息。非admin用户只能查询自身。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/AccountService/Roles

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-402 查询角色集合资源信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/AccountService/Roles

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【响应样例】

{

    "@odata.context": "/redfish/v1/$metadata#RoleCollection.RoleCollection",

    "@odata.id": "/redfish/v1/AccountService/Roles",

    "@odata.type": "#RoleCollection.RoleCollection",

    "Members": [

        {

            "@odata.id": "/redfish/v1/AccountService/Roles/Administrator"

        },

        {

            "@odata.id": "/redfish/v1/AccountService/Roles/Operator"

        },

        {

            "@odata.id": "/redfish/v1/AccountService/Roles/User"

        },

        {

            "@odata.id": "/redfish/v1/AccountService/Roles/CustomRole1"

        },

        {

            "@odata.id": "/redfish/v1/AccountService/Roles/CustomRole2"

        },

        {

            "@odata.id": "/redfish/v1/AccountService/Roles/CustomRole3"

        },

        {

            "@odata.id": "/redfish/v1/AccountService/Roles/CustomRole4"

        },

        {

            "@odata.id": "/redfish/v1/AccountService/Roles/CustomRole5"

        },

        {

            "@odata.id": "/redfish/v1/AccountService/Roles/None"

        }

    ],

    "[email protected]": 9,

"Name": "Roles Collection",

"Oem": {

    "Public": {

      "CompletionCode": 0,

      "Description": "Success"

  }

}

}

 

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-403 查询角色集合资源信息返回值

字段

类型

字段说明

@odata.context

字符串

角色列表资源模型的 OData 描述信息

@odata.id        

字符串

角色列表资源节点的访问路径

@odata.type

字符串

角色列表资源类型

Members

数组

角色资源列表：Operator, Administrator, User, None, CustomRole1~5或自定义名称

[email protected]

数值

服务器当前存在的角色类型的个数

 

4.5.9  查询指定角色信息

【功能描述】

查询指定角色信息。非admin用户只能查询自身。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/AccountService/Roles/role_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-404 查询指定角色资源信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

role_id

角色ID

由查询角色集合资源信息获取

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/AccountService/Roles/Operator

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【响应样例】

{

    "@odata.context": "/redfish/v1/$metadata#Role.Role(*)",

    "@odata.id": "/redfish/v1/AccountService/Roles/Operator",

    "@odata.type": "#Role.v1_3_0.Role",

    "AssignedPrivileges": [

        "ConfigureComponents",

        "Login",

        "ConfigureSelf"

    ],

    "Description": "Operator User Role",

    "Id": "Operator",

    "IsPredefined": true,

    "Name": "User Role",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "OemPrivileges": [

        "OemKvm",

        "OemVmm",

        "OemSecurityMgmt",

        "OemPowerControl",

        "OemSystemAudit"

    ]

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-405 查询指定角色信息返回值

字段

类型

字段说明

@odata.context

字符串

指定角色资源模型的OData 描述信息

@odata.id

字符串

指定角色资源的访问路径

@odata.type

字符串

指定角色资源的类型

AssignedPrivileges

数组

指定权限

"ConfigureUsers"：用户配置

"ConfigureComponents"：常规配置

"Login"：查询权限

"ConfigureSelf"：配置自身

Description

字符串

指定角色资源描述信息

Id

字符串

角色组ID名

IsPredefined

布尔型

是否预设启用

Name

字符串

指定角色资源名称

OemPrivileges

数组

服务器自定义的权限，若没有，则显示[]

"OemKvm"：远程控制

"OemVmm"：远程媒体

"OemSecurityMgmt"：安全配置

"OemPowerControl"：电源控制

"OemDiagnosis"：维护诊断

"OemSystemAudit"：系统审计

 

4.5.10  修改指定角色信息

【功能描述】

修改指定角色信息。

【所属权限模块】

用户配置

【所属系统锁定类型】

BMC配置锁定

【命令格式】

PATCH https://device_ip/redfish/v1/AccountService/Roles/role_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:ifmatch_value

【请求消息体】

{

    "AssignedPrivileges": [

        "ConfigureComponents",

        "ConfigureSelf"

    ],

    "OemPrivileges": [

        "OemKvm",

        "OemVmm",

        "OemSecurityMgmt",

        "OemPowerControl",

        "OemDiagnosis",

        "OemSystemAudit"

    ]

}

【参数说明】

表4-406 修改用户信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或Ipv6

role_id

角色ID

由查询角色集合资源信息获取

说明：只能修改role_id为自定义角色组权限

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

ifmatch_value

请求消息的匹配参数

可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）

AssignedPrivileges

数组

ConfigureSelf： 配置自身

ConfigureComponents：常规配置

OemPrivileges.OemKvm

数组

OemKvm：远程控制

OemVmm：远程媒体

OemSecurityMgmt：安全配置

OemPowerControl：电源控制

OemDiagnosis：维护诊断

OemSystemAudit：系统审计

 

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/AccountService/Roles/CustomRole1

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

    "AssignedPrivileges": [

        "ConfigureComponents",

        "ConfigureSelf"

    ],

    "OemPrivileges": [

        "OemKvm",

        "OemVmm",

        "OemSecurityMgmt",

        "OemPowerControl",

        "OemDiagnosis",

        "OemSystemAudit"

    ]

}

【响应样例】

{

    "@odata.context": "/redfish/v1/$metadata#Role.Role(*)",

    "@odata.id": "/redfish/v1/AccountService/Roles/CustomRole1",

    "@odata.type": "#Role.v1_3_0.Role",

    "AssignedPrivileges": [

        "ConfigureComponents",

        "Login",

        "ConfigureSelf"

    ],

    "Description": "CustomRole1 User Role",

    "Id": "CustomRole1",

    "IsPredefined": true,

    "Name": "User Role",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "OemPrivileges": [

        "OemKvm",

        "OemVmm",

        "OemSecurityMgmt",

        "OemPowerControl",

        "OemDiagnosis",

        "OemSystemAudit"

    ]

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回字段说明同【查询指定角色信息】

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

 

4.5.11  查询角色名称

【功能描述】

查询角色名称。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/AccountService/Roles/Oem/Public/RoleNames

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-407 查询角色组名称资源信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/AccountService/Roles/Oem/Public/RoleNames

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#RoleNames.RoleNames",

    "@odata.id": "/redfish/v1/AccountService/Roles/Oem/Public/RoleNames",

    "@odata.type": "#RoleNames.v1_0_0.RoleNames",

    "Administrator": "Administrator",

    "CustomRole1Name": "CustomRole1",

    "CustomRole2Name": "CustomRole2",

    "CustomRole3Name": "CustomRole3",

    "CustomRole4Name": "CustomRole4",

"CustomRole5Name": "CustomRole5",

"Oem": {

    "Public": {

      "CompletionCode": 0,

      "Description": "Success"

    }

  },

    "Operator": "Operator",

    "User": "User"

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-408 查询角色名称输出参数说明

字段

类型

字段说明

@odata.context

字符串

指定角色资源模型的OData 描述信息

@odata.id

字符串

指定角色资源的访问路径

@odata.type

字符串

指定角色资源的类型

CustomRole1Name

字符串

自定义角色1（长度为1～16个字符，仅支持字母、数字、句点（.）、连接符（-）和下划线（_）和特殊字符（@），区分大小写）

CustomRole2Name

字符串

自定义角色2（长度为1～16个字符，仅支持字母、数字、句点（.）、连接符（-）和下划线（_）和特殊字符（@），区分大小写）

CustomRole3Name

字符串

自定义角色3（长度为1～16个字符，仅支持字母、数字、句点（.）、连接符（-）和下划线（_）和特殊字符（@），区分大小写）

CustomRole4Name

字符串

自定义角色4（长度为1～16个字符，仅支持字母、数字、句点（.）、连接符（-）和下划线（_）和特殊字符（@），区分大小写）

CustomRole5Name

字符串

自定义角色5（长度为1～16个字符，仅支持字母、数字、句点（.）、连接符（-）和下划线（_）和特殊字符（@），区分大小写）

Administrator

字符串

Administrator

Operator

字符串

Operator

User

字符串

User

 

4.5.12  修改角色名称

【功能描述】

修改指定角色名称。

【所属权限模块】

用户配置

【所属系统锁定类型】

BMC配置锁定

【命令格式】

PATCH https://device_ip/redfish/v1/AccountService/Roles/Oem/Public/RoleNames

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:ifmatch_value

【请求消息体】

{

"CustomRole1Name": "CustomRole1name",

"CustomRole2Name": "CustomRole2name",

"CustomRole3Name": "CustomRole3name",

"CustomRole4Name": "CustomRole4name",

"CustomRole5Name": "CustomRole5name"

}

【参数说明】

表4-409 修改角色组名称参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或Ipv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

ifmatch_value

请求消息的匹配参数

可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）

CustomRole1Name

字符串

自定义角色1（长度为1～16个字符，仅支持字母、数字、句点（.）、连接符（-）和下划线（_）和特殊字符（@），区分大小写）

CustomRole2Name

字符串

自定义角色2（长度为1～16个字符，仅支持字母、数字、句点（.）、连接符（-）和下划线（_）和特殊字符（@），区分大小写）

CustomRole3Name

字符串

自定义角色3（长度为1～16个字符，仅支持字母、数字、句点（.）、连接符（-）和下划线（_）和特殊字符（@），区分大小写）

CustomRole4Name

字符串

自定义角色4（长度为1～16个字符，仅支持字母、数字、句点（.）、连接符（-）和下划线（_）和特殊字符（@），区分大小写）

CustomRole5Name

字符串

自定义角色5（长度为1～16个字符，仅支持字母、数字、句点（.）、连接符（-）和下划线（_）和特殊字符（@），区分大小写）

 

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/AccountService/Roles/Oem/Public/RoleNames

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

    "CustomRole1Name": "abc",

    "CustomRole2Name": "123",

    "CustomRole3Name": "zxc",

    "CustomRole4Name": "h3c",

    "CustomRole5Name": "vbn"

}

【响应样例】

{

    "@odata.context": "/redfish/v1/$metadata#RoleNames.RoleNames",

    "@odata.id": "/redfish/v1/AccountService/Roles/Oem/Public/RoleNames",

    "@odata.type": "#RoleNames.v1_0_0.RoleNames",

    "Administrator": "Administrator",

    "CustomRole1Name": "abc",

    "CustomRole2Name": "123",

    "CustomRole3Name": "zxc",

    "CustomRole4Name": "h3c",

    "CustomRole5Name": "vbn",

"Oem": {

    "Public": {

      "CompletionCode": 0,

      "Description": "Success"

    }

  },

    "Operator": "Operator",

    "User": "User"

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回字段说明同【查询角色名称】

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

 

4.5.13  查询LDAP服务资源

【功能描述】

查询LDAP服务资源。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/AccountService/LDAPService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-410 查询 LDAP 服务资源参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/AccountService/LDAPService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【响应样例】

{

"@odata.context": "/redfish/v1/$metadata#AccountService/LDAPService",

  "@odata.id": "/redfish/v1/AccountService/LDAPService",

  "@odata.type": "#LDAPService.v1_0_0.LDAPService",

  "BindDN": "",

  "BindPassword": null,

  "CertificateName":"",

  "CertificateVerificationEnabled": false,

  "CertificateVerificationLevel":"Demand",

  "CommonNameType": "IP",

  "Id": "LDAPService",

  "LDAPControllers": {

    "@odata.id": "/redfish/v1/AccountService/LDAPService/LDAPControllers"

  },

  "LDAPPort": 389,

  "LDAPServerAddress": "",

  "LDAPServiceEnabled": false,

  "Name": "LDAP Controller Collection",

  "Oem": {

    "Public": {

      "CompletionCode": 0,

      "Description": "Success"

    }

  },

  "SSLEncryptionEnabled": false,

  "UserDomain": "",

  "UserIdentification": "cn"

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-411 查询 LDAP 服务资源输出参数说明

字段

类型

字段说明

@odata.context

字符串

LDAP服务资源的OData 描述信息

@odata.id

字符串

LDAP服务资源的访问路径

@odata.type

字符串

LDAP服务资源的类型

LDAPServiceEnabled

布尔

使能状态

LDAPControllers

对象

域控制器集合：

@odata.id：域控制器集合路径

CommonNameType

字符串

通用名称类型;

当前仅支持"IP"，"FQDN"

LDAPServerAddress

字符串

服务器地址

LDAPPort

数值

端口号

BindDN

字符串

LDAP代理用户标识名

注：该字段允许下发的最大长度为255位

BindPassword

字符串

LDAP代理用户的认证密码；

注：密码最大长度为48位

SSLEncryptionEnabled

布尔

加密类型；

false表示无加密，true表示SSL加密

UserDomain

字符串

域控制器的用户域

注：用户域最大长度为255位

UserIdentification

字符串

用户登录属性；

当前仅支持"cn"，"uid"

CertificateVerificationEnabled

布尔型

LDAP证书验证使能

CertificateVerificationLevel

字符串

LDAP证书校验级别

“Demand”：校验失败不允许登录

“Allow”：校验失败允许继续登录

CertificateName

字符串

LDAP证书名称

 

【修改记录】

(1)     HDM2-1.57：新增字段CertificateVerificationEnabled、CertificateVerificationLevel和CertificateName；

 

4.5.14  修改LDAP服务资源

【功能描述】

修改LDAP服务资源。

【所属权限模块】

用户配置

【所属系统锁定类型】

BMC配置锁定

【命令格式】

PATCH https://device_ip/redfish/v1/AccountService/LDAPService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:ifmatch_value

【请求消息体】

{

"LDAPServiceEnabled": true,

"SSLEncryptionEnabled": false,

"CommonNameType": "IP",

"LDAPServerAddress": "192.168.1.2",

"LDAPPort": 635,

"BindDN": "cn=Manager,dc=example,dc=com",

"BindPassword": "test123",

"UserDomain": "cn=Manager,dc=example,dc=com",

"UserIdentification": "cn",

"CertificateVerificationEnabled":true,

"CertificateVerificationLevel":"Allow",

"Oem":{

  "Public":{

    "RSAEncryptionEnabled": true

}

}

}

【参数说明】

表4-412 修改LDAP 服务资源资源信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

LDAPServiceEnabled

布尔型

功能开启状态

CommonNameType

字符串

通用名称类型

LDAPServerAddress

字符串

服务器地址

LDAPPort

数值

端口号

BindDN

字符串

LDAP代理用户标识名

BindPassword

字符串

LDAP代理用户的认证密码

SSLEncryptionEnabled

布尔型

加密类型；

false表示无加密，true表示SSL加密

UserDomain

字符串

域控制器的用户域

UserIdentification

字符串

用户登录属性

CertificateVerificationEnabled

布尔型

LDAP证书验证使能

CertificateVerificationLevel

字符串

LDAP证书校验级别

Oem.Public.RSAEncryptionEnabled

布尔型

是否支持RSA加密，仅限于Web页面设置密码时使用

 

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/AccountService/LDAPService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

"LDAPServiceEnabled": true

}

【响应样例】

{

"@odata.context": "/redfish/v1/$metadata#AccountService/LDAPService",

  "@odata.id": "/redfish/v1/AccountService/LDAPService",

  "@odata.type": "#LDAPService.v1_0_0.LDAPService",

  "BindDN": "",

  "BindPassword": null,

  "CertificateName":"",

  "CertificateVerificationEnabled": false,

  "CertificateVerificationLevel":"Demand",

  "CommonNameType": "IP",

  "Id": "LDAPService",

  "LDAPControllers": {

    "@odata.id": "/redfish/v1/AccountService/LDAPService/LDAPControllers"

  },

  "LDAPPort": 389,

  "LDAPServerAddress": "",

  "LDAPServiceEnabled": true,

  "Name": "LDAP Controller Collection",

  "Oem": {

    "Public": {

      "CompletionCode": 0,

      "Description": "Success"

    }

  },

  "SSLEncryptionEnabled": false,

  "UserDomain": "",

  "UserIdentification": "cn"

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回字段说明同【查询LDAP服务资源】

【修改记录】

(1)     HDM2-1.14：参数说明中删除多余的SSLEncryptionEnabled字段

(2)     HDM2-1.53：添加所属系统锁定类型；

(3)     HDM2-1.57：新增字段CertificateVerificationEnabled和CertificateVerificationLevel；

 

4.5.15  LDAP CA证书导入

【功能描述】

导入LDAP CA证书。

【所属权限模块】

用户配置

【命令格式】

POST https://device_ip/redfish/v1/AccountService/LDAPService/Actions/Oem/Public/LDAPService.ImportLDAPCertificate

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

本地导入

先通过【上传BMC文件】将文件传输到/tmp/web/目录下，再调用本接口

{

"Type":"URI", 

"Content": "/tmp/web/filename"

}

 

远程导入

cifs或sftp

{

   "Type":"URI",

"Content":"cifs://username:password@ip/filename"

}

http、tftp、nfs或https

{

   "Type":"URI",

"Content":"http://ip/filename"

}

【参数说明】

表4-413 导入LDAP CA证书文件参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6 

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

type

导入LDAP CA证书的方式

URI，表明value值是URI（本地或者远程）

Content

导入路径

见其它说明

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/AccountService/LDAPService/Actions/Oem/Public/LDAPService.ImportLDAPCertificate

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"Type":"URI",

"Content":"sftp://y17057:[email protected]/ldap.crt"

}

【响应样例】

{

  "@odata.context":"/redfish/v1/$metadata#TaskCollection.TaskCollection",

  "@odata.type": "#TaskCollection.TaskCollection",

  "Members": [

    {

      "@odata.id":"/redfish/v1/TaskService/Tasks/2"

    }

  ],

  "[email protected]": 1,

  "Name": "Task Collection",

  "Oem": {

    "Public": {

      "CompletionCode": 0,

      "Description": "Success"

    }

  }

}

响应码：202

【输出说明】

返回状态码202，表示操作成功。

表4-414 导入LDAP CA证书文件输出参数说明

字段

类型

字段说明

@odata.context

字符串

导入LDAP CA证书文件TaskService的OData 描述信息

@odata.type

字符串

导入LDAP CA证书文件TaskService的类型

@odata.id

字符串

导入LDAP CA证书文件TaskService的访问路径

[email protected]

字符串

导入LDAP CA证书文件生成的Task链接

[email protected]

数值

导入LDAP CA证书文件生成的Task链接个数

Name

字符串

导入LDAP CA证书文件TaskService的名称

 

【修改记录】

(1)     HDM2-57：新增接口；

 

4.5.16  查询LDAP域控制器集合资源

【功能描述】

查询LDAP域控制器集合资源。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/AccountService/LDAPService/LDAPControllers

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-415 查询 LDAP 域控制器集合资源信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/AccountService/LDAPService/LDAPControllers

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【响应样例】

{

"@odata.context": "/redfish/v1/$metadata#AccountService/LDAPService/LDAPControllers/$entity",

  "@odata.id": "/redfish/v1/AccountService/LDAPService/LDAPControllers",

  "@odata.type": "#LDAPControllersCollection.LDAPControllersCollection",

  "Members": [

    {

      "@odata.id": "/redfish/v1/AccountService/LDAPService/LDAPControllers/1"

}

……

  ],

  "[email protected]": 3,

  "Name": "LDAP Controller Collection",

  "Oem": {

    "Public": {

      "CompletionCode": 0,

      "Description": "Success"

    }

  }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-416 查询LDAP域控制器集合资源输出参数说明

字段

类型

字段说明

@odata.context

字符串

LDAP域控制器集合资源的OData 描述信息

@odata.id

字符串

LDAP域控制器集合资源的访问路径

@odata.type

字符串

LDAP域控制器集合资源的类型

Name

字符串

LDAP域控制器资源的名称

Members

数组

LDAP域控制器资源列表

[email protected]

数值

LDAP域控制器数量

 

4.5.17  查询指定LDAP域用户集合资源

【功能描述】

查询指定LDAP域用户集合资源。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/AccountService/LDAPService/LDAPControllers/controllers_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-417 查询指定LDAP 域用户集合资源参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

controllers_id

LDAP控制器ID

当前只支持1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/AccountService/LDAPService/LDAPControllers/1

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【响应样例】

{

"@odata.context": "/redfish/v1/$metadata#AccountService/LDAPService/LDAPControllers/1/$entity",

  "@odata.id": "/redfish/v1/AccountService/LDAPService/LDAPControllers/1",

  "@odata.type": "#LdapGroupsCollection.LdapGroupsCollection",

  "Id": "1",

  "Members": [

    {

      "@odata.id": "/redfish/v1/AccountService/LDAPService/LDAPControllers/1/1"

    }

  ],

  "[email protected]": 1,

  "Name": "LDAP Groups Collection",

  "Oem": {

    "Public": {

      "CompletionCode": 0,

      "Description": "Success"

    }

  }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-418 查询LDAP 域用户集合资源输出参数说明

字段

类型

字段说明

@odata.context

字符串

指定LDAP域用户集合资源的OData 描述信息

@odata.id

字符串

指定LDAP域用户集合资源的访问路径

@odata.type

字符串

指定LDAP域用户集合资源的类型

Members

对象

LDAP 域用户组

[email protected]

字符串

LDAP域用户数量

 

4.5.18  查询指定LDAP域的单个用户资源

【功能描述】

查询指定LDAP域的单个用户资源。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/AccountService/LDAPService/LDAPControllers/controllers_id/user_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-419 查询LDAP域的单个用户资源参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

controllers_id

LDAP控制器ID

当前仅支持1

user_id

用户编号

从查询指定 LDAP 域用户集合资源中获取

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/AccountService/LDAPService/LDAPControllers/1/3

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【响应样例】

{

"@odata.context": "/redfish/v1/$metadata#AccountService/LDAPService/LDAPControllers/1/1$entity",

  "@odata.id": "/redfish/v1/AccountService/LDAPService/LDAPControllers/1/3",

  "@odata.type": "#LDAPControllers.v1_0_0.LDAPControllers",

  "Description": "LDAP Group Instance",

  "GroupName": "test",

  "GroupRole": "Administrator",

  "Id": "3",

"Name":"LDAPGroupInstance",

  "Oem": {

    "Public": {

      "CompletionCode": 0,

      "Description": "Success"

    }

  },

  "RoleGroupDomain": "cn=Manager,dc=example" 

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-420 查询LDAP域的单个用户资源输出参数说明

字段

类型

字段说明

@odata.context

字符串

指定LDAP域的单个用户资源的OData 描述信息

@odata.id

字符串

指定LDAP域的单个用户资源的访问路径

@odata.type

字符串

指定LDAP域的单个用户资源的类型

Name

字符串

指定LDAP域的单个用户资源的名称

Description

字符串

指定LDAP域用户信息描述

GroupName

字符串

用户组组名

RoleGroupDomain

字符串

用户组组域

GroupRole

字符串

用户组角色

Id

字符串

域用户组编号

 

【修改记录】

(1)     HDM2-1.15：新增字段“Name”；

(2)     HDM2-1.15：修改字段“MemberId”为“Id”；

 

4.5.19  添加指定 LDAP 域用户组

【功能描述】

添加指定LDAP域用户组。

【所属权限模块】

用户配置

【所属系统锁定类型】

BMC配置锁定

【命令格式】

POST https://device_ip/redfish/v1/AccountService/LDAPService/LDAPControllers/controllers_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"Id": "3",

"GroupName": "test",

"RoleGroupDomain": "cn=Manager,dc=example",

"GroupRole": "Administrator"

}

【参数说明】

表4-421 添加指定LDAP域用户组参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

controllers_id

LDAP控制器ID

当前只支持1

Id

字符串

用户组Id

GroupName

字符串

用户组组名；

注：该字段最大长度为255位

RoleGroupDomain

字符串

用户组组域；

注：该字段最大长度为255位

GroupRole

字符串

用户组角色；

注：该字段最大长度为64位

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/AccountService/LDAPService/LDAPControllers/1

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"Id": "1",

"GroupName": "test",

"RoleGroupDomain": "cn=Manager,dc=example",

"GroupRole": "Administrator"

}

【响应样例】

{

"@odata.context": "/redfish/v1/$metadata#AccountService/LDAPService/LDAPControllers/1/1$entity",

  "@odata.id": "/redfish/v1/AccountService/LDAPService/LDAPControllers/1/1",

  "@odata.type": "#LDAPControllers.v1_0_0.LDAPControllers",

  "Description": "LDAP Group Instance",

  "GroupName": "test",

  "GroupRole": "Administrator",

  "Id": "1",

"Name":"LDAPGroupInstance",

  "Oem": {

    "Public": {

      "CompletionCode": 0,

      "Description": "Success"

    }

  },

  "RoleGroupDomain": "cn=Manager,dc=example" 

}

响应码：201

【输出说明】

返回状态码201，表示操作成功。

返回字段说明同【查询查询指定LDAP单个用户资源】

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

 

4.5.20  修改指定 LDAP 域用户组资源

【功能描述】

修改指定LDAP域用户组资源。

【所属权限模块】

用户配置

【所属系统锁定类型】

BMC配置锁定

【命令格式】

PATCH https://device_ip/redfish/v1/AccountService/LDAPService/LDAPControllers/controllers_id/user_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:ifmatch_value

【请求消息体】

{

"GroupName": "test",

"RoleGroupDomain": "cn=Manager,dc=example",

"GroupRole": "Operator"

}

【参数说明】

表4-422 修改LDAP域用户组信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

controllers_id

LDAP控制器ID

当前只支持1

user_id

数值

待修改的LDAP域用户组ID

GroupName

字符串

用户组组名；

注：该字段最大长度为255位

RoleGroupDomain

字符串

用户组组域；

注：该字段最大长度为255位

GroupRole

字符串

用户组角色；

注：该字段最大长度为64位

 

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/AccountService/LDAPService/LDAPControllers/1/1

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

"GroupName": "test",

"RoleGroupDomain": "cn=Manager,dc=example",

"GroupRole": "Administrator"

}

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#AccountService/LDAPService/LDAPControllers/1/1$entity",

  "@odata.id": "/redfish/v1/AccountService/LDAPService/LDAPControllers/1/1",

  "@odata.type": "#LDAPControllers.v1_0_0.LDAPControllers",

  "Description": "LDAP Group Instance",

  "GroupName": "test",

  "GroupRole": "Administrator",

  "Id": "1",

"Name":"LDAPGroupInstance",

  "Oem": {

    "Public": {

      "CompletionCode": 0,

      "Description": "Success"

    }

  },

  "RoleGroupDomain": "cn=Manager,dc=example" 

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回字段说明同【查询查询指定LDAP单个用户资源】

【修改记录】

(1)     HDM2-1.14：参数说明中“待修改的LDAP域用户ID”改为“待修改的LDAP域用户组ID”

(2)     HDM2-1.53：添加所属系统锁定类型；

 

4.5.21  删除指定LDAP域用户组资源

【功能描述】

删除指定 LDAP 域用户组资源。

【所属权限模块】

用户配置

【所属系统锁定类型】

BMC配置锁定

【命令格式】

DELETE https://device_ip/redfish/v1/AccountService/LDAPService/LDAPControllers/controllers_id/user_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-423 删除指定LDAP域用户组参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

controllers_id

LDAP控制器ID

当前只支持1

user_id

数值

待删除LDAP域用户组的ID

 

【使用实例】

【请求样例】

DELETE https://192.168.18.18/redfish/v1/AccountService/LDAPService/LDAPControllers/1/1

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【响应样例】

{

"Oem": {

       "Public": {

           "CompletionCode": 0,

           "Description": "Success"

       }

 },

"error": {

       "@Message.ExtendedInfo": [

           {

               "@odata.type": "#Message.v1_1_1.Message",

               "Message": "The account was successfully removed.",

               "MessageArgs": [],

               "MessageId": "Base.1.8.1.AccountRemoved",

               "MessageSeverity": "OK",

               "Resolution": "No resolution is required."

           }

       ],

        "code":"Base.1.8.1.AccountRemoved",

        "message":"The account was successfully removed."

    }

}

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-424 删除指定LDAP域用户组资源输出参数说明

字段

类型

字段说明

code

字符串

指示消息注册表中特定消息ID的字符串

message

字符串

与消息注册表中的消息对应的易读的错误消息

@Message.ExtendedInfo

消息扩展信息

@odata.type

字符串

消息资源的OData描述信息

MessageId

字符串

消息ID

Message

字符串

详细信息

MessageArgs

数组

信息参数

MessageSeverity

字符串

严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical

Resolution

字符串

解决建议

 

【修改记录】

(1)     HDM2-1.14：参数说明中“待删除的LDAP域用户ID”改为“待删除的LDAP域用户组ID”

(2)     HDM2-1.53：添加所属系统锁定类型；

(3)     HDM2-2.04：Message.ExtendedInfo前添加error节点，并且在error节点下增加code和message字段；

 

4.5.22  查询AD服务资源

【功能描述】

查询 AD资源。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/AccountService/ADService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-425 查询AD服务资源参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/AccountService/ADService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#AccountService/ADService",

  "@odata.id": "/redfish/v1/AccountService/ADService",

  "@odata.type": "#ADService.v1_0_0.ADService",

  "ADControllers": {

    "@odata.id": "/redfish/v1/AccountService/ADService/ADControllers"

  },

  "ADServiceEnabled": false,

  "DomainControllerAddress1": "",

  "DomainControllerAddress2": "",

  "DomainControllerAddress3": "",

  "Id": "ADService",

  "Name": "AD Controller Collection",

  "Oem": {

    "Public": {

      "CompletionCode": 0,

      "Description": "Success"

    }

  },

  "Password": null,

  "UserDomain": "",

  "UserName": ""

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-426 查询AD服务资源输出参数说明

字段

类型

字段说明

@odata.context

字符串

AD服务资源的OData 描述信息

@odata.id

字符串

AD服务资源的访问路径

@odata.type

字符串

AD服务资源的类型

ADServiceEnabled

布尔

使能状态

UserName

字符串

机密用户名

注：最大长度为64位

Password

字符串

机密用户密码

注：最大长度为96位

UserDomain

字符串

用户域名

注：最大长度为255位

DomainControllerAddress1

字符串

AD域控制服务器地址1

DomainControllerAddress2

字符串

AD域控制服务器地址2

DomainControllerAddress3

字符串

AD域控制服务器地址3

ADControllers

对象

AD域控制器集合：

@odata.id：域控制器集合路径

 

4.5.23  修改AD 服务资源

【功能描述】

修改AD服务资源。

【所属权限模块】

用户配置

【所属系统锁定类型】

BMC配置锁定

【命令格式】

PATCH https://device_ip/redfish/v1/AccountService/ADService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:ifmatch_value

【请求消息体】

{

"ADServiceEnabled": false,

"UserName": "test",

"Password": "PassWord@_",

"UserDomain": "cn=Manager,dc=example,dc=com",

"DomainControllerAddress1": "192.168.1.2",

"DomainControllerAddress2": "192.168.1.3",

"DomainControllerAddress3": "192.168.1.4",

"Oem":{

  "Public":{

    "RSAEncryptionEnabled": true

}

}

}

【参数说明】

表4-427 修改AD服务资源参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/AccountService/ADService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

"ADServiceEnabled": false,

"UserName": "test",

"Password": "PassWord@_",

"UserDomain": "cn=Manager,dc=example,dc=com",

"DomainControllerAddress1": "192.168.1.2",

"DomainControllerAddress2": "192.168.1.3",

"DomainControllerAddress3": "192.168.1.4"

}

【响应样例】

{

"@odata.context": "/redfish/v1/$metadata#AccountService/ADService",

  "@odata.id": "/redfish/v1/AccountService/ADService",

  "@odata.type": "#ADService.v1_0_0.ADService",

  "ADControllers": {

    "@odata.id": "/redfish/v1/AccountService/ADService/ADControllers"

  },

  "ADServiceEnabled": false,

  "DomainControllerAddress1": "192.168.1.2",

  "DomainControllerAddress2": "192.168.1.3",

  "DomainControllerAddress3": "192.168.1.4",

  "Id": "ADService",

  "Name": "AD Controller Collection",

  "Oem": {

    "Public": {

      "CompletionCode": 0,

      "Description": "Success"

    }

  },

  "Password": null,

  "UserDomain": "cn=Manager,dc=example,dc=com",

  "UserName": "test"

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回字段说明同【查询AD服务资源】

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

 

4.5.24  查询AD域控制器集合资源

【功能描述】

查询AD域控制器集合资源。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/AccountService/ADService/ADControllers

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-428 查询AD域控制器集合资源参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/AccountService/ADService/ADControllers

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【响应样例】

{

"@odata.context": "/redfish/v1/$metadata#AccountService/ADService/ADControllers/$entity",

  "@odata.id": "/redfish/v1/AccountService/ADService/ADControllers",

  "@odata.type": "#ADControllersCollection.ADControllersCollection",

  "Members": [

    {

      "@odata.id": "/redfish/v1/AccountService/ADService/ADControllers/1"

    }

  ],

  "[email protected]": 1,

  "Name": "AD Controller Collection",

  "Oem": {

    "Public": {

      "CompletionCode": 0,

      "Description": "Success"

    }

  }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-429 查询AD与控制器集合资源

字段

类型

字段说明

@odata.context

字符串

AD域控制器集合资源的OData 描述信息

@odata.id

字符串

AD域控制器集合资源的访问路径

@odata.type

字符串

AD域控制器集合资源的类型

Name

字符串

AD域控制器资源的名称

Members

对象

AD域控制器对象

[email protected]

数值

AD域控制器数量

 

4.5.25  查询指定AD域用户集合资源

【功能描述】

查询指定AD域用户集合资源。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/AccountService/ADService/ADControllers/controllers_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-430 查询AD域控制器下用户集合资源信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

controllers_id

AD控制器ID

当前只支持1

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/AccountService/ADService/ADControllers/1

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#AccountService/ADService/ADControllers/1/$entity",

  "@odata.id": "/redfish/v1/AccountService/ADService/ADControllers/1",

  "@odata.type": "#AdGroupsCollection.v1_0_0.AdGroupsCollection",

  "Id": "1",

  "Members": [

    {

      "@odata.id": "/redfish/v1/AccountService/ADService/ADControllers/1/1"

}

……

  ],

  "[email protected]": 3,

  "Name": "AD Groups Collection",

  "Oem": {

    "Public": {

      "CompletionCode": 0,

      "Description": "Success"

    }

  }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-431 查询AD域用户集合资源信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

指定AD域用户集合资源的OData 描述信息

@odata.id

字符串

指定AD域用户集合资源的访问路径

@odata.type

字符串

指定AD域用户集合资源的类型

Members

数组

AD 用户组

[email protected]

字符串

AD域用户数量

 

【修改记录】

(1)     HDM2-1.14：应答示例中的”LDAP”改为“AD”

 

4.5.26  查询指定AD域的单个用户资源

【功能描述】

查询指定AD域的单个用户资源。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/AccountService/ADService/ADControllers/controllers_id/user_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-432 查询指定角色资源信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

controllers_id

AD控制器ID

当前只支持1

user_id

数值

待查询的AD域用户ID

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/AccountService/ADService/ADControllers/1/3

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【响应样例】

{

"@odata.context": "/redfish/v1/$metadata#AccountService/ADService/ADControllers/1/1$entity",

  "@odata.id": "/redfish/v1/AccountService/ADService/ADControllers/1/3",

  "@odata.type": "#ADControllers.v1_0_0.ADControllers",

  "Description": "AD Group Instance",

  "GroupName": "test",

  "GroupRole": "Administrator",

  "Id": "3",

  "Name": "ADGroupInstance",

  "Oem": {

    "Public": {

      "CompletionCode": 0,

      "Description": "Success"

    }

  },

  "RoleGroupDomain": "qwert.cn"

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-433 查询指定AD域的单个用户资源输出参数说明

字段

类型

字段说明

@odata.context

字符串

指定AD域的单个用户资源的OData 描述信息

@odata.id

字符串

指定AD域的单个用户资源的访问路径

@odata.type

字符串

指定AD域的单个用户资源资源的类型

Name

字符串

指定AD域用户资源的名称

Description

字符串

指定AD域用户信息的描述

GroupName

字符串

用户组组名

RoleGroupDomain

字符串

用户组组域

GroupRole

字符串

用户组角色

Id

字符串

用户组编号

 

【修改记录】

(1)     HDM2-1.15：修改字段“MemberId”为“Id”；

 

4.5.27  添加指定AD 域用户组

【功能描述】

添加指定AD域的用户组。

【所属权限模块】

用户配置

【所属系统锁定类型】

BMC配置锁定

【命令格式】

POST  https://device_ip/redfish/v1/AccountService/ADService/ADControllers/controllers_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"Id": "3",

"GroupName": "yfq",

"RoleGroupDomain": "qwert.cn",

"GroupRole": "Administrator"

}

【参数说明】

表4-434 添加指定AD 域用户组参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

controllers_id

数值

AD控制器，当前只支持1

Id

字符串

用户组Id

GroupName

字符串

用户组组名

注：该字段最大长度为255位

RoleGroupDomain

字符串

用户组组域

注：该字段最大长度为255位

GroupRole

字符串

用户组角色

注：取值范围由查询角色名称接口获得

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/AccountService/ADService/ADControllers/1

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"Id": "1",

"GroupName": "test",

"RoleGroupDomain": "qwert.cn",

"GroupRole": "Administrator"

}

【响应样例】

{

"@odata.context": "/redfish/v1/$metadata#AccountService/ADService/ADControllers/1/1$entity",

  "@odata.id": "/redfish/v1/AccountService/ADService/ADControllers/1/1",

  "@odata.type": "#ADControllers.v1_0_0.ADControllers",

  "Description": "AD Group Instance",

  "GroupName": "test",

  "GroupRole": "Administrator",

  "Id": "1",

  "Name": "ADGroupInstance",

  "Oem": {

    "Public": {

      "CompletionCode": 0,

      "Description": "Success"

    }

  },

  "RoleGroupDomain": "qwert.cn"

}

响应码：201

【输出说明】

返回状态码201，表示操作成功。

返回字段说明同【查询指定AD域的单个用户资源】

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

 

4.5.28  修改指定AD域用户组资源

【功能描述】

修改指定AD域用户组信息

【所属权限模块】

用户配置

【所属系统锁定类型】

BMC配置锁定

【命令格式】

PATCH https://device_ip/redfish/v1/AccountService/ADService/ADControllers/controllers_id/user_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:ifmatch_value

【请求消息体】

{

"GroupName": "test",

"RoleGroupDomain": "CN=qwert,OU=admin,DC=huawei,DC=com",

"GroupRole": "Administrator"

}

【参数说明】

表4-435 修改指定AD域用户资源信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

controllers_id

AD控制器ID

当前只支持1

user_id

数值

待修改的AD域用户组ID

GroupName

字符串

用户组组名

注：该字段最大长度为255位

RoleGroupDomain

字符串

用户组组域

注：该字段最大长度为255位

GroupRole

字符串

用户组角色

注：取值范围由查询角色名称接口获得

 

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/AccountService/ADService/ADControllers/1/3

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

"GroupName": "test",

"RoleGroupDomain": "qwert.cn",

"GroupRole": "Administrator"

}

【响应样例】

{

"@odata.context": "/redfish/v1/$metadata#AccountService/ADService/ADControllers/1/1$entity",

  "@odata.id": "/redfish/v1/AccountService/ADService/ADControllers/1/1",

  "@odata.type": "#ADControllers.v1_0_0.ADControllers",

  "Description": "AD Group Instance",

  "GroupName": "test",

  "GroupRole": "Administrator",

  "Id": "3",

  "Name": "ADGroupInstance",

  "Oem": {

    "Public": {

      "CompletionCode": 0,

      "Description": "Success"

    }

  },

"RoleGroupDomain": "qwert.cn"

}

【输出说明】

返回状态码200，表示操作成功。

返回字段说明同【查询指定AD域的单个用户资源】

【修改记录】

(1)     HDM2-1.14:”user_id”字段解释修改为” 待修改的AD域用户组ID”

(2)     HDM2-1.53：添加所属系统锁定类型；

 

4.5.29  删除指定AD域用户组资源

【功能描述】

删除指定 AD 域用户组资源。

【所属权限模块】

用户配置

【所属系统锁定类型】

BMC配置锁定

【命令格式】

DELETE  https://device_ip/redfish/v1/AccountService/ADService/ADControllers/controllers_id/user_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-436 删除指定AD域用户资源参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

controllers_id

AD控制器ID

当前只支持1

user_id

数值

待删除的AD域用户组ID

 

【使用实例】

【请求样例】

DELETE https://192.168.18.18/redfish/v1/AccountService/ADService/ADControllers/1/1

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【响应样例】

响应体：

{

"Oem": {

       "Public": {

           "CompletionCode": 0,

           "Description": "Success"

       }

 },

"error": {

       "@Message.ExtendedInfo": [

           {

               "@odata.type": "#Message.v1_1_1.Message",

               "Message": "The account was successfully removed.",

               "MessageArgs": [],

               "MessageId": "Base.1.8.1.AccountRemoved",

               "MessageSeverity": "OK",

               "Resolution": "No resolution is required."

           }

       ],

        "code":"Base.1.8.1.AccountRemoved",

        "message":"The account was successfully removed."

    }

}

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-437 删除指定AD域用户资源输出参数说明

字段

类型

字段说明

code

字符串

指示消息注册表中特定消息ID的字符串

message

字符串

与消息注册表中的消息对应的易读的错误消息

@Message.ExtendedInfo

扩展信息

@odata.type

字符串

消息资源的OData描述信息

MessageId

字符串

消息ID

Message

字符串

详细信息

MessageArgs

数组

信息参数

MessageSeverity

字符串

严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical

Resolution

字符串

解决建议

 

【修改记录】

(1)     HDM2-1.14: “user_id”字段解释修改为“待删除的AD用户组ID”

(2)     HDM2-1.53：添加所属系统锁定类型；

(3)     HDM2-2.04：Message.ExtendedInfo前添加error节点，并且在error节点下增加code和message字段；

 

4.5.30  获取用户证书管理服务信息

【功能描述】

获取用户证书管理服务信息，X18000产品不支持该接口。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/AccountService/Oem/Public/CertificateService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-438 获取用户证书管理服务信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/AccountService/Oem/Public/CertificateService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#AccountService/Oem/Public/CertificateService",

    "@odata.id": "/redfish/v1/AccountService/Oem/Public/CertificateService",

    "@odata.type": "#CertificateService.v1_0_0.CertificateService",

    "Name": "Account CertificateService",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

},

"Accounts": {

        "@odata.id": "/redfish/v1/AccountService/Oem/Public/CertificateService/Accounts"

},

    "RevokeCheck": false,

    "RootCertificate": {

        "@odata.id": "/redfish/v1/AccountService/Oem/Public/CertificateService/RootCertificate"

    },

    "RootCertificateId": "",

    "ServiceEnabled": false

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-439 获取用户证书管理服务信息输出说明

字段

类型

字段说明

@odata.context

字符串

用户证书管理服务资源模型的OData 描述信息

@odata.id

字符串

用户证书管理服务资源的访问路径

@odata.type

字符串

用户证书管理服务资源的类型

ServiceEnabled

布尔型

证书启用是否开启：

false表示关闭

true表示开启

RootCertificate

对象

查询根证书列表

RevokeCheck

布尔型

证书撤销检查是否开启：

false表示关闭

true表示开启

RootCertificateId

字符串

已启用根的证书的ID

Accounts

对象

获取客户端证书可绑定的用户列表

 

4.5.31  设置证书管理服务信息

【功能描述】

设置证书管理服务信息，X18000产品不支持该接口。

【所属权限模块】

用户配置

【所属系统锁定类型】

BMC配置锁定

【命令格式】

PATCH https://device_ip/redfish/v1/AccountService/Oem/Public/CertificateService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"ServiceEnabled": true,

"RevokeCheck":true,

"RootCertificateId":"1"

}

【参数说明】

表4-440 设置证书管理服务信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

ServiceEnabled

证书启用是否开启

证书启用是否开启：

false表示关闭

true表示开启

RevokeCheck

证书撤销检查是否开启

证书撤销检查是否开启：

false表示关闭

true表示开启

RootCertificateId

字符串

启用根证书ID

 

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/AccountService/Oem/Public/CertificateService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"ServiceEnabled": true,

"RevokeCheck":true,

"RootCertificateId":"1"

}

【响应样例】

{

   "@odata.context":"/redfish/v1/$metadata#AccountService/Oem/Public/CertificateService",

    "@odata.id":"/redfish/v1/AccountService/Oem/Public/CertificateService",

    "@odata.type":"#CertificateService.v1_0_0.CertificateService",

    "Name":"Account CertificateService",

    "Oem":{

        "Public":{

            "CompletionCode":0,

            "Description":"Success"

        }

    },

    "Accounts":{

        "@odata.id":"/redfish/v1/AccountService/Oem/Public/CertificateService/Accounts"

    },

    "RevokeCheck":true,

    "RootCertificate":{

"@odata.id":"/redfish/v1/AccountService/Oem/Public/CertificateService/RootCertificate"

    },

    "RootCertificateId":"1",

    "ServiceEnabled":true

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回体字段同【获取用户证书管理服务信息】

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

 

4.5.32  查询用户根证书列表

【功能描述】

查询用户根证书列表。X18000产品不支持该接口。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/AccountService/Oem/Public/CertificateService/RootCertificate

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-441 查询用户根证书列表参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/AccountService/Oem/Public/CertificateService/RootCertificate

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#AccountService/Oem/Public/CertificateService/RootCertificate",

    "@odata.id": "/redfish/v1/AccountService/Oem/Public/CertificateService/RootCertificate",

    "@odata.type": "#RootCertificateCollection.RootCertificateCollection",

    "Members": [

        {

            "@odata.id": "/redfish/v1/AccountService/Oem/Public/CertificateService/RootCertificate/1"

        }

    ],

    "[email protected]": 1,

    "Name": "RootCertificate Collection",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-442   查询用户根证书列表输出说明

字段

类型

字段说明

@odata.context

字符串

查询用户根证书列表资源模型的OData 描述信息

@odata.id

字符串

查询用户根证书列表资源的访问路径

@odata.type

字符串

查询用户根证书列表资源的类型

Name

字符串

根证书资源的名称

Members

数组

查询指定根证书

[email protected]

数值

根证书个数

 

4.5.33  查询指定根证书信息

【功能描述】

查询指定根证书信息，X18000产品不支持该接口。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/AccountService/Oem/Public/CertificateService/RootCertificate/rootcertificate_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-443 查询指定根证书列表参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

rootcertificate_id

根证书编号

从查询根证书列表中获得

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/AccountService/Oem/Public/CertificateService/RootCertificate/1

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#AccountService/Oem/Public/CertificateService/RootCertificate",

    "@odata.id": "/redfish/v1/AccountService/Oem/Public/CertificateService/RootCertificate/1",

    "@odata.type": "#Certificate.v1_2_0.Certificate",

    "Actions": {

        "#CertificateService.ImportClientCertificate": {

            "@odata.id": "/redfish/v1/AccountService/Actions/Oem/Public/CertificateService/RootCertificate/1/CertificateService.ImportClientCertificate"

        }

    },

    "CertificateType": "PEM",

    "CertificateUsageType": "Web",

    "ClientCertificate": {

        "@odata.id": "/redfish/v1/AccountService/Oem/Public/CertificateService/RootCertificate/1/ClientCertificate"

    },

    "FileName": "ca.crt",

    "Issuer": "[email protected],CN=root,OU=bmc,O=h3c,L=hangzhou,ST=zhejiang,C=CN",

    "Name": "Root Certificate",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "RootCertificateEnabled": false,

    "RootCertificateId": "1",

    "SerialNumber": "2CE5197635DA354AF219FD4E36130CBE12D0C83F",

    "Subject": "[email protected],CN=root,OU=bmc,O=h3c,L=hangzhou,ST=zhejiang,C=CN",

    "ValidityDays": "2022-12-24T09:43:13+08:00"

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-444 查询指定根证书信息输出说明

字段

类型

字段说明

@odata.context

字符串

查询指定根证书信息资源模型的OData 描述信息

@odata.id

字符串

查询指定根证书信息资源的访问路径

@odata.type

字符串

查询指定根证书信息资源的类型

RootCertificateId

字符串

根证书编号

SerialNumber

字符串

根证书序列号

Issuer

字符串

根证书使用者

ValidityDays

字符串

根证书有效截止日期

Subject

字符串

根证书颁发者

FileName

字符串

根证书文件名

Actions#CertificateService.ImportClientCertificate

对象

导入客户端证书链接

RootCertificateEnabled

布尔

根证书是否启用

 

4.5.34  导入根证书文件

【功能描述】

导入根证书文件，X18000产品不支持该接口。

【所属权限模块】

用户配置

【所属系统锁定类型】

BMC配置锁定

【命令格式】

POST https://device_ip/redfish/v1/AccountService/Actions/Oem/Public/CertificateService.ImportRootCertificate

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

本地导入

先通过【上传BMC文件】将文件传输到/tmp/web/目录下，再调用本接口

{

"Type":"URI",

"Content": "/tmp/web/filename"

}

 

远程导入

cifs或sftp

{

  "Type":"URI",

"Content":"cifs://username:password@ip/filename"

}

http、tftp、nfs或https

{

  "Type":"URI",

"Content":"http://ip/filename"

}

【参数说明】

表4-445 导入根证书文件参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

type

导入客户端证书的方式

URI，表明value值是URI（本地或者远程）

Content

导入路径

见其它说明

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/AccountService/Actions/Oem/Public/CertificateService.ImportRootCertificate

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"Type": "URI",

"Content":"sftp://y17057:[email protected]/ca.crt"

}

【应答示例】

{

  "@odata.context": "/redfish/v1/$metadata#TaskCollection.TaskCollection",

  "@odata.type": "#TaskCollection.TaskCollection",

  "Members": [

    {

      "@odata.id": "/redfish/v1/TaskService/Tasks/2"

    }

  ],

  "[email protected]": 1,

  "Name": "Task Collection",

  "Oem": {

    "Public": {

      "CompletionCode": 0,

      "Description": "Success",

      "TaskUniqueID": 1678656297

    }

  }

}

响应码：202

【输出说明】

返回状态码202，表示操作成功。

表4-446 导入根证书文件输出说明

字段

类型

字段说明

@odata.context

字符串

导入根证书文件TaskService的OData 描述信息

@odata.type

字符串

导入根证书文件TaskService的类型

@odata.id

字符串

导入根证书文件TaskService的访问路径

[email protected]

字符串

导入根证书文件生成的Task链接

[email protected]

数值

导入根证书文件生成的Task链接个数

Name

字符串

导入根证书文件TaskService的名称

Oem.Public.TaskUniqueID

数值

导入根证书文件TaskService的唯一ID

 

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

 

4.5.35  删除根证书文件

【功能描述】

删除根证书文件，X18000产品不支持该接口。

【所属权限模块】

用户配置

【所属系统锁定类型】

BMC配置锁定

【命令格式】

DELETE   https://device_ip/redfish/v1/AccountService/Oem/Public/CertificateService/RootCertificate/rootcertificate_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-447 删除根证书文件参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

rootcertificate_id

根证书ID

从查询根证书列表中获取

 

【使用实例】

【请求样例】

DELETE https://192.168.18.18/redfish/v1/AccountService/Oem/Public/CertificateService/RootCertificate/1

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【响应样例】

 {

"Oem": {

       "Public": {

           "CompletionCode": 0,

           "Description": "Success"

       }

 },

"error": {

       "@Message.ExtendedInfo": [

           {

               "@odata.type": "#Message.v1_1_1.Message",

               "Message": "Successfully Completed Request",

               "MessageArgs": [],

               "MessageId": "Base.1.8.1.Success",

               "MessageSeverity": "OK",

               "Resolution": "None"

           }

       ],

        "code":"Base.1.8.1.Success",

        "message":"Successfully Completed Request"

    }

}

}

【输出说明】

返回状态码200，表示操作成功。

表4-448 删除根证书文件输出参数说明

字段

类型

字段说明

code

字符串

指示消息注册表中特定消息ID的字符串

message

字符串

与消息注册表中的消息对应的易读的错误消息

@Message.ExtendedInfo

消息扩展信息

@odata.type

字符串

消息资源的OData描述信息

MessageId

字符串

消息ID

Message

字符串

详细信息

MessageArgs

数组

信息参数

MessageSeverity

字符串

严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical

Resolution

字符串

解决建议

 

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

(2)     HDM2-2.04：Message.ExtendedInfo前添加error节点，并且在error节点下增加code和message字段；

 

4.5.36  查询与指定根证书绑定的客户端证书列表

【功能描述】

查询与指定根证书绑定的客户端证书列表信息，X18000产品不支持该接口。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/AccountService/Oem/Public/CertificateService/RootCertificate/rootcertificate_id/ClientCertificate

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-449 查询与指定根证书绑定的客户端证书列表参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

rootcertificate_id

根证书编号

从查询根证书列表中获得

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/AccountService/Oem/Public/CertificateService/RootCertificate/1/ClientCertificate

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【响应样例】

{

  "@odata.context": "/redfish/v1/$metadata#AccountService/Oem/Public/CertificateService/RootCertificate/1/ClientCertificate",

    "@odata.id": "/redfish/v1/AccountService/Oem/Public/CertificateService/RootCertificate/1/ClientCertificate",

    "@odata.type": "#ClientCertificateCollection.ClientCertificateCollection",

  "Members": [

  {

      "@odata.id": "/redfish/v1/AccountService/Oem/Public/CertificateService/RootCertificate/1/ClientCertificate/1"

  }

   ……

    ],

    "[email protected]": 2,

"Name": "ClientCertificate Collection",

"Oem": {

    "Public": {

      "CompletionCode": 0,

      "Description": "Success"

    }

  }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-450 查询与指定根证书绑定的客户端证书列表输出参数说明

字段

类型

字段说明

@odata.context

字符串

与指定根证书绑定的客户端证书资源的OData 描述信息

@odata.id

字符串

与指定根证书绑定的客户端证书资源的访问路径

@odata.type

字符串

与指定根证书绑定的客户端证书资源的类型

Members

数组对象

客户端证书信息查询路径

[email protected]

字符串

客户端证书个数

 

4.5.37  导入客户端证书文件

【功能描述】

导入客户端证书文件，X18000产品不支持该接口。

【所属权限模块】

用户配置

【所属系统锁定类型】

BMC配置锁定

【命令格式】

POST https://device_ip/redfish/v1/AccountService/Actions/Oem/Public/CertificateService/RootCertificate/rootcertificate_id/CertificateService.ImportClientCertificate

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

本地导入

先通过【上传BMC文件】将文件传输到/tmp/web/目录下，再调用本接口

{

"Type":"URI",

"Content": "/tmp/web/filename"

}

 

远程导入

cifs或sftp

{

  "Type":"URI",

"Content":"cifs://username:password@ip/filename"

}

http、tftp、nfs或https

{

  "Type":"URI",

"Content":"http://ip/filename"

}

【参数说明】

表4-451 导入客户端证书文件参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

rootcertificate_id

根证书ID

从查询用户根证书列表中获得

type

导入客户端证书的方式

URI，表明value值是URI（本地或者远程）

Content

导入路径

见其它说明

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/AccountService/Actions/Oem/Public/CertificateService/RootCertificate/1/CertificateService.ImportClientCertificate

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"Type": "URI",

"Content":"sftp://y17057:[email protected]/client.crt"

}

【应答示例】

{

  "@odata.context": "/redfish/v1/$metadata#TaskCollection.TaskCollection",

  "@odata.type": "#TaskCollection.TaskCollection",

  "Members": [

    {

      "@odata.id": "/redfish/v1/TaskService/Tasks/2"

    }

  ],

  "[email protected]": 1,

  "Name": "Task Collection",

  "Oem": {

    "Public": {

      "CompletionCode": 0,

      "Description": "Success",

      "TaskUniqueID": 1678656297

    }

  }

}

响应码：202

【输出说明】

返回状态码202，表示操作成功。

表4-452 导入客户端证书输出说明

字段

类型

字段说明

@odata.context

字符串

导入客户端证书TaskService的OData 描述信息

@odata.type

字符串

导入客户端证书TaskService的类型

@odata.id

字符串

导入客户端证书TaskService的访问路径

[email protected]

字符串

导入客户端证书生成的Task链接

[email protected]

数值

导入客户端证书生成的Task链接个数

Name

字符串

导入客户端证书TaskService的名称

Oem.Public.TaskUniqueID

数值

导入客户端证书TaskService的唯一ID

 

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

 

4.5.38  查询指定客户端证书信息

【功能描述】

查询指定客户端证书信息，X18000产品不支持该接口。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/AccountService/Oem/Public/CertificateService/RootCertificate/rootcertificate_id/ClientCertificate/clientcertificate_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-453 查询指定客户端证书信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

rootcertificate_id

根证书编号

从查询用户根证书列表中获得

clientcertificate_id

客户端证书编号

从查询与指定根证书绑定的客户端证书列表中获得

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/AccountService/Oem/Public/CertificateService/RootCertificate/1/ClientCertificate/1

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【响应样例】

{

    "@odata.context": "/redfish/v1/$metadata#AccountService/Oem/Public/CertificateService/RootCertificate/1/ClientCertificate/1",

    "@odata.id": "/redfish/v1/AccountService/Oem/Public/CertificateService/RootCertificate/1/ClientCertificate/1",

    "@odata.type": "#ClientCertificateInstance.v1_0_0.ClientCertificateInstance",

    "Actions": {

        "#CertificateService.BindUser": {

            "target": "/redfish/v1/AccountService/Actions/Oem/Public/CertificateService/RootCertificate/1/ClientCertificate/1/CertificateService.BindUser"

        },

        "#CertificateService.DeleteUser": {

            "target": "/redfish/v1/AccountService/Actions/Oem/Public/CertificateService/RootCertificate/1/ClientCertificate/1/CertificateService.DeleteUser"

        }

    },

    "FileName": "client.crt",

    "Fingerprint": "84:53:A3:28:0D:56:83:FC:4A:9F:39:83:73:68:09:7C:E0:70:0C:03",

    "Id": "1",

    "Name": "ClientCertificate 1",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "RoleId": "Administrator",

    "UserId": "1",

    "UserName": "anonymous"

}

返回码：200

【输出说明】

返回状态码200，表示操作成功。

表4-454 查询指定客户端证书信息参数说明

字段

类型

字段说明

@odata.context

字符串

指定客户端证书信息资源的OData 描述信息

@odata.id

字符串

指定客户端证书信息资源的访问路径

@odata.type

字符串

指定客户端证书信息资源的类型

FileName

字符串

客户端证书文件名

FingerPrint

字符串

客户端证书指纹

UserName

字符串

与该客户端证书绑定用户的用户名

RoleId

字符串

与该客户端证书绑定用户的用户权限名

 

4.5.39  删除指定客户端证书

【功能描述】

删除指定客户端证书，X18000产品不支持该接口。

【所属权限模块】

用户配置

【所属系统锁定类型】

BMC配置锁定

【命令格式】

DELETE https://device_ip/redfish/v1/AccountService/Oem/Public/CertificateService/RootCertificate/rootcertificate_id/ClientCertificate/clientcertificate_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-455 删除指定客户端证书参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

rootcertificate_id

根证书ID

从查询用户根证书列表中获得

clientcertificate_id

客户端证书ID

从查询与指定根证书绑定的客户端证书列表中获得

 

【使用实例】

【请求样例】

DELETE https://192.168.18.18/redfish/v1/AccountService/Oem/Public/CertificateService/RootCertificate/1/ClientCertificate/1

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

 {

"Oem": {

       "Public": {

           "CompletionCode": 0,

           "Description": "Success"

       }

 },

"error": {

       "@Message.ExtendedInfo": [

           {

               "@odata.type": "#Message.v1_1_1.Message",

               "Message": "Successfully Completed Request",

               "MessageArgs": [],

               "MessageId": "Base.1.8.1.Success",

               "MessageSeverity": "OK",

               "Resolution": "None"

           }

       ],

        "code":"Base.1.8.1.Success",

        "message":"Successfully Completed Request"

    }

}

}

【输出说明】

返回状态码200，表示操作成功。

表4-456 删除指定客户端证书输出参数说明

字段

类型

字段说明

code

字符串

指示消息注册表中特定消息ID的字符串

message

字符串

与消息注册表中的消息对应的易读的错误消息

@Message.ExtendedInfo

消息扩展信息

@odata.type

字符串

消息资源的OData描述信息

MessageId

字符串

消息ID

Message

字符串

详细信息

MessageArgs

数组

信息参数

MessageSeverity

字符串

严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical

Resolution

字符串

解决建议

 

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

(2)     HDM2-2.04：Message.ExtendedInfo前添加error节点，并且在error节点下增加code和message字段；

 

4.5.40  获取客户端证书可绑定的用户列表

【功能描述】

获取客户端证书可绑定的用户列表，X18000产品不支持该接口。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/AccountService/Oem/Public/CertificateService/Accounts

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-457 获取客户端证书可绑定的用户列表参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/AccountService/Oem/Public/CertificateService/Accounts

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【响应样例】

{

    "@odata.context":

"/redfish/v1/$metadata#AccountService/Oem/Public/CertificateService/Accounts",

    "@odata.id":"/redfish/v1/AccountService/Oem/Public/CertificateService/Accounts",

"@odata.type": "#CertificateService.v1_0_0.CertificateService",

"Name": "Account CertificateService",

"Members":[{

      "Id":"2",

      "UserName":"test1",

      "RoleId":"Administrator",

},

{

      "Id":"3",

      "UserName":"test2",

      "RoleId":"User",

},

……

] ,

"Oem": {

    "Public": {

      "CompletionCode": 0,

      "Description": "Success"

    }

  }

 

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-458 获取客户端证书可绑定的用户列表参数说明

字段

类型

字段说明

@odata.context

字符串

客户端证书可绑定的用户列表资源的OData 描述信息

@odata.id

字符串

客户端证书可绑定的用户列表资源的访问路径

@odata.type

字符串

客户端证书可绑定的用户列表资源的类型

Members

对象

客户端可绑定的用户

Members.Id

字符串

用户编号

Members.UserName

字符串

用户名

Members.RoleId

字符串

用户角色

 

4.5.41  用户绑定客户端证书

【功能描述】

用户绑定客户端证书，X18000产品不支持该接口。

【所属权限模块】

用户配置

【所属系统锁定类型】

BMC配置锁定

【命令格式】

POST https://device_ip/redfish/v1/AccountService/Actions/Oem/Public/CertificateService/RootCertificate/rootcertificate_id/ClientCertificate/clientcertificate_id/CertificateService.BindUser

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

  "Id":"1"

}

【参数说明】

表4-459 用户绑定客户端证书参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

rootcertificate_id

字符串

根证书编号

clientcertificate_id

字符串

客户端证书编号

Id

字符串

用户Id

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/AccountService/Actions/Oem/Public/CertificateService/RootCertificate/1/ClientCertificate/1/CertificateService.BindUser

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

  "Id":"2"

}

【响应样例】

{

"Oem": {

       "Public": {

           "CompletionCode": 0,

           "Description": "Success"

       }

 },

"error": {

       "@Message.ExtendedInfo": [

           {

               "@odata.type": "#Message.v1_1_1.Message",

               "Message": "Successfully Completed Request",

               "MessageArgs": [],

               "MessageId": "Base.1.8.1.Success",

               "MessageSeverity": "OK",

               "Resolution": "None"

           }

       ],

        "code":"Base.1.8.1.Success",

        "message":"Successfully Completed Request"

    }

}

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-460 用户绑定客户端证书参数说明

字段

类型

字段说明

code

字符串

指示消息注册表中特定消息ID的字符串

message

字符串

与消息注册表中的消息对应的易读的错误消息

@Message.ExtendedInfo

消息扩展信息

@odata.type

字符串

消息资源的OData描述信息

MessageId

字符串

消息ID

Message

字符串

详细信息

MessageArgs

数组

信息参数

MessageSeverity

字符串

严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical

Resolution

字符串

解决建议

 

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

(2)     HDM2-2.04：Message.ExtendedInfo前添加error节点，并且在error节点下增加code和message字段；

 

4.5.42  客户端证书解绑与特定用户的关联

【功能描述】

客户端证书解绑与特定用户的关联，X18000产品不支持该接口。

【所属权限模块】

用户配置

【所属系统锁定类型】

BMC配置锁定

【命令格式】

POST https://device_ip/redfish/v1/AccountService/Actions/Oem/Public/CertificateService/RootCertificate/rootcertificate_id/ClientCertificate/clientcertificate_id/CertificateService.DeleteUser

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

  "Id":"2"

}

【参数说明】

表4-461 客户端证书解绑与特定用的关联参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

rootcertificate_id

字符串

根证书编号

clientcertificate_id

字符串

客户端证书编号

Id

字符串

用户Id

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/AccountService/Actions/Oem/Public/CertificateService/RootCertificate/1/ClientCertificate/1/CertificateService.DeleteUser

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

  "Id":"2"

}

【请求样例】

{

"Oem": {

       "Public": {

           "CompletionCode": 0,

           "Description": "Success"

       }

 },

"error": {

       "@Message.ExtendedInfo": [

           {

               "@odata.type": "#Message.v1_1_1.Message",

               "Message": "Successfully Completed Request",

               "MessageArgs": [],

               "MessageId": "Base.1.8.1.Success",

               "MessageSeverity": "OK",

               "Resolution": "None"

           }

       ],

        "code":"Base.1.8.1.Success",

        "message":"Successfully Completed Request"

    }

}

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-462 客户端证书解绑与特定用户的关联输出参数说明

字段

类型

字段说明

code

字符串

指示消息注册表中特定消息ID的字符串

message

字符串

与消息注册表中的消息对应的易读的错误消息

@Message.ExtendedInfo

消息扩展信息

@odata.type

字符串

消息资源的OData描述信息

MessageId

字符串

消息ID

Message

字符串

详细信息

MessageArgs

数组

信息参数

MessageSeverity

字符串

严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical

Resolution

字符串

解决建议

 

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

(2)     HDM2-2.04：Message.ExtendedInfo前添加error节点，并且在error节点下增加code和message字段；

 

4.5.43  获取SSH公钥列表信息

【功能描述】

获取SSH公钥列表信息

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/AccountService/Oem/Public/SSHCiphers

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-463 获取SSH公钥参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/AccountService/Oem/Public/SSHCiphers

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【响应样例】

{

    "@odata.context": "/redfish/v1/$metadata#Managers/1/Oem/Public/SSHCiphers",

    "@odata.id": "/redfish/v1/AccountService/Oem/Public/SSHCiphers",

"@odata.type": "#SSHCiphersCollection.SSHCiphersCollection",

    "Members": [

        {

            "@odata.id": "/redfish/v1/AccountService/Oem/Public/SSHCiphers/1"

        }

],

"Accounts": {

    "@odata.id": "/redfish/v1/AccountService/Oem/Public/SSHCiphers/Accounts"

},

    "[email protected]": 1,

    "Name": "SSHCiphers  Collection",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-464 获取SSH公钥输出参数说明

字段

类型

字段说明

@odata.context

字符串

SSH公钥信息资源的OData 描述信息

@odata.id

字符串

SSH公钥信息资源的访问路径

@odata.type

字符串

SSH公钥信息资源的类型

Members

布尔型

SSH密钥信息查询路径

[email protected]

字符串

SSH密钥个数

Accounts

对象

获取SSH公钥可绑定的用户列表

 

4.5.44  获取指定SSH公钥信息

【功能描述】

获取指定SSH公钥信息

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/AccountService/Oem/Public/SSHCiphers/SSHCiphers_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-465 获取指定SSH公钥信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

SSHCiphers_id

SSH公钥编号

从获取SSH公钥列表信息中获取

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/AccountService/Oem/Public/SSHCiphers/1

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【响应样例】

{

    "@odata.context": "/redfish/v1/$metadata#Managers/1/Oem/Public/SSHCiphers/1",

    "@odata.id": "/redfish/v1/AccountService/Oem/Public/SSHCiphers/1",

    "@odata.type": "#SSHCiphers.v1_0_0.SSHCiphers",

    "FileName": "pubkey.pem",

    "Fingerprint": "44:b0:0a:86:0d:a6:3b:d8:3c:ca:46:65:6b:ae:55:dd",

    "Id": "1",

"Name": "SSHCiphers Instance",

"Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

},

"Users":[

  {

          "Id":"2",

"UserName":"test",

          "RoleId":"User"

},

  {

      "Id":"3",

          "UserName":"test",

          "RoleId":"User"

},

  ……

]

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-466 获取指定SSH公钥信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

指定SSH公钥信息资源的OData 描述信息

@odata.id

字符串

指定SSH公钥信息资源的访问路径

@odata.type

字符串

指定SSH公钥信息资源的类型

UserName

字符串

用户名

Id

字符串

用户编号

RoleId

字符串

用户权限

FileName

字符串

公钥文件名

Fingerprint

字符串

公钥指纹

 

4.5.45  导入SSH公钥

【功能描述】

导入SSH公钥

【所属权限模块】

用户配置

【所属系统锁定类型】

BMC配置锁定

【命令格式】

POST https://device_ip/redfish/v1/AccountService/Actions/Oem/Public/SSHCiphers/SSHCiphers.ImportSSHCiphers

【使用实例】

1、本地导入

{ "Type":"URI", "Content": "/tmp/filename" }

 

2、远程导入

{ "Type":"URI", "Content": "sftp://username:[email protected]/filename"}

【参数说明】

表4-467 导入SSH公钥参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

type

导入客户端证书的方式

URI，表明value值是URI（本地或者远程）

value

内容

1：可以是证书远程路径（支持的文件传输的协议有sftp、https、http、nfs、cifs、tftp）

2：可以是证书本地路径

3：value的含义由type表示

Content

导入路径

见其它说明

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/AccountService/Actions/Oem/Public/SSHCiphers/SSHCiphers.ImportSSHCiphers

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"Type": "URI",

"Content":"sftp://y17057:[email protected]/cacert.pem"

}

【响应样例】

{

    "@odata.context": "/redfish/v1/$metadata#TaskCollection.TaskCollection",

    "@odata.type": "#TaskCollection.TaskCollection",

    "Members": [

        {

            "@odata.id": "/redfish/v1/TaskService/Tasks/1"

        }

    ],

    "[email protected]": 1,

    "Name": "Task Collection",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success",

            "TaskUniqueID": 1678656297

        }

    }

}

响应码：202

【输出说明】

返回状态码202，表示操作成功。

表4-468 导入SSH公钥输出参数说明

字段

类型

字段说明

@odata.context

字符串

导入SSH公钥TaskService的OData 描述信息

@odata.type

字符串

导入SSH公钥TaskService的类型

@odata.id

字符串

导入SSH公钥TaskService的访问路径

[email protected]

字符串

导入SSH公钥生成的Task链接

Name

字符串

导入SSH公钥TaskService的名称

Oem.Public.TaskUniqueID

数值

导入SSH公钥TaskService的唯一ID

 

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

 

4.5.46  删除指定SSH公钥

【功能描述】

删除指定SSH公钥

【所属权限模块】

用户配置

【所属系统锁定类型】

BMC配置锁定

【命令格式】

DELETE https://device_ip/redfish/v1/AccountService/Oem/Public/SSHCiphers/SSHCiphers_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-469 删除指定SSH公钥参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

SSHCiphers _id

SSH公钥编号

从获取SSH公钥列表信息中获取

 

【使用实例】

【请求样例】

DELETE https://192.168.18.18/redfish/v1/AccountService/Oem/Public/SSHCiphers/1

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【响应样例】

 {

"Oem": {

       "Public": {

           "CompletionCode": 0,

           "Description": "Success"

       }

 },

"error": {

       "@Message.ExtendedInfo": [

           {

               "@odata.type": "#Message.v1_1_1.Message",

               "Message": "Successfully Completed Request",

               "MessageArgs": [],

               "MessageId": "Base.1.8.1.Success",

               "MessageSeverity": "OK",

               "Resolution": "None"

           }

       ],

        "code":"Base.1.8.1.Success",

        "message":"Successfully Completed Request"

    }

}

}

【输出说明】

返回状态码200，表示操作成功。

表4-470 删除指定SSH公钥输出参数说明

字段

类型

字段说明

code

字符串

指示消息注册表中特定消息ID的字符串

message

字符串

与消息注册表中的消息对应的易读的错误消息

@Message.ExtendedInfo

消息扩展信息

@odata.type

字符串

消息资源的OData描述信息

MessageId

字符串

消息ID

Message

字符串

详细信息

MessageArgs

数组

信息参数

MessageSeverity

字符串

严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical

Resolution

字符串

解决建议

 

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

(2)     HDM2-2.04：Message.ExtendedInfo前添加error节点，并且在error节点下增加code和message字段；

 

4.5.47  获取SSH公钥可绑定的用户列表

【功能描述】

获取SSH公钥可绑定的用户列表

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/AccountService/Oem/Public/SSHCiphers/Accounts

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-471 获取SSH公钥可绑定的用户列表参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/AccountService/Oem/Public/SSHCiphers/Accounts

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【响应样例】

{

"@odata.context": "/redfish/v1/$metadata#AccountService/Oem/Public/SSHCiphers/Accounts",

    "@odata.id": "/redfish/v1/AccountService/Oem/Public/SSHCiphers/Accounts",

    "@odata.type": "#SSHCiphers.v1_0_0.SSHCiphers",

    "Members": [

        {

            "Id": "1",

            "RoleId": "Administrator",

            "UserName": "anonymous"

        },

        {

            "Id": "2",

            "RoleId": "Administrator",

            "UserName": "test"

        }

    ],

    "Name": "SSHCiphers Accounts",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

}

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-472 获取SSH公钥可绑定的用户列表输出参数说明

字段

类型

字段说明

@odata.context

字符串

SSH公钥可绑定的用户列表资源的OData 描述信息

@odata.id

字符串

SSH公钥可绑定的用户列表资源的访问路径

@odata.type

字符串

SSH公钥可绑定的用户列表资源的类型

Members

对象

客户端可绑定的用户

Members.Id

字符串

用户编号

Members.UserName

字符串

用户名

Members.RoleId

字符串

用户角色

 

4.5.48  用户绑定指定SSH公钥

【功能描述】

用户绑定指定SSH公钥

【所属权限模块】

用户配置

【所属系统锁定类型】

BMC配置锁定

【命令格式】

POST https://device_ip/redfish/v1/AccountService/Actions/Oem/Public/SSHCiphers/SSHCiphers.BindUser

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

  "Id":"3",

  "SSHCiphersId":"2"

}

【参数说明】

表4-473 用户绑定指定SSH公钥参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

Id

用户编号

从查询用户列表信息中获取

SSHCiphersId

公钥编号

从获取SSH公钥列表信息中获取

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/AccountService/Actions/Oem/Public/SSHCiphers/SSHCiphers.BindUser

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

  "Id":"3",

"SSHCiphersId":"2"

}

【响应样例】

{

"Oem": {

       "Public": {

           "CompletionCode": 0,

           "Description": "Success"

       }

 },

"error": {

       "@Message.ExtendedInfo": [

           {

               "@odata.type": "#Message.v1_1_1.Message",

               "Message": "Successfully Completed Request",

               "MessageArgs": [],

               "MessageId": "Base.1.8.1.Success",

               "MessageSeverity": "OK",

               "Resolution": "None"

           }

       ],

        "code":"Base.1.8.1.Success",

        "message":"Successfully Completed Request"

    }

}

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-474 用户绑定指定SSH公钥输出参数说明

字段

类型

字段说明

code

字符串

指示消息注册表中特定消息ID的字符串

message

字符串

与消息注册表中的消息对应的易读的错误消息

@Message.ExtendedInfo

消息扩展信息

@odata.type

字符串

消息资源的OData描述信息

MessageId

字符串

消息ID

Message

字符串

详细信息

MessageArgs

数组

信息参数

MessageSeverity

字符串

严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical

Resolution

字符串

解决建议

 

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

(2)     HDM2-2.04：Message.ExtendedInfo前添加error节点，并且在error节点下增加code和message字段；

 

4.5.49  SSH公钥解绑与特定用户的关联

【功能描述】

SSH公钥解绑与特定用户的关联

【所属权限模块】

用户配置

【所属系统锁定类型】

BMC配置锁定

【命令格式】

POST https://device_ip/redfish/v1/AccountService/Actions/Oem/Public/SSHCiphers/SSHCiphers.DeleteUser

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

  "Id":"3",

  "SSHCiphersId":"2"

}

【参数说明】

表4-475 SSH公钥解绑与特定用户的关联参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

SSHCiphersId

字符串

SSH公钥编号

Id

字符串

用户编号

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/AccountService/Actions/Oem/Public/SSHCiphers/SSHCiphers.DeleteUser

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

  "Id":"3",

  "SSHCiphersId":"2"

}

【响应样例】

{

"Oem": {

       "Public": {

           "CompletionCode": 0,

           "Description": "Success"

       }

 },

"error": {

       "@Message.ExtendedInfo": [

           {

               "@odata.type": "#Message.v1_1_1.Message",

               "Message": "Successfully Completed Request",

               "MessageArgs": [],

               "MessageId": "Base.1.8.1.Success",

               "MessageSeverity": "OK",

               "Resolution": "None"

           }

       ],

        "code":"Base.1.8.1.Success",

        "message":"Successfully Completed Request"

    }

}

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-476 SSH公钥解绑与特定用户的关联输出参数说明

字段

类型

字段说明

code

字符串

指示消息注册表中特定消息ID的字符串

message

字符串

与消息注册表中的消息对应的易读的错误消息

@Message.ExtendedInfo

消息扩展信息

@odata.type

字符串

消息资源的OData描述信息

MessageId

字符串

消息ID

Message

字符串

详细信息

MessageArgs

数组

信息参数

MessageSeverity

字符串

严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical

Resolution

字符串

解决建议

 

【修改记录】

(1)     HDM2-2.04：Message.ExtendedInfo前添加error节点，并且在error节点下增加code和message字段；

 

4.5.50  导入弱口令字典

【功能描述】

导入弱口令字典

【所属权限模块】

用户配置

【所属系统锁定类型】

BMC配置锁定

【命令格式】

POST

https://device_ip/redfish/v1/AccountService/Actions/Oem/Public/AccountService.ImportWeakPasswordDictionary

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

BMC文件系统导入

{

"Type":"URI",

"Content": "/tmp/web/filename"

}

 

远程导入

cifs或sftp

{

    "Type":"URI",

"Content":"cifs://username:password@ip/filename"

}

tftp、nfs、http 或https

 

{

"Type":"URI",

"Content":"nfs://ip/filename"

}

【参数说明】

表4-477 导入弱口令字典操作参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

Type

字符串

URI

Content

文件路径

1、文件传输协议：sftp、https、http、nfs、cifs、tftp，

2、操作路径：不支持中文

3、长度不超过1024，特殊符号支持@!$^&()_+.;[]{}-=~`，不支持中文

4、本地仅支持”/tmp/web/”及其子目录

5、tftp协议目录和文件名的总长度最大为240

6、仅支持.txt文件类型

7、导入文件大小不超过10K，单行弱口令不超过40个字符，文件内容支持换行符、大小写字母、数字、空格和特殊字符`~!@#$%^&*()_+-=[]\{}|;':",./<>?（不符合规则的字符或超长的部分将会被格式化裁剪），格式化后文件内容不能为空

8、文件名长度不超过255

 

【使用实例】

【请求样例】

POST

https://192.168.18.18/redfish/v1/AccountService/Actions/Oem/Public/AccountService.ImportWeakPasswordDictionary

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

  "Type":"URI",

  "Content": "nfs://192.168.20.177/Share1/weakpw.txt"

}

【响应样例】

{

  "@odata.context": "/redfish/v1/$metadata#TaskCollection.TaskCollection",

  "@odata.type": "#TaskCollection.TaskCollection",

  "Members": [

    {

      "@odata.id": "/redfish/v1/TaskService/Tasks/2"

    }

  ],

  "[email protected]": 1,

  "Name": "Task Collection",

  "Oem": {

    "Public": {

      "CompletionCode": 0,

      "Description": "Success",

      "TaskUniqueID": 1678656297

    }

  }

}

响应码：202

【输出说明】

返回状态码202，表示操作成功。

表4-478 导入弱口令字典输出说明

字段

类型

字段说明

@odata.context

字符串

导入弱口令字典TaskService的OData 描述信息

@odata.type

字符串

导入弱口令字典TaskService的类型

@odata.id

字符串

导入弱口令字典TaskService的访问路径

[email protected]

对象

导入弱口令字典生成的Task链接

Name

字符串

导入弱口令字典的TaskService的名称

Oem.Public.TaskUniqueID

数值

导入弱口令字典的TaskService的唯一ID

 

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

4.5.51  导出弱口令字典

【功能描述】

导出弱口令字典

【所属权限模块】

用户配置

【命令格式】

POST

https://device_ip/redfish/v1/AccountService/Actions/Oem/Public/AccountService.ExportWeakPasswordDictionary

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

BMC文件系统导出

{

"Type":"URI",

"Content": "/tmp/web/filename"

}

 

远程导出

cifs或sftp

{

    "Type":"URI",

"Content":"cifs://username:password@ip/filename"

}

Tftp或nfs

{

"Type":"URI",

"Content":"nfs://ip/filename"

}

http 或https

{

  "Type":"URI",

  "Content":"http://ip/filename",

  "ScriptName":"1.php"

}

【参数说明】

表4-479 导出弱口令字典操作参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

Type

字符串

URI

Content

文件路径

1、文件传输协议：sftp、https、http、nfs、cifs、tftp，

2、操作路径：不支持中文

3、长度不超过1024，特殊符号支持@!$^&()_+.;[]{}-=~`，不支持中文

4、本地仅支持”/tmp/web/”及其子目录

5、tftp协议目录和文件名的总长度最大为240

6、仅支持.txt文件类型

7、导入文件大小不超过10K，单行弱口令不超过40个字符，文件内容支持换行符、大小写字母、数字、空格和特殊字符`~!@#$%^&*()_+-=[]\{}|;':",./<>?（不符合规则的字符或超长的部分将会被格式化裁剪），格式化后文件内容不能为空

8、文件名长度不超过255

ScriptName

字符串

通过http/https导出的脚本文件名称

 

【使用实例】

【请求样例】

POST

https://192.168.18.18/redfish/v1/AccountService/Actions/Oem/Public/AccountService.ExportWeakPasswordDictionary

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

  "Type":"URI",

  "Content": "nfs://192.168.20.177/Share1/weakpw.txt"

}

【响应样例】

{

  "@odata.context": "/redfish/v1/$metadata#TaskCollection.TaskCollection",

  "@odata.type": "#TaskCollection.TaskCollection",

  "Members": [

    {

      "@odata.id": "/redfish/v1/TaskService/Tasks/2"

    }

  ],

  "[email protected]": 1,

  "Name": "Task Collection",

  "Oem": {

    "Public": {

      "CompletionCode": 0,

      "Description": "Success",

      "TaskUniqueID": 1678656297

    }

  }

}

响应码：202

【输出说明】

返回状态码202，表示操作成功。

表4-480 导出弱口令字典输出说明

字段

类型

字段说明

@odata.context

字符串

导出弱口令字典TaskService的OData 描述信息

@odata.type

字符串

导出弱口令字典TaskService的类型

@odata.id

字符串

导出弱口令字典TaskService的访问路径

[email protected]

对象

导出弱口令字典生成的Task链接

Oem.Public.TaskUniqueID

数值

导出弱口令字典TaskService的唯一ID

 

4.5.52  查询 Kerberos 服务资源

【功能描述】

查询Kerberos服务资源。

本资源受许可证控制，需要通过许可证授权后才能使用。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/AccountService/Oem/Public/KerberosService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-481 查询Kerberos服务资源参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/AccountService/Oem/Public/KerberosService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【响应样例】

{

    "@odata.context": "/redfish/v1/$metadata#AccountService/Oem/Public/KerberosService",

    "@odata.id": "/redfish/v1/AccountService/Oem/Public/KerberosService",

    "@odata.type": "#Kerberos.v1_0_0.Kerberos",

    "Id": "KerberosService",

    "KerberosControllers": {

        "@odata.id": "/redfish/v1/AccountService/Oem/Public/KerberosService/KerberosControllers"

    },

    "Name": "Kerberos Service",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "ServiceEnabled": false

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-482 查询Kerberos 服务资源输出参数说明

字段

类型

字段说明

@odata.context

字符串

Kerberos服务资源的OData 描述信息

@odata.id        

字符串

Kerberos 资源节点的访问路径

@odata.type

字符串

Kerberos 资源类型

Name

字符串

Kerberos 资源的名称

Id

字符串

Kerberos 资源的 ID

KerberosControllers

对象

Kerberos域控制器集合：

@odata.id：域控制器集合路径

ServiceEnabled

布尔

Kerberos服务是否开启

 

4.5.53  修改Kerberos服务资源

【功能描述】

修改Kerberos服务资源。

本资源受许可证控制，需要通过许可证授权后才能使用。

【所属权限模块】

用户配置

【命令格式】

PATCH https://device_ip/redfish/v1/AccountService/Oem/Public/KerberosService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

    "ServiceEnabled": true

}

【参数说明】

表4-483 设置Kerberos服务资源参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

ServiceEnabled

布尔

Kerberos服务是否开启

 

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/AccountService/Oem/Public/KerberosService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

    "ServiceEnabled": true

}

【响应样例】

{

    "@odata.context": "/redfish/v1/$metadata#AccountService/Oem/Public/KerberosService",

    "@odata.id": "/redfish/v1/AccountService/Oem/Public/KerberosService",

    "@odata.type": "#Kerberos.v1_0_0.Kerberos",

    "Id": "KerberosService",

    "KerberosControllers": {

        "@odata.id": "/redfish/v1/AccountService/Oem/Public/KerberosService/KerberosControllers"

    },

    "Name": "Kerberos Service",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "ServiceEnabled": true

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回字段说明同【查询Kerberos服务资源】

 

4.5.54  查询Kerberos集合资源

【功能描述】

查询Kerberos集合资源。

本资源受许可证控制，需要通过许可证授权后才能使用。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/AccountService/Oem/Public/KerberosService/KerberosControllers

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-484 查询Kerberos集合资源参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/AccountService/Oem/Public/KerberosService/KerberosControllers

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【响应样例】

{

    "@odata.context":"/redfish/v1/$metadata#AccountService/Oem/Public/KerberosService/KerberosControllers/$entity",

    "@odata.id":"/redfish/v1/AccountService/Oem/Public/KerberosService/KerberosControllers",

    "@odata.type":"#KerberosCollection.KerberosCollection",

    "Members":[

        {

            "@odata.id":"/redfish/v1/AccountService/Oem/Public/KerberosService/KerberosControllers/1"

        }

    ],

    "[email protected]":1,

    "Name":"Kerberos Controller Collection",

    "Oem":{

        "Public":{

            "CompletionCode":0,

            "Description":"Success"

        }

    }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-485 查询Kerberos集合资源

字段

类型

字段说明

@odata.context

字符串

Kerberos集合资源的OData 描述信息

@odata.id

字符串

Kerberos集合资源的访问路径

@odata.type

字符串

Kerberos集合资源的类型

Name

字符串

Kerberos集合资源的名称

Members

对象

Kerberos集合对象

[email protected]

数值

Kerberos集合数量

 

4.5.55  查询指定Kerberos用户组集合资源

【功能描述】

查询指定Kerberos用户组集合资源。

本资源受许可证控制，需要通过许可证授权后才能使用。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/AccountService/Oem/Public/KerberosService/KerberosControllers/controllers_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-486 查询Kerberos用户组集合资源信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

controllers_id

Kerberos控制器ID

当前只支持1

 

【使用实例】

【请求样例】

GET https://192.168.18.1/redfish/v1/AccountService/Oem/Public/KerberosService/KerberosControllers/1

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context":"/redfish/v1/$metadata#AccountService/Oem/Public/KerberosService/KerberosControllers/1/$entity",

    "@odata.id":"/redfish/v1/AccountService/Oem/Public/KerberosService/KerberosControllers/1",

    "@odata.type":"#KerberosGroupsCollection.v1_0_0.KerberosGroupsCollection",

    "Id":"1",

    "Members":[

        {

            "@odata.id":"/redfish/v1/AccountService/Oem/Public/KerberosService/KerberosControllers/1/1"

        }

    ],

    "[email protected]":1,

    "Name":"Kerberos Groups Collection",

    "ServerAddress":"192.168.1.199",

    "Port":88,

    "Realm":"IT.SOFTWARE.COM",

    "Oem":{

        "Public":{

            "CompletionCode":0,

            "Description":"Success"

        }

    }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-487 查询Kerberos用户组集合资源信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

指定Kerberos用户集合资源的OData 描述信息

@odata.id

字符串

指定Kerberos用户集合资源的访问路径

@odata.type

字符串

指定Kerberos用户集合资源的类型

Members

数组

Kerberos用户组

[email protected]

字符串

Kerberos用户组数量

ServerAddress

字符串

域控制器的地址，可以是ipv4 或者 ipv6 地址，也可以是一个域名

Port

数字

域控制器的端口号

取值范围： 1～65535

默认值： 88

Realm

字符串

域控制器的领域，领域名称必须大写

 

4.5.56  修改指定 Kerberos用户组集合资源

【功能描述】

修改指定Kerberos用户组集合资源。

本资源受许可证控制，需要通过许可证授权后才能使用。

【所属权限模块】

用户配置

【命令格式】

PATCH https://device_ip/redfish/v1/AccountService/Oem/Public/KerberosService/KerberosControllers/controllers_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:ifmatch_value

【请求消息体】

{

    "ServerAddress":"device_ip",

    "Port": port,

    "Realm": Realm

}

【参数说明】

表4-488 修改Kerberos用户组集合资源信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

controllers_id

Kerberos控制器ID

当前只支持1

ServerAddress

字符串

域控制器的地址，可以是ipv4 或者 ipv6 地址，也可以是一个域名

Port

数字

域控制器的端口号

取值范围： 1～65535

默认值： 88

Realm

字符串

域控制器的领域，领域名称必须大写

Content

字符串

Keytab文件路径

 

【使用实例】

【请求样例】

PATCH https://192.168.18.1/redfish/v1/AccountService/Oem/Public/KerberosService/KerberosControllers/1

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

    "ServerAddress":"192.168.1.199",

    "Port":88,

    "Realm":"IT.SOFTWARE.COM"

}

【应答示例】

{

    "@odata.context":"/redfish/v1/$metadata#AccountService/Oem/Public/KerberosService/KerberosControllers/1/$entity",

    "@odata.id":"/redfish/v1/AccountService/Oem/Public/KerberosService/KerberosControllers/1",

    "@odata.type":"#KerberosGroupsCollection.v1_0_0.KerberosGroupsCollection",

    "Id":"1",

    "Members":[

        {

            "@odata.id":"/redfish/v1/AccountService/Oem/Public/KerberosService/KerberosControllers/1/1"

        }

    ],

    "[email protected]":1,

    "Name":"Kerberos Groups Collection",

    "ServerAddress":"192.168.1.199",

    "Port":88,

    "Realm":"IT.SOFTWARE.COM",

    "Oem":{

        "Public":{

            "CompletionCode":0,

            "Description":"Success"

        }

    }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回字段说明同【查询指定Kerberos用户组集合资源】

 

4.5.57  上传keytab文件

【功能描述】

上传keytab文件。

本资源受许可证控制，需要通过许可证授权后才能使用。

【所属权限模块】

用户配置

【命令格式】

POST https://device_ip/redfish/v1/AccountService/Actions/Oem/Public/KerberosService/KerberosControllers/controllers_id/KerberosControllers.ImportKeytab

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:ifmatch_value

【请求消息体】

本地导入

先通过【上传BMC文件】将文件传输到/tmp/web/目录下，再调用本接口

{

    "Type":"URI",

    "Content":"/tmp/web/Kerberos.keytab"

}

远程导入

cifs或sftp

{

    "Type":"URI",

    "Content":"cifs://username:password@ip/filename"

}

http、tftp、nfs或https

{

    "Type":"URI",

    "Content":"http://ip/filename"

}

【参数说明】

表4-489 上传keytab文件参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

controllers_id

Kerberos控制器ID

当前只支持1

Type

上传keytab文件的方式

URI

Content

字符串

见其它说明

 

【使用实例】

【请求样例】

POST https://192.168.18.1/redfish/v1/AccountService/Actions/Oem/Public/KerberosService/KerberosControllers/1/KerberosControllers.ImportKeytab

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

    "Type":"URI",

    "Content":"/tmp/web/Kerberos.keytab"

}

【应答示例】

{

  "@odata.context": "/redfish/v1/$metadata#TaskCollection.TaskCollection",

  "@odata.type": "#TaskCollection.TaskCollection",

  "Members": [

    {

      "@odata.id": "/redfish/v1/TaskService/Tasks/3"

    }

  ],

  "[email protected]": 1,

  "Name": "Task Collection",

  "Oem": {

    "Public": {

      "CompletionCode": 0,

      "Description": "Success",

      "TaskUniqueID": 1508470554

    }

  }

}

响应码：202

【输出说明】

返回状态码202，表示操作成功。

表4-490 上传keytab文件输出说明

字段

类型

字段说明

@odata.context

字符串

上传keytab文件TaskService的OData 描述信息

@odata.type

字符串

上传keytab文件TaskService的类型

@odata.id

字符串

上传keytab文件TaskService的访问路径

[email protected]

字符串

上传keytab文件生成的Task链接

 

4.5.58  添加指定Kerberos用户组

【功能描述】

添加指定Kerberos的用户组。

本资源受许可证控制，需要通过许可证授权后才能使用。

【所属权限模块】

用户配置

【命令格式】

POST  https://device_ip/redfish/v1/AccountService/Oem/Public/KerberosService/KerberosControllers/controllers_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

    "Id":"3",

    "GroupName":"test",

    "GroupSID":SID,

    "GroupRole":"Administrator"

}

【参数说明】

表4-491 添加指定Kerberos用户组参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

controllers_id

Kerberos控制器

当前只支持1

Id

数值

用户组Id

GroupName

字符串

用户组组名

GroupSID

字符串

用户组SID

GroupRole

字符串

用户组角色

注：取值范围由查询角色名称接口获得

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/AccountService/Oem/Public/KerberosService/KerberosControllers/1

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

    "Id":"1",

    "GroupName":"test",

    "GroupSID":"S-1-5-21-174651825-3639122879-2784557100-1105",

    "GroupRole":"Administrator"

}

【响应样例】

{

    "@odata.context":"/redfish/v1/$metadata#AccountService/Oem/Public/KerberosService/KerberosControllers/1/1$entity",

    "@odata.id":"/redfish/v1/AccountService/Oem/Public/KerberosService/KerberosControllers/1/1",

    "@odata.type":"#KerberosControllers.v1_0_0.KerberosControllers",

    "Description":"Kerberos Groups Instance",

    "GroupName":"test",

    "GroupRole":"Administrator",

    "GroupSID":"S-1-5-21-174651825-3639122879-2784557100-1105",

    "Id":"1",

    "Name":"Kerberos Controller Collection",

    "Oem":{

        "Public":{

            "CompletionCode":0,

            "Description":"Success"

        }

    }

}

响应码：201

【输出说明】

返回状态码201，表示操作成功。

表4-492 添加指定Kerberos用户组输出参数说明

字段

类型

字段说明

@odata.context

字符串

指定Kerberos的单个用户组资源的OData 描述信息

@odata.id

字符串

指定Kerberos的单个用户组资源的访问路径

@odata.type

字符串

指定Kerberos的单个用户组资源的类型

Id

字符串

用户组ID

Name

字符串

指定Kerberos的单个用户组资源的名称

Description

字符串

指定Kerberos用户组信息描述

GroupName

字符串

用户组组名

GroupRole

字符串

用户组角色

GroupSID

字符串

用户组 SID

 

【修改记录】

(1)     HDM2-1.57：删除功能描述中“SID暂不支持”；

(2)     HDM2-1.58：新增Id字段说明并更新Name和@odata.type字段说明；

(3)     HDM2-1.62：删除GroupRole字段描述中的“目前只支持admin用户”；

 

4.5.59  查询指定Kerberos的单个用户组资源

【功能描述】

查询指定Kerberos的单个用户资源。

本资源受许可证控制，需要通过许可证授权后才能使用。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/AccountService/Oem/Public/KerberosService/KerberosControllers/controllers_id/user_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-493 查询Kerberos单个用户组信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

controllers_id

Kerberos控制器ID

当前只支持1

user_id

数值

待查询的Kerberos用户组ID

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/AccountService/Oem/Public/KerberosService/KerberosControllers/1/1

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【响应样例】

{

    "@odata.context":"/redfish/v1/$metadata#AccountService/Oem/Public/KerberosService/KerberosControllers/1/1$entity",

    "@odata.id":"/redfish/v1/AccountService/Oem/Public/KerberosService/KerberosControllers/1/1",

    "@odata.type":"#KerberosControllers.v1_0_0.KerberosControllers",

    "Description":"Kerberos Groups Instance",

    "GroupName":"test",

    "GroupRole":"Administrator",

    "GroupSID":"S-1-5-21-174651825-3639122879-2784557100-1105",

    "Id":"1",

    "Name":"Kerberos Controller Instance",

    "Oem":{

        "Public":{

            "CompletionCode":0,

            "Description":"Success"

        }

    }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-494 查询指定Kerberos的单个用户资源输出参数说明

字段

类型

字段说明

@odata.context

字符串

指定Kerberos的单个用户组资源的OData 描述信息

@odata.id

字符串

指定Kerberos的单个用户组资源的访问路径

@odata.type

字符串

指定Kerberos的单个用户组资源的类型

Id

字符串

用户组ID

Name

字符串

指定Kerberos的单个用户组资源的名称

Description

字符串

指定Kerberos用户组信息描述

GroupName

字符串

用户组组名

GroupRole

字符串

用户组角色

GroupSID

字符串

用户组 SID

 

【修改记录】

(1)     HDM2-1.57：删除功能描述中“SID暂不支持”；

(2)     HDM2-1.58：新增Id字段说明并更新Name和@odata.type字段说明；

(3)     HDM2-1.62：删除GroupRole字段描述中的“目前只支持admin用户”；

 

4.5.60  修改指定Kerberos用户组资源

【功能描述】

修改指定Kerberos用户组信息

本资源受许可证控制，需要通过许可证授权后才能使用。

【所属权限模块】

用户配置

【命令格式】

PATCH https://device_ip/redfish/v1/AccountService/Oem/Public/KerberosService/KerberosControllers/controllers_id/user_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:ifmatch_value

【请求消息体】

{

    "GroupName":"test",

    "GroupSID":SID,

    "GroupRole":"Administrator"

}

【参数说明】

表4-495 修改指定Kerberos用户组资源信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

controllers_id

Kerberos控制器ID

当前只支持1

user_id

数值

待修改的Kerberos用户组ID

GroupName

字符串

用户组组名

GroupRole

字符串

用户组角色

GroupSID

字符串

用户组 SID

 

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/AccountService/Oem/Public/KerberosService/KerberosControllers/1/1

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

    "GroupName":"test",

    "GroupSID":"S-1-5-21-174651825-3639122879-2784557100-1105",

    "GroupRole":"Administrator"

}

【响应样例】

{

    "@odata.context":"/redfish/v1/$metadata#AccountService/Oem/Public/KerberosService/KerberosControllers/1/1$entity",

    "@odata.id":"/redfish/v1/AccountService/Oem/Public/KerberosService/KerberosControllers/1/1",

    "@odata.type":"#KerberosControllers.v1_0_0.KerberosControllers",

    "Description":"Kerberos Groups Instance",

    "GroupName":"test",

    "GroupRole":"Administrator",

    "GroupSID":"S-1-5-21-174651825-3639122879-2784557100-1105",

    "Id":"1",

    "Name":"Kerberos Controller Collection",

    "Oem":{

        "Public":{

            "CompletionCode":0,

            "Description":"Success"

        }

    }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回字段说明同【查询指定Kerberos的单个用户组资源】

【修改记录】

(1)     HDM2-1.57：删除功能描述中“SID暂不支持”；

(2)     HDM2-1.62：删除GroupRole字段描述中的“目前只支持admin用户”；

 

4.5.61  删除指定Kerberos用户组资源

【功能描述】

删除指定Kerberos 用户组资源。

本资源受许可证控制，需要通过许可证授权后才能使用。

【所属权限模块】

用户配置

【命令格式】

DELETE  https://device_ip/redfish/v1/AccountService/Oem/Public/KerberosService/KerberosControllers/controllers_id/user_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-496 删除指定Kerberos用户组资源参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

controllers_id

Kerberos控制器ID

当前只支持1

user_id

数值

待删除的Kerberos用户组ID

 

【使用实例】

【请求样例】

DELETE https://192.168.18.18/redfish/v1/AccountService/Oem/Public/KerberosService/KerberosControllers/1/1

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【响应样例】

响应体：

{

"Oem": {

       "Public": {

           "CompletionCode": 0,

           "Description": "Success"

       }

 },

"error": {

       "@Message.ExtendedInfo": [

           {

               "@odata.type": "#Message.v1_1_1.Message",

               "Message": "The account was successfully removed.",

               "MessageArgs": [],

               "MessageId": "Base.1.8.1.AccountRemoved",

               "MessageSeverity": "OK",

               "Resolution": "No resolution is required."

           }

       ],

        "code":"Base.1.8.1.AccountRemoved",

        "message":"The account was successfully removed."

    }

}

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-497 删除指定Kerberos用户组资源输出参数说明

字段

类型

字段说明

code

字符串

指示消息注册表中特定消息ID的字符串

message

字符串

与消息注册表中的消息对应的易读的错误消息

@Message.ExtendedInfo

消息扩展信息

@odata.type

字符串

消息资源的OData描述信息

MessageId

字符串

消息ID

Message

字符串

详细信息

MessageArgs

数组

信息参数

MessageSeverity

字符串

严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical

Resolution

字符串

解决建议

 

【修改记录】

(1)     HDM2-2.04：Message.ExtendedInfo前添加error节点，并且在error节点下增加code和message字段；

 

4.6  SessionService 资源的操作

4.6.1  创建Redfish会话

【功能描述】

创建新会话。

【所属权限模块】

查询模块

【功能说明】

当前Redfish最大能够创建20个会话，且仅支持HTTPS。如果同时启用了HTTP和HTTPS，则通过HTTP端口创建会话的POST请求应重定向到HTTPS端口。

【命令格式】

POST https://device_ip/redfish/v1/SessionService/Sessions

【请求头】

Content-Type:application/json

【请求消息体】

{

"UserName":name,

"Password":password

}

【参数说明】

表4-498 创建Redfish会话信息返回值

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

UserName

新建会话对应的用户

HDM系统的用户[明文]

Password

新建会话对应的用户的密码

HDM系统的用户对应的密码[明文]

注：密码长度为2～40个字符

 

【使用指南】

在对服务器的Redfish操作过程中，该POST操作是首先要执行的。因为后续大部分操作，都需要在“ Headers”中携带“ X-Auth-Token”值用于鉴权，而“ X-Auth-Token”可通过本操作获得。

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/SessionService/Sessions

【请求头】

Content-Type:application/json

【请求消息体】

{

"UserName":"admin",

"Password":"Password@_"

}

【应答示例】Body部分

{

    "@odata.context": "/redfish/v1/$metadataSessionService/Sessions",

    "@odata.id": "/redfish/v1/SessionService/Sessions/tHNeZ7O293bnX0k2XVBOpnlOCmKElCQd",

    "@odata.type": "#Session.v1_3_0.Session",

    "ClientOriginIPAddress": "192.168.44.56",

    "Description": "Session Service",

    "Id": "4",

    "Name": "admin Session",

    "Oem": {

        "Public": {

            "AssignedPrivileges": [

                "ConfigureUsers",

                "ConfigureComponents",

                "Login",

                "ConfigureSelf"

            ],

            "DefaultPasswordModifyPolicy":"NotModify",

            "CompletionCode": 0,

            "Description": "Success",

            "IPMIEnable": true,

            "LockTimeSeconds": 0,

            "LoginTime": "2017-08-31T07:43:23+08:00",

            "OemPrivileges": [

                "OemKvm",

                "OemVmm",

                "OemSecurityMgmt",

                "OemPowerControl",

                "OemDiagnosis",

                "OemSystemAudit"

            ],

            "PasswordExpired": false,

            "PasswordModify": true,

            "PasswordRemainingSeconds": 0,

            "PasswordValidityDays": 0,

            "PrivilegeIndex": "1023",

            "SessionId": "4",

            "UserRole": "Administrator",

            "UserType": "LocalUser",

            "WebEnable": true,

            "X-Auth-Token": "kkdVRFYCaYxqNhrSK5uYd9dbEoCO7Wv0"

        }

    },

    "SessionType": "Redfish",

    "UserName": "admin"

}

【应答示例】Header部分

X-Auth-Token→kkdVRFYCaYxqNhrSK5uYd9dbEoCO7Wv0

Location→/redfish/v1/SessionService/Sessions/tHNeZ7O293bnX0k2XVBOpnlOCmKElCQd

Strict-Transport-Security→value

X-Frame-Options→DENY

Pragma→no-cache

Cache-Control→no-Store,no-Cache

X-XSS-Protection→nosniff

X-Content-Type-Options→nosniff

Content-Type→application/json

Date→Wed, 30 Aug 2017 23:43:22 GMT

Content-Length→1262

Server→web server

响应码：201

【输出说明】

返回状态码201，表示操作成功。

表4-499 创建会话返回值参数说明

字段

类型

字段说明

@odata.context

字符串

会话信息资源模型的OData描述信息

@odata.id        

字符串

会话信息资源节点的访问路径

@odata.type

字符串

会话信息 资源类型

Description

字符串

会话描述信息

Id

字符串

会话ID

Name

字符串

会话名称

UserName

字符串

用户名称

ClientOriginIPAddress

字符串

用户IP

SessionType

字符串

会话类型；

"Redfish"

"USB"

Oem.Public

对象

该会话的自定义参数

AssignedPrivileges

字符串数组

用户权限

DefaultPasswordModifyPolicy

字符串

默认密码修改策略

NotModify：不修改

ForcedModify：强制修改

Optional：可选弹框

LoginTime

字符串

会话创建时间

OemPrivileges

字符串数组

用户自定义权限

IPMIEnable

布尔

IPMI使能

LockTimeSeconds

数值

剩余锁定时长（秒）

PasswordModify

布尔

密码是否修改

PasswordExpired

布尔

密码是否过期

PasswordRemainingSeconds

数值

密码剩余有效期（秒）

PasswordValidityDays

数值

密码有效期（天）

PrivilegeIndex

字符串

权限索引

SessionId

字符串

会话Index

UserRole

字符串

用户角色

UserType

字符串

用户类型：

LocalUser：本地用户

DomainUser：域用户

WebEnable

布尔

Web使能

X-Auth-Token

字符串

Token值

 

【修改记录】

(1)     HDM2-2.04：将ChangeDefaultPasswordEnabled字段更改为DefaultPasswordModifyPolicy字段；

 

4.6.2  查询会话集合资源信息

【功能描述】

查询服务器当前所有会话信息

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/SessionService/Sessions

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-500 查询服务器当前所有会话信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/SessionService/Sessions

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#SessionCollection.SessionCollection",

    "@odata.id": "/redfish/v1/SessionService/Sessions/",

    "@odata.type": "#SessionCollection.SessionCollection",

    "Description": "Session Collection",

    "Members": [

        {

            "@odata.id": "/redfish/v1/SessionService/Sessions/afQLANTiaGL6yY4aYtsapJWODotcF1sF"

        }

    ],

    "[email protected]": 1,

    "Name": "Session Collection",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    }

}

响应码：200

【输出说明】

表4-501 查询服务器当前所有会话信息返回参数说明

字段

类型

字段说明

@odata.context

字符串

会话集合资源信息模型的OData描述信息

@odata.id        

字符串

会话集合资源信息节点的访问路径

@odata.type

字符串

会话集合资源信息的类型

Members

数组

会话列表

[email protected]

数值

会话数量

Name

字符串

会话资源的名称

 

4.6.3  查询指定会话资源信息

【功能描述】

查询服务器当前指定会话资源信息

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/SessionService/Sessions/session_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-502 查询服务器当前指定会话资源信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

session_id

会话ID

由“查询会话集合资源信息”中获取

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/SessionService/Sessions/rFYBf8FRrmbSXgTXmwEIxAb65AWWlR3q

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#Session.Session",

    "@odata.id": "/redfish/v1/SessionService/Sessions/rFYBf8FRrmbSXgTXmwEIxAb65AWWlR3q",

    "@odata.type": "#Session.v1_3_0.Session",

    "ClientOriginIPAddress": "192.168.170.57",

    "Description": "Session Service",

    "Id": "1",

    "Name": "admin Session",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success",

            "LoginTime": "2019-02-16T20:56:59+08:00",

            "UserID": 1,

            "UserIP": "192.168.170.57",

            "UserRole": "User",

            "UserTag": "Redfish"

        }

    },

    "Password": null,

    "SessionType": "Redfish",

    "UserName": "admin"

}

响应码：200

【输出说明】

表4-503 查询服务器当前指定会话资源信息返回参数说明

字段

类型

字段说明

@odata.context

字符串

指定会话资源模型的访问路径

@odata.id        

字符串

指定会话信息资源节点的访问路径

@odata.type

字符串

指定会话信息 资源类型

Id

字符串

指定会话资源的唯一标识

Name

字符串

指定会话的名称

ClientOriginIPAddress

字符串

该会话对应的用户的地址

UserName

字符串

指定会话的用户名称

UserID

数值

该会话对应的用户Id

UserTag

字符串

该会话对应的登录接口：

"Redfish"

"USB"

"WebUI"

"KVMIP"

LoginTime

字符串

指定会话创建时间

UserRole

字符串

用户角色

SessionType

字符串

会话类型：

"Redfish"

"USB"

"WebUI"

"KVMIP"

 

4.6.4  删除指定会话

【功能描述】

删除指定会话。

【所属权限模块】

安全配置|配置自身

【命令格式】

DELETE  https://device_ip/redfish/v1/SessionService/Sessions/session_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-504 删除指定会话服务参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

session_id

会话ID

由“查询会话集合资源信息”中获取

 

【使用实例】

【请求样例】

DELETE https://device_ip/redfish/v1/SessionService/Sessions/kkdVRFYCaYxqNhrSK5uYd9dbEoCO7Wv0

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【响应样例】

{

"Oem": {

       "Public": {

           "CompletionCode": 0,

           "Description": "Success"

       }

 },

"error": {

       "@Message.ExtendedInfo": [

           {

               "@odata.type": "#Message.v1_1_1.Message",

               "Message": "Successfully Completed Request",

               "MessageArgs": [],

               "MessageId": "Base.1.8.1.Success",

               "MessageSeverity": "OK",

               "Resolution": "None"

           }

       ],

        "code":"Base.1.8.1.Success",

        "message":"Successfully Completed Request"

    }

}

}

响应码：200

【输出说明】

表4-505 删除指定会话服务信息返回值

字段

类型

字段说明

code

字符串

指示消息注册表中特定消息ID的字符串

message

字符串

与消息注册表中的消息对应的易读的错误消息

@Message.ExtendedInfo

消息扩展信息

@odata.type

字符串

消息资源的OData描述信息

MessageId

字符串

消息ID

Message

字符串

详细信息

MessageArgs

数组

信息参数

MessageSeverity

字符串

严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical

Resolution

字符串

解决建议

 

【修改记录】

(1)     HDM2-2.04：Message.ExtendedInfo前添加error节点，并且在error节点下增加code和message字段；

 

4.6.5  查询Redfish会话服务信息

【功能描述】

查询服务器当前Redfish会话服务的信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/SessionService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-506 查询Redfish会话服务信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【使用指南】

无。

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/SessionService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#SessionService.SessionService",

    "@odata.id": "/redfish/v1/SessionService/",

    "@odata.type": "#SessionService.v1_1_8.SessionService",

    "Description": "Session Service",

    "Id": "SessionService",

    "Name": "Session Service",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "ServiceEnabled": true,

    "SessionTimeout": 1800,

    "Sessions": {

        "@odata.id": "/redfish/v1/SessionService/Sessions"

    },

    "Status": {

        "Health": "OK",

        "State": "Enabled"

    }

}

响应码：200

【输出说明】

表4-507 查询Redfish会话服务信息返回参数说明

字段

类型

字段说明

@odata.context

字符串

SessionService资源模型的OData描述信息

@odata.id        

字符串

SessionService资源节点的访问路径

@odata.type

字符串

SessionService 资源类型

Id

字符串

SessionService 的资源ID

Name

字符串

SessionService 资源的名称

ServiceEnabled

布尔型

SessionService使能

SessionTimeout

数值

Redfish会话超时时长，默认时长1800s

Sessions

对象

会话列表

@odata.id        

字符串

会话列表的访问路径

Status

对象

会话管理的状态， 包括：

Health：会话管理健康状态

State：会话管理使能状态

 

4.6.6  修改Redfish会话服务信息

【功能描述】

修改Redfish会话服务信息。

【所属权限模块】

安全配置

【所属系统锁定类型】

BMC配置锁定

【命令格式】

PATCH https://device_ip/redfish/v1/SessionService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:ifmatch_value

【请求消息体】

{

     "ServiceEnabled": true,

     "SessionTimeout": 1800

}

【参数说明】

表4-508 修改Redfish会话服务信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

ifmatch_value

请求消息的匹配参数

可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）

ServiceEnabled

布尔型

是否使能，不支持关闭；若下发false，忽略下发值

SessionTimeout

数值

会话超时时长；范围：30～86400；单位s

 

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/SessionService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

     "ServiceEnabled": true,

     "SessionTimeout": 1800

}

【响应样例】

{

    "@odata.context": "/redfish/v1/$metadata#SessionService.SessionService",

    "@odata.id": "/redfish/v1/SessionService/",

    "@odata.type": "#SessionService.v1_1_8.SessionService",

    "Description": "Session Service",

    "Id": "SessionService",

    "Name": "Session Service",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "ServiceEnabled": true,

    "SessionTimeout": 1800,

    "Sessions": {

        "@odata.id": "/redfish/v1/SessionService/Sessions"

    },

    "Status": {

        "Health": "OK",

        "State": "Enabled"

    }

}

响应码：200

【输出说明】

表4-509 修改修改Redfish会话服务信息返回值

字段

类型

字段说明

@odata.context

字符串

SessionService资源模型的OData描述信息

@odata.id        

字符串

SessionService资源节点的访问路径

@odata.type

字符串

SessionService资源类型

Id     

字符串

SessionService资源的ID

Name

字符串

SessionService资源的名称

SessionTimeout

数字

Redfish会话超时时长

Sessions

会话列表

@odata.id

字符串

会话列表的访问路径

Status.Health

字符串

健康状态

Status.State

字符串

使能状态

 

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

 

4.7  UpdateService 资源的操作

4.7.1  查询服务器当前升级服务资源的信息

【功能描述】

查询服务器当前升级服务资源的信息。

【所属权限模块】

查询模块

【补充说明】

配置管理、导入导出、SSL证书上传、固件更新等会涉及升级状态查询

【命令格式】

GET https://device_ip/redfish/v1/UpdateService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-510 查询服务器当前升级服务资源的信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/UpdateService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#UpdateService",

    "@odata.id": "/redfish/v1/UpdateService",

    "@odata.type": "#UpdateService.v1_9_0.UpdateService",

    "Actions": {

        "#UpdateService.SimpleUpdate": {

            "target": "/redfish/v1/UpdateService/Actions/UpdateService.SimpleUpdate"

        },

        "Oem": {

            "Public": {

                "#MirrorPool.DeleteImage": {

                    "target": "/redfish/v1/UpdateService/Actions/Oem/Public/MirrorPool.DeleteImage"

                },

                "#UpdateService.DumpBIOS": {

                    "target": "/redfish/v1/UpdateService/Actions/Oem/Public/UpdateService.DumpBIOS"

                },

                "#UpdateService.UninstallPackage": {

                    "[email protected]": [

                        "PATCH",

                        "FEATURE"

                    ],

                    "target": "/redfish/v1/UpdateService/Actions/Oem/Public/UpdateService.UninstallPackage"

                }

            }

        }

    },

    "Description": "Service for Software Update",

    "FirmwareInventory": {

        "@odata.id": "/redfish/v1/UpdateService/FirmwareInventory"

    },

    "HttpPushUri": "/redfish/v1/UpdateService",

    "Id": "UpdateService",

    "MaxImageSizeBytes": 471859200,

    "Name": "Update Service",

    "Oem": {

        "Public": {

            "BIOSFirmwareRestoreEnabled": true,

            "BMCFirmwareRestoreEnabled": true,

            "CompletionCode": 0,

            "Description": "Success",

            "FirmwareList": {

                "@odata.id": "/redfish/v1/UpdateService/Oem/Public/FirmwareList"

            },

            "InstalledPackages": {

                "@odata.id": "/redfish/v1/UpdateService/Oem/Public/InstalledPackages"

            },

            "MirrorPool": {

                "@odata.id": "/redfish/v1/UpdateService/Oem/Public/MirrorPool"

            },

            "UpgradeState": null,

            "UpgradeTaskRestoreEnabled": true

        }

    },

    "ServiceEnabled": true,

    "Status": {

        "Health": "OK",

        "State": "Enabled"

    }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-511 查询服务器当前升级服务资源的信息返回参数说明

字段

类型

字段说明

@odata.context

字符串

服务器升级资源模型的OData描述信息

@odata.id        

字符串

服务器升级资源节点的访问路径

@odata.type

字符串

服务器升级资源类型

Actions.UpdateService.SimpleUpdate

对象

升级固件

Actions.Oem.Public.MirrorPool.DeleteImage

对象

删除镜像池中镜像

Actions.Oem.Public.UpdateService.UninstallPackage

对象

卸载指定固件安装包

Actions.Oem.Public.UpdateService.DumpBIOS

对象

导出BIOS固件

Name

字符串

指定升级服务资源的名称

MaxImageSizeBytes

数字

最大固件大小

ServiceEnabled

布尔型

升级服务使能状态

Status.Health

字符串

指定升级服务资源的健康状态

Status.State

字符串

指定升级服务资源的使能状态

FirmwareInventory

对象

可升级固件列表的链接

Oem.Public.UpgradeState

字符串

当前升级状态

Upgrading：升级中；

null：未处于升级状态

Oem.Public.FirmwareList

对象

可升级列表链接

Oem.Public.MirrorPool

对象

镜像池列表

Oem.Public.InstalledPackages

对象

查询固件安装包集合信息

Oem.Public.BMCFirmwareRestoreEnabled

布尔型

BMC固件异常恢复使能状态

Oem.Public.BIOSFirmwareRestoreEnabled

布尔型

BIOS固件异常恢复使能状态

Oem.Public.UpgradeTaskRestoreEnabled

布尔型

升级任务恢复使能状态

 

【修改记录】

(1)     HDM2-1.56：新增Oem.Public.BMCFirmwareRestoreEnabled, Oem.Public.BIOSFirmwareRestoreEnabled和Oem.Public.UpgradeTaskRestoreEnabled字段

 

4.7.2  设置服务器当前升级服务资源的信息

【功能描述】

设置服务器当前升级服务资源的信息。

【所属权限模块】

维护诊断

【命令格式】

PATCH  https://device_ip/redfish/v1/UpdateService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

  "Oem": {

      "Public":{

          "BMCFirmwareRestoreEnabled": false,

          "BIOSFirmwareRestoreEnabled": false,

          "UpgradeTaskRestoreEnabled": false 

      }

  }

}

【参数说明】

表4-512 设置服务器当前升级服务资源的信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

Oem.Public.BMCFirmwareRestoreEnabled

布尔型

BMC固件异常恢复使能状态

Oem.Public.BIOSFirmwareRestoreEnabled

布尔型

BIOS固件异常恢复使能状态

Oem.Public.UpgradeTaskRestoreEnabled

布尔型

升级任务恢复使能状态

 

【使用实例】

【请求样例】

PATCH  https://192.168.18.18/redfish/v1/UpdateService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

  "Oem": {

      "Public":{

          "BMCFirmwareRestoreEnabled": false,

          "BIOSFirmwareRestoreEnabled": false,

          "UpgradeTaskRestoreEnabled": false 

      }

  }

}

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#UpdateService",

    "@odata.id": "/redfish/v1/UpdateService",

    "@odata.type": "#UpdateService.v1_9_0.UpdateService",

    "Actions": {

        "#UpdateService.SimpleUpdate": {

            "target": "/redfish/v1/UpdateService/Actions/UpdateService.SimpleUpdate"

        },

        "Oem": {

            "Public": {

                "#MirrorPool.DeleteImage": {

                    "target": "/redfish/v1/UpdateService/Actions/Oem/Public/MirrorPool.DeleteImage"

                },

                "#UpdateService.DumpBIOS": {

                    "target": "/redfish/v1/UpdateService/Actions/Oem/Public/UpdateService.DumpBIOS"

                },

                "#UpdateService.UninstallPackage": {

                    "[email protected]": [

                        "PATCH",

                        "FEATURE"

                    ],

                    "target": "/redfish/v1/UpdateService/Actions/Oem/Public/UpdateService.UninstallPackage"

                }

            }

        }

    },

    "Description": "Service for Software Update",

    "FirmwareInventory": {

        "@odata.id": "/redfish/v1/UpdateService/FirmwareInventory"

    },

    "HttpPushUri": "/redfish/v1/UpdateService",

    "Id": "UpdateService",

    "MaxImageSizeBytes": 471859200,

    "Name": "Update Service",

    "Oem": {

        "Public": {

            "BIOSFirmwareRestoreEnabled": false,

            "BMCFirmwareRestoreEnabled": false,

            "CompletionCode": 0,

            "Description": "Success",

            "FirmwareList": {

                "@odata.id": "/redfish/v1/UpdateService/Oem/Public/FirmwareList"

            },

            "InstalledPackages": {

                "@odata.id": "/redfish/v1/UpdateService/Oem/Public/InstalledPackages"

            },

            "MirrorPool": {

                "@odata.id": "/redfish/v1/UpdateService/Oem/Public/MirrorPool"

            },

            "UpgradeState": null,

            "UpgradeTaskRestoreEnabled": false

        }

    },

    "ServiceEnabled": true,

    "Status": {

        "Health": "OK",

        "State": "Enabled"

    }

}响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回字段说明同【查询服务器当前升级服务资源的信息】

【修改记录】

(1)     HDM2-1.56：新增接口

 

4.7.3  查询可升级固件集合资源信息

【功能描述】

查询服务器当前可升级的固件集合资源的信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/UpdateService/FirmwareInventory

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-513 查询服务器当前可升级的固件集合资源的信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/UpdateService/FirmwareInventory

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#SoftwareInventoryCollection.SoftwareInventoryCollection",

    "@odata.id": "/redfish/v1/UpdateService/FirmwareInventory",

    "@odata.type": "#SoftwareInventoryCollection.SoftwareInventoryCollection",

    "Description": "Collection of Firmware Inventory resources available to the UpdateService",

    "Members": [

        {

            "@odata.id": "/redfish/v1/UpdateService/FirmwareInventory/HDM"

        },

        {

            "@odata.id": "/redfish/v1/UpdateService/FirmwareInventory/BIOS"

        }

    ],

    "[email protected]": 2,

    "Name": "Firmware Inventory Collection",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-514 查询服务器当前可升级的固件集合资源的信息返回参数说明

字段

类型

字段说明

@odata.context

字符串

服务器可升级固件集合资源模型的OData描述信息

@odata.id        

字符串

服务器可升级固件集合资源节点的访问路径

@odata.type

字符串

服务器可升级固件集合资源类型

Description

字符串

服务器可升级固件集合资源的信息描述

Members

数组

可升级固件资源的名称

[email protected]

数值

可升级固件的个数

Name

字符串

可升级固件集合资源的名称

 

4.7.4  查询指定的可升级固件资源的信息

【功能描述】

查询服务器指定的可升级固件资源的信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/UpdateService/FirmwareInventory/softid

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-515 查询指定的可升级固件资源的信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

softid

固件类型

固件类型

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/UpdateService/FirmwareInventory/HDM

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#UpdateService/FirmwareInventory/Members/$entity",

    "@odata.id": "/redfish/v1/UpdateService/FirmwareInventory/HDM",

    "@odata.type": "#SoftwareInventory.v1_3_0.SoftwareInventory",

    "BuildDate": "2022-06-08T09:55:43+08:00",

    "Id": "HDM",

    "Name": "HDM",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "RelatedItem": [

        {

            "@odata.id": "/redfish/v1/Managers/1"

        }

    ],

    "SoftwareId": "HDM",

    "Status": {

        "Health": "OK",

        "HealthRollup": "OK",

        "State": "Enabled"

    },

    "Updateable": true,

    "Version": "0.00.10"

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-516 查询服务器指定的可升级固件资源的信息返回参数说明

字段

类型

字段说明

@odata.context

字符串

服务器指定可升级固件资源模型的OData描述信息

@odata.id        

字符串

服务器指定可升级固件资源节点的访问路径

@odata.type

字符串

服务器指定可升级固件资源类型

Id

字符串

可升级固件资源的 ID

Name

字符串

可升级固件资源的名称

RelatedItem

数组

导航资源：关联的部件资源

Status.Health

字符串

可升级固件资源的健康状态

Status.HealthRollup

字符串

可升级固件资源的整体健康状态

Status.State

字符串

可升级固件资源的使能状态

SoftwareId

字符串

固件类型

Updateable

布尔型

固件有效性

BuildDate

字符串

版本编译时间

Version

字符串

固件版本

 

4.7.5  查询镜像池列表

【功能描述】

查询镜像池列表，SD卡已经存在的镜像。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/UpdateService/Oem/Public/MirrorPool

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-517 查询镜像池列表参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/UpdateService/Oem/Public/MirrorPool

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

响应码：200，表示操作成功，响应体为：

{

    "@odata.context": "/redfish/v1/$metadata#MirrorPool/MirrorPool/Members/$entity",

    "@odata.id": "/redfish/v1/UpdateService/Oem/Public/MirrorPool",

    "@odata.type": "#MirrorPool.v1_0_0.MirrorPool",

    "FreeSpace": 427757568,

    "MirrorPool": [

        {

            "BackupFileName": "BMC_R4900-G6_0.00.02.ima",

            "FileSizeByte": 42678545,

            "ImageType": "BMC",

            "SubImageType": "R4900 G6",

            "Version": "0.00.02"

        }

    ],

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "UsedSpace": 42678545

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-518 查询镜像池列表返回参数说明

字段

类型

字段说明

@odata.context

字符串

查询镜像池列表资源模型的OData描述信息

@odata.id        

字符串

查询镜像池列表资源节点的访问路径

@odata.type

字符串

查询镜像池列表资源类型

MirrorPool

数组

镜像池信息

BackupFileName

字符串

备份文件名称

ImageType

字符串

镜像类型

FileSizeByte

数字

镜像大小

SubImageType

字符串

镜像子类型,部分固件有镜像子类型，没有为null

Version

字符串

固件版本，有的没有版本信息为null

FreeSpace

数字

镜像池最大可上传升级文件大小

UsedSpace

数字

镜像池已使用空间

 

4.7.6  删除镜像池中指定镜像

【功能描述】

删除镜像池中指定镜像。

【所属权限模块】

维护诊断

【命令格式】

POST  https://device_ip/redfish/v1/UpdateService/Actions/Oem/Public/MirrorPool.DeleteImage

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

  "BackupFileName":fliename

}

【参数说明】

表4-519 删除镜像池中指定镜像参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

BackupFileName

备份文件名称

由查询镜像池列表获得

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/UpdateService/Actions/Oem/Public/MirrorPool.DeleteImage

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

  "BackupFileName":"BMC_R4900-G6_0.00.02.ima"

}

【应答示例】

{

"Oem": {

       "Public": {

           "CompletionCode": 0,

           "Description": "Success"

       }

 },

"error": {

       "@Message.ExtendedInfo": [

           {

               "@odata.type": "#Message.v1_1_1.Message",

               "Message": "Successfully Completed Request",

               "MessageArgs": [],

               "MessageId": "Base.1.8.1.Success",

               "MessageSeverity": "OK",

               "Resolution": "None"

           }

       ],

        "code":"Base.1.8.1.Success",

        "message":"Successfully Completed Request"

    }

}

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-520 删除镜像池中指定镜像输出参数说明

字段

类型

字段说明

code

字符串

指示消息注册表中特定消息ID的字符串

message

字符串

与消息注册表中的消息对应的易读的错误消息

@Message.ExtendedInfo

消息扩展信息

@odata.type

字符串

消息资源的OData描述信息

MessageId

字符串

消息ID

Message

字符串

详细信息

MessageArgs

数组

信息参数

MessageSeverity

字符串

严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical

Resolution

字符串

解决建议

 

【修改记录】

(1)     HDM2-2.04：Message.ExtendedInfo前添加error节点，并且在error节点下增加code和message字段；

 

4.7.7  升级固件

【功能描述】

升级服务器固件。

【所属权限模块】

维护诊断

【所属系统锁定类型】

固件版本锁定|BIOS配置锁定（BIOS升级，除仅升级ME时）|BMC配置锁定（BMC升级时）

【命令格式】

POST https://device_ip/redfish/v1/UpdateService/Actions/UpdateService.SimpleUpdate

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

http、tftp、nfs或https

{

  "ImageURI":" tftp://IP/image.bin",

  "Oem": {

      "Public": {

          "Preserve": preserve,

          "RebootMode":reboot_mode,

          "Backup":backup,

          "ImageMd5URI":"tftp://IP/MD5.txt",

          "Date": date,

          "UpgradeType":upgrade_type

      }

  }

}

cifs或sftp

{

  "ImageURI":"sftp://username:passwd@IP/image.bin",

  "Oem": {

      "Public": {

          "Preserve": preserve,

          "RebootMode":reboot_mode,

          "Backup":backup,

          "ImageMd5URI":"sftp://username:passwd@IP/MD5.txt",

          "Date": date,

          "UpgradeType":upgrade_type

      }

  }

}

【参数说明】

表4-521 升级固件参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

ImageURI

字符串

升级包所在路径

Oem.Public.Preserve

字符串

Retain 配置保留

Restore 配置覆盖

ForceRestore 强制覆盖

Oem.Public.RebootMode

字符串

Auto 立即重启

Manual 手动重启

Oem.Public.Backup

布尔

true 备份

false 不备份

Oem.Public.Date

字符串

任务延时时间

Oem.Public.UpgradeType

字符串

BIOS:

all 更新Bios加ME

bios 仅更新Bios

me 仅更新ME

SEAMLESS:

All 更新Bios加Me加Microcode

bios 仅更新Bios

me 仅更新ME

microcode 仅更新Microcode

bios+me 仅更新Bios加ME

bios+microcode 仅更新Bios加Microcode

me+microcode 仅更新ME加Microcode

Oem.Public.ImageMd5URI

字符串

MD5文件所在路径（选填）

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/UpdateService/Actions/UpdateService.SimpleUpdate

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"ImageURI":"tftp://192.168.21.21/BMC.bin",

"Oem": {

"Public": {

"Preserve":"Retain",

"RebootMode":"Auto"

}

}

}

【应答示例】

{

  "@odata.context": "/redfish/v1/$metadata#TaskCollection.TaskCollection",

  "@odata.type": "#TaskCollection.TaskCollection",

  "Members": [

    {

      "@odata.id": "/redfish/v1/TaskService/Tasks/2"

    }

  ],

  "[email protected]": 1,

  "Name": "Task Collection",

  "Oem": {

    "Public": {

      "CompletionCode": 0,

      "Description": "Success",

      "TaskUniqueID": 1678656297

    }

  }

}

响应码：202

【输出说明】

返回状态码202，表示操作成功。

表4-522 升级输出说明

字段

类型

字段说明

@odata.context

字符串

升级固件TaskService的OData 描述信息

@odata.type

字符串

升级固件TaskService的类型

Name

字符串

升级固件的名称

[email protected]

数字

升级固件生成的Task个数

Members

数组

升级固件生成的Task链接集合

@odata.id

字符串

升级固件生成的Task链接

Oem.Public.TaskUniqueID

数组

升级固件TaskService的唯一ID

 

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

 

4.7.8  查询固件清单信息

【功能描述】

查询固件清单信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/UpdateService/Oem/Public/FirmwareList

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-523 查询固件清单信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/UpdateService/Oem/Public/FirmwareList

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#FirmwareListCollection.FirmwareListCollection",

    "@odata.id": "/redfish/v1/UpdateService/Oem/Public/FirmwareList",

    "@odata.type": "#FirmwareListCollection.FirmwareListCollection",

    "Members": [

        {

            "@odata.id": "/redfish/v1/UpdateService/Oem/Public/FirmwareList/BMCP"

        },

        {

            "@odata.id": "/redfish/v1/UpdateService/Oem/Public/FirmwareList/BMCS"

        },

        {

            "@odata.id": "/redfish/v1/UpdateService/Oem/Public/FirmwareList/BMCCPLD"

        },

        {

            "@odata.id": "/redfish/v1/UpdateService/Oem/Public/FirmwareList/CPLD1"

        },

        {

            "@odata.id": "/redfish/v1/UpdateService/Oem/Public/FirmwareList/CPLD2"

        },

        {

            "@odata.id": "/redfish/v1/UpdateService/Oem/Public/FirmwareList/BIOS"

        },

        {

            "@odata.id": "/redfish/v1/UpdateService/Oem/Public/FirmwareList/RC"

        },

        {

            "@odata.id": "/redfish/v1/UpdateService/Oem/Public/FirmwareList/ME"

        },

        {

            "@odata.id": "/redfish/v1/UpdateService/Oem/Public/FirmwareList/MICROCODE"

        },

        {

            "@odata.id": "/redfish/v1/UpdateService/Oem/Public/FirmwareList/PSU1"

        },

        {

            "@odata.id": "/redfish/v1/UpdateService/Oem/Public/FirmwareList/PSU2"

        },

        {

            "@odata.id": "/redfish/v1/UpdateService/Oem/Public/FirmwareList/PFRCPLD"

        }

    ],

    "[email protected]": 12,

    "Name": "Firmware List Collection",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-524 查询固件清单信息返回参数说明

字段

类型

字段说明

@odata.context

字符串

服务器固件清单的OData描述信息

@odata.id

字符串

服务器固件清单节点的访问路径

@odata.type

字符串

服务器固件清单集合资源类型

Members

数组

固件清单的名称

[email protected]

数值

固件清单的个数

Name

字符串

固件清单集合资源的名称

 

【修改记录】

(1)     HDM2-1.60：将固件清单名称CPLD、SCPLD改为CPLD1、CPLD2，但CPLD、SCPLD仍兼容；

 

4.7.9  查询单个固件清单信息

【功能描述】

查询单个固件清单信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/UpdateService/Oem/Public/FirmwareList/firmware_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-525 查询单个固件清单信息参数说明

参数

参数说明

取值

IP

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

firmware_id

固件名称

从查询固件清单信息中获取

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/UpdateService/Oem/Public/FirmwareList/BMCP

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#UpdateService/FirmwareList/Members/$entity",

    "@odata.id": "/redfish/v1/UpdateService/Oem/Public/FirmwareList/BMCP",

    "@odata.type": "#FirmwareList.v1_0_0.FirmwareList",

    "FirmwareName": "HDM",

    "Location": "bmc card",

    "Model": "-",

    "Name": "BMCP",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "Version": "1.12"

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-526 查询单个固件清单信息返回参数说明

字段

类型

字段说明

@odata.context

字符串

单个固件清单的OData描述信息

@odata.id

字符串

单个固件清单节点的访问路径

@odata.type

字符串

单个固件清单单个资源类型

FirmwareName

字符串

固件名称

Version

字符串

固件版本号

Location

字符串

固件所在位置

Model

字符串

器件型号

Name

字符串

固件清单单个资源的名称

 

4.7.10  查询固件安装包集合信息

【功能描述】

查询固件安装包集合信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/UpdateService/Oem/Public/InstalledPackages

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-527 查询固件安装包集合信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/UpdateService/Oem/Public/InstalledPackages

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#InstalledPackages.InstalledPackages",

    "@odata.id": "/redfish/v1/UpdateService/Oem/Public/InstalledPackages",

    "@odata.type": "#InstalledPackages.v1_0_0.InstalledPackages",

    "Name": "Installed Packages Collection",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "Packages": [

        {

            "ExternalVersion": "0.00.02",

            "Id": "2",

            "InternalVersion": "V100R001B01BBIT02",

            "Name": "Diag",

            "PackageType": "FEATURE"

        }

    ],

    "[email protected]": 1

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-528 查询固件安装包集合信息返回参数说明

字段

类型

字段说明

@odata.context

字符串

服务器固件清单的OData描述信息

@odata.id

字符串

服务器固件清单节点的访问路径

@odata.type

字符串

服务器固件清单单个资源类型

Packages

数组

安装包详细信息

Id

字符串

安装包ID

Name

字符串

安装包名称

PackageType

字符串

安装包类型： PATCH 补丁包 FEATURE 特性包

InternalVersion

字符串

内部版本号

ExternalVersion

字符串

外部版本号

[email protected]

数字

安装包个数

 

4.7.11  卸载指定固件安装包

【功能描述】

卸载指定固件安装包。

【所属权限模块】

维护诊断

【所属系统锁定类型】

固件版本锁定

【命令格式】

POST https://device_ip/redfish/v1/UpdateService/Actions/Oem/Public/UpdateService.UninstallPackage

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

  "Id": id,

  "PackageType":package_type

}

【参数说明】

表4-529 卸载指定固件安装包参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

Id

安装包的ID

通过固件安装包集合接口获取

PackageType

安装包的类型

PATCH 补丁包

FEATURE 特性包

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/UpdateService/Actions/Oem/Public/UpdateService.UninstallPackage

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

  "Id": "1",

  "PackageType":" PATCH"

}

【应答示例】

{

"Oem": {

       "Public": {

           "CompletionCode": 0,

           "Description": "Success"

       }

 },

"error": {

       "@Message.ExtendedInfo": [

           {

               "@odata.type": "#Message.v1_1_1.Message",

               "Message": "Successfully Completed Request",

               "MessageArgs": [],

               "MessageId": "Base.1.8.1.Success",

               "MessageSeverity": "OK",

               "Resolution": "None"

           }

       ],

        "code":"Base.1.8.1.Success",

        "message":"Successfully Completed Request"

    }

}

}

响应码200

【输出说明】

返回状态码200，表示操作成功。

表4-530 卸载指定固件安装包信息返回值

字段

类型

字段说明

code

字符串

指示消息注册表中特定消息ID的字符串

message

字符串

与消息注册表中的消息对应的易读的错误消息

@Message.ExtendedInfo

消息扩展信息

@odata.type

字符串

消息资源的OData描述信息

MessageId

字符串

消息ID

Message

字符串

详细信息

MessageArgs

数组

信息参数

MessageSeverity

字符串

严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical

Resolution

字符串

解决建议

 

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

(2)     HDM2-2.04：Message.ExtendedInfo前添加error节点，并且在error节点下增加code和message字段；

 

4.7.12  导出BIOS固件

【功能描述】

导出BIOS固件

【所属权限模块】

维护诊断

【命令格式】

POST

https://device_ip/redfish/v1/UpdateService/Actions/Oem/Public/UpdateService.DumpBIOS

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

远程导出

cifs或sftp

{

  "Type":"URI",                           

"Content":"cifs://username:password@ip/filename"

}

http、tftp、nfs或https

{

  "Type":"URI",

"Content":"http://ip/filename",

"ScriptName":"1.php"

}

 

【参数说明】

表4-531 导出BIOS固件参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得。

Type

导出BIOS固件方法

URI

Content

导出BIOS固件路径

见其它说明

ScriptName

字符串

通过http/https协议导出时，需指定的脚本文件的名称

 

【使用实例】

【请求样例】

POST https://192.168.188.188/redfish/v1/UpdateService/Actions/Oem/Public/UpdateService.DumpBIOS

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

  "Type":"URI",

  "Content":"nfs://192.168.8.7/Share1/aaa.bin"

}

【应答示例】

{

  "@odata.context": "/redfish/v1/$metadata#TaskCollection.TaskCollection",

  "@odata.type": "#TaskCollection.TaskCollection",

  "Members": [

    {

      "@odata.id": "/redfish/v1/TaskService/Tasks/2"

    }

  ],

  "[email protected]": 1,

  "Name": "Task Collection",

  "Oem": {

    "Public": {

      "CompletionCode": 0,

      "Description": "Success",

      "TaskUniqueID": 1678656297

    }

  }

}

响应码：202

【输出说明】

返回状态码202，表示操作成功。

表4-532 导出BIOS固件输出说明

字段

类型

字段说明

@odata.context

字符串

任务服务资源模型的OData描述信息

@odata.type

字符串

任务服务资源的类型

Name

字符串

任务集合资源的名称

[email protected]

数值

当前运行的任务数量

Members

任务列表

@odata.id

字符串

指定任务的访问路径

Oem.Public.TaskUniqueID

数值

指定任务的唯一ID

 

【修改记录】

(1)     HDM2-1.15: 请求体“Oem.Public.ScriptName”修改为“ScriptName”

 

4.8  TaskService 资源的操作

4.8.1  查询服务器当前任务服务资源的信息

【功能描述】

查询服务器当前任务服务资源的信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/TaskService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-533 查询服务器当前任务服务资源的信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/TaskService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#TaskService.TaskService",

    "@odata.id": "/redfish/v1/TaskService",

    "@odata.type": "#TaskService.v1_1_5.TaskService",

    "CompletedTaskOverWritePolicy": "Oldest",

    "DateTime": "2022-02-23T07:19:34+08:00",

    "Description": "Task Service",

    "Id": "TaskService",

    "LifeCycleEventOnTaskStateChange": false,

    "Name": "Task Service",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "ServiceEnabled": true,

    "Status": {

        "Health": "OK",

        "State": "Enabled"

    },

    "Tasks": {

        "@odata.id": "/redfish/v1/TaskService/Tasks"

    }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-534 查询服务器当前任务服务资源的信息返回参数说明

字段

类型

字段说明

@odata.context

字符串

任务服务资源模型的OData描述信息

@odata.id

字符串

指定任务资源的访问路径

@odata.type

字符串

任务服务资源的类型

Id

字符串

任务服务资源的ID

Name

字符串

指任务服务资源的名称

DateTime

字符串

系统时间

CompletedTaskOverWritePolicy

字符串

对已完成的任务的处理方法

Oldest：新任务覆盖最早的任务

LifeCycleEventOnTaskStateChange

布尔型

任务状态变化时是否上报事件

false：不上报事件

Status

对象

任务服务资源的状态，包括：

State：使能状态

Health：健康状态

ServiceEnabled

布尔型

任务服务使能状态。

Tasks

对象

@odata.id

字符串

指定任务的访问路径

 

4.8.2  查询服务器当前任务集合资源的信息

【功能描述】

查询服务器当前任务集合资源的信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/TaskService/Tasks

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-535 查询服务器当前任务集合资源的信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/TaskService/Tasks

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#TaskService/Tasks/$entity",

    "@odata.id": "/redfish/v1/TaskService/Tasks",

    "@odata.type": "#TaskCollection.TaskCollection",

    "Members": [

        {

            "@odata.id": "/redfish/v1/TaskService/Tasks/7"

        }

    ],

    "[email protected]": 1,

    "Name": "Task Collection",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "CountOfCanceledTask": 0,

            "CountOfCompletedTask": 0,

            "CountOfCurrentTask": 7,

            "CountOfDeletedTask": 0,

            "CountOfFailedTask": 0,

            "DeletedMembers": [

                {

                    "@odata.id": "/redfish/v1/TaskService/Tasks/1"

                },

                {

                    "@odata.id": "/redfish/v1/TaskService/Tasks/2"

                },

                {

                    "@odata.id": "/redfish/v1/TaskService/Tasks/3"

                },

                {

                    "@odata.id": "/redfish/v1/TaskService/Tasks/4"

                },

                {

                    "@odata.id": "/redfish/v1/TaskService/Tasks/5"

                },

                {

                    "@odata.id": "/redfish/v1/TaskService/Tasks/6"

                }

            ],

            "[email protected]": 6,

            "Description": "Success"

        }

    }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-536 查询服务器当前任务集合资源的信息返回参数说明

字段

类型

字段说明

@odata.context

字符串

任务服务资源模型的OData描述信息

@odata.id

字符串

指定任务资源的访问路径

@odata.type

字符串

任务服务资源的类型

Name

字符串

任务集合资源的名称

[email protected]

数值

当前运行的任务数量

Members

对象

@odata.id

字符串

指定任务的访问路径

Oem.Public.CountOfCanceledTask

数值

任务取消个数

Oem.Public.CountOfCompletedTask

数值

任务成功个数

Oem.Public.CountOfCurrentTask

数值

任务当前个数

Oem.Public.CountOfDeletedTask

数值

任务删除个数

Oem.Public.CountOfFailedTask

数值

任务失败个数

DeletedMembers

数组

待删除的Task

[email protected]

数值

待删除的Task数量

 

4.8.3  查询服务器指定任务资源的信息

【功能描述】

查询服务器指定任务资源的信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/TaskService/Tasks/task_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-537 查询服务器指定任务资源的信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

task_id

待查询任务的ID

可从任务集合资源中获取

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/TaskService/Tasks/7

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#TaskService/Tasks/Members/$entity",

    "@odata.id": "/redfish/v1/TaskService/Tasks/7",

    "@odata.type": "#Task.v1_5_0.Task",

    "EndTime": "",

    "Id": "7",

    "Messages": {

        "Message": "",

        "MessageArgs": [

            ""

        ],

        "MessageId": "",

        "RelatedProperties": [

            ""

        ],

        "Resolution": "",

        "Severity": "",

        "Trigger Condition": ""

    },

    "Name": "Task 7",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Upgrade management",

            "TaskDescription": "Upgrade management",

            "TaskPercentage": "70%",

            "TaskUniqueID": 1678656297

        }

    },

    "StartTime": "2022-02-23T07:22:12+08:00",

    "TaskState": "Running",

    "TaskStatus": "OK"

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-538 查询服务器指定任务资源的信息返回参数说明

字段

类型

字段说明

@odata.context

字符串

任务服务资源模型的OData描述信息

@odata.id

字符串

指定任务资源的访问路径

@odata.type

字符串

任务服务资源的类型

Id

字符串

指定任务资源的ID

Description

字符串

指定任务资源的描述信息

Name

字符串

指定任务资源的名称

TaskState

字符串

指定任务资源的状态

·     Running

·     Pending

·     Completed

·     Cancelled

·     Exception

StartTime

字符串

任务当前状态起始时间

EndTime

字符串

任务当前状态结束时间

TaskStatus

字符串

任务的运行状态

·     OK

Messages.MessageId

字符串

消息ID

Messages.RelatedProperties

数组

消息相关属性

Messages.Message

字符串

详细信息

Messages.MessageArgs

数组

信息参数

Messages.Resolution

字符串

解决建议

Messages.Severity

字符串

严重性级别

·     OK

·     Warning

·     Critical

Messages.Trigger Condition

字符串

触发条件（功能的生效方式，任务注册时输入），

如：

·     BMC Reset.

·     OS Reset.

·     OS Power Off.

·     Automatic.

·     Power Cycle.

·     PSU Reset.

·     Take Effect Immediately.

Oem.Public.TaskDescription

字符串

任务描述

Oem.Public.TaskPercentage

字符串

任务完成进度

Oem.Public.TaskUniqueID

数值

指定任务的唯一ID

 

【修改记录】

(1)     HDM2-1.56：修正文档中Messages.Trigger Condition对应字符串内容；

4.8.4  删除服务器指定任务资源

【功能描述】

删除状态为等待中任务资源

【所属权限模块】

维护诊断

【命令格式】

DELETE https://device_ip/redfish/v1/TaskService/Tasks/task_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-539 删除服务器指定任务资源参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

task_id

待查询任务的ID

可从任务集合资源中获取

 

【使用实例】

【请求样例】

DELETE https://192.168.18.18/redfish/v1/TaskService/Tasks/1

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

"Oem": {

       "Public": {

           "CompletionCode": 0,

           "Description": "Success"

       }

 },

"error": {

       "@Message.ExtendedInfo": [

           {

               "@odata.type": "#Message.v1_1_1.Message",

               "Message": "Successfully Completed Request",

               "MessageArgs": [],

               "MessageId": "Base.1.8.1.Success",

               "MessageSeverity": "OK",

               "Resolution": "None"

           }

       ],

        "code":"Base.1.8.1.Success",

        "message":"Successfully Completed Request"

    }

}

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-540 删除服务器指定任务资源信息返回值

字段

类型

字段说明

code

字符串

指示消息注册表中特定消息ID的字符串

message

字符串

与消息注册表中的消息对应的易读的错误消息

@Message.ExtendedInfo

消息扩展信息

@odata.type

字符串

消息资源的OData描述信息

MessageId

字符串

消息ID

Message

字符串

详细信息

MessageArgs

数组

信息参数

MessageSeverity

字符串

严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical

Resolution

字符串

解决建议

 

【修改记录】

(1)     HDM2-2.04：Message.ExtendedInfo前添加error节点，并且在error节点下增加code和message字段；

 

4.8.5  查询服务器定时任务列表信息

【功能描述】

查询服务器定时任务列表信息

【所属权限模块】

查询模块

【命令格式】

GET

https://device_ip/redfish/v1/TaskService/Oem/Public/TimedTasks

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-541 查询服务器定时任务列表信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/TaskService/Oem/Public/TimedTasks

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【响应样例】

{

  "@odata.context": "/redfish/v1/$metadata#TimedTasksCollection.TimedTasksCollection",

  "@odata.id": "/redfish/v1/TaskService/Oem/Public/TimedTasks", 

"@odata.type": "#TimedTasksCollection.TimedTasksCollection",

  "Id": "TimedTasksCollection",

"Name": "TimedTasksCollection",

"Members":[

{

"@odata.id": "/redfish/v1/TaskService/Oem/Public/TimedTasks/1"

},

{

"@odata.id": "/redfish/v1/TaskService/Oem/Public/TimedTasks/2"

},

……

],

"[email protected]": 2,

"Oem": {

"Public":{

            "CompletionCode": 0,

            "Description": "Success"

    }

 }

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-542 查询服务器定时任务列表信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

任务服务资源模型的OData描述信息

@odata.id

字符串

指定任务资源的访问路径

@odata.type

字符串

任务服务资源的类型

Id

字符串

任务服务资源的ID

Name

字符串

任务服务资源的名称

Members

布尔型

定时任务列表信息查询路径

[email protected]

字符串

定时任务个数

 

4.8.6  查询服务器指定定时任务信息

【功能描述】

查询服务器指定定时任务信息

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/TaskService/Oem/Public/TimedTasks/task_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-543 查询服务器指定定时任务信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

task_id

定时任务编号

由“查询服务器定时任务列表信息”接口获取

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/TaskService/Oem/Public/TimedTasks/2

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

  "@odata.context": "/redfish/v1/$metadata#TaskService.TimedTasks",

  "@odata.id": "/redfish/v1/TaskService/Oem/Public/TimedTask/2", 

"@odata.type": "#TimedTasksInstance.v1_0_0.TimedTasksInstance",

  "Id": "2",

"Name": "TimedTasks Instance",

"TaskType":"Firmware Update",

"TaskState":"Executed",

"Clock":{

    "ClockType":"Single",

    "ExecuteTime":{

                  "Year":2023,

"Month":11,

        "Day":18,

        "Hour":16,

        "Minute":44,

        "Week":null

    }

},

"TaskDescription":"Uploading Version 2.17",

"Oem": {

    "Public": {

        "CompletionCode": 0,

        "Description": "Success"

      }

}

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-544 查询指定定时任务信息输出参数说明

字段

类型

字段说明

@odata.context

字符串

任务服务资源模型的OData描述信息

@odata.id

字符串

指定任务资源的访问路径

@odata.type

字符串

任务服务资源的类型

TaskType

字符串

定时任务类型

TaskState

字符串

定时任务执行状态：

新建定时任务："New"

定时任务已执行："Completed "

定时任务执行异常："Exception "  

TaskDescription

布尔型

定时任务描述

Clock

对象

时钟

Clock.ClockType

字符串

时钟类型：

月时钟："Monthly"

周时钟："Weekly"

日时钟："Daily"

时时钟："Hourly"

分时钟："Minutely"

单次时钟："Single"

当前只支持设置单次时钟

Clock.ExecuteTime.Year

数值

年

Clock.ExecuteTime.Month

数值

月

Clock.ExecuteTime.Day

数值

日

Clock.ExecuteTime.Hour

数值

时

Clock.ExecuteTime.Minute

数值

分

Clock.ExecuteTime.Week

字符串

星期

 

4.8.7  修改服务器指定定时任务信息

【功能描述】

修改服务器指定定时任务信息。

【所属权限模块】

维护诊断

【命令格式】

PATCH https://device_ip/redfish/v1/TaskService/Oem/Public/TimedTasks/task_id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:ifmatch_value

【请求消息体】

{

"Clock":{

    "ClockType":"Single",

    "ExecuteTime":{

                  "Year":2023,

"Month":11,

        "Day":18,

        "Hour":16,

        "Minute":44,

        "Week":"Monday"

    }

}

}

【参数说明】

表4-545 修改服务器指定定时任务信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

task_id

定时任务编号

由“查询服务器定时任务列表信息”接口获取

ifmatch_value

请求消息的匹配参数

可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）

Clock.ClockType

字符串

时钟类型：

月时钟："Monthly"

周时钟："Weekly"

日时钟："Daily"

时时钟："Hourly"

分时钟："Minutely"

单次时钟："Single"

当前只支持设置单次时钟

Clock.ExecuteTime.Year

数值

年

Clock.ExecuteTime.Month

数值

月

Clock.ExecuteTime.Day

数值

日

Clock.ExecuteTime.Hour

数值

时

Clock.ExecuteTime.Minute

数值

分

Clock.ExecuteTime.Week

字符串

星期

 

【使用实例】

【请求样例】

patch https://192.168.30.151/redfish/v1/TaskService/Oem/Public/TimedTasks/2

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

    "Clock":{

        "ClockType":"Single",

        "ExecuteTime":{

            "Year":2023,

            "Month":11,

            "Day":18,

            "Hour":16,

            "Minute":44,

            "Week":"Monday"

        }

    }

}

【响应样例】

{

  "@odata.context": "/redfish/v1/$metadata#TaskService.TimedTasks",

  "@odata.id": "/redfish/v1/TaskService/TimedTasks", 

"@odata.type": "#TimedTasksInstance.v1_0_0.TimedTasksInstance",

  "Id": "2",

"Name": "TimedTasks Instance",

"TaskType":"Firmware Update",

"TaskState":"Executed",

"Clock":{

    "ClockType":"Single",

    "ExecuteTime":{

                  "Year":2023,

"Month":11,

        "Day":18,

        "Hour":16,

        "Minute":44,

        "Week":null

    }

},

"Description":"Uploading Version 2.17",

"Oem": {

   "Public": {

        "CompletionCode": 0,

        "Description": "Success"

    }

 }

}

响应码200

【输出说明】

返回状态码200，表示操作成功。

返回字段说明同【查询服务器指定定时任务信息】

 

4.9  EventService 资源操作

4.9.1  查询事件服务资源

【功能描述】

查询服务器事件服务资源。

【所属权限模块】

查询模块

【命令格式】

GET  https://device_ip/redfish/v1/EventService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-546 查询事件服务资源参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/EventService

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

    "@odata.context": "/redfish/v1/$metadata#EventService.EventService",

    "@odata.id": "/redfish/v1/EventService/",

    "@odata.type": "#EventService.v1_7_2.EventService",

    "Actions": {

        "#EventService.SubmitTestEvent": {

            "@Redfish.ActionInfo": "/redfish/v1/EventService/SubmitTestEventActionInfo",

            "target": "/redfish/v1/EventService/Actions/EventService.SubmitTestEvent"

        }

    },

    "DeliveryRetryAttempts": 1,

    "DeliveryRetryIntervalSeconds": 3,

    "Description": "Event Service",

    "EventTypesForSubscription": [

        "StatusChange",

        "ResourceUpdated",

        "ResourceAdded",

        "ResourceRemoved",

        "Alert"

    ],

    "Id": "EventService",

    "Name": "Event Service",

    "Oem": {

        "Public": {

            "CompletionCode": 0,

            "Description": "Success"

        }

    },

    "ServiceEnabled": true,

    "Status": {

        "Health": "OK",

        "State": "Enabled"

    },

    "Subscriptions": {

        "@odata.id": "/redfish/v1/EventService/Subscriptions"

    }

}

响应码：200

【输出说明】

表4-547 查询事件服务资源的返回参数说明

字段

类型

字段说明

@odata.context

字符串

EventService资源模型的OData描述信息

@odata.id

字符串

EventService资源节点的访问路径

@odata.type

字符串

EventService资源类型

Actions

EventService可执行的操作

#EventService.SubmitTestE

vent

对象

发送测试事件

@Redfish.ActionInfo

字符串

发送测试事件操作信息的查询路径

target

字符串

模拟测试事件上报的路径

DeliveryRetryAttempts

数字

指事件订阅发送失败最大尝试次数

DeliveryRetryIntervalSeconds

数字

指发送任何给定事件的重试尝试之间的秒数

Description

字符串

事件服务资源描述

EventTypesForSubscription

数组

指可以订阅的事件类型，取值为以下合法值的组合：

StatusChange：资源状态改变事件

ResourceUpdated：资源更新事件

ResourceAdded：资源添加事件

ResourceRemoved：资源移除事件

Alert：告警事件

ServiceEnabled

布尔

事件上报开关状态

Id

字符串

EventService资源的ID

Name

字符串

事件订阅资源名称

Status

对象

事件订阅资源的状态，包括：

State：使能状态

Health：健康状态

Subscriptions

对象

指事件目标资源的集合的导航资源

 

4.9.2  创建事件订阅资源

【功能描述】

创建事件订阅资源。

【所属权限模块】

常规配置

【命令格式】

POST https://device_ip/redfish/v1/EventService/Subscriptions

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

    "Destination": "https://172.16.11.95",

    "EventTypes": [

        "StatusChange",

        "ResourceUpdated",

        "ResourceAdded",

        "ResourceRemoved",

        "Alert"

    ],

    "HttpHeaders": [{

        "Content-Type": "application/json",

        "OData-Version": "4.0",

        "X-Auth-Token":"2e751b825163447d30d3021c98116221"

    }], 

    "Context": "event subscription context string",

    "Protocol":"Redfish",

    "MessageIds":[ ],

    "OriginResources":[ ]

}

【参数说明】

表4-548 创建事件订阅资源的请求参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

Destination

字符串

事件订阅接收地址

EventTypes

数组

事件订阅监听的事件类型

HttpHeaders

数组

事件订阅 HTTP 头参数，事件上报时携带。 X-Auth-Token由/redfish/v1/SessionService/Sessions创建会话时获得

Context

字符串

事件订阅上下文信息

Protocol

字符串

事件订阅使用的协议, 当前取值只能为Redfish

MessageIds

数组

事件订阅消息 Id 匹配列表

OriginResources

数组

事件订阅事件源匹配列表，填写空表示全部订阅

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/EventService/Subscriptions

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

    "Destination": "https://192.168.25.11",

    "EventTypes": [

        "StatusChange",

        "ResourceUpdated",

        "ResourceAdded",

        "ResourceRemoved",

        "Alert"

    ],

    "HttpHeaders": [{

        "Content-Type": "application/json",

        "OData-Version": "4.0",

        "X-Auth-Token":"2e751b825163447d30d3021c98116221"

    }], 

    "Context": "event subscription context string",

    "Protocol":"Redfish",

    "MessageIds": [],

          "OriginResources": [{

              "@odata.id": "/redfish/v1/Chassis/1/Thermal#/Fans"

          }

          ] 

}

【应答示例】

{

  "@odata.context": "/redfish/v1/$metadata#EventDestination.EventDestination",

  "@odata.id": "/redfish/v1/EventService/Subscriptions/5",

  "@odata.type": "#EventDestination.v1_9_0.EventDestination",

  "Context": "event subscription context string",

  "Description": "Event Subscription Instance",

  "Destination": "https://192.168.25.11",

  "EventTypes": [

    "Alert",

    "ResourceUpdated",

    "StatusChange"

  ],

  "HttpHeaders": null,

  "Id": "5",

  "MessageIds": [],

  "Name": "Event Destination 5",

  "Oem": {

    "Public": {

      "CompletionCode": 0,

      "Description": "Success"

    }

  },

  "OriginResources": [

    {

      "@odata.id": "/redfish/v1/Chassis/1/Thermal#/Fans"

    }

  ],

  "[email protected]": 1,

  "Protocol": "Redfish",

  "SubscriptionType": "RedfishEvent"

}

响应码：201

【输出说明】

返回状态码201，表示操作成功。

返回字段说明同【查询事件订阅资源信息】

 

4.9.3  查询事件订阅资源集合

【功能描述】

查询事件订阅集合资源。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/EventService/Subscriptions

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-549 查询事件订阅集合资源的参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/EventService/Subscriptions

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

  "@odata.context": "/redfish/v1/$metadata#EventDestinationCollection.EventDestinationCollection",

  "@odata.id": "/redfish/v1/EventService/Subscriptions",

  "@odata.type": "#EventDestinationCollection.EventDestinationCollection",

  "Description": "Collection for Event Subscriptions",

  "Members": [

{

            "@odata.id": "/redfish/v1/EventService/Subscriptions/1"

        },

        {

            "@odata.id": "/redfish/v1/EventService/Subscriptions/2"

        }

],

  "[email protected]": 2,

  "Name": "Event Subscriptions Collection",

  "Oem": {

    "Public": {

      "CompletionCode": 0,

      "Description": "Success"

    }

  }

}

响应码：200

【输出说明】

表4-550 查询事件订阅集合资源的返回参数说明

字段

类型

字段说明

@odata.context

字符串

事件订阅集合资源模型的OData描述信息

@odata.id

字符串

事件订阅集合资源的访问路径

@odata.type

字符串

事件订阅集合资源的类型

Name

字符串

事件订阅集合资源的名称

Description

字符串

事件订阅集合描述

[email protected]

数值

事件订阅集合资源数量

Members

事件订阅资源列表

@odata.id

字符串

单个事件订阅资源节点的访问路径

 

4.9.4  查询事件订阅资源信息

【功能描述】

查询事件订阅资源信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/EventService/Subscriptions/id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-551 查询事件订阅信息的参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

Id

事件订阅资源的ID

可从“查询事件订阅资源集合”中获取

 

【使用实例】

【请求样例】

GET https://192.168.30.151/redfish/v1/EventService/Subscriptions/5

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

  "@odata.context": "/redfish/v1/$metadata#EventDestination.EventDestination",

  "@odata.id": "/redfish/v1/EventService/Subscriptions/5",

  "@odata.type": "#EventDestination.v1_9_0.EventDestination",

  "Context": "event subscription context string",

  "Description": "Event Subscription Instance",

  "Destination": "https://192.168.25.11",

  "EventTypes": [

    "Alert",

    "ResourceUpdated",

    "StatusChange"

  ],

  "HttpHeaders": null,

  "Id": "5",

  "MessageIds": [

    "EventLog.1.0.FanEventSufficient"

  ],

  "Name": "Event Destination 5",

  "Oem": {

    "Public": {

      "CompletionCode": 0,

      "Description": "Success"

    }

  },

  "OriginResources": [

    {

      "@odata.id": "/redfish/v1/Chassis/1/Thermal#/Fans"

    }

  ],

  "[email protected]": 1,

  "Protocol": "Redfish",

  "SubscriptionType": "RedfishEvent"

}

响应码：200

【输出说明】

表4-552 查询事件订阅资源信息的返回参数说明

字段

类型

字段说明

@odata.context

字符串

事件订阅资源模型的OData描述信息

@odata.id

字符串

事件订阅资源节点的访问路径

@odata.type

字符串

事件订阅资源类型

Description

字符串

事件订阅资源的描述信息

Id

字符串

事件订阅资源的ID

Name

字符串

事件订阅资源的名称

Destination

字符串

目的地事件服务的URI

EventTypes

数组

包含将要发送到指定的事件的类型：

"ResourceRemoved"

"ResourceAdded",

"StatusChange",

"ResourceUpdated",

"Alert"

HttpHeaders

对象

事件订阅HTTP头

Protocol

字符串

事件连接的协议类型, 当前取值只能为Redfish

Context

字符串

客户端提供的与事件目标订阅一起存储的字符串

MessageIds

数组

事件消息Id匹配列表

OriginResources

数组

事件源匹配列表

[email protected]

数值

事件源数量

SubscriptionType

字符串

订阅事件的类型

 

4.9.5  修改事件订阅资源

【功能描述】

修改事件订阅资源。

【所属权限模块】

常规配置

【命令格式】

PATCH https://device_ip/redfish/v1/EventService/Subscriptions/id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match:ifmatch_value

【请求消息体】

{

  "HttpHeaders": http_headers,

"Context":"abcdefg"

}

【参数说明】

表4-553 修改事件订阅资源的信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

Id

事件订阅资源的ID

可从“查询事件订阅资源集合”中获取

ifmatch_value

请求消息的匹配参数

可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）

HttpHeaders

对象

HTTP标头信息

Context

字符串

事件订阅上下文

 

【使用实例】

【请求样例】

patch https://192.168.30.151/redfish/v1/EventService/Subscriptions/1

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

"HttpHeaders": [{

        "Content-Type": "application/json",

        "OData-Version": "4.0",

        "X-Auth-Token":"2e751b825163447d30d3021c98116221"

    }],

"Context":" Event Subscription Instance 5"

}

【应答示例】

{

  "@odata.context": "/redfish/v1/$metadata#EventDestination.EventDestination",

  "@odata.id": "/redfish/v1/EventService/Subscriptions/5",

  "@odata.type": "#EventDestination.v1_9_0.EventDestination",

  "Context": "Event Subscription Instance 5",

  "Description": "Event Subscription Instance",

  "Destination": "https://192.168.25.11",

  "EventTypes": [

    "Alert",

    "ResourceUpdated",

    "StatusChange"

  ],

  "HttpHeaders": null,

  "Id": "5",

  "MessageIds": [

    "EventLog.1.0.FanEventSufficient"

  ],

  "Name": "Event Destination 5",

  "Oem": {

    "Public": {

      "CompletionCode": 0,

      "Description": "Success"

    }

  },

  "OriginResources": [

    {

      "@odata.id": "/redfish/v1/Chassis/1/Thermal#/Fans"

    }

  ],

  "[email protected]": 1,

  "Protocol": "Redfish",

  "SubscriptionType": "RedfishEvent"

}

响应码200

【输出说明】

返回状态码200，表示操作成功。

返回字段说明同【查询事件订阅资源信息】

 

4.9.6  删除事件订阅资源

【功能描述】

删除事件订阅资源。

【所属权限模块】

常规配置

【命令格式】

DELETE https://device_ip/redfish/v1/EventService/Subscriptions/id

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-554 删除事件订阅资源的参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

Id

事件订阅资源的ID

可从“查询事件订阅资源集合”中获取

 

【使用实例】

【请求样例】

delete https://192.168.30.151/redfish/v1/EventService/Subscriptions/1

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

"Oem": {

       "Public": {

           "CompletionCode": 0,

           "Description": "Success"

       }

 },

"error": {

       "@Message.ExtendedInfo": [

           {

               "@odata.type": "#Message.v1_1_1.Message",

               "Message": "Successfully Completed Request",

               "MessageArgs": [],

               "MessageId": "Base.1.8.1.Success",

               "MessageSeverity": "OK",

               "Resolution": "None"

           }

       ],

        "code":"Base.1.8.1.Success",

        "message":"Successfully Completed Request"

    }

}

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-555 删除指定事件订阅信息输出参数说明

字段

类型

字段说明

code

字符串

指示消息注册表中特定消息ID的字符串

message

字符串

与消息注册表中的消息对应的易读的错误消息

@Message.ExtendedInfo

消息扩展信息

@odata.type

字符串

消息资源的OData描述信息

MessageId

字符串

消息ID

Message

字符串

详细信息

MessageArgs

数组

信息参数

MessageSeverity

字符串

严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical

Resolution

字符串

解决建议

 

【修改记录】

(1)     HDM2-2.04：Message.ExtendedInfo前添加error节点，并且在error节点下增加code和message字段；

 

4.9.7  故障告警上报报文示例

【功能描述】

故障告警上报报文解析。

注：非Redfish接口

【上报示例】

headers: 

  IOrderedDict([

      ('User-Agent', 'LuaSocket 3.0-rc1'),

      ('TE', 'trailers'),

      ('Content-Length', '800'),

      ('Connection', 'close, TE'),

      ('Content-Type', 'application/json'),

      ('Host', '192.168.25.11')

      ])

bodydata: 

{

  "@odata.context":"/redfish/v1/$metadata#Event.Event",

  "@odata.id":"/redfish/v1/EventService/Events/7",

  "@odata.type":"#Event.v1_6_0.Event",

  "Context":"Public",

  "Events":[{

      "EventId":"26",

      "EventTimestamp":"2020-05-08T17:58:05+08:00",

      "EventType":"Alert",

      "MemberId":"26",

      "Message":"Drive(Drive Slot/Bay): Drive fault --- Bay Slot: 0, HDD Slot: 0",

      "MessageArgs":[],

      "MessageId":"EventLog.1.0.0.Alert",

      "Oem":{

          "Public":{

              "Addinfo":"",

              "alarmStatus":"Asserted",

              "locationInfo":"Drive",

              "neName":"(none)",

              "neType":"server",

              "neUID":"210200A00QH17C000001",

              "objectName":"Drive",

              "objectType":"Drive Slot/Bay",

              "objectUID":"",

              "specificProblem":"Drive fault",

              "specificProblemID":"0x0d6f0100",

              "EventAssertedSeverity": "Major"

              }

          },

      "OriginOfCondition":{

          "@odata.id":"/redfish/v1/Chassis/1/Drives"

          },

      "Severity":"Major"

  }],

  "[email protected]":1,

  "Id":"7",

  "Name":"Event Array"

}

【输出说明】

表4-556 告警信息请求头参数说明

字段

类型

字段说明

headers

消息头描述信息

User-Agent

字符串

用户代理

TE

字符串

用户代理使用的传输编码类型

Content-Length

字符串

HTTP消息实体的传输长度

Connection

字符串

是否需要持久连接

Content-Type

字符串

MIME类型

Host

字符串

服务器的域名和端口号

说明：端口号取决于创建订阅时的目的地址

 

表4-557 接收数据说明

字段

类型

字段说明

bodydata

响应体描述信息

 

@odata.context

字符串

事件消息的OData描述信息

@odata.id

字符串

事件消息的访问路径（url中最后一级与页面显示ID保持一致）

@odata.type

字符串

事件消息的类型

Context

字符串

事件订阅上下文信息

Events

数组

事件信息

EventId

字符串

本次告警事件的ID，告警事件流水号。同一部件，同类型活动告警连续产生时的EventId相同，活动告警与已清除的告警EventId相同

EventTimestamp

字符串

事件发生时间

EventType

字符串

告警类型

l     StatusChange：资源状态改变事件

l     ResourceUpdated：资源更新事件

l     ResourceAdded：资源添加事件

l     ResourceRemoved：资源移除事件

l     Alert：告警事件

MemberId

字符串

告警消息ID，与页面显示ID保持一致

Message

字符串

告警事件或标题

MessageArgs

字符串

信息参数

MessageId

字符串

消息ID

Oem.Public.Addinfo

字符串

告警辅助信息，告警的详细描述。Key和Value之间":"分割，多个Key-Value对用";"分割。Key和Value不得包含":"和";"

Oem.Public.alarmStatus

字符串

告警状态；

Asserted：活动告警；

Deasserted：已清除的告警

Oem.Public.locationInfo

字符串

告警定位信息

Oem.Public.neName

字符串

告警服务器的名称，取值为服务器资产编码

Oem.Public.neType

字符串

告警设备的类型，取值：server

Oem.Public.neUID

字符串

告警服务器的ID，取值为服务器SerialNumber

Oem.Public.objectName

字符串

告警部件的名称

Oem.Public.objectType

字符串

告警部件的类型

Oem.Public.objectUID

字符串

告警部件的ID

Oem.Public.specificProblem

字符串

告警描述

Oem.Public.specificProblemID

字符串

告警码

Oem.Public.EventAssertedSeverity

字符串

（对应）触发告警级别：1:Critical; 2:Major; 3:Minor; 4:Warning; 5:Info;

OriginOfCondition

对象

Origin Of Condition的链接

Severity

字符串

告警级别：1:Critical; 2:Major; 3:Minor; 4:Warning; 5:Info;

[email protected]

数值

事件数量

Id

字符串

故障告警ID号，与页面显示ID保持一致

Name

字符串

故障告警上报接口名称

 

【修改记录】

(1)     HDM2-2.02：修改EventId、Oem.Public.specificProblem、Oem.Public.specificProblemID、Oem.Public.EventAssertedSeverity和Severity字段描述

 

4.9.8  模拟测试事件上报

【功能描述】

模拟测试事件上报。

【所属权限模块】

常规配置

【命令格式】

POST https://device_ip/redfish/v1/EventService/Actions/EventService.SubmitTestEvent

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

}

【参数说明】

表4-558 模拟测试事件上报资源的参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

Id

事件订阅资源的ID

可从“查询事件订阅资源集合”中获取

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/EventService/Actions/EventService.SubmitTestEvent

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

}

【应答示例】

{

"Oem": {

       "Public": {

           "CompletionCode": 0,

           "Description": "Success"

       }

 },

"error": {

       "@Message.ExtendedInfo": [

           {

               "@odata.type": "#Message.v1_1_1.Message",

               "Message": "Successfully Completed Request",

               "MessageArgs": [],

               "MessageId": "Base.1.8.1.Success",

               "MessageSeverity": "OK",

               "Resolution": "None"

           }

       ],

        "code":"Base.1.8.1.Success",

        "message":"Successfully Completed Request"

    }

}

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-559 模拟测试事件上报资源输出参数说明

字段

类型

字段说明

code

字符串

指示消息注册表中特定消息ID的字符串

message

字符串

与消息注册表中的消息对应的易读的错误消息

@Message.ExtendedInfo

消息扩展信息

@odata.type

字符串

消息资源的OData描述信息

MessageId

字符串

消息ID

Message

字符串

详细信息

MessageArgs

数组

信息参数

MessageSeverity

字符串

严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical

Resolution

字符串

解决建议

 

【修改记录】

(1)     HDM2-2.04：Message.ExtendedInfo前添加error节点，并且在error节点下增加code和message字段；

 

4.10  LicenseService资源的操作

4.10.1  查询License服务信息

【功能描述】

查询License服务信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/LicenseService

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-560 查询License服务参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/LicenseService

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

  "@odata.type": "#LicenseService.v1_0_0.LicenseService",

  "Name": "License Service",

  "ServiceEnabled": true,

  "Actions": {

      "#LicenseService.Install": {

          "target": "/redfish/v1/LicenseService/Actions/LicenseService.Install",

          "@Redfish.ActionInfo": "/redfish/v1/LicenseService/InstallActionInfo"

      },

      "Oem": {

          "Public":{

              "#LicenseService.Export": {

                  "target": "/redfish/v1/LicenseService/Actions/Oem/Public/LicenseService.Export",

                  "@Redfish.ActionInfo": "/redfish/v1/LicenseService/Oem/Public/ExportActionInfo"

              },

              "#LicenseService.Uninstall ": {

                  "target": "/redfish/v1/LicenseService/Actions/Oem/Public/LicenseService.Uninstall ",

                  "@Redfish.ActionInfo": "/redfish/v1/LicenseService/Oem/Public/ UninstallActionInfo"

              }

          }

      }

  },

  "LicenseExpirationWarningDays":10,

  "Licenses": {

      "@odata.id": "/redfish/v1/LicenseService/Licenses"

  },

  "Oem": {

      "Public": {

          "DeviceID" :"1B45F9365F95737DBA154EDE3C6C9C9A7BBC94F2",

          "CompletionCode": 0,

          "Description": "Success"

 

      }

  },

  "@odata.id": "/redfish/v1/LicenseService"

}

响应码：200

【输出说明】

表4-561 查询License服务信息输出参数说明

字段

类型

字段说明

@odata.id

字符串

License服务资源的访问路径

@odata.type

字符串

License服务资源的类型

Name

字符串

License服务名称

Actions

License服务资源可执行的操作

LicenseService.Install

对象

License证书安装

Actions.Oem.Public

License服务资源自定义可执行的操作

LicenseService.Uninstall

对象

License证书卸载

LicenseService.Export

对象

License证书导出

LicenseExpirationWarningDays

数值

证书到期前发送告警消息的时间

Licenses

对象

License证书集合资源路径

ServiceEnabled

布尔

License服务使能状态

Oem.Public.DeviceID

字符串

指定设备的DID码

 

4.10.2  查询License资源集合信息

【功能描述】

查询License资源集合信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/LicenseService/Licenses

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-562 查询License资源集合信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/LicenseService/Licenses

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

  "@odata.id": "/redfish/v1/LicenseService/Licenses",

  "@odata.type": "#LicenseCollection.LicenseCollection",

  "Name": "License Collection",

  "Members": [

        {

            "@odata.id": "/redfish/v1/LicenseService/Licenses/1"

        }

    ],

    "[email protected]": 1,

    "Oem": {

      "Public": {

            "CompletionCode": 0,

            "Description": "Success"

      }

  }

}

响应码：200

【输出说明】

表4-563 查询License资源集合信息输出参数说明

字段

类型

字段说明

@odata.id

字符串

License集合资源的访问路径

@odata.type

字符串

License集合资源的类型

Name

字符串

License集合名称

[email protected]

数值

License资源的数量

Members

任务列表

指定License资源的导航路径

 

4.10.3  查询指定License资源信息

【功能描述】

查询指定License资源信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/LicenseService/Licenses/license_id

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-564 查询指定License资源信息参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

license_id

License编号

由查询License资源集合信息获取

 

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/LicenseService/Licenses/1

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

  "@odata.id": "/redfish/v1/LicenseService/Licenses/1",

  "@odata.type": "#License.v1_0_0.License",

  "Id": "1",

  "Name": "License 1",

  "Status": {

      "State": "Enabled",

      "Health": "OK" ,

      "Oem": {

          "Public": {

              "LicenseStatus":"Using"

          }

      }

  },

  "LicenseType": "Trial",

  "SerialNumber": "1errefde1111",

  "Oem": {

      "Public": {

          "CompletionCode": 0,

          "Description": "Success",

          "LicenseRemainingHours":null,

          "LicenseTimeType":""

      }

  }

}

响应码：200

【输出说明】

表4-565 查询指定License资源信息输出参数说明

字段

类型

字段说明

@odata.id

字符串

License集合资源的访问路径

@odata.type

字符串

License集合资源的类型

Id

字符串

License资源ID

Name

字符串

License资源名称

Status

对象

指定License资源状态，包括：

·     Health：License资源健康状态

·     State：License资源使能状态：

·     LicenseStatus：License状态

·     Using  使用中

·     Expired   已过期

·     Unavailable  不可用

·     Expiring  即将过期

·     Uninstalled 已卸载

LicenseType

字符串

·     License类型

·     Trial   临时

·     Production  正式

SerialNumber

字符串

序列号

Oem.Public.LicenseRemainingHours

字符串

剩余有效时间

Oem.Public.LicenseTimeType

字符串

授权时间类型

Permanent 永久

Relative 相对时间

 

【修改记录】

(1)     HDM2-1.14：License类型中的“试用”改为“临时”

 

4.10.4  安装License激活文件

【功能描述】

安装License激活文件。

【所属权限模块】

用户配置

【所属系统锁定类型】

BMC配置锁定

【命令格式】

POST https://device_ip/redfish/v1/LicenseService/Actions/LicenseService.Install

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

1.本地导入安装

{

"Type":"URI",

"Content": "/tmp/web/Licensefiefile"

}

2.远程导入安装

cifs或sftp

{

"Type":"URI",

"Content": "sftp://username:[email protected]/usr/Licensefiefile"

}

 

http、tftp、nfs或https

{

  "Type":"URI",

"Content":"http://ip/Licensefiefile"

}

 

【参数说明】

表4-566 安装License激活文件资源属性选项参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

Type

字符串

URI

Content

LicenseFile文件路径

1、文件传输协议：sftp、https、http、nfs、cifs、tftp，

2、操作路径：不支持中文

3、长度不超过1024，特殊符号支持 @!$^&()_+.;[]{}-=~`，不支持中文

4、本地仅支持”/tmp/web/”及其子目录

5、tftp协议目录和文件名的总长度最大为240

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/LicenseService/Actions/LicenseService.Install

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"Type":"URI",

"Content": "sftp://username:[email protected]/usr/Licensefiefile.xml"

}

【应答示例】

{

  "@odata.context": "/redfish/v1/$metadata#TaskCollection.TaskCollection",

  "@odata.type": "#TaskCollection.TaskCollection",

  "Members": [

    {

      "@odata.id": "/redfish/v1/TaskService/Tasks/2"

    }

  ],

  "[email protected]": 1,

  "Name": "Task Collection",

  "Oem": {

    "Public": {

      "CompletionCode": 0,

      "Description": "Success",

      "TaskUniqueID": 1678656297

    }

  }

}

响应码：202

【输出说明】

返回状态码202，表示操作成功。

表4-567 安装License激活文件输出说明

字段

类型

字段说明

@odata.context

字符串

安装License激活文件TaskService的OData 描述信息

@odata.type

字符串

安装License激活文件TaskService的类型

@odata.id

字符串

安装License激活文件TaskService的访问路径

[email protected]

对象

安装License激活文件生成的Task链接

Oem.Public.TaskUniqueID

数值

安装License激活文件TaskService的唯一ID

 

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

 

4.10.5  导出License文件

【功能描述】

导出License激活文件/卸载文件，该接口需要配合【下载BMC文件】接口使用，先执行该接口，再执行【下载BMC文件】接口

【所属权限模块】

用户配置

【命令格式】

POST https://device_ip/redfish/v1/LicenseService/Actions/Oem/Public/LicenseService.Export

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

1.远程导出

cifs或sftp

{

  "Type":"URI",

  "Content": "sftp://username:[email protected]/usr/Licensefile",

  "LicenseFileType":"Activation"

}

nfs或tftp

{

  "Type":"URI",

  "Content":"http://ip/Licensefile",

  "LicenseFileType":"Activation"

}

http 或https

{

  "Type":"URI",

  "Content":"http://ip/Licensefile",

  "LicenseFileType":"Activation",

  "ScriptName":"1.php"

}

2. 本地导出

{

"Type":"URI",

"Content": "/tmp/web/filename",

"LicenseFileType":"Activation"

}

【参数说明】

表4-568 导出License文件操作参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

Type

字符串

URI

Content

LicenseFile文件路径

1、文件传输协议：sftp、https、http、nfs、cifs、tftp，

2、操作路径：不支持中文

3、长度不超过1024，特殊符号支持 @!$^&()_+.;[]{}-=~`，不支持中文

4、本地仅支持”/tmp/web/”及其子目录

5、tftp协议目录和文件名的总长度最大为240

注：本地导出时，该路径与【下载BMC文件】接口中的路径保持一致

LicenseFileType

字符串

Activation   激活文件

Uninstall    卸载文件

ScriptName

字符串

通过http/https协议导出时，需指定的脚本文件的名称

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/LicenseService/Actions/Oem/Public/LicenseService.Export

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

  "Type":"URI",

  "Content": "nfs://192.168.20.177/Share1/LicenseBackup.xml",

  "LicenseFileType":"Activation"

}

【应答示例】

{

  "@odata.context": "/redfish/v1/$metadata#TaskCollection.TaskCollection",

  "@odata.type": "#TaskCollection.TaskCollection",

  "Members": [

    {

      "@odata.id": "/redfish/v1/TaskService/Tasks/2"

    }

  ],

  "[email protected]": 1,

  "Name": "Task Collection",

  "Oem": {

    "Public": {

      "CompletionCode": 0,

      "Description": "Success",

      "TaskUniqueID": 1678656297

    }

  }

}

响应码：202

【输出说明】

返回状态码202，表示操作成功。

表4-569 导出License激活文件输出说明

字段

类型

字段说明

@odata.context

字符串

导出License激活文件TaskService的OData 描述信息

@odata.type

字符串

导出License激活文件TaskService的类型

@odata.id

字符串

导出License激活文件TaskService的访问路径

[email protected]

对象

导出License激活文件生成的Task链接

Oem.Public.TaskUniqueID

数值

导出License激活文件TaskService的唯一ID

 

4.10.6  卸载Licnese激活文件

【功能描述】

卸载已安装的激活文件。

【所属权限模块】

用户配置

【所属系统锁定类型】

BMC配置锁定

【命令格式】

POST https://device_ip/redfish/v1/LicenseService/Actions/Oem/Public/LicenseService. Uninstall

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

}

【参数说明】

表4-570 卸载Licnese激活文件操作参数说明

参数

参数说明

取值

device_ip

登录设备的IP地址

IPv4或IPv6

TOKEN

请求消息的认证令牌

由/redfish/v1/SessionService/Sessions创建会话时获得

 

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/LicenseService/Actions/Oem/Public/LicenseService.Uninstall

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

}

【应答示例】

{

"Oem": {

       "Public": {

           "CompletionCode": 0,

           "Description": "Success"

       }

 },

"error": {

       "@Message.ExtendedInfo": [

           {

               "@odata.type": "#Message.v1_1_1.Message",

               "Message": "Successfully Completed Request",

               "MessageArgs": [],

               "MessageId": "Base.1.8.1.Success",

               "MessageSeverity": "OK",

               "Resolution": "None"

           }

       ],

        "code":"Base.1.8.1.Success",

        "message":"Successfully Completed Request"

    }

}

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-571 卸载Licnese激活文件输出说明

字段

类型

字段说明

code

字符串

指示消息注册表中特定消息ID的字符串

message

字符串

与消息注册表中的消息对应的易读的错误消息

@Message.ExtendedInfo

消息扩展信息

@odata.type

字符串

消息资源的OData描述信息

MessageId

字符串

消息ID

Message

字符串

详细信息

MessageArgs

数组

信息参数

MessageSeverity

字符串

严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical

Resolution

字符串

解决建议

 

【修改记录】

(1)     HDM2-1.53：添加所属系统锁定类型；

(2)     HDM2-2.04：Message.ExtendedInfo前添加error节点，并且在error节点下增加code和message字段；

 

5 使用案例

5.1  使用postman查询当前根服务资源信息

步骤1：使用postman新建request，并选择请求动作

 

步骤2：输入Redfish接口的URL

 

步骤3：认证类型选择Basic Auth

 

步骤4：输入HDM的用户名和密码

 

步骤5：点击Send按钮发送Redfish接口请求

 

6 附录

6.1  查询参数

客户端在进行GET操作时可以添加查询参数，以便能够从服务端快捷地获取目标资源信息，支持的查询参数如表6-1所示，未实现的查询参数返回501。

表6-1 查询参数列表

查询参数

描述

例子

$skip

整数：表示在开始检索第一个资源之前需要跳过的资源集合中的成员数量。

http://resourcecollection?$skip=5

$top

整数：表示在响应中需要包括的成员数量，最小值为1，默认行为是返回资源集合中的所有成员。

http://resourcecollection?$top=30

$expand

根据expand的值，扩展当前响应中的超链接资源。

http://resource?$expand=*($levels=1)

$select

查询字段的列表

https://resource?$select=Id

 

6.1.2  筛选和分页显示（$skip, $top）

【命令功能】

本命令适用于包含多个成员的集合资源的查询，当“GET”操作的回显信息中包含的成员过多时，您可以使用Redfish提供筛选和分页显示功能，实现便捷查找。

【命令格式】

操作类型：GET

URL：https://device_ip/redfish/v1/Managers/1/LogServices/?$skip=skip_num&$top=top_num

或

URL：https://device_ip/redfish/v1/Managers/1/LogServices/?$top=top_num&$skip=skip_num

或

URL：https://device_ip/redfish/v1/Managers/1/LogServices/?$skip=skip_num

或

URL：https://device_ip/redfish/v1/Managers/1/LogServices/?$top=top_num

 

6.1.3  扩展超链接显示（$expand）

【命令功能】

本命令适用于包含超链接的资源的查询操作，当GET操作的回显信息中包含特殊要求的超链接资源时，可以展开这种超链接，即将超链接指向的资源信息包含在本次请求中。“$expand”参数可以在不知道资源的链接时，减少请求次数。可以展开的特殊超链接必须满足以下条件：

某个属性值为JSON对象，且这种JSON对象仅包含一个属性名称为“@odata_id”，属性值为有效的超链接；

某个属性值为JSON对象类型的集合，且这种JSON对象仅包含一个属性名称为“@odata_id”，属性值为有效的超链接；

当前仅支持扩展一层超链接，即不扩展超链接展开信息中的下一层超链接。此外，“$expand”参数可以与上节的“$skip”、“$top”参数混合使用。

示例：GET

URL：https://device_ip/redfish/v1/Chassis?$expand=*($levels=levels_num)

或

URL：https://device_ip/redfish/v1/Chassis/?$top=top_num&$skip=skip_num&$expand=*($levels=levels_num)

6.1.4  查询字段的列表（$select）

【命令功能】

本命令适用于查询操作，能够筛选你想要的信息。

【命令格式】

操作类型：GET

下面url仅仅想返回查询全部信息的Id属性

https://IP/redfish/v1/Chassis/1/PCIeDevices/2?$select=Id

下面url仅仅想返回查询全部信息的Links字段下的Chassis属性

https://IP/redfish/v1/Chassis/1/PCIeDevices/2?$select=Links/Chassis

新华三官网
联系我们