| Zbigniew Kurzynski | 9f2c7e2 | 2020-02-20 19:00:42 +0100 | [diff] [blame] | 1 | description: > |
| 2 | This interface provides methods for mounting and unmounting images. |
| 3 | |
| 4 | methods: |
| 5 | - name: Mount |
| Przemyslaw Czarnowski | 9ad0a7d | 2022-04-29 12:51:52 +0200 | [diff] [blame] | 6 | description: > |
| 7 | Perform an asynchronous operation of mounting to HOST on given object. |
| Zbigniew Kurzynski | 9f2c7e2 | 2020-02-20 19:00:42 +0100 | [diff] [blame] | 8 | returns: |
| Patrick Williams | 8da396c | 2022-03-14 14:21:02 -0500 | [diff] [blame] | 9 | - name: Status |
| 10 | type: boolean |
| 11 | description: mounting status. True on success. |
| Zbigniew Kurzynski | 9f2c7e2 | 2020-02-20 19:00:42 +0100 | [diff] [blame] | 12 | errors: |
| Patrick Williams | 8da396c | 2022-03-14 14:21:02 -0500 | [diff] [blame] | 13 | - xyz.openbmc_project.Common.Error.InternalFailure |
| Zbigniew Kurzynski | 9f2c7e2 | 2020-02-20 19:00:42 +0100 | [diff] [blame] | 14 | |
| 15 | - name: Unmount |
| Przemyslaw Czarnowski | 9ad0a7d | 2022-04-29 12:51:52 +0200 | [diff] [blame] | 16 | description: > |
| 17 | Perform an asynchronous operation of unmount from HOST on given |
| 18 | object. |
| Zbigniew Kurzynski | 9f2c7e2 | 2020-02-20 19:00:42 +0100 | [diff] [blame] | 19 | returns: |
| Patrick Williams | 8da396c | 2022-03-14 14:21:02 -0500 | [diff] [blame] | 20 | - name: Status |
| 21 | type: boolean |
| 22 | description: the unmount status. True on success. |
| Zbigniew Kurzynski | 9f2c7e2 | 2020-02-20 19:00:42 +0100 | [diff] [blame] | 23 | errors: |
| Patrick Williams | 8da396c | 2022-03-14 14:21:02 -0500 | [diff] [blame] | 24 | - xyz.openbmc_project.Common.Error.InternalFailure |
| Przemyslaw Czarnowski | 9ad0a7d | 2022-04-29 12:51:52 +0200 | [diff] [blame] | 25 | |
| 26 | signals: |
| 27 | - name: Completion |
| 28 | description: > |
| 29 | Signal indicating completion of mount or unmount action. |
| 30 | properties: |
| 31 | - name: Result |
| 32 | type: int32 |
| 33 | description: > |
| 34 | Returns 0 for success or errno on failure after background |
| 35 | operation completes. |