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 `--audio0` `device=<ich9-intel-hda|intel-hda|AC97> [,driver=<spice>]` ::
131 Configure a audio device, useful in combination with QXL/Spice.
133 `--autostart` `<boolean>` ('default =' `0`)::
135 Automatic restart after crash (currently ignored).
137 `--balloon` `<integer> (0 - N)` ::
139 Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
141 `--bios` `<ovmf | seabios>` ('default =' `seabios`)::
143 Select BIOS implementation.
145 `--boot` `[acdn]{1,4}` ('default =' `cdn`)::
147 Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).
149 `--bootdisk` `(ide|sata|scsi|virtio)\d+` ::
151 Enable booting from specified disk.
153 `--bwlimit` `<integer> (0 - N)` ('default =' `restore limit from datacenter or storage config`)::
155 Override I/O bandwidth limit (in KiB/s).
157 `--cdrom` `<volume>` ::
159 This is an alias for option -ide2
161 `--cicustom` `[meta=<volume>] [,network=<volume>] [,user=<volume>]` ::
163 cloud-init: Specify custom files to replace the automatically generated ones at start.
165 `--cipassword` `<password>` ::
167 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.
169 `--citype` `<configdrive2 | nocloud>` ::
171 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.
173 `--ciuser` `<string>` ::
175 cloud-init: User name to change ssh keys and password for instead of the image's configured default user.
177 `--cores` `<integer> (1 - N)` ('default =' `1`)::
179 The number of cores per socket.
181 `--cpu` `[cputype=]<enum> [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=<vendor-id>]` ::
185 `--cpulimit` `<number> (0 - 128)` ('default =' `0`)::
189 `--cpuunits` `<integer> (2 - 262144)` ('default =' `1024`)::
193 `--description` `<string>` ::
195 Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.
197 `--efidisk0` `[file=]<volume> [,format=<enum>] [,size=<DiskSize>]` ::
199 Configure a Disk for storing EFI vars
201 `--force` `<boolean>` ::
203 Allow to overwrite existing VM.
205 NOTE: Requires option(s): `archive`
207 `--freeze` `<boolean>` ::
209 Freeze CPU at startup (use 'c' monitor command to start execution).
211 `--hookscript` `<string>` ::
213 Script that will be executed during various steps in the vms lifetime.
215 `--hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
217 Map host PCI devices into guest.
219 `--hotplug` `<string>` ('default =' `network,disk,usb`)::
221 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'.
223 `--hugepages` `<1024 | 2 | any>` ::
225 Enable/disable hugepages memory.
227 `--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>]` ::
229 Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
231 `--ipconfig[n]` `[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]` ::
233 cloud-init: Specify IP addresses and gateways for the corresponding interface.
235 IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.
237 The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided.
238 For IPv6 the special string 'auto' can be used to use stateless autoconfiguration.
240 If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4.
242 `--ivshmem` `size=<integer> [,name=<string>]` ::
244 Inter-VM shared memory. Useful for direct communication between VMs, or to the host.
246 `--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>` ::
248 Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg' configuration file.It should not be necessary to set it.
250 `--kvm` `<boolean>` ('default =' `1`)::
252 Enable/disable KVM hardware virtualization.
254 `--localtime` `<boolean>` ::
256 Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
258 `--lock` `<backup | clone | create | migrate | rollback | snapshot | snapshot-delete | suspended | suspending>` ::
262 `--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\.pxe)?|virt(?:-\d+(\.\d+)+)?)` ::
264 Specifies the Qemu machine type.
266 `--memory` `<integer> (16 - N)` ('default =' `512`)::
268 Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
270 `--migrate_downtime` `<number> (0 - N)` ('default =' `0.1`)::
272 Set maximum tolerated downtime (in seconds) for migrations.
274 `--migrate_speed` `<integer> (0 - N)` ('default =' `0`)::
276 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
278 `--name` `<string>` ::
280 Set a name for the VM. Only used on the configuration web interface.
282 `--nameserver` `<string>` ::
284 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.
286 `--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>]` ::
288 Specify network devices.
290 `--numa` `<boolean>` ('default =' `0`)::
294 `--numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
298 `--onboot` `<boolean>` ('default =' `0`)::
300 Specifies whether a VM will be started during system bootup.
302 `--ostype` `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win7 | win8 | wvista | wxp>` ::
304 Specify guest operating system.
306 `--parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` ::
308 Map host parallel devices (n is 0 to 2).
310 `--pool` `<string>` ::
312 Add the VM to the specified pool.
314 `--protection` `<boolean>` ('default =' `0`)::
316 Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
318 `--reboot` `<boolean>` ('default =' `1`)::
320 Allow reboot. If set to '0' the VM exit on reboot.
322 `--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>]` ::
324 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
326 `--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>]` ::
328 Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
330 `--scsihw` `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
332 SCSI controller model
334 `--searchdomain` `<string>` ::
336 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.
338 `--serial[n]` `(/dev/.+|socket)` ::
340 Create a serial device inside the VM (n is 0 to 3)
342 `--shares` `<integer> (0 - 50000)` ('default =' `1000`)::
344 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.
346 `--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>]` ::
348 Specify SMBIOS type 1 fields.
350 `--smp` `<integer> (1 - N)` ('default =' `1`)::
352 The number of CPUs. Please use option -sockets instead.
354 `--sockets` `<integer> (1 - N)` ('default =' `1`)::
356 The number of CPU sockets.
358 `--spice_enhancements` `[foldersharing=<1|0>] [,videostreaming=<off|all|filter>]` ::
360 Configure additional enhancements for SPICE.
362 `--sshkeys` `<filepath>` ::
364 cloud-init: Setup public SSH keys (one key per line, OpenSSH format).
366 `--start` `<boolean>` ('default =' `0`)::
368 Start VM after it was created successfully.
370 `--startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
372 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'.
374 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
376 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.
378 `--storage` `<string>` ::
382 `--tablet` `<boolean>` ('default =' `1`)::
384 Enable/disable the USB tablet device.
386 `--tdf` `<boolean>` ('default =' `0`)::
388 Enable/disable time drift fix.
390 `--template` `<boolean>` ('default =' `0`)::
392 Enable/disable Template.
394 `--unique` `<boolean>` ::
396 Assign a unique random ethernet address.
398 NOTE: Requires option(s): `archive`
400 `--unused[n]` `<string>` ::
402 Reference to unused volumes. This is used internally, and should not be modified manually.
404 `--usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
406 Configure an USB device (n is 0 to 4).
408 `--vcpus` `<integer> (1 - N)` ('default =' `0`)::
410 Number of hotplugged vcpus.
412 `--vga` `[[type=]<enum>] [,memory=<integer>]` ::
414 Configure the VGA hardware.
416 `--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>]` ::
418 Use volume as VIRTIO hard disk (n is 0 to 15).
420 `--vmgenid` `<UUID>` ('default =' `1 (autogenerated)`)::
422 Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly.
424 `--vmstatestorage` `<string>` ::
426 Default storage for VM state volumes/files.
428 `--watchdog` `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::
430 Create a virtual hardware watchdog device.
432 *qm delsnapshot* `<vmid> <snapname>` `[OPTIONS]`
434 Delete a VM snapshot.
436 `<vmid>`: `<integer> (1 - N)` ::
438 The (unique) ID of the VM.
440 `<snapname>`: `<string>` ::
442 The name of the snapshot.
444 `--force` `<boolean>` ::
446 For removal from config file, even if removing disk snapshots fails.
448 *qm destroy* `<vmid>` `[OPTIONS]`
450 Destroy the vm (also delete all used/owned volumes).
452 `<vmid>`: `<integer> (1 - N)` ::
454 The (unique) ID of the VM.
456 `--purge` `<boolean>` ::
458 Remove vmid from backup cron jobs.
460 `--skiplock` `<boolean>` ::
462 Ignore locks - only root is allowed to use this option.
464 *qm guest cmd* `<vmid> <command>`
466 Execute Qemu Guest Agent commands.
468 `<vmid>`: `<integer> (1 - N)` ::
470 The (unique) ID of the VM.
472 `<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>` ::
476 *qm guest exec* `<vmid> [<extra-args>]` `[OPTIONS]`
478 Executes the given command via the guest agent
480 `<vmid>`: `<integer> (1 - N)` ::
482 The (unique) ID of the VM.
484 `<extra-args>`: `<array>` ::
486 Extra arguments as array
488 `--synchronous` `<boolean>` ('default =' `1`)::
490 If set to off, returns the pid immediately instead of waiting for the commmand to finish or the timeout.
492 `--timeout` `<integer> (0 - N)` ('default =' `30`)::
494 The maximum time to wait synchronously for the command to finish. If reached, the pid gets returned. Set to 0 to deactivate
496 *qm guest exec-status* `<vmid> <pid>`
498 Gets the status of the given pid started by the guest-agent
500 `<vmid>`: `<integer> (1 - N)` ::
502 The (unique) ID of the VM.
504 `<pid>`: `<integer>` ::
508 *qm guest passwd* `<vmid> <username>` `[OPTIONS]`
510 Sets the password for the given user to the given password
512 `<vmid>`: `<integer> (1 - N)` ::
514 The (unique) ID of the VM.
516 `<username>`: `<string>` ::
518 The user to set the password for.
520 `--crypted` `<boolean>` ('default =' `0`)::
522 set to 1 if the password has already been passed through crypt()
524 *qm help* `[OPTIONS]`
526 Get help about specified command.
528 `--extra-args` `<array>` ::
530 Shows help for a specific command
532 `--verbose` `<boolean>` ::
534 Verbose output format.
536 *qm importdisk* `<vmid> <source> <storage>` `[OPTIONS]`
538 Import an external disk image as an unused disk in a VM. The
539 image format has to be supported by qemu-img(1).
541 `<vmid>`: `<integer> (1 - N)` ::
543 The (unique) ID of the VM.
545 `<source>`: `<string>` ::
547 Path to the disk image to import
549 `<storage>`: `<string>` ::
553 `--format` `<qcow2 | raw | vmdk>` ::
557 *qm importovf* `<vmid> <manifest> <storage>` `[OPTIONS]`
559 Create a new VM using parameters read from an OVF manifest
561 `<vmid>`: `<integer> (1 - N)` ::
563 The (unique) ID of the VM.
565 `<manifest>`: `<string>` ::
569 `<storage>`: `<string>` ::
573 `--dryrun` `<boolean>` ::
575 Print a parsed representation of the extracted OVF parameters, but do not create a VM
577 `--format` `<qcow2 | raw | vmdk>` ::
581 *qm list* `[OPTIONS]`
583 Virtual machine index (per node).
585 `--full` `<boolean>` ::
587 Determine the full status of active VMs.
589 *qm listsnapshot* `<vmid>`
593 `<vmid>`: `<integer> (1 - N)` ::
595 The (unique) ID of the VM.
597 *qm migrate* `<vmid> <target>` `[OPTIONS]`
599 Migrate virtual machine. Creates a new migration task.
601 `<vmid>`: `<integer> (1 - N)` ::
603 The (unique) ID of the VM.
605 `<target>`: `<string>` ::
609 `--bwlimit` `<integer> (0 - N)` ('default =' `migrate limit from datacenter or storage config`)::
611 Override I/O bandwidth limit (in KiB/s).
613 `--force` `<boolean>` ::
615 Allow to migrate VMs which use local devices. Only root may use this option.
617 `--migration_network` `<string>` ::
619 CIDR of the (sub) network that is used for migration.
621 `--migration_type` `<insecure | secure>` ::
623 Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.
625 `--online` `<boolean>` ::
627 Use online/live migration if VM is running. Ignored if VM is stopped.
629 `--targetstorage` `<string>` ::
631 Default target storage.
633 `--with-local-disks` `<boolean>` ::
635 Enable live storage migration for local disk
637 *qm monitor* `<vmid>`
639 Enter Qemu Monitor interface.
641 `<vmid>`: `<integer> (1 - N)` ::
643 The (unique) ID of the VM.
645 *qm move_disk* `<vmid> <disk> <storage>` `[OPTIONS]`
647 Move volume to different storage.
649 `<vmid>`: `<integer> (1 - N)` ::
651 The (unique) ID of the VM.
653 `<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>` ::
655 The disk you want to move.
657 `<storage>`: `<string>` ::
661 `--bwlimit` `<integer> (0 - N)` ('default =' `move limit from datacenter or storage config`)::
663 Override I/O bandwidth limit (in KiB/s).
665 `--delete` `<boolean>` ('default =' `0`)::
667 Delete the original disk after successful copy. By default the original disk is kept as unused disk.
669 `--digest` `<string>` ::
671 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
673 `--format` `<qcow2 | raw | vmdk>` ::
679 Used by qmigrate - do not use manually.
681 *qm nbdstop* `<vmid>`
683 Stop embedded nbd server.
685 `<vmid>`: `<integer> (1 - N)` ::
687 The (unique) ID of the VM.
689 *qm pending* `<vmid>`
691 Get virtual machine configuration, including pending changes.
693 `<vmid>`: `<integer> (1 - N)` ::
695 The (unique) ID of the VM.
697 *qm reboot* `<vmid>` `[OPTIONS]`
699 Reboot the VM by shutting it down, and starting it again. Applies pending
702 `<vmid>`: `<integer> (1 - N)` ::
704 The (unique) ID of the VM.
706 `--timeout` `<integer> (0 - N)` ::
708 Wait maximal timeout seconds for the shutdown.
710 *qm rescan* `[OPTIONS]`
712 Rescan all storages and update disk sizes and unused disk images.
714 `--dryrun` `<boolean>` ('default =' `0`)::
716 Do not actually write changes out to VM config(s).
718 `--vmid` `<integer> (1 - N)` ::
720 The (unique) ID of the VM.
722 *qm reset* `<vmid>` `[OPTIONS]`
724 Reset virtual machine.
726 `<vmid>`: `<integer> (1 - N)` ::
728 The (unique) ID of the VM.
730 `--skiplock` `<boolean>` ::
732 Ignore locks - only root is allowed to use this option.
734 *qm resize* `<vmid> <disk> <size>` `[OPTIONS]`
738 `<vmid>`: `<integer> (1 - N)` ::
740 The (unique) ID of the VM.
742 `<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>` ::
744 The disk you want to resize.
746 `<size>`: `\+?\d+(\.\d+)?[KMGT]?` ::
748 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.
750 `--digest` `<string>` ::
752 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
754 `--skiplock` `<boolean>` ::
756 Ignore locks - only root is allowed to use this option.
758 *qm resume* `<vmid>` `[OPTIONS]`
760 Resume virtual machine.
762 `<vmid>`: `<integer> (1 - N)` ::
764 The (unique) ID of the VM.
766 `--nocheck` `<boolean>` ::
768 no description available
770 `--skiplock` `<boolean>` ::
772 Ignore locks - only root is allowed to use this option.
774 *qm rollback* `<vmid> <snapname>`
776 Rollback VM state to specified snapshot.
778 `<vmid>`: `<integer> (1 - N)` ::
780 The (unique) ID of the VM.
782 `<snapname>`: `<string>` ::
784 The name of the snapshot.
786 *qm sendkey* `<vmid> <key>` `[OPTIONS]`
788 Send key event to virtual machine.
790 `<vmid>`: `<integer> (1 - N)` ::
792 The (unique) ID of the VM.
794 `<key>`: `<string>` ::
796 The key (qemu monitor encoding).
798 `--skiplock` `<boolean>` ::
800 Ignore locks - only root is allowed to use this option.
802 *qm set* `<vmid>` `[OPTIONS]`
804 Set virtual machine options (synchrounous API) - You should consider using
805 the POST method instead for any actions involving hotplug or storage
808 `<vmid>`: `<integer> (1 - N)` ::
810 The (unique) ID of the VM.
812 `--acpi` `<boolean>` ('default =' `1`)::
816 `--agent` `[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>]` ::
818 Enable/disable Qemu GuestAgent and its properties.
820 `--arch` `<aarch64 | x86_64>` ::
822 Virtual processor architecture. Defaults to the host.
824 `--args` `<string>` ::
826 Arbitrary arguments passed to kvm.
828 `--audio0` `device=<ich9-intel-hda|intel-hda|AC97> [,driver=<spice>]` ::
830 Configure a audio device, useful in combination with QXL/Spice.
832 `--autostart` `<boolean>` ('default =' `0`)::
834 Automatic restart after crash (currently ignored).
836 `--balloon` `<integer> (0 - N)` ::
838 Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
840 `--bios` `<ovmf | seabios>` ('default =' `seabios`)::
842 Select BIOS implementation.
844 `--boot` `[acdn]{1,4}` ('default =' `cdn`)::
846 Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).
848 `--bootdisk` `(ide|sata|scsi|virtio)\d+` ::
850 Enable booting from specified disk.
852 `--cdrom` `<volume>` ::
854 This is an alias for option -ide2
856 `--cicustom` `[meta=<volume>] [,network=<volume>] [,user=<volume>]` ::
858 cloud-init: Specify custom files to replace the automatically generated ones at start.
860 `--cipassword` `<password>` ::
862 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.
864 `--citype` `<configdrive2 | nocloud>` ::
866 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.
868 `--ciuser` `<string>` ::
870 cloud-init: User name to change ssh keys and password for instead of the image's configured default user.
872 `--cores` `<integer> (1 - N)` ('default =' `1`)::
874 The number of cores per socket.
876 `--cpu` `[cputype=]<enum> [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=<vendor-id>]` ::
880 `--cpulimit` `<number> (0 - 128)` ('default =' `0`)::
884 `--cpuunits` `<integer> (2 - 262144)` ('default =' `1024`)::
888 `--delete` `<string>` ::
890 A list of settings you want to delete.
892 `--description` `<string>` ::
894 Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.
896 `--digest` `<string>` ::
898 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
900 `--efidisk0` `[file=]<volume> [,format=<enum>] [,size=<DiskSize>]` ::
902 Configure a Disk for storing EFI vars
904 `--force` `<boolean>` ::
906 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.
908 NOTE: Requires option(s): `delete`
910 `--freeze` `<boolean>` ::
912 Freeze CPU at startup (use 'c' monitor command to start execution).
914 `--hookscript` `<string>` ::
916 Script that will be executed during various steps in the vms lifetime.
918 `--hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
920 Map host PCI devices into guest.
922 `--hotplug` `<string>` ('default =' `network,disk,usb`)::
924 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'.
926 `--hugepages` `<1024 | 2 | any>` ::
928 Enable/disable hugepages memory.
930 `--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>]` ::
932 Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
934 `--ipconfig[n]` `[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]` ::
936 cloud-init: Specify IP addresses and gateways for the corresponding interface.
938 IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.
940 The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided.
941 For IPv6 the special string 'auto' can be used to use stateless autoconfiguration.
943 If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4.
945 `--ivshmem` `size=<integer> [,name=<string>]` ::
947 Inter-VM shared memory. Useful for direct communication between VMs, or to the host.
949 `--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>` ::
951 Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg' configuration file.It should not be necessary to set it.
953 `--kvm` `<boolean>` ('default =' `1`)::
955 Enable/disable KVM hardware virtualization.
957 `--localtime` `<boolean>` ::
959 Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
961 `--lock` `<backup | clone | create | migrate | rollback | snapshot | snapshot-delete | suspended | suspending>` ::
965 `--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\.pxe)?|virt(?:-\d+(\.\d+)+)?)` ::
967 Specifies the Qemu machine type.
969 `--memory` `<integer> (16 - N)` ('default =' `512`)::
971 Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
973 `--migrate_downtime` `<number> (0 - N)` ('default =' `0.1`)::
975 Set maximum tolerated downtime (in seconds) for migrations.
977 `--migrate_speed` `<integer> (0 - N)` ('default =' `0`)::
979 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
981 `--name` `<string>` ::
983 Set a name for the VM. Only used on the configuration web interface.
985 `--nameserver` `<string>` ::
987 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.
989 `--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>]` ::
991 Specify network devices.
993 `--numa` `<boolean>` ('default =' `0`)::
997 `--numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
1001 `--onboot` `<boolean>` ('default =' `0`)::
1003 Specifies whether a VM will be started during system bootup.
1005 `--ostype` `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win7 | win8 | wvista | wxp>` ::
1007 Specify guest operating system.
1009 `--parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` ::
1011 Map host parallel devices (n is 0 to 2).
1013 `--protection` `<boolean>` ('default =' `0`)::
1015 Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
1017 `--reboot` `<boolean>` ('default =' `1`)::
1019 Allow reboot. If set to '0' the VM exit on reboot.
1021 `--revert` `<string>` ::
1023 Revert a pending change.
1025 `--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>]` ::
1027 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
1029 `--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>]` ::
1031 Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
1033 `--scsihw` `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
1035 SCSI controller model
1037 `--searchdomain` `<string>` ::
1039 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.
1041 `--serial[n]` `(/dev/.+|socket)` ::
1043 Create a serial device inside the VM (n is 0 to 3)
1045 `--shares` `<integer> (0 - 50000)` ('default =' `1000`)::
1047 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.
1049 `--skiplock` `<boolean>` ::
1051 Ignore locks - only root is allowed to use this option.
1053 `--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>]` ::
1055 Specify SMBIOS type 1 fields.
1057 `--smp` `<integer> (1 - N)` ('default =' `1`)::
1059 The number of CPUs. Please use option -sockets instead.
1061 `--sockets` `<integer> (1 - N)` ('default =' `1`)::
1063 The number of CPU sockets.
1065 `--spice_enhancements` `[foldersharing=<1|0>] [,videostreaming=<off|all|filter>]` ::
1067 Configure additional enhancements for SPICE.
1069 `--sshkeys` `<filepath>` ::
1071 cloud-init: Setup public SSH keys (one key per line, OpenSSH format).
1073 `--startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
1075 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'.
1077 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
1079 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.
1081 `--tablet` `<boolean>` ('default =' `1`)::
1083 Enable/disable the USB tablet device.
1085 `--tdf` `<boolean>` ('default =' `0`)::
1087 Enable/disable time drift fix.
1089 `--template` `<boolean>` ('default =' `0`)::
1091 Enable/disable Template.
1093 `--unused[n]` `<string>` ::
1095 Reference to unused volumes. This is used internally, and should not be modified manually.
1097 `--usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
1099 Configure an USB device (n is 0 to 4).
1101 `--vcpus` `<integer> (1 - N)` ('default =' `0`)::
1103 Number of hotplugged vcpus.
1105 `--vga` `[[type=]<enum>] [,memory=<integer>]` ::
1107 Configure the VGA hardware.
1109 `--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>]` ::
1111 Use volume as VIRTIO hard disk (n is 0 to 15).
1113 `--vmgenid` `<UUID>` ('default =' `1 (autogenerated)`)::
1115 Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly.
1117 `--vmstatestorage` `<string>` ::
1119 Default storage for VM state volumes/files.
1121 `--watchdog` `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::
1123 Create a virtual hardware watchdog device.
1125 *qm showcmd* `<vmid>` `[OPTIONS]`
1127 Show command line which is used to start the VM (debug info).
1129 `<vmid>`: `<integer> (1 - N)` ::
1131 The (unique) ID of the VM.
1133 `--pretty` `<boolean>` ('default =' `0`)::
1135 Puts each option on a new line to enhance human readability
1137 `--snapshot` `<string>` ::
1139 Fetch config values from given snapshot.
1141 *qm shutdown* `<vmid>` `[OPTIONS]`
1143 Shutdown virtual machine. This is similar to pressing the power button on a
1144 physical machine.This will send an ACPI event for the guest OS, which
1145 should then proceed to a clean shutdown.
1147 `<vmid>`: `<integer> (1 - N)` ::
1149 The (unique) ID of the VM.
1151 `--forceStop` `<boolean>` ('default =' `0`)::
1153 Make sure the VM stops.
1155 `--keepActive` `<boolean>` ('default =' `0`)::
1157 Do not deactivate storage volumes.
1159 `--skiplock` `<boolean>` ::
1161 Ignore locks - only root is allowed to use this option.
1163 `--timeout` `<integer> (0 - N)` ::
1165 Wait maximal timeout seconds.
1167 *qm snapshot* `<vmid> <snapname>` `[OPTIONS]`
1171 `<vmid>`: `<integer> (1 - N)` ::
1173 The (unique) ID of the VM.
1175 `<snapname>`: `<string>` ::
1177 The name of the snapshot.
1179 `--description` `<string>` ::
1181 A textual description or comment.
1183 `--vmstate` `<boolean>` ::
1187 *qm start* `<vmid>` `[OPTIONS]`
1189 Start virtual machine.
1191 `<vmid>`: `<integer> (1 - N)` ::
1193 The (unique) ID of the VM.
1195 `--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\.pxe)?|virt(?:-\d+(\.\d+)+)?)` ::
1197 Specifies the Qemu machine type.
1199 `--migratedfrom` `<string>` ::
1201 The cluster node name.
1203 `--migration_network` `<string>` ::
1205 CIDR of the (sub) network that is used for migration.
1207 `--migration_type` `<insecure | secure>` ::
1209 Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.
1211 `--skiplock` `<boolean>` ::
1213 Ignore locks - only root is allowed to use this option.
1215 `--stateuri` `<string>` ::
1217 Some command save/restore state from this location.
1219 `--targetstorage` `<string>` ::
1221 Target storage for the migration. (Can be '1' to use the same storage id as on the source node.)
1223 *qm status* `<vmid>` `[OPTIONS]`
1227 `<vmid>`: `<integer> (1 - N)` ::
1229 The (unique) ID of the VM.
1231 `--verbose` `<boolean>` ::
1233 Verbose output format
1235 *qm stop* `<vmid>` `[OPTIONS]`
1237 Stop virtual machine. The qemu process will exit immediately. Thisis akin
1238 to pulling the power plug of a running computer and may damage the VM data
1240 `<vmid>`: `<integer> (1 - N)` ::
1242 The (unique) ID of the VM.
1244 `--keepActive` `<boolean>` ('default =' `0`)::
1246 Do not deactivate storage volumes.
1248 `--migratedfrom` `<string>` ::
1250 The cluster node name.
1252 `--skiplock` `<boolean>` ::
1254 Ignore locks - only root is allowed to use this option.
1256 `--timeout` `<integer> (0 - N)` ::
1258 Wait maximal timeout seconds.
1260 *qm suspend* `<vmid>` `[OPTIONS]`
1262 Suspend virtual machine.
1264 `<vmid>`: `<integer> (1 - N)` ::
1266 The (unique) ID of the VM.
1268 `--skiplock` `<boolean>` ::
1270 Ignore locks - only root is allowed to use this option.
1272 `--statestorage` `<string>` ::
1274 The storage for the VM state
1276 NOTE: Requires option(s): `todisk`
1278 `--todisk` `<boolean>` ('default =' `0`)::
1280 If set, suspends the VM to disk. Will be resumed on next VM start.
1282 *qm template* `<vmid>` `[OPTIONS]`
1286 `<vmid>`: `<integer> (1 - N)` ::
1288 The (unique) ID of the VM.
1290 `--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>` ::
1292 If you want to convert only 1 disk to base image.
1294 *qm terminal* `<vmid>` `[OPTIONS]`
1296 Open a terminal using a serial device (The VM need to have a serial device
1297 configured, for example 'serial0: socket')
1299 `<vmid>`: `<integer> (1 - N)` ::
1301 The (unique) ID of the VM.
1303 `--escape` `<string>` ('default =' `^O`)::
1307 `--iface` `<serial0 | serial1 | serial2 | serial3>` ::
1309 Select the serial device. By default we simply use the first suitable device.
1311 *qm unlink* `<vmid> --idlist <string>` `[OPTIONS]`
1313 Unlink/delete disk images.
1315 `<vmid>`: `<integer> (1 - N)` ::
1317 The (unique) ID of the VM.
1319 `--force` `<boolean>` ::
1321 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.
1323 `--idlist` `<string>` ::
1325 A list of disk IDs you want to delete.
1327 *qm unlock* `<vmid>`
1331 `<vmid>`: `<integer> (1 - N)` ::
1333 The (unique) ID of the VM.
1335 *qm vncproxy* `<vmid>`
1337 Proxy VM VNC traffic to stdin/stdout
1339 `<vmid>`: `<integer> (1 - N)` ::
1341 The (unique) ID of the VM.
1343 *qm wait* `<vmid>` `[OPTIONS]`
1345 Wait until the VM is stopped.
1347 `<vmid>`: `<integer> (1 - N)` ::
1349 The (unique) ID of the VM.
1351 `--timeout` `<integer> (1 - N)` ::
1353 Timeout in seconds. Default is to wait forever.