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` `[cputype=]<cputype> [,hidden=<1|0>]` ::
129 `-cpulimit` `number (0 - 128)` (default=`0`)::
133 NOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0'
134 indicates no CPU limit.
136 `-cpuunits` `integer (0 - 500000)` (default=`1000`)::
138 CPU weight for a VM. Argument is used in the kernel fair scheduler. The
139 larger the number is, the more CPU time this VM gets. Number is relative to
140 weights of all the other running VMs.
142 NOTE: You can disable fair-scheduler configuration by setting this to 0.
144 `-description` `string` ::
146 Description for the VM. Only used on the configuration web interface. This
147 is saved as comment inside the configuration file.
149 `-force` `boolean` ::
151 Allow to overwrite existing VM.
153 NOTE: Requires option(s): `archive`
155 `-freeze` `boolean` ::
157 Freeze CPU at startup (use 'c' monitor command to start execution).
159 `-hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,x-vga=<1|0>]` ::
161 Map host pci devices. HOSTPCIDEVICE syntax is:
163 'bus:dev.func' (hexadecimal numbers)
165 You can us the 'lspci' command to list existing pci devices.
167 The 'rombar' option determines whether or not the device's ROM will be
168 visible in the guest's memory map (default is 'on').
170 NOTE: This option allows direct access to host hardware. So it is no longer
171 possible to migrate such machines - use with special care.
173 Experimental: user reported problems with this option.
175 `-hotplug` `string` (default=`network,disk,usb`)::
177 Selectively enable hotplug features. This is a comma separated list of
178 hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to
179 disable hotplug completely. Value '1' is an alias for the default
182 `-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>]` ::
184 Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
186 `-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`)::
188 Keybord layout for vnc server. Default is read from the datacenter
191 `-kvm` `boolean` (default=`1`)::
193 Enable/disable KVM hardware virtualization.
195 `-localtime` `boolean` ::
197 Set the real time clock to local time. This is enabled by default if ostype
198 indicates a Microsoft OS.
200 `-lock` `(backup | migrate | rollback | snapshot)` ::
204 `-machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
206 Specific the Qemu machine type.
208 `-memory` `integer (16 - N)` (default=`512`)::
210 Amount of RAM for the VM in MB. This is the maximum available memory when
211 you use the balloon device.
213 `-migrate_downtime` `number (0 - N)` (default=`0.1`)::
215 Set maximum tolerated downtime (in seconds) for migrations.
217 `-migrate_speed` `integer (0 - N)` (default=`0`)::
219 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
223 Set a name for the VM. Only used on the configuration web interface.
225 `-net[n]` `string` ::
227 Specify network devices.
229 MODEL is one of: e1000 e1000-82540em e1000-82544gc e1000-82545em i82551
230 i82557b i82559er ne2k_isa ne2k_pci pcnet rtl8139 virtio vmxnet3
232 XX:XX:XX:XX:XX:XX should be an unique MAC address. This is
233 automatically generated if not specified.
235 The bridge parameter can be used to automatically add the interface to a
236 bridge device. The Proxmox VE standard bridge is called 'vmbr0'.
238 Option 'rate' is used to limit traffic bandwidth from and to this
239 interface. It is specified as floating point number, unit is 'Megabytes per
242 If you specify no bridge, we create a kvm 'user' (NATed) network device,
243 which provides DHCP and DNS services. The following addresses are used:
249 The DHCP server assign addresses to the guest starting from 10.0.2.15.
251 `-numa` `boolean` (default=`0`)::
255 `-numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<mb>] [,policy=<preferred|bind|interleave>]` ::
259 `-onboot` `boolean` (default=`0`)::
261 Specifies whether a VM will be started during system bootup.
263 `-ostype` `(l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win7 | win8 | wvista | wxp)` ::
265 Used to enable special optimization/features for specific
268 other => unspecified OS
269 wxp => Microsoft Windows XP
270 w2k => Microsoft Windows 2000
271 w2k3 => Microsoft Windows 2003
272 w2k8 => Microsoft Windows 2008
273 wvista => Microsoft Windows Vista
274 win7 => Microsoft Windows 7
275 win8 => Microsoft Windows 8/2012
276 l24 => Linux 2.4 Kernel
277 l26 => Linux 2.6/3.X Kernel
278 solaris => solaris/opensolaris/openindiania kernel
280 other|l24|l26|solaris ... no special behaviour
281 wxp|w2k|w2k3|w2k8|wvista|win7|win8 ... use --localtime switch
283 `-parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` ::
285 Map host parallel devices (n is 0 to 2).
287 NOTE: This option allows direct access to host hardware. So it is no longer
288 possible to migrate such machines - use with special care.
290 Experimental: user reported problems with this option.
294 Add the VM to the specified pool.
296 `-protection` `boolean` (default=`0`)::
298 Sets the protection flag of the VM. This will prevent the remove operation.
300 `-reboot` `boolean` (default=`1`)::
302 Allow reboot. If set to '0' the VM exit on reboot.
304 `-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>]` ::
306 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
308 `-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>]` ::
310 Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
312 `-scsihw` `(lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single)` (default=`lsi`)::
314 scsi controller model
316 `-serial[n]` `(/dev/.+|socket)` ::
318 Create a serial device inside the VM (n is 0 to 3), and pass through a host
319 serial device (i.e. /dev/ttyS0), or create a unix socket on the host side
320 (use 'qm terminal' to open a terminal connection).
322 NOTE: If you pass through a host serial device, it is no longer possible to
323 migrate such machines - use with special care.
325 Experimental: user reported problems with this option.
327 `-shares` `integer (0 - 50000)` (default=`1000`)::
329 Amount of memory shares for auto-ballooning. The larger the number is, the
330 more memory this VM gets. Number is relative to weights of all other
331 running VMs. Using zero disables auto-ballooning
333 `-smbios[n]` `[family=<str>] [,manufacturer=<name>] [,product=<name>] [,serial=<str>] [,sku=<str>] [,uuid=<UUID>] [,version=<str>]` ::
335 Specify SMBIOS type 1 fields.
337 `-smp` `integer (1 - N)` (default=`1`)::
339 The number of CPUs. Please use option -sockets instead.
341 `-sockets` `integer (1 - N)` (default=`1`)::
343 The number of CPU sockets.
345 `-startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` (default=`now`)::
347 Set the initial date of the real time clock. Valid format for date are:
348 'now' or '2006-06-17T16:01:21' or '2006-06-17'.
350 `-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
352 Startup and shutdown behavior. Order is a non-negative number defining the
353 general startup order. Shutdown in done with reverse ordering. Additionally
354 you can set the 'up' or 'down' delay in seconds, which specifies a delay to
355 wait before the next VM is started or stopped.
357 `-storage` `string` ::
361 `-tablet` `boolean` (default=`1`)::
363 Enable/disable the USB tablet device. This device is usually needed to
364 allow absolute mouse positioning with VNC. Else the mouse runs out of sync
365 with normal VNC clients. If you're running lots of console-only guests on
366 one host, you may consider disabling this to save some context switches.
367 This is turned off by default if you use spice (-vga=qxl).
369 `-tdf` `boolean` (default=`0`)::
371 Enable/disable time drift fix.
373 `-template` `boolean` (default=`0`)::
375 Enable/disable Template.
377 `-unique` `boolean` ::
379 Assign a unique random ethernet address.
381 NOTE: Requires option(s): `archive`
383 `-unused[n]` `string` ::
385 Reference to unused volumes.
387 `-usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<yes|no>]` ::
389 Configure an USB device (n is 0 to 4). This can be used to
390 pass-through usb devices to the guest. HOSTUSBDEVICE syntax is:
392 'bus-port(.port)*' (decimal numbers) or
393 'vendor_id:product_id' (hexadeciaml numbers) or
396 You can use the 'lsusb -t' command to list existing usb devices.
398 NOTE: This option allows direct access to host hardware. So it is no longer
399 possible to migrate such machines - use with special care.
401 The value 'spice' can be used to add a usb redirection devices for spice.
403 The 'usb3' option determines whether the device is a USB3 device or not
404 (this does currently not work reliably with spice redirection and is then
407 `-vcpus` `integer (1 - N)` (default=`0`)::
409 Number of hotplugged vcpus.
411 `-vga` `(cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware)` ::
413 Select the VGA type. If you want to use high resolution modes (>=
414 1280x1024x16) then you should use the options 'std' or 'vmware'. Default is
415 'std' for win8/win7/w2k8, and 'cirrus' for other OS types. The 'qxl' option
416 enables the SPICE display sever. For win* OS you can select how many
417 independent displays you want, Linux guests can add displays them self. You
418 can also run without any graphic card, using a serial device as terminal.
420 `-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>]` ::
422 Use volume as VIRTIO hard disk (n is 0 to 15).
424 `-watchdog` `[action=<reset|shutdown|poweroff|pause|debug|none>] [,[model=]<i6300esb|ib700>]` ::
426 Create a virtual hardware watchdog device. Once enabled (by a guest
427 action), the watchdog must be periodically polled by an agent inside the
428 guest or else the watchdog will reset the guest (or execute the respective
433 *qm delsnapshot* `<vmid> <snapname>` `[OPTIONS]`
435 Delete a VM snapshot.
437 `<vmid>` `integer (1 - N)` ::
439 The (unique) ID of the VM.
441 `<snapname>` `string` ::
443 The name of the snapshot.
445 `-force` `boolean` ::
447 For removal from config file, even if removing disk snapshots fails.
451 *qm destroy* `<vmid>` `[OPTIONS]`
453 Destroy the vm (also delete all used/owned volumes).
455 `<vmid>` `integer (1 - N)` ::
457 The (unique) ID of the VM.
459 `-skiplock` `boolean` ::
461 Ignore locks - only root is allowed to use this option.
466 *qm help* `[<cmd>]` `[OPTIONS]`
468 Get help about specified command.
474 `-verbose` `boolean` ::
476 Verbose output format.
481 *qm list* `[OPTIONS]`
483 Virtual machine index (per node).
487 Determine the full status of active VMs.
491 *qm migrate* `<vmid> <target>` `[OPTIONS]`
493 Migrate virtual machine. Creates a new migration task.
495 `<vmid>` `integer (1 - N)` ::
497 The (unique) ID of the VM.
499 `<target>` `string` ::
503 `-force` `boolean` ::
505 Allow to migrate VMs which use local devices. Only root may use this
508 `-online` `boolean` ::
510 Use online/live migration.
515 *qm monitor* `<vmid>`
517 Enter Qemu Monitor interface.
519 `<vmid>` `integer (1 - N)` ::
521 The (unique) ID of the VM.
526 *qm move_disk* `<vmid> <disk> <storage>` `[OPTIONS]`
528 Move volume to different storage.
530 `<vmid>` `integer (1 - N)` ::
532 The (unique) ID of the VM.
534 `<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)` ::
536 The disk you want to move.
538 `<storage>` `string` ::
542 `-delete` `boolean` (default=`0`)::
544 Delete the original disk after successful copy. By default the original
545 disk is kept as unused disk.
547 `-digest` `string` ::
549 Prevent changes if current configuration file has different SHA1 digest.
550 This can be used to prevent concurrent modifications.
552 `-format` `(qcow2 | raw | vmdk)` ::
561 Used by qmigrate - do not use manually.
566 *qm pending* `<vmid>`
568 Get virtual machine configuration, including pending changes.
570 `<vmid>` `integer (1 - N)` ::
572 The (unique) ID of the VM.
577 *qm rescan* `[OPTIONS]`
579 Rescan all storages and update disk sizes and unused disk images.
581 `-vmid` `integer (1 - N)` ::
583 The (unique) ID of the VM.
588 *qm reset* `<vmid>` `[OPTIONS]`
590 Reset virtual machine.
592 `<vmid>` `integer (1 - N)` ::
594 The (unique) ID of the VM.
596 `-skiplock` `boolean` ::
598 Ignore locks - only root is allowed to use this option.
602 *qm resize* `<vmid> <disk> <size>` `[OPTIONS]`
606 `<vmid>` `integer (1 - N)` ::
608 The (unique) ID of the VM.
610 `<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)` ::
612 The disk you want to resize.
614 `<size>` `\+?\d+(\.\d+)?[KMGT]?` ::
616 The new size. With the '+' sign the value is added to the actual size of
617 the volume and without it, the value is taken as an absolute one. Shrinking
618 disk size is not supported.
620 `-digest` `string` ::
622 Prevent changes if current configuration file has different SHA1 digest.
623 This can be used to prevent concurrent modifications.
625 `-skiplock` `boolean` ::
627 Ignore locks - only root is allowed to use this option.
631 *qm resume* `<vmid>` `[OPTIONS]`
633 Resume virtual machine.
635 `<vmid>` `integer (1 - N)` ::
637 The (unique) ID of the VM.
639 `-nocheck` `boolean` ::
641 no description available
643 `-skiplock` `boolean` ::
645 Ignore locks - only root is allowed to use this option.
649 *qm rollback* `<vmid> <snapname>`
651 Rollback VM state to specified snapshot.
653 `<vmid>` `integer (1 - N)` ::
655 The (unique) ID of the VM.
657 `<snapname>` `string` ::
659 The name of the snapshot.
663 *qm sendkey* `<vmid> <key>` `[OPTIONS]`
665 Send key event to virtual machine.
667 `<vmid>` `integer (1 - N)` ::
669 The (unique) ID of the VM.
673 The key (qemu monitor encoding).
675 `-skiplock` `boolean` ::
677 Ignore locks - only root is allowed to use this option.
681 *qm set* `<vmid>` `[OPTIONS]`
683 Set virtual machine options (synchrounous API) - You should consider using
684 the POST method instead for any actions involving hotplug or storage
687 `<vmid>` `integer (1 - N)` ::
689 The (unique) ID of the VM.
691 `-acpi` `boolean` (default=`1`)::
695 `-agent` `boolean` (default=`0`)::
697 Enable/disable Qemu GuestAgent.
701 NOTE: this option is for experts only. It allows you to pass arbitrary
702 arguments to kvm, for example:
704 args: -no-reboot -no-hpet
706 `-autostart` `boolean` (default=`0`)::
708 Automatic restart after crash (currently ignored).
710 `-balloon` `integer (0 - N)` ::
712 Amount of target RAM for the VM in MB. Using zero disables the ballon
715 `-bios` `(ovmf | seabios)` (default=`seabios`)::
717 Select BIOS implementation.
719 `-boot` `[acdn]{1,4}` (default=`cdn`)::
721 Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).
723 `-bootdisk` `(ide|sata|scsi|virtio)\d+` ::
725 Enable booting from specified disk.
729 This is an alias for option -ide2
731 `-cores` `integer (1 - N)` (default=`1`)::
733 The number of cores per socket.
735 `-cpu` `[cputype=]<cputype> [,hidden=<1|0>]` ::
739 `-cpulimit` `number (0 - 128)` (default=`0`)::
743 NOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0'
744 indicates no CPU limit.
746 `-cpuunits` `integer (0 - 500000)` (default=`1000`)::
748 CPU weight for a VM. Argument is used in the kernel fair scheduler. The
749 larger the number is, the more CPU time this VM gets. Number is relative to
750 weights of all the other running VMs.
752 NOTE: You can disable fair-scheduler configuration by setting this to 0.
754 `-delete` `string` ::
756 A list of settings you want to delete.
758 `-description` `string` ::
760 Description for the VM. Only used on the configuration web interface. This
761 is saved as comment inside the configuration file.
763 `-digest` `string` ::
765 Prevent changes if current configuration file has different SHA1 digest.
766 This can be used to prevent concurrent modifications.
768 `-force` `boolean` ::
770 Force physical removal. Without this, we simple remove the disk from the
771 config file and create an additional configuration entry called
772 'unused[n]', which contains the volume ID. Unlink of unused[n] always cause
775 NOTE: Requires option(s): `delete`
777 `-freeze` `boolean` ::
779 Freeze CPU at startup (use 'c' monitor command to start execution).
781 `-hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,x-vga=<1|0>]` ::
783 Map host pci devices. HOSTPCIDEVICE syntax is:
785 'bus:dev.func' (hexadecimal numbers)
787 You can us the 'lspci' command to list existing pci devices.
789 The 'rombar' option determines whether or not the device's ROM will be
790 visible in the guest's memory map (default is 'on').
792 NOTE: This option allows direct access to host hardware. So it is no longer
793 possible to migrate such machines - use with special care.
795 Experimental: user reported problems with this option.
797 `-hotplug` `string` (default=`network,disk,usb`)::
799 Selectively enable hotplug features. This is a comma separated list of
800 hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to
801 disable hotplug completely. Value '1' is an alias for the default
804 `-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>]` ::
806 Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
808 `-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`)::
810 Keybord layout for vnc server. Default is read from the datacenter
813 `-kvm` `boolean` (default=`1`)::
815 Enable/disable KVM hardware virtualization.
817 `-localtime` `boolean` ::
819 Set the real time clock to local time. This is enabled by default if ostype
820 indicates a Microsoft OS.
822 `-lock` `(backup | migrate | rollback | snapshot)` ::
826 `-machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
828 Specific the Qemu machine type.
830 `-memory` `integer (16 - N)` (default=`512`)::
832 Amount of RAM for the VM in MB. This is the maximum available memory when
833 you use the balloon device.
835 `-migrate_downtime` `number (0 - N)` (default=`0.1`)::
837 Set maximum tolerated downtime (in seconds) for migrations.
839 `-migrate_speed` `integer (0 - N)` (default=`0`)::
841 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
845 Set a name for the VM. Only used on the configuration web interface.
847 `-net[n]` `string` ::
849 Specify network devices.
851 MODEL is one of: e1000 e1000-82540em e1000-82544gc e1000-82545em i82551
852 i82557b i82559er ne2k_isa ne2k_pci pcnet rtl8139 virtio vmxnet3
854 XX:XX:XX:XX:XX:XX should be an unique MAC address. This is
855 automatically generated if not specified.
857 The bridge parameter can be used to automatically add the interface to a
858 bridge device. The Proxmox VE standard bridge is called 'vmbr0'.
860 Option 'rate' is used to limit traffic bandwidth from and to this
861 interface. It is specified as floating point number, unit is 'Megabytes per
864 If you specify no bridge, we create a kvm 'user' (NATed) network device,
865 which provides DHCP and DNS services. The following addresses are used:
871 The DHCP server assign addresses to the guest starting from 10.0.2.15.
873 `-numa` `boolean` (default=`0`)::
877 `-numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<mb>] [,policy=<preferred|bind|interleave>]` ::
881 `-onboot` `boolean` (default=`0`)::
883 Specifies whether a VM will be started during system bootup.
885 `-ostype` `(l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win7 | win8 | wvista | wxp)` ::
887 Used to enable special optimization/features for specific
890 other => unspecified OS
891 wxp => Microsoft Windows XP
892 w2k => Microsoft Windows 2000
893 w2k3 => Microsoft Windows 2003
894 w2k8 => Microsoft Windows 2008
895 wvista => Microsoft Windows Vista
896 win7 => Microsoft Windows 7
897 win8 => Microsoft Windows 8/2012
898 l24 => Linux 2.4 Kernel
899 l26 => Linux 2.6/3.X Kernel
900 solaris => solaris/opensolaris/openindiania kernel
902 other|l24|l26|solaris ... no special behaviour
903 wxp|w2k|w2k3|w2k8|wvista|win7|win8 ... use --localtime switch
905 `-parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` ::
907 Map host parallel devices (n is 0 to 2).
909 NOTE: This option allows direct access to host hardware. So it is no longer
910 possible to migrate such machines - use with special care.
912 Experimental: user reported problems with this option.
914 `-protection` `boolean` (default=`0`)::
916 Sets the protection flag of the VM. This will prevent the remove operation.
918 `-reboot` `boolean` (default=`1`)::
920 Allow reboot. If set to '0' the VM exit on reboot.
922 `-revert` `string` ::
924 Revert a pending change.
926 `-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>]` ::
928 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
930 `-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>]` ::
932 Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
934 `-scsihw` `(lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single)` (default=`lsi`)::
936 scsi controller model
938 `-serial[n]` `(/dev/.+|socket)` ::
940 Create a serial device inside the VM (n is 0 to 3), and pass through a host
941 serial device (i.e. /dev/ttyS0), or create a unix socket on the host side
942 (use 'qm terminal' to open a terminal connection).
944 NOTE: If you pass through a host serial device, it is no longer possible to
945 migrate such machines - use with special care.
947 Experimental: user reported problems with this option.
949 `-shares` `integer (0 - 50000)` (default=`1000`)::
951 Amount of memory shares for auto-ballooning. The larger the number is, the
952 more memory this VM gets. Number is relative to weights of all other
953 running VMs. Using zero disables auto-ballooning
955 `-skiplock` `boolean` ::
957 Ignore locks - only root is allowed to use this option.
959 `-smbios[n]` `[family=<str>] [,manufacturer=<name>] [,product=<name>] [,serial=<str>] [,sku=<str>] [,uuid=<UUID>] [,version=<str>]` ::
961 Specify SMBIOS type 1 fields.
963 `-smp` `integer (1 - N)` (default=`1`)::
965 The number of CPUs. Please use option -sockets instead.
967 `-sockets` `integer (1 - N)` (default=`1`)::
969 The number of CPU sockets.
971 `-startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` (default=`now`)::
973 Set the initial date of the real time clock. Valid format for date are:
974 'now' or '2006-06-17T16:01:21' or '2006-06-17'.
976 `-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
978 Startup and shutdown behavior. Order is a non-negative number defining the
979 general startup order. Shutdown in done with reverse ordering. Additionally
980 you can set the 'up' or 'down' delay in seconds, which specifies a delay to
981 wait before the next VM is started or stopped.
983 `-tablet` `boolean` (default=`1`)::
985 Enable/disable the USB tablet device. This device is usually needed to
986 allow absolute mouse positioning with VNC. Else the mouse runs out of sync
987 with normal VNC clients. If you're running lots of console-only guests on
988 one host, you may consider disabling this to save some context switches.
989 This is turned off by default if you use spice (-vga=qxl).
991 `-tdf` `boolean` (default=`0`)::
993 Enable/disable time drift fix.
995 `-template` `boolean` (default=`0`)::
997 Enable/disable Template.
999 `-unused[n]` `string` ::
1001 Reference to unused volumes.
1003 `-usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<yes|no>]` ::
1005 Configure an USB device (n is 0 to 4). This can be used to
1006 pass-through usb devices to the guest. HOSTUSBDEVICE syntax is:
1008 'bus-port(.port)*' (decimal numbers) or
1009 'vendor_id:product_id' (hexadeciaml numbers) or
1012 You can use the 'lsusb -t' command to list existing usb devices.
1014 NOTE: This option allows direct access to host hardware. So it is no longer
1015 possible to migrate such machines - use with special care.
1017 The value 'spice' can be used to add a usb redirection devices for spice.
1019 The 'usb3' option determines whether the device is a USB3 device or not
1020 (this does currently not work reliably with spice redirection and is then
1023 `-vcpus` `integer (1 - N)` (default=`0`)::
1025 Number of hotplugged vcpus.
1027 `-vga` `(cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware)` ::
1029 Select the VGA type. If you want to use high resolution modes (>=
1030 1280x1024x16) then you should use the options 'std' or 'vmware'. Default is
1031 'std' for win8/win7/w2k8, and 'cirrus' for other OS types. The 'qxl' option
1032 enables the SPICE display sever. For win* OS you can select how many
1033 independent displays you want, Linux guests can add displays them self. You
1034 can also run without any graphic card, using a serial device as terminal.
1036 `-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>]` ::
1038 Use volume as VIRTIO hard disk (n is 0 to 15).
1040 `-watchdog` `[action=<reset|shutdown|poweroff|pause|debug|none>] [,[model=]<i6300esb|ib700>]` ::
1042 Create a virtual hardware watchdog device. Once enabled (by a guest
1043 action), the watchdog must be periodically polled by an agent inside the
1044 guest or else the watchdog will reset the guest (or execute the respective
1050 *qm showcmd* `<vmid>`
1052 Show command line which is used to start the VM (debug info).
1054 `<vmid>` `integer (1 - N)` ::
1056 The (unique) ID of the VM.
1061 *qm shutdown* `<vmid>` `[OPTIONS]`
1063 Shutdown virtual machine. This is similar to pressing the power button on a
1064 physical machine.This will send an ACPI event for the guest OS, which
1065 should then proceed to a clean shutdown.
1067 `<vmid>` `integer (1 - N)` ::
1069 The (unique) ID of the VM.
1071 `-forceStop` `boolean` (default=`0`)::
1073 Make sure the VM stops.
1075 `-keepActive` `boolean` (default=`0`)::
1077 Do not decativate storage volumes.
1079 `-skiplock` `boolean` ::
1081 Ignore locks - only root is allowed to use this option.
1083 `-timeout` `integer (0 - N)` ::
1085 Wait maximal timeout seconds.
1089 *qm snapshot* `<vmid> <snapname>` `[OPTIONS]`
1093 `<vmid>` `integer (1 - N)` ::
1095 The (unique) ID of the VM.
1097 `<snapname>` `string` ::
1099 The name of the snapshot.
1101 `-description` `string` ::
1103 A textual description or comment.
1105 `-vmstate` `boolean` ::
1111 *qm start* `<vmid>` `[OPTIONS]`
1113 Start virtual machine.
1115 `<vmid>` `integer (1 - N)` ::
1117 The (unique) ID of the VM.
1119 `-machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
1121 Specific the Qemu machine type.
1123 `-migratedfrom` `string` ::
1125 The cluster node name.
1127 `-skiplock` `boolean` ::
1129 Ignore locks - only root is allowed to use this option.
1131 `-stateuri` `string` ::
1133 Some command save/restore state from this location.
1138 *qm status* `<vmid>` `[OPTIONS]`
1142 `<vmid>` `integer (1 - N)` ::
1144 The (unique) ID of the VM.
1146 `-verbose` `boolean` ::
1148 Verbose output format
1153 *qm stop* `<vmid>` `[OPTIONS]`
1155 Stop virtual machine. The qemu process will exit immediately. Thisis akin
1156 to pulling the power plug of a running computer and may damage the VM data
1158 `<vmid>` `integer (1 - N)` ::
1160 The (unique) ID of the VM.
1162 `-keepActive` `boolean` (default=`0`)::
1164 Do not decativate storage volumes.
1166 `-migratedfrom` `string` ::
1168 The cluster node name.
1170 `-skiplock` `boolean` ::
1172 Ignore locks - only root is allowed to use this option.
1174 `-timeout` `integer (0 - N)` ::
1176 Wait maximal timeout seconds.
1180 *qm suspend* `<vmid>` `[OPTIONS]`
1182 Suspend virtual machine.
1184 `<vmid>` `integer (1 - N)` ::
1186 The (unique) ID of the VM.
1188 `-skiplock` `boolean` ::
1190 Ignore locks - only root is allowed to use this option.
1194 *qm template* `<vmid>` `[OPTIONS]`
1198 `<vmid>` `integer (1 - N)` ::
1200 The (unique) ID of the VM.
1202 `-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)` ::
1204 If you want to convert only 1 disk to base image.
1209 *qm terminal* `<vmid>` `[OPTIONS]`
1211 Open a terminal using a serial device (The VM need to have a serial device
1212 configured, for example 'serial0: socket')
1214 `<vmid>` `integer (1 - N)` ::
1216 The (unique) ID of the VM.
1218 `-iface` `(serial0 | serial1 | serial2 | serial3)` ::
1220 Select the serial device. By default we simply use the first suitable
1226 *qm unlink* `<vmid> -idlist <string>` `[OPTIONS]`
1228 Unlink/delete disk images.
1230 `<vmid>` `integer (1 - N)` ::
1232 The (unique) ID of the VM.
1234 `-force` `boolean` ::
1236 Force physical removal. Without this, we simple remove the disk from the
1237 config file and create an additional configuration entry called
1238 'unused[n]', which contains the volume ID. Unlink of unused[n] always cause
1241 `-idlist` `string` ::
1243 A list of disk IDs you want to delete.
1248 *qm unlock* `<vmid>`
1252 `<vmid>` `integer (1 - N)` ::
1254 The (unique) ID of the VM.
1258 *qm vncproxy* `<vmid>`
1260 Proxy VM VNC traffic to stdin/stdout
1262 `<vmid>` `integer (1 - N)` ::
1264 The (unique) ID of the VM.
1268 *qm wait* `<vmid>` `[OPTIONS]`
1270 Wait until the VM is stopped.
1272 `<vmid>` `integer (1 - N)` ::
1274 The (unique) ID of the VM.
1276 `-timeout` `integer (1 - N)` ::
1278 Timeout in seconds. Default is to wait forever.