1description: >
2    Implement to provide Dump attributes.
3
4    Object which implements this interface must implement
5    xyz.openbmc_project.Time.EpochTime for the Dump creation time. Object which
6    implements this interface should implement xyz.openbmc_project.Object.Delete
7    to allow the deletion of individual Dump objects (and its dump object
8    manager should implement xyz.openbmc_project.Collection.DeleteAll).
9
10methods:
11    - name: InitiateOffload
12      description: >
13          This method initiates the offload of the dump from the dump storage.
14          The transfer will be initiated to the target provide. The caller of
15          this function should set up a method to transfer and pass the URI to
16          to this function. If there is no exceptions the caller can assume the
17          transfer is successfully initiated. Once the transfer is completed.
18          The application which is transferring the dump should set offloaded
19          property to true to indicate offload is completed.
20      parameters:
21          - name: OffloadUri
22            type: string
23            description: >
24                The location to offload dump file, error InvalidArgument will be
25                returned if the URI is not well formated.
26      errors:
27          - xyz.openbmc_project.Common.File.Error.Open
28          - xyz.openbmc_project.Common.File.Error.Write
29          - xyz.openbmc_project.Common.Error.InvalidArgument
30          - xyz.openbmc_project.Common.Error.NotAllowed
31          - xyz.openbmc_project.Common.Error.Unavailable
32
33    - name: GetFileHandle
34      description: >
35          This method provides the Unix file handle for the dump entry. The file
36          handle returned can be used by clients to directly read the contents
37          of file in their own context, without relying on additional API calls.
38          The mode of the file descriptor is read-only.
39      returns:
40          - name: fd
41            type: unixfd
42            description: >
43                The file descriptor to the dump file.
44      errors:
45          - xyz.openbmc_project.Common.File.Error.Open
46          - xyz.openbmc_project.Common.Error.NotAllowed
47          - xyz.openbmc_project.Common.Error.Unavailable
48
49properties:
50    - name: Size
51      type: uint64
52      description: >
53          Size of the Dump.
54    - name: Offloaded
55      type: boolean
56      description: >
57          Indicates whether the dump is offloaded to a client. The BMC
58          application which knows the status of the offload operation should set
59          this to true once the entire dump is offloaded.
60    - name: OffloadUri
61      type: string
62      description: >
63          The URI to write the dump file.
64