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-host-name | get-memory-block-info | get-memory-blocks | get-osinfo | get-time | get-timezone | get-users | 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. Only valid for full clone.
35 `--full` `<boolean>` ::
37 Create a full copy of all disks. This is always done when you clone a normal VM. For VM templates, we try to create a linked clone by default.
39 `--name` `<string>` ::
41 Set a name for the new VM.
43 `--pool` `<string>` ::
45 Add the new VM to the specified pool.
47 `--snapname` `<string>` ::
49 The name of the snapshot.
51 `--storage` `<string>` ::
53 Target storage for full clone.
55 `--target` `<string>` ::
57 Target node. Only allowed if the original VM is on shared storage.
59 *qm config* `<vmid>` `[OPTIONS]`
61 Get current virtual machine configuration. This does not include pending
62 configuration changes (see 'pending' API).
64 `<vmid>`: `<integer> (1 - N)` ::
66 The (unique) ID of the VM.
68 `--current` `<boolean>` ('default =' `0`)::
70 Get current values (instead of pending values).
72 *qm create* `<vmid>` `[OPTIONS]`
74 Create or restore a virtual machine.
76 `<vmid>`: `<integer> (1 - N)` ::
78 The (unique) ID of the VM.
80 `--acpi` `<boolean>` ('default =' `1`)::
84 `--agent` `<boolean>` ('default =' `0`)::
86 Enable/disable Qemu GuestAgent.
88 `--archive` `<string>` ::
92 `--args` `<string>` ::
94 Arbitrary arguments passed to kvm.
96 `--autostart` `<boolean>` ('default =' `0`)::
98 Automatic restart after crash (currently ignored).
100 `--balloon` `<integer> (0 - N)` ::
102 Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
104 `--bios` `<ovmf | seabios>` ('default =' `seabios`)::
106 Select BIOS implementation.
108 `--boot` `[acdn]{1,4}` ('default =' `cdn`)::
110 Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).
112 `--bootdisk` `(ide|sata|scsi|virtio)\d+` ::
114 Enable booting from specified disk.
116 `--bwlimit` `<integer> (0 - N)` ::
118 Override i/o bandwidth limit (in KiB/s).
120 `--cdrom` `<volume>` ::
122 This is an alias for option -ide2
124 `--cipassword` `<password>` ::
126 cloud-init: Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords.
128 `--citype` `<configdrive2 | nocloud>` ::
130 Specifies the cloud-init configuration format. The default depends on the configured operating system type (`ostype`. We use the `nocloud` format for Linux, and `configdrive2` for windows.
132 `--ciuser` `<string>` ::
134 cloud-init: User name to change ssh keys and password for instead of the image's configured default user.
136 `--cores` `<integer> (1 - N)` ('default =' `1`)::
138 The number of cores per socket.
140 `--cpu` `[cputype=]<enum> [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>]` ::
144 `--cpulimit` `<number> (0 - 128)` ('default =' `0`)::
148 `--cpuunits` `<integer> (2 - 262144)` ('default =' `1024`)::
152 `--description` `<string>` ::
154 Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.
156 `--efidisk0` `[file=]<volume> [,format=<enum>] [,size=<DiskSize>]` ::
158 Configure a Disk for storing EFI vars
160 `--force` `<boolean>` ::
162 Allow to overwrite existing VM.
164 NOTE: Requires option(s): `archive`
166 `--freeze` `<boolean>` ::
168 Freeze CPU at startup (use 'c' monitor command to start execution).
170 `--hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
172 Map host PCI devices into guest.
174 `--hotplug` `<string>` ('default =' `network,disk,usb`)::
176 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'.
178 `--hugepages` `<1024 | 2 | any>` ::
180 Enable/disable hugepages memory.
182 `--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>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
184 Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
186 `--ipconfig[n]` `[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]` ::
188 cloud-init: Specify IP addresses and gateways for the corresponding interface.
190 IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.
192 The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided.
193 For IPv6 the special string 'auto' can be used to use stateless autoconfiguration.
195 If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4.
197 `--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>` ::
199 Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.It should not be necessary to set it.
201 `--kvm` `<boolean>` ('default =' `1`)::
203 Enable/disable KVM hardware virtualization.
205 `--localtime` `<boolean>` ::
207 Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
209 `--lock` `<backup | migrate | rollback | snapshot>` ::
213 `--machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
215 Specific the Qemu machine type.
217 `--memory` `<integer> (16 - N)` ('default =' `512`)::
219 Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
221 `--migrate_downtime` `<number> (0 - N)` ('default =' `0.1`)::
223 Set maximum tolerated downtime (in seconds) for migrations.
225 `--migrate_speed` `<integer> (0 - N)` ('default =' `0`)::
227 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
229 `--name` `<string>` ::
231 Set a name for the VM. Only used on the configuration web interface.
233 `--nameserver` `<string>` ::
235 cloud-init: Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.
237 `--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>]` ::
239 Specify network devices.
241 `--numa` `<boolean>` ('default =' `0`)::
245 `--numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
249 `--onboot` `<boolean>` ('default =' `0`)::
251 Specifies whether a VM will be started during system bootup.
253 `--ostype` `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win7 | win8 | wvista | wxp>` ::
255 Specify guest operating system.
257 `--parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` ::
259 Map host parallel devices (n is 0 to 2).
261 `--pool` `<string>` ::
263 Add the VM to the specified pool.
265 `--protection` `<boolean>` ('default =' `0`)::
267 Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
269 `--reboot` `<boolean>` ('default =' `1`)::
271 Allow reboot. If set to '0' the VM exit on reboot.
273 `--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>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
275 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
277 `--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>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
279 Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
281 `--scsihw` `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
283 SCSI controller model
285 `--searchdomain` `<string>` ::
287 cloud-init: Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.
289 `--serial[n]` `(/dev/.+|socket)` ::
291 Create a serial device inside the VM (n is 0 to 3)
293 `--shares` `<integer> (0 - 50000)` ('default =' `1000`)::
295 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
297 `--smbios1` `[family=<string>] [,manufacturer=<string>] [,product=<string>] [,serial=<string>] [,sku=<string>] [,uuid=<UUID>] [,version=<string>]` ::
299 Specify SMBIOS type 1 fields.
301 `--smp` `<integer> (1 - N)` ('default =' `1`)::
303 The number of CPUs. Please use option -sockets instead.
305 `--sockets` `<integer> (1 - N)` ('default =' `1`)::
307 The number of CPU sockets.
309 `--sshkeys` `<filepath>` ::
311 cloud-init: Setup public SSH keys (one key per line, OpenSSH format).
313 `--startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
315 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'.
317 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
319 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.
321 `--storage` `<string>` ::
325 `--tablet` `<boolean>` ('default =' `1`)::
327 Enable/disable the USB tablet device.
329 `--tdf` `<boolean>` ('default =' `0`)::
331 Enable/disable time drift fix.
333 `--template` `<boolean>` ('default =' `0`)::
335 Enable/disable Template.
337 `--unique` `<boolean>` ::
339 Assign a unique random ethernet address.
341 NOTE: Requires option(s): `archive`
343 `--unused[n]` `<string>` ::
345 Reference to unused volumes. This is used internally, and should not be modified manually.
347 `--usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
349 Configure an USB device (n is 0 to 4).
351 `--vcpus` `<integer> (1 - N)` ('default =' `0`)::
353 Number of hotplugged vcpus.
355 `--vga` `<cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware>` ::
359 `--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>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
361 Use volume as VIRTIO hard disk (n is 0 to 15).
363 `--vmstatestorage` `<string>` ::
365 Default storage for VM state volumes/files.
367 `--watchdog` `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::
369 Create a virtual hardware watchdog device.
371 *qm delsnapshot* `<vmid> <snapname>` `[OPTIONS]`
373 Delete a VM snapshot.
375 `<vmid>`: `<integer> (1 - N)` ::
377 The (unique) ID of the VM.
379 `<snapname>`: `<string>` ::
381 The name of the snapshot.
383 `--force` `<boolean>` ::
385 For removal from config file, even if removing disk snapshots fails.
387 *qm destroy* `<vmid>` `[OPTIONS]`
389 Destroy the vm (also delete all used/owned volumes).
391 `<vmid>`: `<integer> (1 - N)` ::
393 The (unique) ID of the VM.
395 `--skiplock` `<boolean>` ::
397 Ignore locks - only root is allowed to use this option.
399 *qm help* `[OPTIONS]`
401 Get help about specified command.
403 `--extra-args` `<array>` ::
405 Shows help for a specific command
407 `--verbose` `<boolean>` ::
409 Verbose output format.
411 *qm importdisk* `<vmid> <source> <storage>` `[OPTIONS]`
413 Import an external disk image as an unused disk in a VM. The
414 image format has to be supported by qemu-img(1).
416 `<vmid>`: `<integer> (1 - N)` ::
418 The (unique) ID of the VM.
420 `<source>`: `<string>` ::
422 Path to the disk image to import
424 `<storage>`: `<string>` ::
428 `--format` `<qcow2 | raw | vmdk>` ::
432 *qm importovf* `<vmid> <manifest> <storage>` `[OPTIONS]`
434 Create a new VM using parameters read from an OVF manifest
436 `<vmid>`: `<integer> (1 - N)` ::
438 The (unique) ID of the VM.
440 `<manifest>`: `<string>` ::
444 `<storage>`: `<string>` ::
448 `--dryrun` `<boolean>` ::
450 Print a parsed representation of the extracted OVF parameters, but do not create a VM
452 `--format` `<qcow2 | raw | vmdk>` ::
456 *qm list* `[OPTIONS]`
458 Virtual machine index (per node).
460 `--full` `<boolean>` ::
462 Determine the full status of active VMs.
464 *qm listsnapshot* `<vmid>`
468 `<vmid>`: `<integer> (1 - N)` ::
470 The (unique) ID of the VM.
472 *qm migrate* `<vmid> <target>` `[OPTIONS]`
474 Migrate virtual machine. Creates a new migration task.
476 `<vmid>`: `<integer> (1 - N)` ::
478 The (unique) ID of the VM.
480 `<target>`: `<string>` ::
484 `--force` `<boolean>` ::
486 Allow to migrate VMs which use local devices. Only root may use this option.
488 `--migration_network` `<string>` ::
490 CIDR of the (sub) network that is used for migration.
492 `--migration_type` `<insecure | secure>` ::
494 Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.
496 `--online` `<boolean>` ::
498 Use online/live migration.
500 `--targetstorage` `<string>` ::
502 Default target storage.
504 `--with-local-disks` `<boolean>` ::
506 Enable live storage migration for local disk
508 *qm monitor* `<vmid>`
510 Enter Qemu Monitor interface.
512 `<vmid>`: `<integer> (1 - N)` ::
514 The (unique) ID of the VM.
516 *qm move_disk* `<vmid> <disk> <storage>` `[OPTIONS]`
518 Move volume to different storage.
520 `<vmid>`: `<integer> (1 - N)` ::
522 The (unique) ID of the VM.
524 `<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>` ::
526 The disk you want to move.
528 `<storage>`: `<string>` ::
532 `--delete` `<boolean>` ('default =' `0`)::
534 Delete the original disk after successful copy. By default the original disk is kept as unused disk.
536 `--digest` `<string>` ::
538 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
540 `--format` `<qcow2 | raw | vmdk>` ::
546 Used by qmigrate - do not use manually.
548 *qm nbdstop* `<vmid>`
550 Stop embedded nbd server.
552 `<vmid>`: `<integer> (1 - N)` ::
554 The (unique) ID of the VM.
556 *qm pending* `<vmid>`
558 Get virtual machine configuration, including pending changes.
560 `<vmid>`: `<integer> (1 - N)` ::
562 The (unique) ID of the VM.
564 *qm rescan* `[OPTIONS]`
566 Rescan all storages and update disk sizes and unused disk images.
568 `--vmid` `<integer> (1 - N)` ::
570 The (unique) ID of the VM.
572 *qm reset* `<vmid>` `[OPTIONS]`
574 Reset virtual machine.
576 `<vmid>`: `<integer> (1 - N)` ::
578 The (unique) ID of the VM.
580 `--skiplock` `<boolean>` ::
582 Ignore locks - only root is allowed to use this option.
584 *qm resize* `<vmid> <disk> <size>` `[OPTIONS]`
588 `<vmid>`: `<integer> (1 - N)` ::
590 The (unique) ID of the VM.
592 `<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>` ::
594 The disk you want to resize.
596 `<size>`: `\+?\d+(\.\d+)?[KMGT]?` ::
598 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.
600 `--digest` `<string>` ::
602 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
604 `--skiplock` `<boolean>` ::
606 Ignore locks - only root is allowed to use this option.
608 *qm resume* `<vmid>` `[OPTIONS]`
610 Resume virtual machine.
612 `<vmid>`: `<integer> (1 - N)` ::
614 The (unique) ID of the VM.
616 `--nocheck` `<boolean>` ::
618 no description available
620 `--skiplock` `<boolean>` ::
622 Ignore locks - only root is allowed to use this option.
624 *qm rollback* `<vmid> <snapname>`
626 Rollback VM state to specified snapshot.
628 `<vmid>`: `<integer> (1 - N)` ::
630 The (unique) ID of the VM.
632 `<snapname>`: `<string>` ::
634 The name of the snapshot.
636 *qm sendkey* `<vmid> <key>` `[OPTIONS]`
638 Send key event to virtual machine.
640 `<vmid>`: `<integer> (1 - N)` ::
642 The (unique) ID of the VM.
644 `<key>`: `<string>` ::
646 The key (qemu monitor encoding).
648 `--skiplock` `<boolean>` ::
650 Ignore locks - only root is allowed to use this option.
652 *qm set* `<vmid>` `[OPTIONS]`
654 Set virtual machine options (synchrounous API) - You should consider using
655 the POST method instead for any actions involving hotplug or storage
658 `<vmid>`: `<integer> (1 - N)` ::
660 The (unique) ID of the VM.
662 `--acpi` `<boolean>` ('default =' `1`)::
666 `--agent` `<boolean>` ('default =' `0`)::
668 Enable/disable Qemu GuestAgent.
670 `--args` `<string>` ::
672 Arbitrary arguments passed to kvm.
674 `--autostart` `<boolean>` ('default =' `0`)::
676 Automatic restart after crash (currently ignored).
678 `--balloon` `<integer> (0 - N)` ::
680 Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
682 `--bios` `<ovmf | seabios>` ('default =' `seabios`)::
684 Select BIOS implementation.
686 `--boot` `[acdn]{1,4}` ('default =' `cdn`)::
688 Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).
690 `--bootdisk` `(ide|sata|scsi|virtio)\d+` ::
692 Enable booting from specified disk.
694 `--cdrom` `<volume>` ::
696 This is an alias for option -ide2
698 `--cipassword` `<password>` ::
700 cloud-init: Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords.
702 `--citype` `<configdrive2 | nocloud>` ::
704 Specifies the cloud-init configuration format. The default depends on the configured operating system type (`ostype`. We use the `nocloud` format for Linux, and `configdrive2` for windows.
706 `--ciuser` `<string>` ::
708 cloud-init: User name to change ssh keys and password for instead of the image's configured default user.
710 `--cores` `<integer> (1 - N)` ('default =' `1`)::
712 The number of cores per socket.
714 `--cpu` `[cputype=]<enum> [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>]` ::
718 `--cpulimit` `<number> (0 - 128)` ('default =' `0`)::
722 `--cpuunits` `<integer> (2 - 262144)` ('default =' `1024`)::
726 `--delete` `<string>` ::
728 A list of settings you want to delete.
730 `--description` `<string>` ::
732 Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.
734 `--digest` `<string>` ::
736 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
738 `--efidisk0` `[file=]<volume> [,format=<enum>] [,size=<DiskSize>]` ::
740 Configure a Disk for storing EFI vars
742 `--force` `<boolean>` ::
744 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.
746 NOTE: Requires option(s): `delete`
748 `--freeze` `<boolean>` ::
750 Freeze CPU at startup (use 'c' monitor command to start execution).
752 `--hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
754 Map host PCI devices into guest.
756 `--hotplug` `<string>` ('default =' `network,disk,usb`)::
758 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'.
760 `--hugepages` `<1024 | 2 | any>` ::
762 Enable/disable hugepages memory.
764 `--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>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
766 Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
768 `--ipconfig[n]` `[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]` ::
770 cloud-init: Specify IP addresses and gateways for the corresponding interface.
772 IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.
774 The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided.
775 For IPv6 the special string 'auto' can be used to use stateless autoconfiguration.
777 If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4.
779 `--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>` ::
781 Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.It should not be necessary to set it.
783 `--kvm` `<boolean>` ('default =' `1`)::
785 Enable/disable KVM hardware virtualization.
787 `--localtime` `<boolean>` ::
789 Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
791 `--lock` `<backup | migrate | rollback | snapshot>` ::
795 `--machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
797 Specific the Qemu machine type.
799 `--memory` `<integer> (16 - N)` ('default =' `512`)::
801 Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
803 `--migrate_downtime` `<number> (0 - N)` ('default =' `0.1`)::
805 Set maximum tolerated downtime (in seconds) for migrations.
807 `--migrate_speed` `<integer> (0 - N)` ('default =' `0`)::
809 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
811 `--name` `<string>` ::
813 Set a name for the VM. Only used on the configuration web interface.
815 `--nameserver` `<string>` ::
817 cloud-init: Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.
819 `--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>]` ::
821 Specify network devices.
823 `--numa` `<boolean>` ('default =' `0`)::
827 `--numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
831 `--onboot` `<boolean>` ('default =' `0`)::
833 Specifies whether a VM will be started during system bootup.
835 `--ostype` `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win7 | win8 | wvista | wxp>` ::
837 Specify guest operating system.
839 `--parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` ::
841 Map host parallel devices (n is 0 to 2).
843 `--protection` `<boolean>` ('default =' `0`)::
845 Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
847 `--reboot` `<boolean>` ('default =' `1`)::
849 Allow reboot. If set to '0' the VM exit on reboot.
851 `--revert` `<string>` ::
853 Revert a pending change.
855 `--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>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
857 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
859 `--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>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
861 Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
863 `--scsihw` `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
865 SCSI controller model
867 `--searchdomain` `<string>` ::
869 cloud-init: Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.
871 `--serial[n]` `(/dev/.+|socket)` ::
873 Create a serial device inside the VM (n is 0 to 3)
875 `--shares` `<integer> (0 - 50000)` ('default =' `1000`)::
877 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
879 `--skiplock` `<boolean>` ::
881 Ignore locks - only root is allowed to use this option.
883 `--smbios1` `[family=<string>] [,manufacturer=<string>] [,product=<string>] [,serial=<string>] [,sku=<string>] [,uuid=<UUID>] [,version=<string>]` ::
885 Specify SMBIOS type 1 fields.
887 `--smp` `<integer> (1 - N)` ('default =' `1`)::
889 The number of CPUs. Please use option -sockets instead.
891 `--sockets` `<integer> (1 - N)` ('default =' `1`)::
893 The number of CPU sockets.
895 `--sshkeys` `<filepath>` ::
897 cloud-init: Setup public SSH keys (one key per line, OpenSSH format).
899 `--startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
901 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'.
903 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
905 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.
907 `--tablet` `<boolean>` ('default =' `1`)::
909 Enable/disable the USB tablet device.
911 `--tdf` `<boolean>` ('default =' `0`)::
913 Enable/disable time drift fix.
915 `--template` `<boolean>` ('default =' `0`)::
917 Enable/disable Template.
919 `--unused[n]` `<string>` ::
921 Reference to unused volumes. This is used internally, and should not be modified manually.
923 `--usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
925 Configure an USB device (n is 0 to 4).
927 `--vcpus` `<integer> (1 - N)` ('default =' `0`)::
929 Number of hotplugged vcpus.
931 `--vga` `<cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware>` ::
935 `--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>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
937 Use volume as VIRTIO hard disk (n is 0 to 15).
939 `--vmstatestorage` `<string>` ::
941 Default storage for VM state volumes/files.
943 `--watchdog` `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::
945 Create a virtual hardware watchdog device.
947 *qm showcmd* `<vmid>` `[OPTIONS]`
949 Show command line which is used to start the VM (debug info).
951 `<vmid>`: `<integer> (1 - N)` ::
953 The (unique) ID of the VM.
955 `--pretty` `<boolean>` ('default =' `0`)::
957 Puts each option on a new line to enhance human readability
959 *qm shutdown* `<vmid>` `[OPTIONS]`
961 Shutdown virtual machine. This is similar to pressing the power button on a
962 physical machine.This will send an ACPI event for the guest OS, which
963 should then proceed to a clean shutdown.
965 `<vmid>`: `<integer> (1 - N)` ::
967 The (unique) ID of the VM.
969 `--forceStop` `<boolean>` ('default =' `0`)::
971 Make sure the VM stops.
973 `--keepActive` `<boolean>` ('default =' `0`)::
975 Do not deactivate storage volumes.
977 `--skiplock` `<boolean>` ::
979 Ignore locks - only root is allowed to use this option.
981 `--timeout` `<integer> (0 - N)` ::
983 Wait maximal timeout seconds.
985 *qm snapshot* `<vmid> <snapname>` `[OPTIONS]`
989 `<vmid>`: `<integer> (1 - N)` ::
991 The (unique) ID of the VM.
993 `<snapname>`: `<string>` ::
995 The name of the snapshot.
997 `--description` `<string>` ::
999 A textual description or comment.
1001 `--vmstate` `<boolean>` ::
1005 *qm start* `<vmid>` `[OPTIONS]`
1007 Start virtual machine.
1009 `<vmid>`: `<integer> (1 - N)` ::
1011 The (unique) ID of the VM.
1013 `--machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
1015 Specific the Qemu machine type.
1017 `--migratedfrom` `<string>` ::
1019 The cluster node name.
1021 `--migration_network` `<string>` ::
1023 CIDR of the (sub) network that is used for migration.
1025 `--migration_type` `<insecure | secure>` ::
1027 Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.
1029 `--skiplock` `<boolean>` ::
1031 Ignore locks - only root is allowed to use this option.
1033 `--stateuri` `<string>` ::
1035 Some command save/restore state from this location.
1037 `--targetstorage` `<string>` ::
1039 Target storage for the migration. (Can be '1' to use the same storage id as on the source node.)
1041 *qm status* `<vmid>` `[OPTIONS]`
1045 `<vmid>`: `<integer> (1 - N)` ::
1047 The (unique) ID of the VM.
1049 `--verbose` `<boolean>` ::
1051 Verbose output format
1053 *qm stop* `<vmid>` `[OPTIONS]`
1055 Stop virtual machine. The qemu process will exit immediately. Thisis akin
1056 to pulling the power plug of a running computer and may damage the VM data
1058 `<vmid>`: `<integer> (1 - N)` ::
1060 The (unique) ID of the VM.
1062 `--keepActive` `<boolean>` ('default =' `0`)::
1064 Do not deactivate storage volumes.
1066 `--migratedfrom` `<string>` ::
1068 The cluster node name.
1070 `--skiplock` `<boolean>` ::
1072 Ignore locks - only root is allowed to use this option.
1074 `--timeout` `<integer> (0 - N)` ::
1076 Wait maximal timeout seconds.
1078 *qm suspend* `<vmid>` `[OPTIONS]`
1080 Suspend virtual machine.
1082 `<vmid>`: `<integer> (1 - N)` ::
1084 The (unique) ID of the VM.
1086 `--skiplock` `<boolean>` ::
1088 Ignore locks - only root is allowed to use this option.
1090 *qm template* `<vmid>` `[OPTIONS]`
1094 `<vmid>`: `<integer> (1 - N)` ::
1096 The (unique) ID of the VM.
1098 `--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>` ::
1100 If you want to convert only 1 disk to base image.
1102 *qm terminal* `<vmid>` `[OPTIONS]`
1104 Open a terminal using a serial device (The VM need to have a serial device
1105 configured, for example 'serial0: socket')
1107 `<vmid>`: `<integer> (1 - N)` ::
1109 The (unique) ID of the VM.
1111 `--escape` `<string>` ('default =' `^O`)::
1115 `--iface` `<serial0 | serial1 | serial2 | serial3>` ::
1117 Select the serial device. By default we simply use the first suitable device.
1119 *qm unlink* `<vmid> --idlist <string>` `[OPTIONS]`
1121 Unlink/delete disk images.
1123 `<vmid>`: `<integer> (1 - N)` ::
1125 The (unique) ID of the VM.
1127 `--force` `<boolean>` ::
1129 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.
1131 `--idlist` `<string>` ::
1133 A list of disk IDs you want to delete.
1135 *qm unlock* `<vmid>`
1139 `<vmid>`: `<integer> (1 - N)` ::
1141 The (unique) ID of the VM.
1143 *qm vncproxy* `<vmid>`
1145 Proxy VM VNC traffic to stdin/stdout
1147 `<vmid>`: `<integer> (1 - N)` ::
1149 The (unique) ID of the VM.
1151 *qm wait* `<vmid>` `[OPTIONS]`
1153 Wait until the VM is stopped.
1155 `<vmid>`: `<integer> (1 - N)` ::
1157 The (unique) ID of the VM.
1159 `--timeout` `<integer> (1 - N)` ::
1161 Timeout in seconds. Default is to wait forever.