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