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 Note: this option is for experts only. It allows you to pass arbitrary
92 arguments to kvm, for example:
94 args: -no-reboot -no-hpet
96 `-autostart` `boolean` (default=`0`)::
98 Automatic restart after crash (currently ignored).
100 `-balloon` `integer (0 - N)` ::
102 Amount of target RAM for the VM in MB. Using zero disables the ballon
105 `-bios` `(ovmf | seabios)` (default=`seabios`)::
107 Select BIOS implementation.
109 `-boot` `[acdn]{1,4}` (default=`cdn`)::
111 Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).
113 `-bootdisk` `(ide|sata|scsi|virtio)\d+` ::
115 Enable booting from specified disk.
119 This is an alias for option -ide2
121 `-cores` `integer (1 - N)` (default=`1`)::
123 The number of cores per socket.
125 `-cpu` `(486 | Broadwell | Conroe | Haswell | IvyBridge | Nehalem | Opteron_G1 | Opteron_G2 | Opteron_G3 | Opteron_G4 | Opteron_G5 | Penryn | SandyBridge | Westmere | athlon | core2duo | coreduo | host | kvm32 | kvm64 | pentium | pentium2 | pentium3 | phenom | qemu32 | qemu64)` (default=`kvm64`)::
129 `-cpulimit` `number (0 - 128)` (default=`0`)::
131 Limit of CPU usage. Note if the computer has 2 CPUs, it has total of '2'
132 CPU time. Value '0' indicates no CPU limit.
134 `-cpuunits` `integer (0 - 500000)` (default=`1000`)::
136 CPU weight for a VM. Argument is used in the kernel fair scheduler. The
137 larger the number is, the more CPU time this VM gets. Number is relative to
138 weights of all the other running VMs.
140 NOTE: You can disable fair-scheduler configuration by setting this to 0.
142 `-description` `string` ::
144 Description for the VM. Only used on the configuration web interface. This
145 is saved as comment inside the configuration file.
147 `-force` `boolean` ::
149 Allow to overwrite existing VM.
151 NOTE: Requires option(s): `archive`
153 `-freeze` `boolean` ::
155 Freeze CPU at startup (use 'c' monitor command to start execution).
157 `-hostpci[n]` `[host=]HOSTPCIDEVICE [,rombar=on|off] [,pcie=0|1] [,x-vga=on|off]` ::
159 Map host pci devices. HOSTPCIDEVICE syntax is:
161 'bus:dev.func' (hexadecimal numbers)
163 You can us the 'lspci' command to list existing pci devices.
165 The 'rombar' option determines whether or not the device's ROM will be
166 visible in the guest's memory map (default is 'on').
168 Note: This option allows direct access to host hardware. So it is no longer
169 possible to migrate such machines - use with special care.
171 Experimental: user reported problems with this option.
173 `-hotplug` `string` (default=`network,disk,usb`)::
175 Selectively enable hotplug features. This is a comma separated list of
176 hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to
177 disable hotplug completely. Value '1' is an alias for the default
180 `-ide[n]` `[volume=]volume,] [,media=cdrom|disk] [,cyls=c,heads=h,secs=s[,trans=t]] [,snapshot=on|off] [,cache=none|writethrough|writeback|unsafe|directsync] [,format=f] [,backup=yes|no] [,rerror=ignore|report|stop] [,werror=enospc|ignore|report|stop] [,aio=native|threads] [,discard=ignore|on] [,detect_zeroes=on|off] [,serial=serial][,model=model]` ::
182 Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
184 `-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`)::
186 Keybord layout for vnc server. Default is read from the datacenter
189 `-kvm` `boolean` (default=`1`)::
191 Enable/disable KVM hardware virtualization.
193 `-localtime` `boolean` ::
195 Set the real time clock to local time. This is enabled by default if ostype
196 indicates a Microsoft OS.
198 `-lock` `(backup | migrate | rollback | snapshot)` ::
202 `-machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
204 Specific the Qemu machine type.
206 `-memory` `integer (16 - N)` (default=`512`)::
208 Amount of RAM for the VM in MB. This is the maximum available memory when
209 you use the balloon device.
211 `-migrate_downtime` `number (0 - N)` (default=`0.1`)::
213 Set maximum tolerated downtime (in seconds) for migrations.
215 `-migrate_speed` `integer (0 - N)` (default=`0`)::
217 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
221 Set a name for the VM. Only used on the configuration web interface.
223 `-net[n]` `MODEL=XX:XX:XX:XX:XX:XX [,bridge=<dev>][,queues=<nbqueues>][,rate=<mbps>] [,tag=<vlanid>][,firewall=0|1],link_down=0|1]` ::
225 Specify network devices.
227 MODEL is one of: e1000 e1000-82540em e1000-82544gc e1000-82545em i82551
228 i82557b i82559er ne2k_isa ne2k_pci pcnet rtl8139 virtio vmxnet3
230 XX:XX:XX:XX:XX:XX should be an unique MAC address. This is
231 automatically generated if not specified.
233 The bridge parameter can be used to automatically add the interface to a
234 bridge device. The Proxmox VE standard bridge is called 'vmbr0'.
236 Option 'rate' is used to limit traffic bandwidth from and to this
237 interface. It is specified as floating point number, unit is 'Megabytes per
240 If you specify no bridge, we create a kvm 'user' (NATed) network device,
241 which provides DHCP and DNS services. The following addresses are used:
247 The DHCP server assign addresses to the guest starting from 10.0.2.15.
250 `-numa` `boolean` (default=`0`)::
254 `-numa[n]` `cpus=<id[-id],memory=<mb>[[,hostnodes=<id[-id]>] [,policy=<preferred|bind|interleave>]]` ::
258 `-onboot` `boolean` (default=`0`)::
260 Specifies whether a VM will be started during system bootup.
262 `-ostype` `(l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win7 | win8 | wvista | wxp)` ::
264 Used to enable special optimization/features for specific
267 other => unspecified OS
268 wxp => Microsoft Windows XP
269 w2k => Microsoft Windows 2000
270 w2k3 => Microsoft Windows 2003
271 w2k8 => Microsoft Windows 2008
272 wvista => Microsoft Windows Vista
273 win7 => Microsoft Windows 7
274 win8 => Microsoft Windows 8/2012
275 l24 => Linux 2.4 Kernel
276 l26 => Linux 2.6/3.X Kernel
277 solaris => solaris/opensolaris/openindiania kernel
279 other|l24|l26|solaris ... no special behaviour
280 wxp|w2k|w2k3|w2k8|wvista|win7|win8 ... use --localtime switch
282 `-parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` ::
284 Map host parallel devices (n is 0 to 2).
286 Note: This option allows direct access to host hardware. So it is no longer
287 possible to migrate such machines - use with special care.
289 Experimental: user reported problems with this option.
293 Add the VM to the specified pool.
295 `-protection` `boolean` (default=`0`)::
297 Sets the protection flag of the VM. This will prevent the remove operation.
299 `-reboot` `boolean` (default=`1`)::
301 Allow reboot. If set to '0' the VM exit on reboot.
303 `-sata[n]` `[volume=]volume,] [,media=cdrom|disk] [,cyls=c,heads=h,secs=s[,trans=t]] [,snapshot=on|off] [,cache=none|writethrough|writeback|unsafe|directsync] [,format=f] [,backup=yes|no] [,rerror=ignore|report|stop] [,werror=enospc|ignore|report|stop] [,aio=native|threads] [,discard=ignore|on] [,detect_zeroes=on|off] [,serial=serial]` ::
305 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
307 `-scsi[n]` `[volume=]volume,] [,media=cdrom|disk] [,cyls=c,heads=h,secs=s[,trans=t]] [,snapshot=on|off] [,cache=none|writethrough|writeback|unsafe|directsync] [,format=f] [,backup=yes|no] [,rerror=ignore|report|stop] [,werror=enospc|ignore|report|stop] [,aio=native|threads] [,discard=ignore|on] [,detect_zeroes=on|off] [,iothread=on] [,queues=<nbqueues>] [,serial=serial]` ::
309 Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
311 `-scsihw` `(lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single)` (default=`lsi`)::
313 scsi controller model
315 `-serial[n]` `(/dev/.+|socket)` ::
317 Create a serial device inside the VM (n is 0 to 3), and pass through a host
318 serial device (i.e. /dev/ttyS0), or create a unix socket on the host side
319 (use 'qm terminal' to open a terminal connection).
321 Note: If you pass through a host serial device, it is no longer possible to
322 migrate such machines - use with special care.
324 Experimental: user reported problems with this option.
326 `-shares` `integer (0 - 50000)` (default=`1000`)::
328 Amount of memory shares for auto-ballooning. The larger the number is, the
329 more memory this VM gets. Number is relative to weights of all other
330 running VMs. Using zero disables auto-ballooning
332 `-smbios[n]` `[manufacturer=str][,product=str][,version=str][,serial=str] [,uuid=uuid][,sku=str][,family=str]` ::
334 Specify SMBIOS type 1 fields.
336 `-smp` `integer (1 - N)` (default=`1`)::
338 The number of CPUs. Please use option -sockets instead.
340 `-sockets` `integer (1 - N)` (default=`1`)::
342 The number of CPU sockets.
344 `-startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` (default=`now`)::
346 Set the initial date of the real time clock. Valid format for date are:
347 'now' or '2006-06-17T16:01:21' or '2006-06-17'.
349 `-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
351 Startup and shutdown behavior. Order is a non-negative number defining the
352 general startup order. Shutdown in done with reverse ordering. Additionally
353 you can set the 'up' or 'down' delay in seconds, which specifies a delay to
354 wait before the next VM is started or stopped.
356 `-storage` `string` ::
360 `-tablet` `boolean` (default=`1`)::
362 Enable/disable the usb tablet device. This device is usually needed to
363 allow absolute mouse positioning with VNC. Else the mouse runs out of sync
364 with normal VNC clients. If you're running lots of console-only guests on
365 one host, you may consider disabling this to save some context switches.
366 This is turned of by default if you use spice (vga=qxl).
368 `-tdf` `boolean` (default=`0`)::
370 Enable/disable time drift fix.
372 `-template` `boolean` (default=`0`)::
374 Enable/disable Template.
376 `-unique` `boolean` ::
378 Assign a unique random ethernet address.
380 NOTE: Requires option(s): `archive`
382 `-unused[n]` `string` ::
384 Reference to unused volumes.
386 `-usb[n]` `host=HOSTUSBDEVICE|spice` ::
388 Configure an USB device (n is 0 to 4). This can be used to
389 pass-through usb devices to the guest. HOSTUSBDEVICE syntax is:
391 'bus-port(.port)*' (decimal numbers) or
392 'vendor_id:product_id' (hexadeciaml numbers)
394 You can use the 'lsusb -t' command to list existing usb devices.
396 Note: This option allows direct access to host hardware. So it is no longer
397 possible to migrate such machines - use with special care.
399 The value 'spice' can be used to add a usb redirection devices for spice.
402 `-vcpus` `integer (1 - N)` (default=`0`)::
404 Number of hotplugged vcpus.
406 `-vga` `(cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware)` ::
408 Select VGA type. If you want to use high resolution modes (>= 1280x1024x16)
409 then you should use option 'std' or 'vmware'. Default is 'std' for
410 win8/win7/w2k8, and 'cirrur' for other OS types. Option 'qxl' enables the
411 SPICE display sever. You can also run without any graphic card using a
412 serial devive as terminal.
414 `-virtio[n]` `[volume=]volume,] [,media=cdrom|disk] [,cyls=c,heads=h,secs=s[,trans=t]] [,snapshot=on|off] [,cache=none|writethrough|writeback|unsafe|directsync] [,format=f] [,backup=yes|no] [,rerror=ignore|report|stop] [,werror=enospc|ignore|report|stop] [,aio=native|threads] [,discard=ignore|on] [,detect_zeroes=on|off] [,iothread=on] [,serial=serial]` ::
416 Use volume as VIRTIO hard disk (n is 0 to 15).
418 `-watchdog` `[[model=]i6300esb|ib700] [,[action=]reset|shutdown|poweroff|pause|debug|none]` ::
420 Create a virtual hardware watchdog device. Once enabled (by a guest
421 action), the watchdog must be periodically polled by an agent inside the
422 guest or else the guest will be restarted (or execute the action specified)
426 *qm delsnapshot* `<vmid> <snapname>` `[OPTIONS]`
428 Delete a VM snapshot.
430 `<vmid>` `integer (1 - N)` ::
432 The (unique) ID of the VM.
434 `<snapname>` `string` ::
436 The name of the snapshot.
438 `-force` `boolean` ::
440 For removal from config file, even if removing disk snapshots fails.
444 *qm destroy* `<vmid>` `[OPTIONS]`
446 Destroy the vm (also delete all used/owned volumes).
448 `<vmid>` `integer (1 - N)` ::
450 The (unique) ID of the VM.
452 `-skiplock` `boolean` ::
454 Ignore locks - only root is allowed to use this option.
459 *qm help* `[<cmd>]` `[OPTIONS]`
461 Get help about specified command.
467 `-verbose` `boolean` ::
469 Verbose output format.
476 Virtual machine index (per node).
480 *qm migrate* `<vmid> <target>` `[OPTIONS]`
482 Migrate virtual machine. Creates a new migration task.
484 `<vmid>` `integer (1 - N)` ::
486 The (unique) ID of the VM.
488 `<target>` `string` ::
492 `-force` `boolean` ::
494 Allow to migrate VMs which use local devices. Only root may use this
497 `-online` `boolean` ::
499 Use online/live migration.
504 *qm monitor* `<vmid>`
506 Enter Qemu Monitor interface.
508 `<vmid>` `integer (1 - N)` ::
510 The (unique) ID of the VM.
515 *qm move_disk* `<vmid> <disk> <storage>` `[OPTIONS]`
517 Move volume to different storage.
519 `<vmid>` `integer (1 - N)` ::
521 The (unique) ID of the VM.
523 `<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)` ::
525 The disk you want to move.
527 `<storage>` `string` ::
531 `-delete` `boolean` (default=`0`)::
533 Delete the original disk after successful copy. By default the original
534 disk is kept as unused disk.
536 `-digest` `string` ::
538 Prevent changes if current configuration file has different SHA1 digest.
539 This can be used to prevent concurrent modifications.
541 `-format` `(qcow2 | raw | vmdk)` ::
550 Used by qmigrate - do not use manually.
555 *qm pending* `<vmid>`
557 Get virtual machine configuration, including pending changes.
559 `<vmid>` `integer (1 - N)` ::
561 The (unique) ID of the VM.
566 *qm rescan* `[OPTIONS]`
568 Rescan all storages and update disk sizes and unused disk images.
570 `-vmid` `integer (1 - N)` ::
572 The (unique) ID of the VM.
577 *qm reset* `<vmid>` `[OPTIONS]`
579 Reset virtual machine.
581 `<vmid>` `integer (1 - N)` ::
583 The (unique) ID of the VM.
585 `-skiplock` `boolean` ::
587 Ignore locks - only root is allowed to use this option.
591 *qm resize* `<vmid> <disk> <size>` `[OPTIONS]`
595 `<vmid>` `integer (1 - N)` ::
597 The (unique) ID of the VM.
599 `<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)` ::
601 The disk you want to resize.
603 `<size>` `\+?\d+(\.\d+)?[KMGT]?` ::
605 The new size. With the '+' sign the value is added to the actual size of
606 the volume and without it, the value is taken as an absolute one. Shrinking
607 disk size is not supported.
609 `-digest` `string` ::
611 Prevent changes if current configuration file has different SHA1 digest.
612 This can be used to prevent concurrent modifications.
614 `-skiplock` `boolean` ::
616 Ignore locks - only root is allowed to use this option.
620 *qm resume* `<vmid>` `[OPTIONS]`
622 Resume virtual machine.
624 `<vmid>` `integer (1 - N)` ::
626 The (unique) ID of the VM.
628 `-nocheck` `boolean` ::
630 no description available
632 `-skiplock` `boolean` ::
634 Ignore locks - only root is allowed to use this option.
638 *qm rollback* `<vmid> <snapname>`
640 Rollback VM state to specified snapshot.
642 `<vmid>` `integer (1 - N)` ::
644 The (unique) ID of the VM.
646 `<snapname>` `string` ::
648 The name of the snapshot.
652 *qm sendkey* `<vmid> <key>` `[OPTIONS]`
654 Send key event to virtual machine.
656 `<vmid>` `integer (1 - N)` ::
658 The (unique) ID of the VM.
662 The key (qemu monitor encoding).
664 `-skiplock` `boolean` ::
666 Ignore locks - only root is allowed to use this option.
670 *qm set* `<vmid>` `[OPTIONS]`
672 Set virtual machine options (synchrounous API) - You should consider using
673 the POST method instead for any actions involving hotplug or storage
676 `<vmid>` `integer (1 - N)` ::
678 The (unique) ID of the VM.
680 `-acpi` `boolean` (default=`1`)::
684 `-agent` `boolean` (default=`0`)::
686 Enable/disable Qemu GuestAgent.
690 Note: this option is for experts only. It allows you to pass arbitrary
691 arguments to kvm, for example:
693 args: -no-reboot -no-hpet
695 `-autostart` `boolean` (default=`0`)::
697 Automatic restart after crash (currently ignored).
699 `-balloon` `integer (0 - N)` ::
701 Amount of target RAM for the VM in MB. Using zero disables the ballon
704 `-bios` `(ovmf | seabios)` (default=`seabios`)::
706 Select BIOS implementation.
708 `-boot` `[acdn]{1,4}` (default=`cdn`)::
710 Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).
712 `-bootdisk` `(ide|sata|scsi|virtio)\d+` ::
714 Enable booting from specified disk.
718 This is an alias for option -ide2
720 `-cores` `integer (1 - N)` (default=`1`)::
722 The number of cores per socket.
724 `-cpu` `(486 | Broadwell | Conroe | Haswell | IvyBridge | Nehalem | Opteron_G1 | Opteron_G2 | Opteron_G3 | Opteron_G4 | Opteron_G5 | Penryn | SandyBridge | Westmere | athlon | core2duo | coreduo | host | kvm32 | kvm64 | pentium | pentium2 | pentium3 | phenom | qemu32 | qemu64)` (default=`kvm64`)::
728 `-cpulimit` `number (0 - 128)` (default=`0`)::
730 Limit of CPU usage. Note if the computer has 2 CPUs, it has total of '2'
731 CPU time. Value '0' indicates no CPU limit.
733 `-cpuunits` `integer (0 - 500000)` (default=`1000`)::
735 CPU weight for a VM. Argument is used in the kernel fair scheduler. The
736 larger the number is, the more CPU time this VM gets. Number is relative to
737 weights of all the other running VMs.
739 NOTE: You can disable fair-scheduler configuration by setting this to 0.
741 `-delete` `string` ::
743 A list of settings you want to delete.
745 `-description` `string` ::
747 Description for the VM. Only used on the configuration web interface. This
748 is saved as comment inside the configuration file.
750 `-digest` `string` ::
752 Prevent changes if current configuration file has different SHA1 digest.
753 This can be used to prevent concurrent modifications.
755 `-force` `boolean` ::
757 Force physical removal. Without this, we simple remove the disk from the
758 config file and create an additional configuration entry called
759 'unused[n]', which contains the volume ID. Unlink of unused[n] always cause
762 NOTE: Requires option(s): `delete`
764 `-freeze` `boolean` ::
766 Freeze CPU at startup (use 'c' monitor command to start execution).
768 `-hostpci[n]` `[host=]HOSTPCIDEVICE [,rombar=on|off] [,pcie=0|1] [,x-vga=on|off]` ::
770 Map host pci devices. HOSTPCIDEVICE syntax is:
772 'bus:dev.func' (hexadecimal numbers)
774 You can us the 'lspci' command to list existing pci devices.
776 The 'rombar' option determines whether or not the device's ROM will be
777 visible in the guest's memory map (default is 'on').
779 Note: This option allows direct access to host hardware. So it is no longer
780 possible to migrate such machines - use with special care.
782 Experimental: user reported problems with this option.
784 `-hotplug` `string` (default=`network,disk,usb`)::
786 Selectively enable hotplug features. This is a comma separated list of
787 hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to
788 disable hotplug completely. Value '1' is an alias for the default
791 `-ide[n]` `[volume=]volume,] [,media=cdrom|disk] [,cyls=c,heads=h,secs=s[,trans=t]] [,snapshot=on|off] [,cache=none|writethrough|writeback|unsafe|directsync] [,format=f] [,backup=yes|no] [,rerror=ignore|report|stop] [,werror=enospc|ignore|report|stop] [,aio=native|threads] [,discard=ignore|on] [,detect_zeroes=on|off] [,serial=serial][,model=model]` ::
793 Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
795 `-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`)::
797 Keybord layout for vnc server. Default is read from the datacenter
800 `-kvm` `boolean` (default=`1`)::
802 Enable/disable KVM hardware virtualization.
804 `-localtime` `boolean` ::
806 Set the real time clock to local time. This is enabled by default if ostype
807 indicates a Microsoft OS.
809 `-lock` `(backup | migrate | rollback | snapshot)` ::
813 `-machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
815 Specific the Qemu machine type.
817 `-memory` `integer (16 - N)` (default=`512`)::
819 Amount of RAM for the VM in MB. This is the maximum available memory when
820 you use the balloon device.
822 `-migrate_downtime` `number (0 - N)` (default=`0.1`)::
824 Set maximum tolerated downtime (in seconds) for migrations.
826 `-migrate_speed` `integer (0 - N)` (default=`0`)::
828 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
832 Set a name for the VM. Only used on the configuration web interface.
834 `-net[n]` `MODEL=XX:XX:XX:XX:XX:XX [,bridge=<dev>][,queues=<nbqueues>][,rate=<mbps>] [,tag=<vlanid>][,firewall=0|1],link_down=0|1]` ::
836 Specify network devices.
838 MODEL is one of: e1000 e1000-82540em e1000-82544gc e1000-82545em i82551
839 i82557b i82559er ne2k_isa ne2k_pci pcnet rtl8139 virtio vmxnet3
841 XX:XX:XX:XX:XX:XX should be an unique MAC address. This is
842 automatically generated if not specified.
844 The bridge parameter can be used to automatically add the interface to a
845 bridge device. The Proxmox VE standard bridge is called 'vmbr0'.
847 Option 'rate' is used to limit traffic bandwidth from and to this
848 interface. It is specified as floating point number, unit is 'Megabytes per
851 If you specify no bridge, we create a kvm 'user' (NATed) network device,
852 which provides DHCP and DNS services. The following addresses are used:
858 The DHCP server assign addresses to the guest starting from 10.0.2.15.
861 `-numa` `boolean` (default=`0`)::
865 `-numa[n]` `cpus=<id[-id],memory=<mb>[[,hostnodes=<id[-id]>] [,policy=<preferred|bind|interleave>]]` ::
869 `-onboot` `boolean` (default=`0`)::
871 Specifies whether a VM will be started during system bootup.
873 `-ostype` `(l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win7 | win8 | wvista | wxp)` ::
875 Used to enable special optimization/features for specific
878 other => unspecified OS
879 wxp => Microsoft Windows XP
880 w2k => Microsoft Windows 2000
881 w2k3 => Microsoft Windows 2003
882 w2k8 => Microsoft Windows 2008
883 wvista => Microsoft Windows Vista
884 win7 => Microsoft Windows 7
885 win8 => Microsoft Windows 8/2012
886 l24 => Linux 2.4 Kernel
887 l26 => Linux 2.6/3.X Kernel
888 solaris => solaris/opensolaris/openindiania kernel
890 other|l24|l26|solaris ... no special behaviour
891 wxp|w2k|w2k3|w2k8|wvista|win7|win8 ... use --localtime switch
893 `-parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` ::
895 Map host parallel devices (n is 0 to 2).
897 Note: This option allows direct access to host hardware. So it is no longer
898 possible to migrate such machines - use with special care.
900 Experimental: user reported problems with this option.
902 `-protection` `boolean` (default=`0`)::
904 Sets the protection flag of the VM. This will prevent the remove operation.
906 `-reboot` `boolean` (default=`1`)::
908 Allow reboot. If set to '0' the VM exit on reboot.
910 `-revert` `string` ::
912 Revert a pending change.
914 `-sata[n]` `[volume=]volume,] [,media=cdrom|disk] [,cyls=c,heads=h,secs=s[,trans=t]] [,snapshot=on|off] [,cache=none|writethrough|writeback|unsafe|directsync] [,format=f] [,backup=yes|no] [,rerror=ignore|report|stop] [,werror=enospc|ignore|report|stop] [,aio=native|threads] [,discard=ignore|on] [,detect_zeroes=on|off] [,serial=serial]` ::
916 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
918 `-scsi[n]` `[volume=]volume,] [,media=cdrom|disk] [,cyls=c,heads=h,secs=s[,trans=t]] [,snapshot=on|off] [,cache=none|writethrough|writeback|unsafe|directsync] [,format=f] [,backup=yes|no] [,rerror=ignore|report|stop] [,werror=enospc|ignore|report|stop] [,aio=native|threads] [,discard=ignore|on] [,detect_zeroes=on|off] [,iothread=on] [,queues=<nbqueues>] [,serial=serial]` ::
920 Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
922 `-scsihw` `(lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single)` (default=`lsi`)::
924 scsi controller model
926 `-serial[n]` `(/dev/.+|socket)` ::
928 Create a serial device inside the VM (n is 0 to 3), and pass through a host
929 serial device (i.e. /dev/ttyS0), or create a unix socket on the host side
930 (use 'qm terminal' to open a terminal connection).
932 Note: If you pass through a host serial device, it is no longer possible to
933 migrate such machines - use with special care.
935 Experimental: user reported problems with this option.
937 `-shares` `integer (0 - 50000)` (default=`1000`)::
939 Amount of memory shares for auto-ballooning. The larger the number is, the
940 more memory this VM gets. Number is relative to weights of all other
941 running VMs. Using zero disables auto-ballooning
943 `-skiplock` `boolean` ::
945 Ignore locks - only root is allowed to use this option.
947 `-smbios[n]` `[manufacturer=str][,product=str][,version=str][,serial=str] [,uuid=uuid][,sku=str][,family=str]` ::
949 Specify SMBIOS type 1 fields.
951 `-smp` `integer (1 - N)` (default=`1`)::
953 The number of CPUs. Please use option -sockets instead.
955 `-sockets` `integer (1 - N)` (default=`1`)::
957 The number of CPU sockets.
959 `-startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` (default=`now`)::
961 Set the initial date of the real time clock. Valid format for date are:
962 'now' or '2006-06-17T16:01:21' or '2006-06-17'.
964 `-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
966 Startup and shutdown behavior. Order is a non-negative number defining the
967 general startup order. Shutdown in done with reverse ordering. Additionally
968 you can set the 'up' or 'down' delay in seconds, which specifies a delay to
969 wait before the next VM is started or stopped.
971 `-tablet` `boolean` (default=`1`)::
973 Enable/disable the usb tablet device. This device is usually needed to
974 allow absolute mouse positioning with VNC. Else the mouse runs out of sync
975 with normal VNC clients. If you're running lots of console-only guests on
976 one host, you may consider disabling this to save some context switches.
977 This is turned of by default if you use spice (vga=qxl).
979 `-tdf` `boolean` (default=`0`)::
981 Enable/disable time drift fix.
983 `-template` `boolean` (default=`0`)::
985 Enable/disable Template.
987 `-unused[n]` `string` ::
989 Reference to unused volumes.
991 `-usb[n]` `host=HOSTUSBDEVICE|spice` ::
993 Configure an USB device (n is 0 to 4). This can be used to
994 pass-through usb devices to the guest. HOSTUSBDEVICE syntax is:
996 'bus-port(.port)*' (decimal numbers) or
997 'vendor_id:product_id' (hexadeciaml numbers)
999 You can use the 'lsusb -t' command to list existing usb devices.
1001 Note: This option allows direct access to host hardware. So it is no longer
1002 possible to migrate such machines - use with special care.
1004 The value 'spice' can be used to add a usb redirection devices for spice.
1007 `-vcpus` `integer (1 - N)` (default=`0`)::
1009 Number of hotplugged vcpus.
1011 `-vga` `(cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware)` ::
1013 Select VGA type. If you want to use high resolution modes (>= 1280x1024x16)
1014 then you should use option 'std' or 'vmware'. Default is 'std' for
1015 win8/win7/w2k8, and 'cirrur' for other OS types. Option 'qxl' enables the
1016 SPICE display sever. You can also run without any graphic card using a
1017 serial devive as terminal.
1019 `-virtio[n]` `[volume=]volume,] [,media=cdrom|disk] [,cyls=c,heads=h,secs=s[,trans=t]] [,snapshot=on|off] [,cache=none|writethrough|writeback|unsafe|directsync] [,format=f] [,backup=yes|no] [,rerror=ignore|report|stop] [,werror=enospc|ignore|report|stop] [,aio=native|threads] [,discard=ignore|on] [,detect_zeroes=on|off] [,iothread=on] [,serial=serial]` ::
1021 Use volume as VIRTIO hard disk (n is 0 to 15).
1023 `-watchdog` `[[model=]i6300esb|ib700] [,[action=]reset|shutdown|poweroff|pause|debug|none]` ::
1025 Create a virtual hardware watchdog device. Once enabled (by a guest
1026 action), the watchdog must be periodically polled by an agent inside the
1027 guest or else the guest will be restarted (or execute the action specified)
1032 *qm showcmd* `<vmid>`
1034 Show command line which is used to start the VM (debug info).
1036 `<vmid>` `integer (1 - N)` ::
1038 The (unique) ID of the VM.
1043 *qm shutdown* `<vmid>` `[OPTIONS]`
1045 Shutdown virtual machine.
1047 `<vmid>` `integer (1 - N)` ::
1049 The (unique) ID of the VM.
1051 `-forceStop` `boolean` (default=`0`)::
1053 Make sure the VM stops.
1055 `-keepActive` `boolean` (default=`0`)::
1057 Do not decativate storage volumes.
1059 `-skiplock` `boolean` ::
1061 Ignore locks - only root is allowed to use this option.
1063 `-timeout` `integer (0 - N)` ::
1065 Wait maximal timeout seconds.
1069 *qm snapshot* `<vmid> <snapname>` `[OPTIONS]`
1073 `<vmid>` `integer (1 - N)` ::
1075 The (unique) ID of the VM.
1077 `<snapname>` `string` ::
1079 The name of the snapshot.
1081 `-description` `string` ::
1083 A textual description or comment.
1085 `-vmstate` `boolean` ::
1091 *qm start* `<vmid>` `[OPTIONS]`
1093 Start virtual machine.
1095 `<vmid>` `integer (1 - N)` ::
1097 The (unique) ID of the VM.
1099 `-machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
1101 Specific the Qemu machine type.
1103 `-migratedfrom` `string` ::
1105 The cluster node name.
1107 `-skiplock` `boolean` ::
1109 Ignore locks - only root is allowed to use this option.
1111 `-stateuri` `string` ::
1113 Some command save/restore state from this location.
1118 *qm status* `<vmid>` `[OPTIONS]`
1122 `<vmid>` `integer (1 - N)` ::
1124 The (unique) ID of the VM.
1126 `-verbose` `boolean` ::
1128 Verbose output format
1133 *qm stop* `<vmid>` `[OPTIONS]`
1135 Stop virtual machine.
1137 `<vmid>` `integer (1 - N)` ::
1139 The (unique) ID of the VM.
1141 `-keepActive` `boolean` (default=`0`)::
1143 Do not decativate storage volumes.
1145 `-migratedfrom` `string` ::
1147 The cluster node name.
1149 `-skiplock` `boolean` ::
1151 Ignore locks - only root is allowed to use this option.
1153 `-timeout` `integer (0 - N)` ::
1155 Wait maximal timeout seconds.
1159 *qm suspend* `<vmid>` `[OPTIONS]`
1161 Suspend virtual machine.
1163 `<vmid>` `integer (1 - N)` ::
1165 The (unique) ID of the VM.
1167 `-skiplock` `boolean` ::
1169 Ignore locks - only root is allowed to use this option.
1173 *qm template* `<vmid>` `[OPTIONS]`
1177 `<vmid>` `integer (1 - N)` ::
1179 The (unique) ID of the VM.
1181 `-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)` ::
1183 If you want to convert only 1 disk to base image.
1188 *qm terminal* `<vmid>` `[OPTIONS]`
1190 Open a terminal using a serial device (The VM need to have a serial device
1191 configured, for example 'serial0: socket')
1193 `<vmid>` `integer (1 - N)` ::
1195 The (unique) ID of the VM.
1197 `-iface` `(serial0 | serial1 | serial2 | serial3)` ::
1199 Select the serial device. By default we simply use the first suitable
1205 *qm unlink* `<vmid> -idlist <string>` `[OPTIONS]`
1207 Unlink/delete disk images.
1209 `<vmid>` `integer (1 - N)` ::
1211 The (unique) ID of the VM.
1213 `-force` `boolean` ::
1215 Force physical removal. Without this, we simple remove the disk from the
1216 config file and create an additional configuration entry called
1217 'unused[n]', which contains the volume ID. Unlink of unused[n] always cause
1220 `-idlist` `string` ::
1222 A list of disk IDs you want to delete.
1227 *qm unlock* `<vmid>`
1231 `<vmid>` `integer (1 - N)` ::
1233 The (unique) ID of the VM.
1237 *qm vncproxy* `<vmid>`
1239 Proxy VM VNC traffic to stdin/stdout
1241 `<vmid>` `integer (1 - N)` ::
1243 The (unique) ID of the VM.
1247 *qm wait* `<vmid>` `[OPTIONS]`
1249 Wait until the VM is stopped.
1251 `<vmid>` `integer (1 - N)` ::
1253 The (unique) ID of the VM.
1255 `-timeout` `integer (1 - N)` ::
1257 Timeout in seconds. Default is to wait forever.