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