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.
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 | 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 `--force` `<boolean>` ('default =' `0`)::
279 Force destroy, even if running.
281 `--purge` `<boolean>` ('default =' `0`)::
283 Remove container from all related configurations. For example, backup jobs, replication jobs or HA. Related ACLs and Firewall entries will *always* be removed.
287 Get the container's current disk usage.
289 `<vmid>`: `<integer> (1 - N)` ::
291 The (unique) ID of the VM.
295 Launch a shell for the specified container.
297 `<vmid>`: `<integer> (1 - N)` ::
299 The (unique) ID of the VM.
301 *pct exec* `<vmid> [<extra-args>]`
303 Launch a command inside the specified container.
305 `<vmid>`: `<integer> (1 - N)` ::
307 The (unique) ID of the VM.
309 `<extra-args>`: `<array>` ::
311 Extra arguments as array
313 *pct fsck* `<vmid>` `[OPTIONS]`
315 Run a filesystem check (fsck) on a container volume.
317 `<vmid>`: `<integer> (1 - N)` ::
319 The (unique) ID of the VM.
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>` ::
323 A volume on which to run the filesystem check
325 `--force` `<boolean>` ('default =' `0`)::
327 Force checking, even if the filesystem seems clean
329 *pct fstrim* `<vmid>` `[OPTIONS]`
331 Run fstrim on a chosen CT and its mountpoints.
333 `<vmid>`: `<integer> (1 - N)` ::
335 The (unique) ID of the VM.
337 `--ignore-mountpoints` `<boolean>` ::
339 Skip all mountpoints, only do fstrim on the container root.
341 *pct help* `[OPTIONS]`
343 Get help about specified command.
345 `--extra-args` `<array>` ::
347 Shows help for a specific command
349 `--verbose` `<boolean>` ::
351 Verbose output format.
355 LXC container index (per node).
357 *pct listsnapshot* `<vmid>`
361 `<vmid>`: `<integer> (1 - N)` ::
363 The (unique) ID of the VM.
365 *pct migrate* `<vmid> <target>` `[OPTIONS]`
367 Migrate the container to another node. Creates a new migration task.
369 `<vmid>`: `<integer> (1 - N)` ::
371 The (unique) ID of the VM.
373 `<target>`: `<string>` ::
377 `--bwlimit` `<number> (0 - N)` ('default =' `migrate limit from datacenter or storage config`)::
379 Override I/O bandwidth limit (in KiB/s).
381 `--force` `<boolean>` ::
383 Force migration despite local bind / device mounts. NOTE: deprecated, use 'shared' property of mount point instead.
385 `--online` `<boolean>` ::
387 Use online/live migration.
389 `--restart` `<boolean>` ::
391 Use restart migration
393 `--timeout` `<integer>` ('default =' `180`)::
395 Timeout in seconds for shutdown for restart migration
399 Mount the container's filesystem on the host. This will hold a lock on the
400 container and is meant for emergency maintenance only as it will prevent
401 further operations on the container other than start and stop.
403 `<vmid>`: `<integer> (1 - N)` ::
405 The (unique) ID of the VM.
407 *pct move_volume* `<vmid> <volume> <storage>` `[OPTIONS]`
409 Move a rootfs-/mp-volume to a different storage
411 `<vmid>`: `<integer> (1 - N)` ::
413 The (unique) ID of the VM.
415 `<volume>`: `<mp0 | mp1 | mp10 | mp100 | mp101 | mp102 | mp103 | mp104 | mp105 | mp106 | mp107 | mp108 | mp109 | mp11 | mp110 | mp111 | mp112 | mp113 | mp114 | mp115 | mp116 | mp117 | mp118 | mp119 | mp12 | mp120 | mp121 | mp122 | mp123 | mp124 | mp125 | mp126 | mp127 | mp128 | mp129 | mp13 | mp130 | mp131 | mp132 | mp133 | mp134 | mp135 | mp136 | mp137 | mp138 | mp139 | mp14 | mp140 | mp141 | mp142 | mp143 | mp144 | mp145 | mp146 | mp147 | mp148 | mp149 | mp15 | mp150 | mp151 | mp152 | mp153 | mp154 | mp155 | mp156 | mp157 | mp158 | mp159 | mp16 | mp160 | mp161 | mp162 | mp163 | mp164 | mp165 | mp166 | mp167 | mp168 | mp169 | mp17 | mp170 | mp171 | mp172 | mp173 | mp174 | mp175 | mp176 | mp177 | mp178 | mp179 | mp18 | mp180 | mp181 | mp182 | mp183 | mp184 | mp185 | mp186 | mp187 | mp188 | mp189 | mp19 | mp190 | mp191 | mp192 | mp193 | mp194 | mp195 | mp196 | mp197 | mp198 | mp199 | mp2 | mp20 | mp200 | mp201 | mp202 | mp203 | mp204 | mp205 | mp206 | mp207 | mp208 | mp209 | mp21 | mp210 | mp211 | mp212 | mp213 | mp214 | mp215 | mp216 | mp217 | mp218 | mp219 | mp22 | mp220 | mp221 | mp222 | mp223 | mp224 | mp225 | mp226 | mp227 | mp228 | mp229 | mp23 | mp230 | mp231 | mp232 | mp233 | mp234 | mp235 | mp236 | mp237 | mp238 | mp239 | mp24 | mp240 | mp241 | mp242 | mp243 | mp244 | mp245 | mp246 | mp247 | mp248 | mp249 | mp25 | mp250 | mp251 | mp252 | mp253 | mp254 | mp255 | mp26 | mp27 | mp28 | mp29 | mp3 | mp30 | mp31 | mp32 | mp33 | mp34 | mp35 | mp36 | mp37 | mp38 | mp39 | mp4 | mp40 | mp41 | mp42 | mp43 | mp44 | mp45 | mp46 | mp47 | mp48 | mp49 | mp5 | mp50 | mp51 | mp52 | mp53 | mp54 | mp55 | mp56 | mp57 | mp58 | mp59 | mp6 | mp60 | mp61 | mp62 | mp63 | mp64 | mp65 | mp66 | mp67 | mp68 | mp69 | mp7 | mp70 | mp71 | mp72 | mp73 | mp74 | mp75 | mp76 | mp77 | mp78 | mp79 | mp8 | mp80 | mp81 | mp82 | mp83 | mp84 | mp85 | mp86 | mp87 | mp88 | mp89 | mp9 | mp90 | mp91 | mp92 | mp93 | mp94 | mp95 | mp96 | mp97 | mp98 | mp99 | rootfs>` ::
417 Volume which will be moved.
419 `<storage>`: `<string>` ::
423 `--bwlimit` `<number> (0 - N)` ('default =' `clone limit from datacenter or storage config`)::
425 Override I/O bandwidth limit (in KiB/s).
427 `--delete` `<boolean>` ('default =' `0`)::
429 Delete the original volume after successful copy. By default the original is kept as an unused volume entry.
431 `--digest` `<string>` ::
433 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
435 *pct pending* `<vmid>`
437 Get container configuration, including pending changes.
439 `<vmid>`: `<integer> (1 - N)` ::
441 The (unique) ID of the VM.
443 *pct pull* `<vmid> <path> <destination>` `[OPTIONS]`
445 Copy a file from the container to the local system.
447 `<vmid>`: `<integer> (1 - N)` ::
449 The (unique) ID of the VM.
451 `<path>`: `<string>` ::
453 Path to a file inside the container to pull.
455 `<destination>`: `<string>` ::
459 `--group` `<string>` ::
461 Owner group name or id.
463 `--perms` `<string>` ::
465 File permissions to use (octal by default, prefix with '0x' for hexadecimal).
467 `--user` `<string>` ::
469 Owner user name or id.
471 *pct push* `<vmid> <file> <destination>` `[OPTIONS]`
473 Copy a local file to the container.
475 `<vmid>`: `<integer> (1 - N)` ::
477 The (unique) ID of the VM.
479 `<file>`: `<string>` ::
481 Path to a local file.
483 `<destination>`: `<string>` ::
485 Destination inside the container to write to.
487 `--group` `<string>` ::
489 Owner group name or id. When using a name it must exist inside the container.
491 `--perms` `<string>` ::
493 File permissions to use (octal by default, prefix with '0x' for hexadecimal).
495 `--user` `<string>` ::
497 Owner user name or id. When using a name it must exist inside the container.
499 *pct reboot* `<vmid>` `[OPTIONS]`
501 Reboot the container by shutting it down, and starting it again. Applies
504 `<vmid>`: `<integer> (1 - N)` ::
506 The (unique) ID of the VM.
508 `--timeout` `<integer> (0 - N)` ::
510 Wait maximal timeout seconds for the shutdown.
512 *pct rescan* `[OPTIONS]`
514 Rescan all storages and update disk sizes and unused disk images.
516 `--dryrun` `<boolean>` ('default =' `0`)::
518 Do not actually write changes out to conifg.
520 `--vmid` `<integer> (1 - N)` ::
522 The (unique) ID of the VM.
524 *pct resize* `<vmid> <disk> <size>` `[OPTIONS]`
526 Resize a container mount point.
528 `<vmid>`: `<integer> (1 - N)` ::
530 The (unique) ID of the VM.
532 `<disk>`: `<mp0 | mp1 | mp10 | mp100 | mp101 | mp102 | mp103 | mp104 | mp105 | mp106 | mp107 | mp108 | mp109 | mp11 | mp110 | mp111 | mp112 | mp113 | mp114 | mp115 | mp116 | mp117 | mp118 | mp119 | mp12 | mp120 | mp121 | mp122 | mp123 | mp124 | mp125 | mp126 | mp127 | mp128 | mp129 | mp13 | mp130 | mp131 | mp132 | mp133 | mp134 | mp135 | mp136 | mp137 | mp138 | mp139 | mp14 | mp140 | mp141 | mp142 | mp143 | mp144 | mp145 | mp146 | mp147 | mp148 | mp149 | mp15 | mp150 | mp151 | mp152 | mp153 | mp154 | mp155 | mp156 | mp157 | mp158 | mp159 | mp16 | mp160 | mp161 | mp162 | mp163 | mp164 | mp165 | mp166 | mp167 | mp168 | mp169 | mp17 | mp170 | mp171 | mp172 | mp173 | mp174 | mp175 | mp176 | mp177 | mp178 | mp179 | mp18 | mp180 | mp181 | mp182 | mp183 | mp184 | mp185 | mp186 | mp187 | mp188 | mp189 | mp19 | mp190 | mp191 | mp192 | mp193 | mp194 | mp195 | mp196 | mp197 | mp198 | mp199 | mp2 | mp20 | mp200 | mp201 | mp202 | mp203 | mp204 | mp205 | mp206 | mp207 | mp208 | mp209 | mp21 | mp210 | mp211 | mp212 | mp213 | mp214 | mp215 | mp216 | mp217 | mp218 | mp219 | mp22 | mp220 | mp221 | mp222 | mp223 | mp224 | mp225 | mp226 | mp227 | mp228 | mp229 | mp23 | mp230 | mp231 | mp232 | mp233 | mp234 | mp235 | mp236 | mp237 | mp238 | mp239 | mp24 | mp240 | mp241 | mp242 | mp243 | mp244 | mp245 | mp246 | mp247 | mp248 | mp249 | mp25 | mp250 | mp251 | mp252 | mp253 | mp254 | mp255 | mp26 | mp27 | mp28 | mp29 | mp3 | mp30 | mp31 | mp32 | mp33 | mp34 | mp35 | mp36 | mp37 | mp38 | mp39 | mp4 | mp40 | mp41 | mp42 | mp43 | mp44 | mp45 | mp46 | mp47 | mp48 | mp49 | mp5 | mp50 | mp51 | mp52 | mp53 | mp54 | mp55 | mp56 | mp57 | mp58 | mp59 | mp6 | mp60 | mp61 | mp62 | mp63 | mp64 | mp65 | mp66 | mp67 | mp68 | mp69 | mp7 | mp70 | mp71 | mp72 | mp73 | mp74 | mp75 | mp76 | mp77 | mp78 | mp79 | mp8 | mp80 | mp81 | mp82 | mp83 | mp84 | mp85 | mp86 | mp87 | mp88 | mp89 | mp9 | mp90 | mp91 | mp92 | mp93 | mp94 | mp95 | mp96 | mp97 | mp98 | mp99 | rootfs>` ::
534 The disk you want to resize.
536 `<size>`: `\+?\d+(\.\d+)?[KMGT]?` ::
538 The new size. With the '+' sign the value is added to the actual size of the volume and without it, the value is taken as an absolute one. Shrinking disk size is not supported.
540 `--digest` `<string>` ::
542 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
544 *pct restore* `<vmid> <ostemplate>` `[OPTIONS]`
546 Create or restore a container.
548 `<vmid>`: `<integer> (1 - N)` ::
550 The (unique) ID of the VM.
552 `<ostemplate>`: `<string>` ::
554 The OS template or backup file.
556 `--arch` `<amd64 | arm64 | armhf | i386>` ('default =' `amd64`)::
558 OS architecture type.
560 `--bwlimit` `<number> (0 - N)` ('default =' `restore limit from datacenter or storage config`)::
562 Override I/O bandwidth limit (in KiB/s).
564 `--cmode` `<console | shell | tty>` ('default =' `tty`)::
566 Console mode. By default, the console command tries to open a connection to one of the available tty devices. By setting cmode to 'console' it tries to attach to /dev/console instead. If you set cmode to 'shell', it simply invokes a shell inside the container (no login).
568 `--console` `<boolean>` ('default =' `1`)::
570 Attach a console device (/dev/console) to the container.
572 `--cores` `<integer> (1 - 8192)` ::
574 The number of cores assigned to the container. A container can use all available cores by default.
576 `--cpulimit` `<number> (0 - 8192)` ('default =' `0`)::
580 NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.
582 `--cpuunits` `<integer> (0 - 500000)` ('default =' `1024`)::
584 CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to the weights of all the other running VMs.
586 NOTE: You can disable fair-scheduler configuration by setting this to 0.
588 `--debug` `<boolean>` ('default =' `0`)::
590 Try to be more verbose. For now this only enables debug log-level on start.
592 `--description` `<string>` ::
594 Container description. Only used on the configuration web interface.
596 `--features` `[force_rw_sys=<1|0>] [,fuse=<1|0>] [,keyctl=<1|0>] [,mknod=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
598 Allow containers access to advanced features.
600 `--force` `<boolean>` ::
602 Allow to overwrite existing container.
604 `--hookscript` `<string>` ::
606 Script that will be exectued during various steps in the containers lifetime.
608 `--hostname` `<string>` ::
610 Set a host name for the container.
612 `--ignore-unpack-errors` `<boolean>` ::
614 Ignore errors when extracting the template.
616 `--lock` `<backup | create | destroyed | disk | fstrim | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
620 `--memory` `<integer> (16 - N)` ('default =' `512`)::
622 Amount of RAM for the VM in MB.
624 `--mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
626 Use volume as container mount point.
628 `--nameserver` `<string>` ::
630 Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
632 `--net[n]` `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
634 Specifies network interfaces for the container.
636 `--onboot` `<boolean>` ('default =' `0`)::
638 Specifies whether a VM will be started during system bootup.
640 `--ostype` `<alpine | archlinux | centos | debian | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
642 OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used to skip and OS specific setup.
644 `--password` `<password>` ::
646 Sets root password inside container.
648 `--pool` `<string>` ::
650 Add the VM to the specified pool.
652 `--protection` `<boolean>` ('default =' `0`)::
654 Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
656 `--rootfs` `[volume=]<volume> [,acl=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
658 Use volume as container root.
660 `--searchdomain` `<string>` ::
662 Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
664 `--ssh-public-keys` `<filepath>` ::
666 Setup public SSH keys (one key per line, OpenSSH format).
668 `--start` `<boolean>` ('default =' `0`)::
670 Start the CT after its creation finished successfully.
672 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
674 Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.
676 `--storage` `<string>` ('default =' `local`)::
680 `--swap` `<integer> (0 - N)` ('default =' `512`)::
682 Amount of SWAP for the VM in MB.
684 `--tags` `<string>` ::
686 Tags of the Container. This is only meta information.
688 `--template` `<boolean>` ('default =' `0`)::
690 Enable/disable Template.
692 `--timezone` `<string>` ::
694 Time zone to use in the container. If option isn't set, then nothing will be done. Can be set to 'host' to match the host time zone, or an arbitrary time zone option from /usr/share/zoneinfo/zone.tab
696 `--tty` `<integer> (0 - 6)` ('default =' `2`)::
698 Specify the number of tty available to the container
700 `--unique` `<boolean>` ::
702 Assign a unique random ethernet address.
704 NOTE: Requires option(s): `restore`
706 `--unprivileged` `<boolean>` ('default =' `0`)::
708 Makes the container run as unprivileged user. (Should not be modified manually.)
710 `--unused[n]` `[volume=]<volume>` ::
712 Reference to unused volumes. This is used internally, and should not be modified manually.
714 *pct resume* `<vmid>`
716 Resume the container.
718 `<vmid>`: `<integer> (1 - N)` ::
720 The (unique) ID of the VM.
722 *pct rollback* `<vmid> <snapname>`
724 Rollback LXC state to specified snapshot.
726 `<vmid>`: `<integer> (1 - N)` ::
728 The (unique) ID of the VM.
730 `<snapname>`: `<string>` ::
732 The name of the snapshot.
734 *pct set* `<vmid>` `[OPTIONS]`
736 Set container options.
738 `<vmid>`: `<integer> (1 - N)` ::
740 The (unique) ID of the VM.
742 `--arch` `<amd64 | arm64 | armhf | i386>` ('default =' `amd64`)::
744 OS architecture type.
746 `--cmode` `<console | shell | tty>` ('default =' `tty`)::
748 Console mode. By default, the console command tries to open a connection to one of the available tty devices. By setting cmode to 'console' it tries to attach to /dev/console instead. If you set cmode to 'shell', it simply invokes a shell inside the container (no login).
750 `--console` `<boolean>` ('default =' `1`)::
752 Attach a console device (/dev/console) to the container.
754 `--cores` `<integer> (1 - 8192)` ::
756 The number of cores assigned to the container. A container can use all available cores by default.
758 `--cpulimit` `<number> (0 - 8192)` ('default =' `0`)::
762 NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.
764 `--cpuunits` `<integer> (0 - 500000)` ('default =' `1024`)::
766 CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to the weights of all the other running VMs.
768 NOTE: You can disable fair-scheduler configuration by setting this to 0.
770 `--debug` `<boolean>` ('default =' `0`)::
772 Try to be more verbose. For now this only enables debug log-level on start.
774 `--delete` `<string>` ::
776 A list of settings you want to delete.
778 `--description` `<string>` ::
780 Container description. Only used on the configuration web interface.
782 `--digest` `<string>` ::
784 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
786 `--features` `[force_rw_sys=<1|0>] [,fuse=<1|0>] [,keyctl=<1|0>] [,mknod=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
788 Allow containers access to advanced features.
790 `--hookscript` `<string>` ::
792 Script that will be exectued during various steps in the containers lifetime.
794 `--hostname` `<string>` ::
796 Set a host name for the container.
798 `--lock` `<backup | create | destroyed | disk | fstrim | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
802 `--memory` `<integer> (16 - N)` ('default =' `512`)::
804 Amount of RAM for the VM in MB.
806 `--mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
808 Use volume as container mount point.
810 `--nameserver` `<string>` ::
812 Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
814 `--net[n]` `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
816 Specifies network interfaces for the container.
818 `--onboot` `<boolean>` ('default =' `0`)::
820 Specifies whether a VM will be started during system bootup.
822 `--ostype` `<alpine | archlinux | centos | debian | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
824 OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used to skip and OS specific setup.
826 `--protection` `<boolean>` ('default =' `0`)::
828 Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
830 `--revert` `<string>` ::
832 Revert a pending change.
834 `--rootfs` `[volume=]<volume> [,acl=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
836 Use volume as container root.
838 `--searchdomain` `<string>` ::
840 Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
842 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
844 Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.
846 `--swap` `<integer> (0 - N)` ('default =' `512`)::
848 Amount of SWAP for the VM in MB.
850 `--tags` `<string>` ::
852 Tags of the Container. This is only meta information.
854 `--template` `<boolean>` ('default =' `0`)::
856 Enable/disable Template.
858 `--timezone` `<string>` ::
860 Time zone to use in the container. If option isn't set, then nothing will be done. Can be set to 'host' to match the host time zone, or an arbitrary time zone option from /usr/share/zoneinfo/zone.tab
862 `--tty` `<integer> (0 - 6)` ('default =' `2`)::
864 Specify the number of tty available to the container
866 `--unprivileged` `<boolean>` ('default =' `0`)::
868 Makes the container run as unprivileged user. (Should not be modified manually.)
870 `--unused[n]` `[volume=]<volume>` ::
872 Reference to unused volumes. This is used internally, and should not be modified manually.
874 *pct shutdown* `<vmid>` `[OPTIONS]`
876 Shutdown the container. This will trigger a clean shutdown of the
877 container, see lxc-stop(1) for details.
879 `<vmid>`: `<integer> (1 - N)` ::
881 The (unique) ID of the VM.
883 `--forceStop` `<boolean>` ('default =' `0`)::
885 Make sure the Container stops.
887 `--timeout` `<integer> (0 - N)` ('default =' `60`)::
889 Wait maximal timeout seconds.
891 *pct snapshot* `<vmid> <snapname>` `[OPTIONS]`
893 Snapshot a container.
895 `<vmid>`: `<integer> (1 - N)` ::
897 The (unique) ID of the VM.
899 `<snapname>`: `<string>` ::
901 The name of the snapshot.
903 `--description` `<string>` ::
905 A textual description or comment.
907 *pct start* `<vmid>` `[OPTIONS]`
911 `<vmid>`: `<integer> (1 - N)` ::
913 The (unique) ID of the VM.
915 `--debug` `<boolean>` ('default =' `0`)::
917 If set, enables very verbose debug log-level on start.
919 `--skiplock` `<boolean>` ::
921 Ignore locks - only root is allowed to use this option.
923 *pct status* `<vmid>` `[OPTIONS]`
927 `<vmid>`: `<integer> (1 - N)` ::
929 The (unique) ID of the VM.
931 `--verbose` `<boolean>` ::
933 Verbose output format
935 *pct stop* `<vmid>` `[OPTIONS]`
937 Stop the container. This will abruptly stop all processes running in the
940 `<vmid>`: `<integer> (1 - N)` ::
942 The (unique) ID of the VM.
944 `--skiplock` `<boolean>` ::
946 Ignore locks - only root is allowed to use this option.
948 *pct suspend* `<vmid>`
950 Suspend the container.
952 `<vmid>`: `<integer> (1 - N)` ::
954 The (unique) ID of the VM.
956 *pct template* `<vmid>`
960 `<vmid>`: `<integer> (1 - N)` ::
962 The (unique) ID of the VM.
964 *pct unlock* `<vmid>`
968 `<vmid>`: `<integer> (1 - N)` ::
970 The (unique) ID of the VM.
972 *pct unmount* `<vmid>`
974 Unmount the container's filesystem.
976 `<vmid>`: `<integer> (1 - N)` ::
978 The (unique) ID of the VM.