| Ramesh Iyyar | ae56dbc | 2021-05-17 06:40:00 -0500 | [diff] [blame] | 1 | description: > |
| Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame] | 2 | This interface contains create method, which can be implemented to create an |
| 3 | xyz.openbmc_project.HardwareIsolation.Entry object which will use to provide |
| 4 | the information of isolated hardware. |
| Ramesh Iyyar | ae56dbc | 2021-05-17 06:40:00 -0500 | [diff] [blame] | 5 | |
| 6 | methods: |
| 7 | - name: Create |
| 8 | description: > |
| Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame] | 9 | Create an xyz.openbmc_project.HardwareIsolation.Entry object if any of |
| 10 | the hardware, needs to be isolated. This interface can be used if want |
| 11 | to isolate hardware without an error log, for example, the user |
| 12 | voluntarily tried to isolate hardware. |
| Ramesh Iyyar | ae56dbc | 2021-05-17 06:40:00 -0500 | [diff] [blame] | 13 | parameters: |
| Patrick Williams | 8da396c | 2022-03-14 14:21:02 -0500 | [diff] [blame] | 14 | - name: IsolateHardware |
| Patrick Williams | b78a070 | 2022-10-24 12:32:56 -0500 | [diff] [blame] | 15 | type: object_path |
| Patrick Williams | 8da396c | 2022-03-14 14:21:02 -0500 | [diff] [blame] | 16 | description: > |
| 17 | The hardware inventory path which is needs to isolate. |
| 18 | - name: Severity |
| 19 | type: enum[xyz.openbmc_project.HardwareIsolation.Entry.Type] |
| 20 | description: > |
| 21 | The severity of hardware isolation. |
| Ramesh Iyyar | ae56dbc | 2021-05-17 06:40:00 -0500 | [diff] [blame] | 22 | returns: |
| Patrick Williams | 8da396c | 2022-03-14 14:21:02 -0500 | [diff] [blame] | 23 | - name: Path |
| Patrick Williams | b78a070 | 2022-10-24 12:32:56 -0500 | [diff] [blame] | 24 | type: object_path |
| Patrick Williams | 8da396c | 2022-03-14 14:21:02 -0500 | [diff] [blame] | 25 | description: > |
| 26 | The path of created xyz.openbmc_project.HardwareIsolation.Entry |
| 27 | object. |
| Ramesh Iyyar | ae56dbc | 2021-05-17 06:40:00 -0500 | [diff] [blame] | 28 | errors: |
| 29 | - xyz.openbmc_project.Common.Error.InvalidArgument |
| 30 | - xyz.openbmc_project.Common.Error.TooManyResources |
| 31 | - xyz.openbmc_project.HardwareIsolation.Error.IsolatedAlready |
| 32 | - xyz.openbmc_project.Common.Error.NotAllowed |
| 33 | - xyz.openbmc_project.Common.Error.Unavailable |
| Ramesh Iyyar | 6ff6561 | 2021-06-18 00:38:55 -0500 | [diff] [blame] | 34 | |
| 35 | - name: CreateWithErrorLog |
| 36 | description: > |
| Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame] | 37 | Create an xyz.openbmc_project.HardwareIsolation.Entry object if any of |
| 38 | the hardware, needs to be isolated. This interface can be used if the |
| 39 | system wants to isolate hardware with an error log that is caused to |
| 40 | isolate hardware. This method is not going to create an error log and |
| 41 | the consumer of this method need to pass the bmc error log which |
| 42 | caused the isolation. |
| Ramesh Iyyar | 6ff6561 | 2021-06-18 00:38:55 -0500 | [diff] [blame] | 43 | parameters: |
| Patrick Williams | 8da396c | 2022-03-14 14:21:02 -0500 | [diff] [blame] | 44 | - name: IsolateHardware |
| Patrick Williams | b78a070 | 2022-10-24 12:32:56 -0500 | [diff] [blame] | 45 | type: object_path |
| Patrick Williams | 8da396c | 2022-03-14 14:21:02 -0500 | [diff] [blame] | 46 | description: > |
| 47 | The hardware inventory path which is needs to isolate. |
| 48 | - name: Severity |
| 49 | type: enum[xyz.openbmc_project.HardwareIsolation.Entry.Type] |
| 50 | description: > |
| 51 | The severity of hardware isolation. |
| 52 | - name: BmcErrorLog |
| Patrick Williams | b78a070 | 2022-10-24 12:32:56 -0500 | [diff] [blame] | 53 | type: object_path |
| Patrick Williams | 8da396c | 2022-03-14 14:21:02 -0500 | [diff] [blame] | 54 | description: > |
| 55 | The BMC error log caused the isolation of hardware. |
| Ramesh Iyyar | 6ff6561 | 2021-06-18 00:38:55 -0500 | [diff] [blame] | 56 | returns: |
| Patrick Williams | 8da396c | 2022-03-14 14:21:02 -0500 | [diff] [blame] | 57 | - name: Path |
| Patrick Williams | b78a070 | 2022-10-24 12:32:56 -0500 | [diff] [blame] | 58 | type: object_path |
| Patrick Williams | 8da396c | 2022-03-14 14:21:02 -0500 | [diff] [blame] | 59 | description: > |
| 60 | The path of created xyz.openbmc_project.HardwareIsolation.Entry |
| 61 | object. |
| Ramesh Iyyar | 6ff6561 | 2021-06-18 00:38:55 -0500 | [diff] [blame] | 62 | errors: |
| 63 | - xyz.openbmc_project.Common.Error.InvalidArgument |
| 64 | - xyz.openbmc_project.Common.Error.TooManyResources |
| 65 | - xyz.openbmc_project.HardwareIsolation.Error.IsolatedAlready |
| 66 | - xyz.openbmc_project.Common.Error.NotAllowed |
| 67 | - xyz.openbmc_project.Common.Error.Unavailable |