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