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 - 128)` ::
109 The number of cores assigned to the container. A container can use all available cores by default.
111 `--cpulimit` `<number> (0 - 128)` ('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 `--description` `<string>` ::
125 Container description. Only used on the configuration web interface.
127 `--features` `[fuse=<1|0>] [,keyctl=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
129 Allow containers access to advanced features.
131 `--force` `<boolean>` ::
133 Allow to overwrite existing container.
135 `--hookscript` `<string>` ::
137 Script that will be exectued during various steps in the containers lifetime.
139 `--hostname` `<string>` ::
141 Set a host name for the container.
143 `--ignore-unpack-errors` `<boolean>` ::
145 Ignore errors when extracting the template.
147 `--lock` `<backup | create | destroyed | disk | fstrim | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
151 `--memory` `<integer> (16 - N)` ('default =' `512`)::
153 Amount of RAM for the VM in MB.
155 `--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>]` ::
157 Use volume as container mount point.
159 `--nameserver` `<string>` ::
161 Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
163 `--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>]` ::
165 Specifies network interfaces for the container.
167 `--onboot` `<boolean>` ('default =' `0`)::
169 Specifies whether a VM will be started during system bootup.
171 `--ostype` `<alpine | archlinux | centos | debian | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
173 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.
175 `--password` `<password>` ::
177 Sets root password inside container.
179 `--pool` `<string>` ::
181 Add the VM to the specified pool.
183 `--protection` `<boolean>` ('default =' `0`)::
185 Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
187 `--restore` `<boolean>` ::
189 Mark this as restore task.
191 `--rootfs` `[volume=]<volume> [,acl=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
193 Use volume as container root.
195 `--searchdomain` `<string>` ::
197 Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
199 `--ssh-public-keys` `<filepath>` ::
201 Setup public SSH keys (one key per line, OpenSSH format).
203 `--start` `<boolean>` ('default =' `0`)::
205 Start the CT after its creation finished successfully.
207 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
209 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.
211 `--storage` `<string>` ('default =' `local`)::
215 `--swap` `<integer> (0 - N)` ('default =' `512`)::
217 Amount of SWAP for the VM in MB.
219 `--tags` `<string>` ::
221 Tags of the Container. This is only meta information.
223 `--template` `<boolean>` ('default =' `0`)::
225 Enable/disable Template.
227 `--tty` `<integer> (0 - 6)` ('default =' `2`)::
229 Specify the number of tty available to the container
231 `--unique` `<boolean>` ::
233 Assign a unique random ethernet address.
235 NOTE: Requires option(s): `restore`
237 `--unprivileged` `<boolean>` ('default =' `0`)::
239 Makes the container run as unprivileged user. (Should not be modified manually.)
241 `--unused[n]` `<string>` ::
243 Reference to unused volumes. This is used internally, and should not be modified manually.
245 *pct delsnapshot* `<vmid> <snapname>` `[OPTIONS]`
247 Delete a LXC snapshot.
249 `<vmid>`: `<integer> (1 - N)` ::
251 The (unique) ID of the VM.
253 `<snapname>`: `<string>` ::
255 The name of the snapshot.
257 `--force` `<boolean>` ::
259 For removal from config file, even if removing disk snapshots fails.
261 *pct destroy* `<vmid>` `[OPTIONS]`
263 Destroy the container (also delete all uses files).
265 `<vmid>`: `<integer> (1 - N)` ::
267 The (unique) ID of the VM.
269 `--purge` `<boolean>` ::
271 Remove vmid from backup cron jobs.
275 Get the container's current disk usage.
277 `<vmid>`: `<integer> (1 - N)` ::
279 The (unique) ID of the VM.
283 Launch a shell for the specified container.
285 `<vmid>`: `<integer> (1 - N)` ::
287 The (unique) ID of the VM.
289 *pct exec* `<vmid> [<extra-args>]`
291 Launch a command inside the specified container.
293 `<vmid>`: `<integer> (1 - N)` ::
295 The (unique) ID of the VM.
297 `<extra-args>`: `<array>` ::
299 Extra arguments as array
301 *pct fsck* `<vmid>` `[OPTIONS]`
303 Run a filesystem check (fsck) on a container volume.
305 `<vmid>`: `<integer> (1 - N)` ::
307 The (unique) ID of the VM.
309 `--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>` ::
311 A volume on which to run the filesystem check
313 `--force` `<boolean>` ('default =' `0`)::
315 Force checking, even if the filesystem seems clean
317 *pct fstrim* `<vmid>`
319 Run fstrim on a chosen CT and its mountpoints.
321 `<vmid>`: `<integer> (1 - N)` ::
323 The (unique) ID of the VM.
325 *pct help* `[OPTIONS]`
327 Get help about specified command.
329 `--extra-args` `<array>` ::
331 Shows help for a specific command
333 `--verbose` `<boolean>` ::
335 Verbose output format.
339 LXC container index (per node).
341 *pct listsnapshot* `<vmid>`
345 `<vmid>`: `<integer> (1 - N)` ::
347 The (unique) ID of the VM.
349 *pct migrate* `<vmid> <target>` `[OPTIONS]`
351 Migrate the container to another node. Creates a new migration task.
353 `<vmid>`: `<integer> (1 - N)` ::
355 The (unique) ID of the VM.
357 `<target>`: `<string>` ::
361 `--bwlimit` `<number> (0 - N)` ('default =' `migrate limit from datacenter or storage config`)::
363 Override I/O bandwidth limit (in KiB/s).
365 `--force` `<boolean>` ::
367 Force migration despite local bind / device mounts. NOTE: deprecated, use 'shared' property of mount point instead.
369 `--online` `<boolean>` ::
371 Use online/live migration.
373 `--restart` `<boolean>` ::
375 Use restart migration
377 `--timeout` `<integer>` ('default =' `180`)::
379 Timeout in seconds for shutdown for restart migration
383 Mount the container's filesystem on the host. This will hold a lock on the
384 container and is meant for emergency maintenance only as it will prevent
385 further operations on the container other than start and stop.
387 `<vmid>`: `<integer> (1 - N)` ::
389 The (unique) ID of the VM.
391 *pct move_volume* `<vmid> <volume> <storage>` `[OPTIONS]`
393 Move a rootfs-/mp-volume to a different storage
395 `<vmid>`: `<integer> (1 - N)` ::
397 The (unique) ID of the VM.
399 `<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>` ::
401 Volume which will be moved.
403 `<storage>`: `<string>` ::
407 `--bwlimit` `<number> (0 - N)` ('default =' `clone limit from datacenter or storage config`)::
409 Override I/O bandwidth limit (in KiB/s).
411 `--delete` `<boolean>` ('default =' `0`)::
413 Delete the original volume after successful copy. By default the original is kept as an unused volume entry.
415 `--digest` `<string>` ::
417 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
419 *pct pending* `<vmid>`
421 Get container configuration, including pending changes.
423 `<vmid>`: `<integer> (1 - N)` ::
425 The (unique) ID of the VM.
427 *pct pull* `<vmid> <path> <destination>` `[OPTIONS]`
429 Copy a file from the container to the local system.
431 `<vmid>`: `<integer> (1 - N)` ::
433 The (unique) ID of the VM.
435 `<path>`: `<string>` ::
437 Path to a file inside the container to pull.
439 `<destination>`: `<string>` ::
443 `--group` `<string>` ::
445 Owner group name or id.
447 `--perms` `<string>` ::
449 File permissions to use (octal by default, prefix with '0x' for hexadecimal).
451 `--user` `<string>` ::
453 Owner user name or id.
455 *pct push* `<vmid> <file> <destination>` `[OPTIONS]`
457 Copy a local file to the container.
459 `<vmid>`: `<integer> (1 - N)` ::
461 The (unique) ID of the VM.
463 `<file>`: `<string>` ::
465 Path to a local file.
467 `<destination>`: `<string>` ::
469 Destination inside the container to write to.
471 `--group` `<string>` ::
473 Owner group name or id. When using a name it must exist inside the container.
475 `--perms` `<string>` ::
477 File permissions to use (octal by default, prefix with '0x' for hexadecimal).
479 `--user` `<string>` ::
481 Owner user name or id. When using a name it must exist inside the container.
483 *pct reboot* `<vmid>` `[OPTIONS]`
485 Reboot the container by shutting it down, and starting it again. Applies
488 `<vmid>`: `<integer> (1 - N)` ::
490 The (unique) ID of the VM.
492 `--timeout` `<integer> (0 - N)` ::
494 Wait maximal timeout seconds for the shutdown.
496 *pct rescan* `[OPTIONS]`
498 Rescan all storages and update disk sizes and unused disk images.
500 `--dryrun` `<boolean>` ('default =' `0`)::
502 Do not actually write changes out to conifg.
504 `--vmid` `<integer> (1 - N)` ::
506 The (unique) ID of the VM.
508 *pct resize* `<vmid> <disk> <size>` `[OPTIONS]`
510 Resize a container mount point.
512 `<vmid>`: `<integer> (1 - N)` ::
514 The (unique) ID of the VM.
516 `<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>` ::
518 The disk you want to resize.
520 `<size>`: `\+?\d+(\.\d+)?[KMGT]?` ::
522 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.
524 `--digest` `<string>` ::
526 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
528 *pct restore* `<vmid> <ostemplate>` `[OPTIONS]`
530 Create or restore a container.
532 `<vmid>`: `<integer> (1 - N)` ::
534 The (unique) ID of the VM.
536 `<ostemplate>`: `<string>` ::
538 The OS template or backup file.
540 `--arch` `<amd64 | arm64 | armhf | i386>` ('default =' `amd64`)::
542 OS architecture type.
544 `--bwlimit` `<number> (0 - N)` ('default =' `restore limit from datacenter or storage config`)::
546 Override I/O bandwidth limit (in KiB/s).
548 `--cmode` `<console | shell | tty>` ('default =' `tty`)::
550 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).
552 `--console` `<boolean>` ('default =' `1`)::
554 Attach a console device (/dev/console) to the container.
556 `--cores` `<integer> (1 - 128)` ::
558 The number of cores assigned to the container. A container can use all available cores by default.
560 `--cpulimit` `<number> (0 - 128)` ('default =' `0`)::
564 NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.
566 `--cpuunits` `<integer> (0 - 500000)` ('default =' `1024`)::
568 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.
570 NOTE: You can disable fair-scheduler configuration by setting this to 0.
572 `--description` `<string>` ::
574 Container description. Only used on the configuration web interface.
576 `--features` `[fuse=<1|0>] [,keyctl=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
578 Allow containers access to advanced features.
580 `--force` `<boolean>` ::
582 Allow to overwrite existing container.
584 `--hookscript` `<string>` ::
586 Script that will be exectued during various steps in the containers lifetime.
588 `--hostname` `<string>` ::
590 Set a host name for the container.
592 `--ignore-unpack-errors` `<boolean>` ::
594 Ignore errors when extracting the template.
596 `--lock` `<backup | create | destroyed | disk | fstrim | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
600 `--memory` `<integer> (16 - N)` ('default =' `512`)::
602 Amount of RAM for the VM in MB.
604 `--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>]` ::
606 Use volume as container mount point.
608 `--nameserver` `<string>` ::
610 Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
612 `--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>]` ::
614 Specifies network interfaces for the container.
616 `--onboot` `<boolean>` ('default =' `0`)::
618 Specifies whether a VM will be started during system bootup.
620 `--ostype` `<alpine | archlinux | centos | debian | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
622 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.
624 `--password` `<password>` ::
626 Sets root password inside container.
628 `--pool` `<string>` ::
630 Add the VM to the specified pool.
632 `--protection` `<boolean>` ('default =' `0`)::
634 Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
636 `--rootfs` `[volume=]<volume> [,acl=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
638 Use volume as container root.
640 `--searchdomain` `<string>` ::
642 Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
644 `--ssh-public-keys` `<filepath>` ::
646 Setup public SSH keys (one key per line, OpenSSH format).
648 `--start` `<boolean>` ('default =' `0`)::
650 Start the CT after its creation finished successfully.
652 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
654 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.
656 `--storage` `<string>` ('default =' `local`)::
660 `--swap` `<integer> (0 - N)` ('default =' `512`)::
662 Amount of SWAP for the VM in MB.
664 `--tags` `<string>` ::
666 Tags of the Container. This is only meta information.
668 `--template` `<boolean>` ('default =' `0`)::
670 Enable/disable Template.
672 `--tty` `<integer> (0 - 6)` ('default =' `2`)::
674 Specify the number of tty available to the container
676 `--unique` `<boolean>` ::
678 Assign a unique random ethernet address.
680 NOTE: Requires option(s): `restore`
682 `--unprivileged` `<boolean>` ('default =' `0`)::
684 Makes the container run as unprivileged user. (Should not be modified manually.)
686 `--unused[n]` `<string>` ::
688 Reference to unused volumes. This is used internally, and should not be modified manually.
690 *pct resume* `<vmid>`
692 Resume the container.
694 `<vmid>`: `<integer> (1 - N)` ::
696 The (unique) ID of the VM.
698 *pct rollback* `<vmid> <snapname>`
700 Rollback LXC state to specified snapshot.
702 `<vmid>`: `<integer> (1 - N)` ::
704 The (unique) ID of the VM.
706 `<snapname>`: `<string>` ::
708 The name of the snapshot.
710 *pct set* `<vmid>` `[OPTIONS]`
712 Set container options.
714 `<vmid>`: `<integer> (1 - N)` ::
716 The (unique) ID of the VM.
718 `--arch` `<amd64 | arm64 | armhf | i386>` ('default =' `amd64`)::
720 OS architecture type.
722 `--cmode` `<console | shell | tty>` ('default =' `tty`)::
724 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).
726 `--console` `<boolean>` ('default =' `1`)::
728 Attach a console device (/dev/console) to the container.
730 `--cores` `<integer> (1 - 128)` ::
732 The number of cores assigned to the container. A container can use all available cores by default.
734 `--cpulimit` `<number> (0 - 128)` ('default =' `0`)::
738 NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.
740 `--cpuunits` `<integer> (0 - 500000)` ('default =' `1024`)::
742 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.
744 NOTE: You can disable fair-scheduler configuration by setting this to 0.
746 `--delete` `<string>` ::
748 A list of settings you want to delete.
750 `--description` `<string>` ::
752 Container description. Only used on the configuration web interface.
754 `--digest` `<string>` ::
756 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
758 `--features` `[fuse=<1|0>] [,keyctl=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
760 Allow containers access to advanced features.
762 `--hookscript` `<string>` ::
764 Script that will be exectued during various steps in the containers lifetime.
766 `--hostname` `<string>` ::
768 Set a host name for the container.
770 `--lock` `<backup | create | destroyed | disk | fstrim | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
774 `--memory` `<integer> (16 - N)` ('default =' `512`)::
776 Amount of RAM for the VM in MB.
778 `--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>]` ::
780 Use volume as container mount point.
782 `--nameserver` `<string>` ::
784 Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
786 `--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>]` ::
788 Specifies network interfaces for the container.
790 `--onboot` `<boolean>` ('default =' `0`)::
792 Specifies whether a VM will be started during system bootup.
794 `--ostype` `<alpine | archlinux | centos | debian | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
796 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.
798 `--protection` `<boolean>` ('default =' `0`)::
800 Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
802 `--revert` `<string>` ::
804 Revert a pending change.
806 `--rootfs` `[volume=]<volume> [,acl=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
808 Use volume as container root.
810 `--searchdomain` `<string>` ::
812 Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
814 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
816 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.
818 `--swap` `<integer> (0 - N)` ('default =' `512`)::
820 Amount of SWAP for the VM in MB.
822 `--tags` `<string>` ::
824 Tags of the Container. This is only meta information.
826 `--template` `<boolean>` ('default =' `0`)::
828 Enable/disable Template.
830 `--tty` `<integer> (0 - 6)` ('default =' `2`)::
832 Specify the number of tty available to the container
834 `--unprivileged` `<boolean>` ('default =' `0`)::
836 Makes the container run as unprivileged user. (Should not be modified manually.)
838 `--unused[n]` `<string>` ::
840 Reference to unused volumes. This is used internally, and should not be modified manually.
842 *pct shutdown* `<vmid>` `[OPTIONS]`
844 Shutdown the container. This will trigger a clean shutdown of the
845 container, see lxc-stop(1) for details.
847 `<vmid>`: `<integer> (1 - N)` ::
849 The (unique) ID of the VM.
851 `--forceStop` `<boolean>` ('default =' `0`)::
853 Make sure the Container stops.
855 `--timeout` `<integer> (0 - N)` ('default =' `60`)::
857 Wait maximal timeout seconds.
859 *pct snapshot* `<vmid> <snapname>` `[OPTIONS]`
861 Snapshot a container.
863 `<vmid>`: `<integer> (1 - N)` ::
865 The (unique) ID of the VM.
867 `<snapname>`: `<string>` ::
869 The name of the snapshot.
871 `--description` `<string>` ::
873 A textual description or comment.
875 *pct start* `<vmid>` `[OPTIONS]`
879 `<vmid>`: `<integer> (1 - N)` ::
881 The (unique) ID of the VM.
883 `--skiplock` `<boolean>` ::
885 Ignore locks - only root is allowed to use this option.
887 *pct status* `<vmid>` `[OPTIONS]`
891 `<vmid>`: `<integer> (1 - N)` ::
893 The (unique) ID of the VM.
895 `--verbose` `<boolean>` ::
897 Verbose output format
899 *pct stop* `<vmid>` `[OPTIONS]`
901 Stop the container. This will abruptly stop all processes running in the
904 `<vmid>`: `<integer> (1 - N)` ::
906 The (unique) ID of the VM.
908 `--skiplock` `<boolean>` ::
910 Ignore locks - only root is allowed to use this option.
912 *pct suspend* `<vmid>`
914 Suspend the container.
916 `<vmid>`: `<integer> (1 - N)` ::
918 The (unique) ID of the VM.
920 *pct template* `<vmid>`
924 `<vmid>`: `<integer> (1 - N)` ::
926 The (unique) ID of the VM.
928 *pct unlock* `<vmid>`
932 `<vmid>`: `<integer> (1 - N)` ::
934 The (unique) ID of the VM.
936 *pct unmount* `<vmid>`
938 Unmount the container's filesystem.
940 `<vmid>`: `<integer> (1 - N)` ::
942 The (unique) ID of the VM.