blob: 075fe1cbaf8a33575098601430eec90118681947 [file] [log] [blame]
Jayanth Othayotheea98142017-04-05 00:58:48 -05001description: >
2 Implement to provide Dump attributes.
3
4 Object which implements this interface must implement
5 xyz.openbmc_project.Time.EpochTime for the Dump
6 creation time.
7 Object which implements this interface should implement
8 xyz.openbmc_project.Object.Delete to allow the deletion of
9 individual Dump objects.
10
Dhruvaraj Subhashchandran86d1ab12020-01-24 01:03:52 -060011methods:
12 - name: InitiateOffload
13 description: >
Patrick Williams8da396c2022-03-14 14:21:02 -050014 This method initiates the offload of the dump from the dump storage.
15 The transfer will be initiated to the target provide. The caller of
16 this function should set up a method to transfer and pass the URI to
17 to this function. If there is no exceptions the caller can assume the
18 transfer is successfully initiated. Once the transfer is completed.
19 The application which is transferring the dump should set offloaded
20 property to true to indicate offload is completed.
Dhruvaraj Subhashchandran86d1ab12020-01-24 01:03:52 -060021 parameters:
Patrick Williams8da396c2022-03-14 14:21:02 -050022 - name: OffloadUri
23 type: string
24 description: >
25 The location to offload dump file, error InvalidArgument will be
26 returned if the URI is not well formated.
Dhruvaraj Subhashchandran39ceb2f2020-06-24 14:48:44 -050027 errors:
Patrick Williams8da396c2022-03-14 14:21:02 -050028 - xyz.openbmc_project.Common.File.Error.Open
29 - xyz.openbmc_project.Common.File.Error.Write
30 - xyz.openbmc_project.Common.Error.InvalidArgument
31 - xyz.openbmc_project.Common.Error.NotAllowed
Dhruvaraj Subhashchandran3b99c182022-03-29 23:24:08 -050032 - xyz.openbmc_project.Common.Error.Unavailable
Dhruvaraj Subhashchandran39ceb2f2020-06-24 14:48:44 -050033
Jayanth Othayotheea98142017-04-05 00:58:48 -050034properties:
35 - name: Size
36 type: uint64
37 description: >
38 Size of the Dump.
Dhruvaraj Subhashchandran5006cdf2020-01-20 04:08:10 -060039 - name: Offloaded
40 type: boolean
41 description: >
42 Indicates whether the dump is offloaded to a client.
43 The BMC application which knows the status of the offload
44 operation should set this to true once the entire dump is
45 offloaded.
Dhruvaraj Subhashchandran86d1ab12020-01-24 01:03:52 -060046 - name: OffloadUri
47 type: string
48 description: >
49 The URI to write the dump file.