commit f6db102edd88ef28c5d8ab40aed9f4ea6c31d934
author Asmitha Karunanithi <asmitk01@in.ibm.com> Tue Jun 28 04:47:59 2022 -0500
committer Asmitha Karunanithi <asmitk01@in.ibm.com> Mon Jul 11 10:47:10 2022 +0000
tree 555501ac5795d0f20444168e0b21c3d6dd1140f5
parent a39c66ae86c5e5bdfdeb88da3f79e31407c45581

createDump: Add Originator info as additional parameter

This commit adds "OriginatorId" & "OriginatorType" of the
"xyz.openbmc_project.Common.OriginatedBy" interface as
additional parameter in the createDump dbus call.

The "AdditionalData" parameter in createDump call will
be in a key-value format and the key in this case would be
"xyz.openbmc_project.Common.OriginatorId"; the value
would be any unique identifier of the user/component that
initiated the dump. This is an optional parameter and will be
implemented for user-triggered dumps.

The createDump dbus call with OriginatorId will now look like:
busctl call xyz.openbmc_project.Dump.Manager \
/xyz/openbmc_project/dump/bmc xyz.openbmc_project.Dump.Create \
CreateDump a{sv} 2 "xyz.openbmc_project.Dump.Create.CreateParameters.OriginatorId" \
s "<unique-id>" "xyz.openbmc_project.Dump.Create.CreateParameters.OriginatorType" \
s "<originatorType>"

Signed-off-by: Asmitha Karunanithi <asmitk01@in.ibm.com>
Change-Id: I220f20077fc069f798b40583b8918695e18152c2

yaml/xyz/openbmc_project/Dump/Create.interface.yaml

diff --git a/yaml/xyz/openbmc_project/Dump/Create.interface.yaml b/yaml/xyz/openbmc_project/Dump/Create.interface.yaml
index 5543721..9a5bf56 100644
--- a/yaml/xyz/openbmc_project/Dump/Create.interface.yaml
+++ b/yaml/xyz/openbmc_project/Dump/Create.interface.yaml
@@ -47,3 +47,18 @@
           - xyz.openbmc_project.Dump.Create.Error.QuotaExceeded
           - xyz.openbmc_project.Common.Error.NotAllowed
           - xyz.openbmc_project.Common.Error.InvalidArgument
+enumerations:
+    - name: CreateParameters
+      description: >
+          Additional parameters for creating the dump.
+      values:
+        - name: 'OriginatorId'
+          description: >
+              Unique Id of the originator of the respective
+              operation. This property is defined in xyz.openbmc_project.
+              Common.OriginatedBy interface.
+        - name: 'OriginatorType'
+          description: >
+              Type of the originator that initiated the respective
+              operation. This property is defined in xyz.openbmc_project.
+              Common.OriginatedBy interface.