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
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
|
swagger: '2.0'
info:
version: "1.1.0"
title: OpenGnsys REST API definition
description: |
Information about the OpenGnsys REST API functions (including Server and
Repository Manager).
contact:
name: OpenGnsys Project
url: https://opengnsys.es/
license:
name: Creative Commons 4.0 International
url: http://creativecommons.org/licenses/by/4.0/
basePath: /opengnsys/rest
schemes:
- https
consumes:
- application/json
produces:
- application/json
securityDefinitions:
apikey:
type: apiKey
name: Authorization
in: header
# Paths description.
paths:
/login:
post:
description: Check user login and returns his/her API key.
parameters:
- in: body
name: authdata
description: JSON authentication data
required: true
schema:
type: object
properties:
username:
type: string
password:
type: string
format: password
responses:
"200":
description: Successful login
schema:
type: object
properties:
userid:
type: integer
description: user identificator
format: int32
apikey:
description: API key to include in ``Authorization`` header
type: string
"400":
description: Missing parameters
schema:
type: object
properties:
message:
type: string
"500":
description: Authentication error
schema:
type: object
properties:
message:
type: string
tags:
- server
- user
/info:
get:
description: Gets OpenGnsys Server information
responses:
"200":
description: Successful response
schema:
type: object
properties:
project:
description: project name (OpenGnsys)
type: string
version:
description: project version
type: string
release:
description: project release
type: string
services:
description: actived services
type: array
items:
type: string
enum: [ 'server', 'repository', 'tracker' ]
oglive:
description: installed ogLive clients
type: array
items:
type: object
properties:
distribution:
description: base distribution
type: string
kernel:
description: kernel version
type: string
architecture:
description: kernel architecture (32-bit or 64-bit)
type: string
enum: [ "i386", "amd64" ]
revision:
description: OpenGnsys revision
type: string
directory:
description: installation directory
type: string
iso:
description: ISO file
type: string
required: [ distribution, kernel, architecture, revision, directory, iso ]
required: [ project, version, release, services ]
tags:
- server
- repository
/status:
get:
description: Gets OpenGnsys Server status information
responses:
"200":
description: Successful response
schema:
type: object
properties:
memInfo:
description: memory information
properties:
total:
description: total amount of memory
type: integer
format: int64
used:
description: amount of used memory
type: integer
format: int64
required: [ total, used ]
cpu:
description: CPU information
properties:
model:
description: processor model
type: string
usage:
description: average of processor load
type: number
format: float
required: [ model, usage ]
required: [ memInfo, cpu ]
tags:
- server
/ous:
get:
description: Gets all `OU` objects.
responses:
"200":
description: Successful response
schema:
type: array
items:
type: object
properties:
id:
type: integer
description: Organization Unit identificator
format: int32
minimum: 1
name:
type: string
description: Organization Unit name
required: [ id, name ]
tags:
- server
- ou
/ous/{ouid}:
get:
description: Get an `OU` object.
parameters:
- $ref: "#/parameters/ouParam"
responses:
"200":
description: Successful response
schema:
type: object
properties:
id:
type: integer
description: OU identificator
name:
type: string
description: OU name
description:
type: string
description: OU description
required: [ id, name, description ]
security:
- apikey: []
tags:
- server
- ou
/ous/{ouid}/groups:
get:
description: Get all group of labs defined in an `OU` object.
parameters:
- $ref: "#/parameters/ouParam"
responses:
"200":
description: Successful response
schema:
type: array
items:
type: object
properties:
id:
description: group identificator
type: integer
format: int32
name:
description: group name
type: string
type:
description: group type
type: integer
comments:
description: extra comments
type: string
parent:
description: parent group
type: object
properties:
id:
description: parent group identificator
type: integer
format: int32
required: [ id, name, comments ]
security:
- apikey: []
tags:
- server
- ou
/ous/{ouid}/labs:
get:
description: Get all `lab` objects defined in an `OU`.
parameters:
- $ref: "#/parameters/ouParam"
responses:
"200":
description: Successful response
schema:
type: array
items:
type: object
properties:
id:
type: integer
description: laboratory identificator
format: int32
name:
type: string
description: laboratory name
inremotepc:
type: boolean
description: laboratory usable in Remote PC Project flag
group:
type: object
properties:
id:
description: group identificator
type: integer
format: int32
ou:
type: object
properties:
id:
description: OU identificator
type: integer
format: int32
required: [ id, name, inremotepc, ou ]
security:
- apikey: []
tags:
- server
- lab
/ous/{ouid}/labs/{labid}:
get:
description: Get a `lab` object.
parameters:
- $ref: "#/parameters/ouParam"
- $ref: "#/parameters/labParam"
responses:
"200":
description: Successful response
schema:
type: object
properties:
id:
description: laboratory identificator
type: integer
format: int32
name:
description: laboratory name
type: string
location:
description: laboratory location
type: string
description:
description: laboratory description
type: string
inremotepc:
description: check if this lab can be included in Remote PC Project
type: boolean
capacity:
description: maximum number of people in the lab
type: integer
format: int32
defclients:
description: number of defined clients in the lab
type: integer
format: int32
projector:
description: check if this lab has a projector
type: boolean
board:
description: check if this lab has an electronic board
type: boolean
routerip:
description: lab router IP address
type: string
netmask:
description: network mask to use in the lab
type: string
ntp:
description: NTP server IP address
type: string
dns:
description: DNS server IP address
type: string
proxyurl:
description: Proxy server URL
type: string
mcastmode:
description: Multicast protocol mode (full-duplex, half-duplex).
type: string
enum: [ "full-duplex", "half-duplex" ]
default: "full-duplex"
mcastip:
description: Multicast IP address
type: string
mcastport:
description: Multicast port
type: integer
format: int32
mcastspeed:
description: Multicast speed (in Mbps)
type: integer
format: int32
p2pmode:
description: Bittorrent connection type ("peer", "leecher". "seeder").
type: string
p2ptime:
description: Bittorrent connection extra time (in s.)
type: integer
format: int32
picture:
description: Lab's picture file
type: string
required: [ id, name, location, description, inremotepc, capacity, defclients, projector, board, routerip, netmask, mcastmode, mcastip, mcastport, mcastspeed, p2pmode, p2ptime, picture ]
security:
- apikey: []
tags:
- server
- lab
/ous/{ouid}/labs/{labid}/clients:
get:
description: Get all `client` objects defined in an `lab`.
parameters:
- $ref: "#/parameters/ouParam"
- $ref: "#/parameters/labParam"
responses:
"200":
description: Successful response
schema:
type: array
items:
$ref: "#/definitions/SelectedClientModel"
security:
- apikey: []
tags:
- server
- client
/ous/{ouid}/labs/{labid}/clients/status:
get:
description: Get execution status of all clients definied in a `lab`
parameters:
- $ref: "#/parameters/ouParam"
- $ref: "#/parameters/labParam"
responses:
"200":
description: Successful response
schema:
type: array
items:
$ref: "#/definitions/StatusModel"
security:
- apikey: []
tags:
- server
- client
/ous/{ouid}/labs/{labid}/clients/{clientid}:
get:
description: Get a `client` object.
parameters:
- $ref: "#/parameters/ouParam"
- $ref: "#/parameters/labParam"
- $ref: "#/parameters/clientParam"
responses:
"200":
description: Successful response
schema:
type: object
properties:
id:
description: client id
type: integer
format: int32
name:
description: client name
type: string
serialno:
description: client serial number
type: string
netiface:
description: main network interface
type: string
netdriver:
description: client MAC address (kernel module)
type: string
mac:
description: client MAC address
type: string
ip:
description: client IP address
type: string
netmask:
description: subnet mask address
type: string
routerip:
description: network router IP address
type: string
repo:
description: repository identification
type: object
properties:
id:
type: integer
format: int32
validation:
description: boot validation flag
type: boolean
boottype:
description: boot template type
type: string
picture:
description: client's picture file
type: string
required: [ id, name, serialno, netiface, netdriver, mac, ip, netmask, routerip, repo, validation, picture ]
security:
- apikey: []
tags:
- server
- client
/ous/{ouid}/labs/{labid}/clients/{clientid}/hardware:
get:
description: Get the hardware definition of a `client` object.
parameters:
- $ref: "#/parameters/ouParam"
- $ref: "#/parameters/labParam"
- $ref: "#/parameters/clientParam"
responses:
"200":
description: Successful response
schema:
type: object
properties:
id:
description: client id
type: integer
format: int32
name:
description: client name
type: string
hardware:
description: hardware components
type: array
items:
type: object
properties:
type:
description: hardware component type
type: string
description:
description: hardware component description
type: string
required: [ type, description ]
required: [ id, name, hardware ]
security:
- apikey: []
tags:
- server
- client
/ous/{ouid}/labs/{labid}/clients/{clientid}/diskcfg:
get:
description: Get disks configuration of a `client`
parameters:
- $ref: "#/parameters/ouParam"
- $ref: "#/parameters/labParam"
- $ref: "#/parameters/clientParam"
responses:
"200":
description: Successful response
schema:
type: object
properties:
id:
description: client id
type: integer
format: int32
name:
description: client name
type: string
diskcfg:
description: |
array of disk configuration data, including general disk information and
partition/filesystem information (if not specified in paratmeter
description, it is only valid in partition configuration).
type: array
items:
type: object
properties:
disk:
description: disk number
type: integer
format: int32
minimum: 1
size:
description: disk or partition size
type: integer
format: int64
parttable:
description: partition table type (only in disk configuration)
type: string
enum: [ "MSDOS", "GPT", "LVM", "ZVOL" ]
partition:
description: partition number (only in partition configuration)
type: integer
format: int32
minimum: 1
parttype:
description: partition type (only in partition configuration)
type: string
filesystem:
description: filesystem type (only in partition configuration)
type: string
usage:
description: percentage of data usage in a formated filesystem (only in partition configuration)
type: integer
format: int32
os:
description: installed operating system (only in partition configuration)
type: string
image:
description: restaured image data, if needed (only in partition configuration)
type: object
properties:
id:
type: integer
format: int32
deploydate:
description: image restauration/deploying date (only in partition configuration)
type: string
format: date-time
updated:
description: flag to check if the restaured image is updated (only in partition configuration)
type: boolean
required: [ id, name, diskcfg ]
security:
- apikey: []
tags:
- server
- client
/ous/{ouid}/labs/{labid}/clients/{clientid}/status:
get:
description: Get execution status of a `client`
parameters:
- $ref: "#/parameters/ouParam"
- $ref: "#/parameters/labParam"
- $ref: "#/parameters/clientParam"
responses:
"200":
description: Successful response
schema:
$ref: "#/definitions/StatusModel"
security:
- apikey: []
tags:
- server
- client
/ous/{ouid}/labs/{labid}/clients/{clientid}/events:
post:
description: Store UDS server URLs to resend some events recieved from OGAgent.
parameters:
- $ref: "#/parameters/ouParam"
- $ref: "#/parameters/labParam"
- $ref: "#/parameters/clientParam"
- name: data
in: body
description: Operation data
required: true
schema:
type: object
properties:
urlLogin:
description: URL to resend a login event.
type: string
urlLogout:
description: URL to resend a logout event.
type: string
required: [ urlLogin, urlLogout ]
responses:
"200":
description: Successful response
"400":
description: Error message
schema:
type: object
properties:
message:
type: string
security:
- apikey: []
tags:
- server
- client
- remotepc
/ous/{ouid}/labs/{labid}/clients/{clientid}/session:
post:
description: Record session data for a client.
parameters:
- $ref: "#/parameters/ouParam"
- $ref: "#/parameters/labParam"
- $ref: "#/parameters/clientParam"
- name: data
in: body
description: Session parameters
required: true
schema:
type: object
properties:
logoutAt:
description: Time to send a logout operation to the client
type: string
format: date-time
responses:
"200":
description: Successful response
security:
- apikey: []
tags:
- server
- client
- remotepc
/ous/{ouid}/labs/{labid}/clients/{clientid}/unreserve:
delete:
description: Unreserve a client, clear its session data and send a poweroff operation.
parameters:
- $ref: "#/parameters/ouParam"
- $ref: "#/parameters/labParam"
- $ref: "#/parameters/clientParam"
responses:
"200":
description: Successful response
security:
- apikey: []
tags:
- server
- client
- remotepc
/ous/{ouid}/repos:
get:
description: Get all `repo` objects defined in an `OU`.
parameters:
- $ref: "#/parameters/ouParam"
responses:
"200":
description: Successful response
schema:
type: array
items:
type: object
properties:
id:
type: integer
format: int32
name:
type: string
ou:
type: object
properties:
id:
type: integer
format: int32
required: [ id, name, ou ]
security:
- apikey: []
tags:
- server
- repo
/ous/{ouid}/repos/{repoid}:
get:
description: Get a `repo` object.
parameters:
- $ref: "#/parameters/ouParam"
- $ref: "#/parameters/repoParam"
responses:
"200":
description: Successful response
schema:
type: object
properties:
id:
description: repository id
type: integer
format: int32
name:
description: repository name
type: string
description:
description: repository description
type: string
ip:
description: repository IP address
type: string
required: [ id, name, description, ip ]
security:
- apikey: []
tags:
- server
- repo
/ous/{ouid}/images:
get:
description: Get all `image` objects defined in an `OU`.
parameters:
- $ref: "#/parameters/ouParam"
responses:
"200":
description: Successful response
schema:
type: array
items:
type: object
properties:
id:
type: integer
format: int32
name:
type: string
inremotepc:
type: boolean
ou:
type: object
properties:
id:
type: integer
format: int32
required: [ id, name, inremotepc, ou ]
security:
- apikey: []
tags:
- server
- image
/ous/{ouid}/images/{imageid}:
get:
description: Get an `image` object.
parameters:
- $ref: "#/parameters/ouParam"
- $ref: "#/parameters/imageParam"
responses:
"200":
description: Successful response
schema:
type: object
properties:
id:
description: image id
type: integer
format: int32
name:
description: image name
type: string
description:
description: image description
type: string
comments:
description: extra comments
type: string
inremotepc:
description: image usable in Remote PC Project flag
type: boolean
repo:
description: repository identification
type: object
properties:
id:
type: integer
format: int32
type:
description: image type (``monolithic``, ``basic``, ``incremental``)
type: string
enum: [ "monolithic", "basic", "incremental" ]
default: "monolithic"
baseimg:
description: base image for an incremental image (if ``type`` is ``incremental``)
type: string
client:
description: model client's data
type: object
properties:
id:
description: model client's id.
type: integer
format: int32
disk:
description: source disk number
type: integer
format: int32
partition:
description: source partition number
type: integer
format: int32
required: [ id, disk, partition ]
creationdate:
description: image creation date
type: string
format: date-time
release:
description: image creation release
type: string
os:
description: installed operating system
type: string
required: [ id, name, description, comments, inremotepc, repo, type ]
security:
- apikey: []
tags:
- server
- image
/ous/{ouid}/images/{imageid}/software:
get:
description: Get software inventory store into an `image`
parameters:
- $ref: "#/parameters/ouParam"
- $ref: "#/parameters/imageParam"
responses:
"200":
description: Successful response
schema:
type: object
properties:
id:
description: image id
type: integer
format: int32
name:
description: image name
type: string
software:
description: software installed
type: object
properties:
os:
description: operating system
type: string
applications:
type: array
items:
description: list of applications (name and version)
type: string
required: [ id, name, software ]
security:
- apikey: []
tags:
- server
- image
/ous/{ouid}/images/{imageid}/reserve:
post:
description: |
Reserve a client with an installed image and send a boot/reboot operation.
If `labid` is specified, then choose a `client` defined in this lab.
parameters:
- $ref: "#/parameters/ouParam"
- $ref: "#/parameters/imageParam"
- in: body
name: data
description: Operation data
schema:
type: object
properties:
labid:
description: lab id filter (optional)
type: integer
format: int32
minimum: 1
maxtime:
description: maximum reservation time, in h. (optional, 24 h. by default)
type: integer
format: int32
minimum: 1
default: 24
responses:
"200":
description: Reserve a client to boot using an operating system image.
schema:
$ref: "#/definitions/SelectedClientModel"
security:
- apikey: []
tags:
- server
- image
- remotepc
/repository/images:
get:
description: Get information about images stored in a repository
responses:
"200":
description: Successful response
schema:
type: object
properties:
directory:
description: repository directory
type: string
images:
description: information about repository-global images
type: array
items:
$ref: "#/definitions/ImageModel"
ous:
description: OUs defined
type: array
items:
type: object
properties:
subdir:
description: OU subdirectory
type: string
images:
description: information about OU-based images
type: array
items:
$ref: "#/definitions/ImageModel"
disk:
description: repository disk information
type: object
properties:
total:
description: total disk space
type: string
used:
description: disk space used by files
type: string
free:
description: amount of free disk space
type: string
percent:
description: percentage of used space
type: string
required: [ total, used, free, percent ]
required: [ directory, images, ous, disk ]
security:
- apikey: []
tags:
- repository
- image
/repository/image/{ouname}/{imagename}:
get:
description: Get information about an specific image stored in the repository
parameters:
- in: path
name: ouname
description: OU name (optional)
required: false
type: string
- in: path
name: imagename
description: image name
required: true
type: string
responses:
"200":
description: Successful response
schema:
$ref: "#/definitions/ImageModel"
security:
- apikey: []
tags:
- repository
- image
/repository/poweron:
post:
description: send Wake-On-Lan notification to many clients
parameters:
- in: body
name: data
description: Operation data
required: true
schema:
type: object
properties:
macs:
type: array
items:
description: MAC (Ethernet) address
type: string
responses:
"200":
description: Successful response
schema:
type: object
properties:
output:
type: string
security:
- apikey: []
tags:
- repository
- client
/ogagent/started:
post:
description: Process push notification when OGAgent is started
parameters:
- in: body
name: data
description: Operation data
required: true
schema:
type: object
properties:
ip:
type: string
mac:
type: string
ostype:
type: string
osversion:
type: string
secret:
type: string
responses:
"200":
description: Successful operation
"400":
description: An error has occurred
tags:
- server
- agent
/ogagent/stopped:
post:
description: Process push notification when OGAgent is stopped
parameters:
- in: body
name: data
description: Operation data
required: true
schema:
type: object
properties:
ip:
type: string
mac:
type: string
ostype:
type: string
osversion:
type: string
responses:
"200":
description: Successful operation
"400":
description: An error has occurred
tags:
- server
- agent
/ogagent/loggedin:
post:
description: Process push notification when an user logged in
parameters:
- in: body
name: data
description: Operation data
required: true
schema:
type: object
properties:
ip:
type: string
user:
type: string
language:
type: string
ostype:
type: string
osversion:
type: string
responses:
"200":
description: Successful operation
"400":
description: An error has occurred
tags:
- server
- agent
/ogagent/loggedout:
post:
description: Process push notification when an user is logged in
parameters:
- in: body
name: data
description: Operation data
required: true
schema:
type: object
properties:
ip:
type: string
user:
type: string
responses:
"200":
description: Successful operation
"400":
description: An error has occurred
tags:
- server
- agent
parameters:
ouParam:
name: ouid
in: path
description: OU identificator
required: true
type: integer
minimum: 1
labParam:
name: labid
in: path
description: Lab identificator
required: true
type: integer
minimum: 1
clientParam:
name: clientid
in: path
description: Client identificator
required: true
type: integer
minimum: 1
repoParam:
name: repoid
in: path
description: repository identificator
required: true
type: integer
minimum: 1
imageParam:
name: imageid
in: path
description: image definition identificator
required: true
type: integer
minimum: 1
definitions:
StatusModel:
type: object
properties:
id:
description: client id
type: integer
format: int32
minimum: 1
ip:
description: client IP address
type: string
status:
description: execution status
type: string
enum: [ "off", "oglive", "busy", "linux", "windows", "macos", "unknown" ]
loggedin:
description: flag to check if an user is logged in
type: boolean
required: [ id, ip, status ]
SelectedClientModel:
type: object
properties:
id:
description: client id
type: integer
format: int32
minimum: 1
name:
description: client name
type: string
mac:
description: client MAC address
type: string
ip:
description: client IP address
type: string
lab:
description: client's lab
type: object
properties:
id:
description: lab id
type: integer
format: int32
minimum: 1
required: [ id ]
ou:
description: client's OU
type: object
properties:
id:
description: OU id
type: integer
format: int32
minimum: 1
required: [ id ]
required: [ id, name, mac, ip, lab, ou ]
ImageModel:
type: object
properties:
name:
description: image name (file name without extension)
type: string
type:
description: image type (file extension or `dir` for directory image)
type: string
clientname:
description: source client name
type: string
clonator:
description: clonation program
type: string
compressor:
description: compression program
type: string
filesystem:
description: filesystem type
type: string
datasize:
description: data size (bytes)
type: integer
format: int64
size:
description: image size (bytes)
type: integer
format: int64
modified:
description: image modification date
type: string
format: date-time
mode:
description: image access permissions (four octal digits)
type: string
backedup:
description: image backed up flag (check if `.ant` file exists)
type: boolean
default: false
backupsize:
description: image backup size (bytes)
type: integer
format: int64
locked:
description: image locked flag (check if `.lock` file exists)
type: boolean
default: false
required: [ name, type, clientname, clonator, compressor, filesystem, datasize, size, modified, mode, backedup, locked ]
|