| Dhruvaraj Subhashchandran | 5006cdf | 2020-01-20 04:08:10 -0600 | [diff] [blame] | 1 | description: > |
| Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame] | 2 | Implement to notify the creation of new dump. Use this interface when the |
| 3 | dump is already created and ready to be offloaded. This interface will add a |
| 4 | new dump object with the properties provided. The existing internal create |
| 5 | interface should be used when the data is collected and the dump needs to be |
| 6 | packaged. |
| Dhruvaraj Subhashchandran | 5006cdf | 2020-01-20 04:08:10 -0600 | [diff] [blame] | 7 | |
| 8 | Any OpenBMC implementation must provide exactly one implementation of |
| 9 | xyz.openbmc_project.Dump.NewDump on /xyz/openbmc_project/dump. |
| 10 | |
| 11 | methods: |
| 12 | - name: Notify |
| 13 | description: > |
| Patrick Williams | 8da396c | 2022-03-14 14:21:02 -0500 | [diff] [blame] | 14 | Create a dump entry based on the parameters. |
| Dhruvaraj Subhashchandran | 5006cdf | 2020-01-20 04:08:10 -0600 | [diff] [blame] | 15 | parameters: |
| Patrick Williams | 8da396c | 2022-03-14 14:21:02 -0500 | [diff] [blame] | 16 | - name: SourceDumpId |
| 17 | type: uint32 |
| 18 | description: > |
| Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame] | 19 | The dump id provided by the source of the dump. There are dumps |
| 20 | which get generated outside the BMC, like a system dump which |
| 21 | gets generated and stored in the host memory. All dumps will |
| 22 | have a unique id but when communicating to the source of the |
| 23 | dump the SourceDumpId will be used. |
| Patrick Williams | 8da396c | 2022-03-14 14:21:02 -0500 | [diff] [blame] | 24 | - name: Size |
| 25 | type: uint64 |
| 26 | description: > |
| 27 | Size of the dump in bytes |
| Dhruvaraj Subhashchandran | 5006cdf | 2020-01-20 04:08:10 -0600 | [diff] [blame] | 28 | errors: |
| Patrick Williams | 8da396c | 2022-03-14 14:21:02 -0500 | [diff] [blame] | 29 | - xyz.openbmc_project.Dump.Create.Error.Disabled |