1 *qm* `<COMMAND> [ARGS] [OPTIONS]`
5 An alias for 'qm guest cmd'.
7 *qm cleanup* `<vmid> <clean-shutdown> <guest-requested>`
9 Cleans up resources like tap devices, vgpus, etc. Called after a vm shuts
12 `<vmid>`: `<integer> (1 - N)` ::
14 The (unique) ID of the VM.
16 `<clean-shutdown>`: `<boolean>` ::
18 Indicates if qemu shutdown cleanly.
20 `<guest-requested>`: `<boolean>` ::
22 Indicates if the shutdown was requested by the guest or via qmp.
24 *qm clone* `<vmid> <newid>` `[OPTIONS]`
26 Create a copy of virtual machine/template.
28 `<vmid>`: `<integer> (1 - N)` ::
30 The (unique) ID of the VM.
32 `<newid>`: `<integer> (1 - N)` ::
36 `--bwlimit` `<integer> (0 - N)` ('default =' `clone limit from datacenter or storage config`)::
38 Override I/O bandwidth limit (in KiB/s).
40 `--description` `<string>` ::
42 Description for the new VM.
44 `--format` `<qcow2 | raw | vmdk>` ::
46 Target format for file storage. Only valid for full clone.
48 `--full` `<boolean>` ::
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.
52 `--name` `<string>` ::
54 Set a name for the new VM.
56 `--pool` `<string>` ::
58 Add the new VM to the specified pool.
60 `--snapname` `<string>` ::
62 The name of the snapshot.
64 `--storage` `<string>` ::
66 Target storage for full clone.
68 `--target` `<string>` ::
70 Target node. Only allowed if the original VM is on shared storage.
72 *qm cloudinit dump* `<vmid> <type>`
74 Get automatically generated cloudinit config.
76 `<vmid>`: `<integer> (1 - N)` ::
78 The (unique) ID of the VM.
80 `<type>`: `<meta | network | user>` ::
84 *qm cloudinit pending* `<vmid>`
86 Get the cloudinit configuration with both current and pending values.
88 `<vmid>`: `<integer> (1 - N)` ::
90 The (unique) ID of the VM.
92 *qm cloudinit update* `<vmid>`
94 Regenerate and change cloudinit config drive.
96 `<vmid>`: `<integer> (1 - N)` ::
98 The (unique) ID of the VM.
100 *qm config* `<vmid>` `[OPTIONS]`
102 Get the virtual machine configuration with pending configuration changes
103 applied. Set the 'current' parameter to get the current configuration
106 `<vmid>`: `<integer> (1 - N)` ::
108 The (unique) ID of the VM.
110 `--current` `<boolean>` ('default =' `0`)::
112 Get current values (instead of pending values).
114 `--snapshot` `<string>` ::
116 Fetch config values from given snapshot.
118 *qm create* `<vmid>` `[OPTIONS]`
120 Create or restore a virtual machine.
122 `<vmid>`: `<integer> (1 - N)` ::
124 The (unique) ID of the VM.
126 `--acpi` `<boolean>` ('default =' `1`)::
130 `--affinity` `<string>` ::
132 List of host cores used to execute guest processes, for example: 0,5,8-11
134 `--agent` `[enabled=]<1|0> [,freeze-fs-on-backup=<1|0>] [,fstrim_cloned_disks=<1|0>] [,type=<virtio|isa>]` ::
136 Enable/disable communication with the QEMU Guest Agent and its properties.
138 `--arch` `<aarch64 | x86_64>` ::
140 Virtual processor architecture. Defaults to the host.
142 `--archive` `<string>` ::
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.
146 `--args` `<string>` ::
148 Arbitrary arguments passed to kvm.
150 `--audio0` `device=<ich9-intel-hda|intel-hda|AC97> [,driver=<spice|none>]` ::
152 Configure a audio device, useful in combination with QXL/Spice.
154 `--autostart` `<boolean>` ('default =' `0`)::
156 Automatic restart after crash (currently ignored).
158 `--balloon` `<integer> (0 - N)` ::
160 Amount of target RAM for the VM in MiB. Using zero disables the ballon driver.
162 `--bios` `<ovmf | seabios>` ('default =' `seabios`)::
164 Select BIOS implementation.
166 `--boot` `[[legacy=]<[acdn]{1,4}>] [,order=<device[;device...]>]` ::
168 Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated.
170 `--bootdisk` `(ide|sata|scsi|virtio)\d+` ::
172 Enable booting from specified disk. Deprecated: Use 'boot: order=foo;bar' instead.
174 `--bwlimit` `<integer> (0 - N)` ('default =' `restore limit from datacenter or storage config`)::
176 Override I/O bandwidth limit (in KiB/s).
178 `--cdrom` `<volume>` ::
180 This is an alias for option -ide2
182 `--cicustom` `[meta=<volume>] [,network=<volume>] [,user=<volume>] [,vendor=<volume>]` ::
184 cloud-init: Specify custom files to replace the automatically generated ones at start.
186 `--cipassword` `<password>` ::
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.
190 `--citype` `<configdrive2 | nocloud | opennebula>` ::
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.
194 `--ciuser` `<string>` ::
196 cloud-init: User name to change ssh keys and password for instead of the image's configured default user.
198 `--cores` `<integer> (1 - N)` ('default =' `1`)::
200 The number of cores per socket.
202 `--cpu` `[[cputype=]<string>] [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=<vendor-id>] [,phys-bits=<8-64|host>] [,reported-model=<enum>]` ::
206 `--cpulimit` `<number> (0 - 128)` ('default =' `0`)::
210 `--cpuunits` `<integer> (1 - 262144)` ('default =' `cgroup v1: 1024, cgroup v2: 100`)::
212 CPU weight for a VM, will be clamped to [1, 10000] in cgroup v2.
214 `--description` `<string>` ::
216 Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file.
218 `--efidisk0` `[file=]<volume> [,efitype=<2m|4m>] [,format=<enum>] [,import-from=<source volume>] [,pre-enrolled-keys=<1|0>] [,size=<DiskSize>]` ::
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.
222 `--force` `<boolean>` ::
224 Allow to overwrite existing VM.
226 NOTE: Requires option(s): `archive`
228 `--freeze` `<boolean>` ::
230 Freeze CPU at startup (use 'c' monitor command to start execution).
232 `--hookscript` `<string>` ::
234 Script that will be executed during various steps in the vms lifetime.
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>]` ::
238 Map host PCI devices into guest.
240 `--hotplug` `<string>` ('default =' `network,disk,usb`)::
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.
244 `--hugepages` `<1024 | 2 | any>` ::
246 Enable/disable hugepages memory.
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>]` ::
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.
252 `--ipconfig[n]` `[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]` ::
254 cloud-init: Specify IP addresses and gateways for the corresponding interface.
256 IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.
258 The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit
259 gateway should be provided.
260 For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires
261 cloud-init 19.4 or newer.
263 If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using
266 `--ivshmem` `size=<integer> [,name=<string>]` ::
268 Inter-VM shared memory. Useful for direct communication between VMs, or to the host.
270 `--keephugepages` `<boolean>` ('default =' `0`)::
272 Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts.
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>` ::
276 Keyboard layout for VNC server. This option is generally not required and is often better handled from within the guest OS.
278 `--kvm` `<boolean>` ('default =' `1`)::
280 Enable/disable KVM hardware virtualization.
282 `--live-restore` `<boolean>` ::
284 Start the VM immediately from the backup and restore in background. PBS only.
286 NOTE: Requires option(s): `archive`
288 `--localtime` `<boolean>` ::
290 Set the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS.
292 `--lock` `<backup | clone | create | migrate | rollback | snapshot | snapshot-delete | suspended | suspending>` ::
296 `--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` ::
298 Specifies the QEMU machine type.
300 `--memory` `<integer> (16 - N)` ('default =' `512`)::
302 Amount of RAM for the VM in MiB. This is the maximum available memory when you use the balloon device.
304 `--migrate_downtime` `<number> (0 - N)` ('default =' `0.1`)::
306 Set maximum tolerated downtime (in seconds) for migrations.
308 `--migrate_speed` `<integer> (0 - N)` ('default =' `0`)::
310 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
312 `--name` `<string>` ::
314 Set a name for the VM. Only used on the configuration web interface.
316 `--nameserver` `<string>` ::
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.
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>]` ::
322 Specify network devices.
324 `--numa` `<boolean>` ('default =' `0`)::
328 `--numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
332 `--onboot` `<boolean>` ('default =' `0`)::
334 Specifies whether a VM will be started during system bootup.
336 `--ostype` `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win11 | win7 | win8 | wvista | wxp>` ::
338 Specify guest operating system.
340 `--parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` ::
342 Map host parallel devices (n is 0 to 2).
344 `--pool` `<string>` ::
346 Add the VM to the specified pool.
348 `--protection` `<boolean>` ('default =' `0`)::
350 Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
352 `--reboot` `<boolean>` ('default =' `1`)::
354 Allow reboot. If set to '0' the VM exit on reboot.
356 `--rng0` `[source=]</dev/urandom|/dev/random|/dev/hwrng> [,max_bytes=<integer>] [,period=<integer>]` ::
358 Configure a VirtIO-based Random Number Generator.
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>]` ::
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.
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>]` ::
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.
368 `--scsihw` `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
370 SCSI controller model
372 `--searchdomain` `<string>` ::
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.
376 `--serial[n]` `(/dev/.+|socket)` ::
378 Create a serial device inside the VM (n is 0 to 3)
380 `--shares` `<integer> (0 - 50000)` ('default =' `1000`)::
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.
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>]` ::
386 Specify SMBIOS type 1 fields.
388 `--smp` `<integer> (1 - N)` ('default =' `1`)::
390 The number of CPUs. Please use option -sockets instead.
392 `--sockets` `<integer> (1 - N)` ('default =' `1`)::
394 The number of CPU sockets.
396 `--spice_enhancements` `[foldersharing=<1|0>] [,videostreaming=<off|all|filter>]` ::
398 Configure additional enhancements for SPICE.
400 `--sshkeys` `<filepath>` ::
402 cloud-init: Setup public SSH keys (one key per line, OpenSSH format).
404 `--start` `<boolean>` ('default =' `0`)::
406 Start VM after it was created successfully.
408 `--startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
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'.
412 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
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.
416 `--storage` `<string>` ::
420 `--tablet` `<boolean>` ('default =' `1`)::
422 Enable/disable the USB tablet device.
424 `--tags` `<string>` ::
426 Tags of the VM. This is only meta information.
428 `--tdf` `<boolean>` ('default =' `0`)::
430 Enable/disable time drift fix.
432 `--template` `<boolean>` ('default =' `0`)::
434 Enable/disable Template.
436 `--tpmstate0` `[file=]<volume> [,import-from=<source volume>] [,size=<DiskSize>] [,version=<v1.2|v2.0>]` ::
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.
440 `--unique` `<boolean>` ::
442 Assign a unique random ethernet address.
444 NOTE: Requires option(s): `archive`
446 `--unused[n]` `[file=]<volume>` ::
448 Reference to unused volumes. This is used internally, and should not be modified manually.
450 `--usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
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).
454 `--vcpus` `<integer> (1 - N)` ('default =' `0`)::
456 Number of hotplugged vcpus.
458 `--vga` `[[type=]<enum>] [,memory=<integer>]` ::
460 Configure the VGA hardware.
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>]` ::
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.
466 `--vmgenid` `<UUID>` ('default =' `1 (autogenerated)`)::
468 Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly.
470 `--vmstatestorage` `<string>` ::
472 Default storage for VM state volumes/files.
474 `--watchdog` `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::
476 Create a virtual hardware watchdog device.
478 *qm delsnapshot* `<vmid> <snapname>` `[OPTIONS]`
480 Delete a VM snapshot.
482 `<vmid>`: `<integer> (1 - N)` ::
484 The (unique) ID of the VM.
486 `<snapname>`: `<string>` ::
488 The name of the snapshot.
490 `--force` `<boolean>` ::
492 For removal from config file, even if removing disk snapshots fails.
494 *qm destroy* `<vmid>` `[OPTIONS]`
496 Destroy the VM and all used/owned volumes. Removes any VM specific
497 permissions and firewall rules
499 `<vmid>`: `<integer> (1 - N)` ::
501 The (unique) ID of the VM.
503 `--destroy-unreferenced-disks` `<boolean>` ('default =' `0`)::
505 If set, destroy additionally all disks not referenced in the config but with a matching VMID from all enabled storages.
507 `--purge` `<boolean>` ::
509 Remove VMID from configurations, like backup & replication jobs and HA.
511 `--skiplock` `<boolean>` ::
513 Ignore locks - only root is allowed to use this option.
515 *qm disk import* `<vmid> <source> <storage>` `[OPTIONS]`
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).
520 `<vmid>`: `<integer> (1 - N)` ::
522 The (unique) ID of the VM.
524 `<source>`: `<string>` ::
526 Path to the disk image to import
528 `<storage>`: `<string>` ::
532 `--format` `<qcow2 | raw | vmdk>` ::
536 *qm disk move* `<vmid> <disk> [<storage>]` `[OPTIONS]`
538 Move volume to different storage or to a different VM.
540 `<vmid>`: `<integer> (1 - N)` ::
542 The (unique) ID of the VM.
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>` ::
546 The disk you want to move.
548 `<storage>`: `<string>` ::
552 `--bwlimit` `<integer> (0 - N)` ('default =' `move limit from datacenter or storage config`)::
554 Override I/O bandwidth limit (in KiB/s).
556 `--delete` `<boolean>` ('default =' `0`)::
558 Delete the original disk after successful copy. By default the original disk is kept as unused disk.
560 `--digest` `<string>` ::
562 Prevent changes if current configuration file has different SHA1"
563 ." digest. This can be used to prevent concurrent modifications.
565 `--format` `<qcow2 | raw | vmdk>` ::
569 `--target-digest` `<string>` ::
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.
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>` ::
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.
578 `--target-vmid` `<integer> (1 - N)` ::
580 The (unique) ID of the VM.
582 *qm disk rescan* `[OPTIONS]`
584 Rescan all storages and update disk sizes and unused disk images.
586 `--dryrun` `<boolean>` ('default =' `0`)::
588 Do not actually write changes out to VM config(s).
590 `--vmid` `<integer> (1 - N)` ::
592 The (unique) ID of the VM.
594 *qm disk resize* `<vmid> <disk> <size>` `[OPTIONS]`
598 `<vmid>`: `<integer> (1 - N)` ::
600 The (unique) ID of the VM.
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>` ::
604 The disk you want to resize.
606 `<size>`: `\+?\d+(\.\d+)?[KMGT]?` ::
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.
610 `--digest` `<string>` ::
612 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
614 `--skiplock` `<boolean>` ::
616 Ignore locks - only root is allowed to use this option.
618 *qm disk unlink* `<vmid> --idlist <string>` `[OPTIONS]`
620 Unlink/delete disk images.
622 `<vmid>`: `<integer> (1 - N)` ::
624 The (unique) ID of the VM.
626 `--force` `<boolean>` ::
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.
630 `--idlist` `<string>` ::
632 A list of disk IDs you want to delete.
634 *qm guest cmd* `<vmid> <command>`
636 Execute QEMU Guest Agent commands.
638 `<vmid>`: `<integer> (1 - N)` ::
640 The (unique) ID of the VM.
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>` ::
646 *qm guest exec* `<vmid> [<extra-args>]` `[OPTIONS]`
648 Executes the given command via the guest agent
650 `<vmid>`: `<integer> (1 - N)` ::
652 The (unique) ID of the VM.
654 `<extra-args>`: `<array>` ::
656 Extra arguments as array
658 `--pass-stdin` `<boolean>` ('default =' `0`)::
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.
662 `--synchronous` `<boolean>` ('default =' `1`)::
664 If set to off, returns the pid immediately instead of waiting for the commmand to finish or the timeout.
666 `--timeout` `<integer> (0 - N)` ('default =' `30`)::
668 The maximum time to wait synchronously for the command to finish. If reached, the pid gets returned. Set to 0 to deactivate
670 *qm guest exec-status* `<vmid> <pid>`
672 Gets the status of the given pid started by the guest-agent
674 `<vmid>`: `<integer> (1 - N)` ::
676 The (unique) ID of the VM.
678 `<pid>`: `<integer>` ::
682 *qm guest passwd* `<vmid> <username>` `[OPTIONS]`
684 Sets the password for the given user to the given password
686 `<vmid>`: `<integer> (1 - N)` ::
688 The (unique) ID of the VM.
690 `<username>`: `<string>` ::
692 The user to set the password for.
694 `--crypted` `<boolean>` ('default =' `0`)::
696 set to 1 if the password has already been passed through crypt()
698 *qm help* `[OPTIONS]`
700 Get help about specified command.
702 `--extra-args` `<array>` ::
704 Shows help for a specific command
706 `--verbose` `<boolean>` ::
708 Verbose output format.
712 An alias for 'qm disk import'.
714 *qm importovf* `<vmid> <manifest> <storage>` `[OPTIONS]`
716 Create a new VM using parameters read from an OVF manifest
718 `<vmid>`: `<integer> (1 - N)` ::
720 The (unique) ID of the VM.
722 `<manifest>`: `<string>` ::
726 `<storage>`: `<string>` ::
730 `--dryrun` `<boolean>` ::
732 Print a parsed representation of the extracted OVF parameters, but do not create a VM
734 `--format` `<qcow2 | raw | vmdk>` ::
738 *qm list* `[OPTIONS]`
740 Virtual machine index (per node).
742 `--full` `<boolean>` ::
744 Determine the full status of active VMs.
746 *qm listsnapshot* `<vmid>`
750 `<vmid>`: `<integer> (1 - N)` ::
752 The (unique) ID of the VM.
754 *qm migrate* `<vmid> <target>` `[OPTIONS]`
756 Migrate virtual machine. Creates a new migration task.
758 `<vmid>`: `<integer> (1 - N)` ::
760 The (unique) ID of the VM.
762 `<target>`: `<string>` ::
766 `--bwlimit` `<integer> (0 - N)` ('default =' `migrate limit from datacenter or storage config`)::
768 Override I/O bandwidth limit (in KiB/s).
770 `--force` `<boolean>` ::
772 Allow to migrate VMs which use local devices. Only root may use this option.
774 `--migration_network` `<string>` ::
776 CIDR of the (sub) network that is used for migration.
778 `--migration_type` `<insecure | secure>` ::
780 Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.
782 `--online` `<boolean>` ::
784 Use online/live migration if VM is running. Ignored if VM is stopped.
786 `--targetstorage` `<string>` ::
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.
790 `--with-local-disks` `<boolean>` ::
792 Enable live storage migration for local disk
794 *qm monitor* `<vmid>`
796 Enter QEMU Monitor interface.
798 `<vmid>`: `<integer> (1 - N)` ::
800 The (unique) ID of the VM.
804 An alias for 'qm disk move'.
808 An alias for 'qm disk move'.
812 Used by qmigrate - do not use manually.
814 *qm nbdstop* `<vmid>`
816 Stop embedded nbd server.
818 `<vmid>`: `<integer> (1 - N)` ::
820 The (unique) ID of the VM.
822 *qm pending* `<vmid>`
824 Get the virtual machine configuration with both current and pending values.
826 `<vmid>`: `<integer> (1 - N)` ::
828 The (unique) ID of the VM.
830 *qm reboot* `<vmid>` `[OPTIONS]`
832 Reboot the VM by shutting it down, and starting it again. Applies pending
835 `<vmid>`: `<integer> (1 - N)` ::
837 The (unique) ID of the VM.
839 `--timeout` `<integer> (0 - N)` ::
841 Wait maximal timeout seconds for the shutdown.
843 *qm remote-migrate* `<vmid> [<target-vmid>] <target-endpoint> --target-bridge <string> --target-storage <string>` `[OPTIONS]`
845 Migrate virtual machine to a remote cluster. Creates a new migration task.
846 EXPERIMENTAL feature!
848 `<vmid>`: `<integer> (1 - N)` ::
850 The (unique) ID of the VM.
852 `<target-vmid>`: `<integer> (1 - N)` ::
854 The (unique) ID of the VM.
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>]` ::
858 Remote target endpoint
860 `--bwlimit` `<integer> (0 - N)` ('default =' `migrate limit from datacenter or storage config`)::
862 Override I/O bandwidth limit (in KiB/s).
864 `--delete` `<boolean>` ('default =' `0`)::
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.
868 `--online` `<boolean>` ::
870 Use online/live migration if VM is running. Ignored if VM is stopped.
872 `--target-bridge` `<string>` ::
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.
876 `--target-storage` `<string>` ::
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.
882 An alias for 'qm disk rescan'.
884 *qm reset* `<vmid>` `[OPTIONS]`
886 Reset virtual machine.
888 `<vmid>`: `<integer> (1 - N)` ::
890 The (unique) ID of the VM.
892 `--skiplock` `<boolean>` ::
894 Ignore locks - only root is allowed to use this option.
898 An alias for 'qm disk resize'.
900 *qm resume* `<vmid>` `[OPTIONS]`
902 Resume virtual machine.
904 `<vmid>`: `<integer> (1 - N)` ::
906 The (unique) ID of the VM.
908 `--nocheck` `<boolean>` ::
910 no description available
912 `--skiplock` `<boolean>` ::
914 Ignore locks - only root is allowed to use this option.
916 *qm rollback* `<vmid> <snapname>` `[OPTIONS]`
918 Rollback VM state to specified snapshot.
920 `<vmid>`: `<integer> (1 - N)` ::
922 The (unique) ID of the VM.
924 `<snapname>`: `<string>` ::
926 The name of the snapshot.
928 `--start` `<boolean>` ('default =' `0`)::
930 Whether the VM should get started after rolling back successfully. (Note: VMs will be automatically started if the snapshot includes RAM.)
932 *qm sendkey* `<vmid> <key>` `[OPTIONS]`
934 Send key event to virtual machine.
936 `<vmid>`: `<integer> (1 - N)` ::
938 The (unique) ID of the VM.
940 `<key>`: `<string>` ::
942 The key (qemu monitor encoding).
944 `--skiplock` `<boolean>` ::
946 Ignore locks - only root is allowed to use this option.
948 *qm set* `<vmid>` `[OPTIONS]`
950 Set virtual machine options (synchrounous API) - You should consider using
951 the POST method instead for any actions involving hotplug or storage
954 `<vmid>`: `<integer> (1 - N)` ::
956 The (unique) ID of the VM.
958 `--acpi` `<boolean>` ('default =' `1`)::
962 `--affinity` `<string>` ::
964 List of host cores used to execute guest processes, for example: 0,5,8-11
966 `--agent` `[enabled=]<1|0> [,freeze-fs-on-backup=<1|0>] [,fstrim_cloned_disks=<1|0>] [,type=<virtio|isa>]` ::
968 Enable/disable communication with the QEMU Guest Agent and its properties.
970 `--arch` `<aarch64 | x86_64>` ::
972 Virtual processor architecture. Defaults to the host.
974 `--args` `<string>` ::
976 Arbitrary arguments passed to kvm.
978 `--audio0` `device=<ich9-intel-hda|intel-hda|AC97> [,driver=<spice|none>]` ::
980 Configure a audio device, useful in combination with QXL/Spice.
982 `--autostart` `<boolean>` ('default =' `0`)::
984 Automatic restart after crash (currently ignored).
986 `--balloon` `<integer> (0 - N)` ::
988 Amount of target RAM for the VM in MiB. Using zero disables the ballon driver.
990 `--bios` `<ovmf | seabios>` ('default =' `seabios`)::
992 Select BIOS implementation.
994 `--boot` `[[legacy=]<[acdn]{1,4}>] [,order=<device[;device...]>]` ::
996 Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated.
998 `--bootdisk` `(ide|sata|scsi|virtio)\d+` ::
1000 Enable booting from specified disk. Deprecated: Use 'boot: order=foo;bar' instead.
1002 `--cdrom` `<volume>` ::
1004 This is an alias for option -ide2
1006 `--cicustom` `[meta=<volume>] [,network=<volume>] [,user=<volume>] [,vendor=<volume>]` ::
1008 cloud-init: Specify custom files to replace the automatically generated ones at start.
1010 `--cipassword` `<password>` ::
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.
1014 `--citype` `<configdrive2 | nocloud | opennebula>` ::
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.
1018 `--ciuser` `<string>` ::
1020 cloud-init: User name to change ssh keys and password for instead of the image's configured default user.
1022 `--cores` `<integer> (1 - N)` ('default =' `1`)::
1024 The number of cores per socket.
1026 `--cpu` `[[cputype=]<string>] [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=<vendor-id>] [,phys-bits=<8-64|host>] [,reported-model=<enum>]` ::
1030 `--cpulimit` `<number> (0 - 128)` ('default =' `0`)::
1034 `--cpuunits` `<integer> (1 - 262144)` ('default =' `cgroup v1: 1024, cgroup v2: 100`)::
1036 CPU weight for a VM, will be clamped to [1, 10000] in cgroup v2.
1038 `--delete` `<string>` ::
1040 A list of settings you want to delete.
1042 `--description` `<string>` ::
1044 Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file.
1046 `--digest` `<string>` ::
1048 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
1050 `--efidisk0` `[file=]<volume> [,efitype=<2m|4m>] [,format=<enum>] [,import-from=<source volume>] [,pre-enrolled-keys=<1|0>] [,size=<DiskSize>]` ::
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.
1054 `--force` `<boolean>` ::
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.
1058 NOTE: Requires option(s): `delete`
1060 `--freeze` `<boolean>` ::
1062 Freeze CPU at startup (use 'c' monitor command to start execution).
1064 `--hookscript` `<string>` ::
1066 Script that will be executed during various steps in the vms lifetime.
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>]` ::
1070 Map host PCI devices into guest.
1072 `--hotplug` `<string>` ('default =' `network,disk,usb`)::
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.
1076 `--hugepages` `<1024 | 2 | any>` ::
1078 Enable/disable hugepages memory.
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>]` ::
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.
1084 `--ipconfig[n]` `[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]` ::
1086 cloud-init: Specify IP addresses and gateways for the corresponding interface.
1088 IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.
1090 The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit
1091 gateway should be provided.
1092 For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires
1093 cloud-init 19.4 or newer.
1095 If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using
1098 `--ivshmem` `size=<integer> [,name=<string>]` ::
1100 Inter-VM shared memory. Useful for direct communication between VMs, or to the host.
1102 `--keephugepages` `<boolean>` ('default =' `0`)::
1104 Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts.
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>` ::
1108 Keyboard layout for VNC server. This option is generally not required and is often better handled from within the guest OS.
1110 `--kvm` `<boolean>` ('default =' `1`)::
1112 Enable/disable KVM hardware virtualization.
1114 `--localtime` `<boolean>` ::
1116 Set the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS.
1118 `--lock` `<backup | clone | create | migrate | rollback | snapshot | snapshot-delete | suspended | suspending>` ::
1122 `--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` ::
1124 Specifies the QEMU machine type.
1126 `--memory` `<integer> (16 - N)` ('default =' `512`)::
1128 Amount of RAM for the VM in MiB. This is the maximum available memory when you use the balloon device.
1130 `--migrate_downtime` `<number> (0 - N)` ('default =' `0.1`)::
1132 Set maximum tolerated downtime (in seconds) for migrations.
1134 `--migrate_speed` `<integer> (0 - N)` ('default =' `0`)::
1136 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
1138 `--name` `<string>` ::
1140 Set a name for the VM. Only used on the configuration web interface.
1142 `--nameserver` `<string>` ::
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.
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>]` ::
1148 Specify network devices.
1150 `--numa` `<boolean>` ('default =' `0`)::
1152 Enable/disable NUMA.
1154 `--numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
1158 `--onboot` `<boolean>` ('default =' `0`)::
1160 Specifies whether a VM will be started during system bootup.
1162 `--ostype` `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win11 | win7 | win8 | wvista | wxp>` ::
1164 Specify guest operating system.
1166 `--parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` ::
1168 Map host parallel devices (n is 0 to 2).
1170 `--protection` `<boolean>` ('default =' `0`)::
1172 Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
1174 `--reboot` `<boolean>` ('default =' `1`)::
1176 Allow reboot. If set to '0' the VM exit on reboot.
1178 `--revert` `<string>` ::
1180 Revert a pending change.
1182 `--rng0` `[source=]</dev/urandom|/dev/random|/dev/hwrng> [,max_bytes=<integer>] [,period=<integer>]` ::
1184 Configure a VirtIO-based Random Number Generator.
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>]` ::
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.
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>]` ::
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.
1194 `--scsihw` `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
1196 SCSI controller model
1198 `--searchdomain` `<string>` ::
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.
1202 `--serial[n]` `(/dev/.+|socket)` ::
1204 Create a serial device inside the VM (n is 0 to 3)
1206 `--shares` `<integer> (0 - 50000)` ('default =' `1000`)::
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.
1210 `--skiplock` `<boolean>` ::
1212 Ignore locks - only root is allowed to use this option.
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>]` ::
1216 Specify SMBIOS type 1 fields.
1218 `--smp` `<integer> (1 - N)` ('default =' `1`)::
1220 The number of CPUs. Please use option -sockets instead.
1222 `--sockets` `<integer> (1 - N)` ('default =' `1`)::
1224 The number of CPU sockets.
1226 `--spice_enhancements` `[foldersharing=<1|0>] [,videostreaming=<off|all|filter>]` ::
1228 Configure additional enhancements for SPICE.
1230 `--sshkeys` `<filepath>` ::
1232 cloud-init: Setup public SSH keys (one key per line, OpenSSH format).
1234 `--startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
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'.
1238 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
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.
1242 `--tablet` `<boolean>` ('default =' `1`)::
1244 Enable/disable the USB tablet device.
1246 `--tags` `<string>` ::
1248 Tags of the VM. This is only meta information.
1250 `--tdf` `<boolean>` ('default =' `0`)::
1252 Enable/disable time drift fix.
1254 `--template` `<boolean>` ('default =' `0`)::
1256 Enable/disable Template.
1258 `--tpmstate0` `[file=]<volume> [,import-from=<source volume>] [,size=<DiskSize>] [,version=<v1.2|v2.0>]` ::
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.
1262 `--unused[n]` `[file=]<volume>` ::
1264 Reference to unused volumes. This is used internally, and should not be modified manually.
1266 `--usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
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).
1270 `--vcpus` `<integer> (1 - N)` ('default =' `0`)::
1272 Number of hotplugged vcpus.
1274 `--vga` `[[type=]<enum>] [,memory=<integer>]` ::
1276 Configure the VGA hardware.
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>]` ::
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.
1282 `--vmgenid` `<UUID>` ('default =' `1 (autogenerated)`)::
1284 Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly.
1286 `--vmstatestorage` `<string>` ::
1288 Default storage for VM state volumes/files.
1290 `--watchdog` `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::
1292 Create a virtual hardware watchdog device.
1294 *qm showcmd* `<vmid>` `[OPTIONS]`
1296 Show command line which is used to start the VM (debug info).
1298 `<vmid>`: `<integer> (1 - N)` ::
1300 The (unique) ID of the VM.
1302 `--pretty` `<boolean>` ('default =' `0`)::
1304 Puts each option on a new line to enhance human readability
1306 `--snapshot` `<string>` ::
1308 Fetch config values from given snapshot.
1310 *qm shutdown* `<vmid>` `[OPTIONS]`
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.
1316 `<vmid>`: `<integer> (1 - N)` ::
1318 The (unique) ID of the VM.
1320 `--forceStop` `<boolean>` ('default =' `0`)::
1322 Make sure the VM stops.
1324 `--keepActive` `<boolean>` ('default =' `0`)::
1326 Do not deactivate storage volumes.
1328 `--skiplock` `<boolean>` ::
1330 Ignore locks - only root is allowed to use this option.
1332 `--timeout` `<integer> (0 - N)` ::
1334 Wait maximal timeout seconds.
1336 *qm snapshot* `<vmid> <snapname>` `[OPTIONS]`
1340 `<vmid>`: `<integer> (1 - N)` ::
1342 The (unique) ID of the VM.
1344 `<snapname>`: `<string>` ::
1346 The name of the snapshot.
1348 `--description` `<string>` ::
1350 A textual description or comment.
1352 `--vmstate` `<boolean>` ::
1356 *qm start* `<vmid>` `[OPTIONS]`
1358 Start virtual machine.
1360 `<vmid>`: `<integer> (1 - N)` ::
1362 The (unique) ID of the VM.
1364 `--force-cpu` `<string>` ::
1366 Override QEMU's -cpu argument with the given string.
1368 `--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` ::
1370 Specifies the QEMU machine type.
1372 `--migratedfrom` `<string>` ::
1374 The cluster node name.
1376 `--migration_network` `<string>` ::
1378 CIDR of the (sub) network that is used for migration.
1380 `--migration_type` `<insecure | secure>` ::
1382 Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.
1384 `--skiplock` `<boolean>` ::
1386 Ignore locks - only root is allowed to use this option.
1388 `--stateuri` `<string>` ::
1390 Some command save/restore state from this location.
1392 `--targetstorage` `<string>` ::
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.
1396 `--timeout` `<integer> (0 - N)` ('default =' `max(30, vm memory in GiB)`)::
1398 Wait maximal timeout seconds.
1400 *qm status* `<vmid>` `[OPTIONS]`
1404 `<vmid>`: `<integer> (1 - N)` ::
1406 The (unique) ID of the VM.
1408 `--verbose` `<boolean>` ::
1410 Verbose output format
1412 *qm stop* `<vmid>` `[OPTIONS]`
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
1417 `<vmid>`: `<integer> (1 - N)` ::
1419 The (unique) ID of the VM.
1421 `--keepActive` `<boolean>` ('default =' `0`)::
1423 Do not deactivate storage volumes.
1425 `--migratedfrom` `<string>` ::
1427 The cluster node name.
1429 `--skiplock` `<boolean>` ::
1431 Ignore locks - only root is allowed to use this option.
1433 `--timeout` `<integer> (0 - N)` ::
1435 Wait maximal timeout seconds.
1437 *qm suspend* `<vmid>` `[OPTIONS]`
1439 Suspend virtual machine.
1441 `<vmid>`: `<integer> (1 - N)` ::
1443 The (unique) ID of the VM.
1445 `--skiplock` `<boolean>` ::
1447 Ignore locks - only root is allowed to use this option.
1449 `--statestorage` `<string>` ::
1451 The storage for the VM state
1453 NOTE: Requires option(s): `todisk`
1455 `--todisk` `<boolean>` ('default =' `0`)::
1457 If set, suspends the VM to disk. Will be resumed on next VM start.
1459 *qm template* `<vmid>` `[OPTIONS]`
1463 `<vmid>`: `<integer> (1 - N)` ::
1465 The (unique) ID of the VM.
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>` ::
1469 If you want to convert only 1 disk to base image.
1471 *qm terminal* `<vmid>` `[OPTIONS]`
1473 Open a terminal using a serial device (The VM need to have a serial device
1474 configured, for example 'serial0: socket')
1476 `<vmid>`: `<integer> (1 - N)` ::
1478 The (unique) ID of the VM.
1480 `--escape` `<string>` ('default =' `^O`)::
1484 `--iface` `<serial0 | serial1 | serial2 | serial3>` ::
1486 Select the serial device. By default we simply use the first suitable device.
1490 An alias for 'qm disk unlink'.
1492 *qm unlock* `<vmid>`
1496 `<vmid>`: `<integer> (1 - N)` ::
1498 The (unique) ID of the VM.
1500 *qm vncproxy* `<vmid>`
1502 Proxy VM VNC traffic to stdin/stdout
1504 `<vmid>`: `<integer> (1 - N)` ::
1506 The (unique) ID of the VM.
1508 *qm wait* `<vmid>` `[OPTIONS]`
1510 Wait until the VM is stopped.
1512 `<vmid>`: `<integer> (1 - N)` ::
1514 The (unique) ID of the VM.
1516 `--timeout` `<integer> (1 - N)` ::
1518 Timeout in seconds. Default is to wait forever.