Post by asmithakr on Mar 22, 2024 7:52:15 GMT
Current Design:
CollectDiagnosticData method is defined in LogService schema and the parameters to this method are defined in LogEntry schema:
DiagnosticDataType, OEMDiagnosticDataType, Password, TargetURI, TransferProtocol, UserName.
Requirement:
For user-initiated dumps, there is an IBM-specific requirement that gets the resource name and password from the user to collect diagnostic data for any particular resource.
Proposal:
In order to meet this requirement, there can be a property called "AdditionalArgs" or "OemAdditionalArgs" that is a list of additional parameters to this method. The redfish request for user-initiated dump looks like the below with the proposed property:
```
POST https://${bmc}/redfish/v1/Managers/bmc/LogServices/Dump/Actions/LogService.CollectDiagnosticData -d '{"DiagnosticDataType":"OEM", "OEMDiagnosticDataType":"<DiagnosticDataType>", "OemAdditionalArgs":["arg1", "arg2", ..., "argn"]}'
```
Things that needs clarification:
* Can this list have multiple data types, although current requirement is for strings?
* If it can be extended to DiagnosticDataType other than OEM, can we rename it as "AdditionalArgs"?
CollectDiagnosticData method is defined in LogService schema and the parameters to this method are defined in LogEntry schema:
DiagnosticDataType, OEMDiagnosticDataType, Password, TargetURI, TransferProtocol, UserName.
Requirement:
For user-initiated dumps, there is an IBM-specific requirement that gets the resource name and password from the user to collect diagnostic data for any particular resource.
Proposal:
In order to meet this requirement, there can be a property called "AdditionalArgs" or "OemAdditionalArgs" that is a list of additional parameters to this method. The redfish request for user-initiated dump looks like the below with the proposed property:
```
POST https://${bmc}/redfish/v1/Managers/bmc/LogServices/Dump/Actions/LogService.CollectDiagnosticData -d '{"DiagnosticDataType":"OEM", "OEMDiagnosticDataType":"<DiagnosticDataType>", "OemAdditionalArgs":["arg1", "arg2", ..., "argn"]}'
```
Things that needs clarification:
* Can this list have multiple data types, although current requirement is for strings?
* If it can be extended to DiagnosticDataType other than OEM, can we rename it as "AdditionalArgs"?
