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
28 VM. For VM templates, we try to create a linked clone by default.
32 Set a name for the new VM.
36 Add the new VM to the specified pool.
38 `-snapname` `string` ::
40 The name of the snapshot.
42 `-storage` `string` ::
44 Target storage for full clone.
46 NOTE: Requires option(s): `full`
50 Target node. Only allowed if the original VM is on shared storage.
54 *qm config* `<vmid>` `[OPTIONS]`
56 Get current virtual machine configuration. This does not include pending
57 configuration changes (see 'pending' API).
59 `<vmid>` `integer (1 - N)` ::
61 The (unique) ID of the VM.
63 `-current` `boolean` (default=`0`)::
65 Get current values (instead of pending values).
69 *qm create* `<vmid>` `[OPTIONS]`
71 Create or restore a virtual machine.
73 `<vmid>` `integer (1 - N)` ::
75 The (unique) ID of the VM.
77 `-acpi` `boolean` (default=`1`)::
81 `-agent` `boolean` (default=`0`)::
83 Enable/disable Qemu GuestAgent.
85 `-archive` `string` ::
91 Arbitrary arguments passed to kvm, for example:
93 args: -no-reboot -no-hpet
95 NOTE: this option is for experts only.
97 `-autostart` `boolean` (default=`0`)::
99 Automatic restart after crash (currently ignored).
101 `-balloon` `integer (0 - N)` ::
103 Amount of target RAM for the VM in MB. Using zero disables the ballon
106 `-bios` `(ovmf | seabios)` (default=`seabios`)::
108 Select BIOS implementation.
110 `-boot` `[acdn]{1,4}` (default=`cdn`)::
112 Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).
114 `-bootdisk` `(ide|sata|scsi|virtio)\d+` ::
116 Enable booting from specified disk.
120 This is an alias for option -ide2
122 `-cores` `integer (1 - N)` (default=`1`)::
124 The number of cores per socket.
126 `-cpu` `[cputype=]<cputype> [,hidden=<1|0>]` ::
130 `-cpulimit` `number (0 - 128)` (default=`0`)::
134 NOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0'
135 indicates no CPU limit.
137 `-cpuunits` `integer (0 - 500000)` (default=`1000`)::
139 CPU weight for a VM. Argument is used in the kernel fair scheduler. The
140 larger the number is, the more CPU time this VM gets. Number is relative to
141 weights of all the other running VMs.
143 NOTE: You can disable fair-scheduler configuration by setting this to 0.
145 `-description` `string` ::
147 Description for the VM. Only used on the configuration web interface. This
148 is saved as comment inside the configuration file.
150 `-force` `boolean` ::
152 Allow to overwrite existing VM.
154 NOTE: Requires option(s): `archive`
156 `-freeze` `boolean` ::
158 Freeze CPU at startup (use 'c' monitor command to start execution).
160 `-hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,x-vga=<1|0>]` ::
162 Map host pci devices. HOSTPCIDEVICE syntax is:
164 'bus:dev.func' (hexadecimal numbers)
166 You can us the 'lspci' command to list existing pci devices.
168 The 'rombar' option determines whether or not the device's ROM will be
169 visible in the guest's memory map (default is 'on').
171 NOTE: This option allows direct access to host hardware. So it is no longer
172 possible to migrate such machines - use with special care.
174 Experimental: user reported problems with this option.
176 `-hotplug` `string` (default=`network,disk,usb`)::
178 Selectively enable hotplug features. This is a comma separated list of
179 hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to
180 disable hotplug completely. Value '1' is an alias for the default
183 `-ide[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<on|off>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<count>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<drive format>] [,heads=<count>] [,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=<count>] [,serial=<serial>] [,snapshot=<on|off>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
185 Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
187 `-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`)::
189 Keybord layout for vnc server. Default is read from the datacenter
192 `-kvm` `boolean` (default=`1`)::
194 Enable/disable KVM hardware virtualization.
196 `-localtime` `boolean` ::
198 Set the real time clock to local time. This is enabled by default if ostype
199 indicates a Microsoft OS.
201 `-lock` `(backup | migrate | rollback | snapshot)` ::
205 `-machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
207 Specific the Qemu machine type.
209 `-memory` `integer (16 - N)` (default=`512`)::
211 Amount of RAM for the VM in MB. This is the maximum available memory when
212 you use the balloon device.
214 `-migrate_downtime` `number (0 - N)` (default=`0.1`)::
216 Set maximum tolerated downtime (in seconds) for migrations.
218 `-migrate_speed` `integer (0 - N)` (default=`0`)::
220 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
224 Set a name for the VM. Only used on the configuration web interface.
226 `-net[n]` `string` ::
228 Specify network devices.
230 MODEL is one of: e1000 e1000-82540em e1000-82544gc e1000-82545em i82551
231 i82557b i82559er ne2k_isa ne2k_pci pcnet rtl8139 virtio vmxnet3
233 XX:XX:XX:XX:XX:XX should be an unique MAC address. This is
234 automatically generated if not specified.
236 The bridge parameter can be used to automatically add the interface to a
237 bridge device. The Proxmox VE standard bridge is called 'vmbr0'.
239 Option 'rate' is used to limit traffic bandwidth from and to this
240 interface. It is specified as floating point number, unit is 'Megabytes per
243 If you specify no bridge, we create a kvm 'user' (NATed) network device,
244 which provides DHCP and DNS services. The following addresses are used:
250 The DHCP server assign addresses to the guest starting from 10.0.2.15.
252 `-numa` `boolean` (default=`0`)::
256 `-numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<mb>] [,policy=<preferred|bind|interleave>]` ::
260 `-onboot` `boolean` (default=`0`)::
262 Specifies whether a VM will be started during system bootup.
264 `-ostype` `(l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win7 | win8 | wvista | wxp)` ::
266 Used to enable special optimization/features for specific
269 other => unspecified OS
270 wxp => Microsoft Windows XP
271 w2k => Microsoft Windows 2000
272 w2k3 => Microsoft Windows 2003
273 w2k8 => Microsoft Windows 2008
274 wvista => Microsoft Windows Vista
275 win7 => Microsoft Windows 7
276 win8 => Microsoft Windows 8/2012
277 l24 => Linux 2.4 Kernel
278 l26 => Linux 2.6/3.X Kernel
279 solaris => solaris/opensolaris/openindiania kernel
281 other|l24|l26|solaris ... no special behaviour
282 wxp|w2k|w2k3|w2k8|wvista|win7|win8 ... use --localtime switch
284 `-parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` ::
286 Map host parallel devices (n is 0 to 2).
288 NOTE: This option allows direct access to host hardware. So it is no longer
289 possible to migrate such machines - use with special care.
291 Experimental: user reported problems with this option.
295 Add the VM to the specified pool.
297 `-protection` `boolean` (default=`0`)::
299 Sets the protection flag of the VM. This will prevent the remove operation.
301 `-reboot` `boolean` (default=`1`)::
303 Allow reboot. If set to '0' the VM exit on reboot.
305 `-sata[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<on|off>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<count>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<drive format>] [,heads=<count>] [,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=<count>] [,serial=<serial>] [,snapshot=<on|off>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
307 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
309 `-scsi[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<on|off>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<count>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<drive format>] [,heads=<count>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iothread=<off|on>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,queues=<nbqueues>] [,secs=<count>] [,serial=<serial>] [,snapshot=<on|off>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
311 Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
313 `-scsihw` `(lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single)` (default=`lsi`)::
315 scsi controller model
317 `-serial[n]` `(/dev/.+|socket)` ::
319 Create a serial device inside the VM (n is 0 to 3), and pass through a host
320 serial device (i.e. /dev/ttyS0), or create a unix socket on the host side
321 (use 'qm terminal' to open a terminal connection).
323 NOTE: If you pass through a host serial device, it is no longer possible to
324 migrate such machines - use with special care.
326 Experimental: user reported problems with this option.
328 `-shares` `integer (0 - 50000)` (default=`1000`)::
330 Amount of memory shares for auto-ballooning. The larger the number is, the
331 more memory this VM gets. Number is relative to weights of all other
332 running VMs. Using zero disables auto-ballooning
334 `-smbios[n]` `[family=<str>] [,manufacturer=<name>] [,product=<name>] [,serial=<str>] [,sku=<str>] [,uuid=<UUID>] [,version=<str>]` ::
336 Specify SMBIOS type 1 fields.
338 `-smp` `integer (1 - N)` (default=`1`)::
340 The number of CPUs. Please use option -sockets instead.
342 `-sockets` `integer (1 - N)` (default=`1`)::
344 The number of CPU sockets.
346 `-startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` (default=`now`)::
348 Set the initial date of the real time clock. Valid format for date are:
349 'now' or '2006-06-17T16:01:21' or '2006-06-17'.
351 `-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
353 Startup and shutdown behavior. Order is a non-negative number defining the
354 general startup order. Shutdown in done with reverse ordering. Additionally
355 you can set the 'up' or 'down' delay in seconds, which specifies a delay to
356 wait before the next VM is started or stopped.
358 `-storage` `string` ::
362 `-tablet` `boolean` (default=`1`)::
364 Enable/disable the USB tablet device. This device is usually needed to
365 allow absolute mouse positioning with VNC. Else the mouse runs out of sync
366 with normal VNC clients. If you're running lots of console-only guests on
367 one host, you may consider disabling this to save some context switches.
368 This is turned off by default if you use spice (-vga=qxl).
370 `-tdf` `boolean` (default=`0`)::
372 Enable/disable time drift fix.
374 `-template` `boolean` (default=`0`)::
376 Enable/disable Template.
378 `-unique` `boolean` ::
380 Assign a unique random ethernet address.
382 NOTE: Requires option(s): `archive`
384 `-unused[n]` `string` ::
386 Reference to unused volumes.
388 `-usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<yes|no>]` ::
390 Configure an USB device (n is 0 to 4). This can be used to
391 pass-through usb devices to the guest. HOSTUSBDEVICE syntax is:
393 'bus-port(.port)*' (decimal numbers) or
394 'vendor_id:product_id' (hexadeciaml numbers) or
397 You can use the 'lsusb -t' command to list existing usb devices.
399 NOTE: This option allows direct access to host hardware. So it is no longer
400 possible to migrate such machines - use with special care.
402 The value 'spice' can be used to add a usb redirection devices for spice.
404 The 'usb3' option determines whether the device is a USB3 device or not
405 (this does currently not work reliably with spice redirection and is then
408 `-vcpus` `integer (1 - N)` (default=`0`)::
410 Number of hotplugged vcpus.
412 `-vga` `(cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware)` ::
414 Select the VGA type. If you want to use high resolution modes (>=
415 1280x1024x16) then you should use the options 'std' or 'vmware'. Default is
416 'std' for win8/win7/w2k8, and 'cirrus' for other OS types. The 'qxl' option
417 enables the SPICE display sever. For win* OS you can select how many
418 independent displays you want, Linux guests can add displays them self. You
419 can also run without any graphic card, using a serial device as terminal.
421 `-virtio[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<on|off>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<count>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<drive format>] [,heads=<count>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iothread=<off|on>] [,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=<count>] [,serial=<serial>] [,snapshot=<on|off>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
423 Use volume as VIRTIO hard disk (n is 0 to 15).
425 `-watchdog` `[action=<reset|shutdown|poweroff|pause|debug|none>] [,[model=]<i6300esb|ib700>]` ::
427 Create a virtual hardware watchdog device. Once enabled (by a guest
428 action), the watchdog must be periodically polled by an agent inside the
429 guest or else the watchdog will reset the guest (or execute the respective
434 *qm delsnapshot* `<vmid> <snapname>` `[OPTIONS]`
436 Delete a VM snapshot.
438 `<vmid>` `integer (1 - N)` ::
440 The (unique) ID of the VM.
442 `<snapname>` `string` ::
444 The name of the snapshot.
446 `-force` `boolean` ::
448 For removal from config file, even if removing disk snapshots fails.
452 *qm destroy* `<vmid>` `[OPTIONS]`
454 Destroy the vm (also delete all used/owned volumes).
456 `<vmid>` `integer (1 - N)` ::
458 The (unique) ID of the VM.
460 `-skiplock` `boolean` ::
462 Ignore locks - only root is allowed to use this option.
467 *qm help* `[<cmd>]` `[OPTIONS]`
469 Get help about specified command.
475 `-verbose` `boolean` ::
477 Verbose output format.
482 *qm list* `[OPTIONS]`
484 Virtual machine index (per node).
488 Determine the full status of active VMs.
492 *qm migrate* `<vmid> <target>` `[OPTIONS]`
494 Migrate virtual machine. Creates a new migration task.
496 `<vmid>` `integer (1 - N)` ::
498 The (unique) ID of the VM.
500 `<target>` `string` ::
504 `-force` `boolean` ::
506 Allow to migrate VMs which use local devices. Only root may use this
509 `-online` `boolean` ::
511 Use online/live migration.
516 *qm monitor* `<vmid>`
518 Enter Qemu Monitor interface.
520 `<vmid>` `integer (1 - N)` ::
522 The (unique) ID of the VM.
527 *qm move_disk* `<vmid> <disk> <storage>` `[OPTIONS]`
529 Move volume to different storage.
531 `<vmid>` `integer (1 - N)` ::
533 The (unique) ID of the VM.
535 `<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)` ::
537 The disk you want to move.
539 `<storage>` `string` ::
543 `-delete` `boolean` (default=`0`)::
545 Delete the original disk after successful copy. By default the original
546 disk is kept as unused disk.
548 `-digest` `string` ::
550 Prevent changes if current configuration file has different SHA1 digest.
551 This can be used to prevent concurrent modifications.
553 `-format` `(qcow2 | raw | vmdk)` ::
562 Used by qmigrate - do not use manually.
567 *qm pending* `<vmid>`
569 Get virtual machine configuration, including pending changes.
571 `<vmid>` `integer (1 - N)` ::
573 The (unique) ID of the VM.
578 *qm rescan* `[OPTIONS]`
580 Rescan all storages and update disk sizes and unused disk images.
582 `-vmid` `integer (1 - N)` ::
584 The (unique) ID of the VM.
589 *qm reset* `<vmid>` `[OPTIONS]`
591 Reset virtual machine.
593 `<vmid>` `integer (1 - N)` ::
595 The (unique) ID of the VM.
597 `-skiplock` `boolean` ::
599 Ignore locks - only root is allowed to use this option.
603 *qm resize* `<vmid> <disk> <size>` `[OPTIONS]`
607 `<vmid>` `integer (1 - N)` ::
609 The (unique) ID of the VM.
611 `<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)` ::
613 The disk you want to resize.
615 `<size>` `\+?\d+(\.\d+)?[KMGT]?` ::
617 The new size. With the '+' sign the value is added to the actual size of
618 the volume and without it, the value is taken as an absolute one. Shrinking
619 disk size is not supported.
621 `-digest` `string` ::
623 Prevent changes if current configuration file has different SHA1 digest.
624 This can be used to prevent concurrent modifications.
626 `-skiplock` `boolean` ::
628 Ignore locks - only root is allowed to use this option.
632 *qm resume* `<vmid>` `[OPTIONS]`
634 Resume virtual machine.
636 `<vmid>` `integer (1 - N)` ::
638 The (unique) ID of the VM.
640 `-nocheck` `boolean` ::
642 no description available
644 `-skiplock` `boolean` ::
646 Ignore locks - only root is allowed to use this option.
650 *qm rollback* `<vmid> <snapname>`
652 Rollback VM state to specified snapshot.
654 `<vmid>` `integer (1 - N)` ::
656 The (unique) ID of the VM.
658 `<snapname>` `string` ::
660 The name of the snapshot.
664 *qm sendkey* `<vmid> <key>` `[OPTIONS]`
666 Send key event to virtual machine.
668 `<vmid>` `integer (1 - N)` ::
670 The (unique) ID of the VM.
674 The key (qemu monitor encoding).
676 `-skiplock` `boolean` ::
678 Ignore locks - only root is allowed to use this option.
682 *qm set* `<vmid>` `[OPTIONS]`
684 Set virtual machine options (synchrounous API) - You should consider using
685 the POST method instead for any actions involving hotplug or storage
688 `<vmid>` `integer (1 - N)` ::
690 The (unique) ID of the VM.
692 `-acpi` `boolean` (default=`1`)::
696 `-agent` `boolean` (default=`0`)::
698 Enable/disable Qemu GuestAgent.
702 Arbitrary arguments passed to kvm, for example:
704 args: -no-reboot -no-hpet
706 NOTE: this option is for experts only.
708 `-autostart` `boolean` (default=`0`)::
710 Automatic restart after crash (currently ignored).
712 `-balloon` `integer (0 - N)` ::
714 Amount of target RAM for the VM in MB. Using zero disables the ballon
717 `-bios` `(ovmf | seabios)` (default=`seabios`)::
719 Select BIOS implementation.
721 `-boot` `[acdn]{1,4}` (default=`cdn`)::
723 Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).
725 `-bootdisk` `(ide|sata|scsi|virtio)\d+` ::
727 Enable booting from specified disk.
731 This is an alias for option -ide2
733 `-cores` `integer (1 - N)` (default=`1`)::
735 The number of cores per socket.
737 `-cpu` `[cputype=]<cputype> [,hidden=<1|0>]` ::
741 `-cpulimit` `number (0 - 128)` (default=`0`)::
745 NOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0'
746 indicates no CPU limit.
748 `-cpuunits` `integer (0 - 500000)` (default=`1000`)::
750 CPU weight for a VM. Argument is used in the kernel fair scheduler. The
751 larger the number is, the more CPU time this VM gets. Number is relative to
752 weights of all the other running VMs.
754 NOTE: You can disable fair-scheduler configuration by setting this to 0.
756 `-delete` `string` ::
758 A list of settings you want to delete.
760 `-description` `string` ::
762 Description for the VM. Only used on the configuration web interface. This
763 is saved as comment inside the configuration file.
765 `-digest` `string` ::
767 Prevent changes if current configuration file has different SHA1 digest.
768 This can be used to prevent concurrent modifications.
770 `-force` `boolean` ::
772 Force physical removal. Without this, we simple remove the disk from the
773 config file and create an additional configuration entry called
774 'unused[n]', which contains the volume ID. Unlink of unused[n] always cause
777 NOTE: Requires option(s): `delete`
779 `-freeze` `boolean` ::
781 Freeze CPU at startup (use 'c' monitor command to start execution).
783 `-hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,x-vga=<1|0>]` ::
785 Map host pci devices. HOSTPCIDEVICE syntax is:
787 'bus:dev.func' (hexadecimal numbers)
789 You can us the 'lspci' command to list existing pci devices.
791 The 'rombar' option determines whether or not the device's ROM will be
792 visible in the guest's memory map (default is 'on').
794 NOTE: This option allows direct access to host hardware. So it is no longer
795 possible to migrate such machines - use with special care.
797 Experimental: user reported problems with this option.
799 `-hotplug` `string` (default=`network,disk,usb`)::
801 Selectively enable hotplug features. This is a comma separated list of
802 hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to
803 disable hotplug completely. Value '1' is an alias for the default
806 `-ide[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<on|off>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<count>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<drive format>] [,heads=<count>] [,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=<count>] [,serial=<serial>] [,snapshot=<on|off>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
808 Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
810 `-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`)::
812 Keybord layout for vnc server. Default is read from the datacenter
815 `-kvm` `boolean` (default=`1`)::
817 Enable/disable KVM hardware virtualization.
819 `-localtime` `boolean` ::
821 Set the real time clock to local time. This is enabled by default if ostype
822 indicates a Microsoft OS.
824 `-lock` `(backup | migrate | rollback | snapshot)` ::
828 `-machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
830 Specific the Qemu machine type.
832 `-memory` `integer (16 - N)` (default=`512`)::
834 Amount of RAM for the VM in MB. This is the maximum available memory when
835 you use the balloon device.
837 `-migrate_downtime` `number (0 - N)` (default=`0.1`)::
839 Set maximum tolerated downtime (in seconds) for migrations.
841 `-migrate_speed` `integer (0 - N)` (default=`0`)::
843 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
847 Set a name for the VM. Only used on the configuration web interface.
849 `-net[n]` `string` ::
851 Specify network devices.
853 MODEL is one of: e1000 e1000-82540em e1000-82544gc e1000-82545em i82551
854 i82557b i82559er ne2k_isa ne2k_pci pcnet rtl8139 virtio vmxnet3
856 XX:XX:XX:XX:XX:XX should be an unique MAC address. This is
857 automatically generated if not specified.
859 The bridge parameter can be used to automatically add the interface to a
860 bridge device. The Proxmox VE standard bridge is called 'vmbr0'.
862 Option 'rate' is used to limit traffic bandwidth from and to this
863 interface. It is specified as floating point number, unit is 'Megabytes per
866 If you specify no bridge, we create a kvm 'user' (NATed) network device,
867 which provides DHCP and DNS services. The following addresses are used:
873 The DHCP server assign addresses to the guest starting from 10.0.2.15.
875 `-numa` `boolean` (default=`0`)::
879 `-numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<mb>] [,policy=<preferred|bind|interleave>]` ::
883 `-onboot` `boolean` (default=`0`)::
885 Specifies whether a VM will be started during system bootup.
887 `-ostype` `(l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win7 | win8 | wvista | wxp)` ::
889 Used to enable special optimization/features for specific
892 other => unspecified OS
893 wxp => Microsoft Windows XP
894 w2k => Microsoft Windows 2000
895 w2k3 => Microsoft Windows 2003
896 w2k8 => Microsoft Windows 2008
897 wvista => Microsoft Windows Vista
898 win7 => Microsoft Windows 7
899 win8 => Microsoft Windows 8/2012
900 l24 => Linux 2.4 Kernel
901 l26 => Linux 2.6/3.X Kernel
902 solaris => solaris/opensolaris/openindiania kernel
904 other|l24|l26|solaris ... no special behaviour
905 wxp|w2k|w2k3|w2k8|wvista|win7|win8 ... use --localtime switch
907 `-parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` ::
909 Map host parallel devices (n is 0 to 2).
911 NOTE: This option allows direct access to host hardware. So it is no longer
912 possible to migrate such machines - use with special care.
914 Experimental: user reported problems with this option.
916 `-protection` `boolean` (default=`0`)::
918 Sets the protection flag of the VM. This will prevent the remove operation.
920 `-reboot` `boolean` (default=`1`)::
922 Allow reboot. If set to '0' the VM exit on reboot.
924 `-revert` `string` ::
926 Revert a pending change.
928 `-sata[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<on|off>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<count>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<drive format>] [,heads=<count>] [,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=<count>] [,serial=<serial>] [,snapshot=<on|off>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
930 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
932 `-scsi[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<on|off>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<count>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<drive format>] [,heads=<count>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iothread=<off|on>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,queues=<nbqueues>] [,secs=<count>] [,serial=<serial>] [,snapshot=<on|off>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
934 Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
936 `-scsihw` `(lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single)` (default=`lsi`)::
938 scsi controller model
940 `-serial[n]` `(/dev/.+|socket)` ::
942 Create a serial device inside the VM (n is 0 to 3), and pass through a host
943 serial device (i.e. /dev/ttyS0), or create a unix socket on the host side
944 (use 'qm terminal' to open a terminal connection).
946 NOTE: If you pass through a host serial device, it is no longer possible to
947 migrate such machines - use with special care.
949 Experimental: user reported problems with this option.
951 `-shares` `integer (0 - 50000)` (default=`1000`)::
953 Amount of memory shares for auto-ballooning. The larger the number is, the
954 more memory this VM gets. Number is relative to weights of all other
955 running VMs. Using zero disables auto-ballooning
957 `-skiplock` `boolean` ::
959 Ignore locks - only root is allowed to use this option.
961 `-smbios[n]` `[family=<str>] [,manufacturer=<name>] [,product=<name>] [,serial=<str>] [,sku=<str>] [,uuid=<UUID>] [,version=<str>]` ::
963 Specify SMBIOS type 1 fields.
965 `-smp` `integer (1 - N)` (default=`1`)::
967 The number of CPUs. Please use option -sockets instead.
969 `-sockets` `integer (1 - N)` (default=`1`)::
971 The number of CPU sockets.
973 `-startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` (default=`now`)::
975 Set the initial date of the real time clock. Valid format for date are:
976 'now' or '2006-06-17T16:01:21' or '2006-06-17'.
978 `-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
980 Startup and shutdown behavior. Order is a non-negative number defining the
981 general startup order. Shutdown in done with reverse ordering. Additionally
982 you can set the 'up' or 'down' delay in seconds, which specifies a delay to
983 wait before the next VM is started or stopped.
985 `-tablet` `boolean` (default=`1`)::
987 Enable/disable the USB tablet device. This device is usually needed to
988 allow absolute mouse positioning with VNC. Else the mouse runs out of sync
989 with normal VNC clients. If you're running lots of console-only guests on
990 one host, you may consider disabling this to save some context switches.
991 This is turned off by default if you use spice (-vga=qxl).
993 `-tdf` `boolean` (default=`0`)::
995 Enable/disable time drift fix.
997 `-template` `boolean` (default=`0`)::
999 Enable/disable Template.
1001 `-unused[n]` `string` ::
1003 Reference to unused volumes.
1005 `-usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<yes|no>]` ::
1007 Configure an USB device (n is 0 to 4). This can be used to
1008 pass-through usb devices to the guest. HOSTUSBDEVICE syntax is:
1010 'bus-port(.port)*' (decimal numbers) or
1011 'vendor_id:product_id' (hexadeciaml numbers) or
1014 You can use the 'lsusb -t' command to list existing usb devices.
1016 NOTE: This option allows direct access to host hardware. So it is no longer
1017 possible to migrate such machines - use with special care.
1019 The value 'spice' can be used to add a usb redirection devices for spice.
1021 The 'usb3' option determines whether the device is a USB3 device or not
1022 (this does currently not work reliably with spice redirection and is then
1025 `-vcpus` `integer (1 - N)` (default=`0`)::
1027 Number of hotplugged vcpus.
1029 `-vga` `(cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware)` ::
1031 Select the VGA type. If you want to use high resolution modes (>=
1032 1280x1024x16) then you should use the options 'std' or 'vmware'. Default is
1033 'std' for win8/win7/w2k8, and 'cirrus' for other OS types. The 'qxl' option
1034 enables the SPICE display sever. For win* OS you can select how many
1035 independent displays you want, Linux guests can add displays them self. You
1036 can also run without any graphic card, using a serial device as terminal.
1038 `-virtio[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<on|off>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<count>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<drive format>] [,heads=<count>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iothread=<off|on>] [,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=<count>] [,serial=<serial>] [,snapshot=<on|off>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
1040 Use volume as VIRTIO hard disk (n is 0 to 15).
1042 `-watchdog` `[action=<reset|shutdown|poweroff|pause|debug|none>] [,[model=]<i6300esb|ib700>]` ::
1044 Create a virtual hardware watchdog device. Once enabled (by a guest
1045 action), the watchdog must be periodically polled by an agent inside the
1046 guest or else the watchdog will reset the guest (or execute the respective
1052 *qm showcmd* `<vmid>`
1054 Show command line which is used to start the VM (debug info).
1056 `<vmid>` `integer (1 - N)` ::
1058 The (unique) ID of the VM.
1063 *qm shutdown* `<vmid>` `[OPTIONS]`
1065 Shutdown virtual machine. This is similar to pressing the power button on a
1066 physical machine.This will send an ACPI event for the guest OS, which
1067 should then proceed to a clean shutdown.
1069 `<vmid>` `integer (1 - N)` ::
1071 The (unique) ID of the VM.
1073 `-forceStop` `boolean` (default=`0`)::
1075 Make sure the VM stops.
1077 `-keepActive` `boolean` (default=`0`)::
1079 Do not decativate storage volumes.
1081 `-skiplock` `boolean` ::
1083 Ignore locks - only root is allowed to use this option.
1085 `-timeout` `integer (0 - N)` ::
1087 Wait maximal timeout seconds.
1091 *qm snapshot* `<vmid> <snapname>` `[OPTIONS]`
1095 `<vmid>` `integer (1 - N)` ::
1097 The (unique) ID of the VM.
1099 `<snapname>` `string` ::
1101 The name of the snapshot.
1103 `-description` `string` ::
1105 A textual description or comment.
1107 `-vmstate` `boolean` ::
1113 *qm start* `<vmid>` `[OPTIONS]`
1115 Start virtual machine.
1117 `<vmid>` `integer (1 - N)` ::
1119 The (unique) ID of the VM.
1121 `-machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
1123 Specific the Qemu machine type.
1125 `-migratedfrom` `string` ::
1127 The cluster node name.
1129 `-skiplock` `boolean` ::
1131 Ignore locks - only root is allowed to use this option.
1133 `-stateuri` `string` ::
1135 Some command save/restore state from this location.
1140 *qm status* `<vmid>` `[OPTIONS]`
1144 `<vmid>` `integer (1 - N)` ::
1146 The (unique) ID of the VM.
1148 `-verbose` `boolean` ::
1150 Verbose output format
1155 *qm stop* `<vmid>` `[OPTIONS]`
1157 Stop virtual machine. The qemu process will exit immediately. Thisis akin
1158 to pulling the power plug of a running computer and may damage the VM data
1160 `<vmid>` `integer (1 - N)` ::
1162 The (unique) ID of the VM.
1164 `-keepActive` `boolean` (default=`0`)::
1166 Do not decativate storage volumes.
1168 `-migratedfrom` `string` ::
1170 The cluster node name.
1172 `-skiplock` `boolean` ::
1174 Ignore locks - only root is allowed to use this option.
1176 `-timeout` `integer (0 - N)` ::
1178 Wait maximal timeout seconds.
1182 *qm suspend* `<vmid>` `[OPTIONS]`
1184 Suspend virtual machine.
1186 `<vmid>` `integer (1 - N)` ::
1188 The (unique) ID of the VM.
1190 `-skiplock` `boolean` ::
1192 Ignore locks - only root is allowed to use this option.
1196 *qm template* `<vmid>` `[OPTIONS]`
1200 `<vmid>` `integer (1 - N)` ::
1202 The (unique) ID of the VM.
1204 `-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)` ::
1206 If you want to convert only 1 disk to base image.
1211 *qm terminal* `<vmid>` `[OPTIONS]`
1213 Open a terminal using a serial device (The VM need to have a serial device
1214 configured, for example 'serial0: socket')
1216 `<vmid>` `integer (1 - N)` ::
1218 The (unique) ID of the VM.
1220 `-iface` `(serial0 | serial1 | serial2 | serial3)` ::
1222 Select the serial device. By default we simply use the first suitable
1228 *qm unlink* `<vmid> -idlist <string>` `[OPTIONS]`
1230 Unlink/delete disk images.
1232 `<vmid>` `integer (1 - N)` ::
1234 The (unique) ID of the VM.
1236 `-force` `boolean` ::
1238 Force physical removal. Without this, we simple remove the disk from the
1239 config file and create an additional configuration entry called
1240 'unused[n]', which contains the volume ID. Unlink of unused[n] always cause
1243 `-idlist` `string` ::
1245 A list of disk IDs you want to delete.
1250 *qm unlock* `<vmid>`
1254 `<vmid>` `integer (1 - N)` ::
1256 The (unique) ID of the VM.
1260 *qm vncproxy* `<vmid>`
1262 Proxy VM VNC traffic to stdin/stdout
1264 `<vmid>` `integer (1 - N)` ::
1266 The (unique) ID of the VM.
1270 *qm wait* `<vmid>` `[OPTIONS]`
1272 Wait until the VM is stopped.
1274 `<vmid>` `integer (1 - N)` ::
1276 The (unique) ID of the VM.
1278 `-timeout` `integer (1 - N)` ::
1280 Timeout in seconds. Default is to wait forever.