1description: >
2    Implement this to add Resource dump management.
3
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.
7
8properties:
9    - name: SourceDumpId
10      type: uint32
11      description: >
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.
17    - name: VSPString
18      type: string
19      description: >
20          The resource selector for generating the dump.
21    - name: UserChallenge
22      type: string
23      description: >
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.
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.
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: Unknown
49
50enumerations:
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: Unknown
57            description: >
58                The status of the request is unknown, or not initialized
59          - name: Requested
60            description: >
61                Requested for resource dump and awaiting the host response
62          - name: Success
63            description: >
64                Resource dump parameters and ACF data are successfully validated
65          - name: ACLFileInvalid
66            description: >
67                Invalid Access Control List file
68          - name: UserChallengeInvalid
69            description: >
70                User challenge provided is not valid
71          - name: PermissionDenied
72            descVSPtion: >
73                Caller does not have enough privileges to execute the requested
74                resource selector(VSP string)
75          - name: ResourceSelectorInvalid
76            description: >
77                Resource selector(VSP String) provided is not valid
78