Dump Manager: Update the createDump parameters
The dump create method is accepting a set of key-value
pairs as additional parameters for creating various
types of dump. Updated the documentation for the
createDump method.
Signed-off-by: Dhruvaraj Subhashchandran <dhruvaraj@in.ibm.com>
Change-Id: I3642603463fddef3574cc113a853e669e83e1212
diff --git a/designs/dump-manager.md b/designs/dump-manager.md
index 0a8f535..4027595 100644
--- a/designs/dump-manager.md
+++ b/designs/dump-manager.md
@@ -73,6 +73,7 @@
stop during this dump and may collect various processor states and/or memory
contents to help to debug the failure.
+
## Requirements
@@ -142,7 +143,21 @@
- Interfaces
- **Create**: The interface to create a dump, called by clients to initiate
user-initiated dump.
- - Type: Type of the dump needs to be created
+ - AdditionalData: The additional data, if any, for initiating the dump.
+ The key in this case should be an implementation specific enum
+ defined for the specific type of dump either in xyz or in a domain.
+ The values can be either a string or a 64 bit number.
+ The enum-format string is required to come from a parallel class
+ with this specific Enum name. All of the Enum strings should be in
+ the format
+ 'domain.Dump.Create.CreateParameters.ParamName'.
+ e.g.:
+ {
+ "key1": "value1",
+ "key2": "value2"
+ }
+ ends up in AdditionaData like:
+ ["KEY1=value1", "KEY2=value2"]
- **Notify**: Notify the dump manager that a new dump is created.
- ID: ID of the dump, if not 0 this will be the external id of the dump