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
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
|
# File 'lib/osctl/cli/app.rb', line 18
def setup
Thread.abort_on_exception = true
program_desc 'Management utility for vpsAdminOS'
version OsCtl::VERSION
subcommand_option_handling :normal
preserve_argv true
arguments :strict
hide_commands_without_desc true
desc 'Show precise values'
switch %i[p parsable], negatable: false
desc 'Format output in JSON'
switch %i[j json], negatable: false
desc 'Toggle colorized output'
switch :color, default_value: true
desc 'Pool name'
flag :pool, arg_name: 'pool'
desc 'Surpress output'
switch %i[q quiet], negatable: false
desc 'Manage data pools'
command :pool do |p|
p.desc 'List imported pools'
p.arg_name '[pools...]'
p.command %i[ls list] do |ls|
ls.desc 'Select parameters to output'
ls.flag %i[o output], arg_name: 'parameters'
ls.desc 'Do not show header'
ls.switch %i[H hide-header], negatable: false
ls.desc 'List available parameters'
ls.switch %i[L list], negatable: false
ls.desc 'Sort by parameter(s)'
ls.flag %i[s sort], arg_name: 'parameters'
ls.action(&Command.run(Pool, :list))
end
p.desc 'Show information about imported pool'
p.arg_name '<pool>'
p.command :show do |c|
c.desc 'Select parameters to output'
c.flag %i[o output], arg_name: 'parameters'
c.desc 'Do not show header'
c.switch %i[H hide-header], negatable: false
c.desc 'List available parameters'
c.switch %i[L list], negatable: false
c.action(&Command.run(Pool, :show))
end
p.desc 'Import pool(s)'
p.arg_name '[pool]'
p.command :import do |c|
c.desc 'Import all installed pools'
c.switch %i[a all], negatable: false
c.desc 'Start containers that are configured to be started automatically'
c.switch %i[s autostart], default_value: true
c.action(&Command.run(Pool, :import))
end
p.desc 'Export imported pool'
p.arg_name '<pool>'
p.command :export do |c|
c.desc 'Export the pool even if there are containers running'
c.switch %i[f force]
c.desc 'Stop all containers from the exported pool'
c.switch %i[s stop-containers], default_value: true
c.desc 'Unregister system users that come from the exported pool'
c.switch %i[u unregister-users], default_value: true
c.desc 'Message sent to logged-in container users'
c.flag %i[m message], arg_name: 'message'
c.desc 'Do not fail if the pool is not imported'
c.switch %i[if-imported]
c.desc 'Abort running pool export'
c.switch %i[abort], negatable: false
c.action(&Command.run(Pool, :export))
end
p.desc 'Install a new pool'
p.arg_name '<pool>'
p.command :install do |c|
c.desc 'Place osctld datasets into a subdataset'
c.flag :dataset, arg_name: 'dataset'
c.action(&Command.run(Pool, :install))
end
p.desc 'Uninstall pool'
p.arg_name '<pool>'
p.command :uninstall do |c|
c.action(&Command.run(Pool, :uninstall))
end
p.desc "List pool's assets (datasets, files, directories)"
p.arg_name '<pool>'
assets(p, Pool)
p.desc 'Check and trigger container auto-starting'
p.command :autostart do |as|
as.desc 'Check auto-start queue'
as.arg_name '<pool>'
as.command :queue do |c|
c.desc 'Select parameters to output'
c.flag %i[o output], arg_name: 'parameters'
c.desc 'Do not show header'
c.switch %i[H hide-header], negatable: false
c.desc 'List available parameters'
c.switch %i[L list], negatable: false
c.action(&Command.run(Pool, :autostart_queue))
end
as.desc 'Start containers that have auto-start enabled'
as.arg_name '<pool>'
as.command :trigger do |c|
c.action(&Command.run(Pool, :autostart_trigger))
end
as.desc 'Cancel start of containers left in the queue'
as.arg_name '<pool>'
as.command :cancel do |c|
c.action(&Command.run(Pool, :autostart_cancel))
end
end
p.desc 'Configure pool options'
p.command :set do |set|
set.desc 'How many containers should be simultaneously started at pool import'
set.arg_name '<pool> <n>'
set.command 'parallel-start' do |c|
c.action(&Command.run(Pool, :set, [:parallel_start]))
end
set.desc 'How many containers should be simultaneously stopped at pool export'
set.arg_name '<pool> <n>'
set.command 'parallel-stop' do |c|
c.action(&Command.run(Pool, :set, [:parallel_stop]))
end
set_attr(set, Pool, 'pool')
end
p.desc 'Reset pool options'
p.command :unset do |unset|
unset.desc 'How many containers should be simultaneously started at pool import'
unset.arg_name '<pool>'
unset.command 'parallel-start' do |c|
c.action(&Command.run(Pool, :unset, [:parallel_start]))
end
unset.desc 'How many containers should be simultaneously stopped at pool export'
unset.arg_name '<pool>'
unset.command 'parallel-stop' do |c|
c.action(&Command.run(Pool, :unset, [:parallel_stop]))
end
unset_attr(unset, Pool, 'pool')
end
end
desc 'Manage ID ranges'
command 'id-ranges' do |idr|
idr.desc 'Create a new ID range'
idr.arg_name '<id-range>'
idr.command %i[new create] do |c|
c.desc 'The first user/group ID'
c.flag 'start-id', arg_name: 'n', required: true, type: Integer
c.desc 'Number of user/group IDs making up the minimum allocation unit'
c.flag 'block-size', arg_name: 'n', required: true, type: Integer
c.desc 'How many blocks should the range include'
c.flag 'block-count', arg_name: 'n', required: true, type: Integer
c.action(&Command.run(IdRange, :create))
end
idr.desc 'Delete ID range'
idr.arg_name '<id-range>'
idr.command %i[del delete] do |c|
c.action(&Command.run(IdRange, :delete))
end
idr.desc 'List configured ID ranges'
idr.arg_name '[id-range...]'
idr.command %i[ls list] do |ls|
ls.desc 'Select parameters to output'
ls.flag %i[o output], arg_name: 'parameters'
ls.desc 'Do not show header'
ls.switch %i[H hide-header], negatable: false
ls.desc 'List available parameters'
ls.switch %i[L list], negatable: false
ls.desc 'Sort by parameter(s)'
ls.flag %i[s sort], arg_name: 'parameters'
ls.action(&Command.run(IdRange, :list))
end
idr.desc 'Show ID range info'
idr.arg_name '<id-range>'
idr.command %i[show info] do |c|
c.desc 'Select parameters to output'
c.flag %i[o output], arg_name: 'parameters'
c.desc 'Do not show header'
c.switch %i[H hide-header], negatable: false
c.desc 'List available parameters'
c.switch %i[L list], negatable: false
c.action(&Command.run(IdRange, :show))
end
idr.desc 'Access allocation table'
idr.command :table do |tbl|
tbl.desc 'List entries in the allocation table'
tbl.arg_name '<id-range> [all|allocated|free]'
tbl.command %i[ls list] do |c|
c.desc 'Select parameters to output'
c.flag %i[o output], arg_name: 'parameters'
c.desc 'Do not show header'
c.switch %i[H hide-header], negatable: false
c.desc 'List available parameters'
c.switch %i[L list], negatable: false
c.desc 'Sort by parameter(s)'
c.flag %i[s sort], arg_name: 'parameters'
c.action(&Command.run(IdRange, :table_list))
end
tbl.desc 'Show information about entry in the allocation table'
tbl.arg_name '<id-range> <block-index>'
tbl.command %i[show info] do |c|
c.desc 'Select parameters to output'
c.flag %i[o output], arg_name: 'parameters'
c.desc 'Do not show header'
c.switch %i[H hide-header], negatable: false
c.desc 'List available parameters'
c.switch %i[L list], negatable: false
c.action(&Command.run(IdRange, :table_show))
end
end
idr.desc 'Allocate blocks from ID range'
idr.arg_name '<id-range>'
idr.command :allocate do |c|
c.desc 'Number of blocks to allocate'
c.flag 'block-count', arg_name: 'n', default_value: 1, type: Integer
c.desc 'Optional index of the starting block'
c.flag 'block-index', arg_name: 'n', type: Integer
c.desc 'Identify owner of the allocation'
c.flag 'owner'
c.action(&Command.run(IdRange, :allocate))
end
idr.desc 'Free allocated blocks from ID range'
idr.arg_name '<id-range>'
idr.command :free do |c|
c.desc 'Index of a block to free'
c.flag 'block-index', type: Integer
c.desc 'Free allocations belonging to owner'
c.flag 'owner'
c.action(&Command.run(IdRange, :free))
end
idr.desc 'List ID range assets (datasets, files, directories)'
idr.arg_name '<id-range>'
assets(idr, IdRange)
idr.desc 'Configure ID range options'
idr.command :set do |set|
set_attr(set, IdRange, 'id-range')
end
idr.desc 'Reset ID range options'
idr.command :unset do |unset|
unset_attr(unset, IdRange, 'id-range')
end
end
desc 'Manage system users and user namespace configuration'
command :user do |u|
u.desc 'List available users'
u.arg_name '[user...]'
u.command %i[ls list] do |ls|
ls.desc 'Filter by pool, comma separated'
ls.flag :pool, arg_name: 'pool'
ls.desc 'Filter registered users'
ls.switch 'registered', negatable: false
ls.desc 'Filter unregistered users'
ls.switch 'unregistered', negatable: false
ls.desc 'Select parameters to output'
ls.flag %i[o output], arg_name: 'parameters'
ls.desc 'Do not show header'
ls.switch %i[H hide-header], negatable: false
ls.desc 'List available parameters'
ls.switch %i[L list], negatable: false
ls.desc 'Sort by parameter(s)'
ls.flag %i[s sort], arg_name: 'parameters'
ls.action(&Command.run(User, :list))
end
u.desc 'Show user info'
u.arg_name '<user>'
u.command %i[show info] do |c|
c.desc 'Select parameters to output'
c.flag %i[o output], arg_name: 'parameters'
c.desc 'Do not show header'
c.switch %i[H hide-header], negatable: false
c.desc 'List available parameters'
c.switch %i[L list], negatable: false
c.action(&Command.run(User, :show))
end
u.desc 'Create a new user with user namespace configuration'
u.arg_name '<user>'
u.command %i[new create] do |new|
new.desc 'Pool name'
new.flag :pool, arg_name: 'pool'
new.desc 'ID range to allocate UID/GID block from'
new.flag 'id-range', arg_name: 'id-range'
new.desc 'Specify allocated block index from ID range'
new.flag 'id-range-block-index', type: Integer, arg_name: 'n'
new.desc 'UID/GID mapping'
new.flag 'map', multiple: true, arg_name: 'id_map'
new.desc 'UID mapping'
new.flag 'map-uid', multiple: true, arg_name: 'uid_map'
new.desc 'GID mapping'
new.flag 'map-gid', multiple: true, arg_name: 'gid_map'
new.desc 'Make the user standalone'
new.switch %i[standalone], default_value: true
new.action(&Command.run(User, :create))
end
u.desc 'Delete user'
u.arg_name '<user>'
u.command %i[del delete] do |del|
del.action(&Command.run(User, :delete))
end
u.desc 'Register users into the system'
u.arg_name '<user>|all'
u.command %i[reg register] do |c|
c.action(&Command.run(User, :register))
end
u.desc 'Unregister users from the system'
u.arg_name '<user>|all'
u.command %i[unreg unregister] do |c|
c.action(&Command.run(User, :unregister))
end
u.desc 'Generate /etc/subuid and /etc/subgid'
u.command :subugids do |sub|
sub.action(&Command.run(User, :subugids))
end
u.desc "List user's assets (datasets, files, directories)"
u.arg_name '<user>'
assets(u, User)
u.desc 'List UID/GID mappings'
u.arg_name '<user> [uid|gid|both]'
u.command :map do |c|
c.desc 'Select parameters to output'
c.flag %i[o output], arg_name: 'parameters'
c.desc 'Do not show header'
c.switch %i[H hide-header], negatable: false
c.desc 'List available parameters'
c.switch %i[L list], negatable: false
c.action(&Command.run(User, :idmap_ls))
end
u.desc 'Configure user options'
u.command :set do |set|
set.desc 'Make the user standalone'
set.arg_name '<user>'
set.command :standalone do |c|
c.action(&Command.run(User, :set_standalone))
end
set_attr(set, User, 'user')
end
u.desc 'Reset user options'
u.command :unset do |unset|
unset.desc 'Remove the standalone flag'
unset.arg_name '<user>'
unset.command :standalone do |c|
c.action(&Command.run(User, :unset_standalone))
end
unset_attr(unset, User, 'user')
end
end
desc 'Manage groups used for cgroup-based resource limiting'
command :group do |grp|
grp.desc 'List available groups'
grp.arg_name '[group...]'
grp.command %i[ls list] do |ls|
ls.desc 'Filter by pool, comma separated'
ls.flag :pool, arg_name: 'pool'
ls.desc 'Select parameters to output'
ls.flag %i[o output], arg_name: 'parameters'
ls.desc 'Do not show header'
ls.switch %i[H hide-header], negatable: false
ls.desc 'List available parameters'
ls.switch %i[L list], negatable: false
ls.desc 'Sort by parameter(s)'
ls.flag %i[s sort], arg_name: 'parameters'
ls.action(&Command.run(Group, :list))
end
grp.desc 'Print group tree'
grp.arg_name '<pool>'
grp.command :tree do |c|
c.action(&Command.run(Group, :tree))
end
grp.desc 'Show group info'
grp.arg_name '<group>'
grp.command %i[show find] do |c|
c.desc 'Select parameters to output'
c.flag %i[o output], arg_name: 'parameters'
c.desc 'Do not show header'
c.switch %i[H hide-header], negatable: false
c.desc 'List available parameters'
c.switch %i[L list], negatable: false
c.action(&Command.run(Group, :show))
end
grp.desc 'Create group'
grp.arg_name '<group>'
grp.command %i[new create] do |new|
new.desc 'Pool name'
new.flag :pool, arg_name: 'pool'
new.desc 'Create missing parent groups'
new.switch %i[p parents]
new.desc 'Set CGroup parameter'
new.flag %i[cgparam], multiple: true
new.action(&Command.run(Group, :create))
end
grp.desc 'Delete group'
grp.arg_name '<group>'
grp.command %i[del delete] do |del|
del.action(&Command.run(Group, :delete))
end
grp.desc 'Configure group'
grp.command :set do |set|
set_limits(set, Group, 'group')
set_attr(set, Group, 'group')
end
grp.desc 'Clear configuration options'
grp.command :unset do |unset|
unset_limits(unset, Group, 'group')
unset_attr(unset, Group, 'group')
end
grp.desc "List group's assets (datasets, files, directories)"
grp.arg_name '<group>'
assets(grp, Group)
cg_params(grp, Group, 'group')
devices(grp, Group, 'group')
end
desc 'Manage containers'
command %i[ct vps] do |ct|
ct.desc 'List containers'
ct.arg_name '[ctid...]'
ct.command %i[ls list] do |ls|
ls.desc 'Filter by pool, comma separated'
ls.flag :pool, arg_name: 'pool'
ls.desc 'Filter by user name, comma separated'
ls.flag %i[u user], arg_name: 'user'
ls.desc 'Filter by group name, comma separated'
ls.flag %i[g group], arg_name: 'group'
ls.desc 'Filter by distribution, comma separated'
ls.flag %i[d distribution], arg_name: 'distribution'
ls.desc 'Filter by distribution version, comma separated'
ls.flag %i[v version], arg_name: 'version'
ls.desc 'Filter by distribution arch, comma separated'
ls.flag :arch, arg_name: 'arch'
ls.desc 'Filter by distribution vendor, comma separated'
ls.flag :vendor, arg_name: 'vendor'
ls.desc 'Filter by distribution variant, comma separated'
ls.flag :variant, arg_name: 'variant'
ls.desc 'Filter by state, comma separated'
ls.flag %i[S state], arg_name: 'state'
ls.desc 'Filter ephemeral containers'
ls.switch %i[e ephemeral], negatable: false
ls.desc 'Filter persistent (non-ephemeral) containers'
ls.switch %i[p persistent], negatable: false
ls.desc 'Select parameters to output'
ls.flag %i[o output], arg_name: 'parameters'
ls.desc 'Do not show header'
ls.switch %i[H hide-header], negatable: false
ls.desc 'List available parameters'
ls.switch %i[L list], negatable: false
ls.desc 'Sort by parameter(s)'
ls.flag %i[s sort], arg_name: 'parameters'
ls.action(&Command.run(Container, :list))
end
ct.desc 'Print tree of containers and groups'
ct.arg_name '<pool>'
ct.command :tree do |c|
c.action(&Command.run(Container, :tree))
end
ct.desc "Show container's info"
ct.arg_name '<ctid>'
ct.command %i[show info] do |c|
c.desc 'Select parameters to output'
c.flag %i[o output], arg_name: 'parameters'
c.desc 'Do not show header'
c.switch %i[H hide-header], negatable: false
c.desc 'List available parameters'
c.switch %i[L list], negatable: false
c.action(&Command.run(Container, :show))
end
ct.desc 'Create container'
ct.arg_name '<ctid>'
ct.command %i[new create] do |new|
new.desc 'Pool name'
new.flag :pool, arg_name: 'pool'
new.desc 'User name'
new.flag :user, arg_name: 'user'
new.desc 'Group name'
new.flag :group, required: false, arg_name: 'group'
new.desc 'Use a custom dataset for the rootfs'
new.flag :dataset, arg_name: 'dataset'
new.desc 'Do not extract any image'
new.switch 'skip-image', negatable: false
new.desc 'Distribution name in lower case'
new.flag :distribution, arg_name: 'distribution'
new.desc 'Distribution version'
new.flag :version, arg_name: 'version'
new.desc 'Architecture'
new.flag :arch, arg_name: 'arch'
new.desc 'Vendor (used only when downloading the image)'
new.flag :vendor, arg_name: 'vendor'
new.desc 'Variant (used only when downloading the image)'
new.flag :variant, arg_name: 'variant'
new.desc 'Repository'
new.flag :repository, arg_name: 'repository'
new.action(&Command.run(Container, :create))
end
ct.desc 'Delete container'
ct.arg_name '<ctid>'
ct.command %i[del delete] do |c|
c.desc 'Stop and delete running container'
c.switch %i[f force], negatable: false
c.action(&Command.run(Container, :delete))
end
ct.desc 'Reinstall container'
ct.arg_name '<ctid>'
ct.command :reinstall do |c|
c.desc 'Reinstall from container image'
c.flag 'from-file', arg_name: 'file'
c.desc 'Distribution name in lower case'
c.flag :distribution, arg_name: 'distribution'
c.desc 'Distribution version'
c.flag :version, arg_name: 'version'
c.desc 'Architecture'
c.flag :arch, arg_name: 'arch'
c.desc 'Vendor (used only when downloading the image)'
c.flag :vendor, arg_name: 'vendor'
c.desc 'Variant (used only when downloading the image)'
c.flag :variant, arg_name: 'variant'
c.desc 'Repository'
c.flag :repository, arg_name: 'repository'
c.desc 'Remove snapshots of the root dataset'
c.switch %i[r remove-snapshots]
c.action(&Command.run(Container, :reinstall))
end
ct.desc "Mount the container's datasets"
ct.arg_name '<ctid>'
ct.command :mount do |c|
c.action(&Command.run(Container, :mount))
end
ct.desc 'Start container'
ct.arg_name '<ctid>'
ct.command :start do |c|
c.desc 'How long to wait for the container to start'
c.flag %i[w wait], default_value: 120, arg_name: 'n'
c.desc 'Open container console (can be later detached)'
c.switch %i[F foreground]
c.desc 'Enqueue the start operation using pool autostart facility'
c.switch %i[q queue]
c.desc 'Priority for the autostart queue'
c.flag %i[p priority], type: Integer, default_value: 10, arg_name: 'n'
c.desc 'Enable debug messages in LXC'
c.switch %i[D debug]
c.desc 'Attach container after start'
c.switch %i[a attach], negatable: false
c.desc 'Run shell as configured in the container'
c.switch %i[u user-shell], negatable: false
c.action(&Command.run(Container, :start))
end
ct.desc 'Stop container'
ct.arg_name '<ctid>'
ct.command :stop do |c|
c.desc 'Open container console (can be later detached)'
c.switch %i[F foreground]
c.desc 'Message sent to logged-in container users'
c.flag %i[m message], arg_name: 'message'
c.desc 'How many seconds to wait before killing the container'
c.flag %i[t timeout], type: Integer, default_value: 300, arg_name: 'n'
c.desc 'Do not request a clean shutdown, kill the container'
c.switch %i[k kill], negatable: false
c.desc 'Do not kill the container if clean shutdown fails'
c.switch 'dont-kill', negatable: false
c.action(&Command.run(Container, :stop))
end
ct.desc 'Restart container'
ct.arg_name '<ctid>'
ct.command :restart do |c|
c.desc 'How long to wait for the container to start'
c.flag %i[w wait], default_value: 120, arg_name: 'n'
c.desc 'Open container console (can be later detached)'
c.switch %i[F foreground]
c.desc 'Message sent to logged-in container users'
c.flag %i[m message], arg_name: 'message'
c.desc 'Request reboot by signaling the init process'
c.switch %i[r reboot]
c.desc 'How many seconds to wait before killing the container'
c.flag %i[t timeout], type: Integer, default_value: 300, arg_name: 'n'
c.desc 'Do not request a clean shutdown, kill the container'
c.switch %i[k kill], negatable: false
c.desc 'Do not kill the container if clean shutdown fails'
c.switch 'dont-kill', negatable: false
c.desc 'Attach container after start'
c.switch %i[a attach], negatable: false
c.desc 'Run shell as configured in the container'
c.switch %i[u user-shell], negatable: false
c.action(&Command.run(Container, :restart))
end
ct.desc "Open container's console"
ct.arg_name '<ctid>'
ct.command :console do |c|
c.desc 'TTY'
c.flag %i[t tty], type: Integer, default_value: 0, arg_name: 'ttyN'
c.action(&Command.run(Container, :console))
end
ct.desc 'Attach the container'
ct.arg_name '<ctid>'
ct.command %i[attach enter] do |c|
c.desc 'Run shell as configured in the container'
c.switch %i[u user-shell], negatable: false
c.action(&Command.run(Container, :attach))
end
ct.desc 'Execute a command within the container'
ct.arg_name '<ctid> <cmd...>'
ct.command %i[exec] do |c|
c.desc "Run the container if it isn't running already"
c.switch %i[r run-container], negatable: false
c.desc 'Configure network'
c.switch %i[n network], negatable: false
c.action(&Command.run(Container, :exec))
end
ct.desc 'Run script within the container'
ct.arg_name '<ctid> <script> [arguments...]'
ct.command %i[runscript] do |c|
c.desc "Run the container if it isn't running already"
c.switch %i[r run-container], negatable: false
c.desc 'Configure network'
c.switch %i[n network], negatable: false
c.action(&Command.run(Container, :runscript))
end
ct.desc 'Cat files from container'
ct.arg_name '<ctid> <file...>'
ct.command %i[cat] do |c|
c.action(&Command.run(Container, :cat))
end
ct.desc 'Send message to users logged-in containers'
ct.arg_name '[ctid...]'
ct.command %i[wall] do |c|
c.desc 'Message to send'
c.flag %i[m message]
c.desc 'Suppress the banner'
c.switch %i[n hide-banner], negatable: false
c.action(&Command.run(Container, :wall))
end
ct.desc "Get container's user's shell"
ct.arg_name '<ctid>'
ct.command :su do |su|
su.action(&Command.run(Container, :su))
end
ct.desc 'Configure container'
ct.command :set do |set|
set.desc 'Start the container when its pool is imported'
set.arg_name '<ctid>'
set.command :autostart do |c|
c.desc 'Start priority (0 is the highest priority)'
c.flag %i[p priority], type: Integer, default_value: 1000, arg_name: 'n'
c.desc 'How long to wait before starting another container, in seconds'
c.flag %i[d delay], type: Integer, default_value: 5, arg_name: 'n'
c.action(&Command.run(Container, :set_autostart))
end
set.desc 'Destroy the container after it is stopped'
set.arg_name '<ctid>'
set.command :ephemeral do |c|
c.action(&Command.run(Container, :set_ephemeral))
end
set.desc 'Set hostname'
set.arg_name '<ctid> <hostname>'
set.command :hostname do |c|
c.action(&Command.run(Container, :set_hostname))
end
set.desc 'Set DNS resolver'
set.arg_name '<ctid> <address...>'
set.command :'dns-resolver' do |c|
c.action(&Command.run(Container, :set_dns_resolver))
end
set.desc 'Enable container nesting'
set.arg_name '<ctid>'
set.command :nesting do |c|
c.action(&Command.run(Container, :set_nesting))
end
set.desc 'Change distribution and version info'
set.arg_name '<ctid> <distribution> <version> [arch [vendor [variant]]]'
set.command :distribution do |c|
c.action(&Command.run(Container, :set_distribution))
end
set.desc 'Set image config'
set.arg_name '<ctid>'
set.command 'image-config' do |c|
c.desc 'Use container image from local file'
c.flag 'from-file', arg_name: 'file'
c.desc 'Distribution name in lower case'
c.flag :distribution, arg_name: 'distribution'
c.desc 'Distribution version'
c.flag :version, arg_name: 'version'
c.desc 'Architecture'
c.flag :arch, arg_name: 'arch'
c.desc 'Vendor (used only when downloading the image)'
c.flag :vendor, arg_name: 'vendor'
c.desc 'Variant (used only when downloading the image)'
c.flag :variant, arg_name: 'variant'
c.desc 'Repository'
c.flag :repository, arg_name: 'repository'
c.action(&Command.run(Container, :set_image_config))
end
set.desc 'Pin to a specific CPU package'
set.arg_name '<ctid> <cpu-package>'
set.command 'cpu-package' do |c|
c.action(&Command.run(Container, :set_cpu_package))
end
set.desc 'Set path to seccomp profile'
set.arg_name '<ctid> <profile>'
set.command :seccomp do |c|
c.action(&Command.run(Container, :set_seccomp_profile))
end
set.desc 'Set path to the binary within the container to use as init'
set.arg_name '<ctid> <binary> [arguments...]'
set.command :'init-cmd' do |c|
c.action(&Command.run(Container, :set_init_cmd))
end
set.desc 'Enable the start menu'
set.arg_name '<ctid>'
set.command :'start-menu' do |c|
c.desc 'Timeout'
c.flag %i[t timeout], arg_name: 'n', type: Integer, default_value: 5
c.action(&Command.run(Container, :set_start_menu))
end
set.desc 'Enable impermanence'
set.arg_name '<ctid>'
set.command :impermanence do |c|
c.desc 'ZFS properties for the impermanent rootfs dataset'
c.flag 'zfs-property', arg_name: 'property=value', multiple: true
c.action(&Command.run(Container, :set_impermanence))
end
set.desc 'Append raw configuration to auto-generated config files'
set.command :raw do |raw|
raw.desc 'Append raw LXC configuration'
raw.arg_name '<ctid>'
raw.command :lxc do |c|
c.action(&Command.run(Container, :set_raw_lxc))
end
end
set_attr(set, Container, 'ctid')
set_limits(set, Container, 'ctid')
end
ct.desc 'Clear configuration options'
ct.command :unset do |unset|
unset.desc 'Disable automatic container starting'
unset.arg_name '<ctid>'
unset.command :autostart do |c|
c.action(&Command.run(Container, :unset_autostart))
end
unset.desc 'Do not destroy the container after it is stopped'
unset.arg_name '<ctid>'
unset.command :ephemeral do |c|
c.action(&Command.run(Container, :unset_ephemeral))
end
unset.desc 'Disable hostname management'
unset.arg_name '<ctid>'
unset.command :hostname do |c|
c.action(&Command.run(Container, :unset_hostname))
end
unset.desc 'Disable DNS resolver management'
unset.arg_name '<ctid>'
unset.command :'dns-resolver' do |c|
c.action(&Command.run(Container, :unset_dns_resolver))
end
unset.desc 'Disable container nesting'
unset.arg_name '<ctid>'
unset.command :nesting do |c|
c.action(&Command.run(Container, :unset_nesting))
end
unset.desc 'Remove pin to a specific CPU package'
unset.arg_name '<ctid> <cpu-package>'
unset.command 'cpu-package' do |c|
c.action(&Command.run(Container, :unset_cpu_package))
end
unset.desc 'Use the default seccomp profile'
unset.arg_name '<ctid>'
unset.command :seccomp do |c|
c.action(&Command.run(Container, :unset_seccomp_profile))
end
unset.desc 'Use default path to binary used as init (/sbin/init)'
unset.arg_name '<ctid>'
unset.command :'init-cmd' do |c|
c.action(&Command.run(Container, :unset_init_cmd))
end
unset.desc 'Disable the start menu'
unset.arg_name '<ctid>'
unset.command :'start-menu' do |c|
c.action(&Command.run(Container, :unset_start_menu))
end
unset.desc 'Disable impermanence'
unset.arg_name '<ctid>'
unset.command :impermanence do |c|
c.action(&Command.run(Container, :unset_impermanence))
end
unset.desc 'Remove raw configuration from auto-generated config files'
unset.command :raw do |raw|
raw.desc 'Remove raw LXC configuration'
raw.arg_name '<ctid>'
raw.command :lxc do |c|
c.action(&Command.run(Container, :unset_raw_lxc))
end
end
unset_attr(unset, Container, 'ctid')
unset_limits(unset, Container, 'ctid')
end
ct.desc 'Copy container'
ct.arg_name '<ctid> [pool:]<new-id>'
ct.command %i[cp copy] do |c|
c.desc 'Stop the container during the copy'
c.switch :consistent, default_value: true
c.desc 'Target pool'
c.flag :pool, arg_name: 'pool'
c.desc 'Target user'
c.flag :user, arg_name: 'user'
c.desc 'Target group'
c.flag :group, arg_name: 'group'
c.desc 'Target dataset'
c.flag :dataset, arg_name: 'dataset'
c.desc 'Copy network interfaces'
c.switch 'network-interfaces', default_value: true
c.action(&Command.run(Container, :copy))
end
ct.desc 'Move container'
ct.arg_name '<ctid> [pool:]<new-id>'
ct.command %i[mv move] do |c|
c.desc 'Target pool'
c.flag :pool, arg_name: 'pool'
c.desc 'Target user'
c.flag :user, arg_name: 'user'
c.desc 'Target group'
c.flag :group, arg_name: 'group'
c.desc 'Target dataset'
c.flag :dataset, arg_name: 'dataset'
c.action(&Command.run(Container, :move))
end
ct.desc 'Move the container to another user namespace'
ct.arg_name '<ctid> <user>'
ct.command :chown do |c|
c.action(&Command.run(Container, :chown))
end
ct.desc 'Move the container to another group'
ct.arg_name '<ctid> <group>'
ct.command :chgrp do |c|
c.desc 'Provide or remove missing devices'
c.flag 'missing-devices', must_match: %w[provide remove check]
c.action(&Command.run(Container, :chgrp))
end
ct.desc 'Boot container from image'
ct.arg_name '<ctid>'
ct.command :boot do |c|
c.desc 'Stop the container if it is running'
c.switch %i[f force]
c.desc 'Boot from container image'
c.flag 'from-file', arg_name: 'file'
c.desc 'Distribution name in lower case'
c.flag :distribution, arg_name: 'distribution'
c.desc 'Distribution version'
c.flag :version, arg_name: 'version'
c.desc 'Architecture'
c.flag :arch, arg_name: 'arch'
c.desc 'Vendor (used only when downloading the image)'
c.flag :vendor, arg_name: 'vendor'
c.desc 'Variant (used only when downloading the image)'
c.flag :variant, arg_name: 'variant'
c.desc 'Repository'
c.flag :repository, arg_name: 'repository'
c.desc 'Mount root dataset'
c.flag 'mount-root-dataset', arg_name: 'dir'
c.desc 'ZFS properties for the temporary rootfs dataset'
c.flag 'zfs-property', arg_name: 'property=value', multiple: true
c.desc 'How long to wait for the container to start'
c.flag %i[w wait], default_value: 120, arg_name: 'n'
c.desc 'Open container console (can be later detached)'
c.switch %i[F foreground]
c.desc 'Enqueue the start operation using pool autostart facility'
c.switch %i[q queue]
c.desc 'Priority for the autostart queue'
c.flag %i[p priority], type: Integer, default_value: 10, arg_name: 'n'
c.desc 'Enable debug messages in LXC'
c.switch %i[D debug]
c.desc 'Attach container after start'
c.switch %i[a attach], negatable: false
c.desc 'Run shell as configured in the container'
c.switch %i[u user-shell], negatable: false
c.action(&Command.run(Container, :boot))
end
ct.desc "Manipulate the container's config file"
ct.command %i[cfg config] do |cfg|
cfg.desc "Reload the container's configuration file"
cfg.arg_name '<ctid>'
cfg.command :reload do |c|
c.action(&Command.run(Container, :config_reload))
end
cfg.desc "Replace the container's configuration file"
cfg.arg_name '<ctid>'
cfg.command :replace do |c|
c.action(&Command.run(Container, :config_replace))
end
end
ct.desc 'Set password for a user within the container'
ct.arg_name '<ctid> <username> [password]'
ct.command :passwd do |c|
c.action(&Command.run(Container, :passwd))
end
ct.desc 'Regenerate LXC configuration'
ct.arg_name '<ctid>'
ct.command :reconfigure do |c|
c.action(&Command.run(Container, :reconfigure))
end
ct.desc 'Freeze the container'
ct.arg_name '<ctid>'
ct.command :freeze do |c|
c.action(&Command.run(Container, :freeze))
end
ct.desc 'Unfreeze (thaw) the container'
ct.arg_name '<ctid>'
ct.command %i[unfreeze thaw] do |c|
c.action(&Command.run(Container, :unfreeze))
end
ct.desc 'Use binary search to find a misbehaving container'
ct.arg_name '[ctid...]'
ct.command :bisect do |c|
c.desc 'Disable method'
c.flag %i[a action], must_match: %w[freeze stop], default_value: 'freeze'
c.desc 'Exclude containers'
c.flag %i[x exclude], arg_name: 'ctids'
c.desc 'Filter by pool, comma separated'
c.flag :pool, arg_name: 'pool'
c.desc 'Filter by user name, comma separated'
c.flag %i[u user], arg_name: 'user'
c.desc 'Filter by group name, comma separated'
c.flag %i[g group], arg_name: 'group'
c.desc 'Filter by distribution, comma separated'
c.flag %i[d distribution], arg_name: 'distribution'
c.desc 'Filter by distribution version, comma separated'
c.flag %i[v version], arg_name: 'version'
c.desc 'Filter ephemeral containers'
c.switch %i[e ephemeral], negatable: false
c.desc 'Filter persistent (non-ephemeral) containers'
c.switch %i[p persistent], negatable: false
c.desc 'Select parameters to output'
c.flag %i[o output], arg_name: 'parameters'
c.desc 'List available parameters'
c.switch %i[L list], negatable: false
c.desc 'Sort by parameter(s)'
c.flag %i[s sort], arg_name: 'parameters'
c.action(&Command.run(Container, :bisect))
end
ct.desc 'Export the container configs and data into a tar archive'
ct.arg_name '<ctid> <file>'
ct.command :export do |c|
c.desc 'Stop the container during the export'
c.switch :consistent, default_value: true
c.desc 'Compression'
c.flag %i[c compression], must_match: %w[auto off gzip],
default_value: 'auto'
c.action(&Command.run(Container, :export))
end
ct.desc 'Import container from tar archive'
ct.arg_name '<file>'
ct.command :import do |c|
c.desc 'Import as container id'
c.flag 'as-id'
c.desc 'Import as an existing user'
c.flag 'as-user'
c.desc 'Import into an existing group'
c.flag 'as-group'
c.desc 'Use a custom dataset for the rootfs'
c.flag :dataset, arg_name: 'dataset'
c.desc 'Provide or remove missing devices'
c.flag 'missing-devices', must_match: %w[provide remove check]
c.action(&Command.run(Container, :import))
end
ct.desc 'Send container at once (equals to steps 1-4 in succession)'
ct.arg_name '<ctid> <dst>'
ct.command :send do |s|
s.desc 'SSH port'
s.flag %i[p port], type: Integer, arg_name: 'port'
s.desc 'Passphrase'
s.flag 'passphrase'
s.desc 'Send the container with a different id'
s.flag 'as-id'
s.desc 'Send the container with a different user name'
s.flag 'as-user'
s.desc 'Send the container with a different group name'
s.flag 'as-group'
s.desc 'Pool on the target node to send the container to'
s.flag 'to-pool'
s.desc 'Clone the container on the target node, do not move it'
s.switch :clone
s.desc 'Stop the container when cloning'
s.switch :consistent, default_value: true
s.desc 'Do not restart the container after cloning on the source node'
s.switch :restart, default_value: true
s.desc 'Do not start the container on the target node'
s.switch :start, default_value: true
s.desc 'Send network interfaces to target node'
s.switch 'network-interfaces', default_value: true
s.desc 'Send snapshots'
s.switch 'snapshots', default_value: true
s.desc 'Start the transfer from selected snapshot'
s.flag 'from-snapshot'
s.desc 'Assume datasets on the target node already exist'
s.switch 'preexisting-datasets', default_value: false
s.action(&Command.run(Send, :now))
s.desc 'Step 1., copy configs to target node'
s.arg_name '<ctid> <dst>'
s.command :config do |c|
c.desc 'SSH port'
c.flag %i[p port], type: Integer, arg_name: 'port'
c.desc 'Passphrase'
c.flag 'passphrase'
c.desc 'Send the container with a different id'
c.flag 'as-id'
c.desc 'Send the container with a different user name'
c.flag 'as-user'
c.desc 'Send the container with a different group name'
c.flag 'as-group'
c.desc 'Pool on the target node to send the container to'
c.flag 'to-pool'
c.desc 'Send network interfaces to target node'
c.switch 'network-interfaces', default_value: true
c.desc 'Send snapshots'
c.switch 'snapshots', default_value: true
c.desc 'Start the transfer from selected snapshot'
c.flag 'from-snapshot'
c.desc 'Assume datasets on the target node already exist'
c.switch 'preexisting-datasets', default_value: false
c.action(&Command.run(Send, :config))
end
s.desc 'Step 2., do an initial copy of container dataset'
s.arg_name '<ctid>'
s.command :rootfs do |c|
c.action(&Command.run(Send, :rootfs))
end
s.desc 'Optional step 3., transfer rootfs changes'
s.arg_name '<ctid>'
s.command :sync do |c|
c.action(&Command.run(Send, :sync))
end
s.desc 'Step 4., transfer the container to target node'
s.arg_name '<ctid>'
s.command :state do |c|
c.desc 'Clone the container on the target node, do not move it'
c.switch :clone
c.desc 'Stop the container when cloning'
c.switch :consistent, default_value: true
c.desc 'Do not restart the container after cloning on the source node'
c.switch :restart, default_value: true
c.desc 'Do not start the container on the target node'
c.switch :start, default_value: true
c.action(&Command.run(Send, :state))
end
s.desc 'Step 5., cleanup the container on the source node'
s.arg_name '<ctid>'
s.command :cleanup do |c|
c.action(&Command.run(Send, :cleanup))
end
s.desc 'Cancel ongoing send in mid-step'
s.arg_name '<ctid>'
s.command :cancel do |c|
c.desc 'Cancel the send on the local node, even if remote fails'
c.switch %i[f force], negatable: false
c.desc 'Cancel the send only on the local node'
c.switch %i[l local], negatable: false
c.action(&Command.run(Send, :cancel))
end
end
ct.desc 'Access container LXC log file'
ct.command :log do |log|
log.desc 'Cat log file to stdout'
log.arg_name '<ctid>'
log.command :cat do |c|
c.action(&Command.run(Container, :log_cat))
end
log.desc 'Print path to the log file'
log.arg_name '<ctid>'
log.command :path do |c|
c.action(&Command.run(Container, :log_path))
end
end
ct.desc 'Monitor container state changes'
ct.arg_name '[ctid...]'
ct.command :monitor do |c|
c.action(&Command.run(Event, :monitor_ct))
end
ct.desc 'Wait for container for container to enter state'
ct.arg_name '<ctid> <state...>'
ct.command :wait do |c|
c.action(&Command.run(Event, :wait_ct))
end
ct.desc 'Top-like container monitor'
ct.arg_name '[ctid...]'
ct.command :top do |c|
c.desc 'Refresh rate, in seconds'
c.flag %i[r rate], type: Float, default_value: 1.0, arg_name: 'n'
c.desc 'Track state of all processes (TUI only)'
c.switch %i[processes], default_value: true
c.desc "Track the host's IO stats using zpool iostat"
c.switch :iostat, default_value: true
c.action(&Command.run(Top::Main, :start))
end
ct.desc 'Find containers by PID'
ct.arg_name '[pid...] | -'
ct.command :pid do |c|
c.desc 'Do not show header'
c.switch %i[H hide-header], negatable: false
c.action(&Command.run(Container, :pid))
end
ct.desc 'List container processes'
ct.arg_name '[ctid...]'
ct.command :ps do |c|
c.desc 'Select parameters to output'
c.flag %i[o output], arg_name: 'parameters'
c.desc 'Do not show header'
c.switch %i[H hide-header], negatable: false
c.desc 'List available parameters'
c.switch %i[L list], negatable: false
c.desc 'Sort by parameter(s)'
c.flag %i[s sort], arg_name: 'parameters'
c.desc 'Filter by parameter values'
c.flag %i[p parameter], arg_name: 'cond', multiple: true
c.action(&Command.run(Ps::Main, :run))
end
ct.desc 'List container assets (datasets, files, directories)'
ct.arg_name '<ctid>'
assets(ct, Container)
ct.desc "Manage container's network interfaces"
ct.command %i[netif net] do |net|
net.desc 'List network interfaces'
net.arg_name '<ctid>'
net.command %i[ls list] do |c|
c.desc 'Filter by interface type'
c.flag %i[t type], arg_name: 'netif_type'
c.desc 'Filter by linked bridge'
c.flag %i[l link], arg_name: 'netif_bridge'
c.desc 'Select parameters to output'
c.flag %i[o output], arg_name: 'parameters'
c.desc 'Do not show header'
c.switch %i[H hide-header], negatable: false
c.desc 'List available parameters'
c.switch %i[L list], negatable: false
c.desc 'Sort by parameter(s)'
c.flag %i[s sort], arg_name: 'parameters'
c.action(&Command.run(NetInterface, :list))
end
net.desc 'Create a new network interface'
net.command %i[new create] do |create|
create.desc 'Create a new bridged veth interface'
create.arg_name '<ctid> <ifname>'
create.command :bridge do |c|
c.desc 'What bridge should the interface be linked with'
c.flag :link, required: true, arg_name: 'host_netif'
c.desc 'Use DHCP client within the container'
c.switch :dhcp, default_value: true
c.desc 'IPv4 gateway to use when DHCP is disabled'
c.flag 'gateway-v4', arg_name: 'ipv4'
c.desc 'IPv6 gateway to use when DHCP is disabled'
c.flag 'gateway-v6', arg_name: 'ipv6'
c.desc 'MAC address'
c.flag :hwaddr, arg_name: 'hwaddr'
c.desc 'Number of transmit queues'
c.flag 'tx-queues', arg_name: 'queues', type: Integer, default_value: 1
c.desc 'Number of receive queues'
c.flag 'rx-queues', arg_name: 'queues', type: Integer, default_value: 1
c.desc 'Shaper on outgoing data'
c.flag 'max-tx', arg_name: 'rate'
c.desc 'Shaper on incoming data'
c.flag 'max-rx', arg_name: 'rate'
c.action(&Command.run(NetInterface, :create_bridge))
end
create.desc 'Create a new routed veth interface'
create.arg_name '<ctid> <ifname>'
create.command :routed do |c|
c.desc 'MAC address'
c.flag :hwaddr, arg_name: 'hwaddr'
c.desc 'Number of transmit queues'
c.flag 'tx-queues', arg_name: 'queues', type: Integer, default_value: 1
c.desc 'Number of receive queues'
c.flag 'rx-queues', arg_name: 'queues', type: Integer, default_value: 1
c.desc 'Shaper on outgoing data'
c.flag 'max-tx', arg_name: 'rate'
c.desc 'Shaper on incoming data'
c.flag 'max-rx', arg_name: 'rate'
c.action(&Command.run(NetInterface, :create_routed))
end
end
net.desc 'Remove network interface'
net.arg_name '<ctid> <ifname>'
net.command %i[del delete] do |c|
c.action(&Command.run(NetInterface, :delete))
end
net.desc 'Rename network interface'
net.arg_name '<ctid> <ifname> <new-ifname>'
net.command :rename do |c|
c.action(&Command.run(NetInterface, :rename))
end
net.desc 'Configure network interface'
net.arg_name '<ctid> <ifname>'
net.command :set do |c|
c.desc 'What bridge should the interface be linked with'
c.flag :link, arg_name: 'host_netif'
c.desc 'Use DHCP client within the container'
c.switch 'enable-dhcp', negatable: false
c.desc 'Do not use DHCP client within the container'
c.switch 'disable-dhcp', negatable: false
c.desc 'IPv4 gateway to use when DHCP is disabled'
c.flag 'gateway-v4', arg_name: 'ipv4'
c.desc 'IPv6 gateway to use when DHCP is disabled'
c.flag 'gateway-v6', arg_name: 'ipv6'
c.desc 'MAC address'
c.flag :hwaddr, arg_name: 'hwaddr'
c.desc 'Number of transmit queues'
c.flag 'tx-queues', arg_name: 'queues', type: Integer
c.desc 'Number of receive queues'
c.flag 'rx-queues', arg_name: 'queues', type: Integer
c.desc 'Shaper on outgoing data'
c.flag 'max-tx', arg_name: 'rate'
c.desc 'Shaper on incoming data'
c.flag 'max-rx', arg_name: 'rate'
c.action(&Command.run(NetInterface, :set))
end
net.desc 'Manage IP addresses'
net.command :ip do |ip|
ip.desc 'List IP addresses'
ip.arg_name '[ctid] [ifname]'
ip.command %i[ls list] do |c|
c.desc 'Filter by IP version'
c.flag %i[v version], type: Integer
c.desc 'Select parameters to output'
c.flag %i[o output], arg_name: 'parameters'
c.desc 'Do not show header'
c.switch %i[H hide-header], negatable: false
c.desc 'List available parameters'
c.switch %i[L list], negatable: false
c.desc 'Sort by parameter(s)'
c.flag %i[s sort], arg_name: 'parameters'
c.action(&Command.run(NetInterface, :ip_list))
end
ip.desc 'Add IP address'
ip.arg_name '<ctid> <ifname> <addr>'
ip.command :add do |c|
c.desc 'Add route for addr'
c.switch :route, default_value: true
c.desc 'Add route for a different network than addr'
c.flag 'route-as', arg_name: 'addr'
c.action(&Command.run(NetInterface, :ip_add))
end
ip.desc 'Remove IP address'
ip.arg_name '<ctid> <ifname> <addr>'
ip.command :del do |c|
c.desc 'Remove route for addr'
c.switch 'keep-route'
c.desc 'IP versions to remove'
c.flag %i[v version], type: Integer
c.action(&Command.run(NetInterface, :ip_del))
end
end
net.desc 'Manage routes'
net.command :route do |ip|
ip.desc 'List routes'
ip.arg_name '[ctid] [ifname]'
ip.command %i[ls list] do |c|
c.desc 'Filter by IP version'
c.flag %i[v version], type: Integer
c.desc 'Select parameters to output'
c.flag %i[o output], arg_name: 'parameters'
c.desc 'Do not show header'
c.switch %i[H hide-header], negatable: false
c.desc 'List available parameters'
c.switch %i[L list], negatable: false
c.desc 'Sort by parameter(s)'
c.flag %i[s sort], arg_name: 'parameters'
c.action(&Command.run(NetInterface, :route_list))
end
ip.desc 'Add route'
ip.arg_name '<ctid> <ifname> <addr>'
ip.command :add do |c|
c.desc 'Route via specific address'
c.flag :via, arg_name: 'hostaddr'
c.action(&Command.run(NetInterface, :route_add))
end
ip.desc 'Remove route'
ip.arg_name '<ctid> <ifname> <addr>'
ip.command :del do |c|
c.desc 'IP versions to remove'
c.flag %i[v version], type: Integer
c.action(&Command.run(NetInterface, :route_del))
end
end
end
cg_params(ct, Container, 'ctid')
devices(ct, Container, 'ctid')
ct.desc 'Manage resource limits'
ct.command :prlimits do |pr|
pr.desc 'List configured limits'
pr.arg_name '<ctid> [limits...]'
pr.command %i[ls list] do |c|
c.desc 'Select parameters to output'
c.flag %i[o output], arg_name: 'parameters'
c.desc 'Do not show header'
c.switch %i[H hide-header], negatable: false
c.desc 'List available parameters'
c.switch %i[L list], negatable: false
c.action(&Command.run(Container, :prlimit_list))
end
pr.desc 'Configure limit'
pr.arg_name '<ctid> <limit> (<soft_and_hard>| <soft> <hard>)'
pr.command :set do |c|
c.action(&Command.run(Container, :prlimit_set))
end
pr.desc 'Remove configured limit'
pr.arg_name '<ctid> <limit>'
pr.command :unset do |c|
c.action(&Command.run(Container, :prlimit_unset))
end
end
ct.desc 'Manage container datasets'
ct.command :dataset do |ds|
ds.desc 'List datasets'
ds.arg_name '<ctid>'
ds.command %i[ls list] do |c|
c.desc 'Select parameters to output'
c.flag %i[o output], arg_name: 'parameters'
c.desc 'Do not show header'
c.switch %i[H hide-header], negatable: false
c.desc 'List available parameters'
c.switch %i[L list], negatable: false
c.action(&Command.run(Container, :dataset_list))
end
ds.desc 'Create a new dataset'
ds.arg_name '<ctid> <dataset> [mountpoint]'
ds.command %i[new create] do |c|
c.desc 'Enable/disable auto mount'
c.switch :mount, default_value: true
c.action(&Command.run(Container, :dataset_create))
end
ds.desc 'Delete dataset'
ds.arg_name '<ctid> <dataset>'
ds.command %i[del delete] do |c|
c.desc 'Recursively delete all children as well'
c.switch %i[r recursive]
c.desc 'Unmount all affected mountpoints'
c.switch %i[u umount unmount]
c.action(&Command.run(Container, :dataset_delete))
end
end
ct.desc 'Manage mounts'
ct.command :mounts do |m|
m.desc 'List configured mounts'
m.arg_name '<ctid>'
m.command %i[ls list] do |c|
c.desc 'Select parameters to output'
c.flag %i[o output], arg_name: 'parameters'
c.desc 'Do not show header'
c.switch %i[H hide-header], negatable: false
c.desc 'List available parameters'
c.switch %i[L list], negatable: false
c.action(&Command.run(Container, :mount_list))
end
m.desc 'Create a new mount'
m.arg_name '<ctid>'
m.command %i[new create] do |c|
c.desc 'Filesystem'
c.flag :fs, required: true
c.desc 'Mountpoint'
c.flag :mountpoint, required: true
c.desc 'Type'
c.flag :type, required: true
c.desc 'Options'
c.flag :opts, required: true
c.desc 'Activate this mount when the container starts'
c.switch :automount, default_value: true
c.action(&Command.run(Container, :mount_create))
end
m.desc 'Mount a dataset'
m.arg_name '<ctid> <dataset> <mountpoint>'
m.command :dataset do |c|
c.desc 'Mount the dataset read-only'
c.switch %i[ro read-only], negatable: false
c.desc 'Mount the dataset read-write'
c.switch %i[rw read-write], negatable: false
c.desc 'Activate this mount when the container starts'
c.switch :automount, default_value: true
c.action(&Command.run(Container, :mount_dataset))
end
m.desc 'Register manually created mounts'
m.arg_name '<id> <mountpoint>'
m.command %i[reg register] do |c|
c.desc 'Filesystem'
c.flag :fs
c.desc 'Type'
c.flag :type
c.desc 'Options'
c.flag :opts
c.desc 'Skip container locking to prevent deadlocks'
c.switch 'on-ct-start', negatable: false
c.action(&Command.run(Container, :mount_register))
end
m.desc 'Activate a mount'
m.arg_name '<ctid> <mountpoint>'
m.command :activate do |c|
c.action(&Command.run(Container, :mount_activate))
end
m.desc 'Deactivate a mount'
m.arg_name '<ctid> <mountpoint>'
m.command :deactivate do |c|
c.action(&Command.run(Container, :mount_deactivate))
end
m.desc 'Remove mount'
m.arg_name '<ctid> <mountpoint>'
m.command %i[del delete] do |c|
c.action(&Command.run(Container, :mount_delete))
end
m.desc 'Clear mounts'
m.arg_name '<ctid>'
m.command :clear do |c|
c.action(&Command.run(Container, :mount_clear))
end
end
ct.desc 'Recover container from errors'
ct.command :recover do |r|
r.desc 'Kill all container processes'
r.arg_name '<ctid> [signal]'
r.command :kill do |c|
c.action(&Command.run(Container, :recover_kill))
end
r.desc 'Check current container state'
r.arg_name '<ctid>'
r.command :state do |c|
c.action(&Command.run(Container, :recover_state))
c.desc 'Ignore the manipulation lock mechanism'
c.switch %i[lock], default_value: true
end
r.desc 'Clean up leftover cgroups and network interfaces'
r.arg_name '<ctid>'
r.command :cleanup do |c|
c.desc 'Force the cleanup even on an unstopped container'
c.switch %i[f force], negatable: false
c.desc 'Cleanup only cgroups'
c.switch %i[cgroups], negatable: false
c.desc 'Cleanup only network interfaces'
c.switch %i[network-interfaces], negatable: false
c.action(&Command.run(Container, :recover_cleanup))
end
end
end
desc 'Key chain management for container sends'
command :send do |m|
m.desc 'Manage local node identity'
m.command :key do |k|
k.desc 'Generate a new public/private key pair'
k.command :gen do |c|
c.desc 'Key type'
c.flag %i[t type], must_match: %w[rsa ecdsa ed25519]
c.desc 'Key bit size'
c.flag %i[b bits], type: Integer, arg_name: 'n'
c.desc 'Overwrite existing key'
c.switch %i[f force], negatable: false
c.action(&Command.run(Send, :key_gen))
end
k.desc 'Print path to public/private key'
k.arg_name '[public | private]'
k.command :path do |c|
c.action(&Command.run(Send, :key_path))
end
end
end
desc 'Key chain management for receiving containers'
command :receive do |m|
m.desc 'Manage keys authorized to send containers to this node'
m.command 'authorized-keys' do |a|
a.desc 'List authorized keys'
a.command %i[ls list] do |c|
c.action(&Command.run(Receive, :authorized_keys_list))
end
a.desc 'Authorize a new key'
a.arg_name '<name>'
a.command :add do |c|
c.desc 'Container ID pattern'
c.flag 'ctid'
c.desc 'Source host/address pattern'
c.flag 'from'
c.desc 'Single use authorization'
c.switch 'single-use'
c.desc 'Passphrase'
c.flag 'passphrase'
c.action(&Command.run(Receive, :authorized_keys_add))
end
a.desc 'Remove authorized key by name'
a.arg_name '<name>'
a.command %i[del delete] do |c|
c.action(&Command.run(Receive, :authorized_keys_delete))
end
end
end
desc 'Manage image repositories'
command %i[repo repository] do |r|
r.desc 'List repositories'
r.arg_name '[repository...]'
r.command %i[ls list] do |c|
c.desc 'Select parameters to output'
c.flag %i[o output], arg_name: 'parameters'
c.desc 'Do not show header'
c.switch %i[H hide-header], negatable: false
c.desc 'List available parameters'
c.switch %i[L list], negatable: false
c.action(&Command.run(Repository, :list))
end
r.desc 'Show information about a repository'
r.arg_name '<repository>'
r.command :show do |c|
c.desc 'Select parameters to output'
c.flag %i[o output], arg_name: 'parameters'
c.desc 'Do not show header'
c.switch %i[H hide-header], negatable: false
c.desc 'List available parameters'
c.switch %i[L list], negatable: false
c.action(&Command.run(Repository, :show))
end
r.desc 'Add a new repository'
r.arg_name '<repository> <url>'
r.command :add do |c|
c.action(&Command.run(Repository, :add))
end
r.desc 'Remove a repository'
r.arg_name '<repository>'
r.command :del do |c|
c.action(&Command.run(Repository, :delete))
end
r.desc 'Enable a repository'
r.arg_name '<repository>'
r.command :enable do |c|
c.action(&Command.run(Repository, :enable))
end
r.desc 'Disable a repository'
r.arg_name '<repository>'
r.command :disable do |c|
c.action(&Command.run(Repository, :disable))
end
r.desc 'Configure repository'
r.command :set do |set|
set.desc 'Change repository URL'
set.arg_name '<repository> <url>'
set.command :url do |c|
c.action(&Command.run(Repository, :set_url))
end
set_attr(set, Repository, 'repository')
end
r.desc 'Clear configuration options'
r.command :unset do |unset|
unset_attr(unset, Repository, 'repository')
end
r.desc 'List repository assets (datasets, files, directories)'
r.arg_name '<repository>'
assets(r, Repository)
r.desc 'Browse repository images'
r.command :images do |t|
t.desc 'List available images'
t.arg_name '<repository>'
t.command %i[ls list] do |c|
c.desc 'Select parameters to output'
c.flag %i[o output], arg_name: 'parameters'
c.desc 'Do not show header'
c.switch %i[H hide-header], negatable: false
c.desc 'List available parameters'
c.switch %i[L list], negatable: false
c.desc 'Sort by parameter(s)'
c.flag %i[s sort]
c.desc 'Filter by vendor'
c.flag :vendor, arg_name: 'vendor'
c.desc 'Filter by variant'
c.flag :variant, arg_name: 'variant'
c.desc 'Filter by architecture'
c.flag :arch, arg_name: 'arch'
c.desc 'Filter by distribution'
c.flag :distribution, arg_name: 'distribution'
c.desc 'Filter by distribution version'
c.flag :version, arg_name: 'version'
c.desc 'Filter by version tag'
c.flag :tag, arg_name: 'tag'
c.desc 'Filter locally cached images'
c.switch :cached, negatable: false
c.desc 'Filter locally uncached images'
c.switch :uncached, negatable: false
c.action(&Command.run(Repository, :image_list))
end
end
end
desc 'Manage the CPU scheduler'
command 'cpu-scheduler' do |sched|
sched.desc 'Show CPU scheduler status'
sched.command :status do |c|
c.action(&Command.run(CpuScheduler, :status))
end
sched.desc 'Enable the CPU scheduler'
sched.command :enable do |c|
c.action(&Command.run(CpuScheduler, :enable))
end
sched.desc 'Disable the CPU scheduler'
sched.command :disable do |c|
c.action(&Command.run(CpuScheduler, :disable))
end
sched.desc 'Run internal CPU scheduler upkeeping'
sched.command :upkeep do |c|
c.action(&Command.run(CpuScheduler, :upkeep))
end
sched.desc 'Inspect CPU packages'
sched.command :package do |pkg|
pkg.desc 'List CPU packages'
pkg.command %i[ls list] do |c|
c.desc 'Select parameters to output'
c.flag %i[o output], arg_name: 'parameters'
c.desc 'Do not show header'
c.switch %i[H hide-header], negatable: false
c.desc 'List available parameters'
c.switch %i[L list], negatable: false
c.desc 'Sort by parameter(s)'
c.flag %i[s sort]
c.action(&Command.run(CpuScheduler, :package_list))
end
pkg.desc 'Enable CPU package'
pkg.arg_name '<package>'
pkg.command :enable do |c|
c.action(&Command.run(CpuScheduler, :package_enable))
end
pkg.desc 'Disable CPU package'
pkg.arg_name '<package>'
pkg.command :disable do |c|
c.action(&Command.run(CpuScheduler, :package_disable))
end
end
end
desc 'Manage trash bin'
command 'trash-bin' do |t|
t.desc 'Manage datasets'
t.command :dataset do |ds|
ds.desc 'Add custom dataset to the trash bin'
ds.arg_name '<dataset>'
ds.command :add do |c|
c.action(&Command.run(TrashBin, :dataset_add))
end
end
t.desc 'Prune trash bin'
t.arg_name '[pool...]'
t.command :prune do |c|
c.action(&Command.run(TrashBin, :prune))
end
end
desc 'Manage garbage collector'
command 'garbage-collector' do |t|
t.desc 'Run garbage collector'
t.arg_name '[pool...]'
t.command :prune do |c|
c.action(&Command.run(GarbageCollector, :prune))
end
end
desc 'Monitor'
command :monitor do |c|
c.action(&Command.run(Event, :monitor))
end
desc 'Browse pool management history'
arg_name '[pool]'
command :history do |c|
c.action(&Command.run(History, :list))
end
desc "List osctld's assets (datasets, files, directories)"
assets(self, Self)
desc 'Health check'
arg_name '[pool...]'
command :healthcheck do |c|
c.desc 'Check all pools'
c.switch %i[a all], negatable: false
c.action(&Command.run(Self, :healthcheck))
end
desc 'Check if osctld is running'
arg_name '[wait]'
command :ping do |c|
c.action(&Command.run(Self, :ping))
end
desc 'Execute Ruby script with osctl modules'
arg_name '<file> [args...]'
command :script do |c|
c.action(&Command.run(Self, :script))
end
desc 'Configure the system after it was upgraded'
command :activate do |c|
c.desc 'Regenerate system files'
c.switch :system, default_value: true
c.action(&Command.run(Self, :activate))
end
desc 'Export all pools and stop all containers'
command :shutdown do |c|
c.desc 'Do not ask for confirmation, shutdown immediately'
c.switch %i[f force], negatable: false
c.desc 'Send message to logged-in container users'
c.switch %i[w wall], default_value: true
c.desc 'Message sent to logged-in container users'
c.flag %i[m message], arg_name: 'message'
c.desc 'Abort running shutdown'
c.switch %i[abort], negatable: false
c.action(&Command.run(Self, :shutdown))
end
command :debug do |dbg|
dbg.command 'locks' do |locks|
locks.command :ls do |c|
c.switch %i[v verbose], negatable: false
c.action(&Command.run(Debug, :locks_ls))
end
locks.arg_name '<id>'
locks.command :show do |c|
c.action(&Command.run(Debug, :locks_show))
end
end
dbg.command 'threads' do |threads|
threads.command :ls do |c|
c.action(&Command.run(Debug, :threads_ls))
end
end
dbg.command 'ugids' do |ugids|
ugids.arg_name '[all|taken|free]'
ugids.command :ls do |c|
c.action(&Command.run(Debug, :ugids_ls))
end
end
end
command 'gen-completion' do |g|
g.command :bash do |c|
c.action(&Command.run(GenCompletion, :bash))
end
end
end
|