1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
|
{
"$id": "http://redfish.dmtf.org/schemas/v1/VirtualMedia.v1_3_2.json",
"$ref": "#/definitions/VirtualMedia",
"$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
"copyright": "Copyright 2014-2019 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
"definitions": {
"Actions": {
"additionalProperties": false,
"description": "The available actions for this Resource.",
"longDescription": "This type shall contain the available actions for this Resource.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"#VirtualMedia.EjectMedia": {
"$ref": "#/definitions/EjectMedia"
},
"#VirtualMedia.InsertMedia": {
"$ref": "#/definitions/InsertMedia"
},
"Oem": {
"$ref": "#/definitions/OemActions",
"description": "The available OEM-specific actions for this Resource.",
"longDescription": "This property shall contain the available OEM-specific actions for this Resource.",
"versionAdded": "v1_1_0"
}
},
"type": "object"
},
"ConnectedVia": {
"enum": [
"NotConnected",
"URI",
"Applet",
"Oem"
],
"enumDescriptions": {
"Applet": "Connected to a client application.",
"NotConnected": "No current connection.",
"Oem": "Connected through an OEM-defined method.",
"URI": "Connected to a URI location."
},
"type": "string"
},
"EjectMedia": {
"additionalProperties": false,
"description": "This action detaches remote media from virtual media.",
"longDescription": "This action shall detach the remote media from the virtual media. At the completion of the operation, inserted shall be set to `false` and the image name shall be cleared.",
"parameters": {},
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"target": {
"description": "Link to invoke action",
"format": "uri-reference",
"type": "string"
},
"title": {
"description": "Friendly action name",
"type": "string"
}
},
"type": "object",
"versionAdded": "v1_2_0"
},
"InsertMedia": {
"additionalProperties": false,
"description": "This action attaches remote media to virtual media.",
"longDescription": "This action shall attach remote media to virtual media.",
"parameters": {
"Image": {
"description": "The URI of the remote media to attach to the virtual media.",
"longDescription": "This parameter shall specify the URI of the remote media to be attached to the virtual media.",
"requiredParameter": true,
"type": "string"
},
"Inserted": {
"description": "An indication of whether the image is treated as inserted upon completion of the action. The default is `true`.",
"longDescription": "This parameter shall indicate whether the image is treated as inserted upon completion of the action. If the client does not provide this parameter, the service shall default this value to `true`.",
"type": "boolean"
},
"Password": {
"description": "The password to access the Image parameter-specified URI.",
"longDescription": "This parameter shall represent the password to access the Image parameter-specified URI.",
"type": "string",
"versionAdded": "v1_3_0"
},
"TransferMethod": {
"$ref": "#/definitions/TransferMethod",
"description": "The transfer method to use with the Image.",
"longDescription": "This parameter shall describe how the image transfer occurs.",
"versionAdded": "v1_3_0"
},
"TransferProtocolType": {
"$ref": "#/definitions/TransferProtocolType",
"description": "The network protocol to use with the image.",
"longDescription": "This parameter shall represent the network protocol to use with the specified image URI.",
"versionAdded": "v1_3_0"
},
"UserName": {
"description": "The user name to access the Image parameter-specified URI.",
"longDescription": "This parameter shall contain the user name to access the Image parameter-specified URI.",
"type": "string",
"versionAdded": "v1_3_0"
},
"WriteProtected": {
"description": "An indication of whether the remote media is treated as write-protected. The default is `true`.",
"longDescription": "This parameter shall indicate whether the remote media is treated as write-protected. If the client does not provide this parameter, the service shall default this value to `true`.",
"type": "boolean"
}
},
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"target": {
"description": "Link to invoke action",
"format": "uri-reference",
"type": "string"
},
"title": {
"description": "Friendly action name",
"type": "string"
}
},
"type": "object",
"versionAdded": "v1_2_0"
},
"MediaType": {
"enum": [
"CD",
"Floppy",
"USBStick",
"DVD"
],
"enumDescriptions": {
"CD": "A CD-ROM format (ISO) image.",
"DVD": "A DVD-ROM format image.",
"Floppy": "A floppy disk image.",
"USBStick": "An emulation of a USB storage device."
},
"type": "string"
},
"OemActions": {
"additionalProperties": true,
"description": "The available OEM-specific actions for this Resource.",
"longDescription": "This type shall contain the available OEM-specific actions for this Resource.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {},
"type": "object"
},
"TransferMethod": {
"enum": [
"Stream",
"Upload"
],
"enumDescriptions": {
"Stream": "Stream image file data from the source URI.",
"Upload": "Upload the entire image file from the source URI to the service."
},
"type": "string"
},
"TransferProtocolType": {
"enum": [
"CIFS",
"FTP",
"SFTP",
"HTTP",
"HTTPS",
"NFS",
"SCP",
"TFTP",
"OEM"
],
"enumDescriptions": {
"CIFS": "Common Internet File System (CIFS).",
"FTP": "File Transfer Protocol (FTP).",
"HTTP": "Hypertext Transfer Protocol (HTTP).",
"HTTPS": "Hypertext Transfer Protocol Secure (HTTPS).",
"NFS": "Network File System (NFS).",
"OEM": "A manufacturer-defined protocol.",
"SCP": "Secure Copy Protocol (SCP).",
"SFTP": "Secure File Transfer Protocol (SFTP).",
"TFTP": "Trivial File Transfer Protocol (TFTP)."
},
"type": "string"
},
"VirtualMedia": {
"additionalProperties": false,
"description": "The VirtualMedia schema contains properties related to the monitor and control of an instance of virtual media, such as a remote CD, DVD, or USB device. A manager for a system or device provides virtual media functionality.",
"longDescription": "This Resource shall represent a virtual media service for a Redfish implementation.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"@odata.context": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
},
"@odata.etag": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
},
"@odata.id": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
},
"@odata.type": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
},
"Actions": {
"$ref": "#/definitions/Actions",
"description": "The available actions for this Resource.",
"longDescription": "This property shall contain the available actions for this Resource.",
"versionAdded": "v1_1_0"
},
"ConnectedVia": {
"anyOf": [
{
"$ref": "#/definitions/ConnectedVia"
},
{
"type": "null"
}
],
"description": "The current virtual media connection method.",
"longDescription": "This property shall contain the current connection method from a client to the virtual media that this Resource represents.",
"readonly": true
},
"Description": {
"anyOf": [
{
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
},
{
"type": "null"
}
],
"readonly": true
},
"Id": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
"readonly": true
},
"Image": {
"description": "The URI of the location of the selected image.",
"format": "uri-reference",
"longDescription": "This property shall contain an URI. A null value indicated no image connection.",
"readonly": false,
"type": [
"string",
"null"
]
},
"ImageName": {
"description": "The current image name.",
"longDescription": "This property shall contain the name of the image.",
"readonly": true,
"type": [
"string",
"null"
]
},
"Inserted": {
"description": "An indication of whether virtual media is inserted into the virtual device.",
"longDescription": "This property shall indicate whether media is present in the virtual media device.",
"readonly": false,
"type": [
"boolean",
"null"
]
},
"MediaTypes": {
"description": "The media types supported as virtual media.",
"items": {
"$ref": "#/definitions/MediaType"
},
"longDescription": "The values of this array shall be the supported media types for this connection.",
"readonly": true,
"type": "array"
},
"Name": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
"readonly": true
},
"Oem": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
"description": "The OEM extension property.",
"longDescription": "This property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
},
"Password": {
"description": "The password to access the Image parameter-specified URI. This property is null in responses.",
"longDescription": "This parameter shall represent the password to access the Image parameter-specified URI. The value shall be null in responses.",
"readonly": false,
"type": [
"string",
"null"
],
"versionAdded": "v1_3_0"
},
"TransferMethod": {
"anyOf": [
{
"$ref": "#/definitions/TransferMethod"
},
{
"type": "null"
}
],
"description": "The transfer method to use with the Image.",
"longDescription": "This parameter shall describe how the image transfer occurs.",
"readonly": false,
"versionAdded": "v1_3_0"
},
"TransferProtocolType": {
"anyOf": [
{
"$ref": "#/definitions/TransferProtocolType"
},
{
"type": "null"
}
],
"description": "The network protocol to use with the image.",
"longDescription": "This parameter shall represent the network protocol to use with the specified image URI.",
"readonly": false,
"versionAdded": "v1_3_0"
},
"UserName": {
"description": "The user name to access the Image parameter-specified URI.",
"longDescription": "This parameter shall represent the user name to access the Image parameter-specified URI.",
"readonly": false,
"type": [
"string",
"null"
],
"versionAdded": "v1_3_0"
},
"WriteProtected": {
"description": "An indication of whether the media is write-protected.",
"longDescription": "This property shall indicate whether the remote device media prevents writing to that media.",
"readonly": false,
"type": [
"boolean",
"null"
]
}
},
"required": [
"@odata.id",
"@odata.type",
"Id",
"Name"
],
"type": "object"
}
},
"owningEntity": "DMTF",
"release": "2018.3",
"title": "#VirtualMedia.v1_3_2.VirtualMedia"
}
|
