T/CESA 1220-2022 服务器管理北向接口技术要求

ICS35.020

CCSL62

团体标准

T/CESA1220—2022

服务器管理北向接口技术要求

Technicalrequirementforsevermanagementnorthboundinterface

2022-07-21发布2022-08-20实施

中国电子工业标准化技术协会发布

T/CESA1220—2022

目  次

前言.......................................................................................................................................................................Ⅲ

1范围.....................................................................................................................................................................1

2规范性引用文件.................................................................................................................................................1

3术语和定义.........................................................................................................................................................1

4缩略语.................................................................................................................................................................1

5系统概述.............................................................................................................................................................1

5.1系统概述.....................................................................................................................................................2

6总体要求.............................................................................................................................................................2

6.1公共固定资源.............................................................................................................................................3

6.2Systems资源..............................................................................................................................................6

6.3Chassis资源............................................................................................................................................25

6.4Managers资源..........................................................................................................................................41

6.5EventService资源..................................................................................................................................56

6.6TaskService资源....................................................................................................................................63

6.7UpdateService资源................................................................................................................................65

6.8AccountService资源..............................................................................................................................68

II

T/CESA1220—2022

前  言

本文件按照GB/T1.1—2020《标准化工作导则第1部分：标准化文件的结构和起草规则》的规定

起草。

请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别专利的责任。

本文件由中国电子技术标准化研究院提出。

本文件由中国电子技术标准化研究院、中国电子工业标准化技术协会归口。

本文件起草单位：中国电子技术标准化研究院、华为技术有限公司、阿里云计算有限公司、联想集

团、中电科技（北京）股份有限公司、新华三技术有限公司、南京百敖软件有限公司、浪潮电子信息产

业股份有限公司、飞腾信息技术有限公司、中国长城科技集团股份有限公司、同方股份有限公司、武汉

长江计算科技有限公司。

本文件主要起草人：李雪莲、陈颖、钟伟军、任翔、赵鑫、尹航、杜晓东、聂永丰、李志兵、梁卫、

李有为、雷鸣、陈小春、王亚洲、刘如冰、张俊、汪涛、张伦、班华堂、刘宝阳、舒奕棋、王敏、黎建

根、方小明、耿成山、杨蔚才、戴权、戴冬艳。

III

T/CESA1220-2022

服务器管理北向接口技术要求

1范围

本文件规定了服务器管理北向接口的基本技术要求。

本文件适用于服务器产品BMC的规划、设计，可作为测试、选型及验收的依据。

2规范性引用文件

下列文件中的内容通过文中的规范性引用而构成本文件必不可少的条款。其中，注日期的引用文

件，仅该日期对应的版本适用于本文件；不注日期的引用文件，其最新版本（包括所有的修改单）适

用于本文件。

DSP0266RedfishSpecificationVersion1.11.0

DSP8010RedfishSchemaBundleVersion2020.1

3术语和定义

下列术语和定义适用于本文件。

3.1

Redfish协议RedfishProtocol

Redfish是一种基于HTTPs服务的管理标准，利用RESTful接口实现设备管理。每个HTTPs都以

UTF-8编码的JSON的形式，提交或返回一个资源。

3.2

RESTful架构RESTfulArchitecture

REST是一组架构约束条件和原则。RESTful架构是满足这些约束条件和原则的应用程序或设计的架

构。

4缩略语

下列缩略语适用于本文件。

BIOS：基本输入输出系统（BasicInputOutputSystem）

BMC：基板管理控制器（BaseboardManagementController）

DHCP：动态主机设置协议（DynamicHostConfigurationProtocol）

DMTF：分布式管理任务组（DistributedManagementTaskForce）

OData：开放数据协议（OpenDataProtocol）

SNMP：简单网络管理协议（SimpleNetworkManagementProtocol）

REST：表现层状态转换（RepresentationalStateTransfer）

5系统概述

1

T/CESA1220-2022

5.1系统概述

服务器系统管理的主要功能包括：硬件信息管理、配置管理、本地和远程诊断、控制台支持和故障

排除。一般分为带外管理和带内管理两部分：带外管理主要是基于BMC。BMC是服务器硬件管理的核

心部件，提供远程管理、监控和诊断等核心功能，对数据中心高效运维起到重要作用。带内管理是通过

特定管理软件和BMC配合提供更强的管理能力。同时系统管理还提供能耗管理、及服务器的安全基础

能力等。

本文件将完整的定义服务器系统管理北向接口Redfish的技术要求，包括信息采集、监控、配置、

更新、安全、性能等各个方面的要求。本标准考虑服务器产品的能力发展水平，并吸收、借鉴国际主流

标准、技术规范。

6总体要求

系统管理北向接口Redfish将利用通用的互联网和Web服务标准，利用RESTful接口实现设备管理。

每个HTTPs都以UTF-8编码的JSON的形式，提交或返回一个资源。就像Web应用程序向浏览器返回

HTML一样，RESTful接口会通过同样的传输机制(HTTPS)，以JSON的形式向客户端返回数据。相比之

前的技术，它们易于实施、易于使用而且提供了可扩展性优势。

DMTF标准组织定义了Redfish的系统管理接口，它按照Restful接口规范定义了数据中心管理接口

以及数据模型。当前，整个互联网正逐渐向通用的新软件接口模式发展，Redfish无疑契合了这一趋势。

Redfish的同一个数据模型既可以用于传统机架服务器、刀片，也可以用于新型系统。此优势源自于数

据模型对于被管对象的抽象，并以元数据的方式用来向客户端自我描述，从一开始便为将来的扩展预留

了足够空间。

本文档扩展了Redfish可扩展平台管理的接口，并基于服务器的管理需求对Redfish接口的要求实

施了细化。为服务器的管理定义了一个全面的RestfulAPI，可解决服务器管理常见的运维和业务问题，

如：

a)资产信息收集；

b)配置和部署；

c)设备监控；

d)设备更新；

e)用户和安全管理；

f)事件和日志管理；

g)资源使用度量。

扩展规则：厂商在本文件基础上扩展自定义要求时，扩展机制遵从DSP0266Redfish

Specification11.8章节“扩展标准资源”的规定。本文件没有规定的技术要求，厂商可以遵从Redfish相

关标准的定义。

认证方式：本文件的鉴权方式支持HTTPBasicauthentication和Redfishsessionloginauthentication，

当访问任意需要鉴权的RedfishURL时，使用HTTPBasicauthentication方式，可以代替请求头中

X-Auth-Token参数。

返回结果：对于请求无法查询到或不支持的资源，在响应消息中不用返回该资源数据。

请求头说明见表1。

2

T/CESA1220-2022

表1版本信息根服务资源信息

请求头说明

If-Match为确保客户端从已知状态更新资源，对于服务返回ETags的资源的PATCH请求必须支持If-Match

X-Auth-Token对用户会话进行身份验证。如果服务支持此请求头，客户端可以在不建立会话的情况下访问非安全资源

6.1公共固定资源

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

命令功能：查询当前使用的Redfish协议的版本号。

命令格式：类型为GET，URL:https://device_ip/redfish

属性说明见表2。

表2版本信息根服务资源信息

字段类型说明

v1字符串Redfish版本信息

6.1.2查询服务器根服务资源

命令功能：查询服务器当前根服务资源。

命令格式：类型为GET，URL:https://device_ip/redfish/v1。

属性说明见表3。

表3根服务资源信息

字段类型说明

@odata.context字符串根服务资源模型的OData描述信息

@odata.id字符串根服务资源节点的访问路径

@odata.type字符串根服务资源类型

Id字符串根服务资源的ID

Name字符串根服务资源的名称

RedfishVersion字符串Redfish的详细版本信息

UUID字符串设备的全局唯一标识符

Systems对象系统资源

Chassis对象机箱资源

对象管理资源

Managers

Tasks对象任务服务资源

SessionService对象会话服务资源

3

T/CESA1220-2022

表3根服务资源信息（续）

字段类型说明

AccountService对象账户服务资源

EventService对象事件服务资源

Links.Sessions对象会话集合资源

UpdateService对象更新服务资源

Registries对象消息归档资源

JsonSchemas对象数组格式的模板资源

6.1.3查询OData服务文档

命令功能：查询OData服务文档。

命令格式：类型为GET，URL:https://device_ip/redfish/v1/odata。

属性说明见表4。

表4文档资源信息

字段类型说明

@odata.context字符串OData服务文档资源模型的OData描

述信息

ValueOData服务文档资源列表

name字符串OData服务文档资源名称

kind字符串OData服务文档资源类型

url字符串OData服务文档资源访问路径

6.1.4查询Metadata文档

命令功能：查询Redfish规范里的元数据文档。

命令格式：类型为GET，URL:https://device_ip/redfish/v1/$metadata。

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

命令功能：查询服务器当前所有资源的Schema文件。

命令格式：类型为GET，URL:https://device_ip/redfish/v1/JsonSchemas。

属性说明见表5。

4

T/CESA1220-2022

表5查询所有资源的Schema文件资源信息

字段类型说明

@odata.context字符串Schemas资源模型的OData描述信息

@odata.id字符串Schemas资源节点的访问路径

@odata.type字符串Schemas资源的类型

Name字符串Schemas资源的名称

Members@odata.count数字当前Schemas资源的数量

MembersSchemas资源列表

@odata.id字符串单个Schemas资源节点的访问路径

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

命令功能：查询服务器当前所有的归档文件资源。

命令格式：类型为GET，URL:https://device_ip/redfish/v1/Registries。

