]>
Commit | Line | Data |
---|---|---|
1f554f76 DM |
1 | *qm* `<COMMAND> [ARGS] [OPTIONS]` |
2 | ||
4d47f125 | 3 | *qm agent* |
32d876b5 | 4 | |
4d47f125 | 5 | An alias for 'qm guest cmd'. |
32d876b5 | 6 | |
e2d681b3 TL |
7 | *qm cleanup* `<vmid> <clean-shutdown> <guest-requested>` |
8 | ||
9 | Cleans up resources like tap devices, vgpus, etc. Called after a vm shuts | |
10 | down, crashes, etc. | |
11 | ||
12 | `<vmid>`: `<integer> (1 - N)` :: | |
13 | ||
14 | The (unique) ID of the VM. | |
15 | ||
16 | `<clean-shutdown>`: `<boolean>` :: | |
17 | ||
18 | Indicates if qemu shutdown cleanly. | |
19 | ||
20 | `<guest-requested>`: `<boolean>` :: | |
21 | ||
22 | Indicates if the shutdown was requested by the guest or via qmp. | |
23 | ||
1f554f76 DM |
24 | *qm clone* `<vmid> <newid>` `[OPTIONS]` |
25 | ||
26 | Create a copy of virtual machine/template. | |
27 | ||
013dc89f | 28 | `<vmid>`: `<integer> (1 - N)` :: |
1f554f76 DM |
29 | |
30 | The (unique) ID of the VM. | |
31 | ||
013dc89f | 32 | `<newid>`: `<integer> (1 - N)` :: |
1f554f76 DM |
33 | |
34 | VMID for the clone. | |
35 | ||
95895385 TL |
36 | `--bwlimit` `<integer> (0 - N)` ('default =' `clone limit from datacenter or storage config`):: |
37 | ||
38 | Override I/O bandwidth limit (in KiB/s). | |
39 | ||
2489d6df | 40 | `--description` `<string>` :: |
1f554f76 DM |
41 | |
42 | Description for the new VM. | |
43 | ||
2489d6df | 44 | `--format` `<qcow2 | raw | vmdk>` :: |
1f554f76 | 45 | |
27a7acb2 | 46 | Target format for file storage. Only valid for full clone. |
1f554f76 | 47 | |
27a7acb2 | 48 | `--full` `<boolean>` :: |
1f554f76 | 49 | |
27a7acb2 | 50 | Create a full copy of all disks. This is always done when you clone a normal VM. For VM templates, we try to create a linked clone by default. |
1f554f76 | 51 | |
2489d6df | 52 | `--name` `<string>` :: |
1f554f76 DM |
53 | |
54 | Set a name for the new VM. | |
55 | ||
2489d6df | 56 | `--pool` `<string>` :: |
1f554f76 DM |
57 | |
58 | Add the new VM to the specified pool. | |
59 | ||
2489d6df | 60 | `--snapname` `<string>` :: |
1f554f76 DM |
61 | |
62 | The name of the snapshot. | |
63 | ||
2489d6df | 64 | `--storage` `<string>` :: |
1f554f76 DM |
65 | |
66 | Target storage for full clone. | |
1f554f76 | 67 | |
2489d6df | 68 | `--target` `<string>` :: |
1f554f76 DM |
69 | |
70 | Target node. Only allowed if the original VM is on shared storage. | |
71 | ||
1e3f8156 TL |
72 | *qm cloudinit dump* `<vmid> <type>` |
73 | ||
74 | Get automatically generated cloudinit config. | |
75 | ||
76 | `<vmid>`: `<integer> (1 - N)` :: | |
77 | ||
78 | The (unique) ID of the VM. | |
79 | ||
80 | `<type>`: `<meta | network | user>` :: | |
81 | ||
82 | Config type. | |
83 | ||
4e7f60c2 TL |
84 | *qm cloudinit pending* `<vmid>` |
85 | ||
86 | Get the cloudinit configuration with both current and pending values. | |
87 | ||
88 | `<vmid>`: `<integer> (1 - N)` :: | |
89 | ||
90 | The (unique) ID of the VM. | |
91 | ||
92 | *qm cloudinit update* `<vmid>` | |
93 | ||
94 | Regenerate and change cloudinit config drive. | |
95 | ||
96 | `<vmid>`: `<integer> (1 - N)` :: | |
97 | ||
98 | The (unique) ID of the VM. | |
99 | ||
1f554f76 DM |
100 | *qm config* `<vmid>` `[OPTIONS]` |
101 | ||
e9cd3bd4 TL |
102 | Get the virtual machine configuration with pending configuration changes |
103 | applied. Set the 'current' parameter to get the current configuration | |
104 | instead. | |
1f554f76 | 105 | |
013dc89f | 106 | `<vmid>`: `<integer> (1 - N)` :: |
1f554f76 DM |
107 | |
108 | The (unique) ID of the VM. | |
109 | ||
2489d6df | 110 | `--current` `<boolean>` ('default =' `0`):: |
1f554f76 DM |
111 | |
112 | Get current values (instead of pending values). | |
113 | ||
5f26e15b TL |
114 | `--snapshot` `<string>` :: |
115 | ||
116 | Fetch config values from given snapshot. | |
117 | ||
1f554f76 DM |
118 | *qm create* `<vmid>` `[OPTIONS]` |
119 | ||
120 | Create or restore a virtual machine. | |
121 | ||
013dc89f | 122 | `<vmid>`: `<integer> (1 - N)` :: |
1f554f76 DM |
123 | |
124 | The (unique) ID of the VM. | |
125 | ||
2489d6df | 126 | `--acpi` `<boolean>` ('default =' `1`):: |
1f554f76 DM |
127 | |
128 | Enable/disable ACPI. | |
129 | ||
4e7f60c2 TL |
130 | `--affinity` `<string>` :: |
131 | ||
81a3384d | 132 | List of host cores used to execute guest processes, for example: 0,5,8-11 |
4e7f60c2 | 133 | |
9d2e98ed | 134 | `--agent` `[enabled=]<1|0> [,freeze-fs-on-backup=<1|0>] [,fstrim_cloned_disks=<1|0>] [,type=<virtio|isa>]` :: |
1f554f76 | 135 | |
9d2e98ed | 136 | Enable/disable communication with the QEMU Guest Agent and its properties. |
1f554f76 | 137 | |
e2d681b3 TL |
138 | `--arch` `<aarch64 | x86_64>` :: |
139 | ||
140 | Virtual processor architecture. Defaults to the host. | |
141 | ||
2489d6df | 142 | `--archive` `<string>` :: |
1f554f76 | 143 | |
c5aa7e14 | 144 | The backup archive. Either the file system path to a .tar or .vma file (use '-' to pipe data from stdin) or a proxmox storage backup volume identifier. |
1f554f76 | 145 | |
2489d6df | 146 | `--args` `<string>` :: |
1f554f76 | 147 | |
c2993fe5 | 148 | Arbitrary arguments passed to kvm. |
1f554f76 | 149 | |
d2656385 | 150 | `--audio0` `device=<ich9-intel-hda|intel-hda|AC97> [,driver=<spice|none>]` :: |
1c532546 TL |
151 | |
152 | Configure a audio device, useful in combination with QXL/Spice. | |
153 | ||
2489d6df | 154 | `--autostart` `<boolean>` ('default =' `0`):: |
1f554f76 DM |
155 | |
156 | Automatic restart after crash (currently ignored). | |
157 | ||
2489d6df | 158 | `--balloon` `<integer> (0 - N)` :: |
1f554f76 | 159 | |
9d2e98ed | 160 | Amount of target RAM for the VM in MiB. Using zero disables the ballon driver. |
1f554f76 | 161 | |
2489d6df | 162 | `--bios` `<ovmf | seabios>` ('default =' `seabios`):: |
1f554f76 DM |
163 | |
164 | Select BIOS implementation. | |
165 | ||
4772952b | 166 | `--boot` `[[legacy=]<[acdn]{1,4}>] [,order=<device[;device...]>]` :: |
1f554f76 | 167 | |
5370fa8c | 168 | Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated. |
1f554f76 | 169 | |
2489d6df | 170 | `--bootdisk` `(ide|sata|scsi|virtio)\d+` :: |
1f554f76 | 171 | |
4772952b | 172 | Enable booting from specified disk. Deprecated: Use 'boot: order=foo;bar' instead. |
1f554f76 | 173 | |
95895385 | 174 | `--bwlimit` `<integer> (0 - N)` ('default =' `restore limit from datacenter or storage config`):: |
27a7acb2 | 175 | |
95895385 | 176 | Override I/O bandwidth limit (in KiB/s). |
27a7acb2 | 177 | |
2489d6df | 178 | `--cdrom` `<volume>` :: |
1f554f76 DM |
179 | |
180 | This is an alias for option -ide2 | |
181 | ||
5370fa8c | 182 | `--cicustom` `[meta=<volume>] [,network=<volume>] [,user=<volume>] [,vendor=<volume>]` :: |
95895385 TL |
183 | |
184 | cloud-init: Specify custom files to replace the automatically generated ones at start. | |
185 | ||
27a7acb2 DM |
186 | `--cipassword` `<password>` :: |
187 | ||
188 | cloud-init: Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords. | |
189 | ||
d2656385 | 190 | `--citype` `<configdrive2 | nocloud | opennebula>` :: |
27a7acb2 DM |
191 | |
192 | Specifies the cloud-init configuration format. The default depends on the configured operating system type (`ostype`. We use the `nocloud` format for Linux, and `configdrive2` for windows. | |
193 | ||
194 | `--ciuser` `<string>` :: | |
195 | ||
196 | cloud-init: User name to change ssh keys and password for instead of the image's configured default user. | |
197 | ||
2489d6df | 198 | `--cores` `<integer> (1 - N)` ('default =' `1`):: |
1f554f76 DM |
199 | |
200 | The number of cores per socket. | |
201 | ||
04d22a9f | 202 | `--cpu` `[[cputype=]<string>] [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=<vendor-id>] [,phys-bits=<8-64|host>] [,reported-model=<enum>]` :: |
1f554f76 DM |
203 | |
204 | Emulated CPU type. | |
205 | ||
2489d6df | 206 | `--cpulimit` `<number> (0 - 128)` ('default =' `0`):: |
1f554f76 | 207 | |
9b3e4991 | 208 | Limit of CPU usage. |
1f554f76 | 209 | |
7af2edf9 | 210 | `--cpuunits` `<integer> (1 - 262144)` ('default =' `cgroup v1: 1024, cgroup v2: 100`):: |
1f554f76 | 211 | |
5370fa8c | 212 | CPU weight for a VM, will be clamped to [1, 10000] in cgroup v2. |
1f554f76 | 213 | |
2489d6df | 214 | `--description` `<string>` :: |
1f554f76 | 215 | |
8f4d9c87 | 216 | Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file. |
1f554f76 | 217 | |
7af2edf9 | 218 | `--efidisk0` `[file=]<volume> [,efitype=<2m|4m>] [,format=<enum>] [,import-from=<source volume>] [,pre-enrolled-keys=<1|0>] [,size=<DiskSize>]` :: |
2c0dde61 | 219 | |
9d2e98ed | 220 | Configure a disk for storing EFI vars. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. |
2c0dde61 | 221 | |
2489d6df | 222 | `--force` `<boolean>` :: |
1f554f76 DM |
223 | |
224 | Allow to overwrite existing VM. | |
225 | + | |
226 | NOTE: Requires option(s): `archive` | |
227 | ||
2489d6df | 228 | `--freeze` `<boolean>` :: |
1f554f76 DM |
229 | |
230 | Freeze CPU at startup (use 'c' monitor command to start execution). | |
231 | ||
5f26e15b TL |
232 | `--hookscript` `<string>` :: |
233 | ||
234 | Script that will be executed during various steps in the vms lifetime. | |
235 | ||
7af2edf9 | 236 | `--hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,device-id=<hex id>] [,legacy-igd=<1|0>] [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,sub-device-id=<hex id>] [,sub-vendor-id=<hex id>] [,vendor-id=<hex id>] [,x-vga=<1|0>]` :: |
1f554f76 | 237 | |
c2993fe5 | 238 | Map host PCI devices into guest. |
1f554f76 | 239 | |
2489d6df | 240 | `--hotplug` `<string>` ('default =' `network,disk,usb`):: |
1f554f76 | 241 | |
4e7f60c2 | 242 | Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory', 'usb' and 'cloudinit'. Use '0' to disable hotplug completely. Using '1' as value is an alias for the default `network,disk,usb`. USB hotplugging is possible for guests with machine version >= 7.1 and ostype l26 or windows > 7. |
1f554f76 | 243 | |
2489d6df | 244 | `--hugepages` `<1024 | 2 | any>` :: |
2c0dde61 DM |
245 | |
246 | Enable/disable hugepages memory. | |
247 | ||
7af2edf9 | 248 | `--ide[n]` `[file=]<volume> [,aio=<native|threads|io_uring>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,import-from=<source volume>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]` :: |
1f554f76 | 249 | |
7af2edf9 | 250 | Use volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. |
1f554f76 | 251 | |
27a7acb2 DM |
252 | `--ipconfig[n]` `[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]` :: |
253 | ||
254 | cloud-init: Specify IP addresses and gateways for the corresponding interface. | |
255 | + | |
256 | IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. | |
257 | + | |
4772952b TL |
258 | The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit |
259 | gateway should be provided. | |
d2656385 TL |
260 | For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires |
261 | cloud-init 19.4 or newer. | |
27a7acb2 | 262 | + |
4772952b TL |
263 | If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using |
264 | dhcp on IPv4. | |
27a7acb2 | 265 | |
95895385 TL |
266 | `--ivshmem` `size=<integer> [,name=<string>]` :: |
267 | ||
268 | Inter-VM shared memory. Useful for direct communication between VMs, or to the host. | |
269 | ||
4772952b TL |
270 | `--keephugepages` `<boolean>` ('default =' `0`):: |
271 | ||
272 | Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts. | |
273 | ||
35a75dd3 | 274 | `--keyboard` `<da | de | de-ch | en-gb | en-us | es | fi | fr | fr-be | fr-ca | fr-ch | hu | is | it | ja | lt | mk | nl | no | pl | pt | pt-br | sl | sv | tr>` :: |
1f554f76 | 275 | |
7af2edf9 | 276 | Keyboard layout for VNC server. This option is generally not required and is often better handled from within the guest OS. |
1f554f76 | 277 | |
2489d6df | 278 | `--kvm` `<boolean>` ('default =' `1`):: |
1f554f76 DM |
279 | |
280 | Enable/disable KVM hardware virtualization. | |
281 | ||
d2656385 TL |
282 | `--live-restore` `<boolean>` :: |
283 | ||
284 | Start the VM immediately from the backup and restore in background. PBS only. | |
285 | + | |
286 | NOTE: Requires option(s): `archive` | |
287 | ||
2489d6df | 288 | `--localtime` `<boolean>` :: |
1f554f76 | 289 | |
5370fa8c | 290 | Set the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS. |
1f554f76 | 291 | |
95895385 | 292 | `--lock` `<backup | clone | create | migrate | rollback | snapshot | snapshot-delete | suspended | suspending>` :: |
1f554f76 DM |
293 | |
294 | Lock/unlock the VM. | |
295 | ||
5c1699e5 | 296 | `--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` :: |
1f554f76 | 297 | |
9d2e98ed | 298 | Specifies the QEMU machine type. |
1f554f76 | 299 | |
2489d6df | 300 | `--memory` `<integer> (16 - N)` ('default =' `512`):: |
1f554f76 | 301 | |
9d2e98ed | 302 | Amount of RAM for the VM in MiB. This is the maximum available memory when you use the balloon device. |
1f554f76 | 303 | |
2489d6df | 304 | `--migrate_downtime` `<number> (0 - N)` ('default =' `0.1`):: |
1f554f76 DM |
305 | |
306 | Set maximum tolerated downtime (in seconds) for migrations. | |
307 | ||
2489d6df | 308 | `--migrate_speed` `<integer> (0 - N)` ('default =' `0`):: |
1f554f76 DM |
309 | |
310 | Set maximum speed (in MB/s) for migrations. Value 0 is no limit. | |
311 | ||
2489d6df | 312 | `--name` `<string>` :: |
1f554f76 DM |
313 | |
314 | Set a name for the VM. Only used on the configuration web interface. | |
315 | ||
27a7acb2 DM |
316 | `--nameserver` `<string>` :: |
317 | ||
de786b48 | 318 | cloud-init: Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set. |
27a7acb2 | 319 | |
ac70d7d1 | 320 | `--net[n]` `[model=]<enum> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,mtu=<integer>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]` :: |
1f554f76 DM |
321 | |
322 | Specify network devices. | |
1f554f76 | 323 | |
2489d6df | 324 | `--numa` `<boolean>` ('default =' `0`):: |
1f554f76 | 325 | |
9b3e4991 | 326 | Enable/disable NUMA. |
1f554f76 | 327 | |
2489d6df | 328 | `--numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` :: |
1f554f76 | 329 | |
c2993fe5 | 330 | NUMA topology. |
1f554f76 | 331 | |
2489d6df | 332 | `--onboot` `<boolean>` ('default =' `0`):: |
1f554f76 DM |
333 | |
334 | Specifies whether a VM will be started during system bootup. | |
335 | ||
5370fa8c | 336 | `--ostype` `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win11 | win7 | win8 | wvista | wxp>` :: |
1f554f76 | 337 | |
c2993fe5 | 338 | Specify guest operating system. |
1f554f76 | 339 | |
2489d6df | 340 | `--parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` :: |
1f554f76 DM |
341 | |
342 | Map host parallel devices (n is 0 to 2). | |
1f554f76 | 343 | |
2489d6df | 344 | `--pool` `<string>` :: |
1f554f76 DM |
345 | |
346 | Add the VM to the specified pool. | |
347 | ||
2489d6df | 348 | `--protection` `<boolean>` ('default =' `0`):: |
1f554f76 | 349 | |
c2993fe5 | 350 | Sets the protection flag of the VM. This will disable the remove VM and remove disk operations. |
1f554f76 | 351 | |
2489d6df | 352 | `--reboot` `<boolean>` ('default =' `1`):: |
1f554f76 DM |
353 | |
354 | Allow reboot. If set to '0' the VM exit on reboot. | |
355 | ||
c5aa7e14 TL |
356 | `--rng0` `[source=]</dev/urandom|/dev/random|/dev/hwrng> [,max_bytes=<integer>] [,period=<integer>]` :: |
357 | ||
358 | Configure a VirtIO-based Random Number Generator. | |
359 | ||
7af2edf9 | 360 | `--sata[n]` `[file=]<volume> [,aio=<native|threads|io_uring>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,import-from=<source volume>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]` :: |
1f554f76 | 361 | |
7af2edf9 | 362 | Use volume as SATA hard disk or CD-ROM (n is 0 to 5). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. |
1f554f76 | 363 | |
7af2edf9 | 364 | `--scsi[n]` `[file=]<volume> [,aio=<native|threads|io_uring>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,import-from=<source volume>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,queues=<integer>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,ro=<1|0>] [,scsiblock=<1|0>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]` :: |
1f554f76 | 365 | |
7af2edf9 | 366 | Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. |
1f554f76 | 367 | |
2489d6df | 368 | `--scsihw` `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`):: |
1f554f76 | 369 | |
c2993fe5 | 370 | SCSI controller model |
1f554f76 | 371 | |
27a7acb2 DM |
372 | `--searchdomain` `<string>` :: |
373 | ||
de786b48 | 374 | cloud-init: Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set. |
27a7acb2 | 375 | |
2489d6df | 376 | `--serial[n]` `(/dev/.+|socket)` :: |
1f554f76 | 377 | |
c2993fe5 | 378 | Create a serial device inside the VM (n is 0 to 3) |
1f554f76 | 379 | |
2489d6df | 380 | `--shares` `<integer> (0 - 50000)` ('default =' `1000`):: |
1f554f76 | 381 | |
5da3d723 | 382 | Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning. Auto-ballooning is done by pvestatd. |
1f554f76 | 383 | |
1e3f8156 | 384 | `--smbios1` `[base64=<1|0>] [,family=<Base64 encoded string>] [,manufacturer=<Base64 encoded string>] [,product=<Base64 encoded string>] [,serial=<Base64 encoded string>] [,sku=<Base64 encoded string>] [,uuid=<UUID>] [,version=<Base64 encoded string>]` :: |
1f554f76 DM |
385 | |
386 | Specify SMBIOS type 1 fields. | |
387 | ||
2489d6df | 388 | `--smp` `<integer> (1 - N)` ('default =' `1`):: |
1f554f76 DM |
389 | |
390 | The number of CPUs. Please use option -sockets instead. | |
391 | ||
2489d6df | 392 | `--sockets` `<integer> (1 - N)` ('default =' `1`):: |
1f554f76 DM |
393 | |
394 | The number of CPU sockets. | |
395 | ||
1c532546 TL |
396 | `--spice_enhancements` `[foldersharing=<1|0>] [,videostreaming=<off|all|filter>]` :: |
397 | ||
398 | Configure additional enhancements for SPICE. | |
399 | ||
27a7acb2 DM |
400 | `--sshkeys` `<filepath>` :: |
401 | ||
402 | cloud-init: Setup public SSH keys (one key per line, OpenSSH format). | |
403 | ||
5da3d723 TL |
404 | `--start` `<boolean>` ('default =' `0`):: |
405 | ||
406 | Start VM after it was created successfully. | |
407 | ||
2489d6df | 408 | `--startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`):: |
1f554f76 | 409 | |
4772952b | 410 | Set the initial date of the real time clock. Valid format for date are:'now' or '2006-06-17T16:01:21' or '2006-06-17'. |
1f554f76 | 411 | |
2489d6df | 412 | `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` :: |
1f554f76 | 413 | |
c2993fe5 | 414 | Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped. |
1f554f76 | 415 | |
2489d6df | 416 | `--storage` `<string>` :: |
1f554f76 DM |
417 | |
418 | Default storage. | |
419 | ||
2489d6df | 420 | `--tablet` `<boolean>` ('default =' `1`):: |
1f554f76 | 421 | |
c2993fe5 | 422 | Enable/disable the USB tablet device. |
1f554f76 | 423 | |
5c1699e5 TL |
424 | `--tags` `<string>` :: |
425 | ||
426 | Tags of the VM. This is only meta information. | |
427 | ||
2489d6df | 428 | `--tdf` `<boolean>` ('default =' `0`):: |
1f554f76 DM |
429 | |
430 | Enable/disable time drift fix. | |
431 | ||
2489d6df | 432 | `--template` `<boolean>` ('default =' `0`):: |
1f554f76 DM |
433 | |
434 | Enable/disable Template. | |
435 | ||
7af2edf9 | 436 | `--tpmstate0` `[file=]<volume> [,import-from=<source volume>] [,size=<DiskSize>] [,version=<v1.2|v2.0>]` :: |
5370fa8c | 437 | |
7af2edf9 | 438 | Configure a Disk for storing TPM state. The format is fixed to 'raw'. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and 4 MiB will be used instead. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. |
5370fa8c | 439 | |
2489d6df | 440 | `--unique` `<boolean>` :: |
1f554f76 DM |
441 | |
442 | Assign a unique random ethernet address. | |
443 | + | |
444 | NOTE: Requires option(s): `archive` | |
445 | ||
c5aa7e14 | 446 | `--unused[n]` `[file=]<volume>` :: |
1f554f76 | 447 | |
c2993fe5 | 448 | Reference to unused volumes. This is used internally, and should not be modified manually. |
1f554f76 | 449 | |
2489d6df | 450 | `--usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` :: |
1f554f76 | 451 | |
4e7f60c2 | 452 | Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). |
1f554f76 | 453 | |
2489d6df | 454 | `--vcpus` `<integer> (1 - N)` ('default =' `0`):: |
1f554f76 DM |
455 | |
456 | Number of hotplugged vcpus. | |
457 | ||
e2d681b3 | 458 | `--vga` `[[type=]<enum>] [,memory=<integer>]` :: |
1f554f76 | 459 | |
e2d681b3 | 460 | Configure the VGA hardware. |
1f554f76 | 461 | |
7af2edf9 | 462 | `--virtio[n]` `[file=]<volume> [,aio=<native|threads|io_uring>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,import-from=<source volume>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,ro=<1|0>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` :: |
1f554f76 | 463 | |
7af2edf9 | 464 | Use volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. |
1f554f76 | 465 | |
4d47f125 TL |
466 | `--vmgenid` `<UUID>` ('default =' `1 (autogenerated)`):: |
467 | ||
468 | Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly. | |
469 | ||
2489d6df WB |
470 | `--vmstatestorage` `<string>` :: |
471 | ||
472 | Default storage for VM state volumes/files. | |
473 | ||
474 | `--watchdog` `[[model=]<i6300esb|ib700>] [,action=<enum>]` :: | |
1f554f76 | 475 | |
c2993fe5 | 476 | Create a virtual hardware watchdog device. |
1f554f76 | 477 | |
1f554f76 DM |
478 | *qm delsnapshot* `<vmid> <snapname>` `[OPTIONS]` |
479 | ||
480 | Delete a VM snapshot. | |
481 | ||
013dc89f | 482 | `<vmid>`: `<integer> (1 - N)` :: |
1f554f76 DM |
483 | |
484 | The (unique) ID of the VM. | |
485 | ||
013dc89f | 486 | `<snapname>`: `<string>` :: |
1f554f76 DM |
487 | |
488 | The name of the snapshot. | |
489 | ||
2489d6df | 490 | `--force` `<boolean>` :: |
1f554f76 DM |
491 | |
492 | For removal from config file, even if removing disk snapshots fails. | |
493 | ||
1f554f76 DM |
494 | *qm destroy* `<vmid>` `[OPTIONS]` |
495 | ||
d2656385 TL |
496 | Destroy the VM and all used/owned volumes. Removes any VM specific |
497 | permissions and firewall rules | |
1f554f76 | 498 | |
013dc89f | 499 | `<vmid>`: `<integer> (1 - N)` :: |
1f554f76 DM |
500 | |
501 | The (unique) ID of the VM. | |
502 | ||
8f4d9c87 | 503 | `--destroy-unreferenced-disks` `<boolean>` ('default =' `0`):: |
d2656385 TL |
504 | |
505 | If set, destroy additionally all disks not referenced in the config but with a matching VMID from all enabled storages. | |
506 | ||
1c532546 TL |
507 | `--purge` `<boolean>` :: |
508 | ||
d2656385 | 509 | Remove VMID from configurations, like backup & replication jobs and HA. |
1c532546 | 510 | |
2489d6df | 511 | `--skiplock` `<boolean>` :: |
1f554f76 DM |
512 | |
513 | Ignore locks - only root is allowed to use this option. | |
514 | ||
4e7f60c2 TL |
515 | *qm disk import* `<vmid> <source> <storage>` `[OPTIONS]` |
516 | ||
517 | Import an external disk image as an unused disk in a VM. The | |
518 | image format has to be supported by qemu-img(1). | |
519 | ||
520 | `<vmid>`: `<integer> (1 - N)` :: | |
521 | ||
522 | The (unique) ID of the VM. | |
523 | ||
524 | `<source>`: `<string>` :: | |
525 | ||
526 | Path to the disk image to import | |
527 | ||
528 | `<storage>`: `<string>` :: | |
529 | ||
530 | Target storage ID | |
531 | ||
532 | `--format` `<qcow2 | raw | vmdk>` :: | |
533 | ||
534 | Target format | |
535 | ||
536 | *qm disk move* `<vmid> <disk> [<storage>]` `[OPTIONS]` | |
537 | ||
538 | Move volume to different storage or to a different VM. | |
539 | ||
540 | `<vmid>`: `<integer> (1 - N)` :: | |
541 | ||
542 | The (unique) ID of the VM. | |
543 | ||
544 | `<disk>`: `<efidisk0 | ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi14 | scsi15 | scsi16 | scsi17 | scsi18 | scsi19 | scsi2 | scsi20 | scsi21 | scsi22 | scsi23 | scsi24 | scsi25 | scsi26 | scsi27 | scsi28 | scsi29 | scsi3 | scsi30 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | tpmstate0 | 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 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9>` :: | |
545 | ||
546 | The disk you want to move. | |
547 | ||
548 | `<storage>`: `<string>` :: | |
549 | ||
550 | Target storage. | |
551 | ||
552 | `--bwlimit` `<integer> (0 - N)` ('default =' `move limit from datacenter or storage config`):: | |
553 | ||
554 | Override I/O bandwidth limit (in KiB/s). | |
555 | ||
556 | `--delete` `<boolean>` ('default =' `0`):: | |
557 | ||
558 | Delete the original disk after successful copy. By default the original disk is kept as unused disk. | |
559 | ||
560 | `--digest` `<string>` :: | |
561 | ||
562 | Prevent changes if current configuration file has different SHA1" | |
563 | ." digest. This can be used to prevent concurrent modifications. | |
564 | ||
565 | `--format` `<qcow2 | raw | vmdk>` :: | |
566 | ||
567 | Target Format. | |
568 | ||
569 | `--target-digest` `<string>` :: | |
570 | ||
571 | Prevent changes if the current config file of the target VM has a" | |
572 | ." different SHA1 digest. This can be used to detect concurrent modifications. | |
573 | ||
574 | `--target-disk` `<efidisk0 | ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi14 | scsi15 | scsi16 | scsi17 | scsi18 | scsi19 | scsi2 | scsi20 | scsi21 | scsi22 | scsi23 | scsi24 | scsi25 | scsi26 | scsi27 | scsi28 | scsi29 | scsi3 | scsi30 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | tpmstate0 | 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 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9>` :: | |
575 | ||
576 | The config key the disk will be moved to on the target VM (for example, ide0 or scsi1). Default is the source disk key. | |
577 | ||
578 | `--target-vmid` `<integer> (1 - N)` :: | |
579 | ||
580 | The (unique) ID of the VM. | |
581 | ||
582 | *qm disk rescan* `[OPTIONS]` | |
583 | ||
584 | Rescan all storages and update disk sizes and unused disk images. | |
585 | ||
586 | `--dryrun` `<boolean>` ('default =' `0`):: | |
587 | ||
588 | Do not actually write changes out to VM config(s). | |
589 | ||
590 | `--vmid` `<integer> (1 - N)` :: | |
591 | ||
592 | The (unique) ID of the VM. | |
593 | ||
594 | *qm disk resize* `<vmid> <disk> <size>` `[OPTIONS]` | |
595 | ||
596 | Extend volume size. | |
597 | ||
598 | `<vmid>`: `<integer> (1 - N)` :: | |
599 | ||
600 | The (unique) ID of the VM. | |
601 | ||
602 | `<disk>`: `<efidisk0 | ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi14 | scsi15 | scsi16 | scsi17 | scsi18 | scsi19 | scsi2 | scsi20 | scsi21 | scsi22 | scsi23 | scsi24 | scsi25 | scsi26 | scsi27 | scsi28 | scsi29 | scsi3 | scsi30 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | tpmstate0 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9>` :: | |
603 | ||
604 | The disk you want to resize. | |
605 | ||
606 | `<size>`: `\+?\d+(\.\d+)?[KMGT]?` :: | |
607 | ||
608 | The new size. With the `+` sign the value is added to the actual size of the volume and without it, the value is taken as an absolute one. Shrinking disk size is not supported. | |
609 | ||
610 | `--digest` `<string>` :: | |
611 | ||
612 | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. | |
613 | ||
614 | `--skiplock` `<boolean>` :: | |
615 | ||
616 | Ignore locks - only root is allowed to use this option. | |
617 | ||
618 | *qm disk unlink* `<vmid> --idlist <string>` `[OPTIONS]` | |
619 | ||
620 | Unlink/delete disk images. | |
621 | ||
622 | `<vmid>`: `<integer> (1 - N)` :: | |
623 | ||
624 | The (unique) ID of the VM. | |
625 | ||
626 | `--force` `<boolean>` :: | |
627 | ||
628 | Force physical removal. Without this, we simple remove the disk from the config file and create an additional configuration entry called 'unused[n]', which contains the volume ID. Unlink of unused[n] always cause physical removal. | |
629 | ||
630 | `--idlist` `<string>` :: | |
631 | ||
632 | A list of disk IDs you want to delete. | |
633 | ||
4d47f125 TL |
634 | *qm guest cmd* `<vmid> <command>` |
635 | ||
9d2e98ed | 636 | Execute QEMU Guest Agent commands. |
4d47f125 TL |
637 | |
638 | `<vmid>`: `<integer> (1 - N)` :: | |
639 | ||
640 | The (unique) ID of the VM. | |
641 | ||
642 | `<command>`: `<fsfreeze-freeze | fsfreeze-status | fsfreeze-thaw | fstrim | get-fsinfo | get-host-name | get-memory-block-info | get-memory-blocks | get-osinfo | get-time | get-timezone | get-users | get-vcpus | info | network-get-interfaces | ping | shutdown | suspend-disk | suspend-hybrid | suspend-ram>` :: | |
643 | ||
644 | The QGA command. | |
645 | ||
646 | *qm guest exec* `<vmid> [<extra-args>]` `[OPTIONS]` | |
647 | ||
648 | Executes the given command via the guest agent | |
649 | ||
650 | `<vmid>`: `<integer> (1 - N)` :: | |
651 | ||
652 | The (unique) ID of the VM. | |
653 | ||
654 | `<extra-args>`: `<array>` :: | |
655 | ||
656 | Extra arguments as array | |
657 | ||
c5aa7e14 TL |
658 | `--pass-stdin` `<boolean>` ('default =' `0`):: |
659 | ||
660 | When set, read STDIN until EOF and forward to guest agent via 'input-data' (usually treated as STDIN to process launched by guest agent). Allows maximal 1 MiB. | |
661 | ||
4d47f125 TL |
662 | `--synchronous` `<boolean>` ('default =' `1`):: |
663 | ||
664 | If set to off, returns the pid immediately instead of waiting for the commmand to finish or the timeout. | |
665 | ||
666 | `--timeout` `<integer> (0 - N)` ('default =' `30`):: | |
667 | ||
668 | The maximum time to wait synchronously for the command to finish. If reached, the pid gets returned. Set to 0 to deactivate | |
669 | ||
670 | *qm guest exec-status* `<vmid> <pid>` | |
671 | ||
672 | Gets the status of the given pid started by the guest-agent | |
673 | ||
674 | `<vmid>`: `<integer> (1 - N)` :: | |
675 | ||
676 | The (unique) ID of the VM. | |
677 | ||
678 | `<pid>`: `<integer>` :: | |
679 | ||
680 | The PID to query | |
681 | ||
682 | *qm guest passwd* `<vmid> <username>` `[OPTIONS]` | |
683 | ||
684 | Sets the password for the given user to the given password | |
685 | ||
686 | `<vmid>`: `<integer> (1 - N)` :: | |
687 | ||
688 | The (unique) ID of the VM. | |
689 | ||
690 | `<username>`: `<string>` :: | |
691 | ||
692 | The user to set the password for. | |
693 | ||
694 | `--crypted` `<boolean>` ('default =' `0`):: | |
695 | ||
696 | set to 1 if the password has already been passed through crypt() | |
697 | ||
35a75dd3 | 698 | *qm help* `[OPTIONS]` |
1f554f76 DM |
699 | |
700 | Get help about specified command. | |
701 | ||
35a75dd3 | 702 | `--extra-args` `<array>` :: |
1f554f76 | 703 | |
35a75dd3 | 704 | Shows help for a specific command |
1f554f76 | 705 | |
2489d6df | 706 | `--verbose` `<boolean>` :: |
1f554f76 DM |
707 | |
708 | Verbose output format. | |
709 | ||
4e7f60c2 | 710 | *qm importdisk* |
5d9c884c | 711 | |
4e7f60c2 | 712 | An alias for 'qm disk import'. |
2489d6df | 713 | |
2489d6df WB |
714 | *qm importovf* `<vmid> <manifest> <storage>` `[OPTIONS]` |
715 | ||
716 | Create a new VM using parameters read from an OVF manifest | |
717 | ||
718 | `<vmid>`: `<integer> (1 - N)` :: | |
719 | ||
720 | The (unique) ID of the VM. | |
721 | ||
722 | `<manifest>`: `<string>` :: | |
723 | ||
724 | path to the ovf file | |
725 | ||
726 | `<storage>`: `<string>` :: | |
727 | ||
728 | Target storage ID | |
729 | ||
730 | `--dryrun` `<boolean>` :: | |
731 | ||
732 | Print a parsed representation of the extracted OVF parameters, but do not create a VM | |
733 | ||
734 | `--format` `<qcow2 | raw | vmdk>` :: | |
5d9c884c DM |
735 | |
736 | Target format | |
737 | ||
9b3e4991 | 738 | *qm list* `[OPTIONS]` |
1f554f76 DM |
739 | |
740 | Virtual machine index (per node). | |
741 | ||
2489d6df | 742 | `--full` `<boolean>` :: |
9b3e4991 DM |
743 | |
744 | Determine the full status of active VMs. | |
745 | ||
de0983cb DM |
746 | *qm listsnapshot* `<vmid>` |
747 | ||
748 | List all snapshots. | |
749 | ||
013dc89f | 750 | `<vmid>`: `<integer> (1 - N)` :: |
de0983cb DM |
751 | |
752 | The (unique) ID of the VM. | |
753 | ||
1f554f76 DM |
754 | *qm migrate* `<vmid> <target>` `[OPTIONS]` |
755 | ||
756 | Migrate virtual machine. Creates a new migration task. | |
757 | ||
013dc89f | 758 | `<vmid>`: `<integer> (1 - N)` :: |
1f554f76 DM |
759 | |
760 | The (unique) ID of the VM. | |
761 | ||
013dc89f | 762 | `<target>`: `<string>` :: |
1f554f76 DM |
763 | |
764 | Target node. | |
765 | ||
95895385 TL |
766 | `--bwlimit` `<integer> (0 - N)` ('default =' `migrate limit from datacenter or storage config`):: |
767 | ||
768 | Override I/O bandwidth limit (in KiB/s). | |
769 | ||
2489d6df | 770 | `--force` `<boolean>` :: |
1f554f76 | 771 | |
c2993fe5 | 772 | Allow to migrate VMs which use local devices. Only root may use this option. |
1f554f76 | 773 | |
2489d6df | 774 | `--migration_network` `<string>` :: |
de0983cb DM |
775 | |
776 | CIDR of the (sub) network that is used for migration. | |
777 | ||
2489d6df | 778 | `--migration_type` `<insecure | secure>` :: |
de0983cb DM |
779 | |
780 | Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance. | |
781 | ||
2489d6df | 782 | `--online` `<boolean>` :: |
1f554f76 | 783 | |
1c532546 | 784 | Use online/live migration if VM is running. Ignored if VM is stopped. |
1f554f76 | 785 | |
2489d6df | 786 | `--targetstorage` `<string>` :: |
52e44c50 | 787 | |
c5aa7e14 | 788 | Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself. |
52e44c50 | 789 | |
2489d6df | 790 | `--with-local-disks` `<boolean>` :: |
52e44c50 FG |
791 | |
792 | Enable live storage migration for local disk | |
793 | ||
1f554f76 DM |
794 | *qm monitor* `<vmid>` |
795 | ||
9d2e98ed | 796 | Enter QEMU Monitor interface. |
1f554f76 | 797 | |
013dc89f | 798 | `<vmid>`: `<integer> (1 - N)` :: |
1f554f76 DM |
799 | |
800 | The (unique) ID of the VM. | |
801 | ||
4e7f60c2 | 802 | *qm move-disk* |
5370fa8c | 803 | |
4e7f60c2 | 804 | An alias for 'qm disk move'. |
5370fa8c TL |
805 | |
806 | *qm move_disk* | |
807 | ||
4e7f60c2 | 808 | An alias for 'qm disk move'. |
5370fa8c | 809 | |
1f554f76 DM |
810 | *qm mtunnel* |
811 | ||
812 | Used by qmigrate - do not use manually. | |
813 | ||
52e44c50 FG |
814 | *qm nbdstop* `<vmid>` |
815 | ||
816 | Stop embedded nbd server. | |
817 | ||
818 | `<vmid>`: `<integer> (1 - N)` :: | |
819 | ||
820 | The (unique) ID of the VM. | |
821 | ||
1f554f76 DM |
822 | *qm pending* `<vmid>` |
823 | ||
e9cd3bd4 | 824 | Get the virtual machine configuration with both current and pending values. |
1f554f76 | 825 | |
013dc89f | 826 | `<vmid>`: `<integer> (1 - N)` :: |
1f554f76 DM |
827 | |
828 | The (unique) ID of the VM. | |
829 | ||
1c532546 TL |
830 | *qm reboot* `<vmid>` `[OPTIONS]` |
831 | ||
832 | Reboot the VM by shutting it down, and starting it again. Applies pending | |
833 | changes. | |
834 | ||
835 | `<vmid>`: `<integer> (1 - N)` :: | |
836 | ||
837 | The (unique) ID of the VM. | |
838 | ||
839 | `--timeout` `<integer> (0 - N)` :: | |
840 | ||
841 | Wait maximal timeout seconds for the shutdown. | |
842 | ||
81a3384d TL |
843 | *qm remote-migrate* `<vmid> [<target-vmid>] <target-endpoint> --target-bridge <string> --target-storage <string>` `[OPTIONS]` |
844 | ||
845 | Migrate virtual machine to a remote cluster. Creates a new migration task. | |
846 | EXPERIMENTAL feature! | |
847 | ||
848 | `<vmid>`: `<integer> (1 - N)` :: | |
849 | ||
850 | The (unique) ID of the VM. | |
851 | ||
852 | `<target-vmid>`: `<integer> (1 - N)` :: | |
853 | ||
854 | The (unique) ID of the VM. | |
855 | ||
856 | `<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>]` :: | |
857 | ||
858 | Remote target endpoint | |
859 | ||
860 | `--bwlimit` `<integer> (0 - N)` ('default =' `migrate limit from datacenter or storage config`):: | |
861 | ||
862 | Override I/O bandwidth limit (in KiB/s). | |
863 | ||
864 | `--delete` `<boolean>` ('default =' `0`):: | |
865 | ||
866 | Delete the original VM and related data after successful migration. By default the original VM is kept on the source cluster in a stopped state. | |
867 | ||
868 | `--online` `<boolean>` :: | |
869 | ||
870 | Use online/live migration if VM is running. Ignored if VM is stopped. | |
871 | ||
872 | `--target-bridge` `<string>` :: | |
873 | ||
874 | Mapping from source to target bridges. Providing only a single bridge ID maps all source bridges to that bridge. Providing the special value '1' will map each source bridge to itself. | |
875 | ||
876 | `--target-storage` `<string>` :: | |
877 | ||
878 | Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself. | |
879 | ||
4e7f60c2 | 880 | *qm rescan* |
1f554f76 | 881 | |
4e7f60c2 | 882 | An alias for 'qm disk rescan'. |
1f554f76 | 883 | |
1f554f76 DM |
884 | *qm reset* `<vmid>` `[OPTIONS]` |
885 | ||
886 | Reset virtual machine. | |
887 | ||
013dc89f | 888 | `<vmid>`: `<integer> (1 - N)` :: |
1f554f76 DM |
889 | |
890 | The (unique) ID of the VM. | |
891 | ||
2489d6df | 892 | `--skiplock` `<boolean>` :: |
1f554f76 DM |
893 | |
894 | Ignore locks - only root is allowed to use this option. | |
895 | ||
4e7f60c2 | 896 | *qm resize* |
1f554f76 | 897 | |
4e7f60c2 | 898 | An alias for 'qm disk resize'. |
1f554f76 | 899 | |
1f554f76 DM |
900 | *qm resume* `<vmid>` `[OPTIONS]` |
901 | ||
902 | Resume virtual machine. | |
903 | ||
013dc89f | 904 | `<vmid>`: `<integer> (1 - N)` :: |
1f554f76 DM |
905 | |
906 | The (unique) ID of the VM. | |
907 | ||
2489d6df | 908 | `--nocheck` `<boolean>` :: |
1f554f76 DM |
909 | |
910 | no description available | |
911 | ||
2489d6df | 912 | `--skiplock` `<boolean>` :: |
1f554f76 DM |
913 | |
914 | Ignore locks - only root is allowed to use this option. | |
915 | ||
4e7f60c2 | 916 | *qm rollback* `<vmid> <snapname>` `[OPTIONS]` |
1f554f76 DM |
917 | |
918 | Rollback VM state to specified snapshot. | |
919 | ||
013dc89f | 920 | `<vmid>`: `<integer> (1 - N)` :: |
1f554f76 DM |
921 | |
922 | The (unique) ID of the VM. | |
923 | ||
013dc89f | 924 | `<snapname>`: `<string>` :: |
1f554f76 DM |
925 | |
926 | The name of the snapshot. | |
927 | ||
4e7f60c2 TL |
928 | `--start` `<boolean>` ('default =' `0`):: |
929 | ||
9d2e98ed | 930 | Whether the VM should get started after rolling back successfully. (Note: VMs will be automatically started if the snapshot includes RAM.) |
4e7f60c2 | 931 | |
1f554f76 DM |
932 | *qm sendkey* `<vmid> <key>` `[OPTIONS]` |
933 | ||
934 | Send key event to virtual machine. | |
935 | ||
013dc89f | 936 | `<vmid>`: `<integer> (1 - N)` :: |
1f554f76 DM |
937 | |
938 | The (unique) ID of the VM. | |
939 | ||
013dc89f | 940 | `<key>`: `<string>` :: |
1f554f76 DM |
941 | |
942 | The key (qemu monitor encoding). | |
943 | ||
2489d6df | 944 | `--skiplock` `<boolean>` :: |
1f554f76 DM |
945 | |
946 | Ignore locks - only root is allowed to use this option. | |
947 | ||
1f554f76 DM |
948 | *qm set* `<vmid>` `[OPTIONS]` |
949 | ||
950 | Set virtual machine options (synchrounous API) - You should consider using | |
951 | the POST method instead for any actions involving hotplug or storage | |
952 | allocation. | |
953 | ||
013dc89f | 954 | `<vmid>`: `<integer> (1 - N)` :: |
1f554f76 DM |
955 | |
956 | The (unique) ID of the VM. | |
957 | ||
2489d6df | 958 | `--acpi` `<boolean>` ('default =' `1`):: |
1f554f76 DM |
959 | |
960 | Enable/disable ACPI. | |
961 | ||
4e7f60c2 TL |
962 | `--affinity` `<string>` :: |
963 | ||
81a3384d | 964 | List of host cores used to execute guest processes, for example: 0,5,8-11 |
4e7f60c2 | 965 | |
9d2e98ed | 966 | `--agent` `[enabled=]<1|0> [,freeze-fs-on-backup=<1|0>] [,fstrim_cloned_disks=<1|0>] [,type=<virtio|isa>]` :: |
1f554f76 | 967 | |
9d2e98ed | 968 | Enable/disable communication with the QEMU Guest Agent and its properties. |
1f554f76 | 969 | |
e2d681b3 TL |
970 | `--arch` `<aarch64 | x86_64>` :: |
971 | ||
972 | Virtual processor architecture. Defaults to the host. | |
973 | ||
2489d6df | 974 | `--args` `<string>` :: |
1f554f76 | 975 | |
c2993fe5 | 976 | Arbitrary arguments passed to kvm. |
1f554f76 | 977 | |
d2656385 | 978 | `--audio0` `device=<ich9-intel-hda|intel-hda|AC97> [,driver=<spice|none>]` :: |
1c532546 TL |
979 | |
980 | Configure a audio device, useful in combination with QXL/Spice. | |
981 | ||
2489d6df | 982 | `--autostart` `<boolean>` ('default =' `0`):: |
1f554f76 DM |
983 | |
984 | Automatic restart after crash (currently ignored). | |
985 | ||
2489d6df | 986 | `--balloon` `<integer> (0 - N)` :: |
1f554f76 | 987 | |
9d2e98ed | 988 | Amount of target RAM for the VM in MiB. Using zero disables the ballon driver. |
1f554f76 | 989 | |
2489d6df | 990 | `--bios` `<ovmf | seabios>` ('default =' `seabios`):: |
1f554f76 DM |
991 | |
992 | Select BIOS implementation. | |
993 | ||
4772952b | 994 | `--boot` `[[legacy=]<[acdn]{1,4}>] [,order=<device[;device...]>]` :: |
1f554f76 | 995 | |
5370fa8c | 996 | Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated. |
1f554f76 | 997 | |
2489d6df | 998 | `--bootdisk` `(ide|sata|scsi|virtio)\d+` :: |
1f554f76 | 999 | |
4772952b | 1000 | Enable booting from specified disk. Deprecated: Use 'boot: order=foo;bar' instead. |
1f554f76 | 1001 | |
2489d6df | 1002 | `--cdrom` `<volume>` :: |
1f554f76 DM |
1003 | |
1004 | This is an alias for option -ide2 | |
1005 | ||
5370fa8c | 1006 | `--cicustom` `[meta=<volume>] [,network=<volume>] [,user=<volume>] [,vendor=<volume>]` :: |
95895385 TL |
1007 | |
1008 | cloud-init: Specify custom files to replace the automatically generated ones at start. | |
1009 | ||
27a7acb2 DM |
1010 | `--cipassword` `<password>` :: |
1011 | ||
1012 | cloud-init: Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords. | |
1013 | ||
d2656385 | 1014 | `--citype` `<configdrive2 | nocloud | opennebula>` :: |
27a7acb2 DM |
1015 | |
1016 | Specifies the cloud-init configuration format. The default depends on the configured operating system type (`ostype`. We use the `nocloud` format for Linux, and `configdrive2` for windows. | |
1017 | ||
1018 | `--ciuser` `<string>` :: | |
1019 | ||
1020 | cloud-init: User name to change ssh keys and password for instead of the image's configured default user. | |
1021 | ||
2489d6df | 1022 | `--cores` `<integer> (1 - N)` ('default =' `1`):: |
1f554f76 DM |
1023 | |
1024 | The number of cores per socket. | |
1025 | ||
04d22a9f | 1026 | `--cpu` `[[cputype=]<string>] [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=<vendor-id>] [,phys-bits=<8-64|host>] [,reported-model=<enum>]` :: |
1f554f76 DM |
1027 | |
1028 | Emulated CPU type. | |
1029 | ||
2489d6df | 1030 | `--cpulimit` `<number> (0 - 128)` ('default =' `0`):: |
1f554f76 | 1031 | |
9b3e4991 | 1032 | Limit of CPU usage. |
1f554f76 | 1033 | |
7af2edf9 | 1034 | `--cpuunits` `<integer> (1 - 262144)` ('default =' `cgroup v1: 1024, cgroup v2: 100`):: |
1f554f76 | 1035 | |
5370fa8c | 1036 | CPU weight for a VM, will be clamped to [1, 10000] in cgroup v2. |
1f554f76 | 1037 | |
2489d6df | 1038 | `--delete` `<string>` :: |
1f554f76 DM |
1039 | |
1040 | A list of settings you want to delete. | |
1041 | ||
2489d6df | 1042 | `--description` `<string>` :: |
1f554f76 | 1043 | |
8f4d9c87 | 1044 | Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file. |
1f554f76 | 1045 | |
2489d6df | 1046 | `--digest` `<string>` :: |
1f554f76 | 1047 | |
c2993fe5 | 1048 | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
1f554f76 | 1049 | |
7af2edf9 | 1050 | `--efidisk0` `[file=]<volume> [,efitype=<2m|4m>] [,format=<enum>] [,import-from=<source volume>] [,pre-enrolled-keys=<1|0>] [,size=<DiskSize>]` :: |
2c0dde61 | 1051 | |
9d2e98ed | 1052 | Configure a disk for storing EFI vars. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. |
2c0dde61 | 1053 | |
2489d6df | 1054 | `--force` `<boolean>` :: |
1f554f76 | 1055 | |
c2993fe5 | 1056 | Force physical removal. Without this, we simple remove the disk from the config file and create an additional configuration entry called 'unused[n]', which contains the volume ID. Unlink of unused[n] always cause physical removal. |
1f554f76 DM |
1057 | + |
1058 | NOTE: Requires option(s): `delete` | |
1059 | ||
2489d6df | 1060 | `--freeze` `<boolean>` :: |
1f554f76 DM |
1061 | |
1062 | Freeze CPU at startup (use 'c' monitor command to start execution). | |
1063 | ||
5f26e15b TL |
1064 | `--hookscript` `<string>` :: |
1065 | ||
1066 | Script that will be executed during various steps in the vms lifetime. | |
1067 | ||
7af2edf9 | 1068 | `--hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,device-id=<hex id>] [,legacy-igd=<1|0>] [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,sub-device-id=<hex id>] [,sub-vendor-id=<hex id>] [,vendor-id=<hex id>] [,x-vga=<1|0>]` :: |
1f554f76 | 1069 | |
c2993fe5 | 1070 | Map host PCI devices into guest. |
1f554f76 | 1071 | |
2489d6df | 1072 | `--hotplug` `<string>` ('default =' `network,disk,usb`):: |
1f554f76 | 1073 | |
4e7f60c2 | 1074 | Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory', 'usb' and 'cloudinit'. Use '0' to disable hotplug completely. Using '1' as value is an alias for the default `network,disk,usb`. USB hotplugging is possible for guests with machine version >= 7.1 and ostype l26 or windows > 7. |
1f554f76 | 1075 | |
2489d6df | 1076 | `--hugepages` `<1024 | 2 | any>` :: |
2c0dde61 DM |
1077 | |
1078 | Enable/disable hugepages memory. | |
1079 | ||
7af2edf9 | 1080 | `--ide[n]` `[file=]<volume> [,aio=<native|threads|io_uring>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,import-from=<source volume>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]` :: |
1f554f76 | 1081 | |
7af2edf9 | 1082 | Use volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. |
1f554f76 | 1083 | |
27a7acb2 DM |
1084 | `--ipconfig[n]` `[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]` :: |
1085 | ||
1086 | cloud-init: Specify IP addresses and gateways for the corresponding interface. | |
1087 | + | |
1088 | IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. | |
1089 | + | |
4772952b TL |
1090 | The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit |
1091 | gateway should be provided. | |
d2656385 TL |
1092 | For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires |
1093 | cloud-init 19.4 or newer. | |
27a7acb2 | 1094 | + |
4772952b TL |
1095 | If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using |
1096 | dhcp on IPv4. | |
27a7acb2 | 1097 | |
95895385 TL |
1098 | `--ivshmem` `size=<integer> [,name=<string>]` :: |
1099 | ||
1100 | Inter-VM shared memory. Useful for direct communication between VMs, or to the host. | |
1101 | ||
4772952b TL |
1102 | `--keephugepages` `<boolean>` ('default =' `0`):: |
1103 | ||
1104 | Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts. | |
1105 | ||
35a75dd3 | 1106 | `--keyboard` `<da | de | de-ch | en-gb | en-us | es | fi | fr | fr-be | fr-ca | fr-ch | hu | is | it | ja | lt | mk | nl | no | pl | pt | pt-br | sl | sv | tr>` :: |
1f554f76 | 1107 | |
7af2edf9 | 1108 | Keyboard layout for VNC server. This option is generally not required and is often better handled from within the guest OS. |
1f554f76 | 1109 | |
2489d6df | 1110 | `--kvm` `<boolean>` ('default =' `1`):: |
1f554f76 DM |
1111 | |
1112 | Enable/disable KVM hardware virtualization. | |
1113 | ||
2489d6df | 1114 | `--localtime` `<boolean>` :: |
1f554f76 | 1115 | |
5370fa8c | 1116 | Set the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS. |
1f554f76 | 1117 | |
95895385 | 1118 | `--lock` `<backup | clone | create | migrate | rollback | snapshot | snapshot-delete | suspended | suspending>` :: |
1f554f76 DM |
1119 | |
1120 | Lock/unlock the VM. | |
1121 | ||
5c1699e5 | 1122 | `--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` :: |
1f554f76 | 1123 | |
9d2e98ed | 1124 | Specifies the QEMU machine type. |
1f554f76 | 1125 | |
2489d6df | 1126 | `--memory` `<integer> (16 - N)` ('default =' `512`):: |
1f554f76 | 1127 | |
9d2e98ed | 1128 | Amount of RAM for the VM in MiB. This is the maximum available memory when you use the balloon device. |
1f554f76 | 1129 | |
2489d6df | 1130 | `--migrate_downtime` `<number> (0 - N)` ('default =' `0.1`):: |
1f554f76 DM |
1131 | |
1132 | Set maximum tolerated downtime (in seconds) for migrations. | |
1133 | ||
2489d6df | 1134 | `--migrate_speed` `<integer> (0 - N)` ('default =' `0`):: |
1f554f76 DM |
1135 | |
1136 | Set maximum speed (in MB/s) for migrations. Value 0 is no limit. | |
1137 | ||
2489d6df | 1138 | `--name` `<string>` :: |
1f554f76 DM |
1139 | |
1140 | Set a name for the VM. Only used on the configuration web interface. | |
1141 | ||
27a7acb2 DM |
1142 | `--nameserver` `<string>` :: |
1143 | ||
de786b48 | 1144 | cloud-init: Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set. |
27a7acb2 | 1145 | |
ac70d7d1 | 1146 | `--net[n]` `[model=]<enum> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,mtu=<integer>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]` :: |
1f554f76 DM |
1147 | |
1148 | Specify network devices. | |
1f554f76 | 1149 | |
2489d6df | 1150 | `--numa` `<boolean>` ('default =' `0`):: |
1f554f76 | 1151 | |
9b3e4991 | 1152 | Enable/disable NUMA. |
1f554f76 | 1153 | |
2489d6df | 1154 | `--numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` :: |
1f554f76 | 1155 | |
c2993fe5 | 1156 | NUMA topology. |
1f554f76 | 1157 | |
2489d6df | 1158 | `--onboot` `<boolean>` ('default =' `0`):: |
1f554f76 DM |
1159 | |
1160 | Specifies whether a VM will be started during system bootup. | |
1161 | ||
5370fa8c | 1162 | `--ostype` `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win11 | win7 | win8 | wvista | wxp>` :: |
1f554f76 | 1163 | |
c2993fe5 | 1164 | Specify guest operating system. |
1f554f76 | 1165 | |
2489d6df | 1166 | `--parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` :: |
1f554f76 DM |
1167 | |
1168 | Map host parallel devices (n is 0 to 2). | |
1f554f76 | 1169 | |
2489d6df | 1170 | `--protection` `<boolean>` ('default =' `0`):: |
1f554f76 | 1171 | |
c2993fe5 | 1172 | Sets the protection flag of the VM. This will disable the remove VM and remove disk operations. |
1f554f76 | 1173 | |
2489d6df | 1174 | `--reboot` `<boolean>` ('default =' `1`):: |
1f554f76 DM |
1175 | |
1176 | Allow reboot. If set to '0' the VM exit on reboot. | |
1177 | ||
2489d6df | 1178 | `--revert` `<string>` :: |
1f554f76 DM |
1179 | |
1180 | Revert a pending change. | |
1181 | ||
c5aa7e14 TL |
1182 | `--rng0` `[source=]</dev/urandom|/dev/random|/dev/hwrng> [,max_bytes=<integer>] [,period=<integer>]` :: |
1183 | ||
1184 | Configure a VirtIO-based Random Number Generator. | |
1185 | ||
7af2edf9 | 1186 | `--sata[n]` `[file=]<volume> [,aio=<native|threads|io_uring>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,import-from=<source volume>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]` :: |
1f554f76 | 1187 | |
7af2edf9 | 1188 | Use volume as SATA hard disk or CD-ROM (n is 0 to 5). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. |
1f554f76 | 1189 | |
7af2edf9 | 1190 | `--scsi[n]` `[file=]<volume> [,aio=<native|threads|io_uring>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,import-from=<source volume>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,queues=<integer>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,ro=<1|0>] [,scsiblock=<1|0>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]` :: |
1f554f76 | 1191 | |
7af2edf9 | 1192 | Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. |
1f554f76 | 1193 | |
2489d6df | 1194 | `--scsihw` `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`):: |
1f554f76 | 1195 | |
c2993fe5 | 1196 | SCSI controller model |
1f554f76 | 1197 | |
27a7acb2 DM |
1198 | `--searchdomain` `<string>` :: |
1199 | ||
de786b48 | 1200 | cloud-init: Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set. |
27a7acb2 | 1201 | |
2489d6df | 1202 | `--serial[n]` `(/dev/.+|socket)` :: |
1f554f76 | 1203 | |
c2993fe5 | 1204 | Create a serial device inside the VM (n is 0 to 3) |
1f554f76 | 1205 | |
2489d6df | 1206 | `--shares` `<integer> (0 - 50000)` ('default =' `1000`):: |
1f554f76 | 1207 | |
5da3d723 | 1208 | Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning. Auto-ballooning is done by pvestatd. |
1f554f76 | 1209 | |
2489d6df | 1210 | `--skiplock` `<boolean>` :: |
1f554f76 DM |
1211 | |
1212 | Ignore locks - only root is allowed to use this option. | |
1213 | ||
1e3f8156 | 1214 | `--smbios1` `[base64=<1|0>] [,family=<Base64 encoded string>] [,manufacturer=<Base64 encoded string>] [,product=<Base64 encoded string>] [,serial=<Base64 encoded string>] [,sku=<Base64 encoded string>] [,uuid=<UUID>] [,version=<Base64 encoded string>]` :: |
1f554f76 DM |
1215 | |
1216 | Specify SMBIOS type 1 fields. | |
1217 | ||
2489d6df | 1218 | `--smp` `<integer> (1 - N)` ('default =' `1`):: |
1f554f76 DM |
1219 | |
1220 | The number of CPUs. Please use option -sockets instead. | |
1221 | ||
2489d6df | 1222 | `--sockets` `<integer> (1 - N)` ('default =' `1`):: |
1f554f76 DM |
1223 | |
1224 | The number of CPU sockets. | |
1225 | ||
1c532546 TL |
1226 | `--spice_enhancements` `[foldersharing=<1|0>] [,videostreaming=<off|all|filter>]` :: |
1227 | ||
1228 | Configure additional enhancements for SPICE. | |
1229 | ||
27a7acb2 DM |
1230 | `--sshkeys` `<filepath>` :: |
1231 | ||
1232 | cloud-init: Setup public SSH keys (one key per line, OpenSSH format). | |
1233 | ||
2489d6df | 1234 | `--startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`):: |
1f554f76 | 1235 | |
4772952b | 1236 | Set the initial date of the real time clock. Valid format for date are:'now' or '2006-06-17T16:01:21' or '2006-06-17'. |
1f554f76 | 1237 | |
2489d6df | 1238 | `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` :: |
1f554f76 | 1239 | |
c2993fe5 | 1240 | Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped. |
1f554f76 | 1241 | |
2489d6df | 1242 | `--tablet` `<boolean>` ('default =' `1`):: |
1f554f76 | 1243 | |
c2993fe5 | 1244 | Enable/disable the USB tablet device. |
1f554f76 | 1245 | |
5c1699e5 TL |
1246 | `--tags` `<string>` :: |
1247 | ||
1248 | Tags of the VM. This is only meta information. | |
1249 | ||
2489d6df | 1250 | `--tdf` `<boolean>` ('default =' `0`):: |
1f554f76 DM |
1251 | |
1252 | Enable/disable time drift fix. | |
1253 | ||
2489d6df | 1254 | `--template` `<boolean>` ('default =' `0`):: |
1f554f76 DM |
1255 | |
1256 | Enable/disable Template. | |
1257 | ||
7af2edf9 | 1258 | `--tpmstate0` `[file=]<volume> [,import-from=<source volume>] [,size=<DiskSize>] [,version=<v1.2|v2.0>]` :: |
5370fa8c | 1259 | |
7af2edf9 | 1260 | Configure a Disk for storing TPM state. The format is fixed to 'raw'. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and 4 MiB will be used instead. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. |
5370fa8c | 1261 | |
c5aa7e14 | 1262 | `--unused[n]` `[file=]<volume>` :: |
1f554f76 | 1263 | |
c2993fe5 | 1264 | Reference to unused volumes. This is used internally, and should not be modified manually. |
1f554f76 | 1265 | |
2489d6df | 1266 | `--usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` :: |
1f554f76 | 1267 | |
4e7f60c2 | 1268 | Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). |
1f554f76 | 1269 | |
2489d6df | 1270 | `--vcpus` `<integer> (1 - N)` ('default =' `0`):: |
1f554f76 DM |
1271 | |
1272 | Number of hotplugged vcpus. | |
1273 | ||
e2d681b3 | 1274 | `--vga` `[[type=]<enum>] [,memory=<integer>]` :: |
1f554f76 | 1275 | |
e2d681b3 | 1276 | Configure the VGA hardware. |
1f554f76 | 1277 | |
7af2edf9 | 1278 | `--virtio[n]` `[file=]<volume> [,aio=<native|threads|io_uring>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,import-from=<source volume>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,ro=<1|0>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` :: |
1f554f76 | 1279 | |
7af2edf9 | 1280 | Use volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. |
1f554f76 | 1281 | |
4d47f125 TL |
1282 | `--vmgenid` `<UUID>` ('default =' `1 (autogenerated)`):: |
1283 | ||
1284 | Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly. | |
1285 | ||
2489d6df WB |
1286 | `--vmstatestorage` `<string>` :: |
1287 | ||
1288 | Default storage for VM state volumes/files. | |
1289 | ||
1290 | `--watchdog` `[[model=]<i6300esb|ib700>] [,action=<enum>]` :: | |
1f554f76 | 1291 | |
c2993fe5 | 1292 | Create a virtual hardware watchdog device. |
1f554f76 | 1293 | |
35a75dd3 | 1294 | *qm showcmd* `<vmid>` `[OPTIONS]` |
1f554f76 DM |
1295 | |
1296 | Show command line which is used to start the VM (debug info). | |
1297 | ||
013dc89f | 1298 | `<vmid>`: `<integer> (1 - N)` :: |
1f554f76 DM |
1299 | |
1300 | The (unique) ID of the VM. | |
1301 | ||
35a75dd3 | 1302 | `--pretty` `<boolean>` ('default =' `0`):: |
1f554f76 | 1303 | |
35a75dd3 | 1304 | Puts each option on a new line to enhance human readability |
1f554f76 | 1305 | |
5f26e15b TL |
1306 | `--snapshot` `<string>` :: |
1307 | ||
1308 | Fetch config values from given snapshot. | |
1309 | ||
1f554f76 DM |
1310 | *qm shutdown* `<vmid>` `[OPTIONS]` |
1311 | ||
9b3e4991 DM |
1312 | Shutdown virtual machine. This is similar to pressing the power button on a |
1313 | physical machine.This will send an ACPI event for the guest OS, which | |
1314 | should then proceed to a clean shutdown. | |
1f554f76 | 1315 | |
013dc89f | 1316 | `<vmid>`: `<integer> (1 - N)` :: |
1f554f76 DM |
1317 | |
1318 | The (unique) ID of the VM. | |
1319 | ||
2489d6df | 1320 | `--forceStop` `<boolean>` ('default =' `0`):: |
1f554f76 DM |
1321 | |
1322 | Make sure the VM stops. | |
1323 | ||
2489d6df | 1324 | `--keepActive` `<boolean>` ('default =' `0`):: |
1f554f76 | 1325 | |
de0983cb | 1326 | Do not deactivate storage volumes. |
1f554f76 | 1327 | |
2489d6df | 1328 | `--skiplock` `<boolean>` :: |
1f554f76 DM |
1329 | |
1330 | Ignore locks - only root is allowed to use this option. | |
1331 | ||
2489d6df | 1332 | `--timeout` `<integer> (0 - N)` :: |
1f554f76 DM |
1333 | |
1334 | Wait maximal timeout seconds. | |
1335 | ||
1f554f76 DM |
1336 | *qm snapshot* `<vmid> <snapname>` `[OPTIONS]` |
1337 | ||
1338 | Snapshot a VM. | |
1339 | ||
013dc89f | 1340 | `<vmid>`: `<integer> (1 - N)` :: |
1f554f76 DM |
1341 | |
1342 | The (unique) ID of the VM. | |
1343 | ||
013dc89f | 1344 | `<snapname>`: `<string>` :: |
1f554f76 DM |
1345 | |
1346 | The name of the snapshot. | |
1347 | ||
2489d6df | 1348 | `--description` `<string>` :: |
1f554f76 DM |
1349 | |
1350 | A textual description or comment. | |
1351 | ||
2489d6df | 1352 | `--vmstate` `<boolean>` :: |
1f554f76 DM |
1353 | |
1354 | Save the vmstate | |
1355 | ||
1f554f76 DM |
1356 | *qm start* `<vmid>` `[OPTIONS]` |
1357 | ||
1358 | Start virtual machine. | |
1359 | ||
013dc89f | 1360 | `<vmid>`: `<integer> (1 - N)` :: |
1f554f76 DM |
1361 | |
1362 | The (unique) ID of the VM. | |
1363 | ||
c5aa7e14 TL |
1364 | `--force-cpu` `<string>` :: |
1365 | ||
1366 | Override QEMU's -cpu argument with the given string. | |
1367 | ||
5c1699e5 | 1368 | `--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` :: |
1f554f76 | 1369 | |
9d2e98ed | 1370 | Specifies the QEMU machine type. |
1f554f76 | 1371 | |
2489d6df | 1372 | `--migratedfrom` `<string>` :: |
1f554f76 DM |
1373 | |
1374 | The cluster node name. | |
1375 | ||
2489d6df | 1376 | `--migration_network` `<string>` :: |
de0983cb DM |
1377 | |
1378 | CIDR of the (sub) network that is used for migration. | |
1379 | ||
2489d6df | 1380 | `--migration_type` `<insecure | secure>` :: |
de0983cb DM |
1381 | |
1382 | Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance. | |
1383 | ||
2489d6df | 1384 | `--skiplock` `<boolean>` :: |
1f554f76 DM |
1385 | |
1386 | Ignore locks - only root is allowed to use this option. | |
1387 | ||
2489d6df | 1388 | `--stateuri` `<string>` :: |
1f554f76 DM |
1389 | |
1390 | Some command save/restore state from this location. | |
1391 | ||
2489d6df | 1392 | `--targetstorage` `<string>` :: |
52e44c50 | 1393 | |
c5aa7e14 | 1394 | Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself. |
52e44c50 | 1395 | |
e9cd3bd4 TL |
1396 | `--timeout` `<integer> (0 - N)` ('default =' `max(30, vm memory in GiB)`):: |
1397 | ||
1398 | Wait maximal timeout seconds. | |
1399 | ||
1f554f76 DM |
1400 | *qm status* `<vmid>` `[OPTIONS]` |
1401 | ||
1402 | Show VM status. | |
1403 | ||
013dc89f | 1404 | `<vmid>`: `<integer> (1 - N)` :: |
1f554f76 DM |
1405 | |
1406 | The (unique) ID of the VM. | |
1407 | ||
2489d6df | 1408 | `--verbose` `<boolean>` :: |
1f554f76 DM |
1409 | |
1410 | Verbose output format | |
1411 | ||
1f554f76 DM |
1412 | *qm stop* `<vmid>` `[OPTIONS]` |
1413 | ||
9b3e4991 DM |
1414 | Stop virtual machine. The qemu process will exit immediately. Thisis akin |
1415 | to pulling the power plug of a running computer and may damage the VM data | |
1f554f76 | 1416 | |
013dc89f | 1417 | `<vmid>`: `<integer> (1 - N)` :: |
1f554f76 DM |
1418 | |
1419 | The (unique) ID of the VM. | |
1420 | ||
2489d6df | 1421 | `--keepActive` `<boolean>` ('default =' `0`):: |
1f554f76 | 1422 | |
de0983cb | 1423 | Do not deactivate storage volumes. |
1f554f76 | 1424 | |
2489d6df | 1425 | `--migratedfrom` `<string>` :: |
1f554f76 DM |
1426 | |
1427 | The cluster node name. | |
1428 | ||
2489d6df | 1429 | `--skiplock` `<boolean>` :: |
1f554f76 DM |
1430 | |
1431 | Ignore locks - only root is allowed to use this option. | |
1432 | ||
2489d6df | 1433 | `--timeout` `<integer> (0 - N)` :: |
1f554f76 DM |
1434 | |
1435 | Wait maximal timeout seconds. | |
1436 | ||
1f554f76 DM |
1437 | *qm suspend* `<vmid>` `[OPTIONS]` |
1438 | ||
1439 | Suspend virtual machine. | |
1440 | ||
013dc89f | 1441 | `<vmid>`: `<integer> (1 - N)` :: |
1f554f76 DM |
1442 | |
1443 | The (unique) ID of the VM. | |
1444 | ||
2489d6df | 1445 | `--skiplock` `<boolean>` :: |
1f554f76 DM |
1446 | |
1447 | Ignore locks - only root is allowed to use this option. | |
1448 | ||
95895385 TL |
1449 | `--statestorage` `<string>` :: |
1450 | ||
1451 | The storage for the VM state | |
1452 | + | |
1453 | NOTE: Requires option(s): `todisk` | |
1454 | ||
1455 | `--todisk` `<boolean>` ('default =' `0`):: | |
1456 | ||
1457 | If set, suspends the VM to disk. Will be resumed on next VM start. | |
1458 | ||
1f554f76 DM |
1459 | *qm template* `<vmid>` `[OPTIONS]` |
1460 | ||
1461 | Create a Template. | |
1462 | ||
013dc89f | 1463 | `<vmid>`: `<integer> (1 - N)` :: |
1f554f76 DM |
1464 | |
1465 | The (unique) ID of the VM. | |
1466 | ||
5370fa8c | 1467 | `--disk` `<efidisk0 | ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi14 | scsi15 | scsi16 | scsi17 | scsi18 | scsi19 | scsi2 | scsi20 | scsi21 | scsi22 | scsi23 | scsi24 | scsi25 | scsi26 | scsi27 | scsi28 | scsi29 | scsi3 | scsi30 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | tpmstate0 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9>` :: |
1f554f76 DM |
1468 | |
1469 | If you want to convert only 1 disk to base image. | |
1470 | ||
1f554f76 DM |
1471 | *qm terminal* `<vmid>` `[OPTIONS]` |
1472 | ||
1473 | Open a terminal using a serial device (The VM need to have a serial device | |
1474 | configured, for example 'serial0: socket') | |
1475 | ||
013dc89f | 1476 | `<vmid>`: `<integer> (1 - N)` :: |
1f554f76 DM |
1477 | |
1478 | The (unique) ID of the VM. | |
1479 | ||
35a75dd3 | 1480 | `--escape` `<string>` ('default =' `^O`):: |
1f554f76 | 1481 | |
35a75dd3 | 1482 | Escape character. |
1f554f76 | 1483 | |
35a75dd3 | 1484 | `--iface` `<serial0 | serial1 | serial2 | serial3>` :: |
1f554f76 | 1485 | |
35a75dd3 | 1486 | Select the serial device. By default we simply use the first suitable device. |
1f554f76 | 1487 | |
4e7f60c2 | 1488 | *qm unlink* |
1f554f76 | 1489 | |
4e7f60c2 | 1490 | An alias for 'qm disk unlink'. |
1f554f76 | 1491 | |
1f554f76 DM |
1492 | *qm unlock* `<vmid>` |
1493 | ||
1494 | Unlock the VM. | |
1495 | ||
013dc89f | 1496 | `<vmid>`: `<integer> (1 - N)` :: |
1f554f76 DM |
1497 | |
1498 | The (unique) ID of the VM. | |
1499 | ||
1f554f76 DM |
1500 | *qm vncproxy* `<vmid>` |
1501 | ||
1502 | Proxy VM VNC traffic to stdin/stdout | |
1503 | ||
013dc89f | 1504 | `<vmid>`: `<integer> (1 - N)` :: |
1f554f76 DM |
1505 | |
1506 | The (unique) ID of the VM. | |
1507 | ||
1f554f76 DM |
1508 | *qm wait* `<vmid>` `[OPTIONS]` |
1509 | ||
1510 | Wait until the VM is stopped. | |
1511 | ||
013dc89f | 1512 | `<vmid>`: `<integer> (1 - N)` :: |
1f554f76 DM |
1513 | |
1514 | The (unique) ID of the VM. | |
1515 | ||
2489d6df | 1516 | `--timeout` `<integer> (1 - N)` :: |
1f554f76 DM |
1517 | |
1518 | Timeout in seconds. Default is to wait forever. | |
1519 | ||
1520 |