ResourceDefinition

uris

/redfish/v1/Managers/manager_id/SmsService

properties

名称	类型	是否只读	取值范围/枚举值	说明
@odata.context	string	true	-	SMS资源模型的OData描述信息
@odata.id	string	true	-	SMS资源的访问路径
@odata.type	string	true	-	SMS资源的类型
Name	string	true	-	SMS资源的名称
Id	string	true	-	SMS资源的ID
BobService {	object	true	-	Bob服务信息
BobService.MappingTable [ {	array	true	-	Bob服务的映射表
BobService.MappingTable[].ServerAddress	string	true	-	Trap服务器ip
BobService.MappingTable[].ServerPort	number	true	-	Trap服务器端口
BobService.MappingTable[].VethPort	number	true	-	带内使能时BMA veth端口
BobService.MappingTable[].Enabled	boolean	true	-	是否启用trap功能
BobService.MappingTable[].BobEnabled	boolean	true	-	是否启用带内转发
BobService.MappingTable[].Id	number	true	-	SMS资源的ID
} ]
BobService.MaxPort	number	false	-	BMA veth最大端口号
BobService.MinPort	number	false	-	BMA veth最小端口号
BobService.AlarmState	boolean	false	-	BOB告警状态 ● true: 有告警 ● false：无告警说明该告警由BMA上报产生，用于指示BMA根据trap映射表建立带内转发通道是否成功
BobService.AlarmDesc	string	false	-	BOB告警描述说明该告警描述由BMA上报产生
}
CdevChannelEnabled	boolean	false	-	带内字符设备通道使能状态 ● true: 使能 ● false: 禁用
VethDriverEnabled	boolean	false	-	带内虚拟网口通道使能状态 ● true: 使能 ● false: 禁用
ChannelType	string	false	-	BOB通道类型 ● PCIe-Veth：虚拟网卡 ● PCIe-Cdev：字符设备 ● USB-Linux：USB通道（Linux系统）
Actions {	object	true	-	SMS组密钥导入操作
Actions.#SmsService.RefreshInstallableBma {	object	true	-	刷新可安装的BMA
`Actions.#SmsService.RefreshInstallableBma.@Redfish.ActionInfo`	string	true	-	操作信息查询路径
Actions.#SmsService.RefreshInstallableBma.target	string	true	-	操作路径
}
}
Mode	string	false	-	BMC veth网口黑白名单模式：WhiteList：仅允许WhiteListPorts中配置的端口访问 BlackList：允许不在BlackListPorts中配置的端口访问说明：只有Mode对应的端口会生效
BlackListPorts[ ]	array	true	-	端口黑名单，仅拒绝veth指定的端口，其他所有端口自动允许，为空时表示所有端口允许取值范围1~65535，最多设置50个端口
WhiteListPorts[ ]	array	true	-	端口白名单，仅允许veth指定的端口通过，其他所有端口自动拒绝，为空时表示所有端口拒绝取值范围1~65535，最多设置50个端口

supported_methods

GET
PATCH
POST

HTTP methods

GET

命令功能

查询 SMS 服务资源信息

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/SmsService

请求头:

text

X-Auth-Token: auth_value

请求消息体: 无

参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6地址
auth_value	请求消息的鉴权参数	可通过/redfish/v1/SessionService/Sessions创建会话时获得

使用指南

无

使用实例

请求样例： GET https://device_ip/redfish/v1/Managers/manager_id/SmsService

X-Auth-Token: auth_value 请求消息体：无

响应样例：

json

{
"@odata.context": "/redfish/v1/$metadata#HwSmsService.HwSmsService",
"@odata.id": "/redfish/v1/Managers/1/SmsService",
"@odata.type": "#HwSmsService.v1_0_0.HwSmsService",
"Name": "SmsService",
"Id": "SmsService",
"BobService": {
"MappingTable": [
{
"Id": 0,
"ServerAddress": "",
"ServerPort": 162,
"VethPort": 30000,
"Enabled": false,
"BobEnabled": false
},
{
"Id": 1,
"ServerAddress": "",
"ServerPort": 162,
"VethPort": 30001,
"Enabled": false,
"BobEnabled": false
},
{
"Id": 2,
"ServerAddress": "",
"ServerPort": 162,
"VethPort": 30002,
"Enabled": false,
"BobEnabled": false
},
{
"Id": 3,
"ServerAddress": "",
"ServerPort": 162,
"VethPort": 30003,
"Enabled": false,
"BobEnabled": false
}
],
"MaxPort": 30015,
"MinPort": 30000,
"AlarmState": false,
"AlarmDesc": ""
},
"VethDriverEnabled": true,
"CdevChannelEnabled": true,
"ChannelType": "PCIe-Veth",
"Actions": {
"#SmsService.RefreshInstallableBma": {
"target": "/redfish/v1/Managers/1/SmsService/Actions/SmsService.RefreshInstallableBma",
"@Redfish.ActionInfo": "/redfish/v1/Managers/1/SmsService/RefreshInstallableBmaActionInfo"
}
}
}

响应码：200

PATCH

命令功能

修改 SMS 服务资源信息

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/SmsService

请求头:

text

X-Auth-Token: auth_value
Content-Type: header_type
If-Match: ifmatch_value

请求消息体:

json

{
"BobService": {
"AlarmState": AlarmState_value,
"AlarmDesc": AlarmDesc_value,
"MaxPort": MaxPort_value,
"MinPort": MinPort_value,
"VethDriverEnabled": vethDriver_Enabled,
"CdevChannelEnabled": cdevChannel_enabled,
"ChannelType": ChannelType_value
}
}

请求头参数说明

参见请求头参数说明

