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 `--description` `<string>` ::
17 Description for the new CT.
19 `--full` `<boolean>` ::
21 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.
23 `--hostname` `<string>` ::
25 Set a hostname for the new CT.
27 `--pool` `<string>` ::
29 Add the new CT to the specified pool.
31 `--snapname` `<string>` ::
33 The name of the snapshot.
35 `--storage` `<string>` ::
37 Target storage for full clone.
39 `--target` `<string>` ::
41 Target node. Only allowed if the original VM is on shared storage.
43 *pct config* `<vmid>` `[OPTIONS]`
45 Get container configuration.
47 `<vmid>`: `<integer> (1 - N)` ::
49 The (unique) ID of the VM.
51 `--snapshot` `<string>` ::
53 Fetch config values from given snapshot.
55 *pct console* `<vmid>` `[OPTIONS]`
57 Launch a console for the specified container.
59 `<vmid>`: `<integer> (1 - N)` ::
61 The (unique) ID of the VM.
63 `--escape` `\^?[a-z]` ('default =' `^a`)::
65 Escape sequence prefix. For example to use <Ctrl+b q> as the escape sequence pass '^b'.
69 Print the list of assigned CPU sets.
71 *pct create* `<vmid> <ostemplate>` `[OPTIONS]`
73 Create or restore a container.
75 `<vmid>`: `<integer> (1 - N)` ::
77 The (unique) ID of the VM.
79 `<ostemplate>`: `<string>` ::
81 The OS template or backup file.
83 `--arch` `<amd64 | arm64 | armhf | i386>` ('default =' `amd64`)::
87 `--bwlimit` `<number> (0 - N)` ::
89 Override i/o bandwidth limit (in KiB/s).
91 `--cmode` `<console | shell | tty>` ('default =' `tty`)::
93 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).
95 `--console` `<boolean>` ('default =' `1`)::
97 Attach a console device (/dev/console) to the container.
99 `--cores` `<integer> (1 - 128)` ::
101 The number of cores assigned to the container. A container can use all available cores by default.
103 `--cpulimit` `<number> (0 - 128)` ('default =' `0`)::
107 NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.
109 `--cpuunits` `<integer> (0 - 500000)` ('default =' `1024`)::
111 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.
113 NOTE: You can disable fair-scheduler configuration by setting this to 0.
115 `--description` `<string>` ::
117 Container description. Only used on the configuration web interface.
119 `--features` `[fuse=<1|0>] [,keyctl=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
121 Allow containers access to advanced features.
123 `--force` `<boolean>` ::
125 Allow to overwrite existing container.
127 `--hookscript` `<string>` ::
129 Script that will be exectued during various steps in the containers lifetime.
131 `--hostname` `<string>` ::
133 Set a host name for the container.
135 `--ignore-unpack-errors` `<boolean>` ::
137 Ignore errors when extracting the template.
139 `--lock` `<backup | disk | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
143 `--memory` `<integer> (16 - N)` ('default =' `512`)::
145 Amount of RAM for the VM in MB.
147 `--mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
149 Use volume as container mount point.
151 `--nameserver` `<string>` ::
153 Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
155 `--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>]` ::
157 Specifies network interfaces for the container.
159 `--onboot` `<boolean>` ('default =' `0`)::
161 Specifies whether a VM will be started during system bootup.
163 `--ostype` `<alpine | archlinux | centos | debian | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
165 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.
167 `--password` `<password>` ::
169 Sets root password inside container.
171 `--pool` `<string>` ::
173 Add the VM to the specified pool.
175 `--protection` `<boolean>` ('default =' `0`)::
177 Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
179 `--restore` `<boolean>` ::
181 Mark this as restore task.
183 `--rootfs` `[volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
185 Use volume as container root.
187 `--searchdomain` `<string>` ::
189 Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
191 `--ssh-public-keys` `<filepath>` ::
193 Setup public SSH keys (one key per line, OpenSSH format).
195 `--start` `<boolean>` ('default =' `0`)::
197 Start the CT after its creation finished successfully.
199 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
201 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.
203 `--storage` `<string>` ('default =' `local`)::
207 `--swap` `<integer> (0 - N)` ('default =' `512`)::
209 Amount of SWAP for the VM in MB.
211 `--template` `<boolean>` ('default =' `0`)::
213 Enable/disable Template.
215 `--tty` `<integer> (0 - 6)` ('default =' `2`)::
217 Specify the number of tty available to the container
219 `--unprivileged` `<boolean>` ('default =' `0`)::
221 Makes the container run as unprivileged user. (Should not be modified manually.)
223 `--unused[n]` `<string>` ::
225 Reference to unused volumes. This is used internally, and should not be modified manually.
227 *pct delsnapshot* `<vmid> <snapname>` `[OPTIONS]`
229 Delete a LXC snapshot.
231 `<vmid>`: `<integer> (1 - N)` ::
233 The (unique) ID of the VM.
235 `<snapname>`: `<string>` ::
237 The name of the snapshot.
239 `--force` `<boolean>` ::
241 For removal from config file, even if removing disk snapshots fails.
243 *pct destroy* `<vmid>`
245 Destroy the container (also delete all uses files).
247 `<vmid>`: `<integer> (1 - N)` ::
249 The (unique) ID of the VM.
253 Get the container's current disk usage.
255 `<vmid>`: `<integer> (1 - N)` ::
257 The (unique) ID of the VM.
261 Launch a shell for the specified container.
263 `<vmid>`: `<integer> (1 - N)` ::
265 The (unique) ID of the VM.
267 *pct exec* `<vmid> [<extra-args>]`
269 Launch a command inside the specified container.
271 `<vmid>`: `<integer> (1 - N)` ::
273 The (unique) ID of the VM.
275 `<extra-args>`: `<array>` ::
277 Extra arguments as array
279 *pct fsck* `<vmid>` `[OPTIONS]`
281 Run a filesystem check (fsck) on a container volume.
283 `<vmid>`: `<integer> (1 - N)` ::
285 The (unique) ID of the VM.
287 `--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>` ::
289 A volume on which to run the filesystem check
291 `--force` `<boolean>` ('default =' `0`)::
293 Force checking, even if the filesystem seems clean
295 *pct help* `[OPTIONS]`
297 Get help about specified command.
299 `--extra-args` `<array>` ::
301 Shows help for a specific command
303 `--verbose` `<boolean>` ::
305 Verbose output format.
309 LXC container index (per node).
311 *pct listsnapshot* `<vmid>`
315 `<vmid>`: `<integer> (1 - N)` ::
317 The (unique) ID of the VM.
319 *pct migrate* `<vmid> <target>` `[OPTIONS]`
321 Migrate the container to another node. Creates a new migration task.
323 `<vmid>`: `<integer> (1 - N)` ::
325 The (unique) ID of the VM.
327 `<target>`: `<string>` ::
331 `--force` `<boolean>` ::
333 Force migration despite local bind / device mounts. NOTE: deprecated, use 'shared' property of mount point instead.
335 `--online` `<boolean>` ::
337 Use online/live migration.
339 `--restart` `<boolean>` ::
341 Use restart migration
343 `--timeout` `<integer>` ('default =' `180`)::
345 Timeout in seconds for shutdown for restart migration
349 Mount the container's filesystem on the host. This will hold a lock on the
350 container and is meant for emergency maintenance only as it will prevent
351 further operations on the container other than start and stop.
353 `<vmid>`: `<integer> (1 - N)` ::
355 The (unique) ID of the VM.
357 *pct move_volume* `<vmid> <volume> <storage>` `[OPTIONS]`
359 Move a rootfs-/mp-volume to a different storage
361 `<vmid>`: `<integer> (1 - N)` ::
363 The (unique) ID of the VM.
365 `<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>` ::
367 Volume which will be moved.
369 `<storage>`: `<string>` ::
373 `--delete` `<boolean>` ('default =' `0`)::
375 Delete the original volume after successful copy. By default the original is kept as an unused volume entry.
377 `--digest` `<string>` ::
379 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
381 *pct pull* `<vmid> <path> <destination>` `[OPTIONS]`
383 Copy a file from the container to the local system.
385 `<vmid>`: `<integer> (1 - N)` ::
387 The (unique) ID of the VM.
389 `<path>`: `<string>` ::
391 Path to a file inside the container to pull.
393 `<destination>`: `<string>` ::
397 `--group` `<string>` ::
399 Owner group name or id.
401 `--perms` `<string>` ::
403 File permissions to use (octal by default, prefix with '0x' for hexadecimal).
405 `--user` `<string>` ::
407 Owner user name or id.
409 *pct push* `<vmid> <file> <destination>` `[OPTIONS]`
411 Copy a local file to the container.
413 `<vmid>`: `<integer> (1 - N)` ::
415 The (unique) ID of the VM.
417 `<file>`: `<string>` ::
419 Path to a local file.
421 `<destination>`: `<string>` ::
423 Destination inside the container to write to.
425 `--group` `<string>` ::
427 Owner group name or id. When using a name it must exist inside the container.
429 `--perms` `<string>` ::
431 File permissions to use (octal by default, prefix with '0x' for hexadecimal).
433 `--user` `<string>` ::
435 Owner user name or id. When using a name it must exist inside the container.
437 *pct rescan* `[OPTIONS]`
439 Rescan all storages and update disk sizes and unused disk images.
441 `--dryrun` `<boolean>` ('default =' `0`)::
443 Do not actually write changes out to conifg.
445 `--vmid` `<integer> (1 - N)` ::
447 The (unique) ID of the VM.
449 *pct resize* `<vmid> <disk> <size>` `[OPTIONS]`
451 Resize a container mount point.
453 `<vmid>`: `<integer> (1 - N)` ::
455 The (unique) ID of the VM.
457 `<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>` ::
459 The disk you want to resize.
461 `<size>`: `\+?\d+(\.\d+)?[KMGT]?` ::
463 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.
465 `--digest` `<string>` ::
467 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
469 *pct restore* `<vmid> <ostemplate>` `[OPTIONS]`
471 Create or restore a container.
473 `<vmid>`: `<integer> (1 - N)` ::
475 The (unique) ID of the VM.
477 `<ostemplate>`: `<string>` ::
479 The OS template or backup file.
481 `--arch` `<amd64 | arm64 | armhf | i386>` ('default =' `amd64`)::
483 OS architecture type.
485 `--bwlimit` `<number> (0 - N)` ::
487 Override i/o bandwidth limit (in KiB/s).
489 `--cmode` `<console | shell | tty>` ('default =' `tty`)::
491 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).
493 `--console` `<boolean>` ('default =' `1`)::
495 Attach a console device (/dev/console) to the container.
497 `--cores` `<integer> (1 - 128)` ::
499 The number of cores assigned to the container. A container can use all available cores by default.
501 `--cpulimit` `<number> (0 - 128)` ('default =' `0`)::
505 NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.
507 `--cpuunits` `<integer> (0 - 500000)` ('default =' `1024`)::
509 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.
511 NOTE: You can disable fair-scheduler configuration by setting this to 0.
513 `--description` `<string>` ::
515 Container description. Only used on the configuration web interface.
517 `--features` `[fuse=<1|0>] [,keyctl=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
519 Allow containers access to advanced features.
521 `--force` `<boolean>` ::
523 Allow to overwrite existing container.
525 `--hookscript` `<string>` ::
527 Script that will be exectued during various steps in the containers lifetime.
529 `--hostname` `<string>` ::
531 Set a host name for the container.
533 `--ignore-unpack-errors` `<boolean>` ::
535 Ignore errors when extracting the template.
537 `--lock` `<backup | disk | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
541 `--memory` `<integer> (16 - N)` ('default =' `512`)::
543 Amount of RAM for the VM in MB.
545 `--mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
547 Use volume as container mount point.
549 `--nameserver` `<string>` ::
551 Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
553 `--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>]` ::
555 Specifies network interfaces for the container.
557 `--onboot` `<boolean>` ('default =' `0`)::
559 Specifies whether a VM will be started during system bootup.
561 `--ostype` `<alpine | archlinux | centos | debian | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
563 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.
565 `--password` `<password>` ::
567 Sets root password inside container.
569 `--pool` `<string>` ::
571 Add the VM to the specified pool.
573 `--protection` `<boolean>` ('default =' `0`)::
575 Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
577 `--rootfs` `[volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
579 Use volume as container root.
581 `--searchdomain` `<string>` ::
583 Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
585 `--ssh-public-keys` `<filepath>` ::
587 Setup public SSH keys (one key per line, OpenSSH format).
589 `--start` `<boolean>` ('default =' `0`)::
591 Start the CT after its creation finished successfully.
593 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
595 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.
597 `--storage` `<string>` ('default =' `local`)::
601 `--swap` `<integer> (0 - N)` ('default =' `512`)::
603 Amount of SWAP for the VM in MB.
605 `--template` `<boolean>` ('default =' `0`)::
607 Enable/disable Template.
609 `--tty` `<integer> (0 - 6)` ('default =' `2`)::
611 Specify the number of tty available to the container
613 `--unprivileged` `<boolean>` ('default =' `0`)::
615 Makes the container run as unprivileged user. (Should not be modified manually.)
617 `--unused[n]` `<string>` ::
619 Reference to unused volumes. This is used internally, and should not be modified manually.
621 *pct resume* `<vmid>`
623 Resume the container.
625 `<vmid>`: `<integer> (1 - N)` ::
627 The (unique) ID of the VM.
629 *pct rollback* `<vmid> <snapname>`
631 Rollback LXC state to specified snapshot.
633 `<vmid>`: `<integer> (1 - N)` ::
635 The (unique) ID of the VM.
637 `<snapname>`: `<string>` ::
639 The name of the snapshot.
641 *pct set* `<vmid>` `[OPTIONS]`
643 Set container options.
645 `<vmid>`: `<integer> (1 - N)` ::
647 The (unique) ID of the VM.
649 `--arch` `<amd64 | arm64 | armhf | i386>` ('default =' `amd64`)::
651 OS architecture type.
653 `--cmode` `<console | shell | tty>` ('default =' `tty`)::
655 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).
657 `--console` `<boolean>` ('default =' `1`)::
659 Attach a console device (/dev/console) to the container.
661 `--cores` `<integer> (1 - 128)` ::
663 The number of cores assigned to the container. A container can use all available cores by default.
665 `--cpulimit` `<number> (0 - 128)` ('default =' `0`)::
669 NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.
671 `--cpuunits` `<integer> (0 - 500000)` ('default =' `1024`)::
673 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.
675 NOTE: You can disable fair-scheduler configuration by setting this to 0.
677 `--delete` `<string>` ::
679 A list of settings you want to delete.
681 `--description` `<string>` ::
683 Container description. Only used on the configuration web interface.
685 `--digest` `<string>` ::
687 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
689 `--features` `[fuse=<1|0>] [,keyctl=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
691 Allow containers access to advanced features.
693 `--hookscript` `<string>` ::
695 Script that will be exectued during various steps in the containers lifetime.
697 `--hostname` `<string>` ::
699 Set a host name for the container.
701 `--lock` `<backup | disk | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
705 `--memory` `<integer> (16 - N)` ('default =' `512`)::
707 Amount of RAM for the VM in MB.
709 `--mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
711 Use volume as container mount point.
713 `--nameserver` `<string>` ::
715 Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
717 `--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>]` ::
719 Specifies network interfaces for the container.
721 `--onboot` `<boolean>` ('default =' `0`)::
723 Specifies whether a VM will be started during system bootup.
725 `--ostype` `<alpine | archlinux | centos | debian | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
727 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.
729 `--protection` `<boolean>` ('default =' `0`)::
731 Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
733 `--rootfs` `[volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
735 Use volume as container root.
737 `--searchdomain` `<string>` ::
739 Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
741 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
743 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.
745 `--swap` `<integer> (0 - N)` ('default =' `512`)::
747 Amount of SWAP for the VM in MB.
749 `--template` `<boolean>` ('default =' `0`)::
751 Enable/disable Template.
753 `--tty` `<integer> (0 - 6)` ('default =' `2`)::
755 Specify the number of tty available to the container
757 `--unprivileged` `<boolean>` ('default =' `0`)::
759 Makes the container run as unprivileged user. (Should not be modified manually.)
761 `--unused[n]` `<string>` ::
763 Reference to unused volumes. This is used internally, and should not be modified manually.
765 *pct shutdown* `<vmid>` `[OPTIONS]`
767 Shutdown the container. This will trigger a clean shutdown of the
768 container, see lxc-stop(1) for details.
770 `<vmid>`: `<integer> (1 - N)` ::
772 The (unique) ID of the VM.
774 `--forceStop` `<boolean>` ('default =' `0`)::
776 Make sure the Container stops.
778 `--timeout` `<integer> (0 - N)` ('default =' `60`)::
780 Wait maximal timeout seconds.
782 *pct snapshot* `<vmid> <snapname>` `[OPTIONS]`
784 Snapshot a container.
786 `<vmid>`: `<integer> (1 - N)` ::
788 The (unique) ID of the VM.
790 `<snapname>`: `<string>` ::
792 The name of the snapshot.
794 `--description` `<string>` ::
796 A textual description or comment.
798 *pct start* `<vmid>` `[OPTIONS]`
802 `<vmid>`: `<integer> (1 - N)` ::
804 The (unique) ID of the VM.
806 `--skiplock` `<boolean>` ::
808 Ignore locks - only root is allowed to use this option.
810 *pct status* `<vmid>` `[OPTIONS]`
814 `<vmid>`: `<integer> (1 - N)` ::
816 The (unique) ID of the VM.
818 `--verbose` `<boolean>` ::
820 Verbose output format
822 *pct stop* `<vmid>` `[OPTIONS]`
824 Stop the container. This will abruptly stop all processes running in the
827 `<vmid>`: `<integer> (1 - N)` ::
829 The (unique) ID of the VM.
831 `--skiplock` `<boolean>` ::
833 Ignore locks - only root is allowed to use this option.
835 *pct suspend* `<vmid>`
837 Suspend the container.
839 `<vmid>`: `<integer> (1 - N)` ::
841 The (unique) ID of the VM.
843 *pct template* `<vmid>`
847 `<vmid>`: `<integer> (1 - N)` ::
849 The (unique) ID of the VM.
851 *pct unlock* `<vmid>`
855 `<vmid>`: `<integer> (1 - N)` ::
857 The (unique) ID of the VM.
859 *pct unmount* `<vmid>`
861 Unmount the container's filesystem.
863 `<vmid>`: `<integer> (1 - N)` ::
865 The (unique) ID of the VM.