1 *qm* `<COMMAND> [ARGS] [OPTIONS]`
3 *qm agent* `<vmid> <command>`
5 Execute Qemu Guest Agent commands.
7 `<vmid>`: `<integer> (1 - N)` ::
9 The (unique) ID of the VM.
11 `<command>`: `<fsfreeze-freeze | fsfreeze-status | fsfreeze-thaw | fstrim | get-fsinfo | get-memory-block-info | get-memory-blocks | get-time | get-vcpus | info | network-get-interfaces | ping | shutdown | suspend-disk | suspend-hybrid | suspend-ram>` ::
17 *qm clone* `<vmid> <newid>` `[OPTIONS]`
19 Create a copy of virtual machine/template.
21 `<vmid>`: `<integer> (1 - N)` ::
23 The (unique) ID of the VM.
25 `<newid>`: `<integer> (1 - N)` ::
29 `-description` `<string>` ::
31 Description for the new VM.
33 `-format` `<qcow2 | raw | vmdk>` ::
35 Target format for file storage.
37 NOTE: Requires option(s): `full`
39 `-full` `<boolean>` ('default =' `0`)::
41 Create a full copy of all disk. This is always done when you clone a normal VM. For VM templates, we try to create a linked clone by default.
45 Set a name for the new VM.
49 Add the new VM to the specified pool.
51 `-snapname` `<string>` ::
53 The name of the snapshot.
55 `-storage` `<string>` ::
57 Target storage for full clone.
59 NOTE: Requires option(s): `full`
61 `-target` `<string>` ::
63 Target node. Only allowed if the original VM is on shared storage.
67 *qm config* `<vmid>` `[OPTIONS]`
69 Get current virtual machine configuration. This does not include pending
70 configuration changes (see 'pending' API).
72 `<vmid>`: `<integer> (1 - N)` ::
74 The (unique) ID of the VM.
76 `-current` `<boolean>` ('default =' `0`)::
78 Get current values (instead of pending values).
82 *qm create* `<vmid>` `[OPTIONS]`
84 Create or restore a virtual machine.
86 `<vmid>`: `<integer> (1 - N)` ::
88 The (unique) ID of the VM.
90 `-acpi` `<boolean>` ('default =' `1`)::
94 `-agent` `<boolean>` ('default =' `0`)::
96 Enable/disable Qemu GuestAgent.
98 `-archive` `<string>` ::
102 `-args` `<string>` ::
104 Arbitrary arguments passed to kvm.
106 `-autostart` `<boolean>` ('default =' `0`)::
108 Automatic restart after crash (currently ignored).
110 `-balloon` `<integer> (0 - N)` ::
112 Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
114 `-bios` `<ovmf | seabios>` ('default =' `seabios`)::
116 Select BIOS implementation.
118 `-boot` `[acdn]{1,4}` ('default =' `cdn`)::
120 Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).
122 `-bootdisk` `(ide|sata|scsi|virtio)\d+` ::
124 Enable booting from specified disk.
126 `-cdrom` `<volume>` ::
128 This is an alias for option -ide2
130 `-cores` `<integer> (1 - N)` ('default =' `1`)::
132 The number of cores per socket.
134 `-cpu` `[cputype=]<enum> [,hidden=<1|0>]` ::
138 `-cpulimit` `<number> (0 - 128)` ('default =' `0`)::
142 `-cpuunits` `<integer> (0 - 500000)` ('default =' `1024`)::
146 `-description` `<string>` ::
148 Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.
150 `-efidisk0` `[file=]<volume> [,format=<enum>] [,size=<DiskSize>]` ::
152 Configure a Disk for storing EFI vars
154 `-force` `<boolean>` ::
156 Allow to overwrite existing VM.
158 NOTE: Requires option(s): `archive`
160 `-freeze` `<boolean>` ::
162 Freeze CPU at startup (use 'c' monitor command to start execution).
164 `-hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,x-vga=<1|0>]` ::
166 Map host PCI devices into guest.
168 `-hotplug` `<string>` ('default =' `network,disk,usb`)::
170 Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to disable hotplug completely. Value '1' is an alias for the default 'network,disk,usb'.
172 `-hugepages` `<1024 | 2 | any>` ::
174 Enable/disable hugepages memory.
176 `-ide[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
178 Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
180 `-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`)::
182 Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.
184 `-kvm` `<boolean>` ('default =' `1`)::
186 Enable/disable KVM hardware virtualization.
188 `-localtime` `<boolean>` ::
190 Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
192 `-lock` `<backup | migrate | rollback | snapshot>` ::
196 `-machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
198 Specific the Qemu machine type.
200 `-memory` `<integer> (16 - N)` ('default =' `512`)::
202 Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
204 `-migrate_downtime` `<number> (0 - N)` ('default =' `0.1`)::
206 Set maximum tolerated downtime (in seconds) for migrations.
208 `-migrate_speed` `<integer> (0 - N)` ('default =' `0`)::
210 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
212 `-name` `<string>` ::
214 Set a name for the VM. Only used on the configuration web interface.
216 `-net[n]` `[model=]<enum> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]` ::
218 Specify network devices.
220 `-numa` `<boolean>` ('default =' `0`)::
224 `-numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
228 `-onboot` `<boolean>` ('default =' `0`)::
230 Specifies whether a VM will be started during system bootup.
232 `-ostype` `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win7 | win8 | wvista | wxp>` ::
234 Specify guest operating system.
236 `-parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` ::
238 Map host parallel devices (n is 0 to 2).
240 `-pool` `<string>` ::
242 Add the VM to the specified pool.
244 `-protection` `<boolean>` ('default =' `0`)::
246 Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
248 `-reboot` `<boolean>` ('default =' `1`)::
250 Allow reboot. If set to '0' the VM exit on reboot.
252 `-sata[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
254 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
256 `-scsi[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,queues=<integer>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
258 Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
260 `-scsihw` `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
262 SCSI controller model
264 `-serial[n]` `(/dev/.+|socket)` ::
266 Create a serial device inside the VM (n is 0 to 3)
268 `-shares` `<integer> (0 - 50000)` ('default =' `1000`)::
270 Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning
272 `-smbios1` `[family=<string>] [,manufacturer=<string>] [,product=<string>] [,serial=<string>] [,sku=<string>] [,uuid=<UUID>] [,version=<string>]` ::
274 Specify SMBIOS type 1 fields.
276 `-smp` `<integer> (1 - N)` ('default =' `1`)::
278 The number of CPUs. Please use option -sockets instead.
280 `-sockets` `<integer> (1 - N)` ('default =' `1`)::
282 The number of CPU sockets.
284 `-startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
286 Set the initial date of the real time clock. Valid format for date are: 'now' or '2006-06-17T16:01:21' or '2006-06-17'.
288 `-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
290 Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.
292 `-storage` `<string>` ::
296 `-tablet` `<boolean>` ('default =' `1`)::
298 Enable/disable the USB tablet device.
300 `-tdf` `<boolean>` ('default =' `0`)::
302 Enable/disable time drift fix.
304 `-template` `<boolean>` ('default =' `0`)::
306 Enable/disable Template.
308 `-unique` `<boolean>` ::
310 Assign a unique random ethernet address.
312 NOTE: Requires option(s): `archive`
314 `-unused[n]` `<string>` ::
316 Reference to unused volumes. This is used internally, and should not be modified manually.
318 `-usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
320 Configure an USB device (n is 0 to 4).
322 `-vcpus` `<integer> (1 - N)` ('default =' `0`)::
324 Number of hotplugged vcpus.
326 `-vga` `<cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware>` ::
330 `-virtio[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
332 Use volume as VIRTIO hard disk (n is 0 to 15).
334 `-watchdog` `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::
336 Create a virtual hardware watchdog device.
340 *qm delsnapshot* `<vmid> <snapname>` `[OPTIONS]`
342 Delete a VM snapshot.
344 `<vmid>`: `<integer> (1 - N)` ::
346 The (unique) ID of the VM.
348 `<snapname>`: `<string>` ::
350 The name of the snapshot.
352 `-force` `<boolean>` ::
354 For removal from config file, even if removing disk snapshots fails.
358 *qm destroy* `<vmid>` `[OPTIONS]`
360 Destroy the vm (also delete all used/owned volumes).
362 `<vmid>`: `<integer> (1 - N)` ::
364 The (unique) ID of the VM.
366 `-skiplock` `<boolean>` ::
368 Ignore locks - only root is allowed to use this option.
373 *qm help* `[<cmd>]` `[OPTIONS]`
375 Get help about specified command.
377 `<cmd>`: `<string>` ::
381 `-verbose` `<boolean>` ::
383 Verbose output format.
388 *qm list* `[OPTIONS]`
390 Virtual machine index (per node).
392 `-full` `<boolean>` ::
394 Determine the full status of active VMs.
398 *qm listsnapshot* `<vmid>`
402 `<vmid>`: `<integer> (1 - N)` ::
404 The (unique) ID of the VM.
408 *qm migrate* `<vmid> <target>` `[OPTIONS]`
410 Migrate virtual machine. Creates a new migration task.
412 `<vmid>`: `<integer> (1 - N)` ::
414 The (unique) ID of the VM.
416 `<target>`: `<string>` ::
420 `-force` `<boolean>` ::
422 Allow to migrate VMs which use local devices. Only root may use this option.
424 `-migration_network` `<string>` ::
426 CIDR of the (sub) network that is used for migration.
428 `-migration_type` `<insecure | secure>` ::
430 Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.
432 `-online` `<boolean>` ::
434 Use online/live migration.
439 *qm monitor* `<vmid>`
441 Enter Qemu Monitor interface.
443 `<vmid>`: `<integer> (1 - N)` ::
445 The (unique) ID of the VM.
450 *qm move_disk* `<vmid> <disk> <storage>` `[OPTIONS]`
452 Move volume to different storage.
454 `<vmid>`: `<integer> (1 - N)` ::
456 The (unique) ID of the VM.
458 `<disk>`: `<efidisk0 | ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi2 | scsi3 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9>` ::
460 The disk you want to move.
462 `<storage>`: `<string>` ::
466 `-delete` `<boolean>` ('default =' `0`)::
468 Delete the original disk after successful copy. By default the original disk is kept as unused disk.
470 `-digest` `<string>` ::
472 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
474 `-format` `<qcow2 | raw | vmdk>` ::
483 Used by qmigrate - do not use manually.
488 *qm pending* `<vmid>`
490 Get virtual machine configuration, including pending changes.
492 `<vmid>`: `<integer> (1 - N)` ::
494 The (unique) ID of the VM.
499 *qm rescan* `[OPTIONS]`
501 Rescan all storages and update disk sizes and unused disk images.
503 `-vmid` `<integer> (1 - N)` ::
505 The (unique) ID of the VM.
510 *qm reset* `<vmid>` `[OPTIONS]`
512 Reset virtual machine.
514 `<vmid>`: `<integer> (1 - N)` ::
516 The (unique) ID of the VM.
518 `-skiplock` `<boolean>` ::
520 Ignore locks - only root is allowed to use this option.
524 *qm resize* `<vmid> <disk> <size>` `[OPTIONS]`
528 `<vmid>`: `<integer> (1 - N)` ::
530 The (unique) ID of the VM.
532 `<disk>`: `<efidisk0 | ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi2 | scsi3 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9>` ::
534 The disk you want to resize.
536 `<size>`: `\+?\d+(\.\d+)?[KMGT]?` ::
538 The new size. With the '+' sign the value is added to the actual size of the volume and without it, the value is taken as an absolute one. Shrinking disk size is not supported.
540 `-digest` `<string>` ::
542 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
544 `-skiplock` `<boolean>` ::
546 Ignore locks - only root is allowed to use this option.
550 *qm resume* `<vmid>` `[OPTIONS]`
552 Resume virtual machine.
554 `<vmid>`: `<integer> (1 - N)` ::
556 The (unique) ID of the VM.
558 `-nocheck` `<boolean>` ::
560 no description available
562 `-skiplock` `<boolean>` ::
564 Ignore locks - only root is allowed to use this option.
568 *qm rollback* `<vmid> <snapname>`
570 Rollback VM state to specified snapshot.
572 `<vmid>`: `<integer> (1 - N)` ::
574 The (unique) ID of the VM.
576 `<snapname>`: `<string>` ::
578 The name of the snapshot.
582 *qm sendkey* `<vmid> <key>` `[OPTIONS]`
584 Send key event to virtual machine.
586 `<vmid>`: `<integer> (1 - N)` ::
588 The (unique) ID of the VM.
590 `<key>`: `<string>` ::
592 The key (qemu monitor encoding).
594 `-skiplock` `<boolean>` ::
596 Ignore locks - only root is allowed to use this option.
600 *qm set* `<vmid>` `[OPTIONS]`
602 Set virtual machine options (synchrounous API) - You should consider using
603 the POST method instead for any actions involving hotplug or storage
606 `<vmid>`: `<integer> (1 - N)` ::
608 The (unique) ID of the VM.
610 `-acpi` `<boolean>` ('default =' `1`)::
614 `-agent` `<boolean>` ('default =' `0`)::
616 Enable/disable Qemu GuestAgent.
618 `-args` `<string>` ::
620 Arbitrary arguments passed to kvm.
622 `-autostart` `<boolean>` ('default =' `0`)::
624 Automatic restart after crash (currently ignored).
626 `-balloon` `<integer> (0 - N)` ::
628 Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
630 `-bios` `<ovmf | seabios>` ('default =' `seabios`)::
632 Select BIOS implementation.
634 `-boot` `[acdn]{1,4}` ('default =' `cdn`)::
636 Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).
638 `-bootdisk` `(ide|sata|scsi|virtio)\d+` ::
640 Enable booting from specified disk.
642 `-cdrom` `<volume>` ::
644 This is an alias for option -ide2
646 `-cores` `<integer> (1 - N)` ('default =' `1`)::
648 The number of cores per socket.
650 `-cpu` `[cputype=]<enum> [,hidden=<1|0>]` ::
654 `-cpulimit` `<number> (0 - 128)` ('default =' `0`)::
658 `-cpuunits` `<integer> (0 - 500000)` ('default =' `1024`)::
662 `-delete` `<string>` ::
664 A list of settings you want to delete.
666 `-description` `<string>` ::
668 Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.
670 `-digest` `<string>` ::
672 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
674 `-efidisk0` `[file=]<volume> [,format=<enum>] [,size=<DiskSize>]` ::
676 Configure a Disk for storing EFI vars
678 `-force` `<boolean>` ::
680 Force physical removal. Without this, we simple remove the disk from the config file and create an additional configuration entry called 'unused[n]', which contains the volume ID. Unlink of unused[n] always cause physical removal.
682 NOTE: Requires option(s): `delete`
684 `-freeze` `<boolean>` ::
686 Freeze CPU at startup (use 'c' monitor command to start execution).
688 `-hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,x-vga=<1|0>]` ::
690 Map host PCI devices into guest.
692 `-hotplug` `<string>` ('default =' `network,disk,usb`)::
694 Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to disable hotplug completely. Value '1' is an alias for the default 'network,disk,usb'.
696 `-hugepages` `<1024 | 2 | any>` ::
698 Enable/disable hugepages memory.
700 `-ide[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
702 Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
704 `-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`)::
706 Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.
708 `-kvm` `<boolean>` ('default =' `1`)::
710 Enable/disable KVM hardware virtualization.
712 `-localtime` `<boolean>` ::
714 Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
716 `-lock` `<backup | migrate | rollback | snapshot>` ::
720 `-machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
722 Specific the Qemu machine type.
724 `-memory` `<integer> (16 - N)` ('default =' `512`)::
726 Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
728 `-migrate_downtime` `<number> (0 - N)` ('default =' `0.1`)::
730 Set maximum tolerated downtime (in seconds) for migrations.
732 `-migrate_speed` `<integer> (0 - N)` ('default =' `0`)::
734 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
736 `-name` `<string>` ::
738 Set a name for the VM. Only used on the configuration web interface.
740 `-net[n]` `[model=]<enum> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]` ::
742 Specify network devices.
744 `-numa` `<boolean>` ('default =' `0`)::
748 `-numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
752 `-onboot` `<boolean>` ('default =' `0`)::
754 Specifies whether a VM will be started during system bootup.
756 `-ostype` `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win7 | win8 | wvista | wxp>` ::
758 Specify guest operating system.
760 `-parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` ::
762 Map host parallel devices (n is 0 to 2).
764 `-protection` `<boolean>` ('default =' `0`)::
766 Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
768 `-reboot` `<boolean>` ('default =' `1`)::
770 Allow reboot. If set to '0' the VM exit on reboot.
772 `-revert` `<string>` ::
774 Revert a pending change.
776 `-sata[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
778 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
780 `-scsi[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,queues=<integer>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
782 Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
784 `-scsihw` `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
786 SCSI controller model
788 `-serial[n]` `(/dev/.+|socket)` ::
790 Create a serial device inside the VM (n is 0 to 3)
792 `-shares` `<integer> (0 - 50000)` ('default =' `1000`)::
794 Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning
796 `-skiplock` `<boolean>` ::
798 Ignore locks - only root is allowed to use this option.
800 `-smbios1` `[family=<string>] [,manufacturer=<string>] [,product=<string>] [,serial=<string>] [,sku=<string>] [,uuid=<UUID>] [,version=<string>]` ::
802 Specify SMBIOS type 1 fields.
804 `-smp` `<integer> (1 - N)` ('default =' `1`)::
806 The number of CPUs. Please use option -sockets instead.
808 `-sockets` `<integer> (1 - N)` ('default =' `1`)::
810 The number of CPU sockets.
812 `-startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
814 Set the initial date of the real time clock. Valid format for date are: 'now' or '2006-06-17T16:01:21' or '2006-06-17'.
816 `-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
818 Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.
820 `-tablet` `<boolean>` ('default =' `1`)::
822 Enable/disable the USB tablet device.
824 `-tdf` `<boolean>` ('default =' `0`)::
826 Enable/disable time drift fix.
828 `-template` `<boolean>` ('default =' `0`)::
830 Enable/disable Template.
832 `-unused[n]` `<string>` ::
834 Reference to unused volumes. This is used internally, and should not be modified manually.
836 `-usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
838 Configure an USB device (n is 0 to 4).
840 `-vcpus` `<integer> (1 - N)` ('default =' `0`)::
842 Number of hotplugged vcpus.
844 `-vga` `<cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware>` ::
848 `-virtio[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
850 Use volume as VIRTIO hard disk (n is 0 to 15).
852 `-watchdog` `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::
854 Create a virtual hardware watchdog device.
859 *qm showcmd* `<vmid>`
861 Show command line which is used to start the VM (debug info).
863 `<vmid>`: `<integer> (1 - N)` ::
865 The (unique) ID of the VM.
870 *qm shutdown* `<vmid>` `[OPTIONS]`
872 Shutdown virtual machine. This is similar to pressing the power button on a
873 physical machine.This will send an ACPI event for the guest OS, which
874 should then proceed to a clean shutdown.
876 `<vmid>`: `<integer> (1 - N)` ::
878 The (unique) ID of the VM.
880 `-forceStop` `<boolean>` ('default =' `0`)::
882 Make sure the VM stops.
884 `-keepActive` `<boolean>` ('default =' `0`)::
886 Do not deactivate storage volumes.
888 `-skiplock` `<boolean>` ::
890 Ignore locks - only root is allowed to use this option.
892 `-timeout` `<integer> (0 - N)` ::
894 Wait maximal timeout seconds.
898 *qm snapshot* `<vmid> <snapname>` `[OPTIONS]`
902 `<vmid>`: `<integer> (1 - N)` ::
904 The (unique) ID of the VM.
906 `<snapname>`: `<string>` ::
908 The name of the snapshot.
910 `-description` `<string>` ::
912 A textual description or comment.
914 `-vmstate` `<boolean>` ::
920 *qm start* `<vmid>` `[OPTIONS]`
922 Start virtual machine.
924 `<vmid>`: `<integer> (1 - N)` ::
926 The (unique) ID of the VM.
928 `-machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
930 Specific the Qemu machine type.
932 `-migratedfrom` `<string>` ::
934 The cluster node name.
936 `-migration_network` `<string>` ::
938 CIDR of the (sub) network that is used for migration.
940 `-migration_type` `<insecure | secure>` ::
942 Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.
944 `-skiplock` `<boolean>` ::
946 Ignore locks - only root is allowed to use this option.
948 `-stateuri` `<string>` ::
950 Some command save/restore state from this location.
955 *qm status* `<vmid>` `[OPTIONS]`
959 `<vmid>`: `<integer> (1 - N)` ::
961 The (unique) ID of the VM.
963 `-verbose` `<boolean>` ::
965 Verbose output format
970 *qm stop* `<vmid>` `[OPTIONS]`
972 Stop virtual machine. The qemu process will exit immediately. Thisis akin
973 to pulling the power plug of a running computer and may damage the VM data
975 `<vmid>`: `<integer> (1 - N)` ::
977 The (unique) ID of the VM.
979 `-keepActive` `<boolean>` ('default =' `0`)::
981 Do not deactivate storage volumes.
983 `-migratedfrom` `<string>` ::
985 The cluster node name.
987 `-skiplock` `<boolean>` ::
989 Ignore locks - only root is allowed to use this option.
991 `-timeout` `<integer> (0 - N)` ::
993 Wait maximal timeout seconds.
997 *qm suspend* `<vmid>` `[OPTIONS]`
999 Suspend virtual machine.
1001 `<vmid>`: `<integer> (1 - N)` ::
1003 The (unique) ID of the VM.
1005 `-skiplock` `<boolean>` ::
1007 Ignore locks - only root is allowed to use this option.
1011 *qm template* `<vmid>` `[OPTIONS]`
1015 `<vmid>`: `<integer> (1 - N)` ::
1017 The (unique) ID of the VM.
1019 `-disk` `<efidisk0 | ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi2 | scsi3 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9>` ::
1021 If you want to convert only 1 disk to base image.
1026 *qm terminal* `<vmid>` `[OPTIONS]`
1028 Open a terminal using a serial device (The VM need to have a serial device
1029 configured, for example 'serial0: socket')
1031 `<vmid>`: `<integer> (1 - N)` ::
1033 The (unique) ID of the VM.
1035 `-iface` `<serial0 | serial1 | serial2 | serial3>` ::
1037 Select the serial device. By default we simply use the first suitable device.
1042 *qm unlink* `<vmid> -idlist <string>` `[OPTIONS]`
1044 Unlink/delete disk images.
1046 `<vmid>`: `<integer> (1 - N)` ::
1048 The (unique) ID of the VM.
1050 `-force` `<boolean>` ::
1052 Force physical removal. Without this, we simple remove the disk from the config file and create an additional configuration entry called 'unused[n]', which contains the volume ID. Unlink of unused[n] always cause physical removal.
1054 `-idlist` `<string>` ::
1056 A list of disk IDs you want to delete.
1061 *qm unlock* `<vmid>`
1065 `<vmid>`: `<integer> (1 - N)` ::
1067 The (unique) ID of the VM.
1071 *qm vncproxy* `<vmid>`
1073 Proxy VM VNC traffic to stdin/stdout
1075 `<vmid>`: `<integer> (1 - N)` ::
1077 The (unique) ID of the VM.
1081 *qm wait* `<vmid>` `[OPTIONS]`
1083 Wait until the VM is stopped.
1085 `<vmid>`: `<integer> (1 - N)` ::
1087 The (unique) ID of the VM.
1089 `-timeout` `<integer> (1 - N)` ::
1091 Timeout in seconds. Default is to wait forever.