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 `-force` `boolean` ::
138 Allow to overwrite existing VM.
140 NOTE: Requires option(s): `archive`
142 `-freeze` `boolean` ::
144 Freeze CPU at startup (use 'c' monitor command to start execution).
146 `-hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,x-vga=<1|0>]` ::
148 Map host PCI devices into guest.
150 `-hotplug` `string` (default=`network,disk,usb`)::
152 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'.
154 `-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>]` ::
156 Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
158 `-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`)::
160 Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.
162 `-kvm` `boolean` (default=`1`)::
164 Enable/disable KVM hardware virtualization.
166 `-localtime` `boolean` ::
168 Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
170 `-lock` `(backup | migrate | rollback | snapshot)` ::
174 `-machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
176 Specific the Qemu machine type.
178 `-memory` `integer (16 - N)` (default=`512`)::
180 Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
182 `-migrate_downtime` `number (0 - N)` (default=`0.1`)::
184 Set maximum tolerated downtime (in seconds) for migrations.
186 `-migrate_speed` `integer (0 - N)` (default=`0`)::
188 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
192 Set a name for the VM. Only used on the configuration web interface.
194 `-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>]` ::
196 Specify network devices.
198 `-numa` `boolean` (default=`0`)::
202 `-numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
206 `-onboot` `boolean` (default=`0`)::
208 Specifies whether a VM will be started during system bootup.
210 `-ostype` `(l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win7 | win8 | wvista | wxp)` ::
212 Specify guest operating system.
214 `-parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` ::
216 Map host parallel devices (n is 0 to 2).
220 Add the VM to the specified pool.
222 `-protection` `boolean` (default=`0`)::
224 Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
226 `-reboot` `boolean` (default=`1`)::
228 Allow reboot. If set to '0' the VM exit on reboot.
230 `-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>]` ::
232 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
234 `-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>]` ::
236 Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
238 `-scsihw` `(lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single)` (default=`lsi`)::
240 SCSI controller model
242 `-serial[n]` `(/dev/.+|socket)` ::
244 Create a serial device inside the VM (n is 0 to 3)
246 `-shares` `integer (0 - 50000)` (default=`1000`)::
248 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
250 `-smbios1` `[family=<string>] [,manufacturer=<string>] [,product=<string>] [,serial=<string>] [,sku=<string>] [,uuid=<UUID>] [,version=<string>]` ::
252 Specify SMBIOS type 1 fields.
254 `-smp` `integer (1 - N)` (default=`1`)::
256 The number of CPUs. Please use option -sockets instead.
258 `-sockets` `integer (1 - N)` (default=`1`)::
260 The number of CPU sockets.
262 `-startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` (default=`now`)::
264 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'.
266 `-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
268 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.
270 `-storage` `string` ::
274 `-tablet` `boolean` (default=`1`)::
276 Enable/disable the USB tablet device.
278 `-tdf` `boolean` (default=`0`)::
280 Enable/disable time drift fix.
282 `-template` `boolean` (default=`0`)::
284 Enable/disable Template.
286 `-unique` `boolean` ::
288 Assign a unique random ethernet address.
290 NOTE: Requires option(s): `archive`
292 `-unused[n]` `string` ::
294 Reference to unused volumes. This is used internally, and should not be modified manually.
296 `-usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
298 Configure an USB device (n is 0 to 4).
300 `-vcpus` `integer (1 - N)` (default=`0`)::
302 Number of hotplugged vcpus.
304 `-vga` `(cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware)` ::
308 `-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>]` ::
310 Use volume as VIRTIO hard disk (n is 0 to 15).
312 `-watchdog` `[[model=]<i6300esb|ib700>] [,action=<reset|shutdown|poweroff|pause|debug|none>]` ::
314 Create a virtual hardware watchdog device.
318 *qm delsnapshot* `<vmid> <snapname>` `[OPTIONS]`
320 Delete a VM snapshot.
322 `<vmid>` `integer (1 - N)` ::
324 The (unique) ID of the VM.
326 `<snapname>` `string` ::
328 The name of the snapshot.
330 `-force` `boolean` ::
332 For removal from config file, even if removing disk snapshots fails.
336 *qm destroy* `<vmid>` `[OPTIONS]`
338 Destroy the vm (also delete all used/owned volumes).
340 `<vmid>` `integer (1 - N)` ::
342 The (unique) ID of the VM.
344 `-skiplock` `boolean` ::
346 Ignore locks - only root is allowed to use this option.
351 *qm help* `[<cmd>]` `[OPTIONS]`
353 Get help about specified command.
359 `-verbose` `boolean` ::
361 Verbose output format.
366 *qm list* `[OPTIONS]`
368 Virtual machine index (per node).
372 Determine the full status of active VMs.
376 *qm migrate* `<vmid> <target>` `[OPTIONS]`
378 Migrate virtual machine. Creates a new migration task.
380 `<vmid>` `integer (1 - N)` ::
382 The (unique) ID of the VM.
384 `<target>` `string` ::
388 `-force` `boolean` ::
390 Allow to migrate VMs which use local devices. Only root may use this option.
392 `-online` `boolean` ::
394 Use online/live migration.
399 *qm monitor* `<vmid>`
401 Enter Qemu Monitor interface.
403 `<vmid>` `integer (1 - N)` ::
405 The (unique) ID of the VM.
410 *qm move_disk* `<vmid> <disk> <storage>` `[OPTIONS]`
412 Move volume to different storage.
414 `<vmid>` `integer (1 - N)` ::
416 The (unique) ID of the VM.
418 `<disk>` `(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)` ::
420 The disk you want to move.
422 `<storage>` `string` ::
426 `-delete` `boolean` (default=`0`)::
428 Delete the original disk after successful copy. By default the original disk is kept as unused disk.
430 `-digest` `string` ::
432 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
434 `-format` `(qcow2 | raw | vmdk)` ::
443 Used by qmigrate - do not use manually.
448 *qm pending* `<vmid>`
450 Get virtual machine configuration, including pending changes.
452 `<vmid>` `integer (1 - N)` ::
454 The (unique) ID of the VM.
459 *qm rescan* `[OPTIONS]`
461 Rescan all storages and update disk sizes and unused disk images.
463 `-vmid` `integer (1 - N)` ::
465 The (unique) ID of the VM.
470 *qm reset* `<vmid>` `[OPTIONS]`
472 Reset virtual machine.
474 `<vmid>` `integer (1 - N)` ::
476 The (unique) ID of the VM.
478 `-skiplock` `boolean` ::
480 Ignore locks - only root is allowed to use this option.
484 *qm resize* `<vmid> <disk> <size>` `[OPTIONS]`
488 `<vmid>` `integer (1 - N)` ::
490 The (unique) ID of the VM.
492 `<disk>` `(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)` ::
494 The disk you want to resize.
496 `<size>` `\+?\d+(\.\d+)?[KMGT]?` ::
498 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.
500 `-digest` `string` ::
502 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
504 `-skiplock` `boolean` ::
506 Ignore locks - only root is allowed to use this option.
510 *qm resume* `<vmid>` `[OPTIONS]`
512 Resume virtual machine.
514 `<vmid>` `integer (1 - N)` ::
516 The (unique) ID of the VM.
518 `-nocheck` `boolean` ::
520 no description available
522 `-skiplock` `boolean` ::
524 Ignore locks - only root is allowed to use this option.
528 *qm rollback* `<vmid> <snapname>`
530 Rollback VM state to specified snapshot.
532 `<vmid>` `integer (1 - N)` ::
534 The (unique) ID of the VM.
536 `<snapname>` `string` ::
538 The name of the snapshot.
542 *qm sendkey* `<vmid> <key>` `[OPTIONS]`
544 Send key event to virtual machine.
546 `<vmid>` `integer (1 - N)` ::
548 The (unique) ID of the VM.
552 The key (qemu monitor encoding).
554 `-skiplock` `boolean` ::
556 Ignore locks - only root is allowed to use this option.
560 *qm set* `<vmid>` `[OPTIONS]`
562 Set virtual machine options (synchrounous API) - You should consider using
563 the POST method instead for any actions involving hotplug or storage
566 `<vmid>` `integer (1 - N)` ::
568 The (unique) ID of the VM.
570 `-acpi` `boolean` (default=`1`)::
574 `-agent` `boolean` (default=`0`)::
576 Enable/disable Qemu GuestAgent.
580 Arbitrary arguments passed to kvm.
582 `-autostart` `boolean` (default=`0`)::
584 Automatic restart after crash (currently ignored).
586 `-balloon` `integer (0 - N)` ::
588 Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
590 `-bios` `(ovmf | seabios)` (default=`seabios`)::
592 Select BIOS implementation.
594 `-boot` `[acdn]{1,4}` (default=`cdn`)::
596 Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).
598 `-bootdisk` `(ide|sata|scsi|virtio)\d+` ::
600 Enable booting from specified disk.
604 This is an alias for option -ide2
606 `-cores` `integer (1 - N)` (default=`1`)::
608 The number of cores per socket.
610 `-cpu` `[cputype=]<cputype> [,hidden=<1|0>]` ::
614 `-cpulimit` `number (0 - 128)` (default=`0`)::
618 `-cpuunits` `integer (0 - 500000)` (default=`1000`)::
622 `-delete` `string` ::
624 A list of settings you want to delete.
626 `-description` `string` ::
628 Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.
630 `-digest` `string` ::
632 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
634 `-force` `boolean` ::
636 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.
638 NOTE: Requires option(s): `delete`
640 `-freeze` `boolean` ::
642 Freeze CPU at startup (use 'c' monitor command to start execution).
644 `-hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,x-vga=<1|0>]` ::
646 Map host PCI devices into guest.
648 `-hotplug` `string` (default=`network,disk,usb`)::
650 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'.
652 `-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>]` ::
654 Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
656 `-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`)::
658 Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.
660 `-kvm` `boolean` (default=`1`)::
662 Enable/disable KVM hardware virtualization.
664 `-localtime` `boolean` ::
666 Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
668 `-lock` `(backup | migrate | rollback | snapshot)` ::
672 `-machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
674 Specific the Qemu machine type.
676 `-memory` `integer (16 - N)` (default=`512`)::
678 Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
680 `-migrate_downtime` `number (0 - N)` (default=`0.1`)::
682 Set maximum tolerated downtime (in seconds) for migrations.
684 `-migrate_speed` `integer (0 - N)` (default=`0`)::
686 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
690 Set a name for the VM. Only used on the configuration web interface.
692 `-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>]` ::
694 Specify network devices.
696 `-numa` `boolean` (default=`0`)::
700 `-numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
704 `-onboot` `boolean` (default=`0`)::
706 Specifies whether a VM will be started during system bootup.
708 `-ostype` `(l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win7 | win8 | wvista | wxp)` ::
710 Specify guest operating system.
712 `-parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` ::
714 Map host parallel devices (n is 0 to 2).
716 `-protection` `boolean` (default=`0`)::
718 Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
720 `-reboot` `boolean` (default=`1`)::
722 Allow reboot. If set to '0' the VM exit on reboot.
724 `-revert` `string` ::
726 Revert a pending change.
728 `-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>]` ::
730 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
732 `-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>]` ::
734 Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
736 `-scsihw` `(lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single)` (default=`lsi`)::
738 SCSI controller model
740 `-serial[n]` `(/dev/.+|socket)` ::
742 Create a serial device inside the VM (n is 0 to 3)
744 `-shares` `integer (0 - 50000)` (default=`1000`)::
746 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
748 `-skiplock` `boolean` ::
750 Ignore locks - only root is allowed to use this option.
752 `-smbios1` `[family=<string>] [,manufacturer=<string>] [,product=<string>] [,serial=<string>] [,sku=<string>] [,uuid=<UUID>] [,version=<string>]` ::
754 Specify SMBIOS type 1 fields.
756 `-smp` `integer (1 - N)` (default=`1`)::
758 The number of CPUs. Please use option -sockets instead.
760 `-sockets` `integer (1 - N)` (default=`1`)::
762 The number of CPU sockets.
764 `-startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` (default=`now`)::
766 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'.
768 `-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
770 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.
772 `-tablet` `boolean` (default=`1`)::
774 Enable/disable the USB tablet device.
776 `-tdf` `boolean` (default=`0`)::
778 Enable/disable time drift fix.
780 `-template` `boolean` (default=`0`)::
782 Enable/disable Template.
784 `-unused[n]` `string` ::
786 Reference to unused volumes. This is used internally, and should not be modified manually.
788 `-usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
790 Configure an USB device (n is 0 to 4).
792 `-vcpus` `integer (1 - N)` (default=`0`)::
794 Number of hotplugged vcpus.
796 `-vga` `(cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware)` ::
800 `-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>]` ::
802 Use volume as VIRTIO hard disk (n is 0 to 15).
804 `-watchdog` `[[model=]<i6300esb|ib700>] [,action=<reset|shutdown|poweroff|pause|debug|none>]` ::
806 Create a virtual hardware watchdog device.
811 *qm showcmd* `<vmid>`
813 Show command line which is used to start the VM (debug info).
815 `<vmid>` `integer (1 - N)` ::
817 The (unique) ID of the VM.
822 *qm shutdown* `<vmid>` `[OPTIONS]`
824 Shutdown virtual machine. This is similar to pressing the power button on a
825 physical machine.This will send an ACPI event for the guest OS, which
826 should then proceed to a clean shutdown.
828 `<vmid>` `integer (1 - N)` ::
830 The (unique) ID of the VM.
832 `-forceStop` `boolean` (default=`0`)::
834 Make sure the VM stops.
836 `-keepActive` `boolean` (default=`0`)::
838 Do not decativate storage volumes.
840 `-skiplock` `boolean` ::
842 Ignore locks - only root is allowed to use this option.
844 `-timeout` `integer (0 - N)` ::
846 Wait maximal timeout seconds.
850 *qm snapshot* `<vmid> <snapname>` `[OPTIONS]`
854 `<vmid>` `integer (1 - N)` ::
856 The (unique) ID of the VM.
858 `<snapname>` `string` ::
860 The name of the snapshot.
862 `-description` `string` ::
864 A textual description or comment.
866 `-vmstate` `boolean` ::
872 *qm start* `<vmid>` `[OPTIONS]`
874 Start virtual machine.
876 `<vmid>` `integer (1 - N)` ::
878 The (unique) ID of the VM.
880 `-machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
882 Specific the Qemu machine type.
884 `-migratedfrom` `string` ::
886 The cluster node name.
888 `-skiplock` `boolean` ::
890 Ignore locks - only root is allowed to use this option.
892 `-stateuri` `string` ::
894 Some command save/restore state from this location.
899 *qm status* `<vmid>` `[OPTIONS]`
903 `<vmid>` `integer (1 - N)` ::
905 The (unique) ID of the VM.
907 `-verbose` `boolean` ::
909 Verbose output format
914 *qm stop* `<vmid>` `[OPTIONS]`
916 Stop virtual machine. The qemu process will exit immediately. Thisis akin
917 to pulling the power plug of a running computer and may damage the VM data
919 `<vmid>` `integer (1 - N)` ::
921 The (unique) ID of the VM.
923 `-keepActive` `boolean` (default=`0`)::
925 Do not decativate storage volumes.
927 `-migratedfrom` `string` ::
929 The cluster node name.
931 `-skiplock` `boolean` ::
933 Ignore locks - only root is allowed to use this option.
935 `-timeout` `integer (0 - N)` ::
937 Wait maximal timeout seconds.
941 *qm suspend* `<vmid>` `[OPTIONS]`
943 Suspend virtual machine.
945 `<vmid>` `integer (1 - N)` ::
947 The (unique) ID of the VM.
949 `-skiplock` `boolean` ::
951 Ignore locks - only root is allowed to use this option.
955 *qm template* `<vmid>` `[OPTIONS]`
959 `<vmid>` `integer (1 - N)` ::
961 The (unique) ID of the VM.
963 `-disk` `(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)` ::
965 If you want to convert only 1 disk to base image.
970 *qm terminal* `<vmid>` `[OPTIONS]`
972 Open a terminal using a serial device (The VM need to have a serial device
973 configured, for example 'serial0: socket')
975 `<vmid>` `integer (1 - N)` ::
977 The (unique) ID of the VM.
979 `-iface` `(serial0 | serial1 | serial2 | serial3)` ::
981 Select the serial device. By default we simply use the first suitable device.
986 *qm unlink* `<vmid> -idlist <string>` `[OPTIONS]`
988 Unlink/delete disk images.
990 `<vmid>` `integer (1 - N)` ::
992 The (unique) ID of the VM.
994 `-force` `boolean` ::
996 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.
998 `-idlist` `string` ::
1000 A list of disk IDs you want to delete.
1005 *qm unlock* `<vmid>`
1009 `<vmid>` `integer (1 - N)` ::
1011 The (unique) ID of the VM.
1015 *qm vncproxy* `<vmid>`
1017 Proxy VM VNC traffic to stdin/stdout
1019 `<vmid>` `integer (1 - N)` ::
1021 The (unique) ID of the VM.
1025 *qm wait* `<vmid>` `[OPTIONS]`
1027 Wait until the VM is stopped.
1029 `<vmid>` `integer (1 - N)` ::
1031 The (unique) ID of the VM.
1033 `-timeout` `integer (1 - N)` ::
1035 Timeout in seconds. Default is to wait forever.