1 *qm* `<COMMAND> [ARGS] [OPTIONS]`
3 *qm agent* `<vmid> <command>`
5 Execute Qemu Guest Agent commands.
7 `<vmid>`: `<integer> (1 - N)` ::
9 The (unique) ID of the VM.
11 `<command>`: `<fsfreeze-freeze | fsfreeze-status | fsfreeze-thaw | fstrim | get-fsinfo | get-memory-block-info | get-memory-blocks | get-time | get-vcpus | info | network-get-interfaces | ping | shutdown | suspend-disk | suspend-hybrid | suspend-ram>` ::
17 *qm clone* `<vmid> <newid>` `[OPTIONS]`
19 Create a copy of virtual machine/template.
21 `<vmid>`: `<integer> (1 - N)` ::
23 The (unique) ID of the VM.
25 `<newid>`: `<integer> (1 - N)` ::
29 `-description` `<string>` ::
31 Description for the new VM.
33 `-format` `<qcow2 | raw | vmdk>` ::
35 Target format for file storage.
37 NOTE: Requires option(s): `full`
39 `-full` `<boolean>` ('default =' `0`)::
41 Create a full copy of all disk. This is always done when you clone a normal VM. For VM templates, we try to create a linked clone by default.
45 Set a name for the new VM.
49 Add the new VM to the specified pool.
51 `-snapname` `<string>` ::
53 The name of the snapshot.
55 `-storage` `<string>` ::
57 Target storage for full clone.
59 NOTE: Requires option(s): `full`
61 `-target` `<string>` ::
63 Target node. Only allowed if the original VM is on shared storage.
67 *qm config* `<vmid>` `[OPTIONS]`
69 Get current virtual machine configuration. This does not include pending
70 configuration changes (see 'pending' API).
72 `<vmid>`: `<integer> (1 - N)` ::
74 The (unique) ID of the VM.
76 `-current` `<boolean>` ('default =' `0`)::
78 Get current values (instead of pending values).
82 *qm create* `<vmid>` `[OPTIONS]`
84 Create or restore a virtual machine.
86 `<vmid>`: `<integer> (1 - N)` ::
88 The (unique) ID of the VM.
90 `-acpi` `<boolean>` ('default =' `1`)::
94 `-agent` `<boolean>` ('default =' `0`)::
96 Enable/disable Qemu GuestAgent.
98 `-archive` `<string>` ::
102 `-args` `<string>` ::
104 Arbitrary arguments passed to kvm.
106 `-autostart` `<boolean>` ('default =' `0`)::
108 Automatic restart after crash (currently ignored).
110 `-balloon` `<integer> (0 - N)` ::
112 Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
114 `-bios` `<ovmf | seabios>` ('default =' `seabios`)::
116 Select BIOS implementation.
118 `-boot` `[acdn]{1,4}` ('default =' `cdn`)::
120 Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).
122 `-bootdisk` `(ide|sata|scsi|virtio)\d+` ::
124 Enable booting from specified disk.
126 `-cdrom` `<volume>` ::
128 This is an alias for option -ide2
130 `-cores` `<integer> (1 - N)` ('default =' `1`)::
132 The number of cores per socket.
134 `-cpu` `[cputype=]<enum> [,hidden=<1|0>]` ::
138 `-cpulimit` `<number> (0 - 128)` ('default =' `0`)::
142 `-cpuunits` `<integer> (0 - 500000)` ('default =' `1024`)::
146 `-description` `<string>` ::
148 Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.
150 `-efidisk0` `[file=]<volume> [,format=<enum>] [,size=<DiskSize>]` ::
152 Configure a Disk for storing EFI vars
154 `-force` `<boolean>` ::
156 Allow to overwrite existing VM.
158 NOTE: Requires option(s): `archive`
160 `-freeze` `<boolean>` ::
162 Freeze CPU at startup (use 'c' monitor command to start execution).
164 `-hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
166 Map host PCI devices into guest.
168 `-hotplug` `<string>` ('default =' `network,disk,usb`)::
170 Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to disable hotplug completely. Value '1' is an alias for the default 'network,disk,usb'.
172 `-hugepages` `<1024 | 2 | any>` ::
174 Enable/disable hugepages memory.
176 `-ide[n]` `[file=]<volume> [,aio=<native|threads>] [,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>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
178 Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
180 `-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>` ('default =' `en-us`)::
182 Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.
184 `-kvm` `<boolean>` ('default =' `1`)::
186 Enable/disable KVM hardware virtualization.
188 `-localtime` `<boolean>` ::
190 Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
192 `-lock` `<backup | migrate | rollback | snapshot>` ::
196 `-machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
198 Specific the Qemu machine type.
200 `-memory` `<integer> (16 - N)` ('default =' `512`)::
202 Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
204 `-migrate_downtime` `<number> (0 - N)` ('default =' `0.1`)::
206 Set maximum tolerated downtime (in seconds) for migrations.
208 `-migrate_speed` `<integer> (0 - N)` ('default =' `0`)::
210 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
212 `-name` `<string>` ::
214 Set a name for the VM. Only used on the configuration web interface.
216 `-net[n]` `[model=]<enum> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]` ::
218 Specify network devices.
220 `-numa` `<boolean>` ('default =' `0`)::
224 `-numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
228 `-onboot` `<boolean>` ('default =' `0`)::
230 Specifies whether a VM will be started during system bootup.
232 `-ostype` `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win7 | win8 | wvista | wxp>` ::
234 Specify guest operating system.
236 `-parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` ::
238 Map host parallel devices (n is 0 to 2).
240 `-pool` `<string>` ::
242 Add the VM to the specified pool.
244 `-protection` `<boolean>` ('default =' `0`)::
246 Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
248 `-reboot` `<boolean>` ('default =' `1`)::
250 Allow reboot. If set to '0' the VM exit on reboot.
252 `-sata[n]` `[file=]<volume> [,aio=<native|threads>] [,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>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
254 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
256 `-scsi[n]` `[file=]<volume> [,aio=<native|threads>] [,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>] [,queues=<integer>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,scsiblock=<1|0>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
258 Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
260 `-scsihw` `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
262 SCSI controller model
264 `-serial[n]` `(/dev/.+|socket)` ::
266 Create a serial device inside the VM (n is 0 to 3)
268 `-shares` `<integer> (0 - 50000)` ('default =' `1000`)::
270 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
272 `-smbios1` `[family=<string>] [,manufacturer=<string>] [,product=<string>] [,serial=<string>] [,sku=<string>] [,uuid=<UUID>] [,version=<string>]` ::
274 Specify SMBIOS type 1 fields.
276 `-smp` `<integer> (1 - N)` ('default =' `1`)::
278 The number of CPUs. Please use option -sockets instead.
280 `-sockets` `<integer> (1 - N)` ('default =' `1`)::
282 The number of CPU sockets.
284 `-startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
286 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'.
288 `-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
290 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.
292 `-storage` `<string>` ::
296 `-tablet` `<boolean>` ('default =' `1`)::
298 Enable/disable the USB tablet device.
300 `-tdf` `<boolean>` ('default =' `0`)::
302 Enable/disable time drift fix.
304 `-template` `<boolean>` ('default =' `0`)::
306 Enable/disable Template.
308 `-unique` `<boolean>` ::
310 Assign a unique random ethernet address.
312 NOTE: Requires option(s): `archive`
314 `-unused[n]` `<string>` ::
316 Reference to unused volumes. This is used internally, and should not be modified manually.
318 `-usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
320 Configure an USB device (n is 0 to 4).
322 `-vcpus` `<integer> (1 - N)` ('default =' `0`)::
324 Number of hotplugged vcpus.
326 `-vga` `<cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware>` ::
330 `-virtio[n]` `[file=]<volume> [,aio=<native|threads>] [,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>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
332 Use volume as VIRTIO hard disk (n is 0 to 15).
334 `-watchdog` `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::
336 Create a virtual hardware watchdog device.
340 *qm delsnapshot* `<vmid> <snapname>` `[OPTIONS]`
342 Delete a VM snapshot.
344 `<vmid>`: `<integer> (1 - N)` ::
346 The (unique) ID of the VM.
348 `<snapname>`: `<string>` ::
350 The name of the snapshot.
352 `-force` `<boolean>` ::
354 For removal from config file, even if removing disk snapshots fails.
358 *qm destroy* `<vmid>` `[OPTIONS]`
360 Destroy the vm (also delete all used/owned volumes).
362 `<vmid>`: `<integer> (1 - N)` ::
364 The (unique) ID of the VM.
366 `-skiplock` `<boolean>` ::
368 Ignore locks - only root is allowed to use this option.
373 *qm help* `[<cmd>]` `[OPTIONS]`
375 Get help about specified command.
377 `<cmd>`: `<string>` ::
381 `-verbose` `<boolean>` ::
383 Verbose output format.
388 *qm importdisk* `<vmid> <source> <storage>` `[OPTIONS]`
390 Import an external disk image as an unused disk in a VM. The
391 image format has to be supported by qemu-img(1).
393 `<vmid>`: `<integer> (1 - N)` ::
395 The (unique) ID of the VM.
397 `<source>`: `<string>` ::
399 Path to the disk image to import
401 `<storage>`: `<string>` ::
405 `-format` `<qcow2 | raw | vmdk>` ::
412 *qm list* `[OPTIONS]`
414 Virtual machine index (per node).
416 `-full` `<boolean>` ::
418 Determine the full status of active VMs.
422 *qm listsnapshot* `<vmid>`
426 `<vmid>`: `<integer> (1 - N)` ::
428 The (unique) ID of the VM.
432 *qm migrate* `<vmid> <target>` `[OPTIONS]`
434 Migrate virtual machine. Creates a new migration task.
436 `<vmid>`: `<integer> (1 - N)` ::
438 The (unique) ID of the VM.
440 `<target>`: `<string>` ::
444 `-force` `<boolean>` ::
446 Allow to migrate VMs which use local devices. Only root may use this option.
448 `-migration_network` `<string>` ::
450 CIDR of the (sub) network that is used for migration.
452 `-migration_type` `<insecure | secure>` ::
454 Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.
456 `-online` `<boolean>` ::
458 Use online/live migration.
460 `-targetstorage` `<string>` ::
462 Default target storage.
464 `-with-local-disks` `<boolean>` ::
466 Enable live storage migration for local disk
471 *qm monitor* `<vmid>`
473 Enter Qemu Monitor interface.
475 `<vmid>`: `<integer> (1 - N)` ::
477 The (unique) ID of the VM.
482 *qm move_disk* `<vmid> <disk> <storage>` `[OPTIONS]`
484 Move volume to different storage.
486 `<vmid>`: `<integer> (1 - N)` ::
488 The (unique) ID of the VM.
490 `<disk>`: `<efidisk0 | ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi2 | scsi3 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9>` ::
492 The disk you want to move.
494 `<storage>`: `<string>` ::
498 `-delete` `<boolean>` ('default =' `0`)::
500 Delete the original disk after successful copy. By default the original disk is kept as unused disk.
502 `-digest` `<string>` ::
504 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
506 `-format` `<qcow2 | raw | vmdk>` ::
515 Used by qmigrate - do not use manually.
519 *qm nbdstop* `<vmid>`
521 Stop embedded nbd server.
523 `<vmid>`: `<integer> (1 - N)` ::
525 The (unique) ID of the VM.
530 *qm pending* `<vmid>`
532 Get virtual machine configuration, including pending changes.
534 `<vmid>`: `<integer> (1 - N)` ::
536 The (unique) ID of the VM.
541 *qm rescan* `[OPTIONS]`
543 Rescan all storages and update disk sizes and unused disk images.
545 `-vmid` `<integer> (1 - N)` ::
547 The (unique) ID of the VM.
552 *qm reset* `<vmid>` `[OPTIONS]`
554 Reset virtual machine.
556 `<vmid>`: `<integer> (1 - N)` ::
558 The (unique) ID of the VM.
560 `-skiplock` `<boolean>` ::
562 Ignore locks - only root is allowed to use this option.
566 *qm resize* `<vmid> <disk> <size>` `[OPTIONS]`
570 `<vmid>`: `<integer> (1 - N)` ::
572 The (unique) ID of the VM.
574 `<disk>`: `<efidisk0 | ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi2 | scsi3 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9>` ::
576 The disk you want to resize.
578 `<size>`: `\+?\d+(\.\d+)?[KMGT]?` ::
580 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.
582 `-digest` `<string>` ::
584 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
586 `-skiplock` `<boolean>` ::
588 Ignore locks - only root is allowed to use this option.
592 *qm resume* `<vmid>` `[OPTIONS]`
594 Resume virtual machine.
596 `<vmid>`: `<integer> (1 - N)` ::
598 The (unique) ID of the VM.
600 `-nocheck` `<boolean>` ::
602 no description available
604 `-skiplock` `<boolean>` ::
606 Ignore locks - only root is allowed to use this option.
610 *qm rollback* `<vmid> <snapname>`
612 Rollback VM state to specified snapshot.
614 `<vmid>`: `<integer> (1 - N)` ::
616 The (unique) ID of the VM.
618 `<snapname>`: `<string>` ::
620 The name of the snapshot.
624 *qm sendkey* `<vmid> <key>` `[OPTIONS]`
626 Send key event to virtual machine.
628 `<vmid>`: `<integer> (1 - N)` ::
630 The (unique) ID of the VM.
632 `<key>`: `<string>` ::
634 The key (qemu monitor encoding).
636 `-skiplock` `<boolean>` ::
638 Ignore locks - only root is allowed to use this option.
642 *qm set* `<vmid>` `[OPTIONS]`
644 Set virtual machine options (synchrounous API) - You should consider using
645 the POST method instead for any actions involving hotplug or storage
648 `<vmid>`: `<integer> (1 - N)` ::
650 The (unique) ID of the VM.
652 `-acpi` `<boolean>` ('default =' `1`)::
656 `-agent` `<boolean>` ('default =' `0`)::
658 Enable/disable Qemu GuestAgent.
660 `-args` `<string>` ::
662 Arbitrary arguments passed to kvm.
664 `-autostart` `<boolean>` ('default =' `0`)::
666 Automatic restart after crash (currently ignored).
668 `-balloon` `<integer> (0 - N)` ::
670 Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
672 `-bios` `<ovmf | seabios>` ('default =' `seabios`)::
674 Select BIOS implementation.
676 `-boot` `[acdn]{1,4}` ('default =' `cdn`)::
678 Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).
680 `-bootdisk` `(ide|sata|scsi|virtio)\d+` ::
682 Enable booting from specified disk.
684 `-cdrom` `<volume>` ::
686 This is an alias for option -ide2
688 `-cores` `<integer> (1 - N)` ('default =' `1`)::
690 The number of cores per socket.
692 `-cpu` `[cputype=]<enum> [,hidden=<1|0>]` ::
696 `-cpulimit` `<number> (0 - 128)` ('default =' `0`)::
700 `-cpuunits` `<integer> (0 - 500000)` ('default =' `1024`)::
704 `-delete` `<string>` ::
706 A list of settings you want to delete.
708 `-description` `<string>` ::
710 Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.
712 `-digest` `<string>` ::
714 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
716 `-efidisk0` `[file=]<volume> [,format=<enum>] [,size=<DiskSize>]` ::
718 Configure a Disk for storing EFI vars
720 `-force` `<boolean>` ::
722 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.
724 NOTE: Requires option(s): `delete`
726 `-freeze` `<boolean>` ::
728 Freeze CPU at startup (use 'c' monitor command to start execution).
730 `-hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
732 Map host PCI devices into guest.
734 `-hotplug` `<string>` ('default =' `network,disk,usb`)::
736 Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to disable hotplug completely. Value '1' is an alias for the default 'network,disk,usb'.
738 `-hugepages` `<1024 | 2 | any>` ::
740 Enable/disable hugepages memory.
742 `-ide[n]` `[file=]<volume> [,aio=<native|threads>] [,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>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
744 Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
746 `-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>` ('default =' `en-us`)::
748 Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.
750 `-kvm` `<boolean>` ('default =' `1`)::
752 Enable/disable KVM hardware virtualization.
754 `-localtime` `<boolean>` ::
756 Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
758 `-lock` `<backup | migrate | rollback | snapshot>` ::
762 `-machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
764 Specific the Qemu machine type.
766 `-memory` `<integer> (16 - N)` ('default =' `512`)::
768 Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
770 `-migrate_downtime` `<number> (0 - N)` ('default =' `0.1`)::
772 Set maximum tolerated downtime (in seconds) for migrations.
774 `-migrate_speed` `<integer> (0 - N)` ('default =' `0`)::
776 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
778 `-name` `<string>` ::
780 Set a name for the VM. Only used on the configuration web interface.
782 `-net[n]` `[model=]<enum> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]` ::
784 Specify network devices.
786 `-numa` `<boolean>` ('default =' `0`)::
790 `-numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
794 `-onboot` `<boolean>` ('default =' `0`)::
796 Specifies whether a VM will be started during system bootup.
798 `-ostype` `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win7 | win8 | wvista | wxp>` ::
800 Specify guest operating system.
802 `-parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` ::
804 Map host parallel devices (n is 0 to 2).
806 `-protection` `<boolean>` ('default =' `0`)::
808 Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
810 `-reboot` `<boolean>` ('default =' `1`)::
812 Allow reboot. If set to '0' the VM exit on reboot.
814 `-revert` `<string>` ::
816 Revert a pending change.
818 `-sata[n]` `[file=]<volume> [,aio=<native|threads>] [,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>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
820 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
822 `-scsi[n]` `[file=]<volume> [,aio=<native|threads>] [,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>] [,queues=<integer>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,scsiblock=<1|0>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
824 Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
826 `-scsihw` `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
828 SCSI controller model
830 `-serial[n]` `(/dev/.+|socket)` ::
832 Create a serial device inside the VM (n is 0 to 3)
834 `-shares` `<integer> (0 - 50000)` ('default =' `1000`)::
836 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
838 `-skiplock` `<boolean>` ::
840 Ignore locks - only root is allowed to use this option.
842 `-smbios1` `[family=<string>] [,manufacturer=<string>] [,product=<string>] [,serial=<string>] [,sku=<string>] [,uuid=<UUID>] [,version=<string>]` ::
844 Specify SMBIOS type 1 fields.
846 `-smp` `<integer> (1 - N)` ('default =' `1`)::
848 The number of CPUs. Please use option -sockets instead.
850 `-sockets` `<integer> (1 - N)` ('default =' `1`)::
852 The number of CPU sockets.
854 `-startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
856 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'.
858 `-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
860 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.
862 `-tablet` `<boolean>` ('default =' `1`)::
864 Enable/disable the USB tablet device.
866 `-tdf` `<boolean>` ('default =' `0`)::
868 Enable/disable time drift fix.
870 `-template` `<boolean>` ('default =' `0`)::
872 Enable/disable Template.
874 `-unused[n]` `<string>` ::
876 Reference to unused volumes. This is used internally, and should not be modified manually.
878 `-usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
880 Configure an USB device (n is 0 to 4).
882 `-vcpus` `<integer> (1 - N)` ('default =' `0`)::
884 Number of hotplugged vcpus.
886 `-vga` `<cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware>` ::
890 `-virtio[n]` `[file=]<volume> [,aio=<native|threads>] [,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>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
892 Use volume as VIRTIO hard disk (n is 0 to 15).
894 `-watchdog` `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::
896 Create a virtual hardware watchdog device.
901 *qm showcmd* `<vmid>`
903 Show command line which is used to start the VM (debug info).
905 `<vmid>`: `<integer> (1 - N)` ::
907 The (unique) ID of the VM.
912 *qm shutdown* `<vmid>` `[OPTIONS]`
914 Shutdown virtual machine. This is similar to pressing the power button on a
915 physical machine.This will send an ACPI event for the guest OS, which
916 should then proceed to a clean shutdown.
918 `<vmid>`: `<integer> (1 - N)` ::
920 The (unique) ID of the VM.
922 `-forceStop` `<boolean>` ('default =' `0`)::
924 Make sure the VM stops.
926 `-keepActive` `<boolean>` ('default =' `0`)::
928 Do not deactivate storage volumes.
930 `-skiplock` `<boolean>` ::
932 Ignore locks - only root is allowed to use this option.
934 `-timeout` `<integer> (0 - N)` ::
936 Wait maximal timeout seconds.
940 *qm snapshot* `<vmid> <snapname>` `[OPTIONS]`
944 `<vmid>`: `<integer> (1 - N)` ::
946 The (unique) ID of the VM.
948 `<snapname>`: `<string>` ::
950 The name of the snapshot.
952 `-description` `<string>` ::
954 A textual description or comment.
956 `-vmstate` `<boolean>` ::
962 *qm start* `<vmid>` `[OPTIONS]`
964 Start virtual machine.
966 `<vmid>`: `<integer> (1 - N)` ::
968 The (unique) ID of the VM.
970 `-machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
972 Specific the Qemu machine type.
974 `-migratedfrom` `<string>` ::
976 The cluster node name.
978 `-migration_network` `<string>` ::
980 CIDR of the (sub) network that is used for migration.
982 `-migration_type` `<insecure | secure>` ::
984 Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.
986 `-skiplock` `<boolean>` ::
988 Ignore locks - only root is allowed to use this option.
990 `-stateuri` `<string>` ::
992 Some command save/restore state from this location.
994 `-targetstorage` `<string>` ::
996 Target storage for the migration. (Can be '1' to use the same storage id as on the source node.)
1001 *qm status* `<vmid>` `[OPTIONS]`
1005 `<vmid>`: `<integer> (1 - N)` ::
1007 The (unique) ID of the VM.
1009 `-verbose` `<boolean>` ::
1011 Verbose output format
1016 *qm stop* `<vmid>` `[OPTIONS]`
1018 Stop virtual machine. The qemu process will exit immediately. Thisis akin
1019 to pulling the power plug of a running computer and may damage the VM data
1021 `<vmid>`: `<integer> (1 - N)` ::
1023 The (unique) ID of the VM.
1025 `-keepActive` `<boolean>` ('default =' `0`)::
1027 Do not deactivate storage volumes.
1029 `-migratedfrom` `<string>` ::
1031 The cluster node name.
1033 `-skiplock` `<boolean>` ::
1035 Ignore locks - only root is allowed to use this option.
1037 `-timeout` `<integer> (0 - N)` ::
1039 Wait maximal timeout seconds.
1043 *qm suspend* `<vmid>` `[OPTIONS]`
1045 Suspend virtual machine.
1047 `<vmid>`: `<integer> (1 - N)` ::
1049 The (unique) ID of the VM.
1051 `-skiplock` `<boolean>` ::
1053 Ignore locks - only root is allowed to use this option.
1057 *qm template* `<vmid>` `[OPTIONS]`
1061 `<vmid>`: `<integer> (1 - N)` ::
1063 The (unique) ID of the VM.
1065 `-disk` `<efidisk0 | ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi2 | scsi3 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9>` ::
1067 If you want to convert only 1 disk to base image.
1072 *qm terminal* `<vmid>` `[OPTIONS]`
1074 Open a terminal using a serial device (The VM need to have a serial device
1075 configured, for example 'serial0: socket')
1077 `<vmid>`: `<integer> (1 - N)` ::
1079 The (unique) ID of the VM.
1081 `-iface` `<serial0 | serial1 | serial2 | serial3>` ::
1083 Select the serial device. By default we simply use the first suitable device.
1088 *qm unlink* `<vmid> -idlist <string>` `[OPTIONS]`
1090 Unlink/delete disk images.
1092 `<vmid>`: `<integer> (1 - N)` ::
1094 The (unique) ID of the VM.
1096 `-force` `<boolean>` ::
1098 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.
1100 `-idlist` `<string>` ::
1102 A list of disk IDs you want to delete.
1107 *qm unlock* `<vmid>`
1111 `<vmid>`: `<integer> (1 - N)` ::
1113 The (unique) ID of the VM.
1117 *qm vncproxy* `<vmid>`
1119 Proxy VM VNC traffic to stdin/stdout
1121 `<vmid>`: `<integer> (1 - N)` ::
1123 The (unique) ID of the VM.
1127 *qm wait* `<vmid>` `[OPTIONS]`
1129 Wait until the VM is stopped.
1131 `<vmid>`: `<integer> (1 - N)` ::
1133 The (unique) ID of the VM.
1135 `-timeout` `<integer> (1 - N)` ::
1137 Timeout in seconds. Default is to wait forever.