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