属性说明见表6。

表6查询所有归档资源信息

字段类型说明

@odata.context字符串消息归档资源模型的OData描述信息

@odata.id字符串消息归档资源节点的访问路径

@odata.type字符串消息归档资源类型

Name字符串消息归档资源的名称

Description字符串消息归档资源的描述信息

Members@odata.count数字消息归档资源包含的扩展资源数

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

@odata.id字符串扩展资源的访问路径

6.1.7查询单个归档资源

命令功能：查询服务器当前具体的消息归档文件资源。

命令格式：类型为GET，URL:https://device_ip/redfish/v1/Registries/registries_id。

属性说明见表7。

表7消息归档资源信息

字段类型说明

@odata.context字符串消息归档资源模型的OData描述信息

@odata.id字符串消息归档资源节点的访问路径

@odata.type字符串消息归档资源类型

5

T/CESA1220-2022

表7消息归档资源信息（续）

字段类型说明

Name字符串消息归档资源的名称

Description字符串消息归档资源的描述信息

Languages数组可用模式的语言代码

Registry字符串归档文件名称，主要和次要版本的值

Location数组

Language字符串模式所在文件的语言代码

Uri字符串链接到本地可用的模式URI

PublicationUri字符串链接到公开可用（规范）URI的模式

6.2Systems资源

6.2.1查询系统集合资源的信息

命令功能：查询服务器当前系统集合资源的信息。

命令格式：类型为GET，URL：https://device_ip/redfish/v1/Systems。

属性说明见表8。

表8系统集合资源信息

字段类型说明

@odata.context字符串系统集合资源模型的OData描述信息

@odata.id字符串系统集合资源的访问路径

@odata.type字符串系统集合资源的类型

Name字符串系统集合资源的名称

Members@odata.count数字当前系统资源数量

Members系统资源列表

@odata.id字符串单个系统资源节点的访问路径

6.2.2查询指定系统资源信息

命令功能：查询服务器指定系统资源信息。

注意：查询BIOS配置信息时，查询的是BIOS配置项实时生效信息。

命令格式：类型为GET，URL：https://device_ip/redfish/v1/Systems/system_id。

属性说明见表9。

6

T/CESA1220-2022

表9系统资源信息

字段类型说明

@odata.context字符串指定系统资源模型的OData描述信息

@odata.id字符串指定系统资源的访问路径

@odata.type字符串指定系统资源的类型

Id字符串指定系统资源的ID

Name字符串指定系统资源的名称

AssetTag字符串指定系统资源的资产标签

Manufacturer字符串指定系统资源的制造商

Model字符串指定系统资源的型号

SerialNumber字符串指定系统资源的序列号

UUID字符串指定系统资源的全球唯一标识

HostName字符串指定系统资源的主机名

PartNumber字符串指定系统资源的部件号

HostingRole对象指定系统资源的主机角色，包括：

ApplicationServer

Switch

StorageServer

Status对象指定系统资源的状态，包括：

Health：系统资源健康状态

State：系统资源使能状态

PowerState字符串指定系统资源的上电状态，包括：

On，Off

Boot指定系统资源的启动参数

BootSourceOverrideTarget字符串系统的当前启动设备

BootSourceOverrideEnabled字符串系统启动参数的使能状态，包括：

Disabled：不生效

Once：仅生效一次，即下次重启时生

效

Continuous：永久有效

BootSourceOverrideMode字符串系统启动模式，包括：

Legacy、UEFI

BootSourceOverrideTarget@Redfish.All数组Redfish定义的启动设备，包括：

owableValuesNone、Pxe、Floppy、Cd、Usb、Hdd、

BiosSetup

TrustedModules指定系统资源的可信模块数组

FirmwareVersion字符串可信模块的固件版本

InterfaceType字符串可信模块的接口类型，包括：

TPM1_2、TPM2_0、TCM1_0

Status对象可信模块的健康状态

7

T/CESA1220-2022

表9系统资源信息（续）

字段类型说明

BiosVersion字符串指定系统资源的BIOS版本

ProcessorSummary指定系统资源的CPU信息

Count数字CPU个数

Model字符串CPU型号

Status对象CPU健康状态

MemorySummary指定系统资源的内存信息

TotalSystemMemoryGiB数字系统总内存容量，单位为GB

Status对象内存健康状态

Processors对象处理器资源节点的访问路径

Memory对象内存资源节点的访问路径

EthernetInterfaces对象主机网卡资源节点的访问路径

Storage对象存储资源节点的访问路径

NetworkInterfaces对象网络接口资源节点的访问路径

LogServices对象日志服务资源节点的访问路径

PCIeDevices对象PCIe设备资源节点的访问路径

PCIeFunctions对象PCIe功能资源节点的访问路径

Bios对象Bios资源节点的访问路径

Actions