请求体参数说明

参数	参数说明	取值
AlarmState	BOB告警状态	● true：有告警 ● false：无告警
AlarmDesc	BOB告警描述	告警描述
MaxPort	BMA veth最大端口号	取值范围：1 ~ 65535说明最大端口号与最小端口号的差值需大于14，比如MinPort_value为20，MaxPort需要大于等于35
MinPort	BMA veth最小端口号	取值范围：1 ~ 65535说明最大端口号与最小端口号的差值需大于14，比如MaxPort_value为35，MinPort需要小于等于20
CdevChannelEnabled	带内字符设备通道使能状态	● true：使能 ● false：禁用说明只能通过带外网络通道来打开字符设备通道使能
VethDriverEnabled	虚拟网口通道使能状态	● true：使能 ● false：禁用说明只能通过带外网络通道来打开虚拟网口通道使能，在关闭通道使能再打开通道使能需要重启BMA服务来恢复，卸载veth驱动之后BMC无法与BMA建立连接，无法进行带内通信
ChannelType	BOB通道	● PCIe-Veth：虚拟网卡 ● PCIe-Cdev：字符设备 ● USB-Linux：USB通道（Linux系统）

使用指南

无

使用实例

请求样例： PATCH https://device_ip/redfish/v1/Managers/manager_id/SmsService

X-Auth-Token: auth_value Content-Type: header_type If-Match: ifmatch_value 请求消息体：

json

{
"BobService": {
"AlarmState": AlarmState_value,
"AlarmDesc": AlarmDesc_value,
"MaxPort": MaxPort_value,
"MinPort": MinPort_value,
"VethDriverEnabled": vethDriver_Enabled,
"CdevChannelEnabled": cdevChannel_enabled,
"ChannelType": ChannelType_value
}
}

响应样例：

json

{
"@odata.context": "/redfish/v1/$metadata#HwSmsService.HwSmsService",
"@odata.id": "/redfish/v1/Managers/1/SmsService",
"@odata.type": "#HwSmsService.v1_0_0.HwSmsService",
"Name": "SmsService",
"Id": "SmsService",
"BobService": {
"MappingTable": [
{
"Id": 0,
"ServerAddress": "",
"ServerPort": 162,
"VethPort": 30000,
"Enabled": false,
"BobEnabled": false
},
{
"Id": 1,
"ServerAddress": "",
"ServerPort": 162,
"VethPort": 30001,
"Enabled": false,
"BobEnabled": false
},
{
"Id": 2,
"ServerAddress": "",
"ServerPort": 162,
"VethPort": 30002,
"Enabled": false,
"BobEnabled": false
},
{
"Id": 3,
"ServerAddress": "",
"ServerPort": 162,
"VethPort": 30003,
"Enabled": false,
"BobEnabled": false
}
],
"MaxPort": 30015,
"MinPort": 30000,
"AlarmState": false,
"AlarmDesc": "hello word"
},
"VethDriverEnabled": false,
"CdevChannelEnabled": false,
"ChannelType": "PCIe-Veth",
"Actions": {
"#SmsService.RefreshInstallableBma": {
"target": "/redfish/v1/Managers/1/SmsService/Actions/SmsService.RefreshInstallableBma",
"@Redfish.ActionInfo": "/redfish/v1/Managers/1/SmsService/RefreshInstallableBmaActionInfo"
}
}
}

响应码：200

POST (ACTION)

RefreshInstallableBma

命令功能

刷新可安装的 BMA

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/SmsService/Actions/SmsService.RefreshInstallableBma

请求头:

text

X-Auth-Token: auth_value
Content-Type: header_type

请求消息体:

json

{
"Mode": mode_value,
"ImageURI": ImageURI_value,
"SignatureURI": SignatureURI_value,
"CrlURI": CrlURI_value
}

请求头参数说明

参见请求头参数说明

请求体参数说明

参数	参数说明	取值
mode_value	工作模式	支持的取值包括： ● Delete：删除模式 ● Upgrade: 升级模式
ImageURI_value	升级包地址	URL地址（支持的文件传输的协议有https、sftp、nfs、cifs、scp）：sftp:// username:password@10.1 0.10.191/usr/image.tar.gz说明文件名不能超过200个字符, 若模式为升级模式时必须传入此参数。
SignatureURI_value	升级包数字签名地址	URL地址（支持的文件传输的协议有https、sftp、nfs、cifs、scp）: sftp:// username:password@10.1 0.10.191/usr/image.tar.gz.cms说明文件名不能超过200个字符，若模式为升级模式时必须传入此参数。
CrlURI_value	升级包CRL文件地址	URL地址（支持的文件传输的协议有https、sftp、nfs、cifs、scp）: sftp:// username:password@10.1 0.10.191/usr/image.tar.gz.crl说明文件名不能超过200个字符，若模式为升级模式时必须传入此参数。

使用指南

openUBMC 25.12 LTS及以上版本支持此功能。 GA140C机型不支持

使用实例

请求样例： POST https://device_ip/redfish/v1/Managers/manager_id/SmsService/Actions/SmsService.RefreshInstallableBma

X-Auth-Token: auth_value Content-Type: header_type 请求消息体：

json

{
"Mode": mode_value,
"ImageURI": ImageURI_value,
"SignatureURI": SignatureURI_value,
"CrlURI": CrlURI_value
}

响应码：200

ResourceDefinition ​

uris ​

properties ​

supported_methods ​

HTTP methods ​

GET ​

PATCH ​

POST (ACTION) ​

RefreshInstallableBma ​

ResourceDefinition

uris

properties

supported_methods

HTTP methods

GET

PATCH

POST (ACTION)

RefreshInstallableBma