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