xyz/openbmc_project/Dump/Internal/Create.interface.yaml


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

description: >
    Implement to capture BMC Dump based on type.

methods:
    - name: Create
      description: >
          Create BMC Dump based on the Dump type.
      parameters:
       - name: Type
         type: enum[self.Type]
         description: >
            Type of the Dump.
       - name: FullPaths
         type: array[string]
         description: >
            List of absolute paths to the files to be included
            as part of Dump package.
      errors:
        - xyz.openbmc_project.Common.Error.InternalFailure
        - xyz.openbmc_project.Common.File.Error.Write
        - xyz.openbmc_project.Dump.Create.Error.Disabled
        - xyz.openbmc_project.Dump.Create.Error.QuotaExceeded

enumerations:
    - name: Type
      description: >
          Possible types of BMC Dump.
      values:
        - name: ApplicationCored
          description: >
              Dump triggered due to application core.
        - name: UserRequested
          description: >
              Dump triggered by the user.

# vim: tabstop=8 expandtab shiftwidth=4 softtabstop=4