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 `--bwlimit` `<number> (0 - N)` ('default =' `clone limit from datacenter or storage config`)::
  16
  17 Override I/O bandwidth limit (in KiB/s).
  18
  19 `--description` `<string>` ::
  20
  21 Description for the new CT.
  22
  23 `--full` `<boolean>` ::
  24
  25 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.
  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 `--target` `<string>` ::
  44
  45 Target node. Only allowed if the original VM is on shared storage.
  46
  47 *pct config* `<vmid>` `[OPTIONS]`
  48
  49 Get container configuration.
  50
  51 `<vmid>`: `<integer> (1 - N)` ::
  52
  53 The (unique) ID of the VM.
  54
  55 `--current` `<boolean>` ('default =' `0`)::
  56
  57 Get current values (instead of pending values).
  58
  59 `--snapshot` `<string>` ::
  60
  61 Fetch config values from given snapshot.
  62
  63 *pct console* `<vmid>` `[OPTIONS]`
  64
  65 Launch a console for the specified container.
  66
  67 `<vmid>`: `<integer> (1 - N)` ::
  68
  69 The (unique) ID of the VM.
  70
  71 `--escape` `\^?[a-z]` ('default =' `^a`)::
  72
  73 Escape sequence prefix. For example to use <Ctrl+b q> as the escape sequence pass '^b'.
  74
  75 *pct cpusets*
  76
  77 Print the list of assigned CPU sets.
  78
  79 *pct create* `<vmid> <ostemplate>` `[OPTIONS]`
  80
  81 Create or restore a container.
  82
  83 `<vmid>`: `<integer> (1 - N)` ::
  84
  85 The (unique) ID of the VM.
  86
  87 `<ostemplate>`: `<string>` ::
  88
  89 The OS template or backup file.
  90
  91 `--arch` `<amd64 | arm64 | armhf | i386>` ('default =' `amd64`)::
  92
  93 OS architecture type.
  94
  95 `--bwlimit` `<number> (0 - N)` ('default =' `restore limit from datacenter or storage config`)::
  96
  97 Override I/O bandwidth limit (in KiB/s).
  98
  99 `--cmode` `<console | shell | tty>` ('default =' `tty`)::
 100
 101 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).
 102
 103 `--console` `<boolean>` ('default =' `1`)::
 104
 105 Attach a console device (/dev/console) to the container.
 106
 107 `--cores` `<integer> (1 - 8192)` ::
 108
 109 The number of cores assigned to the container. A container can use all available cores by default.
 110
 111 `--cpulimit` `<number> (0 - 8192)` ('default =' `0`)::
 112
 113 Limit of CPU usage.
 114 +
 115 NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.
 116
 117 `--cpuunits` `<integer> (0 - 500000)` ('default =' `1024`)::
 118
 119 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.
 120 +
 121 NOTE: You can disable fair-scheduler configuration by setting this to 0.
 122
 123 `--debug` `<boolean>` ('default =' `0`)::
 124
 125 Try to be more verbose. For now this only enables debug log-level on start.
 126
 127 `--description` `<string>` ::
 128
 129 Container description. Only used on the configuration web interface.
 130
 131 `--features` `[force_rw_sys=<1|0>] [,fuse=<1|0>] [,keyctl=<1|0>] [,mknod=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
 132
 133 Allow containers access to advanced features.
 134
 135 `--force` `<boolean>` ::
 136
 137 Allow to overwrite existing container.
 138
 139 `--hookscript` `<string>` ::
 140
 141 Script that will be exectued during various steps in the containers lifetime.
 142
 143 `--hostname` `<string>` ::
 144
 145 Set a host name for the container.
 146
 147 `--ignore-unpack-errors` `<boolean>` ::
 148
 149 Ignore errors when extracting the template.
 150
 151 `--lock` `<backup | create | destroyed | disk | fstrim | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
 152
 153 Lock/unlock the VM.
 154
 155 `--memory` `<integer> (16 - N)` ('default =' `512`)::
 156
 157 Amount of RAM for the VM in MB.
 158
 159 `--mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
 160
 161 Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
 162
 163 `--nameserver` `<string>` ::
 164
 165 Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
 166
 167 `--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>]` ::
 168
 169 Specifies network interfaces for the container.
 170
 171 `--onboot` `<boolean>` ('default =' `0`)::
 172
 173 Specifies whether a VM will be started during system bootup.
 174
 175 `--ostype` `<alpine | archlinux | centos | debian | devuan | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
 176
 177 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.
 178
 179 `--password` `<password>` ::
 180
 181 Sets root password inside container.
 182
 183 `--pool` `<string>` ::
 184
 185 Add the VM to the specified pool.
 186
 187 `--protection` `<boolean>` ('default =' `0`)::
 188
 189 Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
 190
 191 `--restore` `<boolean>` ::
 192
 193 Mark this as restore task.
 194
 195 `--rootfs` `[volume=]<volume> [,acl=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
 196
 197 Use volume as container root.
 198
 199 `--searchdomain` `<string>` ::
 200
 201 Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
 202
 203 `--ssh-public-keys` `<filepath>` ::
 204
 205 Setup public SSH keys (one key per line, OpenSSH format).
 206
 207 `--start` `<boolean>` ('default =' `0`)::
 208
 209 Start the CT after its creation finished successfully.
 210
 211 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
 212
 213 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.
 214
 215 `--storage` `<string>` ('default =' `local`)::
 216
 217 Default Storage.
 218
 219 `--swap` `<integer> (0 - N)` ('default =' `512`)::
 220
 221 Amount of SWAP for the VM in MB.
 222
 223 `--tags` `<string>` ::
 224
 225 Tags of the Container. This is only meta information.
 226
 227 `--template` `<boolean>` ('default =' `0`)::
 228
 229 Enable/disable Template.
 230
 231 `--timezone` `<string>` ::
 232
 233 Time zone to use in the container. If option isn't set, then nothing will be done. Can be set to 'host' to match the host time zone, or an arbitrary time zone option from /usr/share/zoneinfo/zone.tab
 234
 235 `--tty` `<integer> (0 - 6)` ('default =' `2`)::
 236
 237 Specify the number of tty available to the container
 238
 239 `--unique` `<boolean>` ::
 240
 241 Assign a unique random ethernet address.
 242 +
 243 NOTE: Requires option(s): `restore`
 244
 245 `--unprivileged` `<boolean>` ('default =' `0`)::
 246
 247 Makes the container run as unprivileged user. (Should not be modified manually.)
 248
 249 `--unused[n]` `[volume=]<volume>` ::
 250
 251 Reference to unused volumes. This is used internally, and should not be modified manually.
 252
 253 *pct delsnapshot* `<vmid> <snapname>` `[OPTIONS]`
 254
 255 Delete a LXC snapshot.
 256
 257 `<vmid>`: `<integer> (1 - N)` ::
 258
 259 The (unique) ID of the VM.
 260
 261 `<snapname>`: `<string>` ::
 262
 263 The name of the snapshot.
 264
 265 `--force` `<boolean>` ::
 266
 267 For removal from config file, even if removing disk snapshots fails.
 268
 269 *pct destroy* `<vmid>` `[OPTIONS]`
 270
 271 Destroy the container (also delete all uses files).
 272
 273 `<vmid>`: `<integer> (1 - N)` ::
 274
 275 The (unique) ID of the VM.
 276
 277 `--destroy-unreferenced-disks` `<boolean>` ::
 278
 279 If set, destroy additionally all disks with the VMID from all enabled storages which are not referenced in the config.
 280
 281 `--force` `<boolean>` ('default =' `0`)::
 282
 283 Force destroy, even if running.
 284
 285 `--purge` `<boolean>` ('default =' `0`)::
 286
 287 Remove container from all related configurations. For example, backup jobs, replication jobs or HA. Related ACLs and Firewall entries will *always* be removed.
 288
 289 *pct df* `<vmid>`
 290
 291 Get the container's current disk usage.
 292
 293 `<vmid>`: `<integer> (1 - N)` ::
 294
 295 The (unique) ID of the VM.
 296
 297 *pct enter* `<vmid>`
 298
 299 Launch a shell for the specified container.
 300
 301 `<vmid>`: `<integer> (1 - N)` ::
 302
 303 The (unique) ID of the VM.
 304
 305 *pct exec* `<vmid> [<extra-args>]`
 306
 307 Launch a command inside the specified container.
 308
 309 `<vmid>`: `<integer> (1 - N)` ::
 310
 311 The (unique) ID of the VM.
 312
 313 `<extra-args>`: `<array>` ::
 314
 315 Extra arguments as array
 316
 317 *pct fsck* `<vmid>` `[OPTIONS]`
 318
 319 Run a filesystem check (fsck) on a container volume.
 320
 321 `<vmid>`: `<integer> (1 - N)` ::
 322
 323 The (unique) ID of the VM.
 324
 325 `--device` `<mp0 | mp1 | mp10 | mp100 | mp101 | mp102 | mp103 | mp104 | mp105 | mp106 | mp107 | mp108 | mp109 | mp11 | mp110 | mp111 | mp112 | mp113 | mp114 | mp115 | mp116 | mp117 | mp118 | mp119 | mp12 | mp120 | mp121 | mp122 | mp123 | mp124 | mp125 | mp126 | mp127 | mp128 | mp129 | mp13 | mp130 | mp131 | mp132 | mp133 | mp134 | mp135 | mp136 | mp137 | mp138 | mp139 | mp14 | mp140 | mp141 | mp142 | mp143 | mp144 | mp145 | mp146 | mp147 | mp148 | mp149 | mp15 | mp150 | mp151 | mp152 | mp153 | mp154 | mp155 | mp156 | mp157 | mp158 | mp159 | mp16 | mp160 | mp161 | mp162 | mp163 | mp164 | mp165 | mp166 | mp167 | mp168 | mp169 | mp17 | mp170 | mp171 | mp172 | mp173 | mp174 | mp175 | mp176 | mp177 | mp178 | mp179 | mp18 | mp180 | mp181 | mp182 | mp183 | mp184 | mp185 | mp186 | mp187 | mp188 | mp189 | mp19 | mp190 | mp191 | mp192 | mp193 | mp194 | mp195 | mp196 | mp197 | mp198 | mp199 | mp2 | mp20 | mp200 | mp201 | mp202 | mp203 | mp204 | mp205 | mp206 | mp207 | mp208 | mp209 | mp21 | mp210 | mp211 | mp212 | mp213 | mp214 | mp215 | mp216 | mp217 | mp218 | mp219 | mp22 | mp220 | mp221 | mp222 | mp223 | mp224 | mp225 | mp226 | mp227 | mp228 | mp229 | mp23 | mp230 | mp231 | mp232 | mp233 | mp234 | mp235 | mp236 | mp237 | mp238 | mp239 | mp24 | mp240 | mp241 | mp242 | mp243 | mp244 | mp245 | mp246 | mp247 | mp248 | mp249 | mp25 | mp250 | mp251 | mp252 | mp253 | mp254 | mp255 | mp26 | mp27 | mp28 | mp29 | mp3 | mp30 | mp31 | mp32 | mp33 | mp34 | mp35 | mp36 | mp37 | mp38 | mp39 | mp4 | mp40 | mp41 | mp42 | mp43 | mp44 | mp45 | mp46 | mp47 | mp48 | mp49 | mp5 | mp50 | mp51 | mp52 | mp53 | mp54 | mp55 | mp56 | mp57 | mp58 | mp59 | mp6 | mp60 | mp61 | mp62 | mp63 | mp64 | mp65 | mp66 | mp67 | mp68 | mp69 | mp7 | mp70 | mp71 | mp72 | mp73 | mp74 | mp75 | mp76 | mp77 | mp78 | mp79 | mp8 | mp80 | mp81 | mp82 | mp83 | mp84 | mp85 | mp86 | mp87 | mp88 | mp89 | mp9 | mp90 | mp91 | mp92 | mp93 | mp94 | mp95 | mp96 | mp97 | mp98 | mp99 | rootfs>` ::
 326
 327 A volume on which to run the filesystem check
 328
 329 `--force` `<boolean>` ('default =' `0`)::
 330
 331 Force checking, even if the filesystem seems clean
 332
 333 *pct fstrim* `<vmid>` `[OPTIONS]`
 334
 335 Run fstrim on a chosen CT and its mountpoints.
 336
 337 `<vmid>`: `<integer> (1 - N)` ::
 338
 339 The (unique) ID of the VM.
 340
 341 `--ignore-mountpoints` `<boolean>` ::
 342
 343 Skip all mountpoints, only do fstrim on the container root.
 344
 345 *pct help* `[OPTIONS]`
 346
 347 Get help about specified command.
 348
 349 `--extra-args` `<array>` ::
 350
 351 Shows help for a specific command
 352
 353 `--verbose` `<boolean>` ::
 354
 355 Verbose output format.
 356
 357 *pct list*
 358
 359 LXC container index (per node).
 360
 361 *pct listsnapshot* `<vmid>`
 362
 363 List all snapshots.
 364
 365 `<vmid>`: `<integer> (1 - N)` ::
 366
 367 The (unique) ID of the VM.
 368
 369 *pct migrate* `<vmid> <target>` `[OPTIONS]`
 370
 371 Migrate the container to another node. Creates a new migration task.
 372
 373 `<vmid>`: `<integer> (1 - N)` ::
 374
 375 The (unique) ID of the VM.
 376
 377 `<target>`: `<string>` ::
 378
 379 Target node.
 380
 381 `--bwlimit` `<number> (0 - N)` ('default =' `migrate limit from datacenter or storage config`)::
 382
 383 Override I/O bandwidth limit (in KiB/s).
 384
 385 `--force` `<boolean>` ::
 386
 387 Force migration despite local bind / device mounts. NOTE: deprecated, use 'shared' property of mount point instead.
 388
 389 `--online` `<boolean>` ::
 390
 391 Use online/live migration.
 392
 393 `--restart` `<boolean>` ::
 394
 395 Use restart migration
 396
 397 `--timeout` `<integer>` ('default =' `180`)::
 398
 399 Timeout in seconds for shutdown for restart migration
 400
 401 *pct mount* `<vmid>`
 402
 403 Mount the container's filesystem on the host. This will hold a lock on the
 404 container and is meant for emergency maintenance only as it will prevent
 405 further operations on the container other than start and stop.
 406
 407 `<vmid>`: `<integer> (1 - N)` ::
 408
 409 The (unique) ID of the VM.
 410
 411 *pct move_volume* `<vmid> <volume> <storage>` `[OPTIONS]`
 412
 413 Move a rootfs-/mp-volume to a different storage
 414
 415 `<vmid>`: `<integer> (1 - N)` ::
 416
 417 The (unique) ID of the VM.
 418
 419 `<volume>`: `<mp0 | mp1 | mp10 | mp100 | mp101 | mp102 | mp103 | mp104 | mp105 | mp106 | mp107 | mp108 | mp109 | mp11 | mp110 | mp111 | mp112 | mp113 | mp114 | mp115 | mp116 | mp117 | mp118 | mp119 | mp12 | mp120 | mp121 | mp122 | mp123 | mp124 | mp125 | mp126 | mp127 | mp128 | mp129 | mp13 | mp130 | mp131 | mp132 | mp133 | mp134 | mp135 | mp136 | mp137 | mp138 | mp139 | mp14 | mp140 | mp141 | mp142 | mp143 | mp144 | mp145 | mp146 | mp147 | mp148 | mp149 | mp15 | mp150 | mp151 | mp152 | mp153 | mp154 | mp155 | mp156 | mp157 | mp158 | mp159 | mp16 | mp160 | mp161 | mp162 | mp163 | mp164 | mp165 | mp166 | mp167 | mp168 | mp169 | mp17 | mp170 | mp171 | mp172 | mp173 | mp174 | mp175 | mp176 | mp177 | mp178 | mp179 | mp18 | mp180 | mp181 | mp182 | mp183 | mp184 | mp185 | mp186 | mp187 | mp188 | mp189 | mp19 | mp190 | mp191 | mp192 | mp193 | mp194 | mp195 | mp196 | mp197 | mp198 | mp199 | mp2 | mp20 | mp200 | mp201 | mp202 | mp203 | mp204 | mp205 | mp206 | mp207 | mp208 | mp209 | mp21 | mp210 | mp211 | mp212 | mp213 | mp214 | mp215 | mp216 | mp217 | mp218 | mp219 | mp22 | mp220 | mp221 | mp222 | mp223 | mp224 | mp225 | mp226 | mp227 | mp228 | mp229 | mp23 | mp230 | mp231 | mp232 | mp233 | mp234 | mp235 | mp236 | mp237 | mp238 | mp239 | mp24 | mp240 | mp241 | mp242 | mp243 | mp244 | mp245 | mp246 | mp247 | mp248 | mp249 | mp25 | mp250 | mp251 | mp252 | mp253 | mp254 | mp255 | mp26 | mp27 | mp28 | mp29 | mp3 | mp30 | mp31 | mp32 | mp33 | mp34 | mp35 | mp36 | mp37 | mp38 | mp39 | mp4 | mp40 | mp41 | mp42 | mp43 | mp44 | mp45 | mp46 | mp47 | mp48 | mp49 | mp5 | mp50 | mp51 | mp52 | mp53 | mp54 | mp55 | mp56 | mp57 | mp58 | mp59 | mp6 | mp60 | mp61 | mp62 | mp63 | mp64 | mp65 | mp66 | mp67 | mp68 | mp69 | mp7 | mp70 | mp71 | mp72 | mp73 | mp74 | mp75 | mp76 | mp77 | mp78 | mp79 | mp8 | mp80 | mp81 | mp82 | mp83 | mp84 | mp85 | mp86 | mp87 | mp88 | mp89 | mp9 | mp90 | mp91 | mp92 | mp93 | mp94 | mp95 | mp96 | mp97 | mp98 | mp99 | rootfs>` ::
 420
 421 Volume which will be moved.
 422
 423 `<storage>`: `<string>` ::
 424
 425 Target Storage.
 426
 427 `--bwlimit` `<number> (0 - N)` ('default =' `clone limit from datacenter or storage config`)::
 428
 429 Override I/O bandwidth limit (in KiB/s).
 430
 431 `--delete` `<boolean>` ('default =' `0`)::
 432
 433 Delete the original volume after successful copy. By default the original is kept as an unused volume entry.
 434
 435 `--digest` `<string>` ::
 436
 437 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
 438
 439 *pct pending* `<vmid>`
 440
 441 Get container configuration, including pending changes.
 442
 443 `<vmid>`: `<integer> (1 - N)` ::
 444
 445 The (unique) ID of the VM.
 446
 447 *pct pull* `<vmid> <path> <destination>` `[OPTIONS]`
 448
 449 Copy a file from the container to the local system.
 450
 451 `<vmid>`: `<integer> (1 - N)` ::
 452
 453 The (unique) ID of the VM.
 454
 455 `<path>`: `<string>` ::
 456
 457 Path to a file inside the container to pull.
 458
 459 `<destination>`: `<string>` ::
 460
 461 Destination
 462
 463 `--group` `<string>` ::
 464
 465 Owner group name or id.
 466
 467 `--perms` `<string>` ::
 468
 469 File permissions to use (octal by default, prefix with '0x' for hexadecimal).
 470
 471 `--user` `<string>` ::
 472
 473 Owner user name or id.
 474
 475 *pct push* `<vmid> <file> <destination>` `[OPTIONS]`
 476
 477 Copy a local file to the container.
 478
 479 `<vmid>`: `<integer> (1 - N)` ::
 480
 481 The (unique) ID of the VM.
 482
 483 `<file>`: `<string>` ::
 484
 485 Path to a local file.
 486
 487 `<destination>`: `<string>` ::
 488
 489 Destination inside the container to write to.
 490
 491 `--group` `<string>` ::
 492
 493 Owner group name or id. When using a name it must exist inside the container.
 494
 495 `--perms` `<string>` ::
 496
 497 File permissions to use (octal by default, prefix with '0x' for hexadecimal).
 498
 499 `--user` `<string>` ::
 500
 501 Owner user name or id. When using a name it must exist inside the container.
 502
 503 *pct reboot* `<vmid>` `[OPTIONS]`
 504
 505 Reboot the container by shutting it down, and starting it again. Applies
 506 pending changes.
 507
 508 `<vmid>`: `<integer> (1 - N)` ::
 509
 510 The (unique) ID of the VM.
 511
 512 `--timeout` `<integer> (0 - N)` ::
 513
 514 Wait maximal timeout seconds for the shutdown.
 515
 516 *pct rescan* `[OPTIONS]`
 517
 518 Rescan all storages and update disk sizes and unused disk images.
 519
 520 `--dryrun` `<boolean>` ('default =' `0`)::
 521
 522 Do not actually write changes out to conifg.
 523
 524 `--vmid` `<integer> (1 - N)` ::
 525
 526 The (unique) ID of the VM.
 527
 528 *pct resize* `<vmid> <disk> <size>` `[OPTIONS]`
 529
 530 Resize a container mount point.
 531
 532 `<vmid>`: `<integer> (1 - N)` ::
 533
 534 The (unique) ID of the VM.
 535
 536 `<disk>`: `<mp0 | mp1 | mp10 | mp100 | mp101 | mp102 | mp103 | mp104 | mp105 | mp106 | mp107 | mp108 | mp109 | mp11 | mp110 | mp111 | mp112 | mp113 | mp114 | mp115 | mp116 | mp117 | mp118 | mp119 | mp12 | mp120 | mp121 | mp122 | mp123 | mp124 | mp125 | mp126 | mp127 | mp128 | mp129 | mp13 | mp130 | mp131 | mp132 | mp133 | mp134 | mp135 | mp136 | mp137 | mp138 | mp139 | mp14 | mp140 | mp141 | mp142 | mp143 | mp144 | mp145 | mp146 | mp147 | mp148 | mp149 | mp15 | mp150 | mp151 | mp152 | mp153 | mp154 | mp155 | mp156 | mp157 | mp158 | mp159 | mp16 | mp160 | mp161 | mp162 | mp163 | mp164 | mp165 | mp166 | mp167 | mp168 | mp169 | mp17 | mp170 | mp171 | mp172 | mp173 | mp174 | mp175 | mp176 | mp177 | mp178 | mp179 | mp18 | mp180 | mp181 | mp182 | mp183 | mp184 | mp185 | mp186 | mp187 | mp188 | mp189 | mp19 | mp190 | mp191 | mp192 | mp193 | mp194 | mp195 | mp196 | mp197 | mp198 | mp199 | mp2 | mp20 | mp200 | mp201 | mp202 | mp203 | mp204 | mp205 | mp206 | mp207 | mp208 | mp209 | mp21 | mp210 | mp211 | mp212 | mp213 | mp214 | mp215 | mp216 | mp217 | mp218 | mp219 | mp22 | mp220 | mp221 | mp222 | mp223 | mp224 | mp225 | mp226 | mp227 | mp228 | mp229 | mp23 | mp230 | mp231 | mp232 | mp233 | mp234 | mp235 | mp236 | mp237 | mp238 | mp239 | mp24 | mp240 | mp241 | mp242 | mp243 | mp244 | mp245 | mp246 | mp247 | mp248 | mp249 | mp25 | mp250 | mp251 | mp252 | mp253 | mp254 | mp255 | mp26 | mp27 | mp28 | mp29 | mp3 | mp30 | mp31 | mp32 | mp33 | mp34 | mp35 | mp36 | mp37 | mp38 | mp39 | mp4 | mp40 | mp41 | mp42 | mp43 | mp44 | mp45 | mp46 | mp47 | mp48 | mp49 | mp5 | mp50 | mp51 | mp52 | mp53 | mp54 | mp55 | mp56 | mp57 | mp58 | mp59 | mp6 | mp60 | mp61 | mp62 | mp63 | mp64 | mp65 | mp66 | mp67 | mp68 | mp69 | mp7 | mp70 | mp71 | mp72 | mp73 | mp74 | mp75 | mp76 | mp77 | mp78 | mp79 | mp8 | mp80 | mp81 | mp82 | mp83 | mp84 | mp85 | mp86 | mp87 | mp88 | mp89 | mp9 | mp90 | mp91 | mp92 | mp93 | mp94 | mp95 | mp96 | mp97 | mp98 | mp99 | rootfs>` ::
 537
 538 The disk you want to resize.
 539
 540 `<size>`: `\+?\d+(\.\d+)?[KMGT]?` ::
 541
 542 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.
 543
 544 `--digest` `<string>` ::
 545
 546 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
 547
 548 *pct restore* `<vmid> <ostemplate>` `[OPTIONS]`
 549
 550 Create or restore a container.
 551
 552 `<vmid>`: `<integer> (1 - N)` ::
 553
 554 The (unique) ID of the VM.
 555
 556 `<ostemplate>`: `<string>` ::
 557
 558 The OS template or backup file.
 559
 560 `--arch` `<amd64 | arm64 | armhf | i386>` ('default =' `amd64`)::
 561
 562 OS architecture type.
 563
 564 `--bwlimit` `<number> (0 - N)` ('default =' `restore limit from datacenter or storage config`)::
 565
 566 Override I/O bandwidth limit (in KiB/s).
 567
 568 `--cmode` `<console | shell | tty>` ('default =' `tty`)::
 569
 570 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).
 571
 572 `--console` `<boolean>` ('default =' `1`)::
 573
 574 Attach a console device (/dev/console) to the container.
 575
 576 `--cores` `<integer> (1 - 8192)` ::
 577
 578 The number of cores assigned to the container. A container can use all available cores by default.
 579
 580 `--cpulimit` `<number> (0 - 8192)` ('default =' `0`)::
 581
 582 Limit of CPU usage.
 583 +
 584 NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.
 585
 586 `--cpuunits` `<integer> (0 - 500000)` ('default =' `1024`)::
 587
 588 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.
 589 +
 590 NOTE: You can disable fair-scheduler configuration by setting this to 0.
 591
 592 `--debug` `<boolean>` ('default =' `0`)::
 593
 594 Try to be more verbose. For now this only enables debug log-level on start.
 595
 596 `--description` `<string>` ::
 597
 598 Container description. Only used on the configuration web interface.
 599
 600 `--features` `[force_rw_sys=<1|0>] [,fuse=<1|0>] [,keyctl=<1|0>] [,mknod=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
 601
 602 Allow containers access to advanced features.
 603
 604 `--force` `<boolean>` ::
 605
 606 Allow to overwrite existing container.
 607
 608 `--hookscript` `<string>` ::
 609
 610 Script that will be exectued during various steps in the containers lifetime.
 611
 612 `--hostname` `<string>` ::
 613
 614 Set a host name for the container.
 615
 616 `--ignore-unpack-errors` `<boolean>` ::
 617
 618 Ignore errors when extracting the template.
 619
 620 `--lock` `<backup | create | destroyed | disk | fstrim | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
 621
 622 Lock/unlock the VM.
 623
 624 `--memory` `<integer> (16 - N)` ('default =' `512`)::
 625
 626 Amount of RAM for the VM in MB.
 627
 628 `--mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
 629
 630 Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
 631
 632 `--nameserver` `<string>` ::
 633
 634 Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
 635
 636 `--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>]` ::
 637
 638 Specifies network interfaces for the container.
 639
 640 `--onboot` `<boolean>` ('default =' `0`)::
 641
 642 Specifies whether a VM will be started during system bootup.
 643
 644 `--ostype` `<alpine | archlinux | centos | debian | devuan | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
 645
 646 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.
 647
 648 `--password` `<password>` ::
 649
 650 Sets root password inside container.
 651
 652 `--pool` `<string>` ::
 653
 654 Add the VM to the specified pool.
 655
 656 `--protection` `<boolean>` ('default =' `0`)::
 657
 658 Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
 659
 660 `--rootfs` `[volume=]<volume> [,acl=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
 661
 662 Use volume as container root.
 663
 664 `--searchdomain` `<string>` ::
 665
 666 Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
 667
 668 `--ssh-public-keys` `<filepath>` ::
 669
 670 Setup public SSH keys (one key per line, OpenSSH format).
 671
 672 `--start` `<boolean>` ('default =' `0`)::
 673
 674 Start the CT after its creation finished successfully.
 675
 676 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
 677
 678 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.
 679
 680 `--storage` `<string>` ('default =' `local`)::
 681
 682 Default Storage.
 683
 684 `--swap` `<integer> (0 - N)` ('default =' `512`)::
 685
 686 Amount of SWAP for the VM in MB.
 687
 688 `--tags` `<string>` ::
 689
 690 Tags of the Container. This is only meta information.
 691
 692 `--template` `<boolean>` ('default =' `0`)::
 693
 694 Enable/disable Template.
 695
 696 `--timezone` `<string>` ::
 697
 698 Time zone to use in the container. If option isn't set, then nothing will be done. Can be set to 'host' to match the host time zone, or an arbitrary time zone option from /usr/share/zoneinfo/zone.tab
 699
 700 `--tty` `<integer> (0 - 6)` ('default =' `2`)::
 701
 702 Specify the number of tty available to the container
 703
 704 `--unique` `<boolean>` ::
 705
 706 Assign a unique random ethernet address.
 707 +
 708 NOTE: Requires option(s): `restore`
 709
 710 `--unprivileged` `<boolean>` ('default =' `0`)::
 711
 712 Makes the container run as unprivileged user. (Should not be modified manually.)
 713
 714 `--unused[n]` `[volume=]<volume>` ::
 715
 716 Reference to unused volumes. This is used internally, and should not be modified manually.
 717
 718 *pct resume* `<vmid>`
 719
 720 Resume the container.
 721
 722 `<vmid>`: `<integer> (1 - N)` ::
 723
 724 The (unique) ID of the VM.
 725
 726 *pct rollback* `<vmid> <snapname>`
 727
 728 Rollback LXC state to specified snapshot.
 729
 730 `<vmid>`: `<integer> (1 - N)` ::
 731
 732 The (unique) ID of the VM.
 733
 734 `<snapname>`: `<string>` ::
 735
 736 The name of the snapshot.
 737
 738 *pct set* `<vmid>` `[OPTIONS]`
 739
 740 Set container options.
 741
 742 `<vmid>`: `<integer> (1 - N)` ::
 743
 744 The (unique) ID of the VM.
 745
 746 `--arch` `<amd64 | arm64 | armhf | i386>` ('default =' `amd64`)::
 747
 748 OS architecture type.
 749
 750 `--cmode` `<console | shell | tty>` ('default =' `tty`)::
 751
 752 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).
 753
 754 `--console` `<boolean>` ('default =' `1`)::
 755
 756 Attach a console device (/dev/console) to the container.
 757
 758 `--cores` `<integer> (1 - 8192)` ::
 759
 760 The number of cores assigned to the container. A container can use all available cores by default.
 761
 762 `--cpulimit` `<number> (0 - 8192)` ('default =' `0`)::
 763
 764 Limit of CPU usage.
 765 +
 766 NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.
 767
 768 `--cpuunits` `<integer> (0 - 500000)` ('default =' `1024`)::
 769
 770 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.
 771 +
 772 NOTE: You can disable fair-scheduler configuration by setting this to 0.
 773
 774 `--debug` `<boolean>` ('default =' `0`)::
 775
 776 Try to be more verbose. For now this only enables debug log-level on start.
 777
 778 `--delete` `<string>` ::
 779
 780 A list of settings you want to delete.
 781
 782 `--description` `<string>` ::
 783
 784 Container description. Only used on the configuration web interface.
 785
 786 `--digest` `<string>` ::
 787
 788 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
 789
 790 `--features` `[force_rw_sys=<1|0>] [,fuse=<1|0>] [,keyctl=<1|0>] [,mknod=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
 791
 792 Allow containers access to advanced features.
 793
 794 `--hookscript` `<string>` ::
 795
 796 Script that will be exectued during various steps in the containers lifetime.
 797
 798 `--hostname` `<string>` ::
 799
 800 Set a host name for the container.
 801
 802 `--lock` `<backup | create | destroyed | disk | fstrim | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
 803
 804 Lock/unlock the VM.
 805
 806 `--memory` `<integer> (16 - N)` ('default =' `512`)::
 807
 808 Amount of RAM for the VM in MB.
 809
 810 `--mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
 811
 812 Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
 813
 814 `--nameserver` `<string>` ::
 815
 816 Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
 817
 818 `--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>]` ::
 819
 820 Specifies network interfaces for the container.
 821
 822 `--onboot` `<boolean>` ('default =' `0`)::
 823
 824 Specifies whether a VM will be started during system bootup.
 825
 826 `--ostype` `<alpine | archlinux | centos | debian | devuan | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
 827
 828 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.
 829
 830 `--protection` `<boolean>` ('default =' `0`)::
 831
 832 Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
 833
 834 `--revert` `<string>` ::
 835
 836 Revert a pending change.
 837
 838 `--rootfs` `[volume=]<volume> [,acl=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
 839
 840 Use volume as container root.
 841
 842 `--searchdomain` `<string>` ::
 843
 844 Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
 845
 846 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
 847
 848 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.
 849
 850 `--swap` `<integer> (0 - N)` ('default =' `512`)::
 851
 852 Amount of SWAP for the VM in MB.
 853
 854 `--tags` `<string>` ::
 855
 856 Tags of the Container. This is only meta information.
 857
 858 `--template` `<boolean>` ('default =' `0`)::
 859
 860 Enable/disable Template.
 861
 862 `--timezone` `<string>` ::
 863
 864 Time zone to use in the container. If option isn't set, then nothing will be done. Can be set to 'host' to match the host time zone, or an arbitrary time zone option from /usr/share/zoneinfo/zone.tab
 865
 866 `--tty` `<integer> (0 - 6)` ('default =' `2`)::
 867
 868 Specify the number of tty available to the container
 869
 870 `--unprivileged` `<boolean>` ('default =' `0`)::
 871
 872 Makes the container run as unprivileged user. (Should not be modified manually.)
 873
 874 `--unused[n]` `[volume=]<volume>` ::
 875
 876 Reference to unused volumes. This is used internally, and should not be modified manually.
 877
 878 *pct shutdown* `<vmid>` `[OPTIONS]`
 879
 880 Shutdown the container. This will trigger a clean shutdown of the
 881 container, see lxc-stop(1) for details.
 882
 883 `<vmid>`: `<integer> (1 - N)` ::
 884
 885 The (unique) ID of the VM.
 886
 887 `--forceStop` `<boolean>` ('default =' `0`)::
 888
 889 Make sure the Container stops.
 890
 891 `--timeout` `<integer> (0 - N)` ('default =' `60`)::
 892
 893 Wait maximal timeout seconds.
 894
 895 *pct snapshot* `<vmid> <snapname>` `[OPTIONS]`
 896
 897 Snapshot a container.
 898
 899 `<vmid>`: `<integer> (1 - N)` ::
 900
 901 The (unique) ID of the VM.
 902
 903 `<snapname>`: `<string>` ::
 904
 905 The name of the snapshot.
 906
 907 `--description` `<string>` ::
 908
 909 A textual description or comment.
 910
 911 *pct start* `<vmid>` `[OPTIONS]`
 912
 913 Start the container.
 914
 915 `<vmid>`: `<integer> (1 - N)` ::
 916
 917 The (unique) ID of the VM.
 918
 919 `--debug` `<boolean>` ('default =' `0`)::
 920
 921 If set, enables very verbose debug log-level on start.
 922
 923 `--skiplock` `<boolean>` ::
 924
 925 Ignore locks - only root is allowed to use this option.
 926
 927 *pct status* `<vmid>` `[OPTIONS]`
 928
 929 Show CT status.
 930
 931 `<vmid>`: `<integer> (1 - N)` ::
 932
 933 The (unique) ID of the VM.
 934
 935 `--verbose` `<boolean>` ::
 936
 937 Verbose output format
 938
 939 *pct stop* `<vmid>` `[OPTIONS]`
 940
 941 Stop the container. This will abruptly stop all processes running in the
 942 container.
 943
 944 `<vmid>`: `<integer> (1 - N)` ::
 945
 946 The (unique) ID of the VM.
 947
 948 `--skiplock` `<boolean>` ::
 949
 950 Ignore locks - only root is allowed to use this option.
 951
 952 *pct suspend* `<vmid>`
 953
 954 Suspend the container.
 955
 956 `<vmid>`: `<integer> (1 - N)` ::
 957
 958 The (unique) ID of the VM.
 959
 960 *pct template* `<vmid>`
 961
 962 Create a Template.
 963
 964 `<vmid>`: `<integer> (1 - N)` ::
 965
 966 The (unique) ID of the VM.
 967
 968 *pct unlock* `<vmid>`
 969
 970 Unlock the VM.
 971
 972 `<vmid>`: `<integer> (1 - N)` ::
 973
 974 The (unique) ID of the VM.
 975
 976 *pct unmount* `<vmid>`
 977
 978 Unmount the container's filesystem.
 979
 980 `<vmid>`: `<integer> (1 - N)` ::
 981
 982 The (unique) ID of the VM.
 983
 984