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