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 - 8192)` ::
109 The number of cores assigned to the container. A container can use all available cores by default.
111 `--cpulimit` `<number> (0 - 8192)` ('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 =' `cgroup v1: 1024, cgroup v2: 100`)::
119 CPU weight for a container, will be clamped to [1, 10000] in cgroup v2.
121 `--debug` `<boolean>` ('default =' `0`)::
123 Try to be more verbose. For now this only enables debug log-level on start.
125 `--description` `<string>` ::
127 Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file.
129 `--features` `[force_rw_sys=<1|0>] [,fuse=<1|0>] [,keyctl=<1|0>] [,mknod=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
131 Allow containers access to advanced features.
133 `--force` `<boolean>` ::
135 Allow to overwrite existing container.
137 `--hookscript` `<string>` ::
139 Script that will be exectued during various steps in the containers lifetime.
141 `--hostname` `<string>` ::
143 Set a host name for the container.
145 `--ignore-unpack-errors` `<boolean>` ::
147 Ignore errors when extracting the template.
149 `--lock` `<backup | create | destroyed | disk | fstrim | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
151 Lock/unlock the container.
153 `--memory` `<integer> (16 - N)` ('default =' `512`)::
155 Amount of RAM for the container in MB.
157 `--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>]` ::
159 Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
161 `--nameserver` `<string>` ::
163 Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
165 `--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>]` ::
167 Specifies network interfaces for the container.
169 `--onboot` `<boolean>` ('default =' `0`)::
171 Specifies whether a container will be started during system bootup.
173 `--ostype` `<alpine | archlinux | centos | debian | devuan | fedora | gentoo | nixos | opensuse | ubuntu | unmanaged>` ::
175 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.
177 `--password` `<password>` ::
179 Sets root password inside container.
181 `--pool` `<string>` ::
183 Add the VM to the specified pool.
185 `--protection` `<boolean>` ('default =' `0`)::
187 Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
189 `--restore` `<boolean>` ::
191 Mark this as restore task.
193 `--rootfs` `[volume=]<volume> [,acl=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
195 Use volume as container root.
197 `--searchdomain` `<string>` ::
199 Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
201 `--ssh-public-keys` `<filepath>` ::
203 Setup public SSH keys (one key per line, OpenSSH format).
205 `--start` `<boolean>` ('default =' `0`)::
207 Start the CT after its creation finished successfully.
209 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
211 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.
213 `--storage` `<string>` ('default =' `local`)::
217 `--swap` `<integer> (0 - N)` ('default =' `512`)::
219 Amount of SWAP for the container in MB.
221 `--tags` `<string>` ::
223 Tags of the Container. This is only meta information.
225 `--template` `<boolean>` ('default =' `0`)::
227 Enable/disable Template.
229 `--timezone` `<string>` ::
231 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
233 `--tty` `<integer> (0 - 6)` ('default =' `2`)::
235 Specify the number of tty available to the container
237 `--unique` `<boolean>` ::
239 Assign a unique random ethernet address.
241 NOTE: Requires option(s): `restore`
243 `--unprivileged` `<boolean>` ('default =' `0`)::
245 Makes the container run as unprivileged user. (Should not be modified manually.)
247 `--unused[n]` `[volume=]<volume>` ::
249 Reference to unused volumes. This is used internally, and should not be modified manually.
251 *pct delsnapshot* `<vmid> <snapname>` `[OPTIONS]`
253 Delete a LXC snapshot.
255 `<vmid>`: `<integer> (1 - N)` ::
257 The (unique) ID of the VM.
259 `<snapname>`: `<string>` ::
261 The name of the snapshot.
263 `--force` `<boolean>` ::
265 For removal from config file, even if removing disk snapshots fails.
267 *pct destroy* `<vmid>` `[OPTIONS]`
269 Destroy the container (also delete all uses files).
271 `<vmid>`: `<integer> (1 - N)` ::
273 The (unique) ID of the VM.
275 `--destroy-unreferenced-disks` `<boolean>` ::
277 If set, destroy additionally all disks with the VMID from all enabled storages which are not referenced in the config.
279 `--force` `<boolean>` ('default =' `0`)::
281 Force destroy, even if running.
283 `--purge` `<boolean>` ('default =' `0`)::
285 Remove container from all related configurations. For example, backup jobs, replication jobs or HA. Related ACLs and Firewall entries will *always* be removed.
289 Get the container's current disk usage.
291 `<vmid>`: `<integer> (1 - N)` ::
293 The (unique) ID of the VM.
297 Launch a shell for the specified container.
299 `<vmid>`: `<integer> (1 - N)` ::
301 The (unique) ID of the VM.
303 *pct exec* `<vmid> [<extra-args>]`
305 Launch a command inside the specified container.
307 `<vmid>`: `<integer> (1 - N)` ::
309 The (unique) ID of the VM.
311 `<extra-args>`: `<array>` ::
313 Extra arguments as array
315 *pct fsck* `<vmid>` `[OPTIONS]`
317 Run a filesystem check (fsck) on a container volume.
319 `<vmid>`: `<integer> (1 - N)` ::
321 The (unique) ID of the VM.
323 `--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>` ::
325 A volume on which to run the filesystem check
327 `--force` `<boolean>` ('default =' `0`)::
329 Force checking, even if the filesystem seems clean
331 *pct fstrim* `<vmid>` `[OPTIONS]`
333 Run fstrim on a chosen CT and its mountpoints.
335 `<vmid>`: `<integer> (1 - N)` ::
337 The (unique) ID of the VM.
339 `--ignore-mountpoints` `<boolean>` ::
341 Skip all mountpoints, only do fstrim on the container root.
343 *pct help* `[OPTIONS]`
345 Get help about specified command.
347 `--extra-args` `<array>` ::
349 Shows help for a specific command
351 `--verbose` `<boolean>` ::
353 Verbose output format.
357 LXC container index (per node).
359 *pct listsnapshot* `<vmid>`
363 `<vmid>`: `<integer> (1 - N)` ::
365 The (unique) ID of the VM.
367 *pct migrate* `<vmid> <target>` `[OPTIONS]`
369 Migrate the container to another node. Creates a new migration task.
371 `<vmid>`: `<integer> (1 - N)` ::
373 The (unique) ID of the VM.
375 `<target>`: `<string>` ::
379 `--bwlimit` `<number> (0 - N)` ('default =' `migrate limit from datacenter or storage config`)::
381 Override I/O bandwidth limit (in KiB/s).
383 `--online` `<boolean>` ::
385 Use online/live migration.
387 `--restart` `<boolean>` ::
389 Use restart migration
391 `--target-storage` `<string>` ::
393 Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself.
395 `--timeout` `<integer>` ('default =' `180`)::
397 Timeout in seconds for shutdown for restart migration
401 Mount the container's filesystem on the host. This will hold a lock on the
402 container and is meant for emergency maintenance only as it will prevent
403 further operations on the container other than start and stop.
405 `<vmid>`: `<integer> (1 - N)` ::
407 The (unique) ID of the VM.
409 *pct move-volume* `<vmid> <volume> [<storage>] [<target-vmid>] [<target-volume>]` `[OPTIONS]`
411 Move a rootfs-/mp-volume to a different storage or to a different
414 `<vmid>`: `<integer> (1 - N)` ::
416 The (unique) ID of the VM.
418 `<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 | unused0 | unused1 | unused10 | unused100 | unused101 | unused102 | unused103 | unused104 | unused105 | unused106 | unused107 | unused108 | unused109 | unused11 | unused110 | unused111 | unused112 | unused113 | unused114 | unused115 | unused116 | unused117 | unused118 | unused119 | unused12 | unused120 | unused121 | unused122 | unused123 | unused124 | unused125 | unused126 | unused127 | unused128 | unused129 | unused13 | unused130 | unused131 | unused132 | unused133 | unused134 | unused135 | unused136 | unused137 | unused138 | unused139 | unused14 | unused140 | unused141 | unused142 | unused143 | unused144 | unused145 | unused146 | unused147 | unused148 | unused149 | unused15 | unused150 | unused151 | unused152 | unused153 | unused154 | unused155 | unused156 | unused157 | unused158 | unused159 | unused16 | unused160 | unused161 | unused162 | unused163 | unused164 | unused165 | unused166 | unused167 | unused168 | unused169 | unused17 | unused170 | unused171 | unused172 | unused173 | unused174 | unused175 | unused176 | unused177 | unused178 | unused179 | unused18 | unused180 | unused181 | unused182 | unused183 | unused184 | unused185 | unused186 | unused187 | unused188 | unused189 | unused19 | unused190 | unused191 | unused192 | unused193 | unused194 | unused195 | unused196 | unused197 | unused198 | unused199 | unused2 | unused20 | unused200 | unused201 | unused202 | unused203 | unused204 | unused205 | unused206 | unused207 | unused208 | unused209 | unused21 | unused210 | unused211 | unused212 | unused213 | unused214 | unused215 | unused216 | unused217 | unused218 | unused219 | unused22 | unused220 | unused221 | unused222 | unused223 | unused224 | unused225 | unused226 | unused227 | unused228 | unused229 | unused23 | unused230 | unused231 | unused232 | unused233 | unused234 | unused235 | unused236 | unused237 | unused238 | unused239 | unused24 | unused240 | unused241 | unused242 | unused243 | unused244 | unused245 | unused246 | unused247 | unused248 | unused249 | unused25 | unused250 | unused251 | unused252 | unused253 | unused254 | unused255 | unused26 | unused27 | unused28 | unused29 | unused3 | unused30 | unused31 | unused32 | unused33 | unused34 | unused35 | unused36 | unused37 | unused38 | unused39 | unused4 | unused40 | unused41 | unused42 | unused43 | unused44 | unused45 | unused46 | unused47 | unused48 | unused49 | unused5 | unused50 | unused51 | unused52 | unused53 | unused54 | unused55 | unused56 | unused57 | unused58 | unused59 | unused6 | unused60 | unused61 | unused62 | unused63 | unused64 | unused65 | unused66 | unused67 | unused68 | unused69 | unused7 | unused70 | unused71 | unused72 | unused73 | unused74 | unused75 | unused76 | unused77 | unused78 | unused79 | unused8 | unused80 | unused81 | unused82 | unused83 | unused84 | unused85 | unused86 | unused87 | unused88 | unused89 | unused9 | unused90 | unused91 | unused92 | unused93 | unused94 | unused95 | unused96 | unused97 | unused98 | unused99>` ::
420 Volume which will be moved.
422 `<storage>`: `<string>` ::
426 `<target-vmid>`: `<integer> (1 - N)` ::
428 The (unique) ID of the VM.
430 `<target-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 | unused0 | unused1 | unused10 | unused100 | unused101 | unused102 | unused103 | unused104 | unused105 | unused106 | unused107 | unused108 | unused109 | unused11 | unused110 | unused111 | unused112 | unused113 | unused114 | unused115 | unused116 | unused117 | unused118 | unused119 | unused12 | unused120 | unused121 | unused122 | unused123 | unused124 | unused125 | unused126 | unused127 | unused128 | unused129 | unused13 | unused130 | unused131 | unused132 | unused133 | unused134 | unused135 | unused136 | unused137 | unused138 | unused139 | unused14 | unused140 | unused141 | unused142 | unused143 | unused144 | unused145 | unused146 | unused147 | unused148 | unused149 | unused15 | unused150 | unused151 | unused152 | unused153 | unused154 | unused155 | unused156 | unused157 | unused158 | unused159 | unused16 | unused160 | unused161 | unused162 | unused163 | unused164 | unused165 | unused166 | unused167 | unused168 | unused169 | unused17 | unused170 | unused171 | unused172 | unused173 | unused174 | unused175 | unused176 | unused177 | unused178 | unused179 | unused18 | unused180 | unused181 | unused182 | unused183 | unused184 | unused185 | unused186 | unused187 | unused188 | unused189 | unused19 | unused190 | unused191 | unused192 | unused193 | unused194 | unused195 | unused196 | unused197 | unused198 | unused199 | unused2 | unused20 | unused200 | unused201 | unused202 | unused203 | unused204 | unused205 | unused206 | unused207 | unused208 | unused209 | unused21 | unused210 | unused211 | unused212 | unused213 | unused214 | unused215 | unused216 | unused217 | unused218 | unused219 | unused22 | unused220 | unused221 | unused222 | unused223 | unused224 | unused225 | unused226 | unused227 | unused228 | unused229 | unused23 | unused230 | unused231 | unused232 | unused233 | unused234 | unused235 | unused236 | unused237 | unused238 | unused239 | unused24 | unused240 | unused241 | unused242 | unused243 | unused244 | unused245 | unused246 | unused247 | unused248 | unused249 | unused25 | unused250 | unused251 | unused252 | unused253 | unused254 | unused255 | unused26 | unused27 | unused28 | unused29 | unused3 | unused30 | unused31 | unused32 | unused33 | unused34 | unused35 | unused36 | unused37 | unused38 | unused39 | unused4 | unused40 | unused41 | unused42 | unused43 | unused44 | unused45 | unused46 | unused47 | unused48 | unused49 | unused5 | unused50 | unused51 | unused52 | unused53 | unused54 | unused55 | unused56 | unused57 | unused58 | unused59 | unused6 | unused60 | unused61 | unused62 | unused63 | unused64 | unused65 | unused66 | unused67 | unused68 | unused69 | unused7 | unused70 | unused71 | unused72 | unused73 | unused74 | unused75 | unused76 | unused77 | unused78 | unused79 | unused8 | unused80 | unused81 | unused82 | unused83 | unused84 | unused85 | unused86 | unused87 | unused88 | unused89 | unused9 | unused90 | unused91 | unused92 | unused93 | unused94 | unused95 | unused96 | unused97 | unused98 | unused99>` ::
432 The config key the volume will be moved to. Default is the source volume key.
434 `--bwlimit` `<number> (0 - N)` ('default =' `clone limit from datacenter or storage config`)::
436 Override I/O bandwidth limit (in KiB/s).
438 `--delete` `<boolean>` ('default =' `0`)::
440 Delete the original volume after successful copy. By default the original is kept as an unused volume entry.
442 `--digest` `<string>` ::
444 Prevent changes if current configuration file has different SHA1 " .
445 "digest. This can be used to prevent concurrent modifications.
447 `--target-digest` `<string>` ::
449 Prevent changes if current configuration file of the target " .
450 "container has a different SHA1 digest. This can be used to prevent " .
451 "concurrent modifications.
455 An alias for 'pct move-volume'.
457 *pct pending* `<vmid>`
459 Get container configuration, including pending changes.
461 `<vmid>`: `<integer> (1 - N)` ::
463 The (unique) ID of the VM.
465 *pct pull* `<vmid> <path> <destination>` `[OPTIONS]`
467 Copy a file from the container to the local system.
469 `<vmid>`: `<integer> (1 - N)` ::
471 The (unique) ID of the VM.
473 `<path>`: `<string>` ::
475 Path to a file inside the container to pull.
477 `<destination>`: `<string>` ::
481 `--group` `<string>` ::
483 Owner group name or id.
485 `--perms` `<string>` ::
487 File permissions to use (octal by default, prefix with '0x' for hexadecimal).
489 `--user` `<string>` ::
491 Owner user name or id.
493 *pct push* `<vmid> <file> <destination>` `[OPTIONS]`
495 Copy a local file to the container.
497 `<vmid>`: `<integer> (1 - N)` ::
499 The (unique) ID of the VM.
501 `<file>`: `<string>` ::
503 Path to a local file.
505 `<destination>`: `<string>` ::
507 Destination inside the container to write to.
509 `--group` `<string>` ::
511 Owner group name or id. When using a name it must exist inside the container.
513 `--perms` `<string>` ::
515 File permissions to use (octal by default, prefix with '0x' for hexadecimal).
517 `--user` `<string>` ::
519 Owner user name or id. When using a name it must exist inside the container.
521 *pct reboot* `<vmid>` `[OPTIONS]`
523 Reboot the container by shutting it down, and starting it again. Applies
526 `<vmid>`: `<integer> (1 - N)` ::
528 The (unique) ID of the VM.
530 `--timeout` `<integer> (0 - N)` ::
532 Wait maximal timeout seconds for the shutdown.
534 *pct remote-migrate* `<vmid> [<target-vmid>] <target-endpoint> --target-bridge <string> --target-storage <string>` `[OPTIONS]`
536 Migrate container to a remote cluster. Creates a new migration task.
537 EXPERIMENTAL feature!
539 `<vmid>`: `<integer> (1 - N)` ::
541 The (unique) ID of the VM.
543 `<target-vmid>`: `<integer> (1 - N)` ::
545 The (unique) ID of the VM.
547 `<target-endpoint>`: `apitoken=<A full Proxmox API token including the secret value.> ,host=<Remote Proxmox hostname or IP> [,fingerprint=<Remote host's certificate fingerprint, if not trusted by system store.>] [,port=<integer>]` ::
549 Remote target endpoint
551 `--bwlimit` `<integer> (0 - N)` ('default =' `migrate limit from datacenter or storage config`)::
553 Override I/O bandwidth limit (in KiB/s).
555 `--delete` `<boolean>` ('default =' `0`)::
557 Delete the original CT and related data after successful migration. By default the original CT is kept on the source cluster in a stopped state.
559 `--online` `<boolean>` ::
561 Use online/live migration.
563 `--restart` `<boolean>` ::
565 Use restart migration
567 `--target-bridge` `<string>` ::
569 Mapping from source to target bridges. Providing only a single bridge ID maps all source bridges to that bridge. Providing the special value '1' will map each source bridge to itself.
571 `--target-storage` `<string>` ::
573 Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself.
575 `--timeout` `<integer>` ('default =' `180`)::
577 Timeout in seconds for shutdown for restart migration
579 *pct rescan* `[OPTIONS]`
581 Rescan all storages and update disk sizes and unused disk images.
583 `--dryrun` `<boolean>` ('default =' `0`)::
585 Do not actually write changes out to conifg.
587 `--vmid` `<integer> (1 - N)` ::
589 The (unique) ID of the VM.
591 *pct resize* `<vmid> <disk> <size>` `[OPTIONS]`
593 Resize a container mount point.
595 `<vmid>`: `<integer> (1 - N)` ::
597 The (unique) ID of the VM.
599 `<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>` ::
601 The disk you want to resize.
603 `<size>`: `\+?\d+(\.\d+)?[KMGT]?` ::
605 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.
607 `--digest` `<string>` ::
609 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
611 *pct restore* `<vmid> <ostemplate>` `[OPTIONS]`
613 Create or restore a container.
615 `<vmid>`: `<integer> (1 - N)` ::
617 The (unique) ID of the VM.
619 `<ostemplate>`: `<string>` ::
621 The OS template or backup file.
623 `--arch` `<amd64 | arm64 | armhf | i386>` ('default =' `amd64`)::
625 OS architecture type.
627 `--bwlimit` `<number> (0 - N)` ('default =' `restore limit from datacenter or storage config`)::
629 Override I/O bandwidth limit (in KiB/s).
631 `--cmode` `<console | shell | tty>` ('default =' `tty`)::
633 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).
635 `--console` `<boolean>` ('default =' `1`)::
637 Attach a console device (/dev/console) to the container.
639 `--cores` `<integer> (1 - 8192)` ::
641 The number of cores assigned to the container. A container can use all available cores by default.
643 `--cpulimit` `<number> (0 - 8192)` ('default =' `0`)::
647 NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.
649 `--cpuunits` `<integer> (0 - 500000)` ('default =' `cgroup v1: 1024, cgroup v2: 100`)::
651 CPU weight for a container, will be clamped to [1, 10000] in cgroup v2.
653 `--debug` `<boolean>` ('default =' `0`)::
655 Try to be more verbose. For now this only enables debug log-level on start.
657 `--description` `<string>` ::
659 Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file.
661 `--features` `[force_rw_sys=<1|0>] [,fuse=<1|0>] [,keyctl=<1|0>] [,mknod=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
663 Allow containers access to advanced features.
665 `--force` `<boolean>` ::
667 Allow to overwrite existing container.
669 `--hookscript` `<string>` ::
671 Script that will be exectued during various steps in the containers lifetime.
673 `--hostname` `<string>` ::
675 Set a host name for the container.
677 `--ignore-unpack-errors` `<boolean>` ::
679 Ignore errors when extracting the template.
681 `--lock` `<backup | create | destroyed | disk | fstrim | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
683 Lock/unlock the container.
685 `--memory` `<integer> (16 - N)` ('default =' `512`)::
687 Amount of RAM for the container in MB.
689 `--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>]` ::
691 Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
693 `--nameserver` `<string>` ::
695 Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
697 `--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>]` ::
699 Specifies network interfaces for the container.
701 `--onboot` `<boolean>` ('default =' `0`)::
703 Specifies whether a container will be started during system bootup.
705 `--ostype` `<alpine | archlinux | centos | debian | devuan | fedora | gentoo | nixos | opensuse | ubuntu | unmanaged>` ::
707 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.
709 `--password` `<password>` ::
711 Sets root password inside container.
713 `--pool` `<string>` ::
715 Add the VM to the specified pool.
717 `--protection` `<boolean>` ('default =' `0`)::
719 Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
721 `--rootfs` `[volume=]<volume> [,acl=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
723 Use volume as container root.
725 `--searchdomain` `<string>` ::
727 Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
729 `--ssh-public-keys` `<filepath>` ::
731 Setup public SSH keys (one key per line, OpenSSH format).
733 `--start` `<boolean>` ('default =' `0`)::
735 Start the CT after its creation finished successfully.
737 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
739 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.
741 `--storage` `<string>` ('default =' `local`)::
745 `--swap` `<integer> (0 - N)` ('default =' `512`)::
747 Amount of SWAP for the container in MB.
749 `--tags` `<string>` ::
751 Tags of the Container. This is only meta information.
753 `--template` `<boolean>` ('default =' `0`)::
755 Enable/disable Template.
757 `--timezone` `<string>` ::
759 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
761 `--tty` `<integer> (0 - 6)` ('default =' `2`)::
763 Specify the number of tty available to the container
765 `--unique` `<boolean>` ::
767 Assign a unique random ethernet address.
769 NOTE: Requires option(s): `restore`
771 `--unprivileged` `<boolean>` ('default =' `0`)::
773 Makes the container run as unprivileged user. (Should not be modified manually.)
775 `--unused[n]` `[volume=]<volume>` ::
777 Reference to unused volumes. This is used internally, and should not be modified manually.
779 *pct resume* `<vmid>`
781 Resume the container.
783 `<vmid>`: `<integer> (1 - N)` ::
785 The (unique) ID of the VM.
787 *pct rollback* `<vmid> <snapname>` `[OPTIONS]`
789 Rollback LXC state to specified snapshot.
791 `<vmid>`: `<integer> (1 - N)` ::
793 The (unique) ID of the VM.
795 `<snapname>`: `<string>` ::
797 The name of the snapshot.
799 `--start` `<boolean>` ('default =' `0`)::
801 Whether the container should get started after rolling back successfully
803 *pct set* `<vmid>` `[OPTIONS]`
805 Set container options.
807 `<vmid>`: `<integer> (1 - N)` ::
809 The (unique) ID of the VM.
811 `--arch` `<amd64 | arm64 | armhf | i386>` ('default =' `amd64`)::
813 OS architecture type.
815 `--cmode` `<console | shell | tty>` ('default =' `tty`)::
817 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).
819 `--console` `<boolean>` ('default =' `1`)::
821 Attach a console device (/dev/console) to the container.
823 `--cores` `<integer> (1 - 8192)` ::
825 The number of cores assigned to the container. A container can use all available cores by default.
827 `--cpulimit` `<number> (0 - 8192)` ('default =' `0`)::
831 NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.
833 `--cpuunits` `<integer> (0 - 500000)` ('default =' `cgroup v1: 1024, cgroup v2: 100`)::
835 CPU weight for a container, will be clamped to [1, 10000] in cgroup v2.
837 `--debug` `<boolean>` ('default =' `0`)::
839 Try to be more verbose. For now this only enables debug log-level on start.
841 `--delete` `<string>` ::
843 A list of settings you want to delete.
845 `--description` `<string>` ::
847 Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file.
849 `--digest` `<string>` ::
851 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
853 `--features` `[force_rw_sys=<1|0>] [,fuse=<1|0>] [,keyctl=<1|0>] [,mknod=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
855 Allow containers access to advanced features.
857 `--hookscript` `<string>` ::
859 Script that will be exectued during various steps in the containers lifetime.
861 `--hostname` `<string>` ::
863 Set a host name for the container.
865 `--lock` `<backup | create | destroyed | disk | fstrim | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
867 Lock/unlock the container.
869 `--memory` `<integer> (16 - N)` ('default =' `512`)::
871 Amount of RAM for the container in MB.
873 `--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>]` ::
875 Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
877 `--nameserver` `<string>` ::
879 Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
881 `--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>]` ::
883 Specifies network interfaces for the container.
885 `--onboot` `<boolean>` ('default =' `0`)::
887 Specifies whether a container will be started during system bootup.
889 `--ostype` `<alpine | archlinux | centos | debian | devuan | fedora | gentoo | nixos | opensuse | ubuntu | unmanaged>` ::
891 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.
893 `--protection` `<boolean>` ('default =' `0`)::
895 Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
897 `--revert` `<string>` ::
899 Revert a pending change.
901 `--rootfs` `[volume=]<volume> [,acl=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
903 Use volume as container root.
905 `--searchdomain` `<string>` ::
907 Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
909 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
911 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.
913 `--swap` `<integer> (0 - N)` ('default =' `512`)::
915 Amount of SWAP for the container in MB.
917 `--tags` `<string>` ::
919 Tags of the Container. This is only meta information.
921 `--template` `<boolean>` ('default =' `0`)::
923 Enable/disable Template.
925 `--timezone` `<string>` ::
927 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
929 `--tty` `<integer> (0 - 6)` ('default =' `2`)::
931 Specify the number of tty available to the container
933 `--unprivileged` `<boolean>` ('default =' `0`)::
935 Makes the container run as unprivileged user. (Should not be modified manually.)
937 `--unused[n]` `[volume=]<volume>` ::
939 Reference to unused volumes. This is used internally, and should not be modified manually.
941 *pct shutdown* `<vmid>` `[OPTIONS]`
943 Shutdown the container. This will trigger a clean shutdown of the
944 container, see lxc-stop(1) for details.
946 `<vmid>`: `<integer> (1 - N)` ::
948 The (unique) ID of the VM.
950 `--forceStop` `<boolean>` ('default =' `0`)::
952 Make sure the Container stops.
954 `--timeout` `<integer> (0 - N)` ('default =' `60`)::
956 Wait maximal timeout seconds.
958 *pct snapshot* `<vmid> <snapname>` `[OPTIONS]`
960 Snapshot a container.
962 `<vmid>`: `<integer> (1 - N)` ::
964 The (unique) ID of the VM.
966 `<snapname>`: `<string>` ::
968 The name of the snapshot.
970 `--description` `<string>` ::
972 A textual description or comment.
974 *pct start* `<vmid>` `[OPTIONS]`
978 `<vmid>`: `<integer> (1 - N)` ::
980 The (unique) ID of the VM.
982 `--debug` `<boolean>` ('default =' `0`)::
984 If set, enables very verbose debug log-level on start.
986 `--skiplock` `<boolean>` ::
988 Ignore locks - only root is allowed to use this option.
990 *pct status* `<vmid>` `[OPTIONS]`
994 `<vmid>`: `<integer> (1 - N)` ::
996 The (unique) ID of the VM.
998 `--verbose` `<boolean>` ::
1000 Verbose output format
1002 *pct stop* `<vmid>` `[OPTIONS]`
1004 Stop the container. This will abruptly stop all processes running in the
1007 `<vmid>`: `<integer> (1 - N)` ::
1009 The (unique) ID of the VM.
1011 `--skiplock` `<boolean>` ::
1013 Ignore locks - only root is allowed to use this option.
1015 *pct suspend* `<vmid>`
1017 Suspend the container. This is experimental.
1019 `<vmid>`: `<integer> (1 - N)` ::
1021 The (unique) ID of the VM.
1023 *pct template* `<vmid>`
1027 `<vmid>`: `<integer> (1 - N)` ::
1029 The (unique) ID of the VM.
1031 *pct unlock* `<vmid>`
1035 `<vmid>`: `<integer> (1 - N)` ::
1037 The (unique) ID of the VM.
1039 *pct unmount* `<vmid>`
1041 Unmount the container's filesystem.
1043 `<vmid>`: `<integer> (1 - N)` ::
1045 The (unique) ID of the VM.