xref: /openbmc/phosphor-dbus-interfaces/yaml/xyz/openbmc_project/VirtualMedia/MountPoint.interface.yaml (revision 921791c73008a3edfc6507afb5bc15e48963d295)
1b1b4d261SWilliam A. Kennington IIIdescription: >
2*921791c7SManojkiran Eda    Defines the object configuration like mounting mode, image paths, timeouts
3a1347418SPatrick Williams    etc.
4b1b4d261SWilliam A. Kennington III
5b1b4d261SWilliam A. Kennington IIIproperties:
6b1b4d261SWilliam A. Kennington III    - name: EndPointId
7b1b4d261SWilliam A. Kennington III      type: string
8b1b4d261SWilliam A. Kennington III      description: Name of the Network Block Devices that will be used.
9b1b4d261SWilliam A. Kennington III      flags:
10b1b4d261SWilliam A. Kennington III          - const
11b1b4d261SWilliam A. Kennington III      errors:
12b1b4d261SWilliam A. Kennington III          - xyz.openbmc_project.Common.Error.InternalFailure
13b1b4d261SWilliam A. Kennington III
14b1b4d261SWilliam A. Kennington III    - name: Mode
15b1b4d261SWilliam A. Kennington III      type: byte
16b1b4d261SWilliam A. Kennington III      description: Mounting mode, supported values are 0-proxy, 1-legacy.
17b1b4d261SWilliam A. Kennington III      flags:
18b1b4d261SWilliam A. Kennington III          - const
19b1b4d261SWilliam A. Kennington III      errors:
20b1b4d261SWilliam A. Kennington III          - xyz.openbmc_project.Common.Error.InternalFailure
21b1b4d261SWilliam A. Kennington III
22b1b4d261SWilliam A. Kennington III    - name: Device
23b1b4d261SWilliam A. Kennington III      type: string
24b1b4d261SWilliam A. Kennington III      description: Name of mounted device.
25b1b4d261SWilliam A. Kennington III      flags:
26b1b4d261SWilliam A. Kennington III          - const
27b1b4d261SWilliam A. Kennington III      errors:
28b1b4d261SWilliam A. Kennington III          - xyz.openbmc_project.Common.Error.InternalFailure
29b1b4d261SWilliam A. Kennington III
30b1b4d261SWilliam A. Kennington III    - name: Socket
31b1b4d261SWilliam A. Kennington III      type: string
32b1b4d261SWilliam A. Kennington III      description: Path to socket used to mount the image.
33b1b4d261SWilliam A. Kennington III      flags:
34b1b4d261SWilliam A. Kennington III          - const
35b1b4d261SWilliam A. Kennington III      errors:
36b1b4d261SWilliam A. Kennington III          - xyz.openbmc_project.Common.Error.InternalFailure
37b1b4d261SWilliam A. Kennington III
38b1b4d261SWilliam A. Kennington III    - name: Timeout
39b1b4d261SWilliam A. Kennington III      type: uint16
40b1b4d261SWilliam A. Kennington III      description: >
41a1347418SPatrick Williams          Client connection timeout in seconds. If VirtualMedia cannot connect
42a1347418SPatrick Williams          successfully with served image the connection is dropped after that
43a1347418SPatrick Williams          timeout.
44b1b4d261SWilliam A. Kennington III      flags:
45b1b4d261SWilliam A. Kennington III          - const
46b1b4d261SWilliam A. Kennington III      errors:
47b1b4d261SWilliam A. Kennington III          - xyz.openbmc_project.Common.Error.InternalFailure
48b1b4d261SWilliam A. Kennington III
49b1b4d261SWilliam A. Kennington III    - name: BlockSize
50b1b4d261SWilliam A. Kennington III      type: uint16
51b1b4d261SWilliam A. Kennington III      description: Size of data block.
52b1b4d261SWilliam A. Kennington III      flags:
53b1b4d261SWilliam A. Kennington III          - const
54b1b4d261SWilliam A. Kennington III      errors:
55b1b4d261SWilliam A. Kennington III          - xyz.openbmc_project.Common.Error.InternalFailure
56b1b4d261SWilliam A. Kennington III
57b1b4d261SWilliam A. Kennington III    - name: RemainingInactivityTimeout
58b1b4d261SWilliam A. Kennington III      type: uint16
59b1b4d261SWilliam A. Kennington III      description: >
60a1347418SPatrick Williams          Seconds to drop connection by server, for activated endpoint, 0
61a1347418SPatrick Williams          otherwise.
62b1b4d261SWilliam A. Kennington III      flags:
63b1b4d261SWilliam A. Kennington III          - const
64b1b4d261SWilliam A. Kennington III      errors:
65b1b4d261SWilliam A. Kennington III          - xyz.openbmc_project.Common.Error.InternalFailure
66b1b4d261SWilliam A. Kennington III
67b1b4d261SWilliam A. Kennington III    - name: ImageURL
68b1b4d261SWilliam A. Kennington III      type: string
69b1b4d261SWilliam A. Kennington III      description: URL to mounted image.
70b1b4d261SWilliam A. Kennington III      flags:
71b1b4d261SWilliam A. Kennington III          - const
72b1b4d261SWilliam A. Kennington III      errors:
73b1b4d261SWilliam A. Kennington III          - xyz.openbmc_project.Common.Error.InternalFailure
74b1b4d261SWilliam A. Kennington III
75b1b4d261SWilliam A. Kennington III    - name: WriteProtected
76b1b4d261SWilliam A. Kennington III      type: boolean
77b1b4d261SWilliam A. Kennington III      description: >
78a1347418SPatrick Williams          Mounting mode, 'True' if the image is read only, 'False' otherwise.
79b1b4d261SWilliam A. Kennington III      flags:
80b1b4d261SWilliam A. Kennington III          - const
81b1b4d261SWilliam A. Kennington III      errors:
82b1b4d261SWilliam A. Kennington III          - xyz.openbmc_project.Common.Error.InternalFailure
83