xref: /openbmc/phosphor-dbus-interfaces/yaml/xyz/openbmc_project/Dump/NewDump.interface.yaml (revision 4f703341)
  • Home
  • History
  • Annotate
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1description: >
2    Implement to notify the creation of new dump.
3    Use this interface when the dump is already created and ready
4    to be offloaded. This interface will add a new dump object with the
5    properties provided. The existing internal create interface should
6    be used when the data is collected and the dump needs to be packaged.
7
8    Any OpenBMC implementation must provide exactly one implementation of
9    xyz.openbmc_project.Dump.NewDump on /xyz/openbmc_project/dump.
10
11methods:
12    - name: Notify
13      description: >
14         Create a dump entry based on the parameters.
15      parameters:
16       - name: SourceDumpId
17         type: uint32
18         description: >
19             The dump id provided by the source of the dump.
20             There are dumps which get generated outside the BMC, like a
21             system dump which gets generated and stored in the host memory.
22             All dumps will have a  unique id  but when communicating
23             to the source of the dump the SourceDumpId will be used.
24       - name: Size
25         type: uint64
26         description: >
27            Size of the dump in bytes
28      errors:
29        - xyz.openbmc_project.Dump.Create.Error.Disabled
30

served by {OpenGrok

Last Index Update: Sun May 25 03:01:12 CDT 2025