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