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