Jayanth Othayoth | 02dcec3 | 2017-05-18 23:31:32 -0500 | [diff] [blame] | 1 | description: > |
Dhruvaraj Subhashchandran | b34d6fd | 2020-08-19 13:06:05 -0500 | [diff] [blame] | 2 | Implement to capture various types of dumps from the |
| 3 | host or BMC. This interface is for user to request a particular |
| 4 | type of dump. |
| 5 | |
| 6 | Any OpenBMC implementation should provide one implementation |
| 7 | of xyz.openbmc_project.Dump.Create per dump type on |
| 8 | /xyz/openbmc_project/dump/<dump type>. On multi-host or on multi-BMC |
| 9 | systems the instance number can be added to the path to differentiate, |
| 10 | for example /xyz/openbmc_project/dump/<dump type><instance-id>. |
| 11 | |
Jayanth Othayoth | 02dcec3 | 2017-05-18 23:31:32 -0500 | [diff] [blame] | 12 | |
| 13 | methods: |
| 14 | - name: CreateDump |
| 15 | description: > |
Dhruvaraj Subhashchandran | b34d6fd | 2020-08-19 13:06:05 -0500 | [diff] [blame] | 16 | Method to create a manual Dump. |
Jayanth Othayoth | 02dcec3 | 2017-05-18 23:31:32 -0500 | [diff] [blame] | 17 | returns: |
Dhruvaraj Subhashchandran | a3943e6 | 2020-09-08 23:24:37 -0500 | [diff] [blame^] | 18 | - name: Path |
| 19 | type: object_path |
Jayanth Othayoth | 02dcec3 | 2017-05-18 23:31:32 -0500 | [diff] [blame] | 20 | description: > |
Dhruvaraj Subhashchandran | a3943e6 | 2020-09-08 23:24:37 -0500 | [diff] [blame^] | 21 | The object path of the object that implements |
| 22 | xyz.openbmc_project.Common.Progress to track the progress |
| 23 | of the dump |
Jayanth Othayoth | 02dcec3 | 2017-05-18 23:31:32 -0500 | [diff] [blame] | 24 | errors: |
Jayanth Othayoth | 02dcec3 | 2017-05-18 23:31:32 -0500 | [diff] [blame] | 25 | - xyz.openbmc_project.Common.File.Error.Write |
| 26 | - xyz.openbmc_project.Dump.Create.Error.Disabled |
| 27 | - xyz.openbmc_project.Dump.Create.Error.QuotaExceeded |