| 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 |
| Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame] | 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). |
| Jayanth Othayoth | eea9814 | 2017-04-05 00:58:48 -0500 | [diff] [blame] | 9 | |
| Dhruvaraj Subhashchandran | 86d1ab1 | 2020-01-24 01:03:52 -0600 | [diff] [blame] | 10 | methods: |
| 11 | - name: InitiateOffload |
| 12 | description: > |
| Patrick Williams | 8da396c | 2022-03-14 14:21:02 -0500 | [diff] [blame] | 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. |
| Dhruvaraj Subhashchandran | 86d1ab1 | 2020-01-24 01:03:52 -0600 | [diff] [blame] | 20 | parameters: |
| Patrick Williams | 8da396c | 2022-03-14 14:21:02 -0500 | [diff] [blame] | 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. |
| Dhruvaraj Subhashchandran | 39ceb2f | 2020-06-24 14:48:44 -0500 | [diff] [blame] | 26 | errors: |
| Patrick Williams | 8da396c | 2022-03-14 14:21:02 -0500 | [diff] [blame] | 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 |
| Dhruvaraj Subhashchandran | 3b99c18 | 2022-03-29 23:24:08 -0500 | [diff] [blame] | 31 | - xyz.openbmc_project.Common.Error.Unavailable |
| Dhruvaraj Subhashchandran | 39ceb2f | 2020-06-24 14:48:44 -0500 | [diff] [blame] | 32 | |
| Dhruvaraj Subhashchandran | 7720dd6 | 2023-06-12 14:13:53 -0500 | [diff] [blame] | 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 | |
| Jayanth Othayoth | eea9814 | 2017-04-05 00:58:48 -0500 | [diff] [blame] | 49 | properties: |
| 50 | - name: Size |
| 51 | type: uint64 |
| 52 | description: > |
| 53 | Size of the Dump. |
| Dhruvaraj Subhashchandran | 5006cdf | 2020-01-20 04:08:10 -0600 | [diff] [blame] | 54 | - name: Offloaded |
| 55 | type: boolean |
| 56 | description: > |
| Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame] | 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. |
| Dhruvaraj Subhashchandran | 86d1ab1 | 2020-01-24 01:03:52 -0600 | [diff] [blame] | 60 | - name: OffloadUri |
| 61 | type: string |
| 62 | description: > |
| 63 | The URI to write the dump file. |