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> (100 - 999999999)` ::
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> (100 - 999999999)` ::
30 The (unique) ID of the VM.
32 `<newid>`: `<integer> (100 - 999999999)` ::
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> (100 - 999999999)` ::
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> (100 - 999999999)` ::
90 The (unique) ID of the VM.
92 *qm cloudinit update* `<vmid>`
94 Regenerate and change cloudinit config drive.
96 `<vmid>`: `<integer> (100 - 999999999)` ::
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> (100 - 999999999)` ::
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> (100 - 999999999)` ::
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 `--ciupgrade` `<boolean>` ('default =' `1`)::
196 cloud-init: do an automatic package upgrade after the first boot.
198 `--ciuser` `<string>` ::
200 cloud-init: User name to change ssh keys and password for instead of the image's configured default user.
202 `--cores` `<integer> (1 - N)` ('default =' `1`)::
204 The number of cores per socket.
206 `--cpu` `[[cputype=]<string>] [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=<vendor-id>] [,phys-bits=<8-64|host>] [,reported-model=<enum>]` ::
210 `--cpulimit` `<number> (0 - 128)` ('default =' `0`)::
214 `--cpuunits` `<integer> (1 - 262144)` ('default =' `cgroup v1: 1024, cgroup v2: 100`)::
216 CPU weight for a VM, will be clamped to [1, 10000] in cgroup v2.
218 `--description` `<string>` ::
220 Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file.
222 `--efidisk0` `[file=]<volume> [,efitype=<2m|4m>] [,format=<enum>] [,import-from=<source volume>] [,pre-enrolled-keys=<1|0>] [,size=<DiskSize>]` ::
224 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.
226 `--force` `<boolean>` ::
228 Allow to overwrite existing VM.
230 NOTE: Requires option(s): `archive`
232 `--freeze` `<boolean>` ::
234 Freeze CPU at startup (use 'c' monitor command to start execution).
236 `--hookscript` `<string>` ::
238 Script that will be executed during various steps in the vms lifetime.
240 `--hostpci[n]` `[[host=]<HOSTPCIID[;HOSTPCIID2...]>] [,device-id=<hex id>] [,legacy-igd=<1|0>] [,mapping=<mapping-id>] [,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>]` ::
242 Map host PCI devices into guest.
244 `--hotplug` `<string>` ('default =' `network,disk,usb`)::
246 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.
248 `--hugepages` `<1024 | 2 | any>` ::
250 Enable/disable hugepages memory.
252 `--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>]` ::
254 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.
256 `--ipconfig[n]` `[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]` ::
258 cloud-init: Specify IP addresses and gateways for the corresponding interface.
260 IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.
262 The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit
263 gateway should be provided.
264 For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires
265 cloud-init 19.4 or newer.
267 If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using
270 `--ivshmem` `size=<integer> [,name=<string>]` ::
272 Inter-VM shared memory. Useful for direct communication between VMs, or to the host.
274 `--keephugepages` `<boolean>` ('default =' `0`)::
276 Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts.
278 `--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>` ::
280 Keyboard layout for VNC server. This option is generally not required and is often better handled from within the guest OS.
282 `--kvm` `<boolean>` ('default =' `1`)::
284 Enable/disable KVM hardware virtualization.
286 `--live-restore` `<boolean>` ::
288 Start the VM immediately while importing or restoring in the background.
290 `--localtime` `<boolean>` ::
292 Set the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS.
294 `--lock` `<backup | clone | create | migrate | rollback | snapshot | snapshot-delete | suspended | suspending>` ::
298 `--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` ::
300 Specifies the QEMU machine type.
302 `--memory` `[current=]<integer>` ::
306 `--migrate_downtime` `<number> (0 - N)` ('default =' `0.1`)::
308 Set maximum tolerated downtime (in seconds) for migrations.
310 `--migrate_speed` `<integer> (0 - N)` ('default =' `0`)::
312 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
314 `--name` `<string>` ::
316 Set a name for the VM. Only used on the configuration web interface.
318 `--nameserver` `<string>` ::
320 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.
322 `--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>]` ::
324 Specify network devices.
326 `--numa` `<boolean>` ('default =' `0`)::
330 `--numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
334 `--onboot` `<boolean>` ('default =' `0`)::
336 Specifies whether a VM will be started during system bootup.
338 `--ostype` `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win11 | win7 | win8 | wvista | wxp>` ::
340 Specify guest operating system.
342 `--parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` ::
344 Map host parallel devices (n is 0 to 2).
346 `--pool` `<string>` ::
348 Add the VM to the specified pool.
350 `--protection` `<boolean>` ('default =' `0`)::
352 Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
354 `--reboot` `<boolean>` ('default =' `1`)::
356 Allow reboot. If set to '0' the VM exit on reboot.
358 `--rng0` `[source=]</dev/urandom|/dev/random|/dev/hwrng> [,max_bytes=<integer>] [,period=<integer>]` ::
360 Configure a VirtIO-based Random Number Generator.
362 `--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>]` ::
364 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.
366 `--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>] [,product=<product>] [,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>] [,vendor=<vendor>] [,werror=<enum>] [,wwn=<wwn>]` ::
368 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.
370 `--scsihw` `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
372 SCSI controller model
374 `--searchdomain` `<string>` ::
376 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.
378 `--serial[n]` `(/dev/.+|socket)` ::
380 Create a serial device inside the VM (n is 0 to 3)
382 `--shares` `<integer> (0 - 50000)` ('default =' `1000`)::
384 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.
386 `--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>]` ::
388 Specify SMBIOS type 1 fields.
390 `--smp` `<integer> (1 - N)` ('default =' `1`)::
392 The number of CPUs. Please use option -sockets instead.
394 `--sockets` `<integer> (1 - N)` ('default =' `1`)::
396 The number of CPU sockets.
398 `--spice_enhancements` `[foldersharing=<1|0>] [,videostreaming=<off|all|filter>]` ::
400 Configure additional enhancements for SPICE.
402 `--sshkeys` `<filepath>` ::
404 cloud-init: Setup public SSH keys (one key per line, OpenSSH format).
406 `--start` `<boolean>` ('default =' `0`)::
408 Start VM after it was created successfully.
410 `--startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
412 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'.
414 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
416 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.
418 `--storage` `<string>` ::
422 `--tablet` `<boolean>` ('default =' `1`)::
424 Enable/disable the USB tablet device.
426 `--tags` `<string>` ::
428 Tags of the VM. This is only meta information.
430 `--tdf` `<boolean>` ('default =' `0`)::
432 Enable/disable time drift fix.
434 `--template` `<boolean>` ('default =' `0`)::
436 Enable/disable Template.
438 `--tpmstate0` `[file=]<volume> [,import-from=<source volume>] [,size=<DiskSize>] [,version=<v1.2|v2.0>]` ::
440 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.
442 `--unique` `<boolean>` ::
444 Assign a unique random ethernet address.
446 NOTE: Requires option(s): `archive`
448 `--unused[n]` `[file=]<volume>` ::
450 Reference to unused volumes. This is used internally, and should not be modified manually.
452 `--usb[n]` `[[host=]<HOSTUSBDEVICE|spice>] [,mapping=<mapping-id>] [,usb3=<1|0>]` ::
454 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).
456 `--vcpus` `<integer> (1 - N)` ('default =' `0`)::
458 Number of hotplugged vcpus.
460 `--vga` `[[type=]<enum>] [,clipboard=<vnc>] [,memory=<integer>]` ::
462 Configure the VGA hardware.
464 `--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>]` ::
466 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.
468 `--vmgenid` `<UUID>` ('default =' `1 (autogenerated)`)::
470 Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly.
472 `--vmstatestorage` `<string>` ::
474 Default storage for VM state volumes/files.
476 `--watchdog` `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::
478 Create a virtual hardware watchdog device.
480 *qm delsnapshot* `<vmid> <snapname>` `[OPTIONS]`
482 Delete a VM snapshot.
484 `<vmid>`: `<integer> (100 - 999999999)` ::
486 The (unique) ID of the VM.
488 `<snapname>`: `<string>` ::
490 The name of the snapshot.
492 `--force` `<boolean>` ::
494 For removal from config file, even if removing disk snapshots fails.
496 *qm destroy* `<vmid>` `[OPTIONS]`
498 Destroy the VM and all used/owned volumes. Removes any VM specific
499 permissions and firewall rules
501 `<vmid>`: `<integer> (100 - 999999999)` ::
503 The (unique) ID of the VM.
505 `--destroy-unreferenced-disks` `<boolean>` ('default =' `0`)::
507 If set, destroy additionally all disks not referenced in the config but with a matching VMID from all enabled storages.
509 `--purge` `<boolean>` ::
511 Remove VMID from configurations, like backup & replication jobs and HA.
513 `--skiplock` `<boolean>` ::
515 Ignore locks - only root is allowed to use this option.
517 *qm disk import* `<vmid> <source> <storage>` `[OPTIONS]`
519 Import an external disk image as an unused disk in a VM. The
520 image format has to be supported by qemu-img(1).
522 `<vmid>`: `<integer> (100 - 999999999)` ::
524 The (unique) ID of the VM.
526 `<source>`: `<string>` ::
528 Path to the disk image to import
530 `<storage>`: `<string>` ::
534 `--format` `<qcow2 | raw | vmdk>` ::
538 *qm disk move* `<vmid> <disk> [<storage>]` `[OPTIONS]`
540 Move volume to different storage or to a different VM.
542 `<vmid>`: `<integer> (100 - 999999999)` ::
544 The (unique) ID of the VM.
546 `<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>` ::
548 The disk you want to move.
550 `<storage>`: `<string>` ::
554 `--bwlimit` `<integer> (0 - N)` ('default =' `move limit from datacenter or storage config`)::
556 Override I/O bandwidth limit (in KiB/s).
558 `--delete` `<boolean>` ('default =' `0`)::
560 Delete the original disk after successful copy. By default the original disk is kept as unused disk.
562 `--digest` `<string>` ::
564 Prevent changes if current configuration file has different SHA1"
565 ." digest. This can be used to prevent concurrent modifications.
567 `--format` `<qcow2 | raw | vmdk>` ::
571 `--target-digest` `<string>` ::
573 Prevent changes if the current config file of the target VM has a"
574 ." different SHA1 digest. This can be used to detect concurrent modifications.
576 `--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>` ::
578 The config key the disk will be moved to on the target VM (for example, ide0 or scsi1). Default is the source disk key.
580 `--target-vmid` `<integer> (100 - 999999999)` ::
582 The (unique) ID of the VM.
584 *qm disk rescan* `[OPTIONS]`
586 Rescan all storages and update disk sizes and unused disk images.
588 `--dryrun` `<boolean>` ('default =' `0`)::
590 Do not actually write changes out to VM config(s).
592 `--vmid` `<integer> (100 - 999999999)` ::
594 The (unique) ID of the VM.
596 *qm disk resize* `<vmid> <disk> <size>` `[OPTIONS]`
600 `<vmid>`: `<integer> (100 - 999999999)` ::
602 The (unique) ID of the VM.
604 `<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>` ::
606 The disk you want to resize.
608 `<size>`: `\+?\d+(\.\d+)?[KMGT]?` ::
610 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.
612 `--digest` `<string>` ::
614 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
616 `--skiplock` `<boolean>` ::
618 Ignore locks - only root is allowed to use this option.
620 *qm disk unlink* `<vmid> --idlist <string>` `[OPTIONS]`
622 Unlink/delete disk images.
624 `<vmid>`: `<integer> (100 - 999999999)` ::
626 The (unique) ID of the VM.
628 `--force` `<boolean>` ::
630 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.
632 `--idlist` `<string>` ::
634 A list of disk IDs you want to delete.
636 *qm guest cmd* `<vmid> <command>`
638 Execute QEMU Guest Agent commands.
640 `<vmid>`: `<integer> (100 - 999999999)` ::
642 The (unique) ID of the VM.
644 `<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>` ::
648 *qm guest exec* `<vmid> [<extra-args>]` `[OPTIONS]`
650 Executes the given command via the guest agent
652 `<vmid>`: `<integer> (100 - 999999999)` ::
654 The (unique) ID of the VM.
656 `<extra-args>`: `<array>` ::
658 Extra arguments as array
660 `--pass-stdin` `<boolean>` ('default =' `0`)::
662 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.
664 `--synchronous` `<boolean>` ('default =' `1`)::
666 If set to off, returns the pid immediately instead of waiting for the commmand to finish or the timeout.
668 `--timeout` `<integer> (0 - N)` ('default =' `30`)::
670 The maximum time to wait synchronously for the command to finish. If reached, the pid gets returned. Set to 0 to deactivate
672 *qm guest exec-status* `<vmid> <pid>`
674 Gets the status of the given pid started by the guest-agent
676 `<vmid>`: `<integer> (100 - 999999999)` ::
678 The (unique) ID of the VM.
680 `<pid>`: `<integer>` ::
684 *qm guest passwd* `<vmid> <username>` `[OPTIONS]`
686 Sets the password for the given user to the given password
688 `<vmid>`: `<integer> (100 - 999999999)` ::
690 The (unique) ID of the VM.
692 `<username>`: `<string>` ::
694 The user to set the password for.
696 `--crypted` `<boolean>` ('default =' `0`)::
698 set to 1 if the password has already been passed through crypt()
700 *qm help* `[OPTIONS]`
702 Get help about specified command.
704 `--extra-args` `<array>` ::
706 Shows help for a specific command
708 `--verbose` `<boolean>` ::
710 Verbose output format.
712 *qm import* `<vmid> <source> --storage <string>` `[OPTIONS]`
714 Import a foreign virtual guest from a supported import source, such as an
717 `<vmid>`: `<integer> (100 - 999999999)` ::
719 The (unique) ID of the VM.
721 `<source>`: `<string>` ::
723 The import source volume id.
725 `--acpi` `<boolean>` ('default =' `1`)::
729 `--affinity` `<string>` ::
731 List of host cores used to execute guest processes, for example: 0,5,8-11
733 `--agent` `[enabled=]<1|0> [,freeze-fs-on-backup=<1|0>] [,fstrim_cloned_disks=<1|0>] [,type=<virtio|isa>]` ::
735 Enable/disable communication with the QEMU Guest Agent and its properties.
737 `--arch` `<aarch64 | x86_64>` ::
739 Virtual processor architecture. Defaults to the host.
741 `--args` `<string>` ::
743 Arbitrary arguments passed to kvm.
745 `--audio0` `device=<ich9-intel-hda|intel-hda|AC97> [,driver=<spice|none>]` ::
747 Configure a audio device, useful in combination with QXL/Spice.
749 `--autostart` `<boolean>` ('default =' `0`)::
751 Automatic restart after crash (currently ignored).
753 `--balloon` `<integer> (0 - N)` ::
755 Amount of target RAM for the VM in MiB. Using zero disables the ballon driver.
757 `--bios` `<ovmf | seabios>` ('default =' `seabios`)::
759 Select BIOS implementation.
761 `--boot` `[[legacy=]<[acdn]{1,4}>] [,order=<device[;device...]>]` ::
763 Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated.
765 `--bootdisk` `(ide|sata|scsi|virtio)\d+` ::
767 Enable booting from specified disk. Deprecated: Use 'boot: order=foo;bar' instead.
769 `--cdrom` `<volume>` ::
771 This is an alias for option -ide2
773 `--cicustom` `[meta=<volume>] [,network=<volume>] [,user=<volume>] [,vendor=<volume>]` ::
775 cloud-init: Specify custom files to replace the automatically generated ones at start.
777 `--cipassword` `<string>` ::
779 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.
781 `--citype` `<configdrive2 | nocloud | opennebula>` ::
783 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.
785 `--ciupgrade` `<boolean>` ('default =' `1`)::
787 cloud-init: do an automatic package upgrade after the first boot.
789 `--ciuser` `<string>` ::
791 cloud-init: User name to change ssh keys and password for instead of the image's configured default user.
793 `--cores` `<integer> (1 - N)` ('default =' `1`)::
795 The number of cores per socket.
797 `--cpu` `[[cputype=]<string>] [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=<vendor-id>] [,phys-bits=<8-64|host>] [,reported-model=<enum>]` ::
801 `--cpulimit` `<number> (0 - 128)` ('default =' `0`)::
805 `--cpuunits` `<integer> (1 - 262144)` ('default =' `cgroup v1: 1024, cgroup v2: 100`)::
807 CPU weight for a VM, will be clamped to [1, 10000] in cgroup v2.
809 `--delete` `<string>` ::
811 A list of settings you want to delete.
813 `--description` `<string>` ::
815 Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file.
817 `--dryrun` `<boolean>` ('default =' `0`)::
819 Show the create command and exit without doing anything.
821 `--efidisk0` `[file=]<volume> [,efitype=<2m|4m>] [,format=<enum>] [,pre-enrolled-keys=<1|0>] [,size=<DiskSize>]` ::
823 Configure a disk for storing EFI vars.
825 `--format` `<qcow2 | raw | vmdk>` ::
829 `--freeze` `<boolean>` ::
831 Freeze CPU at startup (use 'c' monitor command to start execution).
833 `--hookscript` `<string>` ::
835 Script that will be executed during various steps in the vms lifetime.
837 `--hostpci[n]` `[[host=]<HOSTPCIID[;HOSTPCIID2...]>] [,device-id=<hex id>] [,legacy-igd=<1|0>] [,mapping=<mapping-id>] [,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>]` ::
839 Map host PCI devices into guest.
841 `--hotplug` `<string>` ('default =' `network,disk,usb`)::
843 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.
845 `--hugepages` `<1024 | 2 | any>` ::
847 Enable/disable hugepages memory.
849 `--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>] [,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>]` ::
851 Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
853 `--ipconfig[n]` `[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]` ::
855 cloud-init: Specify IP addresses and gateways for the corresponding interface.
857 IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.
859 The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit
860 gateway should be provided.
861 For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires
862 cloud-init 19.4 or newer.
864 If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using
867 `--ivshmem` `size=<integer> [,name=<string>]` ::
869 Inter-VM shared memory. Useful for direct communication between VMs, or to the host.
871 `--keephugepages` `<boolean>` ('default =' `0`)::
873 Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts.
875 `--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>` ::
877 Keyboard layout for VNC server. This option is generally not required and is often better handled from within the guest OS.
879 `--kvm` `<boolean>` ('default =' `1`)::
881 Enable/disable KVM hardware virtualization.
883 `--live-import` `<boolean>` ('default =' `0`)::
885 Immediately start the VM and copy the data in the background.
887 `--localtime` `<boolean>` ::
889 Set the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS.
891 `--lock` `<backup | clone | create | migrate | rollback | snapshot | snapshot-delete | suspended | suspending>` ::
895 `--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` ::
897 Specifies the QEMU machine type.
899 `--memory` `[current=]<integer>` ::
903 `--migrate_downtime` `<number> (0 - N)` ('default =' `0.1`)::
905 Set maximum tolerated downtime (in seconds) for migrations.
907 `--migrate_speed` `<integer> (0 - N)` ('default =' `0`)::
909 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
911 `--name` `<string>` ::
913 Set a name for the VM. Only used on the configuration web interface.
915 `--nameserver` `<string>` ::
917 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.
919 `--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>]` ::
921 Specify network devices.
923 `--numa` `<boolean>` ('default =' `0`)::
927 `--numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
931 `--onboot` `<boolean>` ('default =' `0`)::
933 Specifies whether a VM will be started during system bootup.
935 `--ostype` `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win11 | win7 | win8 | wvista | wxp>` ::
937 Specify guest operating system.
939 `--parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` ::
941 Map host parallel devices (n is 0 to 2).
943 `--protection` `<boolean>` ('default =' `0`)::
945 Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
947 `--reboot` `<boolean>` ('default =' `1`)::
949 Allow reboot. If set to '0' the VM exit on reboot.
951 `--rng0` `[source=]</dev/urandom|/dev/random|/dev/hwrng> [,max_bytes=<integer>] [,period=<integer>]` ::
953 Configure a VirtIO-based Random Number Generator.
955 `--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>] [,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>]` ::
957 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
959 `--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>] [,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>] [,product=<product>] [,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>] [,vendor=<vendor>] [,werror=<enum>] [,wwn=<wwn>]` ::
961 Use volume as SCSI hard disk or CD-ROM (n is 0 to 30).
963 `--scsihw` `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
965 SCSI controller model
967 `--searchdomain` `<string>` ::
969 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.
971 `--serial[n]` `(/dev/.+|socket)` ::
973 Create a serial device inside the VM (n is 0 to 3)
975 `--shares` `<integer> (0 - 50000)` ('default =' `1000`)::
977 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.
979 `--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>]` ::
981 Specify SMBIOS type 1 fields.
983 `--smp` `<integer> (1 - N)` ('default =' `1`)::
985 The number of CPUs. Please use option -sockets instead.
987 `--sockets` `<integer> (1 - N)` ('default =' `1`)::
989 The number of CPU sockets.
991 `--spice_enhancements` `[foldersharing=<1|0>] [,videostreaming=<off|all|filter>]` ::
993 Configure additional enhancements for SPICE.
995 `--sshkeys` `<string>` ::
997 cloud-init: Setup public SSH keys (one key per line, OpenSSH format).
999 `--startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
1001 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'.
1003 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
1005 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.
1007 `--storage` `<string>` ::
1011 `--tablet` `<boolean>` ('default =' `1`)::
1013 Enable/disable the USB tablet device.
1015 `--tags` `<string>` ::
1017 Tags of the VM. This is only meta information.
1019 `--tdf` `<boolean>` ('default =' `0`)::
1021 Enable/disable time drift fix.
1023 `--template` `<boolean>` ('default =' `0`)::
1025 Enable/disable Template.
1027 `--tpmstate0` `[file=]<volume> [,size=<DiskSize>] [,version=<v1.2|v2.0>]` ::
1029 Configure a Disk for storing TPM state. The format is fixed to 'raw'.
1031 `--unused[n]` `[file=]<volume>` ::
1033 Reference to unused volumes. This is used internally, and should not be modified manually.
1035 `--usb[n]` `[[host=]<HOSTUSBDEVICE|spice>] [,mapping=<mapping-id>] [,usb3=<1|0>]` ::
1037 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).
1039 `--vcpus` `<integer> (1 - N)` ('default =' `0`)::
1041 Number of hotplugged vcpus.
1043 `--vga` `[[type=]<enum>] [,clipboard=<vnc>] [,memory=<integer>]` ::
1045 Configure the VGA hardware.
1047 `--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>] [,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>]` ::
1049 Use volume as VIRTIO hard disk (n is 0 to 15).
1051 `--vmgenid` `<UUID>` ('default =' `1 (autogenerated)`)::
1053 Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly.
1055 `--vmstatestorage` `<string>` ::
1057 Default storage for VM state volumes/files.
1059 `--watchdog` `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::
1061 Create a virtual hardware watchdog device.
1065 An alias for 'qm disk import'.
1067 *qm importovf* `<vmid> <manifest> <storage>` `[OPTIONS]`
1069 Create a new VM using parameters read from an OVF manifest
1071 `<vmid>`: `<integer> (100 - 999999999)` ::
1073 The (unique) ID of the VM.
1075 `<manifest>`: `<string>` ::
1077 path to the ovf file
1079 `<storage>`: `<string>` ::
1083 `--dryrun` `<boolean>` ::
1085 Print a parsed representation of the extracted OVF parameters, but do not create a VM
1087 `--format` `<qcow2 | raw | vmdk>` ::
1091 *qm list* `[OPTIONS]`
1093 Virtual machine index (per node).
1095 `--full` `<boolean>` ::
1097 Determine the full status of active VMs.
1099 *qm listsnapshot* `<vmid>`
1103 `<vmid>`: `<integer> (100 - 999999999)` ::
1105 The (unique) ID of the VM.
1107 *qm migrate* `<vmid> <target>` `[OPTIONS]`
1109 Migrate virtual machine. Creates a new migration task.
1111 `<vmid>`: `<integer> (100 - 999999999)` ::
1113 The (unique) ID of the VM.
1115 `<target>`: `<string>` ::
1119 `--bwlimit` `<integer> (0 - N)` ('default =' `migrate limit from datacenter or storage config`)::
1121 Override I/O bandwidth limit (in KiB/s).
1123 `--force` `<boolean>` ::
1125 Allow to migrate VMs which use local devices. Only root may use this option.
1127 `--migration_network` `<string>` ::
1129 CIDR of the (sub) network that is used for migration.
1131 `--migration_type` `<insecure | secure>` ::
1133 Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.
1135 `--online` `<boolean>` ::
1137 Use online/live migration if VM is running. Ignored if VM is stopped.
1139 `--targetstorage` `<string>` ::
1141 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.
1143 `--with-local-disks` `<boolean>` ::
1145 Enable live storage migration for local disk
1147 *qm monitor* `<vmid>`
1149 Enter QEMU Monitor interface.
1151 `<vmid>`: `<integer> (100 - 999999999)` ::
1153 The (unique) ID of the VM.
1157 An alias for 'qm disk move'.
1161 An alias for 'qm disk move'.
1165 Used by qmigrate - do not use manually.
1167 *qm nbdstop* `<vmid>`
1169 Stop embedded nbd server.
1171 `<vmid>`: `<integer> (100 - 999999999)` ::
1173 The (unique) ID of the VM.
1175 *qm pending* `<vmid>`
1177 Get the virtual machine configuration with both current and pending values.
1179 `<vmid>`: `<integer> (100 - 999999999)` ::
1181 The (unique) ID of the VM.
1183 *qm reboot* `<vmid>` `[OPTIONS]`
1185 Reboot the VM by shutting it down, and starting it again. Applies pending
1188 `<vmid>`: `<integer> (100 - 999999999)` ::
1190 The (unique) ID of the VM.
1192 `--timeout` `<integer> (0 - N)` ::
1194 Wait maximal timeout seconds for the shutdown.
1196 *qm remote-migrate* `<vmid> [<target-vmid>] <target-endpoint> --target-bridge <string> --target-storage <string>` `[OPTIONS]`
1198 Migrate virtual machine to a remote cluster. Creates a new migration task.
1199 EXPERIMENTAL feature!
1201 `<vmid>`: `<integer> (100 - 999999999)` ::
1203 The (unique) ID of the VM.
1205 `<target-vmid>`: `<integer> (100 - 999999999)` ::
1207 The (unique) ID of the VM.
1209 `<target-endpoint>`: `apitoken=<user@realm!token=SECRET> ,host=<ADDRESS> [,fingerprint=<FINGERPRINT>] [,port=<PORT>]` ::
1211 Remote target endpoint
1213 `--bwlimit` `<integer> (0 - N)` ('default =' `migrate limit from datacenter or storage config`)::
1215 Override I/O bandwidth limit (in KiB/s).
1217 `--delete` `<boolean>` ('default =' `0`)::
1219 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.
1221 `--online` `<boolean>` ::
1223 Use online/live migration if VM is running. Ignored if VM is stopped.
1225 `--target-bridge` `<string>` ::
1227 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.
1229 `--target-storage` `<string>` ::
1231 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.
1235 An alias for 'qm disk rescan'.
1237 *qm reset* `<vmid>` `[OPTIONS]`
1239 Reset virtual machine.
1241 `<vmid>`: `<integer> (100 - 999999999)` ::
1243 The (unique) ID of the VM.
1245 `--skiplock` `<boolean>` ::
1247 Ignore locks - only root is allowed to use this option.
1251 An alias for 'qm disk resize'.
1253 *qm resume* `<vmid>` `[OPTIONS]`
1255 Resume virtual machine.
1257 `<vmid>`: `<integer> (100 - 999999999)` ::
1259 The (unique) ID of the VM.
1261 `--nocheck` `<boolean>` ::
1263 no description available
1265 `--skiplock` `<boolean>` ::
1267 Ignore locks - only root is allowed to use this option.
1269 *qm rollback* `<vmid> <snapname>` `[OPTIONS]`
1271 Rollback VM state to specified snapshot.
1273 `<vmid>`: `<integer> (100 - 999999999)` ::
1275 The (unique) ID of the VM.
1277 `<snapname>`: `<string>` ::
1279 The name of the snapshot.
1281 `--start` `<boolean>` ('default =' `0`)::
1283 Whether the VM should get started after rolling back successfully. (Note: VMs will be automatically started if the snapshot includes RAM.)
1285 *qm sendkey* `<vmid> <key>` `[OPTIONS]`
1287 Send key event to virtual machine.
1289 `<vmid>`: `<integer> (100 - 999999999)` ::
1291 The (unique) ID of the VM.
1293 `<key>`: `<string>` ::
1295 The key (qemu monitor encoding).
1297 `--skiplock` `<boolean>` ::
1299 Ignore locks - only root is allowed to use this option.
1301 *qm set* `<vmid>` `[OPTIONS]`
1303 Set virtual machine options (synchrounous API) - You should consider using
1304 the POST method instead for any actions involving hotplug or storage
1307 `<vmid>`: `<integer> (100 - 999999999)` ::
1309 The (unique) ID of the VM.
1311 `--acpi` `<boolean>` ('default =' `1`)::
1313 Enable/disable ACPI.
1315 `--affinity` `<string>` ::
1317 List of host cores used to execute guest processes, for example: 0,5,8-11
1319 `--agent` `[enabled=]<1|0> [,freeze-fs-on-backup=<1|0>] [,fstrim_cloned_disks=<1|0>] [,type=<virtio|isa>]` ::
1321 Enable/disable communication with the QEMU Guest Agent and its properties.
1323 `--arch` `<aarch64 | x86_64>` ::
1325 Virtual processor architecture. Defaults to the host.
1327 `--args` `<string>` ::
1329 Arbitrary arguments passed to kvm.
1331 `--audio0` `device=<ich9-intel-hda|intel-hda|AC97> [,driver=<spice|none>]` ::
1333 Configure a audio device, useful in combination with QXL/Spice.
1335 `--autostart` `<boolean>` ('default =' `0`)::
1337 Automatic restart after crash (currently ignored).
1339 `--balloon` `<integer> (0 - N)` ::
1341 Amount of target RAM for the VM in MiB. Using zero disables the ballon driver.
1343 `--bios` `<ovmf | seabios>` ('default =' `seabios`)::
1345 Select BIOS implementation.
1347 `--boot` `[[legacy=]<[acdn]{1,4}>] [,order=<device[;device...]>]` ::
1349 Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated.
1351 `--bootdisk` `(ide|sata|scsi|virtio)\d+` ::
1353 Enable booting from specified disk. Deprecated: Use 'boot: order=foo;bar' instead.
1355 `--cdrom` `<volume>` ::
1357 This is an alias for option -ide2
1359 `--cicustom` `[meta=<volume>] [,network=<volume>] [,user=<volume>] [,vendor=<volume>]` ::
1361 cloud-init: Specify custom files to replace the automatically generated ones at start.
1363 `--cipassword` `<password>` ::
1365 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.
1367 `--citype` `<configdrive2 | nocloud | opennebula>` ::
1369 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.
1371 `--ciupgrade` `<boolean>` ('default =' `1`)::
1373 cloud-init: do an automatic package upgrade after the first boot.
1375 `--ciuser` `<string>` ::
1377 cloud-init: User name to change ssh keys and password for instead of the image's configured default user.
1379 `--cores` `<integer> (1 - N)` ('default =' `1`)::
1381 The number of cores per socket.
1383 `--cpu` `[[cputype=]<string>] [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=<vendor-id>] [,phys-bits=<8-64|host>] [,reported-model=<enum>]` ::
1387 `--cpulimit` `<number> (0 - 128)` ('default =' `0`)::
1391 `--cpuunits` `<integer> (1 - 262144)` ('default =' `cgroup v1: 1024, cgroup v2: 100`)::
1393 CPU weight for a VM, will be clamped to [1, 10000] in cgroup v2.
1395 `--delete` `<string>` ::
1397 A list of settings you want to delete.
1399 `--description` `<string>` ::
1401 Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file.
1403 `--digest` `<string>` ::
1405 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
1407 `--efidisk0` `[file=]<volume> [,efitype=<2m|4m>] [,format=<enum>] [,import-from=<source volume>] [,pre-enrolled-keys=<1|0>] [,size=<DiskSize>]` ::
1409 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.
1411 `--force` `<boolean>` ::
1413 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.
1415 NOTE: Requires option(s): `delete`
1417 `--freeze` `<boolean>` ::
1419 Freeze CPU at startup (use 'c' monitor command to start execution).
1421 `--hookscript` `<string>` ::
1423 Script that will be executed during various steps in the vms lifetime.
1425 `--hostpci[n]` `[[host=]<HOSTPCIID[;HOSTPCIID2...]>] [,device-id=<hex id>] [,legacy-igd=<1|0>] [,mapping=<mapping-id>] [,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>]` ::
1427 Map host PCI devices into guest.
1429 `--hotplug` `<string>` ('default =' `network,disk,usb`)::
1431 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.
1433 `--hugepages` `<1024 | 2 | any>` ::
1435 Enable/disable hugepages memory.
1437 `--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>]` ::
1439 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.
1441 `--ipconfig[n]` `[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]` ::
1443 cloud-init: Specify IP addresses and gateways for the corresponding interface.
1445 IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.
1447 The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit
1448 gateway should be provided.
1449 For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires
1450 cloud-init 19.4 or newer.
1452 If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using
1455 `--ivshmem` `size=<integer> [,name=<string>]` ::
1457 Inter-VM shared memory. Useful for direct communication between VMs, or to the host.
1459 `--keephugepages` `<boolean>` ('default =' `0`)::
1461 Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts.
1463 `--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>` ::
1465 Keyboard layout for VNC server. This option is generally not required and is often better handled from within the guest OS.
1467 `--kvm` `<boolean>` ('default =' `1`)::
1469 Enable/disable KVM hardware virtualization.
1471 `--localtime` `<boolean>` ::
1473 Set the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS.
1475 `--lock` `<backup | clone | create | migrate | rollback | snapshot | snapshot-delete | suspended | suspending>` ::
1479 `--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` ::
1481 Specifies the QEMU machine type.
1483 `--memory` `[current=]<integer>` ::
1487 `--migrate_downtime` `<number> (0 - N)` ('default =' `0.1`)::
1489 Set maximum tolerated downtime (in seconds) for migrations.
1491 `--migrate_speed` `<integer> (0 - N)` ('default =' `0`)::
1493 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
1495 `--name` `<string>` ::
1497 Set a name for the VM. Only used on the configuration web interface.
1499 `--nameserver` `<string>` ::
1501 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.
1503 `--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>]` ::
1505 Specify network devices.
1507 `--numa` `<boolean>` ('default =' `0`)::
1509 Enable/disable NUMA.
1511 `--numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
1515 `--onboot` `<boolean>` ('default =' `0`)::
1517 Specifies whether a VM will be started during system bootup.
1519 `--ostype` `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win11 | win7 | win8 | wvista | wxp>` ::
1521 Specify guest operating system.
1523 `--parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` ::
1525 Map host parallel devices (n is 0 to 2).
1527 `--protection` `<boolean>` ('default =' `0`)::
1529 Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
1531 `--reboot` `<boolean>` ('default =' `1`)::
1533 Allow reboot. If set to '0' the VM exit on reboot.
1535 `--revert` `<string>` ::
1537 Revert a pending change.
1539 `--rng0` `[source=]</dev/urandom|/dev/random|/dev/hwrng> [,max_bytes=<integer>] [,period=<integer>]` ::
1541 Configure a VirtIO-based Random Number Generator.
1543 `--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>]` ::
1545 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.
1547 `--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>] [,product=<product>] [,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>] [,vendor=<vendor>] [,werror=<enum>] [,wwn=<wwn>]` ::
1549 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.
1551 `--scsihw` `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
1553 SCSI controller model
1555 `--searchdomain` `<string>` ::
1557 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.
1559 `--serial[n]` `(/dev/.+|socket)` ::
1561 Create a serial device inside the VM (n is 0 to 3)
1563 `--shares` `<integer> (0 - 50000)` ('default =' `1000`)::
1565 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.
1567 `--skiplock` `<boolean>` ::
1569 Ignore locks - only root is allowed to use this option.
1571 `--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>]` ::
1573 Specify SMBIOS type 1 fields.
1575 `--smp` `<integer> (1 - N)` ('default =' `1`)::
1577 The number of CPUs. Please use option -sockets instead.
1579 `--sockets` `<integer> (1 - N)` ('default =' `1`)::
1581 The number of CPU sockets.
1583 `--spice_enhancements` `[foldersharing=<1|0>] [,videostreaming=<off|all|filter>]` ::
1585 Configure additional enhancements for SPICE.
1587 `--sshkeys` `<filepath>` ::
1589 cloud-init: Setup public SSH keys (one key per line, OpenSSH format).
1591 `--startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
1593 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'.
1595 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
1597 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.
1599 `--tablet` `<boolean>` ('default =' `1`)::
1601 Enable/disable the USB tablet device.
1603 `--tags` `<string>` ::
1605 Tags of the VM. This is only meta information.
1607 `--tdf` `<boolean>` ('default =' `0`)::
1609 Enable/disable time drift fix.
1611 `--template` `<boolean>` ('default =' `0`)::
1613 Enable/disable Template.
1615 `--tpmstate0` `[file=]<volume> [,import-from=<source volume>] [,size=<DiskSize>] [,version=<v1.2|v2.0>]` ::
1617 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.
1619 `--unused[n]` `[file=]<volume>` ::
1621 Reference to unused volumes. This is used internally, and should not be modified manually.
1623 `--usb[n]` `[[host=]<HOSTUSBDEVICE|spice>] [,mapping=<mapping-id>] [,usb3=<1|0>]` ::
1625 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).
1627 `--vcpus` `<integer> (1 - N)` ('default =' `0`)::
1629 Number of hotplugged vcpus.
1631 `--vga` `[[type=]<enum>] [,clipboard=<vnc>] [,memory=<integer>]` ::
1633 Configure the VGA hardware.
1635 `--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>]` ::
1637 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.
1639 `--vmgenid` `<UUID>` ('default =' `1 (autogenerated)`)::
1641 Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly.
1643 `--vmstatestorage` `<string>` ::
1645 Default storage for VM state volumes/files.
1647 `--watchdog` `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::
1649 Create a virtual hardware watchdog device.
1651 *qm showcmd* `<vmid>` `[OPTIONS]`
1653 Show command line which is used to start the VM (debug info).
1655 `<vmid>`: `<integer> (100 - 999999999)` ::
1657 The (unique) ID of the VM.
1659 `--pretty` `<boolean>` ('default =' `0`)::
1661 Puts each option on a new line to enhance human readability
1663 `--snapshot` `<string>` ::
1665 Fetch config values from given snapshot.
1667 *qm shutdown* `<vmid>` `[OPTIONS]`
1669 Shutdown virtual machine. This is similar to pressing the power button on a
1670 physical machine.This will send an ACPI event for the guest OS, which
1671 should then proceed to a clean shutdown.
1673 `<vmid>`: `<integer> (100 - 999999999)` ::
1675 The (unique) ID of the VM.
1677 `--forceStop` `<boolean>` ('default =' `0`)::
1679 Make sure the VM stops.
1681 `--keepActive` `<boolean>` ('default =' `0`)::
1683 Do not deactivate storage volumes.
1685 `--skiplock` `<boolean>` ::
1687 Ignore locks - only root is allowed to use this option.
1689 `--timeout` `<integer> (0 - N)` ::
1691 Wait maximal timeout seconds.
1693 *qm snapshot* `<vmid> <snapname>` `[OPTIONS]`
1697 `<vmid>`: `<integer> (100 - 999999999)` ::
1699 The (unique) ID of the VM.
1701 `<snapname>`: `<string>` ::
1703 The name of the snapshot.
1705 `--description` `<string>` ::
1707 A textual description or comment.
1709 `--vmstate` `<boolean>` ::
1713 *qm start* `<vmid>` `[OPTIONS]`
1715 Start virtual machine.
1717 `<vmid>`: `<integer> (100 - 999999999)` ::
1719 The (unique) ID of the VM.
1721 `--force-cpu` `<string>` ::
1723 Override QEMU's -cpu argument with the given string.
1725 `--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` ::
1727 Specifies the QEMU machine type.
1729 `--migratedfrom` `<string>` ::
1731 The cluster node name.
1733 `--migration_network` `<string>` ::
1735 CIDR of the (sub) network that is used for migration.
1737 `--migration_type` `<insecure | secure>` ::
1739 Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.
1741 `--skiplock` `<boolean>` ::
1743 Ignore locks - only root is allowed to use this option.
1745 `--stateuri` `<string>` ::
1747 Some command save/restore state from this location.
1749 `--targetstorage` `<string>` ::
1751 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.
1753 `--timeout` `<integer> (0 - N)` ('default =' `max(30, vm memory in GiB)`)::
1755 Wait maximal timeout seconds.
1757 *qm status* `<vmid>` `[OPTIONS]`
1761 `<vmid>`: `<integer> (100 - 999999999)` ::
1763 The (unique) ID of the VM.
1765 `--verbose` `<boolean>` ::
1767 Verbose output format
1769 *qm stop* `<vmid>` `[OPTIONS]`
1771 Stop virtual machine. The qemu process will exit immediately. Thisis akin
1772 to pulling the power plug of a running computer and may damage the VM data
1774 `<vmid>`: `<integer> (100 - 999999999)` ::
1776 The (unique) ID of the VM.
1778 `--keepActive` `<boolean>` ('default =' `0`)::
1780 Do not deactivate storage volumes.
1782 `--migratedfrom` `<string>` ::
1784 The cluster node name.
1786 `--skiplock` `<boolean>` ::
1788 Ignore locks - only root is allowed to use this option.
1790 `--timeout` `<integer> (0 - N)` ::
1792 Wait maximal timeout seconds.
1794 *qm suspend* `<vmid>` `[OPTIONS]`
1796 Suspend virtual machine.
1798 `<vmid>`: `<integer> (100 - 999999999)` ::
1800 The (unique) ID of the VM.
1802 `--skiplock` `<boolean>` ::
1804 Ignore locks - only root is allowed to use this option.
1806 `--statestorage` `<string>` ::
1808 The storage for the VM state
1810 NOTE: Requires option(s): `todisk`
1812 `--todisk` `<boolean>` ('default =' `0`)::
1814 If set, suspends the VM to disk. Will be resumed on next VM start.
1816 *qm template* `<vmid>` `[OPTIONS]`
1820 `<vmid>`: `<integer> (100 - 999999999)` ::
1822 The (unique) ID of the VM.
1824 `--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>` ::
1826 If you want to convert only 1 disk to base image.
1828 *qm terminal* `<vmid>` `[OPTIONS]`
1830 Open a terminal using a serial device (The VM need to have a serial device
1831 configured, for example 'serial0: socket')
1833 `<vmid>`: `<integer> (100 - 999999999)` ::
1835 The (unique) ID of the VM.
1837 `--escape` `<string>` ('default =' `^O`)::
1841 `--iface` `<serial0 | serial1 | serial2 | serial3>` ::
1843 Select the serial device. By default we simply use the first suitable device.
1847 An alias for 'qm disk unlink'.
1849 *qm unlock* `<vmid>`
1853 `<vmid>`: `<integer> (100 - 999999999)` ::
1855 The (unique) ID of the VM.
1857 *qm vncproxy* `<vmid>`
1859 Proxy VM VNC traffic to stdin/stdout
1861 `<vmid>`: `<integer> (100 - 999999999)` ::
1863 The (unique) ID of the VM.
1865 *qm wait* `<vmid>` `[OPTIONS]`
1867 Wait until the VM is stopped.
1869 `<vmid>`: `<integer> (100 - 999999999)` ::
1871 The (unique) ID of the VM.
1873 `--timeout` `<integer> (1 - N)` ::
1875 Timeout in seconds. Default is to wait forever.