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.
134 `--agent` `[enabled=]<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 MB. 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 MB. 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.
845 An alias for 'qm disk rescan'.
847 *qm reset* `<vmid>` `[OPTIONS]`
849 Reset virtual machine.
851 `<vmid>`: `<integer> (1 - N)` ::
853 The (unique) ID of the VM.
855 `--skiplock` `<boolean>` ::
857 Ignore locks - only root is allowed to use this option.
861 An alias for 'qm disk resize'.
863 *qm resume* `<vmid>` `[OPTIONS]`
865 Resume virtual machine.
867 `<vmid>`: `<integer> (1 - N)` ::
869 The (unique) ID of the VM.
871 `--nocheck` `<boolean>` ::
873 no description available
875 `--skiplock` `<boolean>` ::
877 Ignore locks - only root is allowed to use this option.
879 *qm rollback* `<vmid> <snapname>` `[OPTIONS]`
881 Rollback VM state to specified snapshot.
883 `<vmid>`: `<integer> (1 - N)` ::
885 The (unique) ID of the VM.
887 `<snapname>`: `<string>` ::
889 The name of the snapshot.
891 `--start` `<boolean>` ('default =' `0`)::
893 Whether the VM should get started after rolling back successfully
895 *qm sendkey* `<vmid> <key>` `[OPTIONS]`
897 Send key event to virtual machine.
899 `<vmid>`: `<integer> (1 - N)` ::
901 The (unique) ID of the VM.
903 `<key>`: `<string>` ::
905 The key (qemu monitor encoding).
907 `--skiplock` `<boolean>` ::
909 Ignore locks - only root is allowed to use this option.
911 *qm set* `<vmid>` `[OPTIONS]`
913 Set virtual machine options (synchrounous API) - You should consider using
914 the POST method instead for any actions involving hotplug or storage
917 `<vmid>`: `<integer> (1 - N)` ::
919 The (unique) ID of the VM.
921 `--acpi` `<boolean>` ('default =' `1`)::
925 `--affinity` `<string>` ::
927 List of host cores used to execute guest processes.
929 `--agent` `[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>] [,type=<virtio|isa>]` ::
931 Enable/disable communication with the Qemu Guest Agent and its properties.
933 `--arch` `<aarch64 | x86_64>` ::
935 Virtual processor architecture. Defaults to the host.
937 `--args` `<string>` ::
939 Arbitrary arguments passed to kvm.
941 `--audio0` `device=<ich9-intel-hda|intel-hda|AC97> [,driver=<spice|none>]` ::
943 Configure a audio device, useful in combination with QXL/Spice.
945 `--autostart` `<boolean>` ('default =' `0`)::
947 Automatic restart after crash (currently ignored).
949 `--balloon` `<integer> (0 - N)` ::
951 Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
953 `--bios` `<ovmf | seabios>` ('default =' `seabios`)::
955 Select BIOS implementation.
957 `--boot` `[[legacy=]<[acdn]{1,4}>] [,order=<device[;device...]>]` ::
959 Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated.
961 `--bootdisk` `(ide|sata|scsi|virtio)\d+` ::
963 Enable booting from specified disk. Deprecated: Use 'boot: order=foo;bar' instead.
965 `--cdrom` `<volume>` ::
967 This is an alias for option -ide2
969 `--cicustom` `[meta=<volume>] [,network=<volume>] [,user=<volume>] [,vendor=<volume>]` ::
971 cloud-init: Specify custom files to replace the automatically generated ones at start.
973 `--cipassword` `<password>` ::
975 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.
977 `--citype` `<configdrive2 | nocloud | opennebula>` ::
979 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.
981 `--ciuser` `<string>` ::
983 cloud-init: User name to change ssh keys and password for instead of the image's configured default user.
985 `--cores` `<integer> (1 - N)` ('default =' `1`)::
987 The number of cores per socket.
989 `--cpu` `[[cputype=]<string>] [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=<vendor-id>] [,phys-bits=<8-64|host>] [,reported-model=<enum>]` ::
993 `--cpulimit` `<number> (0 - 128)` ('default =' `0`)::
997 `--cpuunits` `<integer> (1 - 262144)` ('default =' `cgroup v1: 1024, cgroup v2: 100`)::
999 CPU weight for a VM, will be clamped to [1, 10000] in cgroup v2.
1001 `--delete` `<string>` ::
1003 A list of settings you want to delete.
1005 `--description` `<string>` ::
1007 Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file.
1009 `--digest` `<string>` ::
1011 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
1013 `--efidisk0` `[file=]<volume> [,efitype=<2m|4m>] [,format=<enum>] [,import-from=<source volume>] [,pre-enrolled-keys=<1|0>] [,size=<DiskSize>]` ::
1015 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.
1017 `--force` `<boolean>` ::
1019 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.
1021 NOTE: Requires option(s): `delete`
1023 `--freeze` `<boolean>` ::
1025 Freeze CPU at startup (use 'c' monitor command to start execution).
1027 `--hookscript` `<string>` ::
1029 Script that will be executed during various steps in the vms lifetime.
1031 `--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>]` ::
1033 Map host PCI devices into guest.
1035 `--hotplug` `<string>` ('default =' `network,disk,usb`)::
1037 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.
1039 `--hugepages` `<1024 | 2 | any>` ::
1041 Enable/disable hugepages memory.
1043 `--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>]` ::
1045 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.
1047 `--ipconfig[n]` `[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]` ::
1049 cloud-init: Specify IP addresses and gateways for the corresponding interface.
1051 IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.
1053 The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit
1054 gateway should be provided.
1055 For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires
1056 cloud-init 19.4 or newer.
1058 If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using
1061 `--ivshmem` `size=<integer> [,name=<string>]` ::
1063 Inter-VM shared memory. Useful for direct communication between VMs, or to the host.
1065 `--keephugepages` `<boolean>` ('default =' `0`)::
1067 Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts.
1069 `--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>` ::
1071 Keyboard layout for VNC server. This option is generally not required and is often better handled from within the guest OS.
1073 `--kvm` `<boolean>` ('default =' `1`)::
1075 Enable/disable KVM hardware virtualization.
1077 `--localtime` `<boolean>` ::
1079 Set the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS.
1081 `--lock` `<backup | clone | create | migrate | rollback | snapshot | snapshot-delete | suspended | suspending>` ::
1085 `--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` ::
1087 Specifies the Qemu machine type.
1089 `--memory` `<integer> (16 - N)` ('default =' `512`)::
1091 Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
1093 `--migrate_downtime` `<number> (0 - N)` ('default =' `0.1`)::
1095 Set maximum tolerated downtime (in seconds) for migrations.
1097 `--migrate_speed` `<integer> (0 - N)` ('default =' `0`)::
1099 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
1101 `--name` `<string>` ::
1103 Set a name for the VM. Only used on the configuration web interface.
1105 `--nameserver` `<string>` ::
1107 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.
1109 `--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>]` ::
1111 Specify network devices.
1113 `--numa` `<boolean>` ('default =' `0`)::
1115 Enable/disable NUMA.
1117 `--numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
1121 `--onboot` `<boolean>` ('default =' `0`)::
1123 Specifies whether a VM will be started during system bootup.
1125 `--ostype` `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win11 | win7 | win8 | wvista | wxp>` ::
1127 Specify guest operating system.
1129 `--parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` ::
1131 Map host parallel devices (n is 0 to 2).
1133 `--protection` `<boolean>` ('default =' `0`)::
1135 Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
1137 `--reboot` `<boolean>` ('default =' `1`)::
1139 Allow reboot. If set to '0' the VM exit on reboot.
1141 `--revert` `<string>` ::
1143 Revert a pending change.
1145 `--rng0` `[source=]</dev/urandom|/dev/random|/dev/hwrng> [,max_bytes=<integer>] [,period=<integer>]` ::
1147 Configure a VirtIO-based Random Number Generator.
1149 `--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>]` ::
1151 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.
1153 `--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>]` ::
1155 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.
1157 `--scsihw` `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
1159 SCSI controller model
1161 `--searchdomain` `<string>` ::
1163 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.
1165 `--serial[n]` `(/dev/.+|socket)` ::
1167 Create a serial device inside the VM (n is 0 to 3)
1169 `--shares` `<integer> (0 - 50000)` ('default =' `1000`)::
1171 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.
1173 `--skiplock` `<boolean>` ::
1175 Ignore locks - only root is allowed to use this option.
1177 `--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>]` ::
1179 Specify SMBIOS type 1 fields.
1181 `--smp` `<integer> (1 - N)` ('default =' `1`)::
1183 The number of CPUs. Please use option -sockets instead.
1185 `--sockets` `<integer> (1 - N)` ('default =' `1`)::
1187 The number of CPU sockets.
1189 `--spice_enhancements` `[foldersharing=<1|0>] [,videostreaming=<off|all|filter>]` ::
1191 Configure additional enhancements for SPICE.
1193 `--sshkeys` `<filepath>` ::
1195 cloud-init: Setup public SSH keys (one key per line, OpenSSH format).
1197 `--startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
1199 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'.
1201 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
1203 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.
1205 `--tablet` `<boolean>` ('default =' `1`)::
1207 Enable/disable the USB tablet device.
1209 `--tags` `<string>` ::
1211 Tags of the VM. This is only meta information.
1213 `--tdf` `<boolean>` ('default =' `0`)::
1215 Enable/disable time drift fix.
1217 `--template` `<boolean>` ('default =' `0`)::
1219 Enable/disable Template.
1221 `--tpmstate0` `[file=]<volume> [,import-from=<source volume>] [,size=<DiskSize>] [,version=<v1.2|v2.0>]` ::
1223 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.
1225 `--unused[n]` `[file=]<volume>` ::
1227 Reference to unused volumes. This is used internally, and should not be modified manually.
1229 `--usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
1231 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).
1233 `--vcpus` `<integer> (1 - N)` ('default =' `0`)::
1235 Number of hotplugged vcpus.
1237 `--vga` `[[type=]<enum>] [,memory=<integer>]` ::
1239 Configure the VGA hardware.
1241 `--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>]` ::
1243 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.
1245 `--vmgenid` `<UUID>` ('default =' `1 (autogenerated)`)::
1247 Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly.
1249 `--vmstatestorage` `<string>` ::
1251 Default storage for VM state volumes/files.
1253 `--watchdog` `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::
1255 Create a virtual hardware watchdog device.
1257 *qm showcmd* `<vmid>` `[OPTIONS]`
1259 Show command line which is used to start the VM (debug info).
1261 `<vmid>`: `<integer> (1 - N)` ::
1263 The (unique) ID of the VM.
1265 `--pretty` `<boolean>` ('default =' `0`)::
1267 Puts each option on a new line to enhance human readability
1269 `--snapshot` `<string>` ::
1271 Fetch config values from given snapshot.
1273 *qm shutdown* `<vmid>` `[OPTIONS]`
1275 Shutdown virtual machine. This is similar to pressing the power button on a
1276 physical machine.This will send an ACPI event for the guest OS, which
1277 should then proceed to a clean shutdown.
1279 `<vmid>`: `<integer> (1 - N)` ::
1281 The (unique) ID of the VM.
1283 `--forceStop` `<boolean>` ('default =' `0`)::
1285 Make sure the VM stops.
1287 `--keepActive` `<boolean>` ('default =' `0`)::
1289 Do not deactivate storage volumes.
1291 `--skiplock` `<boolean>` ::
1293 Ignore locks - only root is allowed to use this option.
1295 `--timeout` `<integer> (0 - N)` ::
1297 Wait maximal timeout seconds.
1299 *qm snapshot* `<vmid> <snapname>` `[OPTIONS]`
1303 `<vmid>`: `<integer> (1 - N)` ::
1305 The (unique) ID of the VM.
1307 `<snapname>`: `<string>` ::
1309 The name of the snapshot.
1311 `--description` `<string>` ::
1313 A textual description or comment.
1315 `--vmstate` `<boolean>` ::
1319 *qm start* `<vmid>` `[OPTIONS]`
1321 Start virtual machine.
1323 `<vmid>`: `<integer> (1 - N)` ::
1325 The (unique) ID of the VM.
1327 `--force-cpu` `<string>` ::
1329 Override QEMU's -cpu argument with the given string.
1331 `--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` ::
1333 Specifies the Qemu machine type.
1335 `--migratedfrom` `<string>` ::
1337 The cluster node name.
1339 `--migration_network` `<string>` ::
1341 CIDR of the (sub) network that is used for migration.
1343 `--migration_type` `<insecure | secure>` ::
1345 Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.
1347 `--skiplock` `<boolean>` ::
1349 Ignore locks - only root is allowed to use this option.
1351 `--stateuri` `<string>` ::
1353 Some command save/restore state from this location.
1355 `--targetstorage` `<string>` ::
1357 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.
1359 `--timeout` `<integer> (0 - N)` ('default =' `max(30, vm memory in GiB)`)::
1361 Wait maximal timeout seconds.
1363 *qm status* `<vmid>` `[OPTIONS]`
1367 `<vmid>`: `<integer> (1 - N)` ::
1369 The (unique) ID of the VM.
1371 `--verbose` `<boolean>` ::
1373 Verbose output format
1375 *qm stop* `<vmid>` `[OPTIONS]`
1377 Stop virtual machine. The qemu process will exit immediately. Thisis akin
1378 to pulling the power plug of a running computer and may damage the VM data
1380 `<vmid>`: `<integer> (1 - N)` ::
1382 The (unique) ID of the VM.
1384 `--keepActive` `<boolean>` ('default =' `0`)::
1386 Do not deactivate storage volumes.
1388 `--migratedfrom` `<string>` ::
1390 The cluster node name.
1392 `--skiplock` `<boolean>` ::
1394 Ignore locks - only root is allowed to use this option.
1396 `--timeout` `<integer> (0 - N)` ::
1398 Wait maximal timeout seconds.
1400 *qm suspend* `<vmid>` `[OPTIONS]`
1402 Suspend virtual machine.
1404 `<vmid>`: `<integer> (1 - N)` ::
1406 The (unique) ID of the VM.
1408 `--skiplock` `<boolean>` ::
1410 Ignore locks - only root is allowed to use this option.
1412 `--statestorage` `<string>` ::
1414 The storage for the VM state
1416 NOTE: Requires option(s): `todisk`
1418 `--todisk` `<boolean>` ('default =' `0`)::
1420 If set, suspends the VM to disk. Will be resumed on next VM start.
1422 *qm template* `<vmid>` `[OPTIONS]`
1426 `<vmid>`: `<integer> (1 - N)` ::
1428 The (unique) ID of the VM.
1430 `--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>` ::
1432 If you want to convert only 1 disk to base image.
1434 *qm terminal* `<vmid>` `[OPTIONS]`
1436 Open a terminal using a serial device (The VM need to have a serial device
1437 configured, for example 'serial0: socket')
1439 `<vmid>`: `<integer> (1 - N)` ::
1441 The (unique) ID of the VM.
1443 `--escape` `<string>` ('default =' `^O`)::
1447 `--iface` `<serial0 | serial1 | serial2 | serial3>` ::
1449 Select the serial device. By default we simply use the first suitable device.
1453 An alias for 'qm disk unlink'.
1455 *qm unlock* `<vmid>`
1459 `<vmid>`: `<integer> (1 - N)` ::
1461 The (unique) ID of the VM.
1463 *qm vncproxy* `<vmid>`
1465 Proxy VM VNC traffic to stdin/stdout
1467 `<vmid>`: `<integer> (1 - N)` ::
1469 The (unique) ID of the VM.
1471 *qm wait* `<vmid>` `[OPTIONS]`
1473 Wait until the VM is stopped.
1475 `<vmid>`: `<integer> (1 - N)` ::
1477 The (unique) ID of the VM.
1479 `--timeout` `<integer> (1 - N)` ::
1481 Timeout in seconds. Default is to wait forever.