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