Dump: Add 'SystemImpact' to System Dump entry
This commit introduces 'SystemImpact' to the system dump
entry. This new enum field indicates whether a system
dump is 'Disruptive' or 'NonDisruptive'.
'Disruptive' dumps alter the system state and capture
extensive data, making them useful for diagnosing system
crashes. In contrast, 'NonDisruptive' dumps do not
disturb the system state while still providing valuable
data for analysis.
Change-Id: I03810e86e1db9d2b46891dbe2e00e436e76b2cc2
Signed-off-by: Dhruvaraj Subhashchandran <dhruvaraj@in.ibm.com>
diff --git a/yaml/xyz/openbmc_project/Dump/Entry/System.interface.yaml b/yaml/xyz/openbmc_project/Dump/Entry/System.interface.yaml
index 3c3e01c..1e530c8 100644
--- a/yaml/xyz/openbmc_project/Dump/Entry/System.interface.yaml
+++ b/yaml/xyz/openbmc_project/Dump/Entry/System.interface.yaml
@@ -22,3 +22,27 @@
A token exchanged with an external firmware subsystem when creating a
dump outside of the BMC. This token can be used to identify the dump
entry once the collection is completed.
+ - name: SystemImpact
+ type: enum [self.SystemImpact]
+ default: Disruptive
+ description: >
+ System dumps can be broadly classified into two types based on their
+ impact on the system state. The first type, known as a 'disruptive'
+ dump, alters the system state. This kind of dump is typically
+ generated during a host crash, although it can also be manually
+ requested by a user. Despite its disruptive nature, this dump is able
+ to collect a lot of data, making it particularly useful for diagnosing
+ system crashes. The second type is a 'non-disruptive' dump. As the
+ name suggests, this dump is created without causing any disruption to
+ the system state.
+
+enumerations:
+ - name: SystemImpact
+ description: Indicate the type of system dump
+ values:
+ - name: Disruptive
+ description: >
+ The system state will change with this type of dump collection
+ - name: NonDisruptive
+ description: >
+ The system state will not change with the collection