1 *qm* `<COMMAND> [ARGS] [OPTIONS]`
3 *qm clone* `<vmid> <newid>` `[OPTIONS]`
5 Create a copy of virtual machine/template.
7 `<vmid>` `integer (1 - N)` ::
9 The (unique) ID of the VM.
11 `<newid>` `integer (1 - N)` ::
15 `-description` `string` ::
17 Description for the new VM.
19 `-format` `(qcow2 | raw | vmdk)` ::
21 Target format for file storage.
23 NOTE: Requires option(s): `full`
25 `-full` `boolean` (default=`0`)::
27 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.
31 Set a name for the new VM.
35 Add the new VM to the specified pool.
37 `-snapname` `string` ::
39 The name of the snapshot.
41 `-storage` `string` ::
43 Target storage for full clone.
45 NOTE: Requires option(s): `full`
49 Target node. Only allowed if the original VM is on shared storage.
53 *qm config* `<vmid>` `[OPTIONS]`
55 Get current virtual machine configuration. This does not include pending
56 configuration changes (see 'pending' API).
58 `<vmid>` `integer (1 - N)` ::
60 The (unique) ID of the VM.
62 `-current` `boolean` (default=`0`)::
64 Get current values (instead of pending values).
68 *qm create* `<vmid>` `[OPTIONS]`
70 Create or restore a virtual machine.
72 `<vmid>` `integer (1 - N)` ::
74 The (unique) ID of the VM.
76 `-acpi` `boolean` (default=`1`)::
80 `-agent` `boolean` (default=`0`)::
82 Enable/disable Qemu GuestAgent.
84 `-archive` `string` ::
90 Arbitrary arguments passed to kvm.
92 `-autostart` `boolean` (default=`0`)::
94 Automatic restart after crash (currently ignored).
96 `-balloon` `integer (0 - N)` ::
98 Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
100 `-bios` `(ovmf | seabios)` (default=`seabios`)::
102 Select BIOS implementation.
104 `-boot` `[acdn]{1,4}` (default=`cdn`)::
106 Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).
108 `-bootdisk` `(ide|sata|scsi|virtio)\d+` ::
110 Enable booting from specified disk.
114 This is an alias for option -ide2
116 `-cores` `integer (1 - N)` (default=`1`)::
118 The number of cores per socket.
120 `-cpu` `[cputype=]<cputype> [,hidden=<1|0>]` ::
124 `-cpulimit` `number (0 - 128)` (default=`0`)::
128 `-cpuunits` `integer (0 - 500000)` (default=`1000`)::
132 `-description` `string` ::
134 Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.
136 `-efidisk0` `[file=]<volume> [,format=<image format>] [,size=<DiskSize>]` ::
138 Configure a Disk for storing EFI vars
140 `-force` `boolean` ::
142 Allow to overwrite existing VM.
144 NOTE: Requires option(s): `archive`
146 `-freeze` `boolean` ::
148 Freeze CPU at startup (use 'c' monitor command to start execution).
150 `-hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,x-vga=<1|0>]` ::
152 Map host PCI devices into guest.
154 `-hotplug` `string` (default=`network,disk,usb`)::
156 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'.
158 `-hugepages` `(1024 | 2 | any)` ::
160 Enable/disable hugepages memory.
162 `-ide[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<image format>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
164 Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
166 `-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`)::
168 Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.
170 `-kvm` `boolean` (default=`1`)::
172 Enable/disable KVM hardware virtualization.
174 `-localtime` `boolean` ::
176 Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
178 `-lock` `(backup | migrate | rollback | snapshot)` ::
182 `-machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
184 Specific the Qemu machine type.
186 `-memory` `integer (16 - N)` (default=`512`)::
188 Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
190 `-migrate_downtime` `number (0 - N)` (default=`0.1`)::
192 Set maximum tolerated downtime (in seconds) for migrations.
194 `-migrate_speed` `integer (0 - N)` (default=`0`)::
196 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
200 Set a name for the VM. Only used on the configuration web interface.
202 `-net[n]` `[model=]<model> [,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>]` ::
204 Specify network devices.
206 `-numa` `boolean` (default=`0`)::
210 `-numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
214 `-onboot` `boolean` (default=`0`)::
216 Specifies whether a VM will be started during system bootup.
218 `-ostype` `(l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win7 | win8 | wvista | wxp)` ::
220 Specify guest operating system.
222 `-parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` ::
224 Map host parallel devices (n is 0 to 2).
228 Add the VM to the specified pool.
230 `-protection` `boolean` (default=`0`)::
232 Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
234 `-reboot` `boolean` (default=`1`)::
236 Allow reboot. If set to '0' the VM exit on reboot.
238 `-sata[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<image format>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
240 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
242 `-scsi[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<image format>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,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>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
244 Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
246 `-scsihw` `(lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single)` (default=`lsi`)::
248 SCSI controller model
250 `-serial[n]` `(/dev/.+|socket)` ::
252 Create a serial device inside the VM (n is 0 to 3)
254 `-shares` `integer (0 - 50000)` (default=`1000`)::
256 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
258 `-smbios1` `[family=<string>] [,manufacturer=<string>] [,product=<string>] [,serial=<string>] [,sku=<string>] [,uuid=<UUID>] [,version=<string>]` ::
260 Specify SMBIOS type 1 fields.
262 `-smp` `integer (1 - N)` (default=`1`)::
264 The number of CPUs. Please use option -sockets instead.
266 `-sockets` `integer (1 - N)` (default=`1`)::
268 The number of CPU sockets.
270 `-startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` (default=`now`)::
272 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'.
274 `-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
276 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.
278 `-storage` `string` ::
282 `-tablet` `boolean` (default=`1`)::
284 Enable/disable the USB tablet device.
286 `-tdf` `boolean` (default=`0`)::
288 Enable/disable time drift fix.
290 `-template` `boolean` (default=`0`)::
292 Enable/disable Template.
294 `-unique` `boolean` ::
296 Assign a unique random ethernet address.
298 NOTE: Requires option(s): `archive`
300 `-unused[n]` `string` ::
302 Reference to unused volumes. This is used internally, and should not be modified manually.
304 `-usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
306 Configure an USB device (n is 0 to 4).
308 `-vcpus` `integer (1 - N)` (default=`0`)::
310 Number of hotplugged vcpus.
312 `-vga` `(cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware)` ::
316 `-virtio[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<image format>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,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>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
318 Use volume as VIRTIO hard disk (n is 0 to 15).
320 `-watchdog` `[[model=]<i6300esb|ib700>] [,action=<reset|shutdown|poweroff|pause|debug|none>]` ::
322 Create a virtual hardware watchdog device.
326 *qm delsnapshot* `<vmid> <snapname>` `[OPTIONS]`
328 Delete a VM snapshot.
330 `<vmid>` `integer (1 - N)` ::
332 The (unique) ID of the VM.
334 `<snapname>` `string` ::
336 The name of the snapshot.
338 `-force` `boolean` ::
340 For removal from config file, even if removing disk snapshots fails.
344 *qm destroy* `<vmid>` `[OPTIONS]`
346 Destroy the vm (also delete all used/owned volumes).
348 `<vmid>` `integer (1 - N)` ::
350 The (unique) ID of the VM.
352 `-skiplock` `boolean` ::
354 Ignore locks - only root is allowed to use this option.
359 *qm help* `[<cmd>]` `[OPTIONS]`
361 Get help about specified command.
367 `-verbose` `boolean` ::
369 Verbose output format.
374 *qm list* `[OPTIONS]`
376 Virtual machine index (per node).
380 Determine the full status of active VMs.
384 *qm migrate* `<vmid> <target>` `[OPTIONS]`
386 Migrate virtual machine. Creates a new migration task.
388 `<vmid>` `integer (1 - N)` ::
390 The (unique) ID of the VM.
392 `<target>` `string` ::
396 `-force` `boolean` ::
398 Allow to migrate VMs which use local devices. Only root may use this option.
400 `-online` `boolean` ::
402 Use online/live migration.
407 *qm monitor* `<vmid>`
409 Enter Qemu Monitor interface.
411 `<vmid>` `integer (1 - N)` ::
413 The (unique) ID of the VM.
418 *qm move_disk* `<vmid> <disk> <storage>` `[OPTIONS]`
420 Move volume to different storage.
422 `<vmid>` `integer (1 - N)` ::
424 The (unique) ID of the VM.
426 `<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)` ::
428 The disk you want to move.
430 `<storage>` `string` ::
434 `-delete` `boolean` (default=`0`)::
436 Delete the original disk after successful copy. By default the original disk is kept as unused disk.
438 `-digest` `string` ::
440 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
442 `-format` `(qcow2 | raw | vmdk)` ::
451 Used by qmigrate - do not use manually.
456 *qm pending* `<vmid>`
458 Get virtual machine configuration, including pending changes.
460 `<vmid>` `integer (1 - N)` ::
462 The (unique) ID of the VM.
467 *qm rescan* `[OPTIONS]`
469 Rescan all storages and update disk sizes and unused disk images.
471 `-vmid` `integer (1 - N)` ::
473 The (unique) ID of the VM.
478 *qm reset* `<vmid>` `[OPTIONS]`
480 Reset virtual machine.
482 `<vmid>` `integer (1 - N)` ::
484 The (unique) ID of the VM.
486 `-skiplock` `boolean` ::
488 Ignore locks - only root is allowed to use this option.
492 *qm resize* `<vmid> <disk> <size>` `[OPTIONS]`
496 `<vmid>` `integer (1 - N)` ::
498 The (unique) ID of the VM.
500 `<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)` ::
502 The disk you want to resize.
504 `<size>` `\+?\d+(\.\d+)?[KMGT]?` ::
506 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.
508 `-digest` `string` ::
510 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
512 `-skiplock` `boolean` ::
514 Ignore locks - only root is allowed to use this option.
518 *qm resume* `<vmid>` `[OPTIONS]`
520 Resume virtual machine.
522 `<vmid>` `integer (1 - N)` ::
524 The (unique) ID of the VM.
526 `-nocheck` `boolean` ::
528 no description available
530 `-skiplock` `boolean` ::
532 Ignore locks - only root is allowed to use this option.
536 *qm rollback* `<vmid> <snapname>`
538 Rollback VM state to specified snapshot.
540 `<vmid>` `integer (1 - N)` ::
542 The (unique) ID of the VM.
544 `<snapname>` `string` ::
546 The name of the snapshot.
550 *qm sendkey* `<vmid> <key>` `[OPTIONS]`
552 Send key event to virtual machine.
554 `<vmid>` `integer (1 - N)` ::
556 The (unique) ID of the VM.
560 The key (qemu monitor encoding).
562 `-skiplock` `boolean` ::
564 Ignore locks - only root is allowed to use this option.
568 *qm set* `<vmid>` `[OPTIONS]`
570 Set virtual machine options (synchrounous API) - You should consider using
571 the POST method instead for any actions involving hotplug or storage
574 `<vmid>` `integer (1 - N)` ::
576 The (unique) ID of the VM.
578 `-acpi` `boolean` (default=`1`)::
582 `-agent` `boolean` (default=`0`)::
584 Enable/disable Qemu GuestAgent.
588 Arbitrary arguments passed to kvm.
590 `-autostart` `boolean` (default=`0`)::
592 Automatic restart after crash (currently ignored).
594 `-balloon` `integer (0 - N)` ::
596 Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
598 `-bios` `(ovmf | seabios)` (default=`seabios`)::
600 Select BIOS implementation.
602 `-boot` `[acdn]{1,4}` (default=`cdn`)::
604 Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).
606 `-bootdisk` `(ide|sata|scsi|virtio)\d+` ::
608 Enable booting from specified disk.
612 This is an alias for option -ide2
614 `-cores` `integer (1 - N)` (default=`1`)::
616 The number of cores per socket.
618 `-cpu` `[cputype=]<cputype> [,hidden=<1|0>]` ::
622 `-cpulimit` `number (0 - 128)` (default=`0`)::
626 `-cpuunits` `integer (0 - 500000)` (default=`1000`)::
630 `-delete` `string` ::
632 A list of settings you want to delete.
634 `-description` `string` ::
636 Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.
638 `-digest` `string` ::
640 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
642 `-efidisk0` `[file=]<volume> [,format=<image format>] [,size=<DiskSize>]` ::
644 Configure a Disk for storing EFI vars
646 `-force` `boolean` ::
648 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.
650 NOTE: Requires option(s): `delete`
652 `-freeze` `boolean` ::
654 Freeze CPU at startup (use 'c' monitor command to start execution).
656 `-hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,x-vga=<1|0>]` ::
658 Map host PCI devices into guest.
660 `-hotplug` `string` (default=`network,disk,usb`)::
662 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'.
664 `-hugepages` `(1024 | 2 | any)` ::
666 Enable/disable hugepages memory.
668 `-ide[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<image format>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
670 Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
672 `-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`)::
674 Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.
676 `-kvm` `boolean` (default=`1`)::
678 Enable/disable KVM hardware virtualization.
680 `-localtime` `boolean` ::
682 Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
684 `-lock` `(backup | migrate | rollback | snapshot)` ::
688 `-machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
690 Specific the Qemu machine type.
692 `-memory` `integer (16 - N)` (default=`512`)::
694 Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
696 `-migrate_downtime` `number (0 - N)` (default=`0.1`)::
698 Set maximum tolerated downtime (in seconds) for migrations.
700 `-migrate_speed` `integer (0 - N)` (default=`0`)::
702 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
706 Set a name for the VM. Only used on the configuration web interface.
708 `-net[n]` `[model=]<model> [,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>]` ::
710 Specify network devices.
712 `-numa` `boolean` (default=`0`)::
716 `-numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
720 `-onboot` `boolean` (default=`0`)::
722 Specifies whether a VM will be started during system bootup.
724 `-ostype` `(l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win7 | win8 | wvista | wxp)` ::
726 Specify guest operating system.
728 `-parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` ::
730 Map host parallel devices (n is 0 to 2).
732 `-protection` `boolean` (default=`0`)::
734 Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
736 `-reboot` `boolean` (default=`1`)::
738 Allow reboot. If set to '0' the VM exit on reboot.
740 `-revert` `string` ::
742 Revert a pending change.
744 `-sata[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<image format>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
746 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
748 `-scsi[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<image format>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,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>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
750 Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
752 `-scsihw` `(lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single)` (default=`lsi`)::
754 SCSI controller model
756 `-serial[n]` `(/dev/.+|socket)` ::
758 Create a serial device inside the VM (n is 0 to 3)
760 `-shares` `integer (0 - 50000)` (default=`1000`)::
762 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
764 `-skiplock` `boolean` ::
766 Ignore locks - only root is allowed to use this option.
768 `-smbios1` `[family=<string>] [,manufacturer=<string>] [,product=<string>] [,serial=<string>] [,sku=<string>] [,uuid=<UUID>] [,version=<string>]` ::
770 Specify SMBIOS type 1 fields.
772 `-smp` `integer (1 - N)` (default=`1`)::
774 The number of CPUs. Please use option -sockets instead.
776 `-sockets` `integer (1 - N)` (default=`1`)::
778 The number of CPU sockets.
780 `-startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` (default=`now`)::
782 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'.
784 `-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
786 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.
788 `-tablet` `boolean` (default=`1`)::
790 Enable/disable the USB tablet device.
792 `-tdf` `boolean` (default=`0`)::
794 Enable/disable time drift fix.
796 `-template` `boolean` (default=`0`)::
798 Enable/disable Template.
800 `-unused[n]` `string` ::
802 Reference to unused volumes. This is used internally, and should not be modified manually.
804 `-usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
806 Configure an USB device (n is 0 to 4).
808 `-vcpus` `integer (1 - N)` (default=`0`)::
810 Number of hotplugged vcpus.
812 `-vga` `(cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware)` ::
816 `-virtio[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<image format>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,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>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
818 Use volume as VIRTIO hard disk (n is 0 to 15).
820 `-watchdog` `[[model=]<i6300esb|ib700>] [,action=<reset|shutdown|poweroff|pause|debug|none>]` ::
822 Create a virtual hardware watchdog device.
827 *qm showcmd* `<vmid>`
829 Show command line which is used to start the VM (debug info).
831 `<vmid>` `integer (1 - N)` ::
833 The (unique) ID of the VM.
838 *qm shutdown* `<vmid>` `[OPTIONS]`
840 Shutdown virtual machine. This is similar to pressing the power button on a
841 physical machine.This will send an ACPI event for the guest OS, which
842 should then proceed to a clean shutdown.
844 `<vmid>` `integer (1 - N)` ::
846 The (unique) ID of the VM.
848 `-forceStop` `boolean` (default=`0`)::
850 Make sure the VM stops.
852 `-keepActive` `boolean` (default=`0`)::
854 Do not decativate storage volumes.
856 `-skiplock` `boolean` ::
858 Ignore locks - only root is allowed to use this option.
860 `-timeout` `integer (0 - N)` ::
862 Wait maximal timeout seconds.
866 *qm snapshot* `<vmid> <snapname>` `[OPTIONS]`
870 `<vmid>` `integer (1 - N)` ::
872 The (unique) ID of the VM.
874 `<snapname>` `string` ::
876 The name of the snapshot.
878 `-description` `string` ::
880 A textual description or comment.
882 `-vmstate` `boolean` ::
888 *qm start* `<vmid>` `[OPTIONS]`
890 Start virtual machine.
892 `<vmid>` `integer (1 - N)` ::
894 The (unique) ID of the VM.
896 `-machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
898 Specific the Qemu machine type.
900 `-migratedfrom` `string` ::
902 The cluster node name.
904 `-skiplock` `boolean` ::
906 Ignore locks - only root is allowed to use this option.
908 `-stateuri` `string` ::
910 Some command save/restore state from this location.
915 *qm status* `<vmid>` `[OPTIONS]`
919 `<vmid>` `integer (1 - N)` ::
921 The (unique) ID of the VM.
923 `-verbose` `boolean` ::
925 Verbose output format
930 *qm stop* `<vmid>` `[OPTIONS]`
932 Stop virtual machine. The qemu process will exit immediately. Thisis akin
933 to pulling the power plug of a running computer and may damage the VM data
935 `<vmid>` `integer (1 - N)` ::
937 The (unique) ID of the VM.
939 `-keepActive` `boolean` (default=`0`)::
941 Do not decativate storage volumes.
943 `-migratedfrom` `string` ::
945 The cluster node name.
947 `-skiplock` `boolean` ::
949 Ignore locks - only root is allowed to use this option.
951 `-timeout` `integer (0 - N)` ::
953 Wait maximal timeout seconds.
957 *qm suspend* `<vmid>` `[OPTIONS]`
959 Suspend virtual machine.
961 `<vmid>` `integer (1 - N)` ::
963 The (unique) ID of the VM.
965 `-skiplock` `boolean` ::
967 Ignore locks - only root is allowed to use this option.
971 *qm template* `<vmid>` `[OPTIONS]`
975 `<vmid>` `integer (1 - N)` ::
977 The (unique) ID of the VM.
979 `-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)` ::
981 If you want to convert only 1 disk to base image.
986 *qm terminal* `<vmid>` `[OPTIONS]`
988 Open a terminal using a serial device (The VM need to have a serial device
989 configured, for example 'serial0: socket')
991 `<vmid>` `integer (1 - N)` ::
993 The (unique) ID of the VM.
995 `-iface` `(serial0 | serial1 | serial2 | serial3)` ::
997 Select the serial device. By default we simply use the first suitable device.
1002 *qm unlink* `<vmid> -idlist <string>` `[OPTIONS]`
1004 Unlink/delete disk images.
1006 `<vmid>` `integer (1 - N)` ::
1008 The (unique) ID of the VM.
1010 `-force` `boolean` ::
1012 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.
1014 `-idlist` `string` ::
1016 A list of disk IDs you want to delete.
1021 *qm unlock* `<vmid>`
1025 `<vmid>` `integer (1 - N)` ::
1027 The (unique) ID of the VM.
1031 *qm vncproxy* `<vmid>`
1033 Proxy VM VNC traffic to stdin/stdout
1035 `<vmid>` `integer (1 - N)` ::
1037 The (unique) ID of the VM.
1041 *qm wait* `<vmid>` `[OPTIONS]`
1043 Wait until the VM is stopped.
1045 `<vmid>` `integer (1 - N)` ::
1047 The (unique) ID of the VM.
1049 `-timeout` `integer (1 - N)` ::
1051 Timeout in seconds. Default is to wait forever.