1 *qm* `<COMMAND> [ARGS] [OPTIONS]`
5 An alias for 'qm guest cmd'.
7 *qm cleanup* `<vmid> <clean-shutdown> <guest-requested>`
9 Cleans up resources like tap devices, vgpus, etc. Called after a vm shuts
12 `<vmid>`: `<integer> (1 - N)` ::
14 The (unique) ID of the VM.
16 `<clean-shutdown>`: `<boolean>` ::
18 Indicates if qemu shutdown cleanly.
20 `<guest-requested>`: `<boolean>` ::
22 Indicates if the shutdown was requested by the guest or via qmp.
24 *qm clone* `<vmid> <newid>` `[OPTIONS]`
26 Create a copy of virtual machine/template.
28 `<vmid>`: `<integer> (1 - N)` ::
30 The (unique) ID of the VM.
32 `<newid>`: `<integer> (1 - N)` ::
36 `--description` `<string>` ::
38 Description for the new VM.
40 `--format` `<qcow2 | raw | vmdk>` ::
42 Target format for file storage. Only valid for full clone.
44 `--full` `<boolean>` ::
46 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.
48 `--name` `<string>` ::
50 Set a name for the new VM.
52 `--pool` `<string>` ::
54 Add the new VM to the specified pool.
56 `--snapname` `<string>` ::
58 The name of the snapshot.
60 `--storage` `<string>` ::
62 Target storage for full clone.
64 `--target` `<string>` ::
66 Target node. Only allowed if the original VM is on shared storage.
68 *qm config* `<vmid>` `[OPTIONS]`
70 Get current virtual machine configuration. This does not include pending
71 configuration changes (see 'pending' API).
73 `<vmid>`: `<integer> (1 - N)` ::
75 The (unique) ID of the VM.
77 `--current` `<boolean>` ('default =' `0`)::
79 Get current values (instead of pending values).
81 *qm create* `<vmid>` `[OPTIONS]`
83 Create or restore a virtual machine.
85 `<vmid>`: `<integer> (1 - N)` ::
87 The (unique) ID of the VM.
89 `--acpi` `<boolean>` ('default =' `1`)::
93 `--agent` `[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>]` ::
95 Enable/disable Qemu GuestAgent and its properties.
97 `--arch` `<aarch64 | x86_64>` ::
99 Virtual processor architecture. Defaults to the host.
101 `--archive` `<string>` ::
105 `--args` `<string>` ::
107 Arbitrary arguments passed to kvm.
109 `--autostart` `<boolean>` ('default =' `0`)::
111 Automatic restart after crash (currently ignored).
113 `--balloon` `<integer> (0 - N)` ::
115 Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
117 `--bios` `<ovmf | seabios>` ('default =' `seabios`)::
119 Select BIOS implementation.
121 `--boot` `[acdn]{1,4}` ('default =' `cdn`)::
123 Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).
125 `--bootdisk` `(ide|sata|scsi|virtio)\d+` ::
127 Enable booting from specified disk.
129 `--bwlimit` `<integer> (0 - N)` ::
131 Override i/o bandwidth limit (in KiB/s).
133 `--cdrom` `<volume>` ::
135 This is an alias for option -ide2
137 `--cipassword` `<password>` ::
139 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.
141 `--citype` `<configdrive2 | nocloud>` ::
143 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.
145 `--ciuser` `<string>` ::
147 cloud-init: User name to change ssh keys and password for instead of the image's configured default user.
149 `--cores` `<integer> (1 - N)` ('default =' `1`)::
151 The number of cores per socket.
153 `--cpu` `[cputype=]<enum> [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>]` ::
157 `--cpulimit` `<number> (0 - 128)` ('default =' `0`)::
161 `--cpuunits` `<integer> (2 - 262144)` ('default =' `1024`)::
165 `--description` `<string>` ::
167 Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.
169 `--efidisk0` `[file=]<volume> [,format=<enum>] [,size=<DiskSize>]` ::
171 Configure a Disk for storing EFI vars
173 `--force` `<boolean>` ::
175 Allow to overwrite existing VM.
177 NOTE: Requires option(s): `archive`
179 `--freeze` `<boolean>` ::
181 Freeze CPU at startup (use 'c' monitor command to start execution).
183 `--hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
185 Map host PCI devices into guest.
187 `--hotplug` `<string>` ('default =' `network,disk,usb`)::
189 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'.
191 `--hugepages` `<1024 | 2 | any>` ::
193 Enable/disable hugepages memory.
195 `--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>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
197 Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
199 `--ipconfig[n]` `[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]` ::
201 cloud-init: Specify IP addresses and gateways for the corresponding interface.
203 IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.
205 The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided.
206 For IPv6 the special string 'auto' can be used to use stateless autoconfiguration.
208 If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4.
210 `--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>` ::
212 Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg' configuration file.It should not be necessary to set it.
214 `--kvm` `<boolean>` ('default =' `1`)::
216 Enable/disable KVM hardware virtualization.
218 `--localtime` `<boolean>` ::
220 Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
222 `--lock` `<backup | migrate | rollback | snapshot>` ::
226 `--machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?|virt(?:-\d+\.\d+)?)` ::
228 Specifies the Qemu machine type.
230 `--memory` `<integer> (16 - N)` ('default =' `512`)::
232 Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
234 `--migrate_downtime` `<number> (0 - N)` ('default =' `0.1`)::
236 Set maximum tolerated downtime (in seconds) for migrations.
238 `--migrate_speed` `<integer> (0 - N)` ('default =' `0`)::
240 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
242 `--name` `<string>` ::
244 Set a name for the VM. Only used on the configuration web interface.
246 `--nameserver` `<string>` ::
248 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.
250 `--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>]` ::
252 Specify network devices.
254 `--numa` `<boolean>` ('default =' `0`)::
258 `--numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
262 `--onboot` `<boolean>` ('default =' `0`)::
264 Specifies whether a VM will be started during system bootup.
266 `--ostype` `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win7 | win8 | wvista | wxp>` ::
268 Specify guest operating system.
270 `--parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` ::
272 Map host parallel devices (n is 0 to 2).
274 `--pool` `<string>` ::
276 Add the VM to the specified pool.
278 `--protection` `<boolean>` ('default =' `0`)::
280 Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
282 `--reboot` `<boolean>` ('default =' `1`)::
284 Allow reboot. If set to '0' the VM exit on reboot.
286 `--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>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
288 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
290 `--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>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
292 Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
294 `--scsihw` `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
296 SCSI controller model
298 `--searchdomain` `<string>` ::
300 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.
302 `--serial[n]` `(/dev/.+|socket)` ::
304 Create a serial device inside the VM (n is 0 to 3)
306 `--shares` `<integer> (0 - 50000)` ('default =' `1000`)::
308 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.
310 `--smbios1` `[family=<string>] [,manufacturer=<string>] [,product=<string>] [,serial=<string>] [,sku=<string>] [,uuid=<UUID>] [,version=<string>]` ::
312 Specify SMBIOS type 1 fields.
314 `--smp` `<integer> (1 - N)` ('default =' `1`)::
316 The number of CPUs. Please use option -sockets instead.
318 `--sockets` `<integer> (1 - N)` ('default =' `1`)::
320 The number of CPU sockets.
322 `--sshkeys` `<filepath>` ::
324 cloud-init: Setup public SSH keys (one key per line, OpenSSH format).
326 `--start` `<boolean>` ('default =' `0`)::
328 Start VM after it was created successfully.
330 `--startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
332 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'.
334 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
336 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.
338 `--storage` `<string>` ::
342 `--tablet` `<boolean>` ('default =' `1`)::
344 Enable/disable the USB tablet device.
346 `--tdf` `<boolean>` ('default =' `0`)::
348 Enable/disable time drift fix.
350 `--template` `<boolean>` ('default =' `0`)::
352 Enable/disable Template.
354 `--unique` `<boolean>` ::
356 Assign a unique random ethernet address.
358 NOTE: Requires option(s): `archive`
360 `--unused[n]` `<string>` ::
362 Reference to unused volumes. This is used internally, and should not be modified manually.
364 `--usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
366 Configure an USB device (n is 0 to 4).
368 `--vcpus` `<integer> (1 - N)` ('default =' `0`)::
370 Number of hotplugged vcpus.
372 `--vga` `[[type=]<enum>] [,memory=<integer>]` ::
374 Configure the VGA hardware.
376 `--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>]` ::
378 Use volume as VIRTIO hard disk (n is 0 to 15).
380 `--vmgenid` `<UUID>` ('default =' `1 (autogenerated)`)::
382 Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly.
384 `--vmstatestorage` `<string>` ::
386 Default storage for VM state volumes/files.
388 `--watchdog` `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::
390 Create a virtual hardware watchdog device.
392 *qm delsnapshot* `<vmid> <snapname>` `[OPTIONS]`
394 Delete a VM snapshot.
396 `<vmid>`: `<integer> (1 - N)` ::
398 The (unique) ID of the VM.
400 `<snapname>`: `<string>` ::
402 The name of the snapshot.
404 `--force` `<boolean>` ::
406 For removal from config file, even if removing disk snapshots fails.
408 *qm destroy* `<vmid>` `[OPTIONS]`
410 Destroy the vm (also delete all used/owned volumes).
412 `<vmid>`: `<integer> (1 - N)` ::
414 The (unique) ID of the VM.
416 `--skiplock` `<boolean>` ::
418 Ignore locks - only root is allowed to use this option.
420 *qm guest cmd* `<vmid> <command>`
422 Execute Qemu Guest Agent commands.
424 `<vmid>`: `<integer> (1 - N)` ::
426 The (unique) ID of the VM.
428 `<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>` ::
432 *qm guest exec* `<vmid> [<extra-args>]` `[OPTIONS]`
434 Executes the given command via the guest agent
436 `<vmid>`: `<integer> (1 - N)` ::
438 The (unique) ID of the VM.
440 `<extra-args>`: `<array>` ::
442 Extra arguments as array
444 `--synchronous` `<boolean>` ('default =' `1`)::
446 If set to off, returns the pid immediately instead of waiting for the commmand to finish or the timeout.
448 `--timeout` `<integer> (0 - N)` ('default =' `30`)::
450 The maximum time to wait synchronously for the command to finish. If reached, the pid gets returned. Set to 0 to deactivate
452 *qm guest exec-status* `<vmid> <pid>`
454 Gets the status of the given pid started by the guest-agent
456 `<vmid>`: `<integer> (1 - N)` ::
458 The (unique) ID of the VM.
460 `<pid>`: `<integer>` ::
464 *qm guest passwd* `<vmid> <username>` `[OPTIONS]`
466 Sets the password for the given user to the given password
468 `<vmid>`: `<integer> (1 - N)` ::
470 The (unique) ID of the VM.
472 `<username>`: `<string>` ::
474 The user to set the password for.
476 `--crypted` `<boolean>` ('default =' `0`)::
478 set to 1 if the password has already been passed through crypt()
480 *qm help* `[OPTIONS]`
482 Get help about specified command.
484 `--extra-args` `<array>` ::
486 Shows help for a specific command
488 `--verbose` `<boolean>` ::
490 Verbose output format.
492 *qm importdisk* `<vmid> <source> <storage>` `[OPTIONS]`
494 Import an external disk image as an unused disk in a VM. The
495 image format has to be supported by qemu-img(1).
497 `<vmid>`: `<integer> (1 - N)` ::
499 The (unique) ID of the VM.
501 `<source>`: `<string>` ::
503 Path to the disk image to import
505 `<storage>`: `<string>` ::
509 `--format` `<qcow2 | raw | vmdk>` ::
513 *qm importovf* `<vmid> <manifest> <storage>` `[OPTIONS]`
515 Create a new VM using parameters read from an OVF manifest
517 `<vmid>`: `<integer> (1 - N)` ::
519 The (unique) ID of the VM.
521 `<manifest>`: `<string>` ::
525 `<storage>`: `<string>` ::
529 `--dryrun` `<boolean>` ::
531 Print a parsed representation of the extracted OVF parameters, but do not create a VM
533 `--format` `<qcow2 | raw | vmdk>` ::
537 *qm list* `[OPTIONS]`
539 Virtual machine index (per node).
541 `--full` `<boolean>` ::
543 Determine the full status of active VMs.
545 *qm listsnapshot* `<vmid>`
549 `<vmid>`: `<integer> (1 - N)` ::
551 The (unique) ID of the VM.
553 *qm migrate* `<vmid> <target>` `[OPTIONS]`
555 Migrate virtual machine. Creates a new migration task.
557 `<vmid>`: `<integer> (1 - N)` ::
559 The (unique) ID of the VM.
561 `<target>`: `<string>` ::
565 `--force` `<boolean>` ::
567 Allow to migrate VMs which use local devices. Only root may use this option.
569 `--migration_network` `<string>` ::
571 CIDR of the (sub) network that is used for migration.
573 `--migration_type` `<insecure | secure>` ::
575 Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.
577 `--online` `<boolean>` ::
579 Use online/live migration.
581 `--targetstorage` `<string>` ::
583 Default target storage.
585 `--with-local-disks` `<boolean>` ::
587 Enable live storage migration for local disk
589 *qm monitor* `<vmid>`
591 Enter Qemu Monitor interface.
593 `<vmid>`: `<integer> (1 - N)` ::
595 The (unique) ID of the VM.
597 *qm move_disk* `<vmid> <disk> <storage>` `[OPTIONS]`
599 Move volume to different storage.
601 `<vmid>`: `<integer> (1 - N)` ::
603 The (unique) ID of the VM.
605 `<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>` ::
607 The disk you want to move.
609 `<storage>`: `<string>` ::
613 `--delete` `<boolean>` ('default =' `0`)::
615 Delete the original disk after successful copy. By default the original disk is kept as unused disk.
617 `--digest` `<string>` ::
619 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
621 `--format` `<qcow2 | raw | vmdk>` ::
627 Used by qmigrate - do not use manually.
629 *qm nbdstop* `<vmid>`
631 Stop embedded nbd server.
633 `<vmid>`: `<integer> (1 - N)` ::
635 The (unique) ID of the VM.
637 *qm pending* `<vmid>`
639 Get virtual machine configuration, including pending changes.
641 `<vmid>`: `<integer> (1 - N)` ::
643 The (unique) ID of the VM.
645 *qm rescan* `[OPTIONS]`
647 Rescan all storages and update disk sizes and unused disk images.
649 `--dryrun` `<boolean>` ('default =' `0`)::
651 Do not actually write changes out to VM config(s).
653 `--vmid` `<integer> (1 - N)` ::
655 The (unique) ID of the VM.
657 *qm reset* `<vmid>` `[OPTIONS]`
659 Reset virtual machine.
661 `<vmid>`: `<integer> (1 - N)` ::
663 The (unique) ID of the VM.
665 `--skiplock` `<boolean>` ::
667 Ignore locks - only root is allowed to use this option.
669 *qm resize* `<vmid> <disk> <size>` `[OPTIONS]`
673 `<vmid>`: `<integer> (1 - N)` ::
675 The (unique) ID of the VM.
677 `<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>` ::
679 The disk you want to resize.
681 `<size>`: `\+?\d+(\.\d+)?[KMGT]?` ::
683 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.
685 `--digest` `<string>` ::
687 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
689 `--skiplock` `<boolean>` ::
691 Ignore locks - only root is allowed to use this option.
693 *qm resume* `<vmid>` `[OPTIONS]`
695 Resume virtual machine.
697 `<vmid>`: `<integer> (1 - N)` ::
699 The (unique) ID of the VM.
701 `--nocheck` `<boolean>` ::
703 no description available
705 `--skiplock` `<boolean>` ::
707 Ignore locks - only root is allowed to use this option.
709 *qm rollback* `<vmid> <snapname>`
711 Rollback VM state to specified snapshot.
713 `<vmid>`: `<integer> (1 - N)` ::
715 The (unique) ID of the VM.
717 `<snapname>`: `<string>` ::
719 The name of the snapshot.
721 *qm sendkey* `<vmid> <key>` `[OPTIONS]`
723 Send key event to virtual machine.
725 `<vmid>`: `<integer> (1 - N)` ::
727 The (unique) ID of the VM.
729 `<key>`: `<string>` ::
731 The key (qemu monitor encoding).
733 `--skiplock` `<boolean>` ::
735 Ignore locks - only root is allowed to use this option.
737 *qm set* `<vmid>` `[OPTIONS]`
739 Set virtual machine options (synchrounous API) - You should consider using
740 the POST method instead for any actions involving hotplug or storage
743 `<vmid>`: `<integer> (1 - N)` ::
745 The (unique) ID of the VM.
747 `--acpi` `<boolean>` ('default =' `1`)::
751 `--agent` `[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>]` ::
753 Enable/disable Qemu GuestAgent and its properties.
755 `--arch` `<aarch64 | x86_64>` ::
757 Virtual processor architecture. Defaults to the host.
759 `--args` `<string>` ::
761 Arbitrary arguments passed to kvm.
763 `--autostart` `<boolean>` ('default =' `0`)::
765 Automatic restart after crash (currently ignored).
767 `--balloon` `<integer> (0 - N)` ::
769 Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
771 `--bios` `<ovmf | seabios>` ('default =' `seabios`)::
773 Select BIOS implementation.
775 `--boot` `[acdn]{1,4}` ('default =' `cdn`)::
777 Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).
779 `--bootdisk` `(ide|sata|scsi|virtio)\d+` ::
781 Enable booting from specified disk.
783 `--cdrom` `<volume>` ::
785 This is an alias for option -ide2
787 `--cipassword` `<password>` ::
789 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.
791 `--citype` `<configdrive2 | nocloud>` ::
793 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.
795 `--ciuser` `<string>` ::
797 cloud-init: User name to change ssh keys and password for instead of the image's configured default user.
799 `--cores` `<integer> (1 - N)` ('default =' `1`)::
801 The number of cores per socket.
803 `--cpu` `[cputype=]<enum> [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>]` ::
807 `--cpulimit` `<number> (0 - 128)` ('default =' `0`)::
811 `--cpuunits` `<integer> (2 - 262144)` ('default =' `1024`)::
815 `--delete` `<string>` ::
817 A list of settings you want to delete.
819 `--description` `<string>` ::
821 Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.
823 `--digest` `<string>` ::
825 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
827 `--efidisk0` `[file=]<volume> [,format=<enum>] [,size=<DiskSize>]` ::
829 Configure a Disk for storing EFI vars
831 `--force` `<boolean>` ::
833 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.
835 NOTE: Requires option(s): `delete`
837 `--freeze` `<boolean>` ::
839 Freeze CPU at startup (use 'c' monitor command to start execution).
841 `--hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
843 Map host PCI devices into guest.
845 `--hotplug` `<string>` ('default =' `network,disk,usb`)::
847 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'.
849 `--hugepages` `<1024 | 2 | any>` ::
851 Enable/disable hugepages memory.
853 `--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>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
855 Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
857 `--ipconfig[n]` `[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]` ::
859 cloud-init: Specify IP addresses and gateways for the corresponding interface.
861 IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.
863 The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided.
864 For IPv6 the special string 'auto' can be used to use stateless autoconfiguration.
866 If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4.
868 `--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>` ::
870 Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg' configuration file.It should not be necessary to set it.
872 `--kvm` `<boolean>` ('default =' `1`)::
874 Enable/disable KVM hardware virtualization.
876 `--localtime` `<boolean>` ::
878 Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
880 `--lock` `<backup | migrate | rollback | snapshot>` ::
884 `--machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?|virt(?:-\d+\.\d+)?)` ::
886 Specifies the Qemu machine type.
888 `--memory` `<integer> (16 - N)` ('default =' `512`)::
890 Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
892 `--migrate_downtime` `<number> (0 - N)` ('default =' `0.1`)::
894 Set maximum tolerated downtime (in seconds) for migrations.
896 `--migrate_speed` `<integer> (0 - N)` ('default =' `0`)::
898 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
900 `--name` `<string>` ::
902 Set a name for the VM. Only used on the configuration web interface.
904 `--nameserver` `<string>` ::
906 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.
908 `--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>]` ::
910 Specify network devices.
912 `--numa` `<boolean>` ('default =' `0`)::
916 `--numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
920 `--onboot` `<boolean>` ('default =' `0`)::
922 Specifies whether a VM will be started during system bootup.
924 `--ostype` `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win7 | win8 | wvista | wxp>` ::
926 Specify guest operating system.
928 `--parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` ::
930 Map host parallel devices (n is 0 to 2).
932 `--protection` `<boolean>` ('default =' `0`)::
934 Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
936 `--reboot` `<boolean>` ('default =' `1`)::
938 Allow reboot. If set to '0' the VM exit on reboot.
940 `--revert` `<string>` ::
942 Revert a pending change.
944 `--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>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
946 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
948 `--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>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
950 Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
952 `--scsihw` `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
954 SCSI controller model
956 `--searchdomain` `<string>` ::
958 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.
960 `--serial[n]` `(/dev/.+|socket)` ::
962 Create a serial device inside the VM (n is 0 to 3)
964 `--shares` `<integer> (0 - 50000)` ('default =' `1000`)::
966 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.
968 `--skiplock` `<boolean>` ::
970 Ignore locks - only root is allowed to use this option.
972 `--smbios1` `[family=<string>] [,manufacturer=<string>] [,product=<string>] [,serial=<string>] [,sku=<string>] [,uuid=<UUID>] [,version=<string>]` ::
974 Specify SMBIOS type 1 fields.
976 `--smp` `<integer> (1 - N)` ('default =' `1`)::
978 The number of CPUs. Please use option -sockets instead.
980 `--sockets` `<integer> (1 - N)` ('default =' `1`)::
982 The number of CPU sockets.
984 `--sshkeys` `<filepath>` ::
986 cloud-init: Setup public SSH keys (one key per line, OpenSSH format).
988 `--startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
990 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'.
992 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
994 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.
996 `--tablet` `<boolean>` ('default =' `1`)::
998 Enable/disable the USB tablet device.
1000 `--tdf` `<boolean>` ('default =' `0`)::
1002 Enable/disable time drift fix.
1004 `--template` `<boolean>` ('default =' `0`)::
1006 Enable/disable Template.
1008 `--unused[n]` `<string>` ::
1010 Reference to unused volumes. This is used internally, and should not be modified manually.
1012 `--usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
1014 Configure an USB device (n is 0 to 4).
1016 `--vcpus` `<integer> (1 - N)` ('default =' `0`)::
1018 Number of hotplugged vcpus.
1020 `--vga` `[[type=]<enum>] [,memory=<integer>]` ::
1022 Configure the VGA hardware.
1024 `--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>]` ::
1026 Use volume as VIRTIO hard disk (n is 0 to 15).
1028 `--vmgenid` `<UUID>` ('default =' `1 (autogenerated)`)::
1030 Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly.
1032 `--vmstatestorage` `<string>` ::
1034 Default storage for VM state volumes/files.
1036 `--watchdog` `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::
1038 Create a virtual hardware watchdog device.
1040 *qm showcmd* `<vmid>` `[OPTIONS]`
1042 Show command line which is used to start the VM (debug info).
1044 `<vmid>`: `<integer> (1 - N)` ::
1046 The (unique) ID of the VM.
1048 `--pretty` `<boolean>` ('default =' `0`)::
1050 Puts each option on a new line to enhance human readability
1052 *qm shutdown* `<vmid>` `[OPTIONS]`
1054 Shutdown virtual machine. This is similar to pressing the power button on a
1055 physical machine.This will send an ACPI event for the guest OS, which
1056 should then proceed to a clean shutdown.
1058 `<vmid>`: `<integer> (1 - N)` ::
1060 The (unique) ID of the VM.
1062 `--forceStop` `<boolean>` ('default =' `0`)::
1064 Make sure the VM stops.
1066 `--keepActive` `<boolean>` ('default =' `0`)::
1068 Do not deactivate storage volumes.
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 snapshot* `<vmid> <snapname>` `[OPTIONS]`
1082 `<vmid>`: `<integer> (1 - N)` ::
1084 The (unique) ID of the VM.
1086 `<snapname>`: `<string>` ::
1088 The name of the snapshot.
1090 `--description` `<string>` ::
1092 A textual description or comment.
1094 `--vmstate` `<boolean>` ::
1098 *qm start* `<vmid>` `[OPTIONS]`
1100 Start virtual machine.
1102 `<vmid>`: `<integer> (1 - N)` ::
1104 The (unique) ID of the VM.
1106 `--machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?|virt(?:-\d+\.\d+)?)` ::
1108 Specifies the Qemu machine type.
1110 `--migratedfrom` `<string>` ::
1112 The cluster node name.
1114 `--migration_network` `<string>` ::
1116 CIDR of the (sub) network that is used for migration.
1118 `--migration_type` `<insecure | secure>` ::
1120 Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.
1122 `--skiplock` `<boolean>` ::
1124 Ignore locks - only root is allowed to use this option.
1126 `--stateuri` `<string>` ::
1128 Some command save/restore state from this location.
1130 `--targetstorage` `<string>` ::
1132 Target storage for the migration. (Can be '1' to use the same storage id as on the source node.)
1134 *qm status* `<vmid>` `[OPTIONS]`
1138 `<vmid>`: `<integer> (1 - N)` ::
1140 The (unique) ID of the VM.
1142 `--verbose` `<boolean>` ::
1144 Verbose output format
1146 *qm stop* `<vmid>` `[OPTIONS]`
1148 Stop virtual machine. The qemu process will exit immediately. Thisis akin
1149 to pulling the power plug of a running computer and may damage the VM data
1151 `<vmid>`: `<integer> (1 - N)` ::
1153 The (unique) ID of the VM.
1155 `--keepActive` `<boolean>` ('default =' `0`)::
1157 Do not deactivate storage volumes.
1159 `--migratedfrom` `<string>` ::
1161 The cluster node name.
1163 `--skiplock` `<boolean>` ::
1165 Ignore locks - only root is allowed to use this option.
1167 `--timeout` `<integer> (0 - N)` ::
1169 Wait maximal timeout seconds.
1171 *qm suspend* `<vmid>` `[OPTIONS]`
1173 Suspend virtual machine.
1175 `<vmid>`: `<integer> (1 - N)` ::
1177 The (unique) ID of the VM.
1179 `--skiplock` `<boolean>` ::
1181 Ignore locks - only root is allowed to use this option.
1183 *qm template* `<vmid>` `[OPTIONS]`
1187 `<vmid>`: `<integer> (1 - N)` ::
1189 The (unique) ID of the VM.
1191 `--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>` ::
1193 If you want to convert only 1 disk to base image.
1195 *qm terminal* `<vmid>` `[OPTIONS]`
1197 Open a terminal using a serial device (The VM need to have a serial device
1198 configured, for example 'serial0: socket')
1200 `<vmid>`: `<integer> (1 - N)` ::
1202 The (unique) ID of the VM.
1204 `--escape` `<string>` ('default =' `^O`)::
1208 `--iface` `<serial0 | serial1 | serial2 | serial3>` ::
1210 Select the serial device. By default we simply use the first suitable device.
1212 *qm unlink* `<vmid> --idlist <string>` `[OPTIONS]`
1214 Unlink/delete disk images.
1216 `<vmid>`: `<integer> (1 - N)` ::
1218 The (unique) ID of the VM.
1220 `--force` `<boolean>` ::
1222 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.
1224 `--idlist` `<string>` ::
1226 A list of disk IDs you want to delete.
1228 *qm unlock* `<vmid>`
1232 `<vmid>`: `<integer> (1 - N)` ::
1234 The (unique) ID of the VM.
1236 *qm vncproxy* `<vmid>`
1238 Proxy VM VNC traffic to stdin/stdout
1240 `<vmid>`: `<integer> (1 - N)` ::
1242 The (unique) ID of the VM.
1244 *qm wait* `<vmid>` `[OPTIONS]`
1246 Wait until the VM is stopped.
1248 `<vmid>`: `<integer> (1 - N)` ::
1250 The (unique) ID of the VM.
1252 `--timeout` `<integer> (1 - N)` ::
1254 Timeout in seconds. Default is to wait forever.