blob: 742eb7295a8d69c44516848c3aeae2378204ce07 [file] [log] [blame]
Dhruvaraj Subhashchandran4bd40332020-11-04 22:50:02 -06001description: >
Patrick Williamsa1347412022-12-06 10:56:22 -06002 Implement this to pass additional parameters to the create dump. Each
3 required parameter for the dump in the ibm domain should be added here as an
4 enum.
Dhruvaraj Subhashchandran4bd40332020-11-04 22:50:02 -06005
6enumerations:
7 - name: CreateParameters
Dhruvaraj Subhashchandran6f8ebc52020-11-23 21:55:44 -06008 description: >
Dhruvaraj Subhashchandran4bd40332020-11-04 22:50:02 -06009 Additional parameters for creating the dump.
10 values:
Patrick Williams8da396c2022-03-14 14:21:02 -050011 - name: "VSPString"
12 description: >
Patrick Williamsa1347412022-12-06 10:56:22 -060013 The resouce dump is collected from various host resources. The
14 resource to collect the dump is indicated by using the resource
15 selector. The resource selector string needs to be passed to
16 host to generate a resource dump.
Patrick Williams8da396c2022-03-14 14:21:02 -050017 - name: "Password"
18 description: >
19 The password for authenticating the resource dump request.
20 - name: "ErrorLogId"
21 description: >
22 The id of the log associated with action which triggered the
23 dump. The value should be a 32 bit unsigned integer.
24 - name: "DumpType"
25 description: >
26 Type of the dump to be collected
27 - name: "FailingUnitId"
28 description: >
29 A unique id of failing hardware unit which is causing the dump.
30 The value should be a 32 bit unsigned integer.
Dhruvaraj Subhashchandran6f8ebc52020-11-23 21:55:44 -060031
32 - name: DumpType
33 description: >
34 Type of the host dump to be collected.
35 values:
Patrick Williams8da396c2022-03-14 14:21:02 -050036 - name: "Hostboot"
37 description: >
38 Hostboot dump is collected during a boot failure during the
39 hostboot booting phase.
40 - name: "Hardware"
41 desription: >
42 Hardware dump is collected during a system checkstop.
Dhruvaraj Subhashchandrandb265882023-07-08 03:57:22 -050043 - name: "System"
44 description: >
45 System Dump: A dump that contains certain hardware register data
46 and host memory.
47 - name: "Resource"
48 description: >
49 Resource Dump: A dump of host resources, created for various
50 host components. The content may vary accordingly.
Dhruvaraj Subhashchandrand1484a12021-09-08 02:18:44 -050051 - name: "SBE"
52 description: >
53 A dump collected from Self Boot Engine(SBE) when it encounters
54 an error and become unresponsive.