| 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. |
| Dhruvaraj Subhashchandran | b3563c1 | 2024-05-06 00:21:44 -0500 | [diff] [blame^] | 21 | - name: UserChallenge |
| Dhruvaraj Subhashchandran | 4bd4033 | 2020-11-04 22:50:02 -0600 | [diff] [blame] | 22 | type: string |
| 23 | description: > |
| Dhruvaraj Subhashchandran | b3563c1 | 2024-05-06 00:21:44 -0500 | [diff] [blame^] | 24 | On some host implementations a user-challenge need to be provided by |
| 25 | the user and it flows through BMC and up to the host as a part of the |
| 26 | dump request. Non-disruptive dumps consume significant host resources |
| 27 | and involve the collection of host memory data. To safeguard these |
| 28 | operations and ensure they are initiated only by authorized personnel, |
| 29 | the provided passphrase is employed. In some systems, an Access |
| 30 | Control List (ACL) file, provided through the Platform Level Data |
| 31 | Model (PLDM), is used. The host validates the provided user-challenge |
| 32 | against this ACL. If the user-challenge doesn't match any entry in the |
| 33 | ACL, the host will reject the dump request. This field is needed so |
| 34 | the host can check that only authorized users are allowed to perform |
| 35 | certain dump operations. |
| Dhruvaraj Subhashchandran | 27afd1f | 2023-07-08 13:07:21 -0500 | [diff] [blame] | 36 | - name: Token |
| 37 | type: uint32 |
| 38 | description: > |
| 39 | A token exchanged with an external firmware subsystem when creating a |
| 40 | dump outside of the BMC. This token can be used to identify the dump |
| 41 | entry once the collection is completed. |
| Dhruvaraj Subhashchandran | 980fb7b | 2022-02-10 00:08:39 -0600 | [diff] [blame] | 42 | - name: DumpRequestStatus |
| 43 | type: enum[self.HostResponse] |
| 44 | description: > |
| 45 | The host will send a response code for each request to create a |
| 46 | resource dump to indicate whether the request is successful or there |
| 47 | is an error. |
| 48 | default: Requested |
| 49 | |
| 50 | enumerations: |
| 51 | - name: HostResponse |
| 52 | description: > |
| 53 | These are the possible response codes from the host after sending a |
| 54 | resource dump request. |
| 55 | values: |
| 56 | - name: Requested |
| 57 | description: > |
| 58 | Requested for resource dump and awaiting the host response |
| 59 | - name: Success |
| 60 | description: > |
| 61 | Resource dump parameters and ACF data are successfully validated |
| 62 | - name: ACFFileInvalid |
| 63 | description: > |
| 64 | Invalid ACF file |
| 65 | - name: UserChallengeInvalid |
| 66 | description: > |
| 67 | User challenge provided is not valid |
| 68 | - name: PermissionDenied |
| 69 | descVSPtion: > |
| 70 | Caller does not have enough privileges to execute the requested |
| 71 | VSP string |
| 72 | - name: ResourceSelectorInvalid |
| 73 | description: > |
| 74 | Resource selector(VSP String) provided is not valid |