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