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