xref: /openbmc/phosphor-dbus-interfaces/yaml/com/ibm/Dump/Create.interface.yaml (revision 921791c73008a3edfc6507afb5bc15e48963d295)
1b1b4d261SWilliam A. Kennington IIIdescription: >
2a1347418SPatrick Williams    Implement this to pass additional parameters to the create dump. Each
3a1347418SPatrick Williams    required parameter for the dump in the ibm domain should be added here as an
4a1347418SPatrick Williams    enum.
5b1b4d261SWilliam A. Kennington III
6b1b4d261SWilliam A. Kennington IIIenumerations:
7b1b4d261SWilliam A. Kennington III    - name: CreateParameters
8b1b4d261SWilliam A. Kennington III      description: >
9b1b4d261SWilliam A. Kennington III          Additional parameters for creating the dump.
10b1b4d261SWilliam A. Kennington III      values:
118da396caSPatrick Williams          - name: "VSPString"
12b1b4d261SWilliam A. Kennington III            description: >
13*921791c7SManojkiran Eda                The resource dump is collected from various host resources. The
14a1347418SPatrick Williams                resource to collect the dump is indicated by using the resource
15a1347418SPatrick Williams                selector. The resource selector string needs to be passed to
16a1347418SPatrick Williams                host to generate a resource dump.
178da396caSPatrick Williams          - name: "Password"
18b1b4d261SWilliam A. Kennington III            description: >
19b1b4d261SWilliam A. Kennington III                The password for authenticating the resource dump request.
208da396caSPatrick Williams          - name: "ErrorLogId"
21b1b4d261SWilliam A. Kennington III            description: >
22b1b4d261SWilliam A. Kennington III                The id of the log associated with action which triggered the
23c6f2d7a7SDhruvaraj Subhashchandran                dump. The value should be a 32 bit unsigned integer.
248da396caSPatrick Williams          - name: "DumpType"
25b1b4d261SWilliam A. Kennington III            description: >
26b1b4d261SWilliam A. Kennington III                Type of the dump to be collected
278da396caSPatrick Williams          - name: "FailingUnitId"
28a2eb94f6SDhruvaraj Subhashchandran            description: >
29a2eb94f6SDhruvaraj Subhashchandran                A unique id of failing hardware unit which is causing the dump.
30a2eb94f6SDhruvaraj Subhashchandran                The value should be a 32 bit unsigned integer.
31b1b4d261SWilliam A. Kennington III
32b1b4d261SWilliam A. Kennington III    - name: DumpType
33b1b4d261SWilliam A. Kennington III      description: >
34b1b4d261SWilliam A. Kennington III          Type of the host dump to be collected.
35b1b4d261SWilliam A. Kennington III      values:
368da396caSPatrick Williams          - name: "Hostboot"
37b1b4d261SWilliam A. Kennington III            description: >
38b1b4d261SWilliam A. Kennington III                Hostboot dump is collected during a boot failure during the
39b1b4d261SWilliam A. Kennington III                hostboot booting phase.
408da396caSPatrick Williams          - name: "Hardware"
41*921791c7SManojkiran Eda            description: >
42a2eb94f6SDhruvaraj Subhashchandran                Hardware dump is collected during a system checkstop.
43db265883SDhruvaraj Subhashchandran          - name: "System"
44db265883SDhruvaraj Subhashchandran            description: >
45db265883SDhruvaraj Subhashchandran                System Dump: A dump that contains certain hardware register data
46db265883SDhruvaraj Subhashchandran                and host memory.
47db265883SDhruvaraj Subhashchandran          - name: "Resource"
48db265883SDhruvaraj Subhashchandran            description: >
49db265883SDhruvaraj Subhashchandran                Resource Dump: A dump of host resources, created for various
50db265883SDhruvaraj Subhashchandran                host components. The content may vary accordingly.
51d1484a14SDhruvaraj Subhashchandran          - name: "SBE"
52d1484a14SDhruvaraj Subhashchandran            description: >
5370d227b6SDhruvaraj Subhashchandran                A dump collected from Self Boot Engine(SBE) on the processor
5470d227b6SDhruvaraj Subhashchandran                when it encounters an error and become unresponsive.
5570d227b6SDhruvaraj Subhashchandran          - name: "MemoryBufferSBE"
5670d227b6SDhruvaraj Subhashchandran            description: >
5770d227b6SDhruvaraj Subhashchandran                A dump collected from Self Boot Engine on the memory buffer when
5870d227b6SDhruvaraj Subhashchandran                it encounters critical failures or unresponsive.
59