]> git.proxmox.com Git - pve-docs.git/blob - pct.1-synopsis.adoc
ha-manager.adoc: fix section hardware watchdog
[pve-docs.git] / pct.1-synopsis.adoc
1 *pct* `<COMMAND> [ARGS] [OPTIONS]`
2
3 *pct clone* `<vmid> <newid> -experimental <boolean>` `[OPTIONS]`
4
5 Create a container clone/copy
6
7 `<vmid>`: `<integer> (1 - N)` ::
8
9 The (unique) ID of the VM.
10
11 `<newid>`: `<integer> (1 - N)` ::
12
13 VMID for the clone.
14
15 `-description` `<string>` ::
16
17 Description for the new CT.
18
19 `-experimental` `<boolean>` ('default =' `0`)::
20
21 The clone feature is experimental, set this flag if you know what you are doing.
22
23 `-full` `<boolean>` ('default =' `0`)::
24
25 Create a full copy of all disk. This is always done when you clone a normal CT. For CT templates, we try to create a linked clone by default.
26
27 `-hostname` `<string>` ::
28
29 Set a hostname for the new CT.
30
31 `-pool` `<string>` ::
32
33 Add the new CT to the specified pool.
34
35 `-snapname` `<string>` ::
36
37 The name of the snapshot.
38
39 `-storage` `<string>` ::
40
41 Target storage for full clone.
42 +
43 NOTE: Requires option(s): `full`
44
45
46
47
48 *pct config* `<vmid>`
49
50 Get container configuration.
51
52 `<vmid>`: `<integer> (1 - N)` ::
53
54 The (unique) ID of the VM.
55
56
57
58
59 *pct console* `<vmid>`
60
61 Launch a console for the specified container.
62
63 `<vmid>`: `<integer> (1 - N)` ::
64
65 The (unique) ID of the VM.
66
67
68
69 *pct cpusets*
70
71 Print the list of assigned CPU sets.
72
73
74
75
76 *pct create* `<vmid> <ostemplate>` `[OPTIONS]`
77
78 Create or restore a container.
79
80 `<vmid>`: `<integer> (1 - N)` ::
81
82 The (unique) ID of the VM.
83
84 `<ostemplate>`: `<string>` ::
85
86 The OS template or backup file.
87
88 `-arch` `<amd64 | i386>` ('default =' `amd64`)::
89
90 OS architecture type.
91
92 `-cmode` `<console | shell | tty>` ('default =' `tty`)::
93
94 Console mode. By default, the console command tries to open a connection to one of the available tty devices. By setting cmode to 'console' it tries to attach to /dev/console instead. If you set cmode to 'shell', it simply invokes a shell inside the container (no login).
95
96 `-console` `<boolean>` ('default =' `1`)::
97
98 Attach a console device (/dev/console) to the container.
99
100 `-cores` `<integer> (1 - 128)` ::
101
102 The number of cores assigned to the container. A container can use all available cores by default.
103
104 `-cpulimit` `<number> (0 - 128)` ('default =' `0`)::
105
106 Limit of CPU usage.
107 +
108 NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.
109
110 `-cpuunits` `<integer> (0 - 500000)` ('default =' `1024`)::
111
112 CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to the weights of all the other running VMs.
113 +
114 NOTE: You can disable fair-scheduler configuration by setting this to 0.
115
116 `-description` `<string>` ::
117
118 Container description. Only used on the configuration web interface.
119
120 `-force` `<boolean>` ::
121
122 Allow to overwrite existing container.
123
124 `-hostname` `<string>` ::
125
126 Set a host name for the container.
127
128 `-ignore-unpack-errors` `<boolean>` ::
129
130 Ignore errors when extracting the template.
131
132 `-lock` `<backup | migrate | rollback | snapshot>` ::
133
134 Lock/unlock the VM.
135
136 `-memory` `<integer> (16 - N)` ('default =' `512`)::
137
138 Amount of RAM for the VM in MB.
139
140 `-mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
141
142 Use volume as container mount point.
143
144 `-nameserver` `<string>` ::
145
146 Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
147
148 `-net[n]` `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
149
150 Specifies network interfaces for the container.
151
152 `-onboot` `<boolean>` ('default =' `0`)::
153
154 Specifies whether a VM will be started during system bootup.
155
156 `-ostype` `<alpine | archlinux | centos | debian | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
157
158 OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used to skip and OS specific setup.
159
160 `-password` ::
161
162 Sets root password inside container.
163
164 `-pool` `<string>` ::
165
166 Add the VM to the specified pool.
167
168 `-protection` `<boolean>` ('default =' `0`)::
169
170 Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
171
172 `-restore` `<boolean>` ::
173
174 Mark this as restore task.
175
176 `-rootfs` `[volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
177
178 Use volume as container root.
179
180 `-searchdomain` `<string>` ::
181
182 Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
183
184 `-ssh-public-keys` `<string>` ::
185
186 Setup public SSH keys (one key per line, OpenSSH format).
187
188 `-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
189
190 Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.
191
192 `-storage` `<string>` ('default =' `local`)::
193
194 Default Storage.
195
196 `-swap` `<integer> (0 - N)` ('default =' `512`)::
197
198 Amount of SWAP for the VM in MB.
199
200 `-template` `<boolean>` ('default =' `0`)::
201
202 Enable/disable Template.
203
204 `-tty` `<integer> (0 - 6)` ('default =' `2`)::
205
206 Specify the number of tty available to the container
207
208 `-unprivileged` `<boolean>` ('default =' `0`)::
209
210 Makes the container run as unprivileged user. (Should not be modified manually.)
211
212 `-unused[n]` `<string>` ::
213
214 Reference to unused volumes. This is used internally, and should not be modified manually.
215
216
217
218
219 *pct delsnapshot* `<vmid> <snapname>` `[OPTIONS]`
220
221 Delete a LXC snapshot.
222
223 `<vmid>`: `<integer> (1 - N)` ::
224
225 The (unique) ID of the VM.
226
227 `<snapname>`: `<string>` ::
228
229 The name of the snapshot.
230
231 `-force` `<boolean>` ::
232
233 For removal from config file, even if removing disk snapshots fails.
234
235
236
237
238 *pct destroy* `<vmid>`
239
240 Destroy the container (also delete all uses files).
241
242 `<vmid>`: `<integer> (1 - N)` ::
243
244 The (unique) ID of the VM.
245
246
247
248
249 *pct df* `<vmid>`
250
251 Get the container's current disk usage.
252
253 `<vmid>`: `<integer> (1 - N)` ::
254
255 The (unique) ID of the VM.
256
257
258
259 *pct enter* `<vmid>`
260
261 Launch a shell for the specified container.
262
263 `<vmid>`: `<integer> (1 - N)` ::
264
265 The (unique) ID of the VM.
266
267
268
269 *pct exec* `<vmid> [<extra-args>]`
270
271 Launch a command inside the specified container.
272
273 `<vmid>`: `<integer> (1 - N)` ::
274
275 The (unique) ID of the VM.
276
277 `<extra-args>`: `<array>` ::
278
279 Extra arguments as array
280
281
282
283 *pct fsck* `<vmid>` `[OPTIONS]`
284
285 Run a filesystem check (fsck) on a container volume.
286
287 `<vmid>`: `<integer> (1 - N)` ::
288
289 The (unique) ID of the VM.
290
291 `-device` `<mp0 | mp1 | mp2 | mp3 | mp4 | mp5 | mp6 | mp7 | mp8 | mp9 | rootfs>` ::
292
293 A volume on which to run the filesystem check
294
295 `-force` `<boolean>` ('default =' `0`)::
296
297 Force checking, even if the filesystem seems clean
298
299
300
301
302 *pct help* `[<cmd>]` `[OPTIONS]`
303
304 Get help about specified command.
305
306 `<cmd>`: `<string>` ::
307
308 Command name
309
310 `-verbose` `<boolean>` ::
311
312 Verbose output format.
313
314
315
316
317 *pct list*
318
319 LXC container index (per node).
320
321
322
323
324 *pct listsnapshot* `<vmid>`
325
326 List all snapshots.
327
328 `<vmid>`: `<integer> (1 - N)` ::
329
330 The (unique) ID of the VM.
331
332
333
334
335 *pct migrate* `<vmid> <target>` `[OPTIONS]`
336
337 Migrate the container to another node. Creates a new migration task.
338
339 `<vmid>`: `<integer> (1 - N)` ::
340
341 The (unique) ID of the VM.
342
343 `<target>`: `<string>` ::
344
345 Target node.
346
347 `-force` `<boolean>` ::
348
349 Force migration despite local bind / device mounts. NOTE: deprecated, use 'shared' property of mount point instead.
350
351 `-online` `<boolean>` ::
352
353 Use online/live migration.
354
355
356
357
358 *pct mount* `<vmid>`
359
360 Mount the container's filesystem on the host. This will hold a lock on the
361 container and is meant for emergency maintenance only as it will prevent
362 further operations on the container other than start and stop.
363
364 `<vmid>`: `<integer> (1 - N)` ::
365
366 The (unique) ID of the VM.
367
368
369
370 *pct pull* `<vmid> <path> <destination>` `[OPTIONS]`
371
372 Copy a file from the container to the local system.
373
374 `<vmid>`: `<integer> (1 - N)` ::
375
376 The (unique) ID of the VM.
377
378 `<path>`: `<string>` ::
379
380 Path to a file inside the container to pull.
381
382 `<destination>`: `<string>` ::
383
384 Destination
385
386 `-group` `<string>` ::
387
388 Owner group name or id.
389
390 `-perms` `<string>` ::
391
392 File permissions to use (octal by default, prefix with '0x' for hexadecimal).
393
394 `-user` `<string>` ::
395
396 Owner user name or id.
397
398
399
400 *pct push* `<vmid> <file> <destination>` `[OPTIONS]`
401
402 Copy a local file to the container.
403
404 `<vmid>`: `<integer> (1 - N)` ::
405
406 The (unique) ID of the VM.
407
408 `<file>`: `<string>` ::
409
410 Path to a local file.
411
412 `<destination>`: `<string>` ::
413
414 Destination inside the container to write to.
415
416 `-group` `<string>` ::
417
418 Owner group name or id. When using a name it must exist inside the container.
419
420 `-perms` `<string>` ::
421
422 File permissions to use (octal by default, prefix with '0x' for hexadecimal).
423
424 `-user` `<string>` ::
425
426 Owner user name or id. When using a name it must exist inside the container.
427
428
429
430
431 *pct resize* `<vmid> <disk> <size>` `[OPTIONS]`
432
433 Resize a container mount point.
434
435 `<vmid>`: `<integer> (1 - N)` ::
436
437 The (unique) ID of the VM.
438
439 `<disk>`: `<mp0 | mp1 | mp2 | mp3 | mp4 | mp5 | mp6 | mp7 | mp8 | mp9 | rootfs>` ::
440
441 The disk you want to resize.
442
443 `<size>`: `\+?\d+(\.\d+)?[KMGT]?` ::
444
445 The new size. With the '+' sign the value is added to the actual size of the volume and without it, the value is taken as an absolute one. Shrinking disk size is not supported.
446
447 `-digest` `<string>` ::
448
449 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
450
451
452
453 *pct restore* `<vmid> <ostemplate>` `[OPTIONS]`
454
455 Create or restore a container.
456
457 `<vmid>`: `<integer> (1 - N)` ::
458
459 The (unique) ID of the VM.
460
461 `<ostemplate>`: `<string>` ::
462
463 The OS template or backup file.
464
465 `-arch` `<amd64 | i386>` ('default =' `amd64`)::
466
467 OS architecture type.
468
469 `-cmode` `<console | shell | tty>` ('default =' `tty`)::
470
471 Console mode. By default, the console command tries to open a connection to one of the available tty devices. By setting cmode to 'console' it tries to attach to /dev/console instead. If you set cmode to 'shell', it simply invokes a shell inside the container (no login).
472
473 `-console` `<boolean>` ('default =' `1`)::
474
475 Attach a console device (/dev/console) to the container.
476
477 `-cores` `<integer> (1 - 128)` ::
478
479 The number of cores assigned to the container. A container can use all available cores by default.
480
481 `-cpulimit` `<number> (0 - 128)` ('default =' `0`)::
482
483 Limit of CPU usage.
484 +
485 NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.
486
487 `-cpuunits` `<integer> (0 - 500000)` ('default =' `1024`)::
488
489 CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to the weights of all the other running VMs.
490 +
491 NOTE: You can disable fair-scheduler configuration by setting this to 0.
492
493 `-description` `<string>` ::
494
495 Container description. Only used on the configuration web interface.
496
497 `-force` `<boolean>` ::
498
499 Allow to overwrite existing container.
500
501 `-hostname` `<string>` ::
502
503 Set a host name for the container.
504
505 `-ignore-unpack-errors` `<boolean>` ::
506
507 Ignore errors when extracting the template.
508
509 `-lock` `<backup | migrate | rollback | snapshot>` ::
510
511 Lock/unlock the VM.
512
513 `-memory` `<integer> (16 - N)` ('default =' `512`)::
514
515 Amount of RAM for the VM in MB.
516
517 `-mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
518
519 Use volume as container mount point.
520
521 `-nameserver` `<string>` ::
522
523 Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
524
525 `-net[n]` `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
526
527 Specifies network interfaces for the container.
528
529 `-onboot` `<boolean>` ('default =' `0`)::
530
531 Specifies whether a VM will be started during system bootup.
532
533 `-ostype` `<alpine | archlinux | centos | debian | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
534
535 OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used to skip and OS specific setup.
536
537 `-password` ::
538
539 Sets root password inside container.
540
541 `-pool` `<string>` ::
542
543 Add the VM to the specified pool.
544
545 `-protection` `<boolean>` ('default =' `0`)::
546
547 Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
548
549 `-rootfs` `[volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
550
551 Use volume as container root.
552
553 `-searchdomain` `<string>` ::
554
555 Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
556
557 `-ssh-public-keys` `<string>` ::
558
559 Setup public SSH keys (one key per line, OpenSSH format).
560
561 `-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
562
563 Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.
564
565 `-storage` `<string>` ('default =' `local`)::
566
567 Default Storage.
568
569 `-swap` `<integer> (0 - N)` ('default =' `512`)::
570
571 Amount of SWAP for the VM in MB.
572
573 `-template` `<boolean>` ('default =' `0`)::
574
575 Enable/disable Template.
576
577 `-tty` `<integer> (0 - 6)` ('default =' `2`)::
578
579 Specify the number of tty available to the container
580
581 `-unprivileged` `<boolean>` ('default =' `0`)::
582
583 Makes the container run as unprivileged user. (Should not be modified manually.)
584
585 `-unused[n]` `<string>` ::
586
587 Reference to unused volumes. This is used internally, and should not be modified manually.
588
589
590
591
592 *pct resume* `<vmid>`
593
594 Resume the container.
595
596 `<vmid>`: `<integer> (1 - N)` ::
597
598 The (unique) ID of the VM.
599
600
601
602
603 *pct rollback* `<vmid> <snapname>`
604
605 Rollback LXC state to specified snapshot.
606
607 `<vmid>`: `<integer> (1 - N)` ::
608
609 The (unique) ID of the VM.
610
611 `<snapname>`: `<string>` ::
612
613 The name of the snapshot.
614
615
616
617
618 *pct set* `<vmid>` `[OPTIONS]`
619
620 Set container options.
621
622 `<vmid>`: `<integer> (1 - N)` ::
623
624 The (unique) ID of the VM.
625
626 `-arch` `<amd64 | i386>` ('default =' `amd64`)::
627
628 OS architecture type.
629
630 `-cmode` `<console | shell | tty>` ('default =' `tty`)::
631
632 Console mode. By default, the console command tries to open a connection to one of the available tty devices. By setting cmode to 'console' it tries to attach to /dev/console instead. If you set cmode to 'shell', it simply invokes a shell inside the container (no login).
633
634 `-console` `<boolean>` ('default =' `1`)::
635
636 Attach a console device (/dev/console) to the container.
637
638 `-cores` `<integer> (1 - 128)` ::
639
640 The number of cores assigned to the container. A container can use all available cores by default.
641
642 `-cpulimit` `<number> (0 - 128)` ('default =' `0`)::
643
644 Limit of CPU usage.
645 +
646 NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.
647
648 `-cpuunits` `<integer> (0 - 500000)` ('default =' `1024`)::
649
650 CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to the weights of all the other running VMs.
651 +
652 NOTE: You can disable fair-scheduler configuration by setting this to 0.
653
654 `-delete` `<string>` ::
655
656 A list of settings you want to delete.
657
658 `-description` `<string>` ::
659
660 Container description. Only used on the configuration web interface.
661
662 `-digest` `<string>` ::
663
664 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
665
666 `-hostname` `<string>` ::
667
668 Set a host name for the container.
669
670 `-lock` `<backup | migrate | rollback | snapshot>` ::
671
672 Lock/unlock the VM.
673
674 `-memory` `<integer> (16 - N)` ('default =' `512`)::
675
676 Amount of RAM for the VM in MB.
677
678 `-mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
679
680 Use volume as container mount point.
681
682 `-nameserver` `<string>` ::
683
684 Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
685
686 `-net[n]` `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
687
688 Specifies network interfaces for the container.
689
690 `-onboot` `<boolean>` ('default =' `0`)::
691
692 Specifies whether a VM will be started during system bootup.
693
694 `-ostype` `<alpine | archlinux | centos | debian | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
695
696 OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used to skip and OS specific setup.
697
698 `-protection` `<boolean>` ('default =' `0`)::
699
700 Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
701
702 `-rootfs` `[volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
703
704 Use volume as container root.
705
706 `-searchdomain` `<string>` ::
707
708 Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
709
710 `-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
711
712 Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.
713
714 `-swap` `<integer> (0 - N)` ('default =' `512`)::
715
716 Amount of SWAP for the VM in MB.
717
718 `-template` `<boolean>` ('default =' `0`)::
719
720 Enable/disable Template.
721
722 `-tty` `<integer> (0 - 6)` ('default =' `2`)::
723
724 Specify the number of tty available to the container
725
726 `-unprivileged` `<boolean>` ('default =' `0`)::
727
728 Makes the container run as unprivileged user. (Should not be modified manually.)
729
730 `-unused[n]` `<string>` ::
731
732 Reference to unused volumes. This is used internally, and should not be modified manually.
733
734
735
736
737 *pct shutdown* `<vmid>` `[OPTIONS]`
738
739 Shutdown the container. This will trigger a clean shutdown of the
740 container, see lxc-stop(1) for details.
741
742 `<vmid>`: `<integer> (1 - N)` ::
743
744 The (unique) ID of the VM.
745
746 `-forceStop` `<boolean>` ('default =' `0`)::
747
748 Make sure the Container stops.
749
750 `-timeout` `<integer> (0 - N)` ('default =' `60`)::
751
752 Wait maximal timeout seconds.
753
754
755
756
757 *pct snapshot* `<vmid> <snapname>` `[OPTIONS]`
758
759 Snapshot a container.
760
761 `<vmid>`: `<integer> (1 - N)` ::
762
763 The (unique) ID of the VM.
764
765 `<snapname>`: `<string>` ::
766
767 The name of the snapshot.
768
769 `-description` `<string>` ::
770
771 A textual description or comment.
772
773
774
775
776 *pct start* `<vmid>` `[OPTIONS]`
777
778 Start the container.
779
780 `<vmid>`: `<integer> (1 - N)` ::
781
782 The (unique) ID of the VM.
783
784 `-skiplock` `<boolean>` ::
785
786 Ignore locks - only root is allowed to use this option.
787
788
789
790
791 *pct status* `<vmid>` `[OPTIONS]`
792
793 Show CT status.
794
795 `<vmid>`: `<integer> (1 - N)` ::
796
797 The (unique) ID of the VM.
798
799 `-verbose` `<boolean>` ::
800
801 Verbose output format
802
803
804
805
806 *pct stop* `<vmid>` `[OPTIONS]`
807
808 Stop the container. This will abruptly stop all processes running in the
809 container.
810
811 `<vmid>`: `<integer> (1 - N)` ::
812
813 The (unique) ID of the VM.
814
815 `-skiplock` `<boolean>` ::
816
817 Ignore locks - only root is allowed to use this option.
818
819
820
821 *pct suspend* `<vmid>`
822
823 Suspend the container.
824
825 `<vmid>`: `<integer> (1 - N)` ::
826
827 The (unique) ID of the VM.
828
829
830
831
832 *pct template* `<vmid> -experimental <boolean>` `[OPTIONS]`
833
834 Create a Template.
835
836 `<vmid>`: `<integer> (1 - N)` ::
837
838 The (unique) ID of the VM.
839
840 `-experimental` `<boolean>` ('default =' `0`)::
841
842 The template feature is experimental, set this flag if you know what you are doing.
843
844
845
846
847 *pct unlock* `<vmid>`
848
849 Unlock the VM.
850
851 `<vmid>`: `<integer> (1 - N)` ::
852
853 The (unique) ID of the VM.
854
855
856
857 *pct unmount* `<vmid>`
858
859 Unmount the container's filesystem.
860
861 `<vmid>`: `<integer> (1 - N)` ::
862
863 The (unique) ID of the VM.
864
865
866
867