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