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