| Jayanth Othayoth | 23ebc26 | 2017-05-25 07:22:03 -0500 | [diff] [blame] | 1 | description: > |
| 2 | Implement to capture BMC Dump based on type. |
| 3 | |
| 4 | methods: |
| 5 | - name: Create |
| 6 | description: > |
| 7 | Create BMC Dump based on the Dump type. |
| 8 | parameters: |
| 9 | - name: Type |
| 10 | type: enum[self.Type] |
| 11 | description: > |
| 12 | Type of the Dump. |
| 13 | - name: FullPaths |
| 14 | type: array[string] |
| 15 | description: > |
| Jayanth Othayoth | 09f6b64 | 2017-09-03 21:09:35 -0500 | [diff] [blame] | 16 | A list of paths (file paths or d-bus object paths) that must be |
| 17 | processed to derive the dump content. |
| Jayanth Othayoth | 23ebc26 | 2017-05-25 07:22:03 -0500 | [diff] [blame] | 18 | errors: |
| Jayanth Othayoth | 23ebc26 | 2017-05-25 07:22:03 -0500 | [diff] [blame] | 19 | - xyz.openbmc_project.Common.File.Error.Write |
| 20 | - xyz.openbmc_project.Dump.Create.Error.Disabled |
| 21 | - xyz.openbmc_project.Dump.Create.Error.QuotaExceeded |
| 22 | |
| 23 | enumerations: |
| 24 | - name: Type |
| 25 | description: > |
| 26 | Possible types of BMC Dump. |
| 27 | values: |
| 28 | - name: ApplicationCored |
| 29 | description: > |
| 30 | Dump triggered due to application core. |
| Jayanth Othayoth | a320c7c | 2017-06-14 07:17:21 -0500 | [diff] [blame] | 31 | - name: UserRequested |
| 32 | description: > |
| 33 | Dump triggered by the user. |
| Jayanth Othayoth | 09f6b64 | 2017-09-03 21:09:35 -0500 | [diff] [blame] | 34 | - name: InternalFailure |
| 35 | description: > |
| 36 | Dump triggered due to InternalFailure type error commit. |
| Jayanth Othayoth | 23ebc26 | 2017-05-25 07:22:03 -0500 | [diff] [blame] | 37 | |
| 38 | # vim: tabstop=8 expandtab shiftwidth=4 softtabstop=4 |