xref: /openbmc/phosphor-dbus-interfaces/yaml/xyz/openbmc_project/Dump/NewDump.interface.yaml (revision 3826910e)
  • Home
  • History
  • Annotate
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1description: >
2    Implement to notify the creation of new dump. Use this interface when the
3    dump is already created and ready to be offloaded. This interface will add a
4    new dump object with the properties provided. The existing internal create
5    interface should be used when the data is collected and the dump needs to be
6    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. There are dumps
20                which get generated outside the BMC, like a system dump which
21                gets generated and stored in the host memory. All dumps will
22                have a  unique id  but when communicating to the source of the
23                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 18 03:01:11 CDT 2025