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