commit e4c402ab592a1e6ddbcdefbf256c58074506e4fb
author Przemyslaw Czarnowski <przemyslaw.hawrylewicz.czarnowski@intel.com> Wed Jul 22 11:49:37 2020 +0200
committer Patrick Williams <patrick@stwcx.xyz> Thu Aug 13 17:25:56 2020 +0000
tree 5a86d0d46c38a4e99555ebb43ded031f5b134f36
parent 6a0c41c4ff098e0f38936fe4751d7a8168f6ba95

Add OEM schema extension description

OEM schema has been created to extend Virtual Media to support multiple
proxy mode connections. Actual documentation lacks information about it.

Change-Id: Id0c11f4f1934194b9b20955f7add73583756bbd5
Signed-off-by: Przemyslaw Czarnowski <przemyslaw.hawrylewicz.czarnowski@intel.com>

designs/VirtualMedia.md

diff --git a/designs/VirtualMedia.md b/designs/VirtualMedia.md
index b05814e..3b15f77 100644
--- a/designs/VirtualMedia.md
+++ b/designs/VirtualMedia.md
@@ -7,7 +7,7 @@
 None
 
 Other contributors:
-None
+Przemyslaw Czarnowski <przemyslaw.hawrylewicz.czarnowski@intel.com>
 
 Created:
 6/4/2019
@@ -237,7 +237,6 @@
             "@odata.id": "/redfish/v1/Managers/BMC/VirtualMedia/1"
         }
     ],
-    "Oem": { } ,
     "@odata.context": "/redfish/v1/$metadata#VirtualMediaCollection.VirtualMediaCollection",
     "@odata.id": "/redfish/v1/Managers/BMC/VirtualMedia"
 }
@@ -260,7 +259,13 @@
     "Inserted": true,
     "WriteProtected": false,
     "@odata.context": "/redfish/v1/$metadata#VirtualMedia.VirtualMedia",
-    "@odata.id": "/redfish/v1/Managers/BMC/VirtualMedia/ISO0"
+    "@odata.id": "/redfish/v1/Managers/BMC/VirtualMedia/ISO0",
+    "Oem": {
+        "OpenBMC": {
+             "@odata.type": "#OemVirtualMedia.v1_0_0.VirtualMedia",
+             "WebSocketEndpoint": "/nbd/0"
+        }
+    },
 }
 ```
 
@@ -276,6 +281,18 @@
 | TransferMethod       | "Stream"   | "Stream"                         | "upload" is not supported by design |
 | TransferProtocolType | "OEM"      | as described by DMTF spec        |                                     |
 
+#### Virtual Media OEM Extension
+
+Virtual Media schema is adapted to Legacy Mode where image is given by user
+directly via Redfish action and whole connection is processed between service
+and web server.
+
+For [Proxy Mode](#Proxy-Mode) nbd data is
+served by client web browser. Having multiple connections, in order to setup
+connection, client needs the information about the location of websocket
+created by web server. This value is exposed as OEM ``WebSocketEndpoint``
+property for each item.
+
 ### Inactivity timeout
 
 Virtual Media supports inactivity timeout, which will break Virtual Media