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