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.cfg' 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. Auto-ballooning is done by pvestatd.
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 `--start` `<boolean>` ('default =' `0`)::
315 Start VM after it was created successfully.
317 `--startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
319 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'.
321 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
323 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.
325 `--storage` `<string>` ::
329 `--tablet` `<boolean>` ('default =' `1`)::
331 Enable/disable the USB tablet device.
333 `--tdf` `<boolean>` ('default =' `0`)::
335 Enable/disable time drift fix.
337 `--template` `<boolean>` ('default =' `0`)::
339 Enable/disable Template.
341 `--unique` `<boolean>` ::
343 Assign a unique random ethernet address.
345 NOTE: Requires option(s): `archive`
347 `--unused[n]` `<string>` ::
349 Reference to unused volumes. This is used internally, and should not be modified manually.
351 `--usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
353 Configure an USB device (n is 0 to 4).
355 `--vcpus` `<integer> (1 - N)` ('default =' `0`)::
357 Number of hotplugged vcpus.
359 `--vga` `<cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware>` ::
363 `--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>]` ::
365 Use volume as VIRTIO hard disk (n is 0 to 15).
367 `--vmstatestorage` `<string>` ::
369 Default storage for VM state volumes/files.
371 `--watchdog` `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::
373 Create a virtual hardware watchdog device.
375 *qm delsnapshot* `<vmid> <snapname>` `[OPTIONS]`
377 Delete a VM snapshot.
379 `<vmid>`: `<integer> (1 - N)` ::
381 The (unique) ID of the VM.
383 `<snapname>`: `<string>` ::
385 The name of the snapshot.
387 `--force` `<boolean>` ::
389 For removal from config file, even if removing disk snapshots fails.
391 *qm destroy* `<vmid>` `[OPTIONS]`
393 Destroy the vm (also delete all used/owned volumes).
395 `<vmid>`: `<integer> (1 - N)` ::
397 The (unique) ID of the VM.
399 `--skiplock` `<boolean>` ::
401 Ignore locks - only root is allowed to use this option.
403 *qm help* `[OPTIONS]`
405 Get help about specified command.
407 `--extra-args` `<array>` ::
409 Shows help for a specific command
411 `--verbose` `<boolean>` ::
413 Verbose output format.
415 *qm importdisk* `<vmid> <source> <storage>` `[OPTIONS]`
417 Import an external disk image as an unused disk in a VM. The
418 image format has to be supported by qemu-img(1).
420 `<vmid>`: `<integer> (1 - N)` ::
422 The (unique) ID of the VM.
424 `<source>`: `<string>` ::
426 Path to the disk image to import
428 `<storage>`: `<string>` ::
432 `--format` `<qcow2 | raw | vmdk>` ::
436 *qm importovf* `<vmid> <manifest> <storage>` `[OPTIONS]`
438 Create a new VM using parameters read from an OVF manifest
440 `<vmid>`: `<integer> (1 - N)` ::
442 The (unique) ID of the VM.
444 `<manifest>`: `<string>` ::
448 `<storage>`: `<string>` ::
452 `--dryrun` `<boolean>` ::
454 Print a parsed representation of the extracted OVF parameters, but do not create a VM
456 `--format` `<qcow2 | raw | vmdk>` ::
460 *qm list* `[OPTIONS]`
462 Virtual machine index (per node).
464 `--full` `<boolean>` ::
466 Determine the full status of active VMs.
468 *qm listsnapshot* `<vmid>`
472 `<vmid>`: `<integer> (1 - N)` ::
474 The (unique) ID of the VM.
476 *qm migrate* `<vmid> <target>` `[OPTIONS]`
478 Migrate virtual machine. Creates a new migration task.
480 `<vmid>`: `<integer> (1 - N)` ::
482 The (unique) ID of the VM.
484 `<target>`: `<string>` ::
488 `--force` `<boolean>` ::
490 Allow to migrate VMs which use local devices. Only root may use this option.
492 `--migration_network` `<string>` ::
494 CIDR of the (sub) network that is used for migration.
496 `--migration_type` `<insecure | secure>` ::
498 Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.
500 `--online` `<boolean>` ::
502 Use online/live migration.
504 `--targetstorage` `<string>` ::
506 Default target storage.
508 `--with-local-disks` `<boolean>` ::
510 Enable live storage migration for local disk
512 *qm monitor* `<vmid>`
514 Enter Qemu Monitor interface.
516 `<vmid>`: `<integer> (1 - N)` ::
518 The (unique) ID of the VM.
520 *qm move_disk* `<vmid> <disk> <storage>` `[OPTIONS]`
522 Move volume to different storage.
524 `<vmid>`: `<integer> (1 - N)` ::
526 The (unique) ID of the VM.
528 `<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>` ::
530 The disk you want to move.
532 `<storage>`: `<string>` ::
536 `--delete` `<boolean>` ('default =' `0`)::
538 Delete the original disk after successful copy. By default the original disk is kept as unused disk.
540 `--digest` `<string>` ::
542 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
544 `--format` `<qcow2 | raw | vmdk>` ::
550 Used by qmigrate - do not use manually.
552 *qm nbdstop* `<vmid>`
554 Stop embedded nbd server.
556 `<vmid>`: `<integer> (1 - N)` ::
558 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.
568 *qm rescan* `[OPTIONS]`
570 Rescan all storages and update disk sizes and unused disk images.
572 `--vmid` `<integer> (1 - N)` ::
574 The (unique) ID of the VM.
576 *qm reset* `<vmid>` `[OPTIONS]`
578 Reset virtual machine.
580 `<vmid>`: `<integer> (1 - N)` ::
582 The (unique) ID of the VM.
584 `--skiplock` `<boolean>` ::
586 Ignore locks - only root is allowed to use this option.
588 *qm resize* `<vmid> <disk> <size>` `[OPTIONS]`
592 `<vmid>`: `<integer> (1 - N)` ::
594 The (unique) ID of the VM.
596 `<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>` ::
598 The disk you want to resize.
600 `<size>`: `\+?\d+(\.\d+)?[KMGT]?` ::
602 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.
604 `--digest` `<string>` ::
606 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
608 `--skiplock` `<boolean>` ::
610 Ignore locks - only root is allowed to use this option.
612 *qm resume* `<vmid>` `[OPTIONS]`
614 Resume virtual machine.
616 `<vmid>`: `<integer> (1 - N)` ::
618 The (unique) ID of the VM.
620 `--nocheck` `<boolean>` ::
622 no description available
624 `--skiplock` `<boolean>` ::
626 Ignore locks - only root is allowed to use this option.
628 *qm rollback* `<vmid> <snapname>`
630 Rollback VM state to specified snapshot.
632 `<vmid>`: `<integer> (1 - N)` ::
634 The (unique) ID of the VM.
636 `<snapname>`: `<string>` ::
638 The name of the snapshot.
640 *qm sendkey* `<vmid> <key>` `[OPTIONS]`
642 Send key event to virtual machine.
644 `<vmid>`: `<integer> (1 - N)` ::
646 The (unique) ID of the VM.
648 `<key>`: `<string>` ::
650 The key (qemu monitor encoding).
652 `--skiplock` `<boolean>` ::
654 Ignore locks - only root is allowed to use this option.
656 *qm set* `<vmid>` `[OPTIONS]`
658 Set virtual machine options (synchrounous API) - You should consider using
659 the POST method instead for any actions involving hotplug or storage
662 `<vmid>`: `<integer> (1 - N)` ::
664 The (unique) ID of the VM.
666 `--acpi` `<boolean>` ('default =' `1`)::
670 `--agent` `<boolean>` ('default =' `0`)::
672 Enable/disable Qemu GuestAgent.
674 `--args` `<string>` ::
676 Arbitrary arguments passed to kvm.
678 `--autostart` `<boolean>` ('default =' `0`)::
680 Automatic restart after crash (currently ignored).
682 `--balloon` `<integer> (0 - N)` ::
684 Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
686 `--bios` `<ovmf | seabios>` ('default =' `seabios`)::
688 Select BIOS implementation.
690 `--boot` `[acdn]{1,4}` ('default =' `cdn`)::
692 Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).
694 `--bootdisk` `(ide|sata|scsi|virtio)\d+` ::
696 Enable booting from specified disk.
698 `--cdrom` `<volume>` ::
700 This is an alias for option -ide2
702 `--cipassword` `<password>` ::
704 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.
706 `--citype` `<configdrive2 | nocloud>` ::
708 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.
710 `--ciuser` `<string>` ::
712 cloud-init: User name to change ssh keys and password for instead of the image's configured default user.
714 `--cores` `<integer> (1 - N)` ('default =' `1`)::
716 The number of cores per socket.
718 `--cpu` `[cputype=]<enum> [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>]` ::
722 `--cpulimit` `<number> (0 - 128)` ('default =' `0`)::
726 `--cpuunits` `<integer> (2 - 262144)` ('default =' `1024`)::
730 `--delete` `<string>` ::
732 A list of settings you want to delete.
734 `--description` `<string>` ::
736 Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.
738 `--digest` `<string>` ::
740 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
742 `--efidisk0` `[file=]<volume> [,format=<enum>] [,size=<DiskSize>]` ::
744 Configure a Disk for storing EFI vars
746 `--force` `<boolean>` ::
748 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.
750 NOTE: Requires option(s): `delete`
752 `--freeze` `<boolean>` ::
754 Freeze CPU at startup (use 'c' monitor command to start execution).
756 `--hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
758 Map host PCI devices into guest.
760 `--hotplug` `<string>` ('default =' `network,disk,usb`)::
762 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'.
764 `--hugepages` `<1024 | 2 | any>` ::
766 Enable/disable hugepages memory.
768 `--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>]` ::
770 Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
772 `--ipconfig[n]` `[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]` ::
774 cloud-init: Specify IP addresses and gateways for the corresponding interface.
776 IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.
778 The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided.
779 For IPv6 the special string 'auto' can be used to use stateless autoconfiguration.
781 If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4.
783 `--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>` ::
785 Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg' configuration file.It should not be necessary to set it.
787 `--kvm` `<boolean>` ('default =' `1`)::
789 Enable/disable KVM hardware virtualization.
791 `--localtime` `<boolean>` ::
793 Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
795 `--lock` `<backup | migrate | rollback | snapshot>` ::
799 `--machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
801 Specific the Qemu machine type.
803 `--memory` `<integer> (16 - N)` ('default =' `512`)::
805 Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
807 `--migrate_downtime` `<number> (0 - N)` ('default =' `0.1`)::
809 Set maximum tolerated downtime (in seconds) for migrations.
811 `--migrate_speed` `<integer> (0 - N)` ('default =' `0`)::
813 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
815 `--name` `<string>` ::
817 Set a name for the VM. Only used on the configuration web interface.
819 `--nameserver` `<string>` ::
821 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.
823 `--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>]` ::
825 Specify network devices.
827 `--numa` `<boolean>` ('default =' `0`)::
831 `--numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
835 `--onboot` `<boolean>` ('default =' `0`)::
837 Specifies whether a VM will be started during system bootup.
839 `--ostype` `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win7 | win8 | wvista | wxp>` ::
841 Specify guest operating system.
843 `--parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` ::
845 Map host parallel devices (n is 0 to 2).
847 `--protection` `<boolean>` ('default =' `0`)::
849 Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
851 `--reboot` `<boolean>` ('default =' `1`)::
853 Allow reboot. If set to '0' the VM exit on reboot.
855 `--revert` `<string>` ::
857 Revert a pending change.
859 `--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>]` ::
861 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
863 `--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>]` ::
865 Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
867 `--scsihw` `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
869 SCSI controller model
871 `--searchdomain` `<string>` ::
873 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.
875 `--serial[n]` `(/dev/.+|socket)` ::
877 Create a serial device inside the VM (n is 0 to 3)
879 `--shares` `<integer> (0 - 50000)` ('default =' `1000`)::
881 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. Auto-ballooning is done by pvestatd.
883 `--skiplock` `<boolean>` ::
885 Ignore locks - only root is allowed to use this option.
887 `--smbios1` `[family=<string>] [,manufacturer=<string>] [,product=<string>] [,serial=<string>] [,sku=<string>] [,uuid=<UUID>] [,version=<string>]` ::
889 Specify SMBIOS type 1 fields.
891 `--smp` `<integer> (1 - N)` ('default =' `1`)::
893 The number of CPUs. Please use option -sockets instead.
895 `--sockets` `<integer> (1 - N)` ('default =' `1`)::
897 The number of CPU sockets.
899 `--sshkeys` `<filepath>` ::
901 cloud-init: Setup public SSH keys (one key per line, OpenSSH format).
903 `--startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
905 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'.
907 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
909 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.
911 `--tablet` `<boolean>` ('default =' `1`)::
913 Enable/disable the USB tablet device.
915 `--tdf` `<boolean>` ('default =' `0`)::
917 Enable/disable time drift fix.
919 `--template` `<boolean>` ('default =' `0`)::
921 Enable/disable Template.
923 `--unused[n]` `<string>` ::
925 Reference to unused volumes. This is used internally, and should not be modified manually.
927 `--usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
929 Configure an USB device (n is 0 to 4).
931 `--vcpus` `<integer> (1 - N)` ('default =' `0`)::
933 Number of hotplugged vcpus.
935 `--vga` `<cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware>` ::
939 `--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>]` ::
941 Use volume as VIRTIO hard disk (n is 0 to 15).
943 `--vmstatestorage` `<string>` ::
945 Default storage for VM state volumes/files.
947 `--watchdog` `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::
949 Create a virtual hardware watchdog device.
951 *qm showcmd* `<vmid>` `[OPTIONS]`
953 Show command line which is used to start the VM (debug info).
955 `<vmid>`: `<integer> (1 - N)` ::
957 The (unique) ID of the VM.
959 `--pretty` `<boolean>` ('default =' `0`)::
961 Puts each option on a new line to enhance human readability
963 *qm shutdown* `<vmid>` `[OPTIONS]`
965 Shutdown virtual machine. This is similar to pressing the power button on a
966 physical machine.This will send an ACPI event for the guest OS, which
967 should then proceed to a clean shutdown.
969 `<vmid>`: `<integer> (1 - N)` ::
971 The (unique) ID of the VM.
973 `--forceStop` `<boolean>` ('default =' `0`)::
975 Make sure the VM stops.
977 `--keepActive` `<boolean>` ('default =' `0`)::
979 Do not deactivate storage volumes.
981 `--skiplock` `<boolean>` ::
983 Ignore locks - only root is allowed to use this option.
985 `--timeout` `<integer> (0 - N)` ::
987 Wait maximal timeout seconds.
989 *qm snapshot* `<vmid> <snapname>` `[OPTIONS]`
993 `<vmid>`: `<integer> (1 - N)` ::
995 The (unique) ID of the VM.
997 `<snapname>`: `<string>` ::
999 The name of the snapshot.
1001 `--description` `<string>` ::
1003 A textual description or comment.
1005 `--vmstate` `<boolean>` ::
1009 *qm start* `<vmid>` `[OPTIONS]`
1011 Start virtual machine.
1013 `<vmid>`: `<integer> (1 - N)` ::
1015 The (unique) ID of the VM.
1017 `--machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
1019 Specific the Qemu machine type.
1021 `--migratedfrom` `<string>` ::
1023 The cluster node name.
1025 `--migration_network` `<string>` ::
1027 CIDR of the (sub) network that is used for migration.
1029 `--migration_type` `<insecure | secure>` ::
1031 Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.
1033 `--skiplock` `<boolean>` ::
1035 Ignore locks - only root is allowed to use this option.
1037 `--stateuri` `<string>` ::
1039 Some command save/restore state from this location.
1041 `--targetstorage` `<string>` ::
1043 Target storage for the migration. (Can be '1' to use the same storage id as on the source node.)
1045 *qm status* `<vmid>` `[OPTIONS]`
1049 `<vmid>`: `<integer> (1 - N)` ::
1051 The (unique) ID of the VM.
1053 `--verbose` `<boolean>` ::
1055 Verbose output format
1057 *qm stop* `<vmid>` `[OPTIONS]`
1059 Stop virtual machine. The qemu process will exit immediately. Thisis akin
1060 to pulling the power plug of a running computer and may damage the VM data
1062 `<vmid>`: `<integer> (1 - N)` ::
1064 The (unique) ID of the VM.
1066 `--keepActive` `<boolean>` ('default =' `0`)::
1068 Do not deactivate storage volumes.
1070 `--migratedfrom` `<string>` ::
1072 The cluster node name.
1074 `--skiplock` `<boolean>` ::
1076 Ignore locks - only root is allowed to use this option.
1078 `--timeout` `<integer> (0 - N)` ::
1080 Wait maximal timeout seconds.
1082 *qm suspend* `<vmid>` `[OPTIONS]`
1084 Suspend virtual machine.
1086 `<vmid>`: `<integer> (1 - N)` ::
1088 The (unique) ID of the VM.
1090 `--skiplock` `<boolean>` ::
1092 Ignore locks - only root is allowed to use this option.
1094 *qm template* `<vmid>` `[OPTIONS]`
1098 `<vmid>`: `<integer> (1 - N)` ::
1100 The (unique) ID of the VM.
1102 `--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>` ::
1104 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 `--escape` `<string>` ('default =' `^O`)::
1119 `--iface` `<serial0 | serial1 | serial2 | serial3>` ::
1121 Select the serial device. By default we simply use the first suitable device.
1123 *qm unlink* `<vmid> --idlist <string>` `[OPTIONS]`
1125 Unlink/delete disk images.
1127 `<vmid>`: `<integer> (1 - N)` ::
1129 The (unique) ID of the VM.
1131 `--force` `<boolean>` ::
1133 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.
1135 `--idlist` `<string>` ::
1137 A list of disk IDs you want to delete.
1139 *qm unlock* `<vmid>`
1143 `<vmid>`: `<integer> (1 - N)` ::
1145 The (unique) ID of the VM.
1147 *qm vncproxy* `<vmid>`
1149 Proxy VM VNC traffic to stdin/stdout
1151 `<vmid>`: `<integer> (1 - N)` ::
1153 The (unique) ID of the VM.
1155 *qm wait* `<vmid>` `[OPTIONS]`
1157 Wait until the VM is stopped.
1159 `<vmid>`: `<integer> (1 - N)` ::
1161 The (unique) ID of the VM.
1163 `--timeout` `<integer> (1 - N)` ::
1165 Timeout in seconds. Default is to wait forever.