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.
43 `--name` `<string>` ::
45 Set a name for the new VM.
47 `--pool` `<string>` ::
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> (2 - 262144)` ('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>] [,romfile=<string>] [,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_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_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_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,replicate=<1|0>] [,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_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_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_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,replicate=<1|0>] [,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_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_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_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,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>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,scsiblock=<1|0>] [,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_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_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_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,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>] [,replicate=<1|0>] [,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 `--vmstatestorage` `<string>` ::
336 Default storage for VM state volumes/files.
338 `--watchdog` `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::
340 Create a virtual hardware watchdog device.
344 *qm delsnapshot* `<vmid> <snapname>` `[OPTIONS]`
346 Delete a VM snapshot.
348 `<vmid>`: `<integer> (1 - N)` ::
350 The (unique) ID of the VM.
352 `<snapname>`: `<string>` ::
354 The name of the snapshot.
356 `--force` `<boolean>` ::
358 For removal from config file, even if removing disk snapshots fails.
362 *qm destroy* `<vmid>` `[OPTIONS]`
364 Destroy the vm (also delete all used/owned volumes).
366 `<vmid>`: `<integer> (1 - N)` ::
368 The (unique) ID of the VM.
370 `--skiplock` `<boolean>` ::
372 Ignore locks - only root is allowed to use this option.
377 *qm help* `[<cmd>]` `[OPTIONS]`
379 Get help about specified command.
381 `<cmd>`: `<string>` ::
385 `--verbose` `<boolean>` ::
387 Verbose output format.
392 *qm importdisk* `<vmid> <source> <storage>` `[OPTIONS]`
394 Import an external disk image as an unused disk in a VM. The
395 image format has to be supported by qemu-img(1).
397 `<vmid>`: `<integer> (1 - N)` ::
399 The (unique) ID of the VM.
401 `<source>`: `<string>` ::
403 Path to the disk image to import
405 `<storage>`: `<string>` ::
409 `--format` `<qcow2 | raw | vmdk>` ::
415 *qm importovf* `<vmid> <manifest> <storage>` `[OPTIONS]`
417 Create a new VM using parameters read from an OVF manifest
419 `<vmid>`: `<integer> (1 - N)` ::
421 The (unique) ID of the VM.
423 `<manifest>`: `<string>` ::
427 `<storage>`: `<string>` ::
431 `--dryrun` `<boolean>` ::
433 Print a parsed representation of the extracted OVF parameters, but do not create a VM
435 `--format` `<qcow2 | raw | vmdk>` ::
442 *qm list* `[OPTIONS]`
444 Virtual machine index (per node).
446 `--full` `<boolean>` ::
448 Determine the full status of active VMs.
452 *qm listsnapshot* `<vmid>`
456 `<vmid>`: `<integer> (1 - N)` ::
458 The (unique) ID of the VM.
462 *qm migrate* `<vmid> <target>` `[OPTIONS]`
464 Migrate virtual machine. Creates a new migration task.
466 `<vmid>`: `<integer> (1 - N)` ::
468 The (unique) ID of the VM.
470 `<target>`: `<string>` ::
474 `--force` `<boolean>` ::
476 Allow to migrate VMs which use local devices. Only root may use this option.
478 `--migration_network` `<string>` ::
480 CIDR of the (sub) network that is used for migration.
482 `--migration_type` `<insecure | secure>` ::
484 Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.
486 `--online` `<boolean>` ::
488 Use online/live migration.
490 `--targetstorage` `<string>` ::
492 Default target storage.
494 `--with-local-disks` `<boolean>` ::
496 Enable live storage migration for local disk
501 *qm monitor* `<vmid>`
503 Enter Qemu Monitor interface.
505 `<vmid>`: `<integer> (1 - N)` ::
507 The (unique) ID of the VM.
512 *qm move_disk* `<vmid> <disk> <storage>` `[OPTIONS]`
514 Move volume to different storage.
516 `<vmid>`: `<integer> (1 - N)` ::
518 The (unique) ID of the VM.
520 `<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>` ::
522 The disk you want to move.
524 `<storage>`: `<string>` ::
528 `--delete` `<boolean>` ('default =' `0`)::
530 Delete the original disk after successful copy. By default the original disk is kept as unused disk.
532 `--digest` `<string>` ::
534 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
536 `--format` `<qcow2 | raw | vmdk>` ::
545 Used by qmigrate - do not use manually.
549 *qm nbdstop* `<vmid>`
551 Stop embedded nbd server.
553 `<vmid>`: `<integer> (1 - N)` ::
555 The (unique) ID of the VM.
560 *qm pending* `<vmid>`
562 Get virtual machine configuration, including pending changes.
564 `<vmid>`: `<integer> (1 - N)` ::
566 The (unique) ID of the VM.
571 *qm rescan* `[OPTIONS]`
573 Rescan all storages and update disk sizes and unused disk images.
575 `--vmid` `<integer> (1 - N)` ::
577 The (unique) ID of the VM.
582 *qm reset* `<vmid>` `[OPTIONS]`
584 Reset virtual machine.
586 `<vmid>`: `<integer> (1 - N)` ::
588 The (unique) ID of the VM.
590 `--skiplock` `<boolean>` ::
592 Ignore locks - only root is allowed to use this option.
596 *qm resize* `<vmid> <disk> <size>` `[OPTIONS]`
600 `<vmid>`: `<integer> (1 - N)` ::
602 The (unique) ID of the VM.
604 `<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>` ::
606 The disk you want to resize.
608 `<size>`: `\+?\d+(\.\d+)?[KMGT]?` ::
610 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.
612 `--digest` `<string>` ::
614 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
616 `--skiplock` `<boolean>` ::
618 Ignore locks - only root is allowed to use this option.
622 *qm resume* `<vmid>` `[OPTIONS]`
624 Resume virtual machine.
626 `<vmid>`: `<integer> (1 - N)` ::
628 The (unique) ID of the VM.
630 `--nocheck` `<boolean>` ::
632 no description available
634 `--skiplock` `<boolean>` ::
636 Ignore locks - only root is allowed to use this option.
640 *qm rollback* `<vmid> <snapname>`
642 Rollback VM state to specified snapshot.
644 `<vmid>`: `<integer> (1 - N)` ::
646 The (unique) ID of the VM.
648 `<snapname>`: `<string>` ::
650 The name of the snapshot.
654 *qm sendkey* `<vmid> <key>` `[OPTIONS]`
656 Send key event to virtual machine.
658 `<vmid>`: `<integer> (1 - N)` ::
660 The (unique) ID of the VM.
662 `<key>`: `<string>` ::
664 The key (qemu monitor encoding).
666 `--skiplock` `<boolean>` ::
668 Ignore locks - only root is allowed to use this option.
672 *qm set* `<vmid>` `[OPTIONS]`
674 Set virtual machine options (synchrounous API) - You should consider using
675 the POST method instead for any actions involving hotplug or storage
678 `<vmid>`: `<integer> (1 - N)` ::
680 The (unique) ID of the VM.
682 `--acpi` `<boolean>` ('default =' `1`)::
686 `--agent` `<boolean>` ('default =' `0`)::
688 Enable/disable Qemu GuestAgent.
690 `--args` `<string>` ::
692 Arbitrary arguments passed to kvm.
694 `--autostart` `<boolean>` ('default =' `0`)::
696 Automatic restart after crash (currently ignored).
698 `--balloon` `<integer> (0 - N)` ::
700 Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
702 `--bios` `<ovmf | seabios>` ('default =' `seabios`)::
704 Select BIOS implementation.
706 `--boot` `[acdn]{1,4}` ('default =' `cdn`)::
708 Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).
710 `--bootdisk` `(ide|sata|scsi|virtio)\d+` ::
712 Enable booting from specified disk.
714 `--cdrom` `<volume>` ::
716 This is an alias for option -ide2
718 `--cores` `<integer> (1 - N)` ('default =' `1`)::
720 The number of cores per socket.
722 `--cpu` `[cputype=]<enum> [,hidden=<1|0>]` ::
726 `--cpulimit` `<number> (0 - 128)` ('default =' `0`)::
730 `--cpuunits` `<integer> (2 - 262144)` ('default =' `1024`)::
734 `--delete` `<string>` ::
736 A list of settings you want to delete.
738 `--description` `<string>` ::
740 Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.
742 `--digest` `<string>` ::
744 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
746 `--efidisk0` `[file=]<volume> [,format=<enum>] [,size=<DiskSize>]` ::
748 Configure a Disk for storing EFI vars
750 `--force` `<boolean>` ::
752 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.
754 NOTE: Requires option(s): `delete`
756 `--freeze` `<boolean>` ::
758 Freeze CPU at startup (use 'c' monitor command to start execution).
760 `--hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
762 Map host PCI devices into guest.
764 `--hotplug` `<string>` ('default =' `network,disk,usb`)::
766 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'.
768 `--hugepages` `<1024 | 2 | any>` ::
770 Enable/disable hugepages memory.
772 `--ide[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_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_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
774 Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
776 `--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`)::
778 Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.
780 `--kvm` `<boolean>` ('default =' `1`)::
782 Enable/disable KVM hardware virtualization.
784 `--localtime` `<boolean>` ::
786 Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
788 `--lock` `<backup | migrate | rollback | snapshot>` ::
792 `--machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
794 Specific the Qemu machine type.
796 `--memory` `<integer> (16 - N)` ('default =' `512`)::
798 Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
800 `--migrate_downtime` `<number> (0 - N)` ('default =' `0.1`)::
802 Set maximum tolerated downtime (in seconds) for migrations.
804 `--migrate_speed` `<integer> (0 - N)` ('default =' `0`)::
806 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
808 `--name` `<string>` ::
810 Set a name for the VM. Only used on the configuration web interface.
812 `--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>]` ::
814 Specify network devices.
816 `--numa` `<boolean>` ('default =' `0`)::
820 `--numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
824 `--onboot` `<boolean>` ('default =' `0`)::
826 Specifies whether a VM will be started during system bootup.
828 `--ostype` `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win7 | win8 | wvista | wxp>` ::
830 Specify guest operating system.
832 `--parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` ::
834 Map host parallel devices (n is 0 to 2).
836 `--protection` `<boolean>` ('default =' `0`)::
838 Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
840 `--reboot` `<boolean>` ('default =' `1`)::
842 Allow reboot. If set to '0' the VM exit on reboot.
844 `--revert` `<string>` ::
846 Revert a pending change.
848 `--sata[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_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_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
850 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
852 `--scsi[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_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_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,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>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,scsiblock=<1|0>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
854 Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
856 `--scsihw` `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
858 SCSI controller model
860 `--serial[n]` `(/dev/.+|socket)` ::
862 Create a serial device inside the VM (n is 0 to 3)
864 `--shares` `<integer> (0 - 50000)` ('default =' `1000`)::
866 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
868 `--skiplock` `<boolean>` ::
870 Ignore locks - only root is allowed to use this option.
872 `--smbios1` `[family=<string>] [,manufacturer=<string>] [,product=<string>] [,serial=<string>] [,sku=<string>] [,uuid=<UUID>] [,version=<string>]` ::
874 Specify SMBIOS type 1 fields.
876 `--smp` `<integer> (1 - N)` ('default =' `1`)::
878 The number of CPUs. Please use option -sockets instead.
880 `--sockets` `<integer> (1 - N)` ('default =' `1`)::
882 The number of CPU sockets.
884 `--startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
886 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'.
888 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
890 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.
892 `--tablet` `<boolean>` ('default =' `1`)::
894 Enable/disable the USB tablet device.
896 `--tdf` `<boolean>` ('default =' `0`)::
898 Enable/disable time drift fix.
900 `--template` `<boolean>` ('default =' `0`)::
902 Enable/disable Template.
904 `--unused[n]` `<string>` ::
906 Reference to unused volumes. This is used internally, and should not be modified manually.
908 `--usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
910 Configure an USB device (n is 0 to 4).
912 `--vcpus` `<integer> (1 - N)` ('default =' `0`)::
914 Number of hotplugged vcpus.
916 `--vga` `<cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware>` ::
920 `--virtio[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_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_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,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>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
922 Use volume as VIRTIO hard disk (n is 0 to 15).
924 `--vmstatestorage` `<string>` ::
926 Default storage for VM state volumes/files.
928 `--watchdog` `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::
930 Create a virtual hardware watchdog device.
935 *qm showcmd* `<vmid>`
937 Show command line which is used to start the VM (debug info).
939 `<vmid>`: `<integer> (1 - N)` ::
941 The (unique) ID of the VM.
946 *qm shutdown* `<vmid>` `[OPTIONS]`
948 Shutdown virtual machine. This is similar to pressing the power button on a
949 physical machine.This will send an ACPI event for the guest OS, which
950 should then proceed to a clean shutdown.
952 `<vmid>`: `<integer> (1 - N)` ::
954 The (unique) ID of the VM.
956 `--forceStop` `<boolean>` ('default =' `0`)::
958 Make sure the VM stops.
960 `--keepActive` `<boolean>` ('default =' `0`)::
962 Do not deactivate storage volumes.
964 `--skiplock` `<boolean>` ::
966 Ignore locks - only root is allowed to use this option.
968 `--timeout` `<integer> (0 - N)` ::
970 Wait maximal timeout seconds.
974 *qm snapshot* `<vmid> <snapname>` `[OPTIONS]`
978 `<vmid>`: `<integer> (1 - N)` ::
980 The (unique) ID of the VM.
982 `<snapname>`: `<string>` ::
984 The name of the snapshot.
986 `--description` `<string>` ::
988 A textual description or comment.
990 `--vmstate` `<boolean>` ::
996 *qm start* `<vmid>` `[OPTIONS]`
998 Start virtual machine.
1000 `<vmid>`: `<integer> (1 - N)` ::
1002 The (unique) ID of the VM.
1004 `--machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
1006 Specific the Qemu machine type.
1008 `--migratedfrom` `<string>` ::
1010 The cluster node name.
1012 `--migration_network` `<string>` ::
1014 CIDR of the (sub) network that is used for migration.
1016 `--migration_type` `<insecure | secure>` ::
1018 Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.
1020 `--skiplock` `<boolean>` ::
1022 Ignore locks - only root is allowed to use this option.
1024 `--stateuri` `<string>` ::
1026 Some command save/restore state from this location.
1028 `--targetstorage` `<string>` ::
1030 Target storage for the migration. (Can be '1' to use the same storage id as on the source node.)
1035 *qm status* `<vmid>` `[OPTIONS]`
1039 `<vmid>`: `<integer> (1 - N)` ::
1041 The (unique) ID of the VM.
1043 `--verbose` `<boolean>` ::
1045 Verbose output format
1050 *qm stop* `<vmid>` `[OPTIONS]`
1052 Stop virtual machine. The qemu process will exit immediately. Thisis akin
1053 to pulling the power plug of a running computer and may damage the VM data
1055 `<vmid>`: `<integer> (1 - N)` ::
1057 The (unique) ID of the VM.
1059 `--keepActive` `<boolean>` ('default =' `0`)::
1061 Do not deactivate storage volumes.
1063 `--migratedfrom` `<string>` ::
1065 The cluster node name.
1067 `--skiplock` `<boolean>` ::
1069 Ignore locks - only root is allowed to use this option.
1071 `--timeout` `<integer> (0 - N)` ::
1073 Wait maximal timeout seconds.
1077 *qm suspend* `<vmid>` `[OPTIONS]`
1079 Suspend virtual machine.
1081 `<vmid>`: `<integer> (1 - N)` ::
1083 The (unique) ID of the VM.
1085 `--skiplock` `<boolean>` ::
1087 Ignore locks - only root is allowed to use this option.
1091 *qm template* `<vmid>` `[OPTIONS]`
1095 `<vmid>`: `<integer> (1 - N)` ::
1097 The (unique) ID of the VM.
1099 `--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>` ::
1101 If you want to convert only 1 disk to base image.
1106 *qm terminal* `<vmid>` `[OPTIONS]`
1108 Open a terminal using a serial device (The VM need to have a serial device
1109 configured, for example 'serial0: socket')
1111 `<vmid>`: `<integer> (1 - N)` ::
1113 The (unique) ID of the VM.
1115 `--iface` `<serial0 | serial1 | serial2 | serial3>` ::
1117 Select the serial device. By default we simply use the first suitable device.
1122 *qm unlink* `<vmid> --idlist <string>` `[OPTIONS]`
1124 Unlink/delete disk images.
1126 `<vmid>`: `<integer> (1 - N)` ::
1128 The (unique) ID of the VM.
1130 `--force` `<boolean>` ::
1132 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.
1134 `--idlist` `<string>` ::
1136 A list of disk IDs you want to delete.
1141 *qm unlock* `<vmid>`
1145 `<vmid>`: `<integer> (1 - N)` ::
1147 The (unique) ID of the VM.
1151 *qm vncproxy* `<vmid>`
1153 Proxy VM VNC traffic to stdin/stdout
1155 `<vmid>`: `<integer> (1 - N)` ::
1157 The (unique) ID of the VM.
1161 *qm wait* `<vmid>` `[OPTIONS]`
1163 Wait until the VM is stopped.
1165 `<vmid>`: `<integer> (1 - N)` ::
1167 The (unique) ID of the VM.
1169 `--timeout` `<integer> (1 - N)` ::
1171 Timeout in seconds. Default is to wait forever.