【已评审】Syslog支持RELP资源协作接口和北向接口评审

Interface SIG
1

ISSUE链接

背景

Syslog RELP（Reliable Event Logging Protocol）是一种可靠的日志传输协议，基于TCP协议，保证数据可靠性传输。

决策点

1、web rest接口/UI/Rest/GenericInfo新增Syslog属性

详细描述：
uri：/UI/Rest/GenericInfo
变化类型：新增属性
操作类型： GET

属性名称 取值类型 取值范围 默认值 说明
Syslog 对象 - - 用于webui对syslog功能进行裁剪判断，示例：
“Syslog”: {
“ProtocolSupported” {
“TLS”: true,
“TCP”: true,
“UDP”: true,
“RELP”: false}
}，包含的属性如下
ProtocolSupported 对象 - - webui显示支持的协议
TLS 布尔值 true/false true webui是否显示TLS协议
TCP 布尔值 true/false true webui是否显示TCP协议
UDP 布尔值 true/false true webui是否显示UDP协议
RELP 布尔值 true/false false webui是否显示RELP协议，默认不显示

2、资源协作接口新增RELPSupported、RELPEnabled属性

path：/bmc/kepler/Managers/1/Syslog
interface：bmc.kepler.Managers.Syslog

属性名称 变化类型 签名 读写&权限 持久化 变化通知 接口说明 接口约束
RELPSupported 新增属性 b 读写
read: ReadOnly
write: SecurityMgmt		 不持久化 false 是否支持RELP协议
RELPEnabled 新增属性 b 读写
read: ReadOnly
write: SecurityMgmt		 掉电持久化（PoweroffPer） false 是否使能RELP协议

说明：
1、RELPSupported属性由客户组件启动阶段对该属性进行设置，从而供webui进行功能裁剪判断；
2、RELPEnabled属性用于对接北向接口获取syslog传输协议；

3、北向接口新增新增RELP取值项

1）web rest接口TransmissionProtocol新增RELP取值项

uri：/UI/Rest/Maintenance/SyslogNotification
变化类型：新增属性取值
操作类型： GET/PATCH

属性名称 取值类型 取值范围 默认值 说明
TransmissionProtocol string syslog传输协议：
1）TLS协议
2）TCP协议
3）UDP协议
4）RELP协议（新增）		 TLS 1、该属性映射后端资源协助接口Protocol和RELPEnabled属性
2、处理时需要结合资源协作接口RELPEnabled属性综合判断：
a）查询场景：如果RELPEnabled为true，则返回RELP，否则从资源协作接口Protocol获取对应取值
b）设置场景：如果用户下发RELP，则将资源协作接口RELPEnabled设置为true，如果下发其他值，则对资源协作接口Protocol进行设置（同时修改RELPEnabled为false，以便查询时从Protocol获取）
2）redfish接口TransmissionProtocol新增RELP取值项

uri：/redfish/v1/Managers/1/SyslogService
变化类型：新增属性取值
操作类型： GET/PATCH

属性名称 取值类型 取值范围 默认值 说明
TransmissionProtocol string 1）TLS协议
2）TCP协议
3）UDP协议
4）RELP协议（新增）		 TLS 1、该属性映射后端资源协助接口Protocol和RELPEnabled属性
2、处理时需要结合资源协作接口RELPEnabled属性综合判断：
a）查询场景：如果RELPEnabled为true，则返回RELP，否则从资源协作接口Protocol获取对应取值
b）设置场景：如果用户下发RELP，则将资源协作接口RELPEnabled设置为true，如果下发其他值，则对资源协作接口Protocol进行设置（同时修改RELPEnabled为false，以便查询时从Protocol获取）

评审结论：

1、同意webrest接口/UI/Rest/GenericInfo新增Syslog/ProtocolSupported对象，该对象下增加属性TLS、UDP、TDP、RELP，类型为boolean，true表示支持该协议，false表示不支持该协议；
2、同意资源协作接口bmc.kepler.Managers.Syslog新增属性
（1）RELPSupported：是否支持RELP协议，签名为b，读权限ReadOnly，写权限SecurityMgmt，不发送变更通知事件
（2）RELPEnabled：是否启用RELP协议，签名为b，读权限ReadOnly，写权限SecurityMgmt，不发送变更通知事件
3、同意webrest接口/UI/Rest/Maintenance/SyslogNotificationt的TransmissionProtocol属性新增取值项“RELP”；
4、同意/redfish/v1/Managers/1/SyslogService接口TransmissionProtocol属性新增取值项“RELP”；

遗留事项：

1、北向下发其他协议类型（例如TCP、UDP等）需要修改RELPEnabled为false； – 已闭环
2、Relp改为大写方式RELP； – 已闭环

1 个赞