-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathincus-doc-cli.txt
More file actions
4515 lines (3671 loc) · 149 KB
/
incus-doc-cli.txt
File metadata and controls
4515 lines (3671 loc) · 149 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
--- Metadata ---
Content: Combination of the incus CLI documentation from the `incus --help`
Source: Extraction of the `incus --help`
Date: 2026-03-30
Author: lxc/incus (linuxcontainers)
License: Apache-2.0
GeneratedBy: https://github.com/fruafr/incus-doc-cli
---
--- admin.md ---
# INCUS - CLI - Help - Admin
## Main command
- [`incus admin`](./incus/admin.txt)
## Sub-commands
- [`incus admin cluster`](./incus/admin/cluster.txt)
- [`incus admin init`](./incus/admin/init.txt)
- [`incus admin recover`](./incus/admin/recover.txt)
- [`incus admin shutdown`](./incus/admin/shutdown.txt)
- [`incus admin sql`](./incus/admin/sql.txt)
- [`incus admin waitready`](./incus/admin/waitready.txt)
--- cluster.md ---
# INCUS - CLI - Help - cluster
## Main command
- [`incus cluster`](./incus/cluster.txt)
## Sub-commands
- [`incus cluster add`](./incus/cluster/add.txt)
- [`incus cluster edit`](./incus/cluster/edit.txt)
- [`incus cluster enable`](./incus/cluster/enable.txt)
- [`incus cluster evacuate`](./incus/cluster/evacuate.txt)
- [`incus cluster get`](./incus/cluster/get.txt)
- [`incus cluster group`](./incus/cluster/group.txt)
- [`incus cluster info`](./incus/cluster/info.txt)
- [`incus cluster list`](./incus/cluster/list.txt)
- [`incus cluster list-tokens`](./incus/cluster/list-tokens.txt)
- [`incus cluster remove`](./incus/cluster/remove.txt)
- [`incus cluster rename`](./incus/cluster/rename.txt)
- [`incus cluster restore`](./incus/cluster/restore.txt)
- [`incus cluster revoke-token`](./incus/cluster/revoken-token.txt)
- [`incus cluster role`](./incus/cluster/role.txt)
- [`incus cluster set`](./incus/cluster/set.txt)
- [`incus cluster show`](./incus/cluster/show.txt)
- [`incus cluster update-certificate`](./incus/cluster/update-certificate.txt)
--- config.md ---
# INCUS - CLI - Help - Config
## Main command
- [`incus config`](./incus/config.txt)
## Sub-commands
- [`incus config device`](./incus/config/device.txt)
- [`incus config edit`](./incus/config/edit.txt)
- [`incus config get`](./incus/config/get.txt)
- [`incus config metadata`](./incus/config/metadata.txt)
- [`incus config set`](./incus/config/set.txt)
- [`incus config show`](./incus/config/show.txt)
- [`incus config template`](./incus/config/template.txt)
- [`incus config trust`](./incus/config/trust.txt)
- [`incus config unset`](./incus/config/unset.txt)
--- file.md ---
# INCUS - CLI - Help - File
## Main command
- [`incus file`](./incus/file.txt)
## Sub-commands
- [`incus file create`](./incus/file/create.txt)
- [`incus file delete`](./incus/file/delete.txt)
- [`incus file edit`](./incus/file/edit.txt)
- [`incus file mount`](./incus/file/mount.txt)
- [`incus file pull`](./incus/file/pull.txt)
- [`incus file push`](./incus/file/push.txt)
--- image.md ---
# INCUS - CLI - Help - Image
## Main command
- [`incus image`](./incus/image.txt)
## Sub-commands
- [`incus image alias`](./incus/image/alias.txt)
- [`incus image copy`](./incus/image/copy.txt)
- [`incus image delete`](./incus/image/delete.txt)
- [`incus image edit`](./incus/image/edit.txt)
- [`incus image export`](./incus/image/export.txt)
- [`incus image get-property`](./incus/image/get-property.txt)
- [`incus image import`](./incus/image/import.txt)
- [`incus image info`](./incus/image/info.txt)
- [`incus image list`](./incus/image/list.txt)
- [`incus image refresh`](./incus/image/refresh.txt)
- [`incus image set-property`](./incus/image/set-property.txt)
- [`incus image show`](./incus/image/show.txt)
- [`incus image unset-property`](./incus/image/unset-property.txt)
--- incus.md ---
# INCUS - CLI - Help
[Incus](https://linuxcontainers.org/incus/docs/main/) CLI help documentation
Below is the documentation of commands and sub-commands per the official command help :
- [`incus`](./incus/incus.txt)
## Main commands
- [`incus admin`](./admin.md)
- [`incus cluster`](./cluster.md)
- [`incus config`](./config.md)
- [`incus console`](./incus/console.txt)
- [`incus copy`](./incus/copy.txt)
- [`incus create`](./incus/create.txt)
- [`incus delete`](./incus/delete.txt)
- [`incus exec`](./incus/exec.txt)
- [`incus export`](./incus/export.txt)
- [`incus file`](./file.md)
- [`incus help`](./incus/help.txt)
- [`incus image`](./image.md)
- [`incus import`](./incus/import.txt)
- [`incus info`](./incus/info.txt)
- [`incus launch`](./incus/launch.txt)
- [`incus list`](./incus/list.txt)
- [`incus move`](./incus/move.txt)
- [`incus network`](./network.md)
- [`incus pause`](./incus/pause.txt)
- [`incus profile`](./profile.md)
- [`incus project`](./project.md)
- [`incus publish`](./incus/publish.txt)
- [`incus rebuild`](./incus/rebuild.txt)
- [`incus remote`](./remote.md)
- [`incus rename`](./incus/rename.txt)
- [`incus restart`](./incus/restart.txt)
- [`incus resume`](./incus/resume.txt)
- [`incus snapshot`](./snapshot.md)
- [`incus start`](./incus/start.txt)
- [`incus stop`](./incus/stop.txt)
- [`incus storage`](./storage.md)
- [`incus top`](./incus/top.txt)
- [`incus version`](./incus/version.txt)
- [`incus webui`](./incus/webui.txt)
--- network.md ---
# INCUS - CLI - Help - Network
## Main command
- [`incus network`](./incus/network.txt)
## Sub-commands
- [`incus network acl`](./incus/network/acl.txt)
- [`incus network attach`](./incus/network/attach.txt)
- [`incus network attach-profile`](./incus/network/attach-profile.txt)
- [`incus network create`](./incus/network/create.txt)
- [`incus network delete`](./incus/network/delete.txt)
- [`incus network detach`](./incus/network/detach.txt)
- [`incus network detach-profile`](./incus/network/detach-profile.txt)
- [`incus network edit`](./incus/network/edit.txt)
- [`incus network forward`](./incus/network/forward.txt)
- [`incus network get`](./incus/network/get.txt)
- [`incus network info`](./incus/network/info.txt)
- [`incus network integration`](./incus/network/integration.txt)
- [`incus network list`](./incus/network/list.txt)
- [`incus network list-allocations`](./incus/network/list-allocations.txt)
- [`incus network list-leases`](./incus/network/list-leases.txt)
- [`incus network load-balancer`](./incus/network/load-balancer.txt)
- [`incus network peer`](./incus/network/peer.txt)
- [`incus network rename`](./incus/network/rename.txt)
- [`incus network set`](./incus/network/set.txt)
- [`incus network show`](./incus/network/show.txt)
- [`incus network unset`](./incus/network/unset.txt)
- [`incus network zone`](./incus/network/zone.txt)
--- profile.md ---
# INCUS - CLI - Help - Profile
## Main command
- [`incus profile`](./incus/profile.txt)
## Sub-commands
- [`incus profile add`](./incus/profile/add.txt)
- [`incus profile assign`](./incus/profile/assign.txt)
- [`incus profile copy`](./incus/profile/copy.txt)
- [`incus profile create`](./incus/profile/create.txt)
- [`incus profile delete`](./incus/profile/delete.txt)
- [`incus profile device`](./incus/profile/device.txt)
- [`incus profile edit`](./incus/profile/edit.txt)
- [`incus profile get`](./incus/profile/get.txt)
- [`incus profile list`](./incus/profile/list.txt)
- [`incus profile remove`](./incus/profile/remove.txt)
- [`incus profile rename`](./incus/profile/rename.txt)
- [`incus profile set`](./incus/profile/set.txt)
- [`incus profile show`](./incus/profile/show.txt)
- [`incus profile unset`](./incus/profile/unset.txt)
--- project.md ---
# INCUS - CLI - Help - Project
## Main command
- [`incus project`](./incus/project.txt)
## Sub-commands
- [`incus project create`](./incus/project/create.txt)
- [`incus project delete`](./incus/project/delete.txt)
- [`incus project edit`](./incus/project/edit.txt)
- [`incus project get`](./incus/project/get.txt)
- [`incus project get-current`](./incus/project/get-current.txt)
- [`incus project info`](./incus/project/info.txt)
- [`incus project list`](./incus/project/list.txt)
- [`incus project rename`](./incus/project/rename.txt)
- [`incus project set`](./incus/project/set.txt)
- [`incus project show`](./incus/project/show.txt)
- [`incus project switch`](./incus/project/switch.txt)
- [`incus project unset`](./incus/project/unset.txt)
--- remote.md ---
# INCUS - CLI - Help - Remote
## Main command
- [`incus remote`](./incus/remote.txt)
## Sub-commands
- [`incus remote add`](./incus/remote/add.txt)
- [`incus remote generate-certificate`](./incus/remote/generate-certificate.txt)
- [`incus remote get-default`](./incus/remote/get-default.txt)
- [`incus remote list`](./incus/remote/list.txt)
- [`incus remote proxy`](./incus/remote/proxy.txt)
- [`incus remote remove`](./incus/remote/remove.txt)
- [`incus remote rename`](./incus/remote/rename.txt)
- [`incus remote set-url`](./incus/remote/set-url.txt)
- [`incus remote switch`](./incus/remote/switch.txt)
--- snapshot.md ---
# INCUS - CLI - Help - Snapshot
## Main command
- [`incus snapshot`](./incus/snapshot.txt)
## Sub-commands
- [`incus snapshot create`](./incus/snapshot/create.txt)
- [`incus snapshot delete`](./incus/snapshot/delete.txt)
- [`incus snapshot list`](./incus/snapshot/list.txt)
- [`incus snapshot rename`](./incus/snapshot/rename.txt)
- [`incus snapshot restore`](./incus/snapshot/restore.txt)
- [`incus snapshot show`](./incus/snapshot/show.txt)
--- storage.md ---
# INCUS - CLI - Help - Storage
## Main command
- [`incus storage`](./incus/storage.txt)
## Sub-commands
- [`incus storage bucket`](./incus/storage/bucket.txt)
- [`incus storage create`](./incus/storage/create.txt)
- [`incus storage delete`](./incus/storage/delete.txt)
- [`incus storage edit`](./incus/storage/edit.txt)
- [`incus storage get`](./incus/storage/get.txt)
- [`incus storage info`](./incus/storage/info.txt)
- [`incus storage list`](./incus/storage/list.txt)
- [`incus storage set`](./incus/storage/set.txt)
- [`incus storage show`](./incus/storage/show.txt)
- [`incus storage unset`](./incus/storage/unset.txt)
- [`incus storage volume`](./incus/storage/volume.txt)
--- admin.txt ---
Description:
Manage incus daemon
Usage:
incus admin [command]
Available Commands:
cluster Low-level cluster administration commands
init Configure the daemon
recover Recover missing instances and volumes from existing and unknown storage pools
shutdown Tell the daemon to shutdown all instances and exit
sql Execute a SQL query against the local or global database
waitready Wait for the daemon to be ready to process requests
Global Flags:
--debug Show all debug messages
--force-local Force using the local unix socket
-h, --help Print help
--project Override the source project
-q, --quiet Don't show progress information
--sub-commands Use with help or --help to view sub-commands
-v, --verbose Show all information messages
--version Print version number
Use "incus admin [command] --help" for more information about a command.
--- cluster.txt ---
Description:
Manage cluster members
Usage:
incus cluster [flags]
incus cluster [command]
Available Commands:
add Request a join token for adding a cluster member
edit Edit cluster member configurations as YAML
enable Enable clustering on a single non-clustered server
evacuate Evacuate cluster member
get Get values for cluster member configuration keys
group Manage cluster groups
info Show useful information about a cluster member
list List all the cluster members
list-tokens List all active cluster member join tokens
remove Remove a member from the cluster
rename Rename a cluster member
restore Restore cluster member
revoke-token Revoke cluster member join token
role Manage cluster roles
set Set a cluster member's configuration keys
show Show details of a cluster member
unset Unset a cluster member's configuration keys
update-certificate Update cluster certificate
Global Flags:
--debug Show all debug messages
--force-local Force using the local unix socket
-h, --help Print help
--project Override the source project
-q, --quiet Don't show progress information
--sub-commands Use with help or --help to view sub-commands
-v, --verbose Show all information messages
--version Print version number
Use "incus cluster [command] --help" for more information about a command.
--- config.txt ---
Description:
Manage instance and server configuration options
Usage:
incus config [flags]
incus config [command]
Available Commands:
device Manage devices
edit Edit instance or server configurations as YAML
get Get values for instance or server configuration keys
metadata Manage instance metadata files
set Set instance or server configuration keys
show Show instance or server configurations
template Manage instance file templates
trust Manage trusted clients
unset Unset instance or server configuration keys
Global Flags:
--debug Show all debug messages
--force-local Force using the local unix socket
-h, --help Print help
--project Override the source project
-q, --quiet Don't show progress information
--sub-commands Use with help or --help to view sub-commands
-v, --verbose Show all information messages
--version Print version number
Use "incus config [command] --help" for more information about a command.
--- console.txt ---
Description:
Attach to instance consoles
This command allows you to interact with the boot console of an instance
as well as retrieve past log entries from it.
Usage:
incus console [<remote>:]<instance> [flags]
Flags:
-f, --force Forces a connection to the console, even if there is already an active session
--show-log Retrieve the instance's console log
-t, --type Type of connection to establish: 'console' for serial console, 'vga' for SPICE graphical output (default "console")
Global Flags:
--debug Show all debug messages
--force-local Force using the local unix socket
-h, --help Print help
--project Override the source project
-q, --quiet Don't show progress information
--sub-commands Use with help or --help to view sub-commands
-v, --verbose Show all information messages
--version Print version number
--- copy.txt ---
Description:
Copy instances within or in between servers
Transfer modes (--mode):
- pull: Target server pulls the data from the source server (source must listen on network)
- push: Source server pushes the data to the target server (target must listen on network)
- relay: The CLI connects to both source and server and proxies the data (both source and target must listen on network)
The pull transfer mode is the default as it is compatible with all server versions.
Usage:
incus copy [<remote>:]<source>[/<snapshot>] [[<remote>:]<destination>] [flags]
Aliases:
copy, cp
Flags:
--allow-inconsistent Ignore copy errors for volatile files
-c, --config Config key/value to apply to the new instance
-d, --device New key/value to apply to a specific device
-e, --ephemeral Ephemeral instance
--instance-only Copy the instance without its snapshots
--mode Transfer mode. One of pull, push or relay (default "pull")
--no-profiles Create the instance with no profiles applied
-p, --profile Profile to apply to the new instance
--refresh Perform an incremental copy
--refresh-exclude-older During incremental copy, exclude source snapshots earlier than latest target snapshot
--stateless Copy a stateful instance stateless
-s, --storage Storage pool name
--target Cluster member name
--target-project Copy to a project different from the source
Global Flags:
--debug Show all debug messages
--force-local Force using the local unix socket
-h, --help Print help
--project Override the source project
-q, --quiet Don't show progress information
--sub-commands Use with help or --help to view sub-commands
-v, --verbose Show all information messages
--version Print version number
--- create.txt ---
Description:
Create instances from images
Usage:
incus create [<remote>:]<image> [<remote>:][<name>] [flags]
Aliases:
create, init
Examples:
incus create images:ubuntu/22.04 u1
incus create images:ubuntu/22.04 u1 < config.yaml
Create the instance with configuration from config.yaml
incus launch images:debian/12 v2 --vm -d root,size=50GiB -d root,io.bus=nvme
Create and start a virtual machine, overriding the disk size and bus
Flags:
-c, --config Config key/value to apply to the new instance
--description Instance description
-d, --device New key/value to apply to a specific device
--empty Create an empty instance
--environment-file Include environment variables from file
-e, --ephemeral Ephemeral instance
-n, --network Network name
--no-profiles Create the instance with no profiles applied
-p, --profile Profile to apply to the new instance
-s, --storage Storage pool name
--target Cluster member name
-t, --type Instance type
--vm Create a virtual machine
Global Flags:
--debug Show all debug messages
--force-local Force using the local unix socket
-h, --help Print help
--project Override the source project
-q, --quiet Don't show progress information
--sub-commands Use with help or --help to view sub-commands
-v, --verbose Show all information messages
--version Print version number
--- delete.txt ---
Description:
Delete instances
Usage:
incus delete [<remote>:]<instance> [[<remote>:]<instance>...] [flags]
Aliases:
delete, rm
Flags:
-f, --force Force the removal of running instances
-i, --interactive Require user confirmation
Global Flags:
--debug Show all debug messages
--force-local Force using the local unix socket
-h, --help Print help
--project Override the source project
-q, --quiet Don't show progress information
--sub-commands Use with help or --help to view sub-commands
-v, --verbose Show all information messages
--version Print version number
--- exec.txt ---
Description:
Execute commands in instances
The command is executed directly using exec, so there is no shell and
shell patterns (variables, file redirects, ...) won't be understood.
If you need a shell environment you need to execute the shell
executable, passing the shell commands as arguments, for example:
incus exec <instance> -- sh -c "cd /tmp && pwd"
Mode defaults to non-interactive, interactive mode is selected if both stdin AND stdout are terminals (stderr is ignored).
Usage:
incus exec [<remote>:]<instance> [flags] [--] <command line>
Examples:
incus exec c1 bash
Run the "bash" command in instance "c1"
incus exec c1 -- ls -lh /
Run the "ls -lh /" command in instance "c1"
Flags:
--cwd Directory to run the command in (default /root)
-n, --disable-stdin Disable stdin (reads from /dev/null)
--env Environment variable to set (e.g. HOME=/home/foo)
-t, --force-interactive Force pseudo-terminal allocation
-T, --force-noninteractive Disable pseudo-terminal allocation
--group Group ID to run the command as (default 0)
--mode Override the terminal mode (auto, interactive or non-interactive) (default "auto")
--user User ID to run the command as (default 0)
Global Flags:
--debug Show all debug messages
--force-local Force using the local unix socket
-h, --help Print help
--project Override the source project
-q, --quiet Don't show progress information
--sub-commands Use with help or --help to view sub-commands
-v, --verbose Show all information messages
--version Print version number
--- export.txt ---
Description:
Export instances as backup tarballs.
Usage:
incus export [<remote>:]<instance> [target] [--instance-only] [--optimized-storage] [flags]
Examples:
incus export u1 backup0.tar.gz
Download a backup tarball of the u1 instance.
Flags:
--compression Compression algorithm to use (none for uncompressed)
--instance-only Whether or not to only backup the instance (without snapshots)
--optimized-storage Use storage driver optimized format (can only be restored on a similar pool)
Global Flags:
--debug Show all debug messages
--force-local Force using the local unix socket
-h, --help Print help
--project Override the source project
-q, --quiet Don't show progress information
--sub-commands Use with help or --help to view sub-commands
-v, --verbose Show all information messages
--version Print version number
--- file.txt ---
Description:
Manage files in instances
Usage:
incus file [flags]
incus file [command]
Available Commands:
create Create files and directories in instances
delete Delete files in instances
edit Edit files in instances
mount Mount files from instances
pull Pull files from instances
push Push files into instances
Global Flags:
--debug Show all debug messages
--force-local Force using the local unix socket
-h, --help Print help
--project Override the source project
-q, --quiet Don't show progress information
--sub-commands Use with help or --help to view sub-commands
-v, --verbose Show all information messages
--version Print version number
Use "incus file [command] --help" for more information about a command.
--- help.txt ---
Help provides help for any command in the application.
Simply type incus help [path to command] for full details.
Usage:
incus help [command] [flags]
Flags:
--all Show less common commands
Global Flags:
--debug Show all debug messages
--force-local Force using the local unix socket
-h, --help Print help
--project Override the source project
-q, --quiet Don't show progress information
--sub-commands Use with help or --help to view sub-commands
-v, --verbose Show all information messages
--version Print version number
--- image.txt ---
Description:
Manage images
Instances are created from images. Those images were themselves
either generated from an existing instance or downloaded from an image
server.
When using remote images, the server will automatically cache images for you
and remove them upon expiration.
The image unique identifier is the hash (sha-256) of its representation
as a compressed tarball (or for split images, the concatenation of the
metadata and rootfs tarballs).
Images can be referenced by their full hash, shortest unique partial
hash or alias name (if one is set).
Usage:
incus image [flags]
incus image [command]
Available Commands:
alias Manage image aliases
copy Copy images between servers
delete Delete images
edit Edit image properties
export Export and download images
get-property Get image properties
import Import images into the image store
info Show useful information about images
list List images
refresh Refresh images
set-property Set image properties
show Show image properties
unset-property Unset image properties
Global Flags:
--debug Show all debug messages
--force-local Force using the local unix socket
-h, --help Print help
--project Override the source project
-q, --quiet Don't show progress information
--sub-commands Use with help or --help to view sub-commands
-v, --verbose Show all information messages
--version Print version number
Use "incus image [command] --help" for more information about a command.
--- import.txt ---
Description:
Import backups of instances including their snapshots.
Usage:
incus import [<remote>:] <backup file> [<instance name>] [flags]
Examples:
incus import backup0.tar.gz
Create a new instance using backup0.tar.gz as the source.
Flags:
-s, --storage Storage pool name
Global Flags:
--debug Show all debug messages
--force-local Force using the local unix socket
-h, --help Print help
--project Override the source project
-q, --quiet Don't show progress information
--sub-commands Use with help or --help to view sub-commands
-v, --verbose Show all information messages
--version Print version number
--- incus.txt ---
Description:
Command line client for Incus
All of Incus's features can be driven through the various commands below.
For help with any of those, simply call them with --help.
Custom commands can be defined through aliases, use "incus alias" to control those.
Usage:
incus [command]
Available Commands:
admin Manage incus daemon
cluster Manage cluster members
config Manage instance and server configuration options
console Attach to instance consoles
copy Copy instances within or in between servers
create Create instances from images
delete Delete instances
exec Execute commands in instances
export Export instance backups
file Manage files in instances
help Help about any command
image Manage images
import Import instance backups
info Show instance or server information
launch Create and start instances from images
list List instances
move Move instances within or in between servers
network Manage and attach instances to networks
pause Pause instances
profile Manage profiles
project Manage projects
publish Publish instances as images
rebuild Rebuild instances
remote Manage the list of remote servers
rename Rename instances
restart Restart instances
resume Resume instances
snapshot Manage instance snapshots
start Start instances
stop Stop instances
storage Manage storage pools and volumes
top Display resource usage info per instance
version Show local and remote versions
webui Open the web interface
Flags:
--all Show less common commands
--debug Show all debug messages
--force-local Force using the local unix socket
-h, --help Print help
--project Override the source project
-q, --quiet Don't show progress information
--sub-commands Use with help or --help to view sub-commands
-v, --verbose Show all information messages
--version Print version number
Use "incus [command] --help" for more information about a command.
--- info.txt ---
Description:
Show instance or server information
Usage:
incus info [<remote>:][<instance>] [flags]
Examples:
incus info [<remote>:]<instance> [--show-log]
For instance information.
incus info [<remote>:] [--resources]
For server information.
Flags:
--resources Show the resources available to the server
--show-access Show the instance's access list
--show-log Show the instance's recent log entries
--target Cluster member name
Global Flags:
--debug Show all debug messages
--force-local Force using the local unix socket
-h, --help Print help
--project Override the source project
-q, --quiet Don't show progress information
--sub-commands Use with help or --help to view sub-commands
-v, --verbose Show all information messages
--version Print version number
--- launch.txt ---
Description:
Create and start instances from images
Usage:
incus launch [<remote>:]<image> [<remote>:][<name>] [flags]
Aliases:
launch, init
Examples:
incus launch images:ubuntu/22.04 u1
incus launch images:ubuntu/22.04 u1 < config.yaml
Create and start a container with configuration from config.yaml
incus launch images:ubuntu/22.04 u2 -t aws:t2.micro
Create and start a container using the same size as an AWS t2.micro (1 vCPU, 1GiB of RAM)
incus launch images:ubuntu/22.04 v1 --vm -c limits.cpu=4 -c limits.memory=4GiB
Create and start a virtual machine with 4 vCPUs and 4GiB of RAM
incus launch images:debian/12 v2 --vm -d root,size=50GiB -d root,io.bus=nvme
Create and start a virtual machine, overriding the disk size and bus
Flags:
-c, --config Config key/value to apply to the new instance
--console[="console"] Immediately attach to the console
--description Instance description
-d, --device New key/value to apply to a specific device
--empty Create an empty instance
--environment-file Include environment variables from file
-e, --ephemeral Ephemeral instance
-n, --network Network name
--no-profiles Create the instance with no profiles applied
-p, --profile Profile to apply to the new instance
-s, --storage Storage pool name
--target Cluster member name
-t, --type Instance type
--vm Create a virtual machine
Global Flags:
--debug Show all debug messages
--force-local Force using the local unix socket
-h, --help Print help
--project Override the source project
-q, --quiet Don't show progress information
--sub-commands Use with help or --help to view sub-commands
-v, --verbose Show all information messages
--version Print version number
--- list.txt ---
Description:
List instances
Default column layout: ns46tS
Fast column layout: nsacPt
A single keyword like "web" which will list any instance with a name starting by "web".
A regular expression on the instance name. (e.g. .*web.*01$).
A key/value pair referring to a configuration item. For those, the
namespace can be abbreviated to the smallest unambiguous identifier.
A key/value pair where the key is a shorthand. Multiple values must be delimited by ','. Available shorthands:
- type={instance type}
- status={instance current lifecycle status}
- architecture={instance architecture}
- location={location name}
- ipv4={ip or CIDR}
- ipv6={ip or CIDR}
Examples:
- "user.blah=abc" will list all instances with the "blah" user property set to "abc".
- "u.blah=abc" will do the same
- "security.privileged=true" will list all privileged instances
- "s.privileged=true" will do the same
- "type=container" will list all container instances
- "type=container status=running" will list all running container instances
A regular expression matching a configuration item or its value. (e.g. volatile.eth0.hwaddr=10:66:6a:.*).
When multiple filters are passed, they are added one on top of the other,
selecting instances which satisfy them all.
== Columns ==
The -c option takes a comma separated list of arguments that control
which instance attributes to output when displaying in table or csv
format.
Column arguments are either pre-defined shorthand chars (see below),
or (extended) config keys.
Commas between consecutive shorthand chars are optional.
Pre-defined column shorthand chars:
4 - IPv4 address
6 - IPv6 address
a - Architecture
b - Storage pool
c - Creation date
d - Description
D - disk usage
e - Project name
l - Last used date
m - Memory usage
M - Memory usage (%)
n - Name
N - Number of Processes
p - PID of the instance's init process
P - Profiles
s - State
S - Number of snapshots
t - Type (persistent or ephemeral)
u - CPU usage (in seconds)
U - Started date
L - Location of the instance (e.g. its cluster member)
f - Base Image Fingerprint (short)
F - Base Image Fingerprint (long)
Custom columns are defined with "[config:|devices:]key[:name][:maxWidth]":
KEY: The (extended) config or devices key to display. If [config:|devices:] is omitted then it defaults to config key.
NAME: Name to display in the column header.
Defaults to the key if not specified or empty.
MAXWIDTH: Max width of the column (longer results are truncated).
Defaults to -1 (unlimited). Use 0 to limit to the column header size.
Usage:
incus list [<remote>:] [<filter>...] [flags]
Aliases:
list, ls
Examples:
incus list -c nFs46,volatile.eth0.hwaddr:MAC,config:image.os,devices:eth0.parent:ETHP
Show instances using the "NAME", "BASE IMAGE", "STATE", "IPV4", "IPV6" and "MAC" columns.
"BASE IMAGE", "MAC" and "IMAGE OS" are custom columns generated from instance configuration keys.
"ETHP" is a custom column generated from a device key.
incus list -c ns,user.comment:comment
List instances with their running state and user comment.
Flags:
--all-projects Display instances from all projects
-c, --columns Columns (default "ns46tSL")
--fast Fast mode (same as --columns=nsacPt)
-f, --format Format (csv|json|table|yaml|compact), use suffix ",noheader" to disable headers and ",header" to enable it if missing, e.g. csv,header (default "table")
Global Flags:
--debug Show all debug messages
--force-local Force using the local unix socket
-h, --help Print help
--project Override the source project
-q, --quiet Don't show progress information
--sub-commands Use with help or --help to view sub-commands
-v, --verbose Show all information messages
--version Print version number
--- move.txt ---
Description:
Move instances within or in between servers
Transfer modes (--mode):
- pull: Target server pulls the data from the source server (source must listen on network)
- push: Source server pushes the data to the target server (target must listen on network)
- relay: The CLI connects to both source and server and proxies the data (both source and target must listen on network)
The pull transfer mode is the default as it is compatible with all server versions.
Usage:
incus move [<remote>:]<instance> [<remote>:][<instance>] [flags]
Aliases:
move, mv
Examples:
incus move [<remote>:]<source instance> [<remote>:][<destination instance>] [--instance-only]
Move an instance between two hosts, renaming it if destination name differs.
incus move <old name> <new name> [--instance-only]
Rename a local instance.
incus move <instance>/<old snapshot name> <instance>/<new snapshot name>
Rename a snapshot.
Flags:
--allow-inconsistent Ignore copy errors for volatile files
-c, --config Config key/value to apply to the target instance
-d, --device New key/value to apply to a specific device
--instance-only Move the instance without its snapshots
--mode Transfer mode. One of pull, push or relay. (default "pull")
--no-profiles Unset all profiles on the target instance
-p, --profile Profile to apply to the target instance
--stateless Copy a stateful instance stateless
-s, --storage Storage pool name
--target Cluster member name
--target-project Copy to a project different from the source
Global Flags:
--debug Show all debug messages
--force-local Force using the local unix socket
-h, --help Print help
--project Override the source project
-q, --quiet Don't show progress information
--sub-commands Use with help or --help to view sub-commands
-v, --verbose Show all information messages
--version Print version number
--- network.txt ---
Description:
Manage and attach instances to networks
Usage:
incus network [flags]
incus network [command]
Available Commands:
acl Manage network ACLs