]> git.proxmox.com Git - pve-docs.git/blame - pct.1-synopsis.adoc
attrs: update cephdocs template to quincy
[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
4d47f125 91`--arch` `<amd64 | arm64 | armhf | i386>` ('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
2489d6df 165`--net[n]` `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
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
TL
332
333Run fstrim on a chosen CT and its mountpoints.
334
335`<vmid>`: `<integer> (1 - N)` ::
336
337The (unique) ID of the VM.
338
4772952b
TL
339`--ignore-mountpoints` `<boolean>` ::
340
341Skip all mountpoints, only do fstrim on the container root.
342
35a75dd3 343*pct help* `[OPTIONS]`
1f554f76
DM
344
345Get help about specified command.
346
35a75dd3 347`--extra-args` `<array>` ::
1f554f76 348
35a75dd3 349Shows help for a specific command
1f554f76 350
2489d6df 351`--verbose` `<boolean>` ::
1f554f76
DM
352
353Verbose output format.
354
1f554f76
DM
355*pct list*
356
357LXC container index (per node).
358
1f554f76
DM
359*pct listsnapshot* `<vmid>`
360
361List all snapshots.
362
013dc89f 363`<vmid>`: `<integer> (1 - N)` ::
1f554f76
DM
364
365The (unique) ID of the VM.
366
1f554f76
DM
367*pct migrate* `<vmid> <target>` `[OPTIONS]`
368
369Migrate the container to another node. Creates a new migration task.
370
013dc89f 371`<vmid>`: `<integer> (1 - N)` ::
1f554f76
DM
372
373The (unique) ID of the VM.
374
013dc89f 375`<target>`: `<string>` ::
1f554f76
DM
376
377Target node.
378
95895385
TL
379`--bwlimit` `<number> (0 - N)` ('default =' `migrate limit from datacenter or storage config`)::
380
381Override I/O bandwidth limit (in KiB/s).
382
2489d6df 383`--online` `<boolean>` ::
1f554f76
DM
384
385Use online/live migration.
386
2489d6df 387`--restart` `<boolean>` ::
6875b729
DM
388
389Use restart migration
390
c30bb419
TL
391`--target-storage` `<string>` ::
392
393Mapping 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.
394
2489d6df 395`--timeout` `<integer>` ('default =' `180`)::
6875b729
DM
396
397Timeout in seconds for shutdown for restart migration
398
9b3e4991
DM
399*pct mount* `<vmid>`
400
401Mount the container's filesystem on the host. This will hold a lock on the
402container and is meant for emergency maintenance only as it will prevent
403further operations on the container other than start and stop.
404
013dc89f 405`<vmid>`: `<integer> (1 - N)` ::
9b3e4991
DM
406
407The (unique) ID of the VM.
408
5370fa8c 409*pct move-volume* `<vmid> <volume> [<storage>] [<target-vmid>] [<target-volume>]` `[OPTIONS]`
27a7acb2 410
5370fa8c
TL
411Move a rootfs-/mp-volume to a different storage or to a different
412container.
27a7acb2
DM
413
414`<vmid>`: `<integer> (1 - N)` ::
415
416The (unique) ID of the VM.
417
5370fa8c 418`<volume>`: `<mp0 | mp1 | mp10 | mp100 | mp101 | mp102 | mp103 | mp104 | mp105 | mp106 | mp107 | mp108 | mp109 | mp11 | mp110 | mp111 | mp112 | mp113 | mp114 | mp115 | mp116 | mp117 | mp118 | mp119 | mp12 | mp120 | mp121 | mp122 | mp123 | mp124 | mp125 | mp126 | mp127 | mp128 | mp129 | mp13 | mp130 | mp131 | mp132 | mp133 | mp134 | mp135 | mp136 | mp137 | mp138 | mp139 | mp14 | mp140 | mp141 | mp142 | mp143 | mp144 | mp145 | mp146 | mp147 | mp148 | mp149 | mp15 | mp150 | mp151 | mp152 | mp153 | mp154 | mp155 | mp156 | mp157 | mp158 | mp159 | mp16 | mp160 | mp161 | mp162 | mp163 | mp164 | mp165 | mp166 | mp167 | mp168 | mp169 | mp17 | mp170 | mp171 | mp172 | mp173 | mp174 | mp175 | mp176 | mp177 | mp178 | mp179 | mp18 | mp180 | mp181 | mp182 | mp183 | mp184 | mp185 | mp186 | mp187 | mp188 | mp189 | mp19 | mp190 | mp191 | mp192 | mp193 | mp194 | mp195 | mp196 | mp197 | mp198 | mp199 | mp2 | mp20 | mp200 | mp201 | mp202 | mp203 | mp204 | mp205 | mp206 | mp207 | mp208 | mp209 | mp21 | mp210 | mp211 | mp212 | mp213 | mp214 | mp215 | mp216 | mp217 | mp218 | mp219 | mp22 | mp220 | mp221 | mp222 | mp223 | mp224 | mp225 | mp226 | mp227 | mp228 | mp229 | mp23 | mp230 | mp231 | mp232 | mp233 | mp234 | mp235 | mp236 | mp237 | mp238 | mp239 | mp24 | mp240 | mp241 | mp242 | mp243 | mp244 | mp245 | mp246 | mp247 | mp248 | mp249 | mp25 | mp250 | mp251 | mp252 | mp253 | mp254 | mp255 | mp26 | mp27 | mp28 | mp29 | mp3 | mp30 | mp31 | mp32 | mp33 | mp34 | mp35 | mp36 | mp37 | mp38 | mp39 | mp4 | mp40 | mp41 | mp42 | mp43 | mp44 | mp45 | mp46 | mp47 | mp48 | mp49 | mp5 | mp50 | mp51 | mp52 | mp53 | mp54 | mp55 | mp56 | mp57 | mp58 | mp59 | mp6 | mp60 | mp61 | mp62 | mp63 | mp64 | mp65 | mp66 | mp67 | mp68 | mp69 | mp7 | mp70 | mp71 | mp72 | mp73 | mp74 | mp75 | mp76 | mp77 | mp78 | mp79 | mp8 | mp80 | mp81 | mp82 | mp83 | mp84 | mp85 | mp86 | mp87 | mp88 | mp89 | mp9 | mp90 | mp91 | mp92 | mp93 | mp94 | mp95 | mp96 | mp97 | mp98 | mp99 | rootfs | unused0 | unused1 | unused10 | unused100 | unused101 | unused102 | unused103 | unused104 | unused105 | unused106 | unused107 | unused108 | unused109 | unused11 | unused110 | unused111 | unused112 | unused113 | unused114 | unused115 | unused116 | unused117 | unused118 | unused119 | unused12 | unused120 | unused121 | unused122 | unused123 | unused124 | unused125 | unused126 | unused127 | unused128 | unused129 | unused13 | unused130 | unused131 | unused132 | unused133 | unused134 | unused135 | unused136 | unused137 | unused138 | unused139 | unused14 | unused140 | unused141 | unused142 | unused143 | unused144 | unused145 | unused146 | unused147 | unused148 | unused149 | unused15 | unused150 | unused151 | unused152 | unused153 | unused154 | unused155 | unused156 | unused157 | unused158 | unused159 | unused16 | unused160 | unused161 | unused162 | unused163 | unused164 | unused165 | unused166 | unused167 | unused168 | unused169 | unused17 | unused170 | unused171 | unused172 | unused173 | unused174 | unused175 | unused176 | unused177 | unused178 | unused179 | unused18 | unused180 | unused181 | unused182 | unused183 | unused184 | unused185 | unused186 | unused187 | unused188 | unused189 | unused19 | unused190 | unused191 | unused192 | unused193 | unused194 | unused195 | unused196 | unused197 | unused198 | unused199 | unused2 | unused20 | unused200 | unused201 | unused202 | unused203 | unused204 | unused205 | unused206 | unused207 | unused208 | unused209 | unused21 | unused210 | unused211 | unused212 | unused213 | unused214 | unused215 | unused216 | unused217 | unused218 | unused219 | unused22 | unused220 | unused221 | unused222 | unused223 | unused224 | unused225 | unused226 | unused227 | unused228 | unused229 | unused23 | unused230 | unused231 | unused232 | unused233 | unused234 | unused235 | unused236 | unused237 | unused238 | unused239 | unused24 | unused240 | unused241 | unused242 | unused243 | unused244 | unused245 | unused246 | unused247 | unused248 | unused249 | unused25 | unused250 | unused251 | unused252 | unused253 | unused254 | unused255 | unused26 | unused27 | unused28 | unused29 | unused3 | unused30 | unused31 | unused32 | unused33 | unused34 | unused35 | unused36 | unused37 | unused38 | unused39 | unused4 | unused40 | unused41 | unused42 | unused43 | unused44 | unused45 | unused46 | unused47 | unused48 | unused49 | unused5 | unused50 | unused51 | unused52 | unused53 | unused54 | unused55 | unused56 | unused57 | unused58 | unused59 | unused6 | unused60 | unused61 | unused62 | unused63 | unused64 | unused65 | unused66 | unused67 | unused68 | unused69 | unused7 | unused70 | unused71 | unused72 | unused73 | unused74 | unused75 | unused76 | unused77 | unused78 | unused79 | unused8 | unused80 | unused81 | unused82 | unused83 | unused84 | unused85 | unused86 | unused87 | unused88 | unused89 | unused9 | unused90 | unused91 | unused92 | unused93 | unused94 | unused95 | unused96 | unused97 | unused98 | unused99>` ::
27a7acb2
DM
419
420Volume which will be moved.
421
422`<storage>`: `<string>` ::
423
424Target Storage.
425
5370fa8c
TL
426`<target-vmid>`: `<integer> (1 - N)` ::
427
428The (unique) ID of the VM.
429
430`<target-volume>`: `<mp0 | mp1 | mp10 | mp100 | mp101 | mp102 | mp103 | mp104 | mp105 | mp106 | mp107 | mp108 | mp109 | mp11 | mp110 | mp111 | mp112 | mp113 | mp114 | mp115 | mp116 | mp117 | mp118 | mp119 | mp12 | mp120 | mp121 | mp122 | mp123 | mp124 | mp125 | mp126 | mp127 | mp128 | mp129 | mp13 | mp130 | mp131 | mp132 | mp133 | mp134 | mp135 | mp136 | mp137 | mp138 | mp139 | mp14 | mp140 | mp141 | mp142 | mp143 | mp144 | mp145 | mp146 | mp147 | mp148 | mp149 | mp15 | mp150 | mp151 | mp152 | mp153 | mp154 | mp155 | mp156 | mp157 | mp158 | mp159 | mp16 | mp160 | mp161 | mp162 | mp163 | mp164 | mp165 | mp166 | mp167 | mp168 | mp169 | mp17 | mp170 | mp171 | mp172 | mp173 | mp174 | mp175 | mp176 | mp177 | mp178 | mp179 | mp18 | mp180 | mp181 | mp182 | mp183 | mp184 | mp185 | mp186 | mp187 | mp188 | mp189 | mp19 | mp190 | mp191 | mp192 | mp193 | mp194 | mp195 | mp196 | mp197 | mp198 | mp199 | mp2 | mp20 | mp200 | mp201 | mp202 | mp203 | mp204 | mp205 | mp206 | mp207 | mp208 | mp209 | mp21 | mp210 | mp211 | mp212 | mp213 | mp214 | mp215 | mp216 | mp217 | mp218 | mp219 | mp22 | mp220 | mp221 | mp222 | mp223 | mp224 | mp225 | mp226 | mp227 | mp228 | mp229 | mp23 | mp230 | mp231 | mp232 | mp233 | mp234 | mp235 | mp236 | mp237 | mp238 | mp239 | mp24 | mp240 | mp241 | mp242 | mp243 | mp244 | mp245 | mp246 | mp247 | mp248 | mp249 | mp25 | mp250 | mp251 | mp252 | mp253 | mp254 | mp255 | mp26 | mp27 | mp28 | mp29 | mp3 | mp30 | mp31 | mp32 | mp33 | mp34 | mp35 | mp36 | mp37 | mp38 | mp39 | mp4 | mp40 | mp41 | mp42 | mp43 | mp44 | mp45 | mp46 | mp47 | mp48 | mp49 | mp5 | mp50 | mp51 | mp52 | mp53 | mp54 | mp55 | mp56 | mp57 | mp58 | mp59 | mp6 | mp60 | mp61 | mp62 | mp63 | mp64 | mp65 | mp66 | mp67 | mp68 | mp69 | mp7 | mp70 | mp71 | mp72 | mp73 | mp74 | mp75 | mp76 | mp77 | mp78 | mp79 | mp8 | mp80 | mp81 | mp82 | mp83 | mp84 | mp85 | mp86 | mp87 | mp88 | mp89 | mp9 | mp90 | mp91 | mp92 | mp93 | mp94 | mp95 | mp96 | mp97 | mp98 | mp99 | rootfs | unused0 | unused1 | unused10 | unused100 | unused101 | unused102 | unused103 | unused104 | unused105 | unused106 | unused107 | unused108 | unused109 | unused11 | unused110 | unused111 | unused112 | unused113 | unused114 | unused115 | unused116 | unused117 | unused118 | unused119 | unused12 | unused120 | unused121 | unused122 | unused123 | unused124 | unused125 | unused126 | unused127 | unused128 | unused129 | unused13 | unused130 | unused131 | unused132 | unused133 | unused134 | unused135 | unused136 | unused137 | unused138 | unused139 | unused14 | unused140 | unused141 | unused142 | unused143 | unused144 | unused145 | unused146 | unused147 | unused148 | unused149 | unused15 | unused150 | unused151 | unused152 | unused153 | unused154 | unused155 | unused156 | unused157 | unused158 | unused159 | unused16 | unused160 | unused161 | unused162 | unused163 | unused164 | unused165 | unused166 | unused167 | unused168 | unused169 | unused17 | unused170 | unused171 | unused172 | unused173 | unused174 | unused175 | unused176 | unused177 | unused178 | unused179 | unused18 | unused180 | unused181 | unused182 | unused183 | unused184 | unused185 | unused186 | unused187 | unused188 | unused189 | unused19 | unused190 | unused191 | unused192 | unused193 | unused194 | unused195 | unused196 | unused197 | unused198 | unused199 | unused2 | unused20 | unused200 | unused201 | unused202 | unused203 | unused204 | unused205 | unused206 | unused207 | unused208 | unused209 | unused21 | unused210 | unused211 | unused212 | unused213 | unused214 | unused215 | unused216 | unused217 | unused218 | unused219 | unused22 | unused220 | unused221 | unused222 | unused223 | unused224 | unused225 | unused226 | unused227 | unused228 | unused229 | unused23 | unused230 | unused231 | unused232 | unused233 | unused234 | unused235 | unused236 | unused237 | unused238 | unused239 | unused24 | unused240 | unused241 | unused242 | unused243 | unused244 | unused245 | unused246 | unused247 | unused248 | unused249 | unused25 | unused250 | unused251 | unused252 | unused253 | unused254 | unused255 | unused26 | unused27 | unused28 | unused29 | unused3 | unused30 | unused31 | unused32 | unused33 | unused34 | unused35 | unused36 | unused37 | unused38 | unused39 | unused4 | unused40 | unused41 | unused42 | unused43 | unused44 | unused45 | unused46 | unused47 | unused48 | unused49 | unused5 | unused50 | unused51 | unused52 | unused53 | unused54 | unused55 | unused56 | unused57 | unused58 | unused59 | unused6 | unused60 | unused61 | unused62 | unused63 | unused64 | unused65 | unused66 | unused67 | unused68 | unused69 | unused7 | unused70 | unused71 | unused72 | unused73 | unused74 | unused75 | unused76 | unused77 | unused78 | unused79 | unused8 | unused80 | unused81 | unused82 | unused83 | unused84 | unused85 | unused86 | unused87 | unused88 | unused89 | unused9 | unused90 | unused91 | unused92 | unused93 | unused94 | unused95 | unused96 | unused97 | unused98 | unused99>` ::
431
432The config key the volume will be moved to. Default is the source volume key.
433
95895385
TL
434`--bwlimit` `<number> (0 - N)` ('default =' `clone limit from datacenter or storage config`)::
435
436Override I/O bandwidth limit (in KiB/s).
437
27a7acb2
DM
438`--delete` `<boolean>` ('default =' `0`)::
439
440Delete the original volume after successful copy. By default the original is kept as an unused volume entry.
441
442`--digest` `<string>` ::
443
5370fa8c
TL
444Prevent changes if current configuration file has different SHA1 " .
445 "digest. This can be used to prevent concurrent modifications.
446
447`--target-digest` `<string>` ::
448
449Prevent changes if current configuration file of the target " .
450 "container has a different SHA1 digest. This can be used to prevent " .
451 "concurrent modifications.
452
453*pct move_volume*
454
455An alias for 'pct move-volume'.
27a7acb2 456
1c532546
TL
457*pct pending* `<vmid>`
458
459Get container configuration, including pending changes.
460
461`<vmid>`: `<integer> (1 - N)` ::
462
463The (unique) ID of the VM.
464
9b3e4991
DM
465*pct pull* `<vmid> <path> <destination>` `[OPTIONS]`
466
467Copy a file from the container to the local system.
468
013dc89f 469`<vmid>`: `<integer> (1 - N)` ::
9b3e4991
DM
470
471The (unique) ID of the VM.
472
013dc89f 473`<path>`: `<string>` ::
9b3e4991
DM
474
475Path to a file inside the container to pull.
476
013dc89f 477`<destination>`: `<string>` ::
9b3e4991
DM
478
479Destination
480
2489d6df 481`--group` `<string>` ::
9b3e4991
DM
482
483Owner group name or id.
484
2489d6df 485`--perms` `<string>` ::
9b3e4991 486
c2993fe5 487File permissions to use (octal by default, prefix with '0x' for hexadecimal).
9b3e4991 488
2489d6df 489`--user` `<string>` ::
9b3e4991
DM
490
491Owner user name or id.
492
9b3e4991
DM
493*pct push* `<vmid> <file> <destination>` `[OPTIONS]`
494
495Copy a local file to the container.
496
013dc89f 497`<vmid>`: `<integer> (1 - N)` ::
9b3e4991
DM
498
499The (unique) ID of the VM.
500
013dc89f 501`<file>`: `<string>` ::
9b3e4991
DM
502
503Path to a local file.
504
013dc89f 505`<destination>`: `<string>` ::
9b3e4991
DM
506
507Destination inside the container to write to.
508
2489d6df 509`--group` `<string>` ::
9b3e4991 510
c2993fe5 511Owner group name or id. When using a name it must exist inside the container.
9b3e4991 512
2489d6df 513`--perms` `<string>` ::
9b3e4991 514
c2993fe5 515File permissions to use (octal by default, prefix with '0x' for hexadecimal).
9b3e4991 516
2489d6df 517`--user` `<string>` ::
9b3e4991 518
c2993fe5 519Owner user name or id. When using a name it must exist inside the container.
9b3e4991 520
5c1699e5
TL
521*pct reboot* `<vmid>` `[OPTIONS]`
522
523Reboot the container by shutting it down, and starting it again. Applies
524pending changes.
525
526`<vmid>`: `<integer> (1 - N)` ::
527
528The (unique) ID of the VM.
529
530`--timeout` `<integer> (0 - N)` ::
531
532Wait maximal timeout seconds for the shutdown.
533
81a3384d
TL
534*pct remote-migrate* `<vmid> [<target-vmid>] <target-endpoint> --target-bridge <string> --target-storage <string>` `[OPTIONS]`
535
536Migrate container to a remote cluster. Creates a new migration task.
537EXPERIMENTAL feature!
538
539`<vmid>`: `<integer> (1 - N)` ::
540
541The (unique) ID of the VM.
542
543`<target-vmid>`: `<integer> (1 - N)` ::
544
545The (unique) ID of the VM.
546
547`<target-endpoint>`: `apitoken=<A full Proxmox API token including the secret value.> ,host=<Remote Proxmox hostname or IP> [,fingerprint=<Remote host's certificate fingerprint, if not trusted by system store.>] [,port=<integer>]` ::
548
549Remote target endpoint
550
551`--bwlimit` `<integer> (0 - N)` ('default =' `migrate limit from datacenter or storage config`)::
552
553Override I/O bandwidth limit (in KiB/s).
554
555`--delete` `<boolean>` ('default =' `0`)::
556
557Delete the original CT and related data after successful migration. By default the original CT is kept on the source cluster in a stopped state.
558
559`--online` `<boolean>` ::
560
561Use online/live migration.
562
563`--restart` `<boolean>` ::
564
565Use restart migration
566
567`--target-bridge` `<string>` ::
568
569Mapping 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.
570
571`--target-storage` `<string>` ::
572
573Mapping 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.
574
575`--timeout` `<integer>` ('default =' `180`)::
576
577Timeout in seconds for shutdown for restart migration
578
e2d681b3
TL
579*pct rescan* `[OPTIONS]`
580
581Rescan all storages and update disk sizes and unused disk images.
582
583`--dryrun` `<boolean>` ('default =' `0`)::
584
585Do not actually write changes out to conifg.
586
587`--vmid` `<integer> (1 - N)` ::
588
589The (unique) ID of the VM.
590
1f554f76
DM
591*pct resize* `<vmid> <disk> <size>` `[OPTIONS]`
592
de0983cb 593Resize a container mount point.
1f554f76 594
013dc89f 595`<vmid>`: `<integer> (1 - N)` ::
1f554f76
DM
596
597The (unique) ID of the VM.
598
4d47f125 599`<disk>`: `<mp0 | mp1 | mp10 | mp100 | mp101 | mp102 | mp103 | mp104 | mp105 | mp106 | mp107 | mp108 | mp109 | mp11 | mp110 | mp111 | mp112 | mp113 | mp114 | mp115 | mp116 | mp117 | mp118 | mp119 | mp12 | mp120 | mp121 | mp122 | mp123 | mp124 | mp125 | mp126 | mp127 | mp128 | mp129 | mp13 | mp130 | mp131 | mp132 | mp133 | mp134 | mp135 | mp136 | mp137 | mp138 | mp139 | mp14 | mp140 | mp141 | mp142 | mp143 | mp144 | mp145 | mp146 | mp147 | mp148 | mp149 | mp15 | mp150 | mp151 | mp152 | mp153 | mp154 | mp155 | mp156 | mp157 | mp158 | mp159 | mp16 | mp160 | mp161 | mp162 | mp163 | mp164 | mp165 | mp166 | mp167 | mp168 | mp169 | mp17 | mp170 | mp171 | mp172 | mp173 | mp174 | mp175 | mp176 | mp177 | mp178 | mp179 | mp18 | mp180 | mp181 | mp182 | mp183 | mp184 | mp185 | mp186 | mp187 | mp188 | mp189 | mp19 | mp190 | mp191 | mp192 | mp193 | mp194 | mp195 | mp196 | mp197 | mp198 | mp199 | mp2 | mp20 | mp200 | mp201 | mp202 | mp203 | mp204 | mp205 | mp206 | mp207 | mp208 | mp209 | mp21 | mp210 | mp211 | mp212 | mp213 | mp214 | mp215 | mp216 | mp217 | mp218 | mp219 | mp22 | mp220 | mp221 | mp222 | mp223 | mp224 | mp225 | mp226 | mp227 | mp228 | mp229 | mp23 | mp230 | mp231 | mp232 | mp233 | mp234 | mp235 | mp236 | mp237 | mp238 | mp239 | mp24 | mp240 | mp241 | mp242 | mp243 | mp244 | mp245 | mp246 | mp247 | mp248 | mp249 | mp25 | mp250 | mp251 | mp252 | mp253 | mp254 | mp255 | mp26 | mp27 | mp28 | mp29 | mp3 | mp30 | mp31 | mp32 | mp33 | mp34 | mp35 | mp36 | mp37 | mp38 | mp39 | mp4 | mp40 | mp41 | mp42 | mp43 | mp44 | mp45 | mp46 | mp47 | mp48 | mp49 | mp5 | mp50 | mp51 | mp52 | mp53 | mp54 | mp55 | mp56 | mp57 | mp58 | mp59 | mp6 | mp60 | mp61 | mp62 | mp63 | mp64 | mp65 | mp66 | mp67 | mp68 | mp69 | mp7 | mp70 | mp71 | mp72 | mp73 | mp74 | mp75 | mp76 | mp77 | mp78 | mp79 | mp8 | mp80 | mp81 | mp82 | mp83 | mp84 | mp85 | mp86 | mp87 | mp88 | mp89 | mp9 | mp90 | mp91 | mp92 | mp93 | mp94 | mp95 | mp96 | mp97 | mp98 | mp99 | rootfs>` ::
1f554f76
DM
600
601The disk you want to resize.
602
013dc89f 603`<size>`: `\+?\d+(\.\d+)?[KMGT]?` ::
1f554f76 604
c2993fe5 605The 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 606
2489d6df 607`--digest` `<string>` ::
1f554f76 608
c2993fe5 609Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
1f554f76 610
1f554f76
DM
611*pct restore* `<vmid> <ostemplate>` `[OPTIONS]`
612
613Create or restore a container.
614
013dc89f 615`<vmid>`: `<integer> (1 - N)` ::
1f554f76
DM
616
617The (unique) ID of the VM.
618
013dc89f 619`<ostemplate>`: `<string>` ::
1f554f76
DM
620
621The OS template or backup file.
622
4d47f125 623`--arch` `<amd64 | arm64 | armhf | i386>` ('default =' `amd64`)::
1f554f76
DM
624
625OS architecture type.
626
95895385 627`--bwlimit` `<number> (0 - N)` ('default =' `restore limit from datacenter or storage config`)::
27a7acb2 628
95895385 629Override I/O bandwidth limit (in KiB/s).
27a7acb2 630
2489d6df 631`--cmode` `<console | shell | tty>` ('default =' `tty`)::
1f554f76 632
c2993fe5 633Console 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 634
2489d6df 635`--console` `<boolean>` ('default =' `1`)::
1f554f76
DM
636
637Attach a console device (/dev/console) to the container.
638
4772952b 639`--cores` `<integer> (1 - 8192)` ::
de0983cb
DM
640
641The number of cores assigned to the container. A container can use all available cores by default.
642
4772952b 643`--cpulimit` `<number> (0 - 8192)` ('default =' `0`)::
1f554f76 644
9b3e4991
DM
645Limit of CPU usage.
646+
c2993fe5 647NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.
1f554f76 648
4e7f60c2 649`--cpuunits` `<integer> (0 - 500000)` ('default =' `cgroup v1: 1024, cgroup v2: 100`)::
1f554f76 650
4e7f60c2 651CPU weight for a container, will be clamped to [1, 10000] in cgroup v2.
1f554f76 652
739d4d64
TL
653`--debug` `<boolean>` ('default =' `0`)::
654
655Try to be more verbose. For now this only enables debug log-level on start.
656
2489d6df 657`--description` `<string>` ::
1f554f76 658
8f4d9c87 659Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file.
1f554f76 660
c5aa7e14 661`--features` `[force_rw_sys=<1|0>] [,fuse=<1|0>] [,keyctl=<1|0>] [,mknod=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
4d47f125
TL
662
663Allow containers access to advanced features.
664
2489d6df 665`--force` `<boolean>` ::
1f554f76
DM
666
667Allow to overwrite existing container.
668
5f26e15b
TL
669`--hookscript` `<string>` ::
670
671Script that will be exectued during various steps in the containers lifetime.
672
2489d6df 673`--hostname` `<string>` ::
1f554f76
DM
674
675Set a host name for the container.
676
2489d6df 677`--ignore-unpack-errors` `<boolean>` ::
1f554f76
DM
678
679Ignore errors when extracting the template.
680
1c532546 681`--lock` `<backup | create | destroyed | disk | fstrim | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
1f554f76 682
4e7f60c2 683Lock/unlock the container.
1f554f76 684
2489d6df 685`--memory` `<integer> (16 - N)` ('default =' `512`)::
1f554f76 686
4e7f60c2 687Amount of RAM for the container in MB.
1f554f76 688
7cbed89a 689`--mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
1f554f76 690
d2656385 691Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
1f554f76 692
2489d6df 693`--nameserver` `<string>` ::
1f554f76 694
c2993fe5 695Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
1f554f76 696
2489d6df 697`--net[n]` `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
1f554f76
DM
698
699Specifies network interfaces for the container.
700
2489d6df 701`--onboot` `<boolean>` ('default =' `0`)::
1f554f76 702
4e7f60c2 703Specifies whether a container will be started during system bootup.
1f554f76 704
7af2edf9 705`--ostype` `<alpine | archlinux | centos | debian | devuan | fedora | gentoo | nixos | opensuse | ubuntu | unmanaged>` ::
1f554f76 706
c2993fe5 707OS 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 708
5da3d723 709`--password` `<password>` ::
1f554f76
DM
710
711Sets root password inside container.
712
2489d6df 713`--pool` `<string>` ::
1f554f76
DM
714
715Add the VM to the specified pool.
716
2489d6df 717`--protection` `<boolean>` ('default =' `0`)::
1f554f76 718
c2993fe5 719Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
1f554f76 720
7cbed89a 721`--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
722
723Use volume as container root.
724
2489d6df 725`--searchdomain` `<string>` ::
1f554f76 726
c2993fe5 727Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
9b3e4991 728
2489d6df 729`--ssh-public-keys` `<filepath>` ::
9b3e4991
DM
730
731Setup public SSH keys (one key per line, OpenSSH format).
1f554f76 732
5da3d723
TL
733`--start` `<boolean>` ('default =' `0`)::
734
735Start the CT after its creation finished successfully.
736
2489d6df 737`--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
1f554f76 738
c2993fe5 739Startup 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 740
2489d6df 741`--storage` `<string>` ('default =' `local`)::
1f554f76
DM
742
743Default Storage.
744
2489d6df 745`--swap` `<integer> (0 - N)` ('default =' `512`)::
1f554f76 746
4e7f60c2 747Amount of SWAP for the container in MB.
1f554f76 748
5c1699e5
TL
749`--tags` `<string>` ::
750
751Tags of the Container. This is only meta information.
752
2489d6df 753`--template` `<boolean>` ('default =' `0`)::
1f554f76
DM
754
755Enable/disable Template.
756
04d22a9f
TL
757`--timezone` `<string>` ::
758
759Time 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
760
2489d6df 761`--tty` `<integer> (0 - 6)` ('default =' `2`)::
1f554f76
DM
762
763Specify the number of tty available to the container
764
95895385
TL
765`--unique` `<boolean>` ::
766
767Assign a unique random ethernet address.
768+
769NOTE: Requires option(s): `restore`
770
2489d6df 771`--unprivileged` `<boolean>` ('default =' `0`)::
1f554f76 772
c2993fe5 773Makes the container run as unprivileged user. (Should not be modified manually.)
1f554f76 774
c5aa7e14 775`--unused[n]` `[volume=]<volume>` ::
1f554f76 776
c2993fe5 777Reference to unused volumes. This is used internally, and should not be modified manually.
1f554f76 778
1f554f76
DM
779*pct resume* `<vmid>`
780
781Resume the container.
782
013dc89f 783`<vmid>`: `<integer> (1 - N)` ::
1f554f76
DM
784
785The (unique) ID of the VM.
786
4e7f60c2 787*pct rollback* `<vmid> <snapname>` `[OPTIONS]`
1f554f76
DM
788
789Rollback LXC state to specified snapshot.
790
013dc89f 791`<vmid>`: `<integer> (1 - N)` ::
1f554f76
DM
792
793The (unique) ID of the VM.
794
013dc89f 795`<snapname>`: `<string>` ::
1f554f76
DM
796
797The name of the snapshot.
798
4e7f60c2
TL
799`--start` `<boolean>` ('default =' `0`)::
800
801Whether the container should get started after rolling back successfully
802
1f554f76
DM
803*pct set* `<vmid>` `[OPTIONS]`
804
805Set container options.
806
013dc89f 807`<vmid>`: `<integer> (1 - N)` ::
1f554f76
DM
808
809The (unique) ID of the VM.
810
4d47f125 811`--arch` `<amd64 | arm64 | armhf | i386>` ('default =' `amd64`)::
1f554f76
DM
812
813OS architecture type.
814
2489d6df 815`--cmode` `<console | shell | tty>` ('default =' `tty`)::
1f554f76 816
c2993fe5 817Console 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 818
2489d6df 819`--console` `<boolean>` ('default =' `1`)::
1f554f76
DM
820
821Attach a console device (/dev/console) to the container.
822
4772952b 823`--cores` `<integer> (1 - 8192)` ::
de0983cb
DM
824
825The number of cores assigned to the container. A container can use all available cores by default.
826
4772952b 827`--cpulimit` `<number> (0 - 8192)` ('default =' `0`)::
1f554f76 828
9b3e4991
DM
829Limit of CPU usage.
830+
c2993fe5 831NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.
1f554f76 832
4e7f60c2 833`--cpuunits` `<integer> (0 - 500000)` ('default =' `cgroup v1: 1024, cgroup v2: 100`)::
1f554f76 834
4e7f60c2 835CPU weight for a container, will be clamped to [1, 10000] in cgroup v2.
1f554f76 836
739d4d64
TL
837`--debug` `<boolean>` ('default =' `0`)::
838
839Try to be more verbose. For now this only enables debug log-level on start.
840
2489d6df 841`--delete` `<string>` ::
1f554f76
DM
842
843A list of settings you want to delete.
844
2489d6df 845`--description` `<string>` ::
1f554f76 846
8f4d9c87 847Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file.
1f554f76 848
2489d6df 849`--digest` `<string>` ::
1f554f76 850
c2993fe5 851Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
1f554f76 852
c5aa7e14 853`--features` `[force_rw_sys=<1|0>] [,fuse=<1|0>] [,keyctl=<1|0>] [,mknod=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
4d47f125
TL
854
855Allow containers access to advanced features.
856
5f26e15b
TL
857`--hookscript` `<string>` ::
858
859Script that will be exectued during various steps in the containers lifetime.
860
2489d6df 861`--hostname` `<string>` ::
1f554f76
DM
862
863Set a host name for the container.
864
1c532546 865`--lock` `<backup | create | destroyed | disk | fstrim | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
1f554f76 866
4e7f60c2 867Lock/unlock the container.
1f554f76 868
2489d6df 869`--memory` `<integer> (16 - N)` ('default =' `512`)::
1f554f76 870
4e7f60c2 871Amount of RAM for the container in MB.
1f554f76 872
7cbed89a 873`--mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
1f554f76 874
d2656385 875Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
1f554f76 876
2489d6df 877`--nameserver` `<string>` ::
1f554f76 878
c2993fe5 879Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
1f554f76 880
2489d6df 881`--net[n]` `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
1f554f76
DM
882
883Specifies network interfaces for the container.
884
2489d6df 885`--onboot` `<boolean>` ('default =' `0`)::
1f554f76 886
4e7f60c2 887Specifies whether a container will be started during system bootup.
1f554f76 888
7af2edf9 889`--ostype` `<alpine | archlinux | centos | debian | devuan | fedora | gentoo | nixos | opensuse | ubuntu | unmanaged>` ::
1f554f76 890
c2993fe5 891OS 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 892
2489d6df 893`--protection` `<boolean>` ('default =' `0`)::
1f554f76 894
c2993fe5 895Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
1f554f76 896
1c532546
TL
897`--revert` `<string>` ::
898
899Revert a pending change.
900
7cbed89a 901`--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
902
903Use volume as container root.
904
2489d6df 905`--searchdomain` `<string>` ::
1f554f76 906
c2993fe5 907Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
1f554f76 908
2489d6df 909`--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
1f554f76 910
c2993fe5 911Startup 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 912
2489d6df 913`--swap` `<integer> (0 - N)` ('default =' `512`)::
1f554f76 914
4e7f60c2 915Amount of SWAP for the container in MB.
1f554f76 916
5c1699e5
TL
917`--tags` `<string>` ::
918
919Tags of the Container. This is only meta information.
920
2489d6df 921`--template` `<boolean>` ('default =' `0`)::
1f554f76
DM
922
923Enable/disable Template.
924
04d22a9f
TL
925`--timezone` `<string>` ::
926
927Time 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
928
2489d6df 929`--tty` `<integer> (0 - 6)` ('default =' `2`)::
1f554f76
DM
930
931Specify the number of tty available to the container
932
2489d6df 933`--unprivileged` `<boolean>` ('default =' `0`)::
1f554f76 934
c2993fe5 935Makes the container run as unprivileged user. (Should not be modified manually.)
1f554f76 936
c5aa7e14 937`--unused[n]` `[volume=]<volume>` ::
1f554f76 938
c2993fe5 939Reference to unused volumes. This is used internally, and should not be modified manually.
1f554f76 940
1f554f76
DM
941*pct shutdown* `<vmid>` `[OPTIONS]`
942
9b3e4991
DM
943Shutdown the container. This will trigger a clean shutdown of the
944container, see lxc-stop(1) for details.
1f554f76 945
013dc89f 946`<vmid>`: `<integer> (1 - N)` ::
1f554f76
DM
947
948The (unique) ID of the VM.
949
2489d6df 950`--forceStop` `<boolean>` ('default =' `0`)::
1f554f76
DM
951
952Make sure the Container stops.
953
2489d6df 954`--timeout` `<integer> (0 - N)` ('default =' `60`)::
1f554f76
DM
955
956Wait maximal timeout seconds.
957
1f554f76
DM
958*pct snapshot* `<vmid> <snapname>` `[OPTIONS]`
959
960Snapshot a container.
961
013dc89f 962`<vmid>`: `<integer> (1 - N)` ::
1f554f76
DM
963
964The (unique) ID of the VM.
965
013dc89f 966`<snapname>`: `<string>` ::
1f554f76
DM
967
968The name of the snapshot.
969
2489d6df 970`--description` `<string>` ::
1f554f76
DM
971
972A textual description or comment.
973
9b3e4991 974*pct start* `<vmid>` `[OPTIONS]`
1f554f76
DM
975
976Start the container.
977
013dc89f 978`<vmid>`: `<integer> (1 - N)` ::
1f554f76
DM
979
980The (unique) ID of the VM.
981
739d4d64
TL
982`--debug` `<boolean>` ('default =' `0`)::
983
984If set, enables very verbose debug log-level on start.
985
2489d6df 986`--skiplock` `<boolean>` ::
9b3e4991
DM
987
988Ignore locks - only root is allowed to use this option.
989
2c0dde61
DM
990*pct status* `<vmid>` `[OPTIONS]`
991
992Show CT status.
993
013dc89f 994`<vmid>`: `<integer> (1 - N)` ::
2c0dde61
DM
995
996The (unique) ID of the VM.
997
2489d6df 998`--verbose` `<boolean>` ::
2c0dde61
DM
999
1000Verbose output format
1001
9b3e4991 1002*pct stop* `<vmid>` `[OPTIONS]`
1f554f76 1003
9b3e4991
DM
1004Stop the container. This will abruptly stop all processes running in the
1005container.
1f554f76 1006
013dc89f 1007`<vmid>`: `<integer> (1 - N)` ::
1f554f76
DM
1008
1009The (unique) ID of the VM.
1010
2489d6df 1011`--skiplock` `<boolean>` ::
9b3e4991
DM
1012
1013Ignore locks - only root is allowed to use this option.
1014
1f554f76
DM
1015*pct suspend* `<vmid>`
1016
5370fa8c 1017Suspend the container. This is experimental.
1f554f76 1018
013dc89f 1019`<vmid>`: `<integer> (1 - N)` ::
1f554f76
DM
1020
1021The (unique) ID of the VM.
1022
27a7acb2 1023*pct template* `<vmid>`
1f554f76
DM
1024
1025Create a Template.
1026
013dc89f 1027`<vmid>`: `<integer> (1 - N)` ::
1f554f76
DM
1028
1029The (unique) ID of the VM.
1030
1f554f76
DM
1031*pct unlock* `<vmid>`
1032
1033Unlock the VM.
1034
013dc89f 1035`<vmid>`: `<integer> (1 - N)` ::
1f554f76
DM
1036
1037The (unique) ID of the VM.
1038
9b3e4991
DM
1039*pct unmount* `<vmid>`
1040
1041Unmount the container's filesystem.
1042
013dc89f 1043`<vmid>`: `<integer> (1 - N)` ::
9b3e4991
DM
1044
1045The (unique) ID of the VM.
1046
1047