Zbigniew Kurzynski | 9f2c7e2 | 2020-02-20 19:00:42 +0100 | [diff] [blame] | 1 | description: > |
| 2 | Defines the object configuration like mounting mode, image paths, |
| 3 | timouts etc. |
| 4 | |
| 5 | properties: |
| 6 | - name: EndPointId |
| 7 | type: string |
| 8 | description: Name of the Network Block Devices that will be used. |
| 9 | flags: |
| 10 | - const |
| 11 | errors: |
| 12 | - xyz.openbmc_project.Common.Error.InternalFailure |
| 13 | |
| 14 | - name: Mode |
| 15 | type: byte |
| 16 | description: Mounting mode, supported values are 0-proxy, 1-legacy. |
| 17 | flags: |
| 18 | - const |
| 19 | errors: |
| 20 | - xyz.openbmc_project.Common.Error.InternalFailure |
| 21 | |
| 22 | - name: Device |
| 23 | type: string |
| 24 | description: Name of mounted device. |
| 25 | flags: |
| 26 | - const |
| 27 | errors: |
| 28 | - xyz.openbmc_project.Common.Error.InternalFailure |
| 29 | |
| 30 | - name: Socket |
| 31 | type: string |
| 32 | description: Path to socket used to mount the image. |
| 33 | flags: |
| 34 | - const |
| 35 | errors: |
| 36 | - xyz.openbmc_project.Common.Error.InternalFailure |
| 37 | |
| 38 | - name: Timeout |
| 39 | type: uint16 |
| 40 | description: > |
| 41 | Client connection timeout in seconds. |
| 42 | If VirtualMedia cannot connect successfully with served |
| 43 | image the connection is dropped after that timeout. |
| 44 | flags: |
| 45 | - const |
| 46 | errors: |
| 47 | - xyz.openbmc_project.Common.Error.InternalFailure |
| 48 | |
| 49 | - name: BlockSize |
| 50 | type: uint16 |
| 51 | description: Size of data block. |
| 52 | flags: |
| 53 | - const |
| 54 | errors: |
| 55 | - xyz.openbmc_project.Common.Error.InternalFailure |
| 56 | |
| 57 | - name: RemainingInactivityTimeout |
| 58 | type: uint16 |
| 59 | description: > |
| 60 | Seconds to drop connection by server, for activated endpoint, |
| 61 | 0 otherwise. |
| 62 | flags: |
| 63 | - const |
| 64 | errors: |
| 65 | - xyz.openbmc_project.Common.Error.InternalFailure |
| 66 | |
| 67 | - name: ImageURL |
| 68 | type: string |
| 69 | description: URL to mounted image. |
| 70 | flags: |
| 71 | - const |
| 72 | errors: |
| 73 | - xyz.openbmc_project.Common.Error.InternalFailure |