| Dhruvaraj Subhashchandran | 4bd4033 | 2020-11-04 22:50:02 -0600 | [diff] [blame] | 1 | description: > |
| 2 | Implement this to add Resource dump management. |
| 3 | |
| Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame] | 4 | The resource dumps are special types of dumps generated by host hypervisor. |
| 5 | The dump is generated based on the resource selector. Hyperviosr needs a |
| 6 | password to validate the request before creating the dump. |
| Dhruvaraj Subhashchandran | 4bd4033 | 2020-11-04 22:50:02 -0600 | [diff] [blame] | 7 | |
| 8 | properties: |
| 9 | - name: SourceDumpId |
| 10 | type: uint32 |
| 11 | description: > |
| Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame] | 12 | The dump id provided by the source of the dump. There are dumps which |
| 13 | get generated outside the BMC, like a resource dump which gets |
| 14 | generated and stored in the host memory. All dumps will have a unique |
| 15 | id but when communicating to the source of the dump the SourceDumpId |
| 16 | will be used. |
| Dhruvaraj Subhashchandran | 4bd4033 | 2020-11-04 22:50:02 -0600 | [diff] [blame] | 17 | - name: VSPString |
| 18 | type: string |
| 19 | description: > |
| 20 | The resource selector for generating the dump. |
| 21 | - name: Password |
| 22 | type: string |
| 23 | description: > |
| 24 | The password required by host to validate the request. |
| Dhruvaraj Subhashchandran | 27afd1f | 2023-07-08 13:07:21 -0500 | [diff] [blame] | 25 | - name: Token |
| 26 | type: uint32 |
| 27 | description: > |
| 28 | A token exchanged with an external firmware subsystem when creating a |
| 29 | dump outside of the BMC. This token can be used to identify the dump |
| 30 | entry once the collection is completed. |
| Dhruvaraj Subhashchandran | 980fb7b | 2022-02-10 00:08:39 -0600 | [diff] [blame^] | 31 | - name: DumpRequestStatus |
| 32 | type: enum[self.HostResponse] |
| 33 | description: > |
| 34 | The host will send a response code for each request to create a |
| 35 | resource dump to indicate whether the request is successful or there |
| 36 | is an error. |
| 37 | default: Requested |
| 38 | |
| 39 | enumerations: |
| 40 | - name: HostResponse |
| 41 | description: > |
| 42 | These are the possible response codes from the host after sending a |
| 43 | resource dump request. |
| 44 | values: |
| 45 | - name: Requested |
| 46 | description: > |
| 47 | Requested for resource dump and awaiting the host response |
| 48 | - name: Success |
| 49 | description: > |
| 50 | Resource dump parameters and ACF data are successfully validated |
| 51 | - name: ACFFileInvalid |
| 52 | description: > |
| 53 | Invalid ACF file |
| 54 | - name: UserChallengeInvalid |
| 55 | description: > |
| 56 | User challenge provided is not valid |
| 57 | - name: PermissionDenied |
| 58 | descVSPtion: > |
| 59 | Caller does not have enough privileges to execute the requested |
| 60 | VSP string |
| 61 | - name: ResourceSelectorInvalid |
| 62 | description: > |
| 63 | Resource selector(VSP String) provided is not valid |