]> git.proxmox.com Git - pve-docs.git/blob - pct.1-synopsis.adoc
fix #3884: Add section for kernel samepage merging
[pve-docs.git] / pct.1-synopsis.adoc
1 *pct* `<COMMAND> [ARGS] [OPTIONS]`
2
3 *pct clone* `<vmid> <newid>` `[OPTIONS]`
4
5 Create a container clone/copy
6
7 `<vmid>`: `<integer> (1 - N)` ::
8
9 The (unique) ID of the VM.
10
11 `<newid>`: `<integer> (1 - N)` ::
12
13 VMID for the clone.
14
15 `--bwlimit` `<number> (0 - N)` ('default =' `clone limit from datacenter or storage config`)::
16
17 Override I/O bandwidth limit (in KiB/s).
18
19 `--description` `<string>` ::
20
21 Description for the new CT.
22
23 `--full` `<boolean>` ::
24
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.
26
27 `--hostname` `<string>` ::
28
29 Set a hostname for the new CT.
30
31 `--pool` `<string>` ::
32
33 Add the new CT to the specified pool.
34
35 `--snapname` `<string>` ::
36
37 The name of the snapshot.
38
39 `--storage` `<string>` ::
40
41 Target storage for full clone.
42
43 `--target` `<string>` ::
44
45 Target node. Only allowed if the original VM is on shared storage.
46
47 *pct config* `<vmid>` `[OPTIONS]`
48
49 Get container configuration.
50
51 `<vmid>`: `<integer> (1 - N)` ::
52
53 The (unique) ID of the VM.
54
55 `--current` `<boolean>` ('default =' `0`)::
56
57 Get current values (instead of pending values).
58
59 `--snapshot` `<string>` ::
60
61 Fetch config values from given snapshot.
62
63 *pct console* `<vmid>` `[OPTIONS]`
64
65 Launch a console for the specified container.
66
67 `<vmid>`: `<integer> (1 - N)` ::
68
69 The (unique) ID of the VM.
70
71 `--escape` `\^?[a-z]` ('default =' `^a`)::
72
73 Escape sequence prefix. For example to use <Ctrl+b q> as the escape sequence pass '^b'.
74
75 *pct cpusets*
76
77 Print the list of assigned CPU sets.
78
79 *pct create* `<vmid> <ostemplate>` `[OPTIONS]`
80
81 Create or restore a container.
82
83 `<vmid>`: `<integer> (1 - N)` ::
84
85 The (unique) ID of the VM.
86
87 `<ostemplate>`: `<string>` ::
88
89 The OS template or backup file.
90
91 `--arch` `<amd64 | arm64 | armhf | i386>` ('default =' `amd64`)::
92
93 OS architecture type.
94
95 `--bwlimit` `<number> (0 - N)` ('default =' `restore limit from datacenter or storage config`)::
96
97 Override I/O bandwidth limit (in KiB/s).
98
99 `--cmode` `<console | shell | tty>` ('default =' `tty`)::
100
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).
102
103 `--console` `<boolean>` ('default =' `1`)::
104
105 Attach a console device (/dev/console) to the container.
106
107 `--cores` `<integer> (1 - 8192)` ::
108
109 The number of cores assigned to the container. A container can use all available cores by default.
110
111 `--cpulimit` `<number> (0 - 8192)` ('default =' `0`)::
112
113 Limit of CPU usage.
114 +
115 NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.
116
117 `--cpuunits` `<integer> (0 - 500000)` ('default =' `1024`)::
118
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.
120 +
121 NOTE: You can disable fair-scheduler configuration by setting this to 0.
122
123 `--debug` `<boolean>` ('default =' `0`)::
124
125 Try to be more verbose. For now this only enables debug log-level on start.
126
127 `--description` `<string>` ::
128
129 Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file.
130
131 `--features` `[force_rw_sys=<1|0>] [,fuse=<1|0>] [,keyctl=<1|0>] [,mknod=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
132
133 Allow containers access to advanced features.
134
135 `--force` `<boolean>` ::
136
137 Allow to overwrite existing container.
138
139 `--hookscript` `<string>` ::
140
141 Script that will be exectued during various steps in the containers lifetime.
142
143 `--hostname` `<string>` ::
144
145 Set a host name for the container.
146
147 `--ignore-unpack-errors` `<boolean>` ::
148
149 Ignore errors when extracting the template.
150
151 `--lock` `<backup | create | destroyed | disk | fstrim | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
152
153 Lock/unlock the VM.
154
155 `--memory` `<integer> (16 - N)` ('default =' `512`)::
156
157 Amount of RAM for the VM in MB.
158
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>]` ::
160
161 Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
162
163 `--nameserver` `<string>` ::
164
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.
166
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>]` ::
168
169 Specifies network interfaces for the container.
170
171 `--onboot` `<boolean>` ('default =' `0`)::
172
173 Specifies whether a VM will be started during system bootup.
174
175 `--ostype` `<alpine | archlinux | centos | debian | devuan | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
176
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.
178
179 `--password` `<password>` ::
180
181 Sets root password inside container.
182
183 `--pool` `<string>` ::
184
185 Add the VM to the specified pool.
186
187 `--protection` `<boolean>` ('default =' `0`)::
188
189 Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
190
191 `--restore` `<boolean>` ::
192
193 Mark this as restore task.
194
195 `--rootfs` `[volume=]<volume> [,acl=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
196
197 Use volume as container root.
198
199 `--searchdomain` `<string>` ::
200
201 Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
202
203 `--ssh-public-keys` `<filepath>` ::
204
205 Setup public SSH keys (one key per line, OpenSSH format).
206
207 `--start` `<boolean>` ('default =' `0`)::
208
209 Start the CT after its creation finished successfully.
210
211 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
212
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.
214
215 `--storage` `<string>` ('default =' `local`)::
216
217 Default Storage.
218
219 `--swap` `<integer> (0 - N)` ('default =' `512`)::
220
221 Amount of SWAP for the VM in MB.
222
223 `--tags` `<string>` ::
224
225 Tags of the Container. This is only meta information.
226
227 `--template` `<boolean>` ('default =' `0`)::
228
229 Enable/disable Template.
230
231 `--timezone` `<string>` ::
232
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
234
235 `--tty` `<integer> (0 - 6)` ('default =' `2`)::
236
237 Specify the number of tty available to the container
238
239 `--unique` `<boolean>` ::
240
241 Assign a unique random ethernet address.
242 +
243 NOTE: Requires option(s): `restore`
244
245 `--unprivileged` `<boolean>` ('default =' `0`)::
246
247 Makes the container run as unprivileged user. (Should not be modified manually.)
248
249 `--unused[n]` `[volume=]<volume>` ::
250
251 Reference to unused volumes. This is used internally, and should not be modified manually.
252
253 *pct delsnapshot* `<vmid> <snapname>` `[OPTIONS]`
254
255 Delete a LXC snapshot.
256
257 `<vmid>`: `<integer> (1 - N)` ::
258
259 The (unique) ID of the VM.
260
261 `<snapname>`: `<string>` ::
262
263 The name of the snapshot.
264
265 `--force` `<boolean>` ::
266
267 For removal from config file, even if removing disk snapshots fails.
268
269 *pct destroy* `<vmid>` `[OPTIONS]`
270
271 Destroy the container (also delete all uses files).
272
273 `<vmid>`: `<integer> (1 - N)` ::
274
275 The (unique) ID of the VM.
276
277 `--destroy-unreferenced-disks` `<boolean>` ::
278
279 If set, destroy additionally all disks with the VMID from all enabled storages which are not referenced in the config.
280
281 `--force` `<boolean>` ('default =' `0`)::
282
283 Force destroy, even if running.
284
285 `--purge` `<boolean>` ('default =' `0`)::
286
287 Remove container from all related configurations. For example, backup jobs, replication jobs or HA. Related ACLs and Firewall entries will *always* be removed.
288
289 *pct df* `<vmid>`
290
291 Get the container's current disk usage.
292
293 `<vmid>`: `<integer> (1 - N)` ::
294
295 The (unique) ID of the VM.
296
297 *pct enter* `<vmid>`
298
299 Launch a shell for the specified container.
300
301 `<vmid>`: `<integer> (1 - N)` ::
302
303 The (unique) ID of the VM.
304
305 *pct exec* `<vmid> [<extra-args>]`
306
307 Launch a command inside the specified container.
308
309 `<vmid>`: `<integer> (1 - N)` ::
310
311 The (unique) ID of the VM.
312
313 `<extra-args>`: `<array>` ::
314
315 Extra arguments as array
316
317 *pct fsck* `<vmid>` `[OPTIONS]`
318
319 Run a filesystem check (fsck) on a container volume.
320
321 `<vmid>`: `<integer> (1 - N)` ::
322
323 The (unique) ID of the VM.
324
325 `--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>` ::
326
327 A volume on which to run the filesystem check
328
329 `--force` `<boolean>` ('default =' `0`)::
330
331 Force checking, even if the filesystem seems clean
332
333 *pct fstrim* `<vmid>` `[OPTIONS]`
334
335 Run fstrim on a chosen CT and its mountpoints.
336
337 `<vmid>`: `<integer> (1 - N)` ::
338
339 The (unique) ID of the VM.
340
341 `--ignore-mountpoints` `<boolean>` ::
342
343 Skip all mountpoints, only do fstrim on the container root.
344
345 *pct help* `[OPTIONS]`
346
347 Get help about specified command.
348
349 `--extra-args` `<array>` ::
350
351 Shows help for a specific command
352
353 `--verbose` `<boolean>` ::
354
355 Verbose output format.
356
357 *pct list*
358
359 LXC container index (per node).
360
361 *pct listsnapshot* `<vmid>`
362
363 List all snapshots.
364
365 `<vmid>`: `<integer> (1 - N)` ::
366
367 The (unique) ID of the VM.
368
369 *pct migrate* `<vmid> <target>` `[OPTIONS]`
370
371 Migrate the container to another node. Creates a new migration task.
372
373 `<vmid>`: `<integer> (1 - N)` ::
374
375 The (unique) ID of the VM.
376
377 `<target>`: `<string>` ::
378
379 Target node.
380
381 `--bwlimit` `<number> (0 - N)` ('default =' `migrate limit from datacenter or storage config`)::
382
383 Override I/O bandwidth limit (in KiB/s).
384
385 `--online` `<boolean>` ::
386
387 Use online/live migration.
388
389 `--restart` `<boolean>` ::
390
391 Use restart migration
392
393 `--target-storage` `<string>` ::
394
395 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.
396
397 `--timeout` `<integer>` ('default =' `180`)::
398
399 Timeout in seconds for shutdown for restart migration
400
401 *pct mount* `<vmid>`
402
403 Mount the container's filesystem on the host. This will hold a lock on the
404 container and is meant for emergency maintenance only as it will prevent
405 further operations on the container other than start and stop.
406
407 `<vmid>`: `<integer> (1 - N)` ::
408
409 The (unique) ID of the VM.
410
411 *pct move-volume* `<vmid> <volume> [<storage>] [<target-vmid>] [<target-volume>]` `[OPTIONS]`
412
413 Move a rootfs-/mp-volume to a different storage or to a different
414 container.
415
416 `<vmid>`: `<integer> (1 - N)` ::
417
418 The (unique) ID of the VM.
419
420 `<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>` ::
421
422 Volume which will be moved.
423
424 `<storage>`: `<string>` ::
425
426 Target Storage.
427
428 `<target-vmid>`: `<integer> (1 - N)` ::
429
430 The (unique) ID of the VM.
431
432 `<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>` ::
433
434 The config key the volume will be moved to. Default is the source volume key.
435
436 `--bwlimit` `<number> (0 - N)` ('default =' `clone limit from datacenter or storage config`)::
437
438 Override I/O bandwidth limit (in KiB/s).
439
440 `--delete` `<boolean>` ('default =' `0`)::
441
442 Delete the original volume after successful copy. By default the original is kept as an unused volume entry.
443
444 `--digest` `<string>` ::
445
446 Prevent changes if current configuration file has different SHA1 " .
447 "digest. This can be used to prevent concurrent modifications.
448
449 `--target-digest` `<string>` ::
450
451 Prevent changes if current configuration file of the target " .
452 "container has a different SHA1 digest. This can be used to prevent " .
453 "concurrent modifications.
454
455 *pct move_volume*
456
457 An alias for 'pct move-volume'.
458
459 *pct pending* `<vmid>`
460
461 Get container configuration, including pending changes.
462
463 `<vmid>`: `<integer> (1 - N)` ::
464
465 The (unique) ID of the VM.
466
467 *pct pull* `<vmid> <path> <destination>` `[OPTIONS]`
468
469 Copy a file from the container to the local system.
470
471 `<vmid>`: `<integer> (1 - N)` ::
472
473 The (unique) ID of the VM.
474
475 `<path>`: `<string>` ::
476
477 Path to a file inside the container to pull.
478
479 `<destination>`: `<string>` ::
480
481 Destination
482
483 `--group` `<string>` ::
484
485 Owner group name or id.
486
487 `--perms` `<string>` ::
488
489 File permissions to use (octal by default, prefix with '0x' for hexadecimal).
490
491 `--user` `<string>` ::
492
493 Owner user name or id.
494
495 *pct push* `<vmid> <file> <destination>` `[OPTIONS]`
496
497 Copy a local file to the container.
498
499 `<vmid>`: `<integer> (1 - N)` ::
500
501 The (unique) ID of the VM.
502
503 `<file>`: `<string>` ::
504
505 Path to a local file.
506
507 `<destination>`: `<string>` ::
508
509 Destination inside the container to write to.
510
511 `--group` `<string>` ::
512
513 Owner group name or id. When using a name it must exist inside the container.
514
515 `--perms` `<string>` ::
516
517 File permissions to use (octal by default, prefix with '0x' for hexadecimal).
518
519 `--user` `<string>` ::
520
521 Owner user name or id. When using a name it must exist inside the container.
522
523 *pct reboot* `<vmid>` `[OPTIONS]`
524
525 Reboot the container by shutting it down, and starting it again. Applies
526 pending changes.
527
528 `<vmid>`: `<integer> (1 - N)` ::
529
530 The (unique) ID of the VM.
531
532 `--timeout` `<integer> (0 - N)` ::
533
534 Wait maximal timeout seconds for the shutdown.
535
536 *pct rescan* `[OPTIONS]`
537
538 Rescan all storages and update disk sizes and unused disk images.
539
540 `--dryrun` `<boolean>` ('default =' `0`)::
541
542 Do not actually write changes out to conifg.
543
544 `--vmid` `<integer> (1 - N)` ::
545
546 The (unique) ID of the VM.
547
548 *pct resize* `<vmid> <disk> <size>` `[OPTIONS]`
549
550 Resize a container mount point.
551
552 `<vmid>`: `<integer> (1 - N)` ::
553
554 The (unique) ID of the VM.
555
556 `<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>` ::
557
558 The disk you want to resize.
559
560 `<size>`: `\+?\d+(\.\d+)?[KMGT]?` ::
561
562 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.
563
564 `--digest` `<string>` ::
565
566 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
567
568 *pct restore* `<vmid> <ostemplate>` `[OPTIONS]`
569
570 Create or restore a container.
571
572 `<vmid>`: `<integer> (1 - N)` ::
573
574 The (unique) ID of the VM.
575
576 `<ostemplate>`: `<string>` ::
577
578 The OS template or backup file.
579
580 `--arch` `<amd64 | arm64 | armhf | i386>` ('default =' `amd64`)::
581
582 OS architecture type.
583
584 `--bwlimit` `<number> (0 - N)` ('default =' `restore limit from datacenter or storage config`)::
585
586 Override I/O bandwidth limit (in KiB/s).
587
588 `--cmode` `<console | shell | tty>` ('default =' `tty`)::
589
590 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).
591
592 `--console` `<boolean>` ('default =' `1`)::
593
594 Attach a console device (/dev/console) to the container.
595
596 `--cores` `<integer> (1 - 8192)` ::
597
598 The number of cores assigned to the container. A container can use all available cores by default.
599
600 `--cpulimit` `<number> (0 - 8192)` ('default =' `0`)::
601
602 Limit of CPU usage.
603 +
604 NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.
605
606 `--cpuunits` `<integer> (0 - 500000)` ('default =' `1024`)::
607
608 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.
609 +
610 NOTE: You can disable fair-scheduler configuration by setting this to 0.
611
612 `--debug` `<boolean>` ('default =' `0`)::
613
614 Try to be more verbose. For now this only enables debug log-level on start.
615
616 `--description` `<string>` ::
617
618 Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file.
619
620 `--features` `[force_rw_sys=<1|0>] [,fuse=<1|0>] [,keyctl=<1|0>] [,mknod=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
621
622 Allow containers access to advanced features.
623
624 `--force` `<boolean>` ::
625
626 Allow to overwrite existing container.
627
628 `--hookscript` `<string>` ::
629
630 Script that will be exectued during various steps in the containers lifetime.
631
632 `--hostname` `<string>` ::
633
634 Set a host name for the container.
635
636 `--ignore-unpack-errors` `<boolean>` ::
637
638 Ignore errors when extracting the template.
639
640 `--lock` `<backup | create | destroyed | disk | fstrim | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
641
642 Lock/unlock the VM.
643
644 `--memory` `<integer> (16 - N)` ('default =' `512`)::
645
646 Amount of RAM for the VM in MB.
647
648 `--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>]` ::
649
650 Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
651
652 `--nameserver` `<string>` ::
653
654 Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
655
656 `--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>]` ::
657
658 Specifies network interfaces for the container.
659
660 `--onboot` `<boolean>` ('default =' `0`)::
661
662 Specifies whether a VM will be started during system bootup.
663
664 `--ostype` `<alpine | archlinux | centos | debian | devuan | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
665
666 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.
667
668 `--password` `<password>` ::
669
670 Sets root password inside container.
671
672 `--pool` `<string>` ::
673
674 Add the VM to the specified pool.
675
676 `--protection` `<boolean>` ('default =' `0`)::
677
678 Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
679
680 `--rootfs` `[volume=]<volume> [,acl=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
681
682 Use volume as container root.
683
684 `--searchdomain` `<string>` ::
685
686 Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
687
688 `--ssh-public-keys` `<filepath>` ::
689
690 Setup public SSH keys (one key per line, OpenSSH format).
691
692 `--start` `<boolean>` ('default =' `0`)::
693
694 Start the CT after its creation finished successfully.
695
696 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
697
698 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.
699
700 `--storage` `<string>` ('default =' `local`)::
701
702 Default Storage.
703
704 `--swap` `<integer> (0 - N)` ('default =' `512`)::
705
706 Amount of SWAP for the VM in MB.
707
708 `--tags` `<string>` ::
709
710 Tags of the Container. This is only meta information.
711
712 `--template` `<boolean>` ('default =' `0`)::
713
714 Enable/disable Template.
715
716 `--timezone` `<string>` ::
717
718 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
719
720 `--tty` `<integer> (0 - 6)` ('default =' `2`)::
721
722 Specify the number of tty available to the container
723
724 `--unique` `<boolean>` ::
725
726 Assign a unique random ethernet address.
727 +
728 NOTE: Requires option(s): `restore`
729
730 `--unprivileged` `<boolean>` ('default =' `0`)::
731
732 Makes the container run as unprivileged user. (Should not be modified manually.)
733
734 `--unused[n]` `[volume=]<volume>` ::
735
736 Reference to unused volumes. This is used internally, and should not be modified manually.
737
738 *pct resume* `<vmid>`
739
740 Resume the container.
741
742 `<vmid>`: `<integer> (1 - N)` ::
743
744 The (unique) ID of the VM.
745
746 *pct rollback* `<vmid> <snapname>`
747
748 Rollback LXC state to specified snapshot.
749
750 `<vmid>`: `<integer> (1 - N)` ::
751
752 The (unique) ID of the VM.
753
754 `<snapname>`: `<string>` ::
755
756 The name of the snapshot.
757
758 *pct set* `<vmid>` `[OPTIONS]`
759
760 Set container options.
761
762 `<vmid>`: `<integer> (1 - N)` ::
763
764 The (unique) ID of the VM.
765
766 `--arch` `<amd64 | arm64 | armhf | i386>` ('default =' `amd64`)::
767
768 OS architecture type.
769
770 `--cmode` `<console | shell | tty>` ('default =' `tty`)::
771
772 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).
773
774 `--console` `<boolean>` ('default =' `1`)::
775
776 Attach a console device (/dev/console) to the container.
777
778 `--cores` `<integer> (1 - 8192)` ::
779
780 The number of cores assigned to the container. A container can use all available cores by default.
781
782 `--cpulimit` `<number> (0 - 8192)` ('default =' `0`)::
783
784 Limit of CPU usage.
785 +
786 NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.
787
788 `--cpuunits` `<integer> (0 - 500000)` ('default =' `1024`)::
789
790 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.
791 +
792 NOTE: You can disable fair-scheduler configuration by setting this to 0.
793
794 `--debug` `<boolean>` ('default =' `0`)::
795
796 Try to be more verbose. For now this only enables debug log-level on start.
797
798 `--delete` `<string>` ::
799
800 A list of settings you want to delete.
801
802 `--description` `<string>` ::
803
804 Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file.
805
806 `--digest` `<string>` ::
807
808 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
809
810 `--features` `[force_rw_sys=<1|0>] [,fuse=<1|0>] [,keyctl=<1|0>] [,mknod=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
811
812 Allow containers access to advanced features.
813
814 `--hookscript` `<string>` ::
815
816 Script that will be exectued during various steps in the containers lifetime.
817
818 `--hostname` `<string>` ::
819
820 Set a host name for the container.
821
822 `--lock` `<backup | create | destroyed | disk | fstrim | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
823
824 Lock/unlock the VM.
825
826 `--memory` `<integer> (16 - N)` ('default =' `512`)::
827
828 Amount of RAM for the VM in MB.
829
830 `--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>]` ::
831
832 Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
833
834 `--nameserver` `<string>` ::
835
836 Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
837
838 `--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>]` ::
839
840 Specifies network interfaces for the container.
841
842 `--onboot` `<boolean>` ('default =' `0`)::
843
844 Specifies whether a VM will be started during system bootup.
845
846 `--ostype` `<alpine | archlinux | centos | debian | devuan | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
847
848 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.
849
850 `--protection` `<boolean>` ('default =' `0`)::
851
852 Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
853
854 `--revert` `<string>` ::
855
856 Revert a pending change.
857
858 `--rootfs` `[volume=]<volume> [,acl=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
859
860 Use volume as container root.
861
862 `--searchdomain` `<string>` ::
863
864 Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
865
866 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
867
868 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.
869
870 `--swap` `<integer> (0 - N)` ('default =' `512`)::
871
872 Amount of SWAP for the VM in MB.
873
874 `--tags` `<string>` ::
875
876 Tags of the Container. This is only meta information.
877
878 `--template` `<boolean>` ('default =' `0`)::
879
880 Enable/disable Template.
881
882 `--timezone` `<string>` ::
883
884 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
885
886 `--tty` `<integer> (0 - 6)` ('default =' `2`)::
887
888 Specify the number of tty available to the container
889
890 `--unprivileged` `<boolean>` ('default =' `0`)::
891
892 Makes the container run as unprivileged user. (Should not be modified manually.)
893
894 `--unused[n]` `[volume=]<volume>` ::
895
896 Reference to unused volumes. This is used internally, and should not be modified manually.
897
898 *pct shutdown* `<vmid>` `[OPTIONS]`
899
900 Shutdown the container. This will trigger a clean shutdown of the
901 container, see lxc-stop(1) for details.
902
903 `<vmid>`: `<integer> (1 - N)` ::
904
905 The (unique) ID of the VM.
906
907 `--forceStop` `<boolean>` ('default =' `0`)::
908
909 Make sure the Container stops.
910
911 `--timeout` `<integer> (0 - N)` ('default =' `60`)::
912
913 Wait maximal timeout seconds.
914
915 *pct snapshot* `<vmid> <snapname>` `[OPTIONS]`
916
917 Snapshot a container.
918
919 `<vmid>`: `<integer> (1 - N)` ::
920
921 The (unique) ID of the VM.
922
923 `<snapname>`: `<string>` ::
924
925 The name of the snapshot.
926
927 `--description` `<string>` ::
928
929 A textual description or comment.
930
931 *pct start* `<vmid>` `[OPTIONS]`
932
933 Start the container.
934
935 `<vmid>`: `<integer> (1 - N)` ::
936
937 The (unique) ID of the VM.
938
939 `--debug` `<boolean>` ('default =' `0`)::
940
941 If set, enables very verbose debug log-level on start.
942
943 `--skiplock` `<boolean>` ::
944
945 Ignore locks - only root is allowed to use this option.
946
947 *pct status* `<vmid>` `[OPTIONS]`
948
949 Show CT status.
950
951 `<vmid>`: `<integer> (1 - N)` ::
952
953 The (unique) ID of the VM.
954
955 `--verbose` `<boolean>` ::
956
957 Verbose output format
958
959 *pct stop* `<vmid>` `[OPTIONS]`
960
961 Stop the container. This will abruptly stop all processes running in the
962 container.
963
964 `<vmid>`: `<integer> (1 - N)` ::
965
966 The (unique) ID of the VM.
967
968 `--skiplock` `<boolean>` ::
969
970 Ignore locks - only root is allowed to use this option.
971
972 *pct suspend* `<vmid>`
973
974 Suspend the container. This is experimental.
975
976 `<vmid>`: `<integer> (1 - N)` ::
977
978 The (unique) ID of the VM.
979
980 *pct template* `<vmid>`
981
982 Create a Template.
983
984 `<vmid>`: `<integer> (1 - N)` ::
985
986 The (unique) ID of the VM.
987
988 *pct unlock* `<vmid>`
989
990 Unlock the VM.
991
992 `<vmid>`: `<integer> (1 - N)` ::
993
994 The (unique) ID of the VM.
995
996 *pct unmount* `<vmid>`
997
998 Unmount the container's filesystem.
999
1000 `<vmid>`: `<integer> (1 - N)` ::
1001
1002 The (unique) ID of the VM.
1003
1004