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>` ::
15 *qm clone* `<vmid> <newid>` `[OPTIONS]`
17 Create a copy of virtual machine/template.
19 `<vmid>`: `<integer> (1 - N)` ::
21 The (unique) ID of the VM.
23 `<newid>`: `<integer> (1 - N)` ::
27 `--description` `<string>` ::
29 Description for the new VM.
31 `--format` `<qcow2 | raw | vmdk>` ::
33 Target format for file storage.
35 NOTE: Requires option(s): `full`
37 `--full` `<boolean>` ('default =' `0`)::
39 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.
41 `--name` `<string>` ::
43 Set a name for the new VM.
45 `--pool` `<string>` ::
47 Add the new VM to the specified pool.
49 `--snapname` `<string>` ::
51 The name of the snapshot.
53 `--storage` `<string>` ::
55 Target storage for full clone.
57 NOTE: Requires option(s): `full`
59 `--target` `<string>` ::
61 Target node. Only allowed if the original VM is on shared storage.
63 *qm config* `<vmid>` `[OPTIONS]`
65 Get current virtual machine configuration. This does not include pending
66 configuration changes (see 'pending' API).
68 `<vmid>`: `<integer> (1 - N)` ::
70 The (unique) ID of the VM.
72 `--current` `<boolean>` ('default =' `0`)::
74 Get current values (instead of pending values).
76 *qm create* `<vmid>` `[OPTIONS]`
78 Create or restore a virtual machine.
80 `<vmid>`: `<integer> (1 - N)` ::
82 The (unique) ID of the VM.
84 `--acpi` `<boolean>` ('default =' `1`)::
88 `--agent` `<boolean>` ('default =' `0`)::
90 Enable/disable Qemu GuestAgent.
92 `--archive` `<string>` ::
96 `--args` `<string>` ::
98 Arbitrary arguments passed to kvm.
100 `--autostart` `<boolean>` ('default =' `0`)::
102 Automatic restart after crash (currently ignored).
104 `--balloon` `<integer> (0 - N)` ::
106 Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
108 `--bios` `<ovmf | seabios>` ('default =' `seabios`)::
110 Select BIOS implementation.
112 `--boot` `[acdn]{1,4}` ('default =' `cdn`)::
114 Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).
116 `--bootdisk` `(ide|sata|scsi|virtio)\d+` ::
118 Enable booting from specified disk.
120 `--cdrom` `<volume>` ::
122 This is an alias for option -ide2
124 `--cores` `<integer> (1 - N)` ('default =' `1`)::
126 The number of cores per socket.
128 `--cpu` `[cputype=]<enum> [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>]` ::
132 `--cpulimit` `<number> (0 - 128)` ('default =' `0`)::
136 `--cpuunits` `<integer> (2 - 262144)` ('default =' `1024`)::
140 `--description` `<string>` ::
142 Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.
144 `--efidisk0` `[file=]<volume> [,format=<enum>] [,size=<DiskSize>]` ::
146 Configure a Disk for storing EFI vars
148 `--force` `<boolean>` ::
150 Allow to overwrite existing VM.
152 NOTE: Requires option(s): `archive`
154 `--freeze` `<boolean>` ::
156 Freeze CPU at startup (use 'c' monitor command to start execution).
158 `--hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
160 Map host PCI devices into guest.
162 `--hotplug` `<string>` ('default =' `network,disk,usb`)::
164 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'.
166 `--hugepages` `<1024 | 2 | any>` ::
168 Enable/disable hugepages memory.
170 `--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>]` ::
172 Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
174 `--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>` ::
176 Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.It should not be necessary to set it.
178 `--kvm` `<boolean>` ('default =' `1`)::
180 Enable/disable KVM hardware virtualization.
182 `--localtime` `<boolean>` ::
184 Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
186 `--lock` `<backup | migrate | rollback | snapshot>` ::
190 `--machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
192 Specific the Qemu machine type.
194 `--memory` `<integer> (16 - N)` ('default =' `512`)::
196 Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
198 `--migrate_downtime` `<number> (0 - N)` ('default =' `0.1`)::
200 Set maximum tolerated downtime (in seconds) for migrations.
202 `--migrate_speed` `<integer> (0 - N)` ('default =' `0`)::
204 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
206 `--name` `<string>` ::
208 Set a name for the VM. Only used on the configuration web interface.
210 `--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>]` ::
212 Specify network devices.
214 `--numa` `<boolean>` ('default =' `0`)::
218 `--numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
222 `--onboot` `<boolean>` ('default =' `0`)::
224 Specifies whether a VM will be started during system bootup.
226 `--ostype` `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win7 | win8 | wvista | wxp>` ::
228 Specify guest operating system.
230 `--parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` ::
232 Map host parallel devices (n is 0 to 2).
234 `--pool` `<string>` ::
236 Add the VM to the specified pool.
238 `--protection` `<boolean>` ('default =' `0`)::
240 Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
242 `--reboot` `<boolean>` ('default =' `1`)::
244 Allow reboot. If set to '0' the VM exit on reboot.
246 `--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>]` ::
248 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
250 `--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>]` ::
252 Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
254 `--scsihw` `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
256 SCSI controller model
258 `--serial[n]` `(/dev/.+|socket)` ::
260 Create a serial device inside the VM (n is 0 to 3)
262 `--shares` `<integer> (0 - 50000)` ('default =' `1000`)::
264 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
266 `--smbios1` `[family=<string>] [,manufacturer=<string>] [,product=<string>] [,serial=<string>] [,sku=<string>] [,uuid=<UUID>] [,version=<string>]` ::
268 Specify SMBIOS type 1 fields.
270 `--smp` `<integer> (1 - N)` ('default =' `1`)::
272 The number of CPUs. Please use option -sockets instead.
274 `--sockets` `<integer> (1 - N)` ('default =' `1`)::
276 The number of CPU sockets.
278 `--startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
280 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'.
282 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
284 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.
286 `--storage` `<string>` ::
290 `--tablet` `<boolean>` ('default =' `1`)::
292 Enable/disable the USB tablet device.
294 `--tdf` `<boolean>` ('default =' `0`)::
296 Enable/disable time drift fix.
298 `--template` `<boolean>` ('default =' `0`)::
300 Enable/disable Template.
302 `--unique` `<boolean>` ::
304 Assign a unique random ethernet address.
306 NOTE: Requires option(s): `archive`
308 `--unused[n]` `<string>` ::
310 Reference to unused volumes. This is used internally, and should not be modified manually.
312 `--usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
314 Configure an USB device (n is 0 to 4).
316 `--vcpus` `<integer> (1 - N)` ('default =' `0`)::
318 Number of hotplugged vcpus.
320 `--vga` `<cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware>` ::
324 `--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>]` ::
326 Use volume as VIRTIO hard disk (n is 0 to 15).
328 `--vmstatestorage` `<string>` ::
330 Default storage for VM state volumes/files.
332 `--watchdog` `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::
334 Create a virtual hardware watchdog device.
336 *qm delsnapshot* `<vmid> <snapname>` `[OPTIONS]`
338 Delete a VM snapshot.
340 `<vmid>`: `<integer> (1 - N)` ::
342 The (unique) ID of the VM.
344 `<snapname>`: `<string>` ::
346 The name of the snapshot.
348 `--force` `<boolean>` ::
350 For removal from config file, even if removing disk snapshots fails.
352 *qm destroy* `<vmid>` `[OPTIONS]`
354 Destroy the vm (also delete all used/owned volumes).
356 `<vmid>`: `<integer> (1 - N)` ::
358 The (unique) ID of the VM.
360 `--skiplock` `<boolean>` ::
362 Ignore locks - only root is allowed to use this option.
364 *qm help* `[OPTIONS]`
366 Get help about specified command.
368 `--extra-args` `<array>` ::
370 Shows help for a specific command
372 `--verbose` `<boolean>` ::
374 Verbose output format.
376 *qm importdisk* `<vmid> <source> <storage>` `[OPTIONS]`
378 Import an external disk image as an unused disk in a VM. The
379 image format has to be supported by qemu-img(1).
381 `<vmid>`: `<integer> (1 - N)` ::
383 The (unique) ID of the VM.
385 `<source>`: `<string>` ::
387 Path to the disk image to import
389 `<storage>`: `<string>` ::
393 `--format` `<qcow2 | raw | vmdk>` ::
397 *qm importovf* `<vmid> <manifest> <storage>` `[OPTIONS]`
399 Create a new VM using parameters read from an OVF manifest
401 `<vmid>`: `<integer> (1 - N)` ::
403 The (unique) ID of the VM.
405 `<manifest>`: `<string>` ::
409 `<storage>`: `<string>` ::
413 `--dryrun` `<boolean>` ::
415 Print a parsed representation of the extracted OVF parameters, but do not create a VM
417 `--format` `<qcow2 | raw | vmdk>` ::
421 *qm list* `[OPTIONS]`
423 Virtual machine index (per node).
425 `--full` `<boolean>` ::
427 Determine the full status of active VMs.
429 *qm listsnapshot* `<vmid>`
433 `<vmid>`: `<integer> (1 - N)` ::
435 The (unique) ID of the VM.
437 *qm migrate* `<vmid> <target>` `[OPTIONS]`
439 Migrate virtual machine. Creates a new migration task.
441 `<vmid>`: `<integer> (1 - N)` ::
443 The (unique) ID of the VM.
445 `<target>`: `<string>` ::
449 `--force` `<boolean>` ::
451 Allow to migrate VMs which use local devices. Only root may use this option.
453 `--migration_network` `<string>` ::
455 CIDR of the (sub) network that is used for migration.
457 `--migration_type` `<insecure | secure>` ::
459 Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.
461 `--online` `<boolean>` ::
463 Use online/live migration.
465 `--targetstorage` `<string>` ::
467 Default target storage.
469 `--with-local-disks` `<boolean>` ::
471 Enable live storage migration for local disk
473 *qm monitor* `<vmid>`
475 Enter Qemu Monitor interface.
477 `<vmid>`: `<integer> (1 - N)` ::
479 The (unique) ID of the VM.
481 *qm move_disk* `<vmid> <disk> <storage>` `[OPTIONS]`
483 Move volume to different storage.
485 `<vmid>`: `<integer> (1 - N)` ::
487 The (unique) ID of the VM.
489 `<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>` ::
491 The disk you want to move.
493 `<storage>`: `<string>` ::
497 `--delete` `<boolean>` ('default =' `0`)::
499 Delete the original disk after successful copy. By default the original disk is kept as unused disk.
501 `--digest` `<string>` ::
503 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
505 `--format` `<qcow2 | raw | vmdk>` ::
511 Used by qmigrate - do not use manually.
513 *qm nbdstop* `<vmid>`
515 Stop embedded nbd server.
517 `<vmid>`: `<integer> (1 - N)` ::
519 The (unique) ID of the VM.
521 *qm pending* `<vmid>`
523 Get virtual machine configuration, including pending changes.
525 `<vmid>`: `<integer> (1 - N)` ::
527 The (unique) ID of the VM.
529 *qm rescan* `[OPTIONS]`
531 Rescan all storages and update disk sizes and unused disk images.
533 `--vmid` `<integer> (1 - N)` ::
535 The (unique) ID of the VM.
537 *qm reset* `<vmid>` `[OPTIONS]`
539 Reset virtual machine.
541 `<vmid>`: `<integer> (1 - N)` ::
543 The (unique) ID of the VM.
545 `--skiplock` `<boolean>` ::
547 Ignore locks - only root is allowed to use this option.
549 *qm resize* `<vmid> <disk> <size>` `[OPTIONS]`
553 `<vmid>`: `<integer> (1 - N)` ::
555 The (unique) ID of the VM.
557 `<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>` ::
559 The disk you want to resize.
561 `<size>`: `\+?\d+(\.\d+)?[KMGT]?` ::
563 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.
565 `--digest` `<string>` ::
567 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
569 `--skiplock` `<boolean>` ::
571 Ignore locks - only root is allowed to use this option.
573 *qm resume* `<vmid>` `[OPTIONS]`
575 Resume virtual machine.
577 `<vmid>`: `<integer> (1 - N)` ::
579 The (unique) ID of the VM.
581 `--nocheck` `<boolean>` ::
583 no description available
585 `--skiplock` `<boolean>` ::
587 Ignore locks - only root is allowed to use this option.
589 *qm rollback* `<vmid> <snapname>`
591 Rollback VM state to specified snapshot.
593 `<vmid>`: `<integer> (1 - N)` ::
595 The (unique) ID of the VM.
597 `<snapname>`: `<string>` ::
599 The name of the snapshot.
601 *qm sendkey* `<vmid> <key>` `[OPTIONS]`
603 Send key event to virtual machine.
605 `<vmid>`: `<integer> (1 - N)` ::
607 The (unique) ID of the VM.
609 `<key>`: `<string>` ::
611 The key (qemu monitor encoding).
613 `--skiplock` `<boolean>` ::
615 Ignore locks - only root is allowed to use this option.
617 *qm set* `<vmid>` `[OPTIONS]`
619 Set virtual machine options (synchrounous API) - You should consider using
620 the POST method instead for any actions involving hotplug or storage
623 `<vmid>`: `<integer> (1 - N)` ::
625 The (unique) ID of the VM.
627 `--acpi` `<boolean>` ('default =' `1`)::
631 `--agent` `<boolean>` ('default =' `0`)::
633 Enable/disable Qemu GuestAgent.
635 `--args` `<string>` ::
637 Arbitrary arguments passed to kvm.
639 `--autostart` `<boolean>` ('default =' `0`)::
641 Automatic restart after crash (currently ignored).
643 `--balloon` `<integer> (0 - N)` ::
645 Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
647 `--bios` `<ovmf | seabios>` ('default =' `seabios`)::
649 Select BIOS implementation.
651 `--boot` `[acdn]{1,4}` ('default =' `cdn`)::
653 Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).
655 `--bootdisk` `(ide|sata|scsi|virtio)\d+` ::
657 Enable booting from specified disk.
659 `--cdrom` `<volume>` ::
661 This is an alias for option -ide2
663 `--cores` `<integer> (1 - N)` ('default =' `1`)::
665 The number of cores per socket.
667 `--cpu` `[cputype=]<enum> [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>]` ::
671 `--cpulimit` `<number> (0 - 128)` ('default =' `0`)::
675 `--cpuunits` `<integer> (2 - 262144)` ('default =' `1024`)::
679 `--delete` `<string>` ::
681 A list of settings you want to delete.
683 `--description` `<string>` ::
685 Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.
687 `--digest` `<string>` ::
689 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
691 `--efidisk0` `[file=]<volume> [,format=<enum>] [,size=<DiskSize>]` ::
693 Configure a Disk for storing EFI vars
695 `--force` `<boolean>` ::
697 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.
699 NOTE: Requires option(s): `delete`
701 `--freeze` `<boolean>` ::
703 Freeze CPU at startup (use 'c' monitor command to start execution).
705 `--hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
707 Map host PCI devices into guest.
709 `--hotplug` `<string>` ('default =' `network,disk,usb`)::
711 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'.
713 `--hugepages` `<1024 | 2 | any>` ::
715 Enable/disable hugepages memory.
717 `--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>]` ::
719 Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
721 `--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>` ::
723 Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.It should not be necessary to set it.
725 `--kvm` `<boolean>` ('default =' `1`)::
727 Enable/disable KVM hardware virtualization.
729 `--localtime` `<boolean>` ::
731 Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
733 `--lock` `<backup | migrate | rollback | snapshot>` ::
737 `--machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
739 Specific the Qemu machine type.
741 `--memory` `<integer> (16 - N)` ('default =' `512`)::
743 Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
745 `--migrate_downtime` `<number> (0 - N)` ('default =' `0.1`)::
747 Set maximum tolerated downtime (in seconds) for migrations.
749 `--migrate_speed` `<integer> (0 - N)` ('default =' `0`)::
751 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
753 `--name` `<string>` ::
755 Set a name for the VM. Only used on the configuration web interface.
757 `--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>]` ::
759 Specify network devices.
761 `--numa` `<boolean>` ('default =' `0`)::
765 `--numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
769 `--onboot` `<boolean>` ('default =' `0`)::
771 Specifies whether a VM will be started during system bootup.
773 `--ostype` `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win7 | win8 | wvista | wxp>` ::
775 Specify guest operating system.
777 `--parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` ::
779 Map host parallel devices (n is 0 to 2).
781 `--protection` `<boolean>` ('default =' `0`)::
783 Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
785 `--reboot` `<boolean>` ('default =' `1`)::
787 Allow reboot. If set to '0' the VM exit on reboot.
789 `--revert` `<string>` ::
791 Revert a pending change.
793 `--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>]` ::
795 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
797 `--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>]` ::
799 Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
801 `--scsihw` `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
803 SCSI controller model
805 `--serial[n]` `(/dev/.+|socket)` ::
807 Create a serial device inside the VM (n is 0 to 3)
809 `--shares` `<integer> (0 - 50000)` ('default =' `1000`)::
811 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
813 `--skiplock` `<boolean>` ::
815 Ignore locks - only root is allowed to use this option.
817 `--smbios1` `[family=<string>] [,manufacturer=<string>] [,product=<string>] [,serial=<string>] [,sku=<string>] [,uuid=<UUID>] [,version=<string>]` ::
819 Specify SMBIOS type 1 fields.
821 `--smp` `<integer> (1 - N)` ('default =' `1`)::
823 The number of CPUs. Please use option -sockets instead.
825 `--sockets` `<integer> (1 - N)` ('default =' `1`)::
827 The number of CPU sockets.
829 `--startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
831 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'.
833 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
835 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.
837 `--tablet` `<boolean>` ('default =' `1`)::
839 Enable/disable the USB tablet device.
841 `--tdf` `<boolean>` ('default =' `0`)::
843 Enable/disable time drift fix.
845 `--template` `<boolean>` ('default =' `0`)::
847 Enable/disable Template.
849 `--unused[n]` `<string>` ::
851 Reference to unused volumes. This is used internally, and should not be modified manually.
853 `--usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
855 Configure an USB device (n is 0 to 4).
857 `--vcpus` `<integer> (1 - N)` ('default =' `0`)::
859 Number of hotplugged vcpus.
861 `--vga` `<cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware>` ::
865 `--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>]` ::
867 Use volume as VIRTIO hard disk (n is 0 to 15).
869 `--vmstatestorage` `<string>` ::
871 Default storage for VM state volumes/files.
873 `--watchdog` `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::
875 Create a virtual hardware watchdog device.
877 *qm showcmd* `<vmid>` `[OPTIONS]`
879 Show command line which is used to start the VM (debug info).
881 `<vmid>`: `<integer> (1 - N)` ::
883 The (unique) ID of the VM.
885 `--pretty` `<boolean>` ('default =' `0`)::
887 Puts each option on a new line to enhance human readability
889 *qm shutdown* `<vmid>` `[OPTIONS]`
891 Shutdown virtual machine. This is similar to pressing the power button on a
892 physical machine.This will send an ACPI event for the guest OS, which
893 should then proceed to a clean shutdown.
895 `<vmid>`: `<integer> (1 - N)` ::
897 The (unique) ID of the VM.
899 `--forceStop` `<boolean>` ('default =' `0`)::
901 Make sure the VM stops.
903 `--keepActive` `<boolean>` ('default =' `0`)::
905 Do not deactivate storage volumes.
907 `--skiplock` `<boolean>` ::
909 Ignore locks - only root is allowed to use this option.
911 `--timeout` `<integer> (0 - N)` ::
913 Wait maximal timeout seconds.
915 *qm snapshot* `<vmid> <snapname>` `[OPTIONS]`
919 `<vmid>`: `<integer> (1 - N)` ::
921 The (unique) ID of the VM.
923 `<snapname>`: `<string>` ::
925 The name of the snapshot.
927 `--description` `<string>` ::
929 A textual description or comment.
931 `--vmstate` `<boolean>` ::
935 *qm start* `<vmid>` `[OPTIONS]`
937 Start virtual machine.
939 `<vmid>`: `<integer> (1 - N)` ::
941 The (unique) ID of the VM.
943 `--machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
945 Specific the Qemu machine type.
947 `--migratedfrom` `<string>` ::
949 The cluster node name.
951 `--migration_network` `<string>` ::
953 CIDR of the (sub) network that is used for migration.
955 `--migration_type` `<insecure | secure>` ::
957 Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.
959 `--skiplock` `<boolean>` ::
961 Ignore locks - only root is allowed to use this option.
963 `--stateuri` `<string>` ::
965 Some command save/restore state from this location.
967 `--targetstorage` `<string>` ::
969 Target storage for the migration. (Can be '1' to use the same storage id as on the source node.)
971 *qm status* `<vmid>` `[OPTIONS]`
975 `<vmid>`: `<integer> (1 - N)` ::
977 The (unique) ID of the VM.
979 `--verbose` `<boolean>` ::
981 Verbose output format
983 *qm stop* `<vmid>` `[OPTIONS]`
985 Stop virtual machine. The qemu process will exit immediately. Thisis akin
986 to pulling the power plug of a running computer and may damage the VM data
988 `<vmid>`: `<integer> (1 - N)` ::
990 The (unique) ID of the VM.
992 `--keepActive` `<boolean>` ('default =' `0`)::
994 Do not deactivate storage volumes.
996 `--migratedfrom` `<string>` ::
998 The cluster node name.
1000 `--skiplock` `<boolean>` ::
1002 Ignore locks - only root is allowed to use this option.
1004 `--timeout` `<integer> (0 - N)` ::
1006 Wait maximal timeout seconds.
1008 *qm suspend* `<vmid>` `[OPTIONS]`
1010 Suspend virtual machine.
1012 `<vmid>`: `<integer> (1 - N)` ::
1014 The (unique) ID of the VM.
1016 `--skiplock` `<boolean>` ::
1018 Ignore locks - only root is allowed to use this option.
1020 *qm template* `<vmid>` `[OPTIONS]`
1024 `<vmid>`: `<integer> (1 - N)` ::
1026 The (unique) ID of the VM.
1028 `--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>` ::
1030 If you want to convert only 1 disk to base image.
1032 *qm terminal* `<vmid>` `[OPTIONS]`
1034 Open a terminal using a serial device (The VM need to have a serial device
1035 configured, for example 'serial0: socket')
1037 `<vmid>`: `<integer> (1 - N)` ::
1039 The (unique) ID of the VM.
1041 `--escape` `<string>` ('default =' `^O`)::
1045 `--iface` `<serial0 | serial1 | serial2 | serial3>` ::
1047 Select the serial device. By default we simply use the first suitable device.
1049 *qm unlink* `<vmid> --idlist <string>` `[OPTIONS]`
1051 Unlink/delete disk images.
1053 `<vmid>`: `<integer> (1 - N)` ::
1055 The (unique) ID of the VM.
1057 `--force` `<boolean>` ::
1059 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.
1061 `--idlist` `<string>` ::
1063 A list of disk IDs you want to delete.
1065 *qm unlock* `<vmid>`
1069 `<vmid>`: `<integer> (1 - N)` ::
1071 The (unique) ID of the VM.
1073 *qm vncproxy* `<vmid>`
1075 Proxy VM VNC traffic to stdin/stdout
1077 `<vmid>`: `<integer> (1 - N)` ::
1079 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.