Repository navigation
Expand file tree
/
Copy pathrest_v1_openapi.yaml
More file actions
10037 lines (9452 loc) · 305 KB
/
Copy pathrest_v1_openapi.yaml
File metadata and controls
10037 lines (9452 loc) · 305 KB
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
openapi: 3.0.2
servers:
- url: http://localhost:3370
description: Local Linstor controller
security:
- bearerAuth: []
- {}
info:
description: |
Linstor REST API V1
The V1 rest api of Linstor should stay compatible and only additions are made to the API,
If there are breaking changes or redesigned a new major REST API version will be issued.
Server runs per default on port `3370` on `::` ipv6 and ipv4.
To change the bind address or port you can use the following linstor client commands:
```
linstor controller set-property REST/bindAddress 127.0.0.1
linstor controller set-property REST/port 8080
```
After setting this properties restart the controller and the new values should be used.
version: 1.30.0
title: Linstor REST API
contact:
email: [email protected]
license:
name: GPLv3
url: https://www.gnu.org/licenses/gpl-3.0.html
tags:
- name: developers
description: Operations available to regular developers
paths:
/v1/actions/snapshot/multi:
post:
tags:
- developers
summary: creates one snapshot for multiple resources each
operationId: createMultiSnapshot
description: |
Suspends IO for all given resources before taking the snapshots on
all participating nodes before resuming IO again.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateMultiSnapshotRequest'
example:
name: snap1
responses:
'201':
description: Snapshot created
content:
application/json:
schema:
$ref: '#/components/schemas/ApiCallRcList'
'400':
$ref: '#/components/responses/InvalidInput'
'500':
$ref: '#/components/responses/OperationFailed'
/v1/storage-pool-definitions:
get:
tags:
- developers
summary: Lists storage pool definitions
operationId: storagePoolDfnList
description: Returns an array of all storage pool definitions
parameters:
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/Limit'
responses:
'200':
description: Array of all storage pool definitions
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/StoragePoolDefinition'
post:
tags:
- developers
summary: add a storage pool definition to Linstor
operationId: storagePoolDfnAdd
description: |
Adds a storage pool definition to Linstor
responses:
'201':
description: storage pool definition created
content:
application/json:
schema:
$ref: '#/components/schemas/ApiCallRcList'
'400':
$ref: '#/components/responses/InvalidInput'
'500':
$ref: '#/components/responses/OperationFailed'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StoragePoolDefinition'
example:
storage_pool_name: ssd_pool
description: Storage pool definition to add
/v1/storage-pool-definitions/{storagepool}:
parameters:
- $ref: '#/components/parameters/StoragePool'
get:
tags:
- developers
summary: Lists a specific storage pool definition
operationId: storagePoolDfnGet
description: Returns a specific storage pool definition
responses:
'200':
description: Specified storage pool definition
content:
application/json:
schema:
$ref: '#/components/schemas/StoragePoolDefinition'
put:
tags:
- developers
summary: modify a storage pool definition
operationId: storPoolDfnModify
description: |
Sets or modifies properties
Possible properties are:
- `MaxOversubscriptionRatio` - range[`1-1000`]
responses:
'200':
description: storage pool definition modified
content:
application/json:
schema:
$ref: '#/components/schemas/ApiCallRcList'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StoragePoolDefinitionModify'
example:
override_props:
Aux/testprop: '1'
delete_props:
- Aux/deleteprop
delete:
tags:
- developers
summary: delete a storage pool definition
operationId: storagePoolDefinitionDelete
description: Delete a storage pool definition from Linstor
responses:
'200':
description: storage pool definition deleted
content:
application/json:
schema:
$ref: '#/components/schemas/ApiCallRcList'
'500':
$ref: '#/components/responses/OperationFailed'
/v1/storage-pool-definitions/properties/info:
get:
tags:
- developers
summary: List all storage-pool-definition properties
description: |
List all properties, including their names and descriptions, that can
be set for any given storage pool definition.
responses:
'200':
description: |
A map where the key is the property name and the value is a
PropsInfo object describing the property.
content:
application/json:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/PropsInfo'
example:
MaxOversubscriptionRatio:
info: 'Maximum allowed ratio of the sum of volume sizes in a thin pool to the total capacity of the pool (default 20)'
prop_type: 'range'
value: '(1 - 1000)'
'sys/fs/blkio_throttle_read_iops':
info: 'Sets the /sys/fs/cgroup/blkio/blkio.throttle.read_iops_device'
prop_type: 'long'
/v1/nodes:
get:
tags:
- developers
summary: Lists nodes registered to the controller
operationId: nodeList
description: |
Returns an array of all nodes registered to Linstor.
parameters:
- $ref: '#/components/parameters/Nodes'
- $ref: '#/components/parameters/Props'
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/Limit'
responses:
'200':
description: Array of all node objects
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Node'
'400':
$ref: '#/components/responses/InvalidInput'
post:
tags:
- developers
summary: add a node to Linstor
operationId: nodeAdd
description: |
Adds a node to Linstor
If only one net-interface is specified and it is does not specify
a `satellite_port` it will apply the default port and `satellite_encryption_type`
for this net-interface.
responses:
'201':
description: node created
content:
application/json:
schema:
$ref: '#/components/schemas/ApiCallRcList'
'400':
$ref: '#/components/responses/InvalidInput'
'500':
$ref: '#/components/responses/OperationFailed'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Node'
example:
name: nodeA
type: SATELLITE
net_interfaces:
- name: default
address: 10.0.0.2
satellite_port: 3366
satellite_encryption_type: Plain
is_active: true
description: Node to add to Linstor
/v1/nodes/exec/drbd-reactorctl/status:
post:
tags:
- developers
summary: get drbd-reactor status from nodes
operationId: nodeExecDrbdReactorStatus
description: |
Executes 'drbd-reactorctl status --json' on specified nodes and returns the output.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ReactorExecRequest'
example:
nodes: ["nodeA", "nodeB"]
responses:
'200':
description: drbd-reactor status results
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ReactorExecResponse'
'400':
$ref: '#/components/responses/InvalidInput'
'500':
$ref: '#/components/responses/OperationFailed'
/v1/nodes/exec/drbd-reactorctl/evict:
post:
tags:
- developers
summary: evict drbd-reactor resources on nodes
operationId: nodeExecDrbdReactorEvict
description: |
Executes 'drbd-reactorctl evict <resource>' on specified nodes.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ReactorExecRequest'
example:
nodes: ["nodeA"]
resource: "linstor_controller"
responses:
'200':
description: evict command results
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ReactorExecResponse'
'400':
$ref: '#/components/responses/InvalidInput'
'500':
$ref: '#/components/responses/OperationFailed'
/v1/nodes/exec/drbd-reactorctl/disable:
post:
tags:
- developers
summary: disable drbd-reactor plugin on nodes
operationId: nodeExecDrbdReactorDisable
description: |
Executes 'drbd-reactorctl disable <config>' on specified nodes.
If 'now' is true, also stops the drbd-services target immediately
(equivalent to 'drbd-reactorctl disable --now <config>').
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ReactorPluginRequest'
example:
nodes: ["nodeA"]
config: "linstor_controller"
now: false
responses:
'200':
description: disable command results
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ReactorExecResponse'
'400':
$ref: '#/components/responses/InvalidInput'
'500':
$ref: '#/components/responses/OperationFailed'
/v1/nodes/exec/drbd-reactorctl/enable:
post:
tags:
- developers
summary: enable drbd-reactor plugin on nodes
operationId: nodeExecDrbdReactorEnable
description: |
Executes 'drbd-reactorctl enable <config>' on specified nodes.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ReactorPluginRequest'
example:
nodes: ["nodeA"]
config: "linstor_controller"
responses:
'200':
description: enable command results
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ReactorExecResponse'
'400':
$ref: '#/components/responses/InvalidInput'
'500':
$ref: '#/components/responses/OperationFailed'
/v1/nodes/exec/drbd-reactorctl/restart:
post:
tags:
- developers
summary: restart drbd-reactor plugin on nodes
operationId: nodeExecDrbdReactorRestart
description: |
Executes 'drbd-reactorctl restart <config>' on specified nodes.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ReactorPluginRequest'
example:
nodes: ["nodeA"]
config: "linstor_controller"
responses:
'200':
description: restart command results
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ReactorExecResponse'
'400':
$ref: '#/components/responses/InvalidInput'
'500':
$ref: '#/components/responses/OperationFailed'
/v1/stats/nodes:
get:
tags:
- developers
summary: Return stats of all nodes.
operationId: nodeStats
description: |
Returns a node stats object.
responses:
'200':
description: Object stats
content:
application/json:
schema:
$ref: '#/components/schemas/NodeStats'
'400':
$ref: '#/components/responses/InvalidInput'
/v1/nodes/{node}:
parameters:
- $ref: '#/components/parameters/Node'
get:
tags:
- developers
summary: Lists a specific node
operationId: nodeGet
description: Returns a specific node registered to Linstor
responses:
'200':
description: Specified node
content:
application/json:
schema:
$ref: '#/components/schemas/Node'
'404':
$ref: '#/components/responses/ObjectNotFound'
put:
tags:
- developers
summary: modify a node
operationId: nodeModify
description: |
Sets or modifies properties
Possible properties are:
- `PrefNic` - regex[`^[a-zA-Z0-9_][a-zA-Z0-9_-]{2,47}$`]
Preferred network interface to use
- `StorPoolName` - regex[`^[a-zA-Z0-9_][a-zA-Z0-9_-]{2,47}$`]
Linstor storage pool name to use.
- `StorPoolNameDrbdMeta` - regex[`^|.internal|[a-zA-Z0-9_][a-zA-Z0-9_-]{2,47}$`]
Linstor storage pool name to use for external metadata.
- `sys/fs/blkio_throttle_read` - long
Sets the /sys/fs/cgroup/blkio/blkio.throttle.read_bps_device
- `sys/fs/blkio_throttle_write` - long
Sets the /sys/fs/cgroup/blkio/blkio.throttle.write_bps_device
- `sys/fs/blkio_throttle_read_iops` - long
Sets the /sys/fs/cgroup/blkio/blkio.throttle.read_iops_device
- `sys/fs/blkio_throttle_write_iops` - long
Sets the /sys/fs/cgroup/blkio/blkio.throttle.write_iops_device
- `DrbdOptions/AutoEvictAfterTime` - long
Time a node can be offline before it is declared EVICTED in minutes
- `DrbdOptions/AutoEvictAllowEviction` - boolean_true_false
If set to true on a node, it cannot be evicted anymore
- `Writecache/PoolName` - regex[`^[a-zA-Z0-9_][a-zA-Z0-9_-]{2,47}$`]
Linstor storage pool name for writecache
- `Writecache/Size` - regex[`^100%|[0-9]{1,2}([.][0-9]*)?%|[1-9][0-9]{2,}$`]
Size of the writecache in % (0-100) or KiB otherwise
- `Writecache/Options/StartSector` - long
offset from the start of cache device in 512-byte sectors
- `Writecache/Options/HighWatermark` - long
start writeback when the number of used blocks reach this watermark
- `Writecache/Options/LowWatermark` - long
stop writeback when the number of used blocks drops below this watermark
- `Writecache/Options/WritebackJobs` - long
limit the number of blocks that are in flight during writeback. Setting this value reduces writeback throughput, but it may improve latency of read requests
- `Writecache/Options/AutocommitBlocks` - long
when the application writes this amount of blocks without issuing the FLUSH request, the blocks are automatically commited
- `Writecache/Options/AutocommitTime` - long
autocommit time in milliseconds. The data is automatically commited if this time passes and no FLUSH request is received
- `Writecache/Options/Fua` - enum
"On" results in "fua" as argument, whereas the value "Off" results in "nofua" argument
* On
* Off
- `Writecache/Options/Additional` - string
Additional arguments passed through
- `Cache/OpMode` - enum
Operation mode
* writeback
* writethrough
* passthrough
- `Cache/MetaPool` - regex[`^[a-zA-Z0-9_][a-zA-Z0-9_-]{2,47}$`]
Name of the storage pool used for the cache metadata. If not specified, this will default to the CachePool property
- `Cache/Metasize` - regex[`^100%|[0-9]{1,2}([.][0-9]*)?%|[1-9][0-9]{2,}$`]
Size of the cache in % (0-100) or KiB otherwise.
- `Cache/CachePool` - regex[`^[a-zA-Z0-9_][a-zA-Z0-9_-]{2,47}$`]
Name of the storage pool used for the cache cache device
- `Cache/Cachesize` - regex[`^100%|[0-9]{1,2}([.][0-9]*)?%|[1-9][0-9]{2,}$`]
Size of the cache in % (0-100) or KiB otherwise.
- `Cache/Blocksize` - long
Block size
- `Cache/Policy` - enum
Replacemant policy
* mq
* smq
* cleaner
- `StorDriver/LvcreateOptions` - regex[`.*`]
Additional parameters added to every 'lvcreate ... ' command
- `StorDriver/ZfscreateOptions` - regex[`.*`]
Additional parameters added to every 'zfs create ... ' command
- `StorDriver/Openflex/ApiHost` - regex[`.+`]
Openflex API host name
- `StorDriver/Openflex/ApiPort` - regex[`[0-9]+`]
Openflex API port
- `StorDriver/Openflex/UserName` - regex[`.+`]
Openflex user name
- `StorDriver/Openflex/UserPassword` - regex[`.+`]
Openflex password
- `StorDriver/Openflex/StorDev` - regex[`.+`]
Openflex storage device
- `StorDriver/Openflex/StorDevHost` - regex[`.+`]
Openflex storage device host
- `StorDriver/Openflex/JobWaitDelay` - regex[`[0-9]+`]
Delay in milliseconds linstor waits between fetching the job status
- `StorDriver/Openflex/JobWaitMaxCount` - regex[`[0-9]+`]
Maximum retries with wait delay until openflex fails
- `Autoplacer/MaxThroughput` - long
The maximum throughput the given storage pool is capable of.
- `DrbdProxy/AutoEnable` - boolean_true_false
- `Site` - string
- `DrbdOptions/auto-diskful-allow-cleanup` - boolean_true_false
Allows this resource to be cleaned up after toggle-disk + resync is finished
responses:
'200':
description: node modified
content:
application/json:
schema:
$ref: '#/components/schemas/ApiCallRcList'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NodeModify'
example:
override_props:
Aux/testprop: '1'
delete_props:
- Aux/deleteprop
delete:
tags:
- developers
summary: delete a node
operationId: nodeDelete
description: Delete a node from Linstor
responses:
'200':
description: node deleted
content:
application/json:
schema:
$ref: '#/components/schemas/ApiCallRcList'
'500':
$ref: '#/components/responses/OperationFailed'
/v1/nodes/properties/info:
get:
tags:
- developers
summary: List all node properties
description: |
List all properties, including their names and descriptions, that can
be set for any given node.
responses:
'200':
description: |
A map where the key is the property name and the value is a
PropsInfo object describing the property.
content:
application/json:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/PropsInfo'
example:
'Cache/Cachesize':
info: 'Size of the cache in % (0-100) or KiB otherwise.'
prop_type: 'regex'
value: '^100%|[0-9]{1,2}([.][0-9]*)?%|[1-9][0-9]{2,}$'
dflt: '5%'
StorPoolName:
info: 'Linstor storage pool name to use.'
prop_type: 'regex'
value: '^[a-zA-Z0-9_][a-zA-Z0-9_-]{2,47}$'
/v1/nodes/{node}/lost:
parameters:
- $ref: '#/components/parameters/Node'
delete:
tags:
- developers
summary: delete an unrecoverable node
operationId: nodeLost
description: Delete an unrecoverable node
responses:
'200':
description: node deleted
content:
application/json:
schema:
$ref: '#/components/schemas/ApiCallRcList'
'500':
$ref: '#/components/responses/OperationFailed'
/v1/nodes/{node}/reconnect:
parameters:
- $ref: '#/components/parameters/Node'
put:
tags:
- developers
summary: reconnect a node to the controller
operationId: nodeReconnect
description: Reconnect a node to the controller
responses:
'200':
description: node put into reconnect cycle
content:
application/json:
schema:
$ref: '#/components/schemas/ApiCallRcList'
'500':
$ref: '#/components/responses/OperationFailed'
/v1/nodes/{node}/net-interfaces:
parameters:
- $ref: '#/components/parameters/Node'
get:
tags:
- developers
summary: return the list of net-interfaces
operationId: netinterfaceList
description: Returns the list of netinterfaces for this node
parameters:
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/Limit'
responses:
'200':
description: Array of net-interfaces
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/NetInterface'
'500':
$ref: '#/components/responses/OperationFailed'
post:
tags:
- developers
summary: create a netinterface on a node
operationId: netinterfaceCreate
description: |
Create a netinterface on a node
If satellite_port and satellite_encryption_type are given
the netinterface can also work as connection to the controller
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NetInterface'
responses:
'201':
description: netinterface created
content:
application/json:
schema:
$ref: '#/components/schemas/ApiCallRcList'
'400':
$ref: '#/components/responses/InvalidInput'
'500':
$ref: '#/components/responses/OperationFailed'
/v1/nodes/{node}/net-interfaces/{netinterface}:
parameters:
- $ref: '#/components/parameters/Node'
- $ref: '#/components/parameters/NetInterface'
get:
tags:
- developers
summary: Lists a specific netinterface of a node
operationId: netinterfaceGet
description: Returns a specific netinterface of a node
responses:
'200':
description: Specified netinterface
content:
application/json:
schema:
$ref: '#/components/schemas/NetInterface'
'404':
$ref: '#/components/responses/ObjectNotFound'
put:
tags:
- developers
summary: modify a netinterface from a node
operationId: netinterfaceModified
description: Modify a netinterface from a node
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NetInterface'
responses:
'200':
description: netinterface modified
content:
application/json:
schema:
$ref: '#/components/schemas/ApiCallRcList'
'400':
$ref: '#/components/responses/InvalidInput'
'500':
$ref: '#/components/responses/OperationFailed'
delete:
tags:
- developers
summary: delete a netinterface from a node
operationId: netinterfaceDelete
description: Delete a netinterface from a node
responses:
'200':
description: netinterface deleted
content:
application/json:
schema:
$ref: '#/components/schemas/ApiCallRcList'
'500':
$ref: '#/components/responses/OperationFailed'
/v1/nodes/{node}/storage-pools:
parameters:
- $ref: '#/components/parameters/Node'
get:
tags:
- developers
summary: lists all storage pools for a node
operationId: nodeStoragePoolList
description: Lists all storage pools of a node
parameters:
- $ref: '#/components/parameters/Nodes'
- name: storage_pools
in: query
description: Filter only for the specified storage pools, if not specified
no filtering. Names may be Java regular expressions and are
matched case-insensitively.
schema:
type: array
items:
type: string
- $ref: '#/components/parameters/Props'
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Cached'
responses:
'200':
description: Array list of all storage pools
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/StoragePool'
post:
tags:
- developers
summary: creates a new storage pool on this node
operationId: nodeStoragePoolCreate
description: |
Creates a new storage pool on this node.
`provider_kind` has to be specified and additional to that
the linked `StorDriver` property that has the value to the backing pool:
* `LVM`: `StorDriver/LvmVg`
* `LVM_THIN`: `StorDriver/LvmVg` and `StorDriver/ThinPool`
* `ZFS`: `StorDriver/ZPool`
* `ZFS_THIN`: `StorDriver/ZPoolThin`
* `DISKLESS`: Does not need a property as it has no backing pool
responses:
'201':
description: storage pool created
content:
application/json:
schema:
$ref: '#/components/schemas/ApiCallRcList'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StoragePool'
example:
storage_pool_name: DfltStorPool
provider_kind: LVM_THIN
props:
StorDriver/LvmVg: mylvmpool
StorDriver/ThinPool: thin
/v1/nodes/{node}/storage-pools/{storagepool}:
parameters:
- $ref: '#/components/parameters/Node'
- $ref: '#/components/parameters/StoragePool'
get:
tags:
- developers
summary: Lists a specific storage pool of a node
operationId: nodeStoragePoolGet
description: Returns a specific storage pool of a node
parameters:
- $ref: '#/components/parameters/Cached'
responses:
'200':
description: Specified storage pool
content:
application/json:
schema:
$ref: '#/components/schemas/StoragePool'
'404':
$ref: '#/components/responses/ObjectNotFound'
put:
tags:
- developers
summary: modify a storage pool
operationId: nodeStoragePoolModify
description: |
Sets or modifies properties
Possible properties are:
- `StorDriver/StorPoolName` - regex[`[a-zA-Z0-9_/-]+`]
- `StorDriver/LvmVg` - regex[`[a-zA-Z0-9_-]+`]
- `StorDriver/ThinPool` - regex[`[a-zA-Z0-9_-]+`]
- `StorDriver/ZPool` - regex[`[a-zA-Z0-9_/-]+`]
- `StorDriver/ZPoolThin` - regex[`[a-zA-Z0-9_/-]+`]
- `StorDriver/FileDir` - regex[`.*`]
- `PrefNic` - regex[`^[a-zA-Z0-9_][a-zA-Z0-9_-]{2,47}$`]
Preferred network interface to use
- `NVMe/PrefNic` - regex[`^[a-zA-Z0-9_][a-zA-Z0-9_-]{2,47}$`]
Preferred network interface to use
- `StorDriver/LvcreateType` - enum
* linear
* striped
* mirror
* raid0
* raid1
* raid4
* raid5
* raid6
* raid10
* lzma
* lz4
- `StorDriver/LvcreateOptions` - regex[`.*`]
Additional parameters added to every 'lvcreate ... ' command
- `StorDriver/ZfscreateOptions` - regex[`.*`]
Additional parameters added to every 'zfs create ... ' command
- `StorDriver/WaitTimeoutAfterCreate` - regex[`[0-9]+`]
- `sys/fs/blkio_throttle_read` - long
Sets the /sys/fs/cgroup/blkio/blkio.throttle.read_bps_device
- `sys/fs/blkio_throttle_write` - long
Sets the /sys/fs/cgroup/blkio/blkio.throttle.write_bps_device
- `sys/fs/blkio_throttle_read_iops` - long
Sets the /sys/fs/cgroup/blkio/blkio.throttle.read_iops_device
- `sys/fs/blkio_throttle_write_iops` - long
Sets the /sys/fs/cgroup/blkio/blkio.throttle.write_iops_device
- `StorDriver/Openflex/ApiHost` - regex[`.+`]
Openflex API host name
- `StorDriver/Openflex/ApiPort` - regex[`[0-9]+`]
Openflex API port
- `StorDriver/Openflex/UserName` - regex[`.+`]
Openflex user name
- `StorDriver/Openflex/UserPassword` - regex[`.+`]
Openflex password
- `StorDriver/Openflex/StorDev` - regex[`.+`]
Openflex storage device
- `StorDriver/Openflex/StorDevHost` - regex[`.+`]
Openflex storage device host
- `StorDriver/Openflex/StorPool` - regex[`[0-9]+`]
Openflex storage pool name
- `Autoplacer/MaxThroughput` - long
The maximum throughput the given storage pool is capable of.
responses:
'200':
description: storage pool modified
content:
application/json:
schema:
$ref: '#/components/schemas/ApiCallRcList'
requestBody:
content: