Add response code to system dump entry
Add new property in the system dump entry for storing the
response code returned by the host after requesting a new
non-disruptive system dump.
Change-Id: Ie6d8204ee6d7574fece9c8fc530bf28b09e50e63
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 2547485..c75fd29 100644
--- a/yaml/xyz/openbmc_project/Dump/Entry/System.interface.yaml
+++ b/yaml/xyz/openbmc_project/Dump/Entry/System.interface.yaml
@@ -50,6 +50,13 @@
ACL, the host will reject the dump request. This field is needed so
the host can check that only authorized users are allowed to perform
certain dump operations.
+ - name: DumpRequestStatus
+ type: enum[self.HostResponse]
+ description: >
+ The host will send a response code for each request to create a system
+ dump to indicate whether the request is successful or there is an
+ error.
+ default: Unknown
enumerations:
- name: SystemImpact
@@ -61,3 +68,29 @@
- name: NonDisruptive
description: >
The system state will not change with the collection
+ - name: HostResponse
+ description: >
+ These are the possible response codes from the host's after sending a
+ non-disruptive system dump request.
+ values:
+ - name: Unknown
+ description: >
+ The status of the request is unknown, or not initialized
+ - name: Requested
+ description: >
+ Requested for system dump and awaiting the host response
+ - name: Success
+ description: >
+ Successfully validated and accepted the request for a
+ non-disruptive system dump.
+ - name: ACLFileInvalid
+ description: >
+ Invalid Access Control List file, cannot validate the user to
+ start a non-disruptive system dump.
+ - name: UserChallengeInvalid
+ description: >
+ The user challenge provided is not valid
+ - name: PermissionDenied
+ description: >
+ The caller does not have enough privileges to execute the
+ requested non-disruptive system dump.