| 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 |
| 9 | individual Dump objects. |
| 10 | |
| Dhruvaraj Subhashchandran | 86d1ab1 | 2020-01-24 01:03:52 -0600 | [diff] [blame] | 11 | methods: |
| 12 | - name: InitiateOffload |
| 13 | description: > |
| 14 | 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. |
| 21 | parameters: |
| 22 | - name: OffloadUri |
| 23 | type: string |
| 24 | description: > |
| 25 | The location to offload dump file. |
| Jayanth Othayoth | eea9814 | 2017-04-05 00:58:48 -0500 | [diff] [blame] | 26 | properties: |
| 27 | - name: Size |
| 28 | type: uint64 |
| 29 | description: > |
| 30 | Size of the Dump. |
| Dhruvaraj Subhashchandran | 5006cdf | 2020-01-20 04:08:10 -0600 | [diff] [blame] | 31 | - name: Offloaded |
| 32 | type: boolean |
| 33 | description: > |
| 34 | Indicates whether the dump is offloaded to a client. |
| 35 | The BMC application which knows the status of the offload |
| 36 | operation should set this to true once the entire dump is |
| 37 | offloaded. |
| Dhruvaraj Subhashchandran | 86d1ab1 | 2020-01-24 01:03:52 -0600 | [diff] [blame] | 38 | - name: OffloadUri |
| 39 | type: string |
| 40 | description: > |
| 41 | The URI to write the dump file. |