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 the virtual machine configuration with pending configuration changes
87 applied. Set the 'current' parameter to get the current configuration
90 `<vmid>`: `<integer> (1 - N)` ::
92 The (unique) ID of the VM.
94 `--current` `<boolean>` ('default =' `0`)::
96 Get current values (instead of pending values).
98 `--snapshot` `<string>` ::
100 Fetch config values from given snapshot.
102 *qm create* `<vmid>` `[OPTIONS]`
104 Create or restore a virtual machine.
106 `<vmid>`: `<integer> (1 - N)` ::
108 The (unique) ID of the VM.
110 `--acpi` `<boolean>` ('default =' `1`)::
114 `--agent` `[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>] [,type=<virtio|isa>]` ::
116 Enable/disable communication with the Qemu Guest Agent and its properties.
118 `--arch` `<aarch64 | x86_64>` ::
120 Virtual processor architecture. Defaults to the host.
122 `--archive` `<string>` ::
124 The backup archive. Either the file system path to a .tar or .vma file (use '-' to pipe data from stdin) or a proxmox storage backup volume identifier.
126 `--args` `<string>` ::
128 Arbitrary arguments passed to kvm.
130 `--audio0` `device=<ich9-intel-hda|intel-hda|AC97> [,driver=<spice|none>]` ::
132 Configure a audio device, useful in combination with QXL/Spice.
134 `--autostart` `<boolean>` ('default =' `0`)::
136 Automatic restart after crash (currently ignored).
138 `--balloon` `<integer> (0 - N)` ::
140 Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
142 `--bios` `<ovmf | seabios>` ('default =' `seabios`)::
144 Select BIOS implementation.
146 `--boot` `[[legacy=]<[acdn]{1,4}>] [,order=<device[;device...]>]` ::
148 Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated.
150 `--bootdisk` `(ide|sata|scsi|virtio)\d+` ::
152 Enable booting from specified disk. Deprecated: Use 'boot: order=foo;bar' instead.
154 `--bwlimit` `<integer> (0 - N)` ('default =' `restore limit from datacenter or storage config`)::
156 Override I/O bandwidth limit (in KiB/s).
158 `--cdrom` `<volume>` ::
160 This is an alias for option -ide2
162 `--cicustom` `[meta=<volume>] [,network=<volume>] [,user=<volume>] [,vendor=<volume>]` ::
164 cloud-init: Specify custom files to replace the automatically generated ones at start.
166 `--cipassword` `<password>` ::
168 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.
170 `--citype` `<configdrive2 | nocloud | opennebula>` ::
172 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.
174 `--ciuser` `<string>` ::
176 cloud-init: User name to change ssh keys and password for instead of the image's configured default user.
178 `--cores` `<integer> (1 - N)` ('default =' `1`)::
180 The number of cores per socket.
182 `--cpu` `[[cputype=]<string>] [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=<vendor-id>] [,phys-bits=<8-64|host>] [,reported-model=<enum>]` ::
186 `--cpulimit` `<number> (0 - 128)` ('default =' `0`)::
190 `--cpuunits` `<integer> (2 - 262144)` ('default =' `cgroup v1: 1024, cgroup v2: 100`)::
192 CPU weight for a VM, will be clamped to [1, 10000] in cgroup v2.
194 `--description` `<string>` ::
196 Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file.
198 `--efidisk0` `[file=]<volume> [,efitype=<2m|4m>] [,format=<enum>] [,pre-enrolled-keys=<1|0>] [,size=<DiskSize>]` ::
200 Configure a Disk for storing EFI vars. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead.
202 `--force` `<boolean>` ::
204 Allow to overwrite existing VM.
206 NOTE: Requires option(s): `archive`
208 `--freeze` `<boolean>` ::
210 Freeze CPU at startup (use 'c' monitor command to start execution).
212 `--hookscript` `<string>` ::
214 Script that will be executed during various steps in the vms lifetime.
216 `--hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,legacy-igd=<1|0>] [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
218 Map host PCI devices into guest.
220 `--hotplug` `<string>` ('default =' `network,disk,usb`)::
222 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. Using '1' as value is an alias for the default `network,disk,usb`.
224 `--hugepages` `<1024 | 2 | any>` ::
226 Enable/disable hugepages memory.
228 `--ide[n]` `[file=]<volume> [,aio=<native|threads|io_uring>] [,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>]` ::
230 Use volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
232 `--ipconfig[n]` `[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]` ::
234 cloud-init: Specify IP addresses and gateways for the corresponding interface.
236 IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.
238 The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit
239 gateway should be provided.
240 For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires
241 cloud-init 19.4 or newer.
243 If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using
246 `--ivshmem` `size=<integer> [,name=<string>]` ::
248 Inter-VM shared memory. Useful for direct communication between VMs, or to the host.
250 `--keephugepages` `<boolean>` ('default =' `0`)::
252 Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts.
254 `--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>` ::
256 Keyboard layout for VNC server. The default is read from the'/etc/pve/datacenter.cfg' configuration file. It should not be necessary to set it.
258 `--kvm` `<boolean>` ('default =' `1`)::
260 Enable/disable KVM hardware virtualization.
262 `--live-restore` `<boolean>` ::
264 Start the VM immediately from the backup and restore in background. PBS only.
266 NOTE: Requires option(s): `archive`
268 `--localtime` `<boolean>` ::
270 Set the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS.
272 `--lock` `<backup | clone | create | migrate | rollback | snapshot | snapshot-delete | suspended | suspending>` ::
276 `--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` ::
278 Specifies the Qemu machine type.
280 `--memory` `<integer> (16 - N)` ('default =' `512`)::
282 Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
284 `--migrate_downtime` `<number> (0 - N)` ('default =' `0.1`)::
286 Set maximum tolerated downtime (in seconds) for migrations.
288 `--migrate_speed` `<integer> (0 - N)` ('default =' `0`)::
290 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
292 `--name` `<string>` ::
294 Set a name for the VM. Only used on the configuration web interface.
296 `--nameserver` `<string>` ::
298 cloud-init: Sets DNS server IP address for a container. Create will'
299 .' automatically use the setting from the host if neither searchdomain nor nameserver'
302 `--net[n]` `[model=]<enum> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,mtu=<integer>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]` ::
304 Specify network devices.
306 `--numa` `<boolean>` ('default =' `0`)::
310 `--numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
314 `--onboot` `<boolean>` ('default =' `0`)::
316 Specifies whether a VM will be started during system bootup.
318 `--ostype` `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win11 | win7 | win8 | wvista | wxp>` ::
320 Specify guest operating system.
322 `--parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` ::
324 Map host parallel devices (n is 0 to 2).
326 `--pool` `<string>` ::
328 Add the VM to the specified pool.
330 `--protection` `<boolean>` ('default =' `0`)::
332 Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
334 `--reboot` `<boolean>` ('default =' `1`)::
336 Allow reboot. If set to '0' the VM exit on reboot.
338 `--rng0` `[source=]</dev/urandom|/dev/random|/dev/hwrng> [,max_bytes=<integer>] [,period=<integer>]` ::
340 Configure a VirtIO-based Random Number Generator.
342 `--sata[n]` `[file=]<volume> [,aio=<native|threads|io_uring>] [,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>]` ::
344 Use volume as SATA hard disk or CD-ROM (n is 0 to 5). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
346 `--scsi[n]` `[file=]<volume> [,aio=<native|threads|io_uring>] [,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>] [,ro=<1|0>] [,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>]` ::
348 Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
350 `--scsihw` `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
352 SCSI controller model
354 `--searchdomain` `<string>` ::
356 cloud-init: Sets DNS search domains for a container. Create will'
357 .' automatically use the setting from the host if neither searchdomain nor nameserver'
360 `--serial[n]` `(/dev/.+|socket)` ::
362 Create a serial device inside the VM (n is 0 to 3)
364 `--shares` `<integer> (0 - 50000)` ('default =' `1000`)::
366 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.
368 `--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>]` ::
370 Specify SMBIOS type 1 fields.
372 `--smp` `<integer> (1 - N)` ('default =' `1`)::
374 The number of CPUs. Please use option -sockets instead.
376 `--sockets` `<integer> (1 - N)` ('default =' `1`)::
378 The number of CPU sockets.
380 `--spice_enhancements` `[foldersharing=<1|0>] [,videostreaming=<off|all|filter>]` ::
382 Configure additional enhancements for SPICE.
384 `--sshkeys` `<filepath>` ::
386 cloud-init: Setup public SSH keys (one key per line, OpenSSH format).
388 `--start` `<boolean>` ('default =' `0`)::
390 Start VM after it was created successfully.
392 `--startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
394 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'.
396 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
398 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.
400 `--storage` `<string>` ::
404 `--tablet` `<boolean>` ('default =' `1`)::
406 Enable/disable the USB tablet device.
408 `--tags` `<string>` ::
410 Tags of the VM. This is only meta information.
412 `--tdf` `<boolean>` ('default =' `0`)::
414 Enable/disable time drift fix.
416 `--template` `<boolean>` ('default =' `0`)::
418 Enable/disable Template.
420 `--tpmstate0` `[file=]<volume> [,size=<DiskSize>] [,version=<v1.2|v2.0>]` ::
422 Configure a Disk for storing TPM state. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default size of 4 MiB will always be used instead. The format is also fixed to 'raw'.
424 `--unique` `<boolean>` ::
426 Assign a unique random ethernet address.
428 NOTE: Requires option(s): `archive`
430 `--unused[n]` `[file=]<volume>` ::
432 Reference to unused volumes. This is used internally, and should not be modified manually.
434 `--usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
436 Configure an USB device (n is 0 to 4).
438 `--vcpus` `<integer> (1 - N)` ('default =' `0`)::
440 Number of hotplugged vcpus.
442 `--vga` `[[type=]<enum>] [,memory=<integer>]` ::
444 Configure the VGA hardware.
446 `--virtio[n]` `[file=]<volume> [,aio=<native|threads|io_uring>] [,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>] [,ro=<1|0>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
448 Use volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
450 `--vmgenid` `<UUID>` ('default =' `1 (autogenerated)`)::
452 Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly.
454 `--vmstatestorage` `<string>` ::
456 Default storage for VM state volumes/files.
458 `--watchdog` `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::
460 Create a virtual hardware watchdog device.
462 *qm delsnapshot* `<vmid> <snapname>` `[OPTIONS]`
464 Delete a VM snapshot.
466 `<vmid>`: `<integer> (1 - N)` ::
468 The (unique) ID of the VM.
470 `<snapname>`: `<string>` ::
472 The name of the snapshot.
474 `--force` `<boolean>` ::
476 For removal from config file, even if removing disk snapshots fails.
478 *qm destroy* `<vmid>` `[OPTIONS]`
480 Destroy the VM and all used/owned volumes. Removes any VM specific
481 permissions and firewall rules
483 `<vmid>`: `<integer> (1 - N)` ::
485 The (unique) ID of the VM.
487 `--destroy-unreferenced-disks` `<boolean>` ('default =' `0`)::
489 If set, destroy additionally all disks not referenced in the config but with a matching VMID from all enabled storages.
491 `--purge` `<boolean>` ::
493 Remove VMID from configurations, like backup & replication jobs and HA.
495 `--skiplock` `<boolean>` ::
497 Ignore locks - only root is allowed to use this option.
499 *qm guest cmd* `<vmid> <command>`
501 Execute Qemu Guest Agent commands.
503 `<vmid>`: `<integer> (1 - N)` ::
505 The (unique) ID of the VM.
507 `<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>` ::
511 *qm guest exec* `<vmid> [<extra-args>]` `[OPTIONS]`
513 Executes the given command via the guest agent
515 `<vmid>`: `<integer> (1 - N)` ::
517 The (unique) ID of the VM.
519 `<extra-args>`: `<array>` ::
521 Extra arguments as array
523 `--pass-stdin` `<boolean>` ('default =' `0`)::
525 When set, read STDIN until EOF and forward to guest agent via 'input-data' (usually treated as STDIN to process launched by guest agent). Allows maximal 1 MiB.
527 `--synchronous` `<boolean>` ('default =' `1`)::
529 If set to off, returns the pid immediately instead of waiting for the commmand to finish or the timeout.
531 `--timeout` `<integer> (0 - N)` ('default =' `30`)::
533 The maximum time to wait synchronously for the command to finish. If reached, the pid gets returned. Set to 0 to deactivate
535 *qm guest exec-status* `<vmid> <pid>`
537 Gets the status of the given pid started by the guest-agent
539 `<vmid>`: `<integer> (1 - N)` ::
541 The (unique) ID of the VM.
543 `<pid>`: `<integer>` ::
547 *qm guest passwd* `<vmid> <username>` `[OPTIONS]`
549 Sets the password for the given user to the given password
551 `<vmid>`: `<integer> (1 - N)` ::
553 The (unique) ID of the VM.
555 `<username>`: `<string>` ::
557 The user to set the password for.
559 `--crypted` `<boolean>` ('default =' `0`)::
561 set to 1 if the password has already been passed through crypt()
563 *qm help* `[OPTIONS]`
565 Get help about specified command.
567 `--extra-args` `<array>` ::
569 Shows help for a specific command
571 `--verbose` `<boolean>` ::
573 Verbose output format.
575 *qm importdisk* `<vmid> <source> <storage>` `[OPTIONS]`
577 Import an external disk image as an unused disk in a VM. The
578 image format has to be supported by qemu-img(1).
580 `<vmid>`: `<integer> (1 - N)` ::
582 The (unique) ID of the VM.
584 `<source>`: `<string>` ::
586 Path to the disk image to import
588 `<storage>`: `<string>` ::
592 `--format` `<qcow2 | raw | vmdk>` ::
596 *qm importovf* `<vmid> <manifest> <storage>` `[OPTIONS]`
598 Create a new VM using parameters read from an OVF manifest
600 `<vmid>`: `<integer> (1 - N)` ::
602 The (unique) ID of the VM.
604 `<manifest>`: `<string>` ::
608 `<storage>`: `<string>` ::
612 `--dryrun` `<boolean>` ::
614 Print a parsed representation of the extracted OVF parameters, but do not create a VM
616 `--format` `<qcow2 | raw | vmdk>` ::
620 *qm list* `[OPTIONS]`
622 Virtual machine index (per node).
624 `--full` `<boolean>` ::
626 Determine the full status of active VMs.
628 *qm listsnapshot* `<vmid>`
632 `<vmid>`: `<integer> (1 - N)` ::
634 The (unique) ID of the VM.
636 *qm migrate* `<vmid> <target>` `[OPTIONS]`
638 Migrate virtual machine. Creates a new migration task.
640 `<vmid>`: `<integer> (1 - N)` ::
642 The (unique) ID of the VM.
644 `<target>`: `<string>` ::
648 `--bwlimit` `<integer> (0 - N)` ('default =' `migrate limit from datacenter or storage config`)::
650 Override I/O bandwidth limit (in KiB/s).
652 `--force` `<boolean>` ::
654 Allow to migrate VMs which use local devices. Only root may use this option.
656 `--migration_network` `<string>` ::
658 CIDR of the (sub) network that is used for migration.
660 `--migration_type` `<insecure | secure>` ::
662 Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.
664 `--online` `<boolean>` ::
666 Use online/live migration if VM is running. Ignored if VM is stopped.
668 `--targetstorage` `<string>` ::
670 Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself.
672 `--with-local-disks` `<boolean>` ::
674 Enable live storage migration for local disk
676 *qm monitor* `<vmid>`
678 Enter Qemu Monitor interface.
680 `<vmid>`: `<integer> (1 - N)` ::
682 The (unique) ID of the VM.
684 *qm move-disk* `<vmid> <disk> [<storage>]` `[OPTIONS]`
686 Move volume to different storage or to a different VM.
688 `<vmid>`: `<integer> (1 - N)` ::
690 The (unique) ID of the VM.
692 `<disk>`: `<efidisk0 | ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi14 | scsi15 | scsi16 | scsi17 | scsi18 | scsi19 | scsi2 | scsi20 | scsi21 | scsi22 | scsi23 | scsi24 | scsi25 | scsi26 | scsi27 | scsi28 | scsi29 | scsi3 | scsi30 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | tpmstate0 | unused0 | unused1 | unused10 | unused100 | unused101 | unused102 | unused103 | unused104 | unused105 | unused106 | unused107 | unused108 | unused109 | unused11 | unused110 | unused111 | unused112 | unused113 | unused114 | unused115 | unused116 | unused117 | unused118 | unused119 | unused12 | unused120 | unused121 | unused122 | unused123 | unused124 | unused125 | unused126 | unused127 | unused128 | unused129 | unused13 | unused130 | unused131 | unused132 | unused133 | unused134 | unused135 | unused136 | unused137 | unused138 | unused139 | unused14 | unused140 | unused141 | unused142 | unused143 | unused144 | unused145 | unused146 | unused147 | unused148 | unused149 | unused15 | unused150 | unused151 | unused152 | unused153 | unused154 | unused155 | unused156 | unused157 | unused158 | unused159 | unused16 | unused160 | unused161 | unused162 | unused163 | unused164 | unused165 | unused166 | unused167 | unused168 | unused169 | unused17 | unused170 | unused171 | unused172 | unused173 | unused174 | unused175 | unused176 | unused177 | unused178 | unused179 | unused18 | unused180 | unused181 | unused182 | unused183 | unused184 | unused185 | unused186 | unused187 | unused188 | unused189 | unused19 | unused190 | unused191 | unused192 | unused193 | unused194 | unused195 | unused196 | unused197 | unused198 | unused199 | unused2 | unused20 | unused200 | unused201 | unused202 | unused203 | unused204 | unused205 | unused206 | unused207 | unused208 | unused209 | unused21 | unused210 | unused211 | unused212 | unused213 | unused214 | unused215 | unused216 | unused217 | unused218 | unused219 | unused22 | unused220 | unused221 | unused222 | unused223 | unused224 | unused225 | unused226 | unused227 | unused228 | unused229 | unused23 | unused230 | unused231 | unused232 | unused233 | unused234 | unused235 | unused236 | unused237 | unused238 | unused239 | unused24 | unused240 | unused241 | unused242 | unused243 | unused244 | unused245 | unused246 | unused247 | unused248 | unused249 | unused25 | unused250 | unused251 | unused252 | unused253 | unused254 | unused255 | unused26 | unused27 | unused28 | unused29 | unused3 | unused30 | unused31 | unused32 | unused33 | unused34 | unused35 | unused36 | unused37 | unused38 | unused39 | unused4 | unused40 | unused41 | unused42 | unused43 | unused44 | unused45 | unused46 | unused47 | unused48 | unused49 | unused5 | unused50 | unused51 | unused52 | unused53 | unused54 | unused55 | unused56 | unused57 | unused58 | unused59 | unused6 | unused60 | unused61 | unused62 | unused63 | unused64 | unused65 | unused66 | unused67 | unused68 | unused69 | unused7 | unused70 | unused71 | unused72 | unused73 | unused74 | unused75 | unused76 | unused77 | unused78 | unused79 | unused8 | unused80 | unused81 | unused82 | unused83 | unused84 | unused85 | unused86 | unused87 | unused88 | unused89 | unused9 | unused90 | unused91 | unused92 | unused93 | unused94 | unused95 | unused96 | unused97 | unused98 | unused99 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9>` ::
694 The disk you want to move.
696 `<storage>`: `<string>` ::
700 `--bwlimit` `<integer> (0 - N)` ('default =' `move limit from datacenter or storage config`)::
702 Override I/O bandwidth limit (in KiB/s).
704 `--delete` `<boolean>` ('default =' `0`)::
706 Delete the original disk after successful copy. By default the original disk is kept as unused disk.
708 `--digest` `<string>` ::
710 Prevent changes if current configuration file has different SHA1"
711 ." digest. This can be used to prevent concurrent modifications.
713 `--format` `<qcow2 | raw | vmdk>` ::
717 `--target-digest` `<string>` ::
719 Prevent changes if the current config file of the target VM has a"
720 ." different SHA1 digest. This can be used to detect concurrent modifications.
722 `--target-disk` `<efidisk0 | ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi14 | scsi15 | scsi16 | scsi17 | scsi18 | scsi19 | scsi2 | scsi20 | scsi21 | scsi22 | scsi23 | scsi24 | scsi25 | scsi26 | scsi27 | scsi28 | scsi29 | scsi3 | scsi30 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | tpmstate0 | unused0 | unused1 | unused10 | unused100 | unused101 | unused102 | unused103 | unused104 | unused105 | unused106 | unused107 | unused108 | unused109 | unused11 | unused110 | unused111 | unused112 | unused113 | unused114 | unused115 | unused116 | unused117 | unused118 | unused119 | unused12 | unused120 | unused121 | unused122 | unused123 | unused124 | unused125 | unused126 | unused127 | unused128 | unused129 | unused13 | unused130 | unused131 | unused132 | unused133 | unused134 | unused135 | unused136 | unused137 | unused138 | unused139 | unused14 | unused140 | unused141 | unused142 | unused143 | unused144 | unused145 | unused146 | unused147 | unused148 | unused149 | unused15 | unused150 | unused151 | unused152 | unused153 | unused154 | unused155 | unused156 | unused157 | unused158 | unused159 | unused16 | unused160 | unused161 | unused162 | unused163 | unused164 | unused165 | unused166 | unused167 | unused168 | unused169 | unused17 | unused170 | unused171 | unused172 | unused173 | unused174 | unused175 | unused176 | unused177 | unused178 | unused179 | unused18 | unused180 | unused181 | unused182 | unused183 | unused184 | unused185 | unused186 | unused187 | unused188 | unused189 | unused19 | unused190 | unused191 | unused192 | unused193 | unused194 | unused195 | unused196 | unused197 | unused198 | unused199 | unused2 | unused20 | unused200 | unused201 | unused202 | unused203 | unused204 | unused205 | unused206 | unused207 | unused208 | unused209 | unused21 | unused210 | unused211 | unused212 | unused213 | unused214 | unused215 | unused216 | unused217 | unused218 | unused219 | unused22 | unused220 | unused221 | unused222 | unused223 | unused224 | unused225 | unused226 | unused227 | unused228 | unused229 | unused23 | unused230 | unused231 | unused232 | unused233 | unused234 | unused235 | unused236 | unused237 | unused238 | unused239 | unused24 | unused240 | unused241 | unused242 | unused243 | unused244 | unused245 | unused246 | unused247 | unused248 | unused249 | unused25 | unused250 | unused251 | unused252 | unused253 | unused254 | unused255 | unused26 | unused27 | unused28 | unused29 | unused3 | unused30 | unused31 | unused32 | unused33 | unused34 | unused35 | unused36 | unused37 | unused38 | unused39 | unused4 | unused40 | unused41 | unused42 | unused43 | unused44 | unused45 | unused46 | unused47 | unused48 | unused49 | unused5 | unused50 | unused51 | unused52 | unused53 | unused54 | unused55 | unused56 | unused57 | unused58 | unused59 | unused6 | unused60 | unused61 | unused62 | unused63 | unused64 | unused65 | unused66 | unused67 | unused68 | unused69 | unused7 | unused70 | unused71 | unused72 | unused73 | unused74 | unused75 | unused76 | unused77 | unused78 | unused79 | unused8 | unused80 | unused81 | unused82 | unused83 | unused84 | unused85 | unused86 | unused87 | unused88 | unused89 | unused9 | unused90 | unused91 | unused92 | unused93 | unused94 | unused95 | unused96 | unused97 | unused98 | unused99 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9>` ::
724 The config key the disk will be moved to on the target VM (for example, ide0 or scsi1). Default is the source disk key.
726 `--target-vmid` `<integer> (1 - N)` ::
728 The (unique) ID of the VM.
732 An alias for 'qm move-disk'.
736 Used by qmigrate - do not use manually.
738 *qm nbdstop* `<vmid>`
740 Stop embedded nbd server.
742 `<vmid>`: `<integer> (1 - N)` ::
744 The (unique) ID of the VM.
746 *qm pending* `<vmid>`
748 Get the virtual machine configuration with both current and pending values.
750 `<vmid>`: `<integer> (1 - N)` ::
752 The (unique) ID of the VM.
754 *qm reboot* `<vmid>` `[OPTIONS]`
756 Reboot the VM by shutting it down, and starting it again. Applies pending
759 `<vmid>`: `<integer> (1 - N)` ::
761 The (unique) ID of the VM.
763 `--timeout` `<integer> (0 - N)` ::
765 Wait maximal timeout seconds for the shutdown.
767 *qm rescan* `[OPTIONS]`
769 Rescan all storages and update disk sizes and unused disk images.
771 `--dryrun` `<boolean>` ('default =' `0`)::
773 Do not actually write changes out to VM config(s).
775 `--vmid` `<integer> (1 - N)` ::
777 The (unique) ID of the VM.
779 *qm reset* `<vmid>` `[OPTIONS]`
781 Reset virtual machine.
783 `<vmid>`: `<integer> (1 - N)` ::
785 The (unique) ID of the VM.
787 `--skiplock` `<boolean>` ::
789 Ignore locks - only root is allowed to use this option.
791 *qm resize* `<vmid> <disk> <size>` `[OPTIONS]`
795 `<vmid>`: `<integer> (1 - N)` ::
797 The (unique) ID of the VM.
799 `<disk>`: `<efidisk0 | ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi14 | scsi15 | scsi16 | scsi17 | scsi18 | scsi19 | scsi2 | scsi20 | scsi21 | scsi22 | scsi23 | scsi24 | scsi25 | scsi26 | scsi27 | scsi28 | scsi29 | scsi3 | scsi30 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | tpmstate0 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9>` ::
801 The disk you want to resize.
803 `<size>`: `\+?\d+(\.\d+)?[KMGT]?` ::
805 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.
807 `--digest` `<string>` ::
809 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
811 `--skiplock` `<boolean>` ::
813 Ignore locks - only root is allowed to use this option.
815 *qm resume* `<vmid>` `[OPTIONS]`
817 Resume virtual machine.
819 `<vmid>`: `<integer> (1 - N)` ::
821 The (unique) ID of the VM.
823 `--nocheck` `<boolean>` ::
825 no description available
827 `--skiplock` `<boolean>` ::
829 Ignore locks - only root is allowed to use this option.
831 *qm rollback* `<vmid> <snapname>`
833 Rollback VM state to specified snapshot.
835 `<vmid>`: `<integer> (1 - N)` ::
837 The (unique) ID of the VM.
839 `<snapname>`: `<string>` ::
841 The name of the snapshot.
843 *qm sendkey* `<vmid> <key>` `[OPTIONS]`
845 Send key event to virtual machine.
847 `<vmid>`: `<integer> (1 - N)` ::
849 The (unique) ID of the VM.
851 `<key>`: `<string>` ::
853 The key (qemu monitor encoding).
855 `--skiplock` `<boolean>` ::
857 Ignore locks - only root is allowed to use this option.
859 *qm set* `<vmid>` `[OPTIONS]`
861 Set virtual machine options (synchrounous API) - You should consider using
862 the POST method instead for any actions involving hotplug or storage
865 `<vmid>`: `<integer> (1 - N)` ::
867 The (unique) ID of the VM.
869 `--acpi` `<boolean>` ('default =' `1`)::
873 `--agent` `[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>] [,type=<virtio|isa>]` ::
875 Enable/disable communication with the Qemu Guest Agent and its properties.
877 `--arch` `<aarch64 | x86_64>` ::
879 Virtual processor architecture. Defaults to the host.
881 `--args` `<string>` ::
883 Arbitrary arguments passed to kvm.
885 `--audio0` `device=<ich9-intel-hda|intel-hda|AC97> [,driver=<spice|none>]` ::
887 Configure a audio device, useful in combination with QXL/Spice.
889 `--autostart` `<boolean>` ('default =' `0`)::
891 Automatic restart after crash (currently ignored).
893 `--balloon` `<integer> (0 - N)` ::
895 Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
897 `--bios` `<ovmf | seabios>` ('default =' `seabios`)::
899 Select BIOS implementation.
901 `--boot` `[[legacy=]<[acdn]{1,4}>] [,order=<device[;device...]>]` ::
903 Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated.
905 `--bootdisk` `(ide|sata|scsi|virtio)\d+` ::
907 Enable booting from specified disk. Deprecated: Use 'boot: order=foo;bar' instead.
909 `--cdrom` `<volume>` ::
911 This is an alias for option -ide2
913 `--cicustom` `[meta=<volume>] [,network=<volume>] [,user=<volume>] [,vendor=<volume>]` ::
915 cloud-init: Specify custom files to replace the automatically generated ones at start.
917 `--cipassword` `<password>` ::
919 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.
921 `--citype` `<configdrive2 | nocloud | opennebula>` ::
923 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.
925 `--ciuser` `<string>` ::
927 cloud-init: User name to change ssh keys and password for instead of the image's configured default user.
929 `--cores` `<integer> (1 - N)` ('default =' `1`)::
931 The number of cores per socket.
933 `--cpu` `[[cputype=]<string>] [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=<vendor-id>] [,phys-bits=<8-64|host>] [,reported-model=<enum>]` ::
937 `--cpulimit` `<number> (0 - 128)` ('default =' `0`)::
941 `--cpuunits` `<integer> (2 - 262144)` ('default =' `cgroup v1: 1024, cgroup v2: 100`)::
943 CPU weight for a VM, will be clamped to [1, 10000] in cgroup v2.
945 `--delete` `<string>` ::
947 A list of settings you want to delete.
949 `--description` `<string>` ::
951 Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file.
953 `--digest` `<string>` ::
955 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
957 `--efidisk0` `[file=]<volume> [,efitype=<2m|4m>] [,format=<enum>] [,pre-enrolled-keys=<1|0>] [,size=<DiskSize>]` ::
959 Configure a Disk for storing EFI vars. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead.
961 `--force` `<boolean>` ::
963 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.
965 NOTE: Requires option(s): `delete`
967 `--freeze` `<boolean>` ::
969 Freeze CPU at startup (use 'c' monitor command to start execution).
971 `--hookscript` `<string>` ::
973 Script that will be executed during various steps in the vms lifetime.
975 `--hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,legacy-igd=<1|0>] [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
977 Map host PCI devices into guest.
979 `--hotplug` `<string>` ('default =' `network,disk,usb`)::
981 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. Using '1' as value is an alias for the default `network,disk,usb`.
983 `--hugepages` `<1024 | 2 | any>` ::
985 Enable/disable hugepages memory.
987 `--ide[n]` `[file=]<volume> [,aio=<native|threads|io_uring>] [,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>]` ::
989 Use volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
991 `--ipconfig[n]` `[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]` ::
993 cloud-init: Specify IP addresses and gateways for the corresponding interface.
995 IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.
997 The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit
998 gateway should be provided.
999 For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires
1000 cloud-init 19.4 or newer.
1002 If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using
1005 `--ivshmem` `size=<integer> [,name=<string>]` ::
1007 Inter-VM shared memory. Useful for direct communication between VMs, or to the host.
1009 `--keephugepages` `<boolean>` ('default =' `0`)::
1011 Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts.
1013 `--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>` ::
1015 Keyboard layout for VNC server. The default is read from the'/etc/pve/datacenter.cfg' configuration file. It should not be necessary to set it.
1017 `--kvm` `<boolean>` ('default =' `1`)::
1019 Enable/disable KVM hardware virtualization.
1021 `--localtime` `<boolean>` ::
1023 Set the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS.
1025 `--lock` `<backup | clone | create | migrate | rollback | snapshot | snapshot-delete | suspended | suspending>` ::
1029 `--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` ::
1031 Specifies the Qemu machine type.
1033 `--memory` `<integer> (16 - N)` ('default =' `512`)::
1035 Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
1037 `--migrate_downtime` `<number> (0 - N)` ('default =' `0.1`)::
1039 Set maximum tolerated downtime (in seconds) for migrations.
1041 `--migrate_speed` `<integer> (0 - N)` ('default =' `0`)::
1043 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
1045 `--name` `<string>` ::
1047 Set a name for the VM. Only used on the configuration web interface.
1049 `--nameserver` `<string>` ::
1051 cloud-init: Sets DNS server IP address for a container. Create will'
1052 .' automatically use the setting from the host if neither searchdomain nor nameserver'
1055 `--net[n]` `[model=]<enum> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,mtu=<integer>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]` ::
1057 Specify network devices.
1059 `--numa` `<boolean>` ('default =' `0`)::
1061 Enable/disable NUMA.
1063 `--numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
1067 `--onboot` `<boolean>` ('default =' `0`)::
1069 Specifies whether a VM will be started during system bootup.
1071 `--ostype` `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win11 | win7 | win8 | wvista | wxp>` ::
1073 Specify guest operating system.
1075 `--parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` ::
1077 Map host parallel devices (n is 0 to 2).
1079 `--protection` `<boolean>` ('default =' `0`)::
1081 Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
1083 `--reboot` `<boolean>` ('default =' `1`)::
1085 Allow reboot. If set to '0' the VM exit on reboot.
1087 `--revert` `<string>` ::
1089 Revert a pending change.
1091 `--rng0` `[source=]</dev/urandom|/dev/random|/dev/hwrng> [,max_bytes=<integer>] [,period=<integer>]` ::
1093 Configure a VirtIO-based Random Number Generator.
1095 `--sata[n]` `[file=]<volume> [,aio=<native|threads|io_uring>] [,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>]` ::
1097 Use volume as SATA hard disk or CD-ROM (n is 0 to 5). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
1099 `--scsi[n]` `[file=]<volume> [,aio=<native|threads|io_uring>] [,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>] [,ro=<1|0>] [,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>]` ::
1101 Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
1103 `--scsihw` `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
1105 SCSI controller model
1107 `--searchdomain` `<string>` ::
1109 cloud-init: Sets DNS search domains for a container. Create will'
1110 .' automatically use the setting from the host if neither searchdomain nor nameserver'
1113 `--serial[n]` `(/dev/.+|socket)` ::
1115 Create a serial device inside the VM (n is 0 to 3)
1117 `--shares` `<integer> (0 - 50000)` ('default =' `1000`)::
1119 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.
1121 `--skiplock` `<boolean>` ::
1123 Ignore locks - only root is allowed to use this option.
1125 `--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>]` ::
1127 Specify SMBIOS type 1 fields.
1129 `--smp` `<integer> (1 - N)` ('default =' `1`)::
1131 The number of CPUs. Please use option -sockets instead.
1133 `--sockets` `<integer> (1 - N)` ('default =' `1`)::
1135 The number of CPU sockets.
1137 `--spice_enhancements` `[foldersharing=<1|0>] [,videostreaming=<off|all|filter>]` ::
1139 Configure additional enhancements for SPICE.
1141 `--sshkeys` `<filepath>` ::
1143 cloud-init: Setup public SSH keys (one key per line, OpenSSH format).
1145 `--startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
1147 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'.
1149 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
1151 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.
1153 `--tablet` `<boolean>` ('default =' `1`)::
1155 Enable/disable the USB tablet device.
1157 `--tags` `<string>` ::
1159 Tags of the VM. This is only meta information.
1161 `--tdf` `<boolean>` ('default =' `0`)::
1163 Enable/disable time drift fix.
1165 `--template` `<boolean>` ('default =' `0`)::
1167 Enable/disable Template.
1169 `--tpmstate0` `[file=]<volume> [,size=<DiskSize>] [,version=<v1.2|v2.0>]` ::
1171 Configure a Disk for storing TPM state. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default size of 4 MiB will always be used instead. The format is also fixed to 'raw'.
1173 `--unused[n]` `[file=]<volume>` ::
1175 Reference to unused volumes. This is used internally, and should not be modified manually.
1177 `--usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
1179 Configure an USB device (n is 0 to 4).
1181 `--vcpus` `<integer> (1 - N)` ('default =' `0`)::
1183 Number of hotplugged vcpus.
1185 `--vga` `[[type=]<enum>] [,memory=<integer>]` ::
1187 Configure the VGA hardware.
1189 `--virtio[n]` `[file=]<volume> [,aio=<native|threads|io_uring>] [,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>] [,ro=<1|0>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
1191 Use volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
1193 `--vmgenid` `<UUID>` ('default =' `1 (autogenerated)`)::
1195 Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly.
1197 `--vmstatestorage` `<string>` ::
1199 Default storage for VM state volumes/files.
1201 `--watchdog` `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::
1203 Create a virtual hardware watchdog device.
1205 *qm showcmd* `<vmid>` `[OPTIONS]`
1207 Show command line which is used to start the VM (debug info).
1209 `<vmid>`: `<integer> (1 - N)` ::
1211 The (unique) ID of the VM.
1213 `--pretty` `<boolean>` ('default =' `0`)::
1215 Puts each option on a new line to enhance human readability
1217 `--snapshot` `<string>` ::
1219 Fetch config values from given snapshot.
1221 *qm shutdown* `<vmid>` `[OPTIONS]`
1223 Shutdown virtual machine. This is similar to pressing the power button on a
1224 physical machine.This will send an ACPI event for the guest OS, which
1225 should then proceed to a clean shutdown.
1227 `<vmid>`: `<integer> (1 - N)` ::
1229 The (unique) ID of the VM.
1231 `--forceStop` `<boolean>` ('default =' `0`)::
1233 Make sure the VM stops.
1235 `--keepActive` `<boolean>` ('default =' `0`)::
1237 Do not deactivate storage volumes.
1239 `--skiplock` `<boolean>` ::
1241 Ignore locks - only root is allowed to use this option.
1243 `--timeout` `<integer> (0 - N)` ::
1245 Wait maximal timeout seconds.
1247 *qm snapshot* `<vmid> <snapname>` `[OPTIONS]`
1251 `<vmid>`: `<integer> (1 - N)` ::
1253 The (unique) ID of the VM.
1255 `<snapname>`: `<string>` ::
1257 The name of the snapshot.
1259 `--description` `<string>` ::
1261 A textual description or comment.
1263 `--vmstate` `<boolean>` ::
1267 *qm start* `<vmid>` `[OPTIONS]`
1269 Start virtual machine.
1271 `<vmid>`: `<integer> (1 - N)` ::
1273 The (unique) ID of the VM.
1275 `--force-cpu` `<string>` ::
1277 Override QEMU's -cpu argument with the given string.
1279 `--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` ::
1281 Specifies the Qemu machine type.
1283 `--migratedfrom` `<string>` ::
1285 The cluster node name.
1287 `--migration_network` `<string>` ::
1289 CIDR of the (sub) network that is used for migration.
1291 `--migration_type` `<insecure | secure>` ::
1293 Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.
1295 `--skiplock` `<boolean>` ::
1297 Ignore locks - only root is allowed to use this option.
1299 `--stateuri` `<string>` ::
1301 Some command save/restore state from this location.
1303 `--targetstorage` `<string>` ::
1305 Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself.
1307 `--timeout` `<integer> (0 - N)` ('default =' `max(30, vm memory in GiB)`)::
1309 Wait maximal timeout seconds.
1311 *qm status* `<vmid>` `[OPTIONS]`
1315 `<vmid>`: `<integer> (1 - N)` ::
1317 The (unique) ID of the VM.
1319 `--verbose` `<boolean>` ::
1321 Verbose output format
1323 *qm stop* `<vmid>` `[OPTIONS]`
1325 Stop virtual machine. The qemu process will exit immediately. Thisis akin
1326 to pulling the power plug of a running computer and may damage the VM data
1328 `<vmid>`: `<integer> (1 - N)` ::
1330 The (unique) ID of the VM.
1332 `--keepActive` `<boolean>` ('default =' `0`)::
1334 Do not deactivate storage volumes.
1336 `--migratedfrom` `<string>` ::
1338 The cluster node name.
1340 `--skiplock` `<boolean>` ::
1342 Ignore locks - only root is allowed to use this option.
1344 `--timeout` `<integer> (0 - N)` ::
1346 Wait maximal timeout seconds.
1348 *qm suspend* `<vmid>` `[OPTIONS]`
1350 Suspend virtual machine.
1352 `<vmid>`: `<integer> (1 - N)` ::
1354 The (unique) ID of the VM.
1356 `--skiplock` `<boolean>` ::
1358 Ignore locks - only root is allowed to use this option.
1360 `--statestorage` `<string>` ::
1362 The storage for the VM state
1364 NOTE: Requires option(s): `todisk`
1366 `--todisk` `<boolean>` ('default =' `0`)::
1368 If set, suspends the VM to disk. Will be resumed on next VM start.
1370 *qm template* `<vmid>` `[OPTIONS]`
1374 `<vmid>`: `<integer> (1 - N)` ::
1376 The (unique) ID of the VM.
1378 `--disk` `<efidisk0 | ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi14 | scsi15 | scsi16 | scsi17 | scsi18 | scsi19 | scsi2 | scsi20 | scsi21 | scsi22 | scsi23 | scsi24 | scsi25 | scsi26 | scsi27 | scsi28 | scsi29 | scsi3 | scsi30 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | tpmstate0 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9>` ::
1380 If you want to convert only 1 disk to base image.
1382 *qm terminal* `<vmid>` `[OPTIONS]`
1384 Open a terminal using a serial device (The VM need to have a serial device
1385 configured, for example 'serial0: socket')
1387 `<vmid>`: `<integer> (1 - N)` ::
1389 The (unique) ID of the VM.
1391 `--escape` `<string>` ('default =' `^O`)::
1395 `--iface` `<serial0 | serial1 | serial2 | serial3>` ::
1397 Select the serial device. By default we simply use the first suitable device.
1399 *qm unlink* `<vmid> --idlist <string>` `[OPTIONS]`
1401 Unlink/delete disk images.
1403 `<vmid>`: `<integer> (1 - N)` ::
1405 The (unique) ID of the VM.
1407 `--force` `<boolean>` ::
1409 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.
1411 `--idlist` `<string>` ::
1413 A list of disk IDs you want to delete.
1415 *qm unlock* `<vmid>`
1419 `<vmid>`: `<integer> (1 - N)` ::
1421 The (unique) ID of the VM.
1423 *qm vncproxy* `<vmid>`
1425 Proxy VM VNC traffic to stdin/stdout
1427 `<vmid>`: `<integer> (1 - N)` ::
1429 The (unique) ID of the VM.
1431 *qm wait* `<vmid>` `[OPTIONS]`
1433 Wait until the VM is stopped.
1435 `<vmid>`: `<integer> (1 - N)` ::
1437 The (unique) ID of the VM.
1439 `--timeout` `<integer> (1 - N)` ::
1441 Timeout in seconds. Default is to wait forever.