【已评审】资源协作接口支持精简日志收集评审

Interface SIG Interface评审
1

ISSUE链接

支持精简日志收集-mdb_interface-GitCode

背景

当前一键收集日志内容过多，收集时间较长，某些机型仅关注特定几类日志的内容，因此提供日志精简收集能力，支持某些机型收集指定范围内的日志内容，缩短日志收集时长

决策点

一、资源协作接口新增方法
资源协作path：/bmc/kepler/Managers/:ManagerId/LogServices
资源协作intf：bmc.kepler.Managers.LogServices
变化类型：新增方法
应用场景 ：用户进行精简日志收集
操作权限：SecurityMgmt

方法名称 req签名 请求参数 rsp签名 响应参数 操作权限 说明 接口约束
QuickDump s FilePath u TaskId SecurityMgmt 精简日志收集接口 FilePath：日志收集后文件的存放路径，支持：
本地路径 （/tmp/文件路径）
远程路径（文件传输协议://用户名:密码@ip 地址/目录/文件名），文件传输协议包括五种：sftp、https、nfs、cifs、scp
TaskId：任务id

redfish接口（历史已有支持该接口）
接口名：/redfish/v1/Managers/:managerid/Actions/Oem/{{OemIdentifier}}/Manager.QuickDump
变化类型：新增接口
操作类型：POST
操作权限：SecurityMgmt
应用场景 ：用户进行精简日志收集

请求参数 参数类型 取值范围 说明
Type string “URI” 取值固定为URI
Content string 本地导出：“/tmp/文件路径”；
远程导出：“文件传输协议://用户名:密码@ip 地址/目录/文件名		 日志收集后文件的存放路径，支持本地路径与远程路径，文件传输协议包括五种：sftp、https、nfs、cifs、scp

ActionInfo示例：

{
    "@odata.context": "/redfish/v1/$metadata#ActionInfo.ActionInfo",
    "@odata.id": "/redfish/v1/Managers/1/QuickDumpActionInfo",
    "@odata.type": "#ActionInfo.v1_0_1.ActionInfo",
    "Id": "QuickDumpActionInfo",
    "Name": "Quick Dump Action Info",
    "Parameters": [
        {
            "Name": "Type",
            "Required": true,
            "DataType": "String",
            "AllowableValues": [
                "URI"
            ]
        },
        {
            "Name": "Content",
            "Required": true,
            "DataType": "String"
        }
    ],
    "Oem": {}
}

评审结论

同意资源协作接口bmc.kepler.Managers.LogServices新增如下方法

方法名称 req签名 请求参数 rsp签名 响应参数 操作权限 说明 接口约束
QuickDump s FilePath u TaskId SecurityMgmt 用于日志快速收集（精简日志范围） FilePath：日志收集后文件的存放路径，支持：
本地路径 （/tmp/文件路径）
远程路径（文件传输协议://用户名:密码@ip 地址/目录/文件名），文件传输协议包括五种：sftp、https、nfs、cifs、scp
TaskId：任务id