blob: e8094d22ca33184536f7f618390bb1ff33018a99 [file] [log] [blame]
Jayanth Othayoth02dcec32017-05-18 23:31:32 -05001description: >
Dhruvaraj Subhashchandranb34d6fd2020-08-19 13:06:05 -05002 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 Othayoth02dcec32017-05-18 23:31:32 -050012methods:
13 - name: CreateDump
14 description: >
Dhruvaraj Subhashchandranb34d6fd2020-08-19 13:06:05 -050015 Method to create a manual Dump.
Dhruvaraj Subhashchandrane6085092020-10-13 02:41:32 -050016 parameters:
Patrick Williams8da396c2022-03-14 14:21:02 -050017 - name: AdditionalData
18 type: dict[string, variant[string,uint64]]
19 description: >
20 The additional data, if any, for initiating the dump.
21 The key in this case should be an implementation
22 specific enum defined for the specific type of dump
23 either in xyz or in a domain.
24 The values can be either a string or a 64 bit number.
25 The enum-format string is required to come from a
26 parallel class with this specific Enum name.
27 All of the Enum strings should be in the format
28 'domain.Dump.Create.CreateParameters.ParamName'.
29 e.g.:
30 {
31 "key1": "value1",
32 "key2": "value2"
33 }
34 ends up in AdditionaData like:
35 ["KEY1=value1", "KEY2=value2"]
Jayanth Othayoth02dcec32017-05-18 23:31:32 -050036 returns:
Patrick Williams8da396c2022-03-14 14:21:02 -050037 - name: Path
38 type: object_path
39 description: >
40 The object path of the object that implements
41 xyz.openbmc_project.Common.Progress to track the progress
42 of the dump
Jayanth Othayoth02dcec32017-05-18 23:31:32 -050043 errors:
Claire Weinanaa46bf42022-06-02 17:09:13 -070044 - xyz.openbmc_project.Common.File.Error.Open
Patrick Williams8da396c2022-03-14 14:21:02 -050045 - xyz.openbmc_project.Common.File.Error.Write
46 - xyz.openbmc_project.Dump.Create.Error.Disabled
47 - xyz.openbmc_project.Dump.Create.Error.QuotaExceeded
48 - xyz.openbmc_project.Common.Error.NotAllowed
49 - xyz.openbmc_project.Common.Error.InvalidArgument
Dhruvaraj Subhashchandranbed657a2022-04-26 08:32:08 -050050 - xyz.openbmc_project.Common.Error.Unavailable
51
Asmitha Karunanithif6db1022022-06-28 04:47:59 -050052enumerations:
53 - name: CreateParameters
54 description: >
55 Additional parameters for creating the dump.
56 values:
57 - name: 'OriginatorId'
58 description: >
59 Unique Id of the originator of the respective
60 operation. This property is defined in xyz.openbmc_project.
61 Common.OriginatedBy interface.
62 - name: 'OriginatorType'
63 description: >
64 Type of the originator that initiated the respective
65 operation. This property is defined in xyz.openbmc_project.
66 Common.OriginatedBy interface.