| Jayanth Othayoth | eea9814 | 2017-04-05 00:58:48 -0500 | [diff] [blame] | 1 | description: > |
| 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 |
| Claire Weinan | 7311efe | 2022-08-10 18:50:26 -0700 | [diff] [blame] | 9 | individual Dump objects (and its dump object manager should |
| 10 | implement xyz.openbmc_project.Collection.DeleteAll). |
| Jayanth Othayoth | eea9814 | 2017-04-05 00:58:48 -0500 | [diff] [blame] | 11 | |
| Dhruvaraj Subhashchandran | 86d1ab1 | 2020-01-24 01:03:52 -0600 | [diff] [blame] | 12 | methods: |
| 13 | - name: InitiateOffload |
| 14 | description: > |
| Patrick Williams | 8da396c | 2022-03-14 14:21:02 -0500 | [diff] [blame] | 15 | This method initiates the offload of the dump from the dump storage. |
| 16 | The transfer will be initiated to the target provide. The caller of |
| 17 | this function should set up a method to transfer and pass the URI to |
| 18 | to this function. If there is no exceptions the caller can assume the |
| 19 | transfer is successfully initiated. Once the transfer is completed. |
| 20 | The application which is transferring the dump should set offloaded |
| 21 | property to true to indicate offload is completed. |
| Dhruvaraj Subhashchandran | 86d1ab1 | 2020-01-24 01:03:52 -0600 | [diff] [blame] | 22 | parameters: |
| Patrick Williams | 8da396c | 2022-03-14 14:21:02 -0500 | [diff] [blame] | 23 | - name: OffloadUri |
| 24 | type: string |
| 25 | description: > |
| 26 | The location to offload dump file, error InvalidArgument will be |
| 27 | returned if the URI is not well formated. |
| Dhruvaraj Subhashchandran | 39ceb2f | 2020-06-24 14:48:44 -0500 | [diff] [blame] | 28 | errors: |
| Patrick Williams | 8da396c | 2022-03-14 14:21:02 -0500 | [diff] [blame] | 29 | - xyz.openbmc_project.Common.File.Error.Open |
| 30 | - xyz.openbmc_project.Common.File.Error.Write |
| 31 | - xyz.openbmc_project.Common.Error.InvalidArgument |
| 32 | - xyz.openbmc_project.Common.Error.NotAllowed |
| Dhruvaraj Subhashchandran | 3b99c18 | 2022-03-29 23:24:08 -0500 | [diff] [blame] | 33 | - xyz.openbmc_project.Common.Error.Unavailable |
| Dhruvaraj Subhashchandran | 39ceb2f | 2020-06-24 14:48:44 -0500 | [diff] [blame] | 34 | |
| Jayanth Othayoth | eea9814 | 2017-04-05 00:58:48 -0500 | [diff] [blame] | 35 | properties: |
| 36 | - name: Size |
| 37 | type: uint64 |
| 38 | description: > |
| 39 | Size of the Dump. |
| Dhruvaraj Subhashchandran | 5006cdf | 2020-01-20 04:08:10 -0600 | [diff] [blame] | 40 | - name: Offloaded |
| 41 | type: boolean |
| 42 | description: > |
| 43 | Indicates whether the dump is offloaded to a client. |
| 44 | The BMC application which knows the status of the offload |
| 45 | operation should set this to true once the entire dump is |
| 46 | offloaded. |
| Dhruvaraj Subhashchandran | 86d1ab1 | 2020-01-24 01:03:52 -0600 | [diff] [blame] | 47 | - name: OffloadUri |
| 48 | type: string |
| 49 | description: > |
| 50 | The URI to write the dump file. |