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