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