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`
47 `-target` `<string>` ::
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.
112 `-cdrom` `<volume>` ::
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=]<enum> [,hidden=<1|0>]` ::
124 `-cpulimit` `<number> (0 - 128)` ('default =' `0`)::
128 `-cpuunits` `<integer> (0 - 500000)` ('default =' `1024`)::
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=<enum>] [,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_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_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_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,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=<enum>]` ::
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.
198 `-name` `<string>` ::
200 Set a name for the VM. Only used on the configuration web interface.
202 `-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>]` ::
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).
226 `-pool` `<string>` ::
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_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_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_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,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=<enum>]` ::
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_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_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_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,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=<enum>]` ::
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_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_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_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,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=<enum>]` ::
318 Use volume as VIRTIO hard disk (n is 0 to 15).
320 `-watchdog` `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::
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.
363 `<cmd>`: `<string>` ::
367 `-verbose` `<boolean>` ::
369 Verbose output format.
374 *qm list* `[OPTIONS]`
376 Virtual machine index (per node).
378 `-full` `<boolean>` ::
380 Determine the full status of active VMs.
384 *qm listsnapshot* `<vmid>`
388 `<vmid>`: `<integer> (1 - N)` ::
390 The (unique) ID of the VM.
394 *qm migrate* `<vmid> <target>` `[OPTIONS]`
396 Migrate virtual machine. Creates a new migration task.
398 `<vmid>`: `<integer> (1 - N)` ::
400 The (unique) ID of the VM.
402 `<target>`: `<string>` ::
406 `-force` `<boolean>` ::
408 Allow to migrate VMs which use local devices. Only root may use this option.
410 `-migration_network` `<string>` ::
412 CIDR of the (sub) network that is used for migration.
414 `-migration_type` `<insecure | secure>` ::
416 Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.
418 `-online` `<boolean>` ::
420 Use online/live migration.
425 *qm monitor* `<vmid>`
427 Enter Qemu Monitor interface.
429 `<vmid>`: `<integer> (1 - N)` ::
431 The (unique) ID of the VM.
436 *qm move_disk* `<vmid> <disk> <storage>` `[OPTIONS]`
438 Move volume to different storage.
440 `<vmid>`: `<integer> (1 - N)` ::
442 The (unique) ID of the VM.
444 `<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>` ::
446 The disk you want to move.
448 `<storage>`: `<string>` ::
452 `-delete` `<boolean>` ('default =' `0`)::
454 Delete the original disk after successful copy. By default the original disk is kept as unused disk.
456 `-digest` `<string>` ::
458 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
460 `-format` `<qcow2 | raw | vmdk>` ::
469 Used by qmigrate - do not use manually.
474 *qm pending* `<vmid>`
476 Get virtual machine configuration, including pending changes.
478 `<vmid>`: `<integer> (1 - N)` ::
480 The (unique) ID of the VM.
485 *qm rescan* `[OPTIONS]`
487 Rescan all storages and update disk sizes and unused disk images.
489 `-vmid` `<integer> (1 - N)` ::
491 The (unique) ID of the VM.
496 *qm reset* `<vmid>` `[OPTIONS]`
498 Reset virtual machine.
500 `<vmid>`: `<integer> (1 - N)` ::
502 The (unique) ID of the VM.
504 `-skiplock` `<boolean>` ::
506 Ignore locks - only root is allowed to use this option.
510 *qm resize* `<vmid> <disk> <size>` `[OPTIONS]`
514 `<vmid>`: `<integer> (1 - N)` ::
516 The (unique) ID of the VM.
518 `<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>` ::
520 The disk you want to resize.
522 `<size>`: `\+?\d+(\.\d+)?[KMGT]?` ::
524 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.
526 `-digest` `<string>` ::
528 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
530 `-skiplock` `<boolean>` ::
532 Ignore locks - only root is allowed to use this option.
536 *qm resume* `<vmid>` `[OPTIONS]`
538 Resume virtual machine.
540 `<vmid>`: `<integer> (1 - N)` ::
542 The (unique) ID of the VM.
544 `-nocheck` `<boolean>` ::
546 no description available
548 `-skiplock` `<boolean>` ::
550 Ignore locks - only root is allowed to use this option.
554 *qm rollback* `<vmid> <snapname>`
556 Rollback VM state to specified snapshot.
558 `<vmid>`: `<integer> (1 - N)` ::
560 The (unique) ID of the VM.
562 `<snapname>`: `<string>` ::
564 The name of the snapshot.
568 *qm sendkey* `<vmid> <key>` `[OPTIONS]`
570 Send key event to virtual machine.
572 `<vmid>`: `<integer> (1 - N)` ::
574 The (unique) ID of the VM.
576 `<key>`: `<string>` ::
578 The key (qemu monitor encoding).
580 `-skiplock` `<boolean>` ::
582 Ignore locks - only root is allowed to use this option.
586 *qm set* `<vmid>` `[OPTIONS]`
588 Set virtual machine options (synchrounous API) - You should consider using
589 the POST method instead for any actions involving hotplug or storage
592 `<vmid>`: `<integer> (1 - N)` ::
594 The (unique) ID of the VM.
596 `-acpi` `<boolean>` ('default =' `1`)::
600 `-agent` `<boolean>` ('default =' `0`)::
602 Enable/disable Qemu GuestAgent.
604 `-args` `<string>` ::
606 Arbitrary arguments passed to kvm.
608 `-autostart` `<boolean>` ('default =' `0`)::
610 Automatic restart after crash (currently ignored).
612 `-balloon` `<integer> (0 - N)` ::
614 Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
616 `-bios` `<ovmf | seabios>` ('default =' `seabios`)::
618 Select BIOS implementation.
620 `-boot` `[acdn]{1,4}` ('default =' `cdn`)::
622 Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).
624 `-bootdisk` `(ide|sata|scsi|virtio)\d+` ::
626 Enable booting from specified disk.
628 `-cdrom` `<volume>` ::
630 This is an alias for option -ide2
632 `-cores` `<integer> (1 - N)` ('default =' `1`)::
634 The number of cores per socket.
636 `-cpu` `[cputype=]<enum> [,hidden=<1|0>]` ::
640 `-cpulimit` `<number> (0 - 128)` ('default =' `0`)::
644 `-cpuunits` `<integer> (0 - 500000)` ('default =' `1024`)::
648 `-delete` `<string>` ::
650 A list of settings you want to delete.
652 `-description` `<string>` ::
654 Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.
656 `-digest` `<string>` ::
658 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
660 `-efidisk0` `[file=]<volume> [,format=<enum>] [,size=<DiskSize>]` ::
662 Configure a Disk for storing EFI vars
664 `-force` `<boolean>` ::
666 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.
668 NOTE: Requires option(s): `delete`
670 `-freeze` `<boolean>` ::
672 Freeze CPU at startup (use 'c' monitor command to start execution).
674 `-hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,x-vga=<1|0>]` ::
676 Map host PCI devices into guest.
678 `-hotplug` `<string>` ('default =' `network,disk,usb`)::
680 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'.
682 `-hugepages` `<1024 | 2 | any>` ::
684 Enable/disable hugepages memory.
686 `-ide[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_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_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,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=<enum>]` ::
688 Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
690 `-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`)::
692 Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.
694 `-kvm` `<boolean>` ('default =' `1`)::
696 Enable/disable KVM hardware virtualization.
698 `-localtime` `<boolean>` ::
700 Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
702 `-lock` `<backup | migrate | rollback | snapshot>` ::
706 `-machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
708 Specific the Qemu machine type.
710 `-memory` `<integer> (16 - N)` ('default =' `512`)::
712 Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
714 `-migrate_downtime` `<number> (0 - N)` ('default =' `0.1`)::
716 Set maximum tolerated downtime (in seconds) for migrations.
718 `-migrate_speed` `<integer> (0 - N)` ('default =' `0`)::
720 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
722 `-name` `<string>` ::
724 Set a name for the VM. Only used on the configuration web interface.
726 `-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>]` ::
728 Specify network devices.
730 `-numa` `<boolean>` ('default =' `0`)::
734 `-numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
738 `-onboot` `<boolean>` ('default =' `0`)::
740 Specifies whether a VM will be started during system bootup.
742 `-ostype` `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win7 | win8 | wvista | wxp>` ::
744 Specify guest operating system.
746 `-parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` ::
748 Map host parallel devices (n is 0 to 2).
750 `-protection` `<boolean>` ('default =' `0`)::
752 Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
754 `-reboot` `<boolean>` ('default =' `1`)::
756 Allow reboot. If set to '0' the VM exit on reboot.
758 `-revert` `<string>` ::
760 Revert a pending change.
762 `-sata[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_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_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,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=<enum>]` ::
764 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
766 `-scsi[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_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_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,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=<enum>]` ::
768 Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
770 `-scsihw` `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
772 SCSI controller model
774 `-serial[n]` `(/dev/.+|socket)` ::
776 Create a serial device inside the VM (n is 0 to 3)
778 `-shares` `<integer> (0 - 50000)` ('default =' `1000`)::
780 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
782 `-skiplock` `<boolean>` ::
784 Ignore locks - only root is allowed to use this option.
786 `-smbios1` `[family=<string>] [,manufacturer=<string>] [,product=<string>] [,serial=<string>] [,sku=<string>] [,uuid=<UUID>] [,version=<string>]` ::
788 Specify SMBIOS type 1 fields.
790 `-smp` `<integer> (1 - N)` ('default =' `1`)::
792 The number of CPUs. Please use option -sockets instead.
794 `-sockets` `<integer> (1 - N)` ('default =' `1`)::
796 The number of CPU sockets.
798 `-startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
800 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'.
802 `-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
804 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.
806 `-tablet` `<boolean>` ('default =' `1`)::
808 Enable/disable the USB tablet device.
810 `-tdf` `<boolean>` ('default =' `0`)::
812 Enable/disable time drift fix.
814 `-template` `<boolean>` ('default =' `0`)::
816 Enable/disable Template.
818 `-unused[n]` `<string>` ::
820 Reference to unused volumes. This is used internally, and should not be modified manually.
822 `-usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
824 Configure an USB device (n is 0 to 4).
826 `-vcpus` `<integer> (1 - N)` ('default =' `0`)::
828 Number of hotplugged vcpus.
830 `-vga` `<cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware>` ::
834 `-virtio[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_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_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,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=<enum>]` ::
836 Use volume as VIRTIO hard disk (n is 0 to 15).
838 `-watchdog` `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::
840 Create a virtual hardware watchdog device.
845 *qm showcmd* `<vmid>`
847 Show command line which is used to start the VM (debug info).
849 `<vmid>`: `<integer> (1 - N)` ::
851 The (unique) ID of the VM.
856 *qm shutdown* `<vmid>` `[OPTIONS]`
858 Shutdown virtual machine. This is similar to pressing the power button on a
859 physical machine.This will send an ACPI event for the guest OS, which
860 should then proceed to a clean shutdown.
862 `<vmid>`: `<integer> (1 - N)` ::
864 The (unique) ID of the VM.
866 `-forceStop` `<boolean>` ('default =' `0`)::
868 Make sure the VM stops.
870 `-keepActive` `<boolean>` ('default =' `0`)::
872 Do not deactivate storage volumes.
874 `-skiplock` `<boolean>` ::
876 Ignore locks - only root is allowed to use this option.
878 `-timeout` `<integer> (0 - N)` ::
880 Wait maximal timeout seconds.
884 *qm snapshot* `<vmid> <snapname>` `[OPTIONS]`
888 `<vmid>`: `<integer> (1 - N)` ::
890 The (unique) ID of the VM.
892 `<snapname>`: `<string>` ::
894 The name of the snapshot.
896 `-description` `<string>` ::
898 A textual description or comment.
900 `-vmstate` `<boolean>` ::
906 *qm start* `<vmid>` `[OPTIONS]`
908 Start virtual machine.
910 `<vmid>`: `<integer> (1 - N)` ::
912 The (unique) ID of the VM.
914 `-machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
916 Specific the Qemu machine type.
918 `-migratedfrom` `<string>` ::
920 The cluster node name.
922 `-migration_network` `<string>` ::
924 CIDR of the (sub) network that is used for migration.
926 `-migration_type` `<insecure | secure>` ::
928 Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.
930 `-skiplock` `<boolean>` ::
932 Ignore locks - only root is allowed to use this option.
934 `-stateuri` `<string>` ::
936 Some command save/restore state from this location.
941 *qm status* `<vmid>` `[OPTIONS]`
945 `<vmid>`: `<integer> (1 - N)` ::
947 The (unique) ID of the VM.
949 `-verbose` `<boolean>` ::
951 Verbose output format
956 *qm stop* `<vmid>` `[OPTIONS]`
958 Stop virtual machine. The qemu process will exit immediately. Thisis akin
959 to pulling the power plug of a running computer and may damage the VM data
961 `<vmid>`: `<integer> (1 - N)` ::
963 The (unique) ID of the VM.
965 `-keepActive` `<boolean>` ('default =' `0`)::
967 Do not deactivate storage volumes.
969 `-migratedfrom` `<string>` ::
971 The cluster node name.
973 `-skiplock` `<boolean>` ::
975 Ignore locks - only root is allowed to use this option.
977 `-timeout` `<integer> (0 - N)` ::
979 Wait maximal timeout seconds.
983 *qm suspend* `<vmid>` `[OPTIONS]`
985 Suspend virtual machine.
987 `<vmid>`: `<integer> (1 - N)` ::
989 The (unique) ID of the VM.
991 `-skiplock` `<boolean>` ::
993 Ignore locks - only root is allowed to use this option.
997 *qm template* `<vmid>` `[OPTIONS]`
1001 `<vmid>`: `<integer> (1 - N)` ::
1003 The (unique) ID of the VM.
1005 `-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>` ::
1007 If you want to convert only 1 disk to base image.
1012 *qm terminal* `<vmid>` `[OPTIONS]`
1014 Open a terminal using a serial device (The VM need to have a serial device
1015 configured, for example 'serial0: socket')
1017 `<vmid>`: `<integer> (1 - N)` ::
1019 The (unique) ID of the VM.
1021 `-iface` `<serial0 | serial1 | serial2 | serial3>` ::
1023 Select the serial device. By default we simply use the first suitable device.
1028 *qm unlink* `<vmid> -idlist <string>` `[OPTIONS]`
1030 Unlink/delete disk images.
1032 `<vmid>`: `<integer> (1 - N)` ::
1034 The (unique) ID of the VM.
1036 `-force` `<boolean>` ::
1038 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.
1040 `-idlist` `<string>` ::
1042 A list of disk IDs you want to delete.
1047 *qm unlock* `<vmid>`
1051 `<vmid>`: `<integer> (1 - N)` ::
1053 The (unique) ID of the VM.
1057 *qm vncproxy* `<vmid>`
1059 Proxy VM VNC traffic to stdin/stdout
1061 `<vmid>`: `<integer> (1 - N)` ::
1063 The (unique) ID of the VM.
1067 *qm wait* `<vmid>` `[OPTIONS]`
1069 Wait until the VM is stopped.
1071 `<vmid>`: `<integer> (1 - N)` ::
1073 The (unique) ID of the VM.
1075 `-timeout` `<integer> (1 - N)` ::
1077 Timeout in seconds. Default is to wait forever.