Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / phosphor-dbus-interfaces / 387a6191f225335caa052522b4774cdb70853189 / . / yaml / xyz / openbmc_project / VirtualMedia / MountPoint.interface.yaml
blob: 34e3efa516f8820aab3e71ae9442630f2d7aaf4f [file] [log] [blame]
Zbigniew Kurzynski9f2c7e22020-02-20 19:00:42 +0100[diff] [blame]1description: >
Patrick Williamsa1347412022-12-06 10:56:22 -0600[diff] [blame]2 Defines the object configuration like mounting mode, image paths, timouts
3 etc.
Zbigniew Kurzynski9f2c7e22020-02-20 19:00:42 +0100[diff] [blame]4
5properties:
6 - name: EndPointId
7 type: string
8 description: Name of the Network Block Devices that will be used.
9 flags:
Patrick Williams8da396c2022-03-14 14:21:02 -0500[diff] [blame]10 - const
Zbigniew Kurzynski9f2c7e22020-02-20 19:00:42 +0100[diff] [blame]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:
Patrick Williams8da396c2022-03-14 14:21:02 -0500[diff] [blame]18 - const
Zbigniew Kurzynski9f2c7e22020-02-20 19:00:42 +0100[diff] [blame]19 errors:
20 - xyz.openbmc_project.Common.Error.InternalFailure
21
22 - name: Device
23 type: string
24 description: Name of mounted device.
25 flags:
Patrick Williams8da396c2022-03-14 14:21:02 -0500[diff] [blame]26 - const
Zbigniew Kurzynski9f2c7e22020-02-20 19:00:42 +0100[diff] [blame]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:
Patrick Williams8da396c2022-03-14 14:21:02 -0500[diff] [blame]34 - const
Zbigniew Kurzynski9f2c7e22020-02-20 19:00:42 +0100[diff] [blame]35 errors:
36 - xyz.openbmc_project.Common.Error.InternalFailure
37
38 - name: Timeout
39 type: uint16
40 description: >
Patrick Williamsa1347412022-12-06 10:56:22 -0600[diff] [blame]41 Client connection timeout in seconds. If VirtualMedia cannot connect
42 successfully with served image the connection is dropped after that
43 timeout.
Zbigniew Kurzynski9f2c7e22020-02-20 19:00:42 +0100[diff] [blame]44 flags:
Patrick Williams8da396c2022-03-14 14:21:02 -0500[diff] [blame]45 - const
Zbigniew Kurzynski9f2c7e22020-02-20 19:00:42 +0100[diff] [blame]46 errors:
47 - xyz.openbmc_project.Common.Error.InternalFailure
48
49 - name: BlockSize
50 type: uint16
51 description: Size of data block.
52 flags:
Patrick Williams8da396c2022-03-14 14:21:02 -0500[diff] [blame]53 - const
Zbigniew Kurzynski9f2c7e22020-02-20 19:00:42 +0100[diff] [blame]54 errors:
55 - xyz.openbmc_project.Common.Error.InternalFailure
56
57 - name: RemainingInactivityTimeout
58 type: uint16
59 description: >
Patrick Williamsa1347412022-12-06 10:56:22 -0600[diff] [blame]60 Seconds to drop connection by server, for activated endpoint, 0
61 otherwise.
Zbigniew Kurzynski9f2c7e22020-02-20 19:00:42 +0100[diff] [blame]62 flags:
Patrick Williams8da396c2022-03-14 14:21:02 -0500[diff] [blame]63 - const
Zbigniew Kurzynski9f2c7e22020-02-20 19:00:42 +0100[diff] [blame]64 errors:
65 - xyz.openbmc_project.Common.Error.InternalFailure
66
67 - name: ImageURL
68 type: string
69 description: URL to mounted image.
70 flags:
Patrick Williams8da396c2022-03-14 14:21:02 -0500[diff] [blame]71 - const
Zbigniew Kurzynski9f2c7e22020-02-20 19:00:42 +0100[diff] [blame]72 errors:
73 - xyz.openbmc_project.Common.Error.InternalFailure
Anna Platash395ba212020-11-19 12:44:00 +0100[diff] [blame]74
75 - name: WriteProtected
76 type: boolean
77 description: >
Patrick Williamsa1347412022-12-06 10:56:22 -0600[diff] [blame]78 Mounting mode, 'True' if the image is read only, 'False' otherwise.
Anna Platash395ba212020-11-19 12:44:00 +0100[diff] [blame]79 flags:
Patrick Williams8da396c2022-03-14 14:21:02 -0500[diff] [blame]80 - const
Anna Platash395ba212020-11-19 12:44:00 +0100[diff] [blame]81 errors:
82 - xyz.openbmc_project.Common.Error.InternalFailure