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 `-restart` `<boolean>` ::
 356
 357 Use restart migration
 358
 359 `-timeout` `<integer>` ('default =' `180`)::
 360
 361 Timeout in seconds for shutdown for restart migration
 362
 363
 364
 365
 366 *pct mount* `<vmid>`
 367
 368 Mount the container's filesystem on the host. This will hold a lock on the
 369 container and is meant for emergency maintenance only as it will prevent
 370 further operations on the container other than start and stop.
 371
 372 `<vmid>`: `<integer> (1 - N)` ::
 373
 374 The (unique) ID of the VM.
 375
 376
 377
 378 *pct pull* `<vmid> <path> <destination>` `[OPTIONS]`
 379
 380 Copy a file from the container to the local system.
 381
 382 `<vmid>`: `<integer> (1 - N)` ::
 383
 384 The (unique) ID of the VM.
 385
 386 `<path>`: `<string>` ::
 387
 388 Path to a file inside the container to pull.
 389
 390 `<destination>`: `<string>` ::
 391
 392 Destination
 393
 394 `-group` `<string>` ::
 395
 396 Owner group name or id.
 397
 398 `-perms` `<string>` ::
 399
 400 File permissions to use (octal by default, prefix with '0x' for hexadecimal).
 401
 402 `-user` `<string>` ::
 403
 404 Owner user name or id.
 405
 406
 407
 408 *pct push* `<vmid> <file> <destination>` `[OPTIONS]`
 409
 410 Copy a local file to the container.
 411
 412 `<vmid>`: `<integer> (1 - N)` ::
 413
 414 The (unique) ID of the VM.
 415
 416 `<file>`: `<string>` ::
 417
 418 Path to a local file.
 419
 420 `<destination>`: `<string>` ::
 421
 422 Destination inside the container to write to.
 423
 424 `-group` `<string>` ::
 425
 426 Owner group name or id. When using a name it must exist inside the container.
 427
 428 `-perms` `<string>` ::
 429
 430 File permissions to use (octal by default, prefix with '0x' for hexadecimal).
 431
 432 `-user` `<string>` ::
 433
 434 Owner user name or id. When using a name it must exist inside the container.
 435
 436
 437
 438
 439 *pct resize* `<vmid> <disk> <size>` `[OPTIONS]`
 440
 441 Resize a container mount point.
 442
 443 `<vmid>`: `<integer> (1 - N)` ::
 444
 445 The (unique) ID of the VM.
 446
 447 `<disk>`: `<mp0 | mp1 | mp2 | mp3 | mp4 | mp5 | mp6 | mp7 | mp8 | mp9 | rootfs>` ::
 448
 449 The disk you want to resize.
 450
 451 `<size>`: `\+?\d+(\.\d+)?[KMGT]?` ::
 452
 453 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.
 454
 455 `-digest` `<string>` ::
 456
 457 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
 458
 459
 460
 461 *pct restore* `<vmid> <ostemplate>` `[OPTIONS]`
 462
 463 Create or restore a container.
 464
 465 `<vmid>`: `<integer> (1 - N)` ::
 466
 467 The (unique) ID of the VM.
 468
 469 `<ostemplate>`: `<string>` ::
 470
 471 The OS template or backup file.
 472
 473 `-arch` `<amd64 | i386>` ('default =' `amd64`)::
 474
 475 OS architecture type.
 476
 477 `-cmode` `<console | shell | tty>` ('default =' `tty`)::
 478
 479 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).
 480
 481 `-console` `<boolean>` ('default =' `1`)::
 482
 483 Attach a console device (/dev/console) to the container.
 484
 485 `-cores` `<integer> (1 - 128)` ::
 486
 487 The number of cores assigned to the container. A container can use all available cores by default.
 488
 489 `-cpulimit` `<number> (0 - 128)` ('default =' `0`)::
 490
 491 Limit of CPU usage.
 492 +
 493 NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.
 494
 495 `-cpuunits` `<integer> (0 - 500000)` ('default =' `1024`)::
 496
 497 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.
 498 +
 499 NOTE: You can disable fair-scheduler configuration by setting this to 0.
 500
 501 `-description` `<string>` ::
 502
 503 Container description. Only used on the configuration web interface.
 504
 505 `-force` `<boolean>` ::
 506
 507 Allow to overwrite existing container.
 508
 509 `-hostname` `<string>` ::
 510
 511 Set a host name for the container.
 512
 513 `-ignore-unpack-errors` `<boolean>` ::
 514
 515 Ignore errors when extracting the template.
 516
 517 `-lock` `<backup | migrate | rollback | snapshot>` ::
 518
 519 Lock/unlock the VM.
 520
 521 `-memory` `<integer> (16 - N)` ('default =' `512`)::
 522
 523 Amount of RAM for the VM in MB.
 524
 525 `-mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
 526
 527 Use volume as container mount point.
 528
 529 `-nameserver` `<string>` ::
 530
 531 Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
 532
 533 `-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>]` ::
 534
 535 Specifies network interfaces for the container.
 536
 537 `-onboot` `<boolean>` ('default =' `0`)::
 538
 539 Specifies whether a VM will be started during system bootup.
 540
 541 `-ostype` `<alpine | archlinux | centos | debian | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
 542
 543 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.
 544
 545 `-password` ::
 546
 547 Sets root password inside container.
 548
 549 `-pool` `<string>` ::
 550
 551 Add the VM to the specified pool.
 552
 553 `-protection` `<boolean>` ('default =' `0`)::
 554
 555 Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
 556
 557 `-rootfs` `[volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
 558
 559 Use volume as container root.
 560
 561 `-searchdomain` `<string>` ::
 562
 563 Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
 564
 565 `-ssh-public-keys` `<string>` ::
 566
 567 Setup public SSH keys (one key per line, OpenSSH format).
 568
 569 `-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
 570
 571 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.
 572
 573 `-storage` `<string>` ('default =' `local`)::
 574
 575 Default Storage.
 576
 577 `-swap` `<integer> (0 - N)` ('default =' `512`)::
 578
 579 Amount of SWAP for the VM in MB.
 580
 581 `-template` `<boolean>` ('default =' `0`)::
 582
 583 Enable/disable Template.
 584
 585 `-tty` `<integer> (0 - 6)` ('default =' `2`)::
 586
 587 Specify the number of tty available to the container
 588
 589 `-unprivileged` `<boolean>` ('default =' `0`)::
 590
 591 Makes the container run as unprivileged user. (Should not be modified manually.)
 592
 593 `-unused[n]` `<string>` ::
 594
 595 Reference to unused volumes. This is used internally, and should not be modified manually.
 596
 597
 598
 599
 600 *pct resume* `<vmid>`
 601
 602 Resume the container.
 603
 604 `<vmid>`: `<integer> (1 - N)` ::
 605
 606 The (unique) ID of the VM.
 607
 608
 609
 610
 611 *pct rollback* `<vmid> <snapname>`
 612
 613 Rollback LXC state to specified snapshot.
 614
 615 `<vmid>`: `<integer> (1 - N)` ::
 616
 617 The (unique) ID of the VM.
 618
 619 `<snapname>`: `<string>` ::
 620
 621 The name of the snapshot.
 622
 623
 624
 625
 626 *pct set* `<vmid>` `[OPTIONS]`
 627
 628 Set container options.
 629
 630 `<vmid>`: `<integer> (1 - N)` ::
 631
 632 The (unique) ID of the VM.
 633
 634 `-arch` `<amd64 | i386>` ('default =' `amd64`)::
 635
 636 OS architecture type.
 637
 638 `-cmode` `<console | shell | tty>` ('default =' `tty`)::
 639
 640 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).
 641
 642 `-console` `<boolean>` ('default =' `1`)::
 643
 644 Attach a console device (/dev/console) to the container.
 645
 646 `-cores` `<integer> (1 - 128)` ::
 647
 648 The number of cores assigned to the container. A container can use all available cores by default.
 649
 650 `-cpulimit` `<number> (0 - 128)` ('default =' `0`)::
 651
 652 Limit of CPU usage.
 653 +
 654 NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.
 655
 656 `-cpuunits` `<integer> (0 - 500000)` ('default =' `1024`)::
 657
 658 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.
 659 +
 660 NOTE: You can disable fair-scheduler configuration by setting this to 0.
 661
 662 `-delete` `<string>` ::
 663
 664 A list of settings you want to delete.
 665
 666 `-description` `<string>` ::
 667
 668 Container description. Only used on the configuration web interface.
 669
 670 `-digest` `<string>` ::
 671
 672 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
 673
 674 `-hostname` `<string>` ::
 675
 676 Set a host name for the container.
 677
 678 `-lock` `<backup | migrate | rollback | snapshot>` ::
 679
 680 Lock/unlock the VM.
 681
 682 `-memory` `<integer> (16 - N)` ('default =' `512`)::
 683
 684 Amount of RAM for the VM in MB.
 685
 686 `-mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
 687
 688 Use volume as container mount point.
 689
 690 `-nameserver` `<string>` ::
 691
 692 Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
 693
 694 `-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>]` ::
 695
 696 Specifies network interfaces for the container.
 697
 698 `-onboot` `<boolean>` ('default =' `0`)::
 699
 700 Specifies whether a VM will be started during system bootup.
 701
 702 `-ostype` `<alpine | archlinux | centos | debian | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
 703
 704 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.
 705
 706 `-protection` `<boolean>` ('default =' `0`)::
 707
 708 Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
 709
 710 `-rootfs` `[volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
 711
 712 Use volume as container root.
 713
 714 `-searchdomain` `<string>` ::
 715
 716 Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
 717
 718 `-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
 719
 720 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.
 721
 722 `-swap` `<integer> (0 - N)` ('default =' `512`)::
 723
 724 Amount of SWAP for the VM in MB.
 725
 726 `-template` `<boolean>` ('default =' `0`)::
 727
 728 Enable/disable Template.
 729
 730 `-tty` `<integer> (0 - 6)` ('default =' `2`)::
 731
 732 Specify the number of tty available to the container
 733
 734 `-unprivileged` `<boolean>` ('default =' `0`)::
 735
 736 Makes the container run as unprivileged user. (Should not be modified manually.)
 737
 738 `-unused[n]` `<string>` ::
 739
 740 Reference to unused volumes. This is used internally, and should not be modified manually.
 741
 742
 743
 744
 745 *pct shutdown* `<vmid>` `[OPTIONS]`
 746
 747 Shutdown the container. This will trigger a clean shutdown of the
 748 container, see lxc-stop(1) for details.
 749
 750 `<vmid>`: `<integer> (1 - N)` ::
 751
 752 The (unique) ID of the VM.
 753
 754 `-forceStop` `<boolean>` ('default =' `0`)::
 755
 756 Make sure the Container stops.
 757
 758 `-timeout` `<integer> (0 - N)` ('default =' `60`)::
 759
 760 Wait maximal timeout seconds.
 761
 762
 763
 764
 765 *pct snapshot* `<vmid> <snapname>` `[OPTIONS]`
 766
 767 Snapshot a container.
 768
 769 `<vmid>`: `<integer> (1 - N)` ::
 770
 771 The (unique) ID of the VM.
 772
 773 `<snapname>`: `<string>` ::
 774
 775 The name of the snapshot.
 776
 777 `-description` `<string>` ::
 778
 779 A textual description or comment.
 780
 781
 782
 783
 784 *pct start* `<vmid>` `[OPTIONS]`
 785
 786 Start the container.
 787
 788 `<vmid>`: `<integer> (1 - N)` ::
 789
 790 The (unique) ID of the VM.
 791
 792 `-skiplock` `<boolean>` ::
 793
 794 Ignore locks - only root is allowed to use this option.
 795
 796
 797
 798
 799 *pct status* `<vmid>` `[OPTIONS]`
 800
 801 Show CT status.
 802
 803 `<vmid>`: `<integer> (1 - N)` ::
 804
 805 The (unique) ID of the VM.
 806
 807 `-verbose` `<boolean>` ::
 808
 809 Verbose output format
 810
 811
 812
 813
 814 *pct stop* `<vmid>` `[OPTIONS]`
 815
 816 Stop the container. This will abruptly stop all processes running in the
 817 container.
 818
 819 `<vmid>`: `<integer> (1 - N)` ::
 820
 821 The (unique) ID of the VM.
 822
 823 `-skiplock` `<boolean>` ::
 824
 825 Ignore locks - only root is allowed to use this option.
 826
 827
 828
 829 *pct suspend* `<vmid>`
 830
 831 Suspend the container.
 832
 833 `<vmid>`: `<integer> (1 - N)` ::
 834
 835 The (unique) ID of the VM.
 836
 837
 838
 839
 840 *pct template* `<vmid> -experimental <boolean>` `[OPTIONS]`
 841
 842 Create a Template.
 843
 844 `<vmid>`: `<integer> (1 - N)` ::
 845
 846 The (unique) ID of the VM.
 847
 848 `-experimental` `<boolean>` ('default =' `0`)::
 849
 850 The template feature is experimental, set this flag if you know what you are doing.
 851
 852
 853
 854
 855 *pct unlock* `<vmid>`
 856
 857 Unlock the VM.
 858
 859 `<vmid>`: `<integer> (1 - N)` ::
 860
 861 The (unique) ID of the VM.
 862
 863
 864
 865 *pct unmount* `<vmid>`
 866
 867 Unmount the container's filesystem.
 868
 869 `<vmid>`: `<integer> (1 - N)` ::
 870
 871 The (unique) ID of the VM.
 872
 873
 874
 875