pct.1-synopsis.adoc

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