blob: 856d3fadbd00db6906bcee85b29f088d854a19db (
plain) (
blame)
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
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
|
openapi: 3.0.0
info:
title: bwLehrpool-Server
description: 'This is the description document of the bwLehrpool-Server API. The API provides functionality to create, modify, and query events or virtual machine images. You can find out more about the bwLehrpool-Server at [https://git.openslx.org/openslx-ng/tutor-module.git](https://git.openslx.org/openslx-ng/tutor-module.git).'
contact:
name: bwLehrpool-Server
url: https://git.openslx.org/openslx-ng/tutor-module.git
version: 1.0.0
servers:
- url: http://192.168.200.20:9080
tags:
- name: vmchooser
description: Query bwLehrpool events and virtual machine images
- name: container
description: Query bwLehrpool container images
- name: server
description: Status and actions of the bwLehrpool-Server
paths:
/vmchooser/list:
get:
tags:
- vmchooser
summary: List all bwLehrpool virtual machine images
operationId: vmchooserGetList
parameters:
- name: locations
in: query
description: IDs of locations that need to be considered for the filter
required: false
style: spaceDelimited
explode: false
schema:
type: array
items:
type: integer
- name: exams
in: query
description: Include exam events for the filter
required: false
style: form
schema:
type: boolean
default: false
responses:
200:
description: Successful operation
content:
application/xml:
schema:
$ref: '#/components/schemas/VirtualMachineImages'
500:
description: Failed to retrieve list
/vmchooser/lecture/{uuid}/metadata:
get:
tags:
- vmchooser
summary: Get metadata for specified lecture
operationId: vmchooserGetLectureMetadata
parameters:
- name: uuid
in: path
description: UUID of the lecture
required: true
schema:
type: string
format: uuid
responses:
200:
description: Successful operation
content:
application/gzip: {}
500:
description: Faild to retrieve metadata
/vmchooser/lecture/{uuid}/netrules:
get:
tags:
- vmchooser
summary: Get network rules for specified lecture
operationId: vmchooserGetLectureNetRules
parameters:
- name: uuid
in: path
description: UUID of the lecture
required: true
schema:
type: string
format: uuid
responses:
200:
description: Successful operation
content:
text/plain: {}
500:
description: Faild to retrieve network rules
/vmchooser/lecture/{uuid}/imagemeta:
get:
tags:
- vmchooser
summary: Get metadata of virtual mchine image for specified lecture
operationId: vmchooserGetLectureImageMeta
parameters:
- name: uuid
in: path
description: UUID of the lecture
required: true
schema:
type: string
format: uuid
responses:
200:
description: Successful operation
content:
application/json: {}
500:
description: Faild to retrieve metadata
/bwlp/container/clusterimages:
get:
tags:
- container
summary: List all bwLehrpool container images
operationId: bwlpGetClusterImagesList
responses:
200:
description: Successful operation
content:
application/json: {}
500:
description: Failed to retrieve container images
/image/container/{uuid}/metadata:
get:
tags:
- container
summary: Get metadata for specified container image
operationId: getContainerImageMetadata
parameters:
- name: uuid
in: path
description: UUID of the container
required: true
schema:
type: string
format: uuid
responses:
200:
description: Successful operation
content:
application/json: {}
500:
description: Failed to retrieve container metadata
/status/fileserver:
get:
tags:
- server
summary: Get bwLehrpool-Server status
operationId: getFileserverStatus
responses:
200:
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/StatusFileserver'
/do/mailtest:
post:
tags:
- server
summary: Send a test mail from the bwLehrpool-Server
operationId: doMailtestOnFileserver
parameters:
- name: host
in: query
description: Domain of SMTP mail server
required: true
schema:
type: string
- name: port
in: query
description: Port of SMTP mail server
required: true
schema:
type: integer
format: int32
- name: ssl
in: query
description: Encryption mode for the SMTP mail server
required: true
schema:
type: string
enum:
- 'NONE'
- 'IMPLICIT'
- 'EXPLICIT'
- name: serverName
in: query
description: Name of the SMTP mail server
required: true
schema:
type: string
- name: username
in: query
description: Username for the SMTP mail server
required: true
schema:
type: string
- name: password
in: query
description: Password for the SMTP mail server
required: true
schema:
type: string
- name: senderAddress
in: query
description: Sender address for the test mail
required: true
schema:
type: string
- name: recipient
in: query
description: Recipient for the test mail
required: true
schema:
type: string
- name: replyTo
in: query
description: Reply-To address for the test mail
required: true
schema:
type: string
responses:
200:
description: Successful operation
content:
text/plain: {}
400:
description: Failed to send test mail
/do/delete-images:
post:
tags:
- server
summary: Delete old images on the bwLehrpool-Server
operationId: doDeleteOldImagesOnFileserver
responses:
200:
description: Successful operation
content:
text/plain: {}
500:
description: Failed to delete old images
/do/start-image-check:
post:
tags:
- server
summary: Start image check on the bwLehrpool-Server
operationId: doStartImageCheckOnFileserver
parameters:
- name: versionid
in: query
description: Image version for the image check
required: true
schema:
type: string
format: uuid
- name: hash
in: query
description: Check hashes of images
required: true
schema:
type: boolean
- name: update
in: query
description: Update state of images
required: true
schema:
type: boolean
responses:
200:
description: Successful operation
content:
text/plain: {}
500:
description: Failed to start image check
/do/query-image-check:
post:
tags:
- server
summary: Query image check on the bwLehrpool-Server
operationId: doQueryImageCheckOnFileserver
parameters:
- name: versionid
in: query
description: Query image check for specified image version
required: false
schema:
type: string
format: uuid
responses:
200:
description: Successful operation
content:
application/json: {}
500:
description: Failed to query image check
/do/reset-mail-templates:
post:
tags:
- server
summary: Rest mail templates on the bwLehrpool-Server
operationId: doResetMailTemplatesOnFileserver
responses:
200:
description: Successful operation
content:
text/plain: {}
500:
description: Failed to reset mail templates
/do/scan-orphaned-files:
post:
tags:
- server
summary: Scan orphaned files on the bwLehrpool-Server
operationId: doScanOrphanedFilesOnFileserver
parameters:
- name: action
in: query
description: Action for orphaned files
required: false
schema:
type: string
enum:
- 'delete'
responses:
200:
description: Successful operation
content:
application/json: {}
500:
description: Failed to scan orphaned files
components:
schemas:
VirtualMachineImages:
type: object
properties:
settings:
type: array
items:
$ref: '#/components/schemas/VirtualMachineImage'
xml:
name: 'settings'
VirtualMachineImage:
type: object
properties:
name:
type: object
properties:
param:
type: string
xml:
attribute: true
xml:
name: 'image_name'
priority:
type: object
properties:
param:
type: integer
format: int32
xml:
attribute: true
creator:
type: object
properties:
param:
type: string
xml:
attribute: true
shortDescription:
type: object
properties:
param:
type: string
xml:
attribute: true
xml:
name: 'short_description'
longDescription:
type: object
properties:
param:
type: string
xml:
attribute: true
xml:
name: 'long_description'
uuid:
type: object
properties:
param:
type: string
format: uuid
xml:
attribute: true
virtualMachine:
type: object
properties:
param:
type: string
xml:
attribute: true
xml:
name: 'virtualmachine'
os:
type: object
properties:
param:
type: string
xml:
attribute: true
icon:
type: object
properties:
param:
type: string
xml:
attribute: true
virtualizerName:
type: object
properties:
param:
type: string
xml:
attribute: true
xml:
name: 'virtualizer_name'
osName:
type: object
properties:
param:
type: string
xml:
attribute: true
xml:
name: 'os_name'
forLocation:
type: object
properties:
param:
type: string
xml:
attribute: true
xml:
name: 'for_location'
isTemplate:
type: object
properties:
param:
type: integer
format: int32
enum:
- 0
- 1
xml:
attribute: true
xml:
name: 'is_template'
xml:
name: 'eintrag'
StatusFileserver:
type: object
properties:
activeUploads:
type: integer
format: int32
activeDownloads:
type: integer
format: int32
|
