1 *pct* `<COMMAND> [ARGS] [OPTIONS]`
3 *pct clone* `<vmid> <newid>` `[OPTIONS]`
5 Create a container clone/copy
7 `<vmid>`: `<integer> (1 - N)` ::
9 The (unique) ID of the VM.
11 `<newid>`: `<integer> (1 - N)` ::
15 `--bwlimit` `<number> (0 - N)` ('default =' `clone limit from datacenter or storage config`)::
17 Override I/O bandwidth limit (in KiB/s).
19 `--description` `<string>` ::
21 Description for the new CT.
23 `--full` `<boolean>` ::
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.
27 `--hostname` `<string>` ::
29 Set a hostname for the new CT.
31 `--pool` `<string>` ::
33 Add the new CT to the specified pool.
35 `--snapname` `<string>` ::
37 The name of the snapshot.
39 `--storage` `<string>` ::
41 Target storage for full clone.
43 `--target` `<string>` ::
45 Target node. Only allowed if the original VM is on shared storage.
47 *pct config* `<vmid>` `[OPTIONS]`
49 Get container configuration.
51 `<vmid>`: `<integer> (1 - N)` ::
53 The (unique) ID of the VM.
55 `--current` `<boolean>` ('default =' `0`)::
57 Get current values (instead of pending values).
59 `--snapshot` `<string>` ::
61 Fetch config values from given snapshot.
63 *pct console* `<vmid>` `[OPTIONS]`
65 Launch a console for the specified container.
67 `<vmid>`: `<integer> (1 - N)` ::
69 The (unique) ID of the VM.
71 `--escape` `\^?[a-z]` ('default =' `^a`)::
73 Escape sequence prefix. For example to use <Ctrl+b q> as the escape sequence pass '^b'.
77 Print the list of assigned CPU sets.
79 *pct create* `<vmid> <ostemplate>` `[OPTIONS]`
81 Create or restore a container.
83 `<vmid>`: `<integer> (1 - N)` ::
85 The (unique) ID of the VM.
87 `<ostemplate>`: `<string>` ::
89 The OS template or backup file.
91 `--arch` `<amd64 | arm64 | armhf | i386>` ('default =' `amd64`)::
95 `--bwlimit` `<number> (0 - N)` ('default =' `restore limit from datacenter or storage config`)::
97 Override I/O bandwidth limit (in KiB/s).
99 `--cmode` `<console | shell | tty>` ('default =' `tty`)::
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).
103 `--console` `<boolean>` ('default =' `1`)::
105 Attach a console device (/dev/console) to the container.
107 `--cores` `<integer> (1 - 8192)` ::
109 The number of cores assigned to the container. A container can use all available cores by default.
111 `--cpulimit` `<number> (0 - 8192)` ('default =' `0`)::
115 NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.
117 `--cpuunits` `<integer> (0 - 500000)` ('default =' `1024`)::
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.
121 NOTE: You can disable fair-scheduler configuration by setting this to 0.
123 `--debug` `<boolean>` ('default =' `0`)::
125 Try to be more verbose. For now this only enables debug log-level on start.
127 `--description` `<string>` ::
129 Container description. Only used on the configuration web interface.
131 `--features` `[force_rw_sys=<1|0>] [,fuse=<1|0>] [,keyctl=<1|0>] [,mknod=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
133 Allow containers access to advanced features.
135 `--force` `<boolean>` ::
137 Allow to overwrite existing container.
139 `--hookscript` `<string>` ::
141 Script that will be exectued during various steps in the containers lifetime.
143 `--hostname` `<string>` ::
145 Set a host name for the container.
147 `--ignore-unpack-errors` `<boolean>` ::
149 Ignore errors when extracting the template.
151 `--lock` `<backup | create | destroyed | disk | fstrim | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
155 `--memory` `<integer> (16 - N)` ('default =' `512`)::
157 Amount of RAM for the VM in MB.
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>]` ::
161 Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
163 `--nameserver` `<string>` ::
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.
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>]` ::
169 Specifies network interfaces for the container.
171 `--onboot` `<boolean>` ('default =' `0`)::
173 Specifies whether a VM will be started during system bootup.
175 `--ostype` `<alpine | archlinux | centos | debian | devuan | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
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.
179 `--password` `<password>` ::
181 Sets root password inside container.
183 `--pool` `<string>` ::
185 Add the VM to the specified pool.
187 `--protection` `<boolean>` ('default =' `0`)::
189 Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
191 `--restore` `<boolean>` ::
193 Mark this as restore task.
195 `--rootfs` `[volume=]<volume> [,acl=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
197 Use volume as container root.
199 `--searchdomain` `<string>` ::
201 Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
203 `--ssh-public-keys` `<filepath>` ::
205 Setup public SSH keys (one key per line, OpenSSH format).
207 `--start` `<boolean>` ('default =' `0`)::
209 Start the CT after its creation finished successfully.
211 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
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.
215 `--storage` `<string>` ('default =' `local`)::
219 `--swap` `<integer> (0 - N)` ('default =' `512`)::
221 Amount of SWAP for the VM in MB.
223 `--tags` `<string>` ::
225 Tags of the Container. This is only meta information.
227 `--template` `<boolean>` ('default =' `0`)::
229 Enable/disable Template.
231 `--timezone` `<string>` ::
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
235 `--tty` `<integer> (0 - 6)` ('default =' `2`)::
237 Specify the number of tty available to the container
239 `--unique` `<boolean>` ::
241 Assign a unique random ethernet address.
243 NOTE: Requires option(s): `restore`
245 `--unprivileged` `<boolean>` ('default =' `0`)::
247 Makes the container run as unprivileged user. (Should not be modified manually.)
249 `--unused[n]` `[volume=]<volume>` ::
251 Reference to unused volumes. This is used internally, and should not be modified manually.
253 *pct delsnapshot* `<vmid> <snapname>` `[OPTIONS]`
255 Delete a LXC snapshot.
257 `<vmid>`: `<integer> (1 - N)` ::
259 The (unique) ID of the VM.
261 `<snapname>`: `<string>` ::
263 The name of the snapshot.
265 `--force` `<boolean>` ::
267 For removal from config file, even if removing disk snapshots fails.
269 *pct destroy* `<vmid>` `[OPTIONS]`
271 Destroy the container (also delete all uses files).
273 `<vmid>`: `<integer> (1 - N)` ::
275 The (unique) ID of the VM.
277 `--destroy-unreferenced-disks` `<boolean>` ::
279 If set, destroy additionally all disks with the VMID from all enabled storages which are not referenced in the config.
281 `--force` `<boolean>` ('default =' `0`)::
283 Force destroy, even if running.
285 `--purge` `<boolean>` ('default =' `0`)::
287 Remove container from all related configurations. For example, backup jobs, replication jobs or HA. Related ACLs and Firewall entries will *always* be removed.
291 Get the container's current disk usage.
293 `<vmid>`: `<integer> (1 - N)` ::
295 The (unique) ID of the VM.
299 Launch a shell for the specified container.
301 `<vmid>`: `<integer> (1 - N)` ::
303 The (unique) ID of the VM.
305 *pct exec* `<vmid> [<extra-args>]`
307 Launch a command inside the specified container.
309 `<vmid>`: `<integer> (1 - N)` ::
311 The (unique) ID of the VM.
313 `<extra-args>`: `<array>` ::
315 Extra arguments as array
317 *pct fsck* `<vmid>` `[OPTIONS]`
319 Run a filesystem check (fsck) on a container volume.
321 `<vmid>`: `<integer> (1 - N)` ::
323 The (unique) ID of the VM.
325 `--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>` ::
327 A volume on which to run the filesystem check
329 `--force` `<boolean>` ('default =' `0`)::
331 Force checking, even if the filesystem seems clean
333 *pct fstrim* `<vmid>` `[OPTIONS]`
335 Run fstrim on a chosen CT and its mountpoints.
337 `<vmid>`: `<integer> (1 - N)` ::
339 The (unique) ID of the VM.
341 `--ignore-mountpoints` `<boolean>` ::
343 Skip all mountpoints, only do fstrim on the container root.
345 *pct help* `[OPTIONS]`
347 Get help about specified command.
349 `--extra-args` `<array>` ::
351 Shows help for a specific command
353 `--verbose` `<boolean>` ::
355 Verbose output format.
359 LXC container index (per node).
361 *pct listsnapshot* `<vmid>`
365 `<vmid>`: `<integer> (1 - N)` ::
367 The (unique) ID of the VM.
369 *pct migrate* `<vmid> <target>` `[OPTIONS]`
371 Migrate the container to another node. Creates a new migration task.
373 `<vmid>`: `<integer> (1 - N)` ::
375 The (unique) ID of the VM.
377 `<target>`: `<string>` ::
381 `--bwlimit` `<number> (0 - N)` ('default =' `migrate limit from datacenter or storage config`)::
383 Override I/O bandwidth limit (in KiB/s).
385 `--force` `<boolean>` ::
387 Force migration despite local bind / device mounts. NOTE: deprecated, use 'shared' property of mount point instead.
389 `--online` `<boolean>` ::
391 Use online/live migration.
393 `--restart` `<boolean>` ::
395 Use restart migration
397 `--timeout` `<integer>` ('default =' `180`)::
399 Timeout in seconds for shutdown for restart migration
403 Mount the container's filesystem on the host. This will hold a lock on the
404 container and is meant for emergency maintenance only as it will prevent
405 further operations on the container other than start and stop.
407 `<vmid>`: `<integer> (1 - N)` ::
409 The (unique) ID of the VM.
411 *pct move_volume* `<vmid> <volume> <storage>` `[OPTIONS]`
413 Move a rootfs-/mp-volume to a different storage
415 `<vmid>`: `<integer> (1 - N)` ::
417 The (unique) ID of the VM.
419 `<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>` ::
421 Volume which will be moved.
423 `<storage>`: `<string>` ::
427 `--bwlimit` `<number> (0 - N)` ('default =' `clone limit from datacenter or storage config`)::
429 Override I/O bandwidth limit (in KiB/s).
431 `--delete` `<boolean>` ('default =' `0`)::
433 Delete the original volume after successful copy. By default the original is kept as an unused volume entry.
435 `--digest` `<string>` ::
437 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
439 *pct pending* `<vmid>`
441 Get container configuration, including pending changes.
443 `<vmid>`: `<integer> (1 - N)` ::
445 The (unique) ID of the VM.
447 *pct pull* `<vmid> <path> <destination>` `[OPTIONS]`
449 Copy a file from the container to the local system.
451 `<vmid>`: `<integer> (1 - N)` ::
453 The (unique) ID of the VM.
455 `<path>`: `<string>` ::
457 Path to a file inside the container to pull.
459 `<destination>`: `<string>` ::
463 `--group` `<string>` ::
465 Owner group name or id.
467 `--perms` `<string>` ::
469 File permissions to use (octal by default, prefix with '0x' for hexadecimal).
471 `--user` `<string>` ::
473 Owner user name or id.
475 *pct push* `<vmid> <file> <destination>` `[OPTIONS]`
477 Copy a local file to the container.
479 `<vmid>`: `<integer> (1 - N)` ::
481 The (unique) ID of the VM.
483 `<file>`: `<string>` ::
485 Path to a local file.
487 `<destination>`: `<string>` ::
489 Destination inside the container to write to.
491 `--group` `<string>` ::
493 Owner group name or id. When using a name it must exist inside the container.
495 `--perms` `<string>` ::
497 File permissions to use (octal by default, prefix with '0x' for hexadecimal).
499 `--user` `<string>` ::
501 Owner user name or id. When using a name it must exist inside the container.
503 *pct reboot* `<vmid>` `[OPTIONS]`
505 Reboot the container by shutting it down, and starting it again. Applies
508 `<vmid>`: `<integer> (1 - N)` ::
510 The (unique) ID of the VM.
512 `--timeout` `<integer> (0 - N)` ::
514 Wait maximal timeout seconds for the shutdown.
516 *pct rescan* `[OPTIONS]`
518 Rescan all storages and update disk sizes and unused disk images.
520 `--dryrun` `<boolean>` ('default =' `0`)::
522 Do not actually write changes out to conifg.
524 `--vmid` `<integer> (1 - N)` ::
526 The (unique) ID of the VM.
528 *pct resize* `<vmid> <disk> <size>` `[OPTIONS]`
530 Resize a container mount point.
532 `<vmid>`: `<integer> (1 - N)` ::
534 The (unique) ID of the VM.
536 `<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>` ::
538 The disk you want to resize.
540 `<size>`: `\+?\d+(\.\d+)?[KMGT]?` ::
542 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.
544 `--digest` `<string>` ::
546 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
548 *pct restore* `<vmid> <ostemplate>` `[OPTIONS]`
550 Create or restore a container.
552 `<vmid>`: `<integer> (1 - N)` ::
554 The (unique) ID of the VM.
556 `<ostemplate>`: `<string>` ::
558 The OS template or backup file.
560 `--arch` `<amd64 | arm64 | armhf | i386>` ('default =' `amd64`)::
562 OS architecture type.
564 `--bwlimit` `<number> (0 - N)` ('default =' `restore limit from datacenter or storage config`)::
566 Override I/O bandwidth limit (in KiB/s).
568 `--cmode` `<console | shell | tty>` ('default =' `tty`)::
570 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).
572 `--console` `<boolean>` ('default =' `1`)::
574 Attach a console device (/dev/console) to the container.
576 `--cores` `<integer> (1 - 8192)` ::
578 The number of cores assigned to the container. A container can use all available cores by default.
580 `--cpulimit` `<number> (0 - 8192)` ('default =' `0`)::
584 NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.
586 `--cpuunits` `<integer> (0 - 500000)` ('default =' `1024`)::
588 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.
590 NOTE: You can disable fair-scheduler configuration by setting this to 0.
592 `--debug` `<boolean>` ('default =' `0`)::
594 Try to be more verbose. For now this only enables debug log-level on start.
596 `--description` `<string>` ::
598 Container description. Only used on the configuration web interface.
600 `--features` `[force_rw_sys=<1|0>] [,fuse=<1|0>] [,keyctl=<1|0>] [,mknod=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
602 Allow containers access to advanced features.
604 `--force` `<boolean>` ::
606 Allow to overwrite existing container.
608 `--hookscript` `<string>` ::
610 Script that will be exectued during various steps in the containers lifetime.
612 `--hostname` `<string>` ::
614 Set a host name for the container.
616 `--ignore-unpack-errors` `<boolean>` ::
618 Ignore errors when extracting the template.
620 `--lock` `<backup | create | destroyed | disk | fstrim | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
624 `--memory` `<integer> (16 - N)` ('default =' `512`)::
626 Amount of RAM for the VM in MB.
628 `--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>]` ::
630 Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
632 `--nameserver` `<string>` ::
634 Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
636 `--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>]` ::
638 Specifies network interfaces for the container.
640 `--onboot` `<boolean>` ('default =' `0`)::
642 Specifies whether a VM will be started during system bootup.
644 `--ostype` `<alpine | archlinux | centos | debian | devuan | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
646 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.
648 `--password` `<password>` ::
650 Sets root password inside container.
652 `--pool` `<string>` ::
654 Add the VM to the specified pool.
656 `--protection` `<boolean>` ('default =' `0`)::
658 Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
660 `--rootfs` `[volume=]<volume> [,acl=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
662 Use volume as container root.
664 `--searchdomain` `<string>` ::
666 Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
668 `--ssh-public-keys` `<filepath>` ::
670 Setup public SSH keys (one key per line, OpenSSH format).
672 `--start` `<boolean>` ('default =' `0`)::
674 Start the CT after its creation finished successfully.
676 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
678 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.
680 `--storage` `<string>` ('default =' `local`)::
684 `--swap` `<integer> (0 - N)` ('default =' `512`)::
686 Amount of SWAP for the VM in MB.
688 `--tags` `<string>` ::
690 Tags of the Container. This is only meta information.
692 `--template` `<boolean>` ('default =' `0`)::
694 Enable/disable Template.
696 `--timezone` `<string>` ::
698 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
700 `--tty` `<integer> (0 - 6)` ('default =' `2`)::
702 Specify the number of tty available to the container
704 `--unique` `<boolean>` ::
706 Assign a unique random ethernet address.
708 NOTE: Requires option(s): `restore`
710 `--unprivileged` `<boolean>` ('default =' `0`)::
712 Makes the container run as unprivileged user. (Should not be modified manually.)
714 `--unused[n]` `[volume=]<volume>` ::
716 Reference to unused volumes. This is used internally, and should not be modified manually.
718 *pct resume* `<vmid>`
720 Resume the container.
722 `<vmid>`: `<integer> (1 - N)` ::
724 The (unique) ID of the VM.
726 *pct rollback* `<vmid> <snapname>`
728 Rollback LXC state to specified snapshot.
730 `<vmid>`: `<integer> (1 - N)` ::
732 The (unique) ID of the VM.
734 `<snapname>`: `<string>` ::
736 The name of the snapshot.
738 *pct set* `<vmid>` `[OPTIONS]`
740 Set container options.
742 `<vmid>`: `<integer> (1 - N)` ::
744 The (unique) ID of the VM.
746 `--arch` `<amd64 | arm64 | armhf | i386>` ('default =' `amd64`)::
748 OS architecture type.
750 `--cmode` `<console | shell | tty>` ('default =' `tty`)::
752 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).
754 `--console` `<boolean>` ('default =' `1`)::
756 Attach a console device (/dev/console) to the container.
758 `--cores` `<integer> (1 - 8192)` ::
760 The number of cores assigned to the container. A container can use all available cores by default.
762 `--cpulimit` `<number> (0 - 8192)` ('default =' `0`)::
766 NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.
768 `--cpuunits` `<integer> (0 - 500000)` ('default =' `1024`)::
770 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.
772 NOTE: You can disable fair-scheduler configuration by setting this to 0.
774 `--debug` `<boolean>` ('default =' `0`)::
776 Try to be more verbose. For now this only enables debug log-level on start.
778 `--delete` `<string>` ::
780 A list of settings you want to delete.
782 `--description` `<string>` ::
784 Container description. Only used on the configuration web interface.
786 `--digest` `<string>` ::
788 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
790 `--features` `[force_rw_sys=<1|0>] [,fuse=<1|0>] [,keyctl=<1|0>] [,mknod=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
792 Allow containers access to advanced features.
794 `--hookscript` `<string>` ::
796 Script that will be exectued during various steps in the containers lifetime.
798 `--hostname` `<string>` ::
800 Set a host name for the container.
802 `--lock` `<backup | create | destroyed | disk | fstrim | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
806 `--memory` `<integer> (16 - N)` ('default =' `512`)::
808 Amount of RAM for the VM in MB.
810 `--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>]` ::
812 Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
814 `--nameserver` `<string>` ::
816 Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
818 `--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>]` ::
820 Specifies network interfaces for the container.
822 `--onboot` `<boolean>` ('default =' `0`)::
824 Specifies whether a VM will be started during system bootup.
826 `--ostype` `<alpine | archlinux | centos | debian | devuan | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
828 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.
830 `--protection` `<boolean>` ('default =' `0`)::
832 Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
834 `--revert` `<string>` ::
836 Revert a pending change.
838 `--rootfs` `[volume=]<volume> [,acl=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
840 Use volume as container root.
842 `--searchdomain` `<string>` ::
844 Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
846 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
848 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.
850 `--swap` `<integer> (0 - N)` ('default =' `512`)::
852 Amount of SWAP for the VM in MB.
854 `--tags` `<string>` ::
856 Tags of the Container. This is only meta information.
858 `--template` `<boolean>` ('default =' `0`)::
860 Enable/disable Template.
862 `--timezone` `<string>` ::
864 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
866 `--tty` `<integer> (0 - 6)` ('default =' `2`)::
868 Specify the number of tty available to the container
870 `--unprivileged` `<boolean>` ('default =' `0`)::
872 Makes the container run as unprivileged user. (Should not be modified manually.)
874 `--unused[n]` `[volume=]<volume>` ::
876 Reference to unused volumes. This is used internally, and should not be modified manually.
878 *pct shutdown* `<vmid>` `[OPTIONS]`
880 Shutdown the container. This will trigger a clean shutdown of the
881 container, see lxc-stop(1) for details.
883 `<vmid>`: `<integer> (1 - N)` ::
885 The (unique) ID of the VM.
887 `--forceStop` `<boolean>` ('default =' `0`)::
889 Make sure the Container stops.
891 `--timeout` `<integer> (0 - N)` ('default =' `60`)::
893 Wait maximal timeout seconds.
895 *pct snapshot* `<vmid> <snapname>` `[OPTIONS]`
897 Snapshot a container.
899 `<vmid>`: `<integer> (1 - N)` ::
901 The (unique) ID of the VM.
903 `<snapname>`: `<string>` ::
905 The name of the snapshot.
907 `--description` `<string>` ::
909 A textual description or comment.
911 *pct start* `<vmid>` `[OPTIONS]`
915 `<vmid>`: `<integer> (1 - N)` ::
917 The (unique) ID of the VM.
919 `--debug` `<boolean>` ('default =' `0`)::
921 If set, enables very verbose debug log-level on start.
923 `--skiplock` `<boolean>` ::
925 Ignore locks - only root is allowed to use this option.
927 *pct status* `<vmid>` `[OPTIONS]`
931 `<vmid>`: `<integer> (1 - N)` ::
933 The (unique) ID of the VM.
935 `--verbose` `<boolean>` ::
937 Verbose output format
939 *pct stop* `<vmid>` `[OPTIONS]`
941 Stop the container. This will abruptly stop all processes running in the
944 `<vmid>`: `<integer> (1 - N)` ::
946 The (unique) ID of the VM.
948 `--skiplock` `<boolean>` ::
950 Ignore locks - only root is allowed to use this option.
952 *pct suspend* `<vmid>`
954 Suspend the container.
956 `<vmid>`: `<integer> (1 - N)` ::
958 The (unique) ID of the VM.
960 *pct template* `<vmid>`
964 `<vmid>`: `<integer> (1 - N)` ::
966 The (unique) ID of the VM.
968 *pct unlock* `<vmid>`
972 `<vmid>`: `<integer> (1 - N)` ::
974 The (unique) ID of the VM.
976 *pct unmount* `<vmid>`
978 Unmount the container's filesystem.
980 `<vmid>`: `<integer> (1 - N)` ::
982 The (unique) ID of the VM.