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