| Dhruvaraj Subhashchandran | 5006cdf | 2020-01-20 04:08:10 -0600 | [diff] [blame^] | 1 | description: > |
| 2 | Implement to notify the creation of new dump. |
| 3 | Use this interface when the dump is already created and ready |
| 4 | to be offloaded. This interface will add a new dump object with the |
| 5 | properties provided. The existing internal create interface should |
| 6 | be used when the data is collected and the dump needs to be packaged. |
| 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: > |
| 14 | Create a dump entry based on the parameters. |
| 15 | parameters: |
| 16 | - name: DumpType |
| 17 | type: enum[self.DumpType] |
| 18 | description: > |
| 19 | Type of the dump |
| 20 | - name: SourceDumpId |
| 21 | type: uint32 |
| 22 | description: > |
| 23 | The dump id provided by the source of the dump. |
| 24 | There are dumps which get generated outside the BMC, like a |
| 25 | system dump which gets generated and stored in the host memory. |
| 26 | All dumps will have a unique id but when communicating |
| 27 | to the source of the dump the SourceDumpId will be used. |
| 28 | - name: Size |
| 29 | type: uint64 |
| 30 | description: > |
| 31 | Size of the dump in bytes |
| 32 | errors: |
| 33 | - xyz.openbmc_project.Common.Error.InternalFailure |
| 34 | - xyz.openbmc_project.Dump.Create.Error.Disabled |
| 35 | |
| 36 | enumerations: |
| 37 | - name: DumpType |
| 38 | description: |
| 39 | Type of the dump |
| 40 | values: |
| 41 | - name: System |
| 42 | description: > |
| 43 | A dump created during a critical failure in the host. |