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 Qemu GuestAgent 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>]` ::
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` `[acdn]{1,4}` ('default =' `cdn`)::
148 Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).
150 `--bootdisk` `(ide|sata|scsi|virtio)\d+` ::
152 Enable booting from specified disk.
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>]` ::
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>` ::
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 =' `1024`)::
194 `--description` `<string>` ::
196 Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.
198 `--efidisk0` `[file=]<volume> [,format=<enum>] [,size=<DiskSize>]` ::
200 Configure a Disk for storing EFI vars
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. Value '1' 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>] [,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).
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 gateway should be provided.
239 For IPv6 the special string 'auto' can be used to use stateless autoconfiguration.
241 If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4.
243 `--ivshmem` `size=<integer> [,name=<string>]` ::
245 Inter-VM shared memory. Useful for direct communication between VMs, or to the host.
247 `--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>` ::
249 Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg' configuration file.It should not be necessary to set it.
251 `--kvm` `<boolean>` ('default =' `1`)::
253 Enable/disable KVM hardware virtualization.
255 `--localtime` `<boolean>` ::
257 Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
259 `--lock` `<backup | clone | create | migrate | rollback | snapshot | snapshot-delete | suspended | suspending>` ::
263 `--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` ::
265 Specifies the Qemu machine type.
267 `--memory` `<integer> (16 - N)` ('default =' `512`)::
269 Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
271 `--migrate_downtime` `<number> (0 - N)` ('default =' `0.1`)::
273 Set maximum tolerated downtime (in seconds) for migrations.
275 `--migrate_speed` `<integer> (0 - N)` ('default =' `0`)::
277 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
279 `--name` `<string>` ::
281 Set a name for the VM. Only used on the configuration web interface.
283 `--nameserver` `<string>` ::
285 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.
287 `--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>]` ::
289 Specify network devices.
291 `--numa` `<boolean>` ('default =' `0`)::
295 `--numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
299 `--onboot` `<boolean>` ('default =' `0`)::
301 Specifies whether a VM will be started during system bootup.
303 `--ostype` `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win7 | win8 | wvista | wxp>` ::
305 Specify guest operating system.
307 `--parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` ::
309 Map host parallel devices (n is 0 to 2).
311 `--pool` `<string>` ::
313 Add the VM to the specified pool.
315 `--protection` `<boolean>` ('default =' `0`)::
317 Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
319 `--reboot` `<boolean>` ('default =' `1`)::
321 Allow reboot. If set to '0' the VM exit on reboot.
323 `--rng0` `[source=]</dev/urandom|/dev/random|/dev/hwrng> [,max_bytes=<integer>] [,period=<integer>]` ::
325 Configure a VirtIO-based Random Number Generator.
327 `--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>]` ::
329 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
331 `--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>]` ::
333 Use volume as SCSI hard disk or CD-ROM (n is 0 to 30).
335 `--scsihw` `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
337 SCSI controller model
339 `--searchdomain` `<string>` ::
341 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.
343 `--serial[n]` `(/dev/.+|socket)` ::
345 Create a serial device inside the VM (n is 0 to 3)
347 `--shares` `<integer> (0 - 50000)` ('default =' `1000`)::
349 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.
351 `--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>]` ::
353 Specify SMBIOS type 1 fields.
355 `--smp` `<integer> (1 - N)` ('default =' `1`)::
357 The number of CPUs. Please use option -sockets instead.
359 `--sockets` `<integer> (1 - N)` ('default =' `1`)::
361 The number of CPU sockets.
363 `--spice_enhancements` `[foldersharing=<1|0>] [,videostreaming=<off|all|filter>]` ::
365 Configure additional enhancements for SPICE.
367 `--sshkeys` `<filepath>` ::
369 cloud-init: Setup public SSH keys (one key per line, OpenSSH format).
371 `--start` `<boolean>` ('default =' `0`)::
373 Start VM after it was created successfully.
375 `--startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
377 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'.
379 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
381 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.
383 `--storage` `<string>` ::
387 `--tablet` `<boolean>` ('default =' `1`)::
389 Enable/disable the USB tablet device.
391 `--tags` `<string>` ::
393 Tags of the VM. This is only meta information.
395 `--tdf` `<boolean>` ('default =' `0`)::
397 Enable/disable time drift fix.
399 `--template` `<boolean>` ('default =' `0`)::
401 Enable/disable Template.
403 `--unique` `<boolean>` ::
405 Assign a unique random ethernet address.
407 NOTE: Requires option(s): `archive`
409 `--unused[n]` `[file=]<volume>` ::
411 Reference to unused volumes. This is used internally, and should not be modified manually.
413 `--usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
415 Configure an USB device (n is 0 to 4).
417 `--vcpus` `<integer> (1 - N)` ('default =' `0`)::
419 Number of hotplugged vcpus.
421 `--vga` `[[type=]<enum>] [,memory=<integer>]` ::
423 Configure the VGA hardware.
425 `--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>]` ::
427 Use volume as VIRTIO hard disk (n is 0 to 15).
429 `--vmgenid` `<UUID>` ('default =' `1 (autogenerated)`)::
431 Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly.
433 `--vmstatestorage` `<string>` ::
435 Default storage for VM state volumes/files.
437 `--watchdog` `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::
439 Create a virtual hardware watchdog device.
441 *qm delsnapshot* `<vmid> <snapname>` `[OPTIONS]`
443 Delete a VM snapshot.
445 `<vmid>`: `<integer> (1 - N)` ::
447 The (unique) ID of the VM.
449 `<snapname>`: `<string>` ::
451 The name of the snapshot.
453 `--force` `<boolean>` ::
455 For removal from config file, even if removing disk snapshots fails.
457 *qm destroy* `<vmid>` `[OPTIONS]`
459 Destroy the vm (also delete all used/owned volumes).
461 `<vmid>`: `<integer> (1 - N)` ::
463 The (unique) ID of the VM.
465 `--purge` `<boolean>` ::
467 Remove vmid from backup cron jobs.
469 `--skiplock` `<boolean>` ::
471 Ignore locks - only root is allowed to use this option.
473 *qm guest cmd* `<vmid> <command>`
475 Execute Qemu Guest Agent commands.
477 `<vmid>`: `<integer> (1 - N)` ::
479 The (unique) ID of the VM.
481 `<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>` ::
485 *qm guest exec* `<vmid> [<extra-args>]` `[OPTIONS]`
487 Executes the given command via the guest agent
489 `<vmid>`: `<integer> (1 - N)` ::
491 The (unique) ID of the VM.
493 `<extra-args>`: `<array>` ::
495 Extra arguments as array
497 `--pass-stdin` `<boolean>` ('default =' `0`)::
499 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.
501 `--synchronous` `<boolean>` ('default =' `1`)::
503 If set to off, returns the pid immediately instead of waiting for the commmand to finish or the timeout.
505 `--timeout` `<integer> (0 - N)` ('default =' `30`)::
507 The maximum time to wait synchronously for the command to finish. If reached, the pid gets returned. Set to 0 to deactivate
509 *qm guest exec-status* `<vmid> <pid>`
511 Gets the status of the given pid started by the guest-agent
513 `<vmid>`: `<integer> (1 - N)` ::
515 The (unique) ID of the VM.
517 `<pid>`: `<integer>` ::
521 *qm guest passwd* `<vmid> <username>` `[OPTIONS]`
523 Sets the password for the given user to the given password
525 `<vmid>`: `<integer> (1 - N)` ::
527 The (unique) ID of the VM.
529 `<username>`: `<string>` ::
531 The user to set the password for.
533 `--crypted` `<boolean>` ('default =' `0`)::
535 set to 1 if the password has already been passed through crypt()
537 *qm help* `[OPTIONS]`
539 Get help about specified command.
541 `--extra-args` `<array>` ::
543 Shows help for a specific command
545 `--verbose` `<boolean>` ::
547 Verbose output format.
549 *qm importdisk* `<vmid> <source> <storage>` `[OPTIONS]`
551 Import an external disk image as an unused disk in a VM. The
552 image format has to be supported by qemu-img(1).
554 `<vmid>`: `<integer> (1 - N)` ::
556 The (unique) ID of the VM.
558 `<source>`: `<string>` ::
560 Path to the disk image to import
562 `<storage>`: `<string>` ::
566 `--format` `<qcow2 | raw | vmdk>` ::
570 *qm importovf* `<vmid> <manifest> <storage>` `[OPTIONS]`
572 Create a new VM using parameters read from an OVF manifest
574 `<vmid>`: `<integer> (1 - N)` ::
576 The (unique) ID of the VM.
578 `<manifest>`: `<string>` ::
582 `<storage>`: `<string>` ::
586 `--dryrun` `<boolean>` ::
588 Print a parsed representation of the extracted OVF parameters, but do not create a VM
590 `--format` `<qcow2 | raw | vmdk>` ::
594 *qm list* `[OPTIONS]`
596 Virtual machine index (per node).
598 `--full` `<boolean>` ::
600 Determine the full status of active VMs.
602 *qm listsnapshot* `<vmid>`
606 `<vmid>`: `<integer> (1 - N)` ::
608 The (unique) ID of the VM.
610 *qm migrate* `<vmid> <target>` `[OPTIONS]`
612 Migrate virtual machine. Creates a new migration task.
614 `<vmid>`: `<integer> (1 - N)` ::
616 The (unique) ID of the VM.
618 `<target>`: `<string>` ::
622 `--bwlimit` `<integer> (0 - N)` ('default =' `migrate limit from datacenter or storage config`)::
624 Override I/O bandwidth limit (in KiB/s).
626 `--force` `<boolean>` ::
628 Allow to migrate VMs which use local devices. Only root may use this option.
630 `--migration_network` `<string>` ::
632 CIDR of the (sub) network that is used for migration.
634 `--migration_type` `<insecure | secure>` ::
636 Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.
638 `--online` `<boolean>` ::
640 Use online/live migration if VM is running. Ignored if VM is stopped.
642 `--targetstorage` `<string>` ::
644 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.
646 `--with-local-disks` `<boolean>` ::
648 Enable live storage migration for local disk
650 *qm monitor* `<vmid>`
652 Enter Qemu Monitor interface.
654 `<vmid>`: `<integer> (1 - N)` ::
656 The (unique) ID of the VM.
658 *qm move_disk* `<vmid> <disk> <storage>` `[OPTIONS]`
660 Move volume to different storage.
662 `<vmid>`: `<integer> (1 - N)` ::
664 The (unique) ID of the VM.
666 `<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 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9>` ::
668 The disk you want to move.
670 `<storage>`: `<string>` ::
674 `--bwlimit` `<integer> (0 - N)` ('default =' `move limit from datacenter or storage config`)::
676 Override I/O bandwidth limit (in KiB/s).
678 `--delete` `<boolean>` ('default =' `0`)::
680 Delete the original disk after successful copy. By default the original disk is kept as unused disk.
682 `--digest` `<string>` ::
684 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
686 `--format` `<qcow2 | raw | vmdk>` ::
692 Used by qmigrate - do not use manually.
694 *qm nbdstop* `<vmid>`
696 Stop embedded nbd server.
698 `<vmid>`: `<integer> (1 - N)` ::
700 The (unique) ID of the VM.
702 *qm pending* `<vmid>`
704 Get the virtual machine configuration with both current and pending values.
706 `<vmid>`: `<integer> (1 - N)` ::
708 The (unique) ID of the VM.
710 *qm reboot* `<vmid>` `[OPTIONS]`
712 Reboot the VM by shutting it down, and starting it again. Applies pending
715 `<vmid>`: `<integer> (1 - N)` ::
717 The (unique) ID of the VM.
719 `--timeout` `<integer> (0 - N)` ::
721 Wait maximal timeout seconds for the shutdown.
723 *qm rescan* `[OPTIONS]`
725 Rescan all storages and update disk sizes and unused disk images.
727 `--dryrun` `<boolean>` ('default =' `0`)::
729 Do not actually write changes out to VM config(s).
731 `--vmid` `<integer> (1 - N)` ::
733 The (unique) ID of the VM.
735 *qm reset* `<vmid>` `[OPTIONS]`
737 Reset virtual machine.
739 `<vmid>`: `<integer> (1 - N)` ::
741 The (unique) ID of the VM.
743 `--skiplock` `<boolean>` ::
745 Ignore locks - only root is allowed to use this option.
747 *qm resize* `<vmid> <disk> <size>` `[OPTIONS]`
751 `<vmid>`: `<integer> (1 - N)` ::
753 The (unique) ID of the VM.
755 `<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 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9>` ::
757 The disk you want to resize.
759 `<size>`: `\+?\d+(\.\d+)?[KMGT]?` ::
761 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.
763 `--digest` `<string>` ::
765 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
767 `--skiplock` `<boolean>` ::
769 Ignore locks - only root is allowed to use this option.
771 *qm resume* `<vmid>` `[OPTIONS]`
773 Resume virtual machine.
775 `<vmid>`: `<integer> (1 - N)` ::
777 The (unique) ID of the VM.
779 `--nocheck` `<boolean>` ::
781 no description available
783 `--skiplock` `<boolean>` ::
785 Ignore locks - only root is allowed to use this option.
787 *qm rollback* `<vmid> <snapname>`
789 Rollback VM state to specified snapshot.
791 `<vmid>`: `<integer> (1 - N)` ::
793 The (unique) ID of the VM.
795 `<snapname>`: `<string>` ::
797 The name of the snapshot.
799 *qm sendkey* `<vmid> <key>` `[OPTIONS]`
801 Send key event to virtual machine.
803 `<vmid>`: `<integer> (1 - N)` ::
805 The (unique) ID of the VM.
807 `<key>`: `<string>` ::
809 The key (qemu monitor encoding).
811 `--skiplock` `<boolean>` ::
813 Ignore locks - only root is allowed to use this option.
815 *qm set* `<vmid>` `[OPTIONS]`
817 Set virtual machine options (synchrounous API) - You should consider using
818 the POST method instead for any actions involving hotplug or storage
821 `<vmid>`: `<integer> (1 - N)` ::
823 The (unique) ID of the VM.
825 `--acpi` `<boolean>` ('default =' `1`)::
829 `--agent` `[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>] [,type=<virtio|isa>]` ::
831 Enable/disable Qemu GuestAgent and its properties.
833 `--arch` `<aarch64 | x86_64>` ::
835 Virtual processor architecture. Defaults to the host.
837 `--args` `<string>` ::
839 Arbitrary arguments passed to kvm.
841 `--audio0` `device=<ich9-intel-hda|intel-hda|AC97> [,driver=<spice>]` ::
843 Configure a audio device, useful in combination with QXL/Spice.
845 `--autostart` `<boolean>` ('default =' `0`)::
847 Automatic restart after crash (currently ignored).
849 `--balloon` `<integer> (0 - N)` ::
851 Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
853 `--bios` `<ovmf | seabios>` ('default =' `seabios`)::
855 Select BIOS implementation.
857 `--boot` `[acdn]{1,4}` ('default =' `cdn`)::
859 Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).
861 `--bootdisk` `(ide|sata|scsi|virtio)\d+` ::
863 Enable booting from specified disk.
865 `--cdrom` `<volume>` ::
867 This is an alias for option -ide2
869 `--cicustom` `[meta=<volume>] [,network=<volume>] [,user=<volume>]` ::
871 cloud-init: Specify custom files to replace the automatically generated ones at start.
873 `--cipassword` `<password>` ::
875 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.
877 `--citype` `<configdrive2 | nocloud>` ::
879 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.
881 `--ciuser` `<string>` ::
883 cloud-init: User name to change ssh keys and password for instead of the image's configured default user.
885 `--cores` `<integer> (1 - N)` ('default =' `1`)::
887 The number of cores per socket.
889 `--cpu` `[[cputype=]<string>] [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=<vendor-id>] [,phys-bits=<8-64|host>] [,reported-model=<enum>]` ::
893 `--cpulimit` `<number> (0 - 128)` ('default =' `0`)::
897 `--cpuunits` `<integer> (2 - 262144)` ('default =' `1024`)::
901 `--delete` `<string>` ::
903 A list of settings you want to delete.
905 `--description` `<string>` ::
907 Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.
909 `--digest` `<string>` ::
911 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
913 `--efidisk0` `[file=]<volume> [,format=<enum>] [,size=<DiskSize>]` ::
915 Configure a Disk for storing EFI vars
917 `--force` `<boolean>` ::
919 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.
921 NOTE: Requires option(s): `delete`
923 `--freeze` `<boolean>` ::
925 Freeze CPU at startup (use 'c' monitor command to start execution).
927 `--hookscript` `<string>` ::
929 Script that will be executed during various steps in the vms lifetime.
931 `--hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,legacy-igd=<1|0>] [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
933 Map host PCI devices into guest.
935 `--hotplug` `<string>` ('default =' `network,disk,usb`)::
937 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'.
939 `--hugepages` `<1024 | 2 | any>` ::
941 Enable/disable hugepages memory.
943 `--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>]` ::
945 Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
947 `--ipconfig[n]` `[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]` ::
949 cloud-init: Specify IP addresses and gateways for the corresponding interface.
951 IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.
953 The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided.
954 For IPv6 the special string 'auto' can be used to use stateless autoconfiguration.
956 If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4.
958 `--ivshmem` `size=<integer> [,name=<string>]` ::
960 Inter-VM shared memory. Useful for direct communication between VMs, or to the host.
962 `--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>` ::
964 Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg' configuration file.It should not be necessary to set it.
966 `--kvm` `<boolean>` ('default =' `1`)::
968 Enable/disable KVM hardware virtualization.
970 `--localtime` `<boolean>` ::
972 Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
974 `--lock` `<backup | clone | create | migrate | rollback | snapshot | snapshot-delete | suspended | suspending>` ::
978 `--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` ::
980 Specifies the Qemu machine type.
982 `--memory` `<integer> (16 - N)` ('default =' `512`)::
984 Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
986 `--migrate_downtime` `<number> (0 - N)` ('default =' `0.1`)::
988 Set maximum tolerated downtime (in seconds) for migrations.
990 `--migrate_speed` `<integer> (0 - N)` ('default =' `0`)::
992 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
994 `--name` `<string>` ::
996 Set a name for the VM. Only used on the configuration web interface.
998 `--nameserver` `<string>` ::
1000 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.
1002 `--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>]` ::
1004 Specify network devices.
1006 `--numa` `<boolean>` ('default =' `0`)::
1008 Enable/disable NUMA.
1010 `--numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
1014 `--onboot` `<boolean>` ('default =' `0`)::
1016 Specifies whether a VM will be started during system bootup.
1018 `--ostype` `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win7 | win8 | wvista | wxp>` ::
1020 Specify guest operating system.
1022 `--parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` ::
1024 Map host parallel devices (n is 0 to 2).
1026 `--protection` `<boolean>` ('default =' `0`)::
1028 Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
1030 `--reboot` `<boolean>` ('default =' `1`)::
1032 Allow reboot. If set to '0' the VM exit on reboot.
1034 `--revert` `<string>` ::
1036 Revert a pending change.
1038 `--rng0` `[source=]</dev/urandom|/dev/random|/dev/hwrng> [,max_bytes=<integer>] [,period=<integer>]` ::
1040 Configure a VirtIO-based Random Number Generator.
1042 `--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>]` ::
1044 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
1046 `--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>]` ::
1048 Use volume as SCSI hard disk or CD-ROM (n is 0 to 30).
1050 `--scsihw` `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
1052 SCSI controller model
1054 `--searchdomain` `<string>` ::
1056 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.
1058 `--serial[n]` `(/dev/.+|socket)` ::
1060 Create a serial device inside the VM (n is 0 to 3)
1062 `--shares` `<integer> (0 - 50000)` ('default =' `1000`)::
1064 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.
1066 `--skiplock` `<boolean>` ::
1068 Ignore locks - only root is allowed to use this option.
1070 `--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>]` ::
1072 Specify SMBIOS type 1 fields.
1074 `--smp` `<integer> (1 - N)` ('default =' `1`)::
1076 The number of CPUs. Please use option -sockets instead.
1078 `--sockets` `<integer> (1 - N)` ('default =' `1`)::
1080 The number of CPU sockets.
1082 `--spice_enhancements` `[foldersharing=<1|0>] [,videostreaming=<off|all|filter>]` ::
1084 Configure additional enhancements for SPICE.
1086 `--sshkeys` `<filepath>` ::
1088 cloud-init: Setup public SSH keys (one key per line, OpenSSH format).
1090 `--startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
1092 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'.
1094 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
1096 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.
1098 `--tablet` `<boolean>` ('default =' `1`)::
1100 Enable/disable the USB tablet device.
1102 `--tags` `<string>` ::
1104 Tags of the VM. This is only meta information.
1106 `--tdf` `<boolean>` ('default =' `0`)::
1108 Enable/disable time drift fix.
1110 `--template` `<boolean>` ('default =' `0`)::
1112 Enable/disable Template.
1114 `--unused[n]` `[file=]<volume>` ::
1116 Reference to unused volumes. This is used internally, and should not be modified manually.
1118 `--usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
1120 Configure an USB device (n is 0 to 4).
1122 `--vcpus` `<integer> (1 - N)` ('default =' `0`)::
1124 Number of hotplugged vcpus.
1126 `--vga` `[[type=]<enum>] [,memory=<integer>]` ::
1128 Configure the VGA hardware.
1130 `--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>]` ::
1132 Use volume as VIRTIO hard disk (n is 0 to 15).
1134 `--vmgenid` `<UUID>` ('default =' `1 (autogenerated)`)::
1136 Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly.
1138 `--vmstatestorage` `<string>` ::
1140 Default storage for VM state volumes/files.
1142 `--watchdog` `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::
1144 Create a virtual hardware watchdog device.
1146 *qm showcmd* `<vmid>` `[OPTIONS]`
1148 Show command line which is used to start the VM (debug info).
1150 `<vmid>`: `<integer> (1 - N)` ::
1152 The (unique) ID of the VM.
1154 `--pretty` `<boolean>` ('default =' `0`)::
1156 Puts each option on a new line to enhance human readability
1158 `--snapshot` `<string>` ::
1160 Fetch config values from given snapshot.
1162 *qm shutdown* `<vmid>` `[OPTIONS]`
1164 Shutdown virtual machine. This is similar to pressing the power button on a
1165 physical machine.This will send an ACPI event for the guest OS, which
1166 should then proceed to a clean shutdown.
1168 `<vmid>`: `<integer> (1 - N)` ::
1170 The (unique) ID of the VM.
1172 `--forceStop` `<boolean>` ('default =' `0`)::
1174 Make sure the VM stops.
1176 `--keepActive` `<boolean>` ('default =' `0`)::
1178 Do not deactivate storage volumes.
1180 `--skiplock` `<boolean>` ::
1182 Ignore locks - only root is allowed to use this option.
1184 `--timeout` `<integer> (0 - N)` ::
1186 Wait maximal timeout seconds.
1188 *qm snapshot* `<vmid> <snapname>` `[OPTIONS]`
1192 `<vmid>`: `<integer> (1 - N)` ::
1194 The (unique) ID of the VM.
1196 `<snapname>`: `<string>` ::
1198 The name of the snapshot.
1200 `--description` `<string>` ::
1202 A textual description or comment.
1204 `--vmstate` `<boolean>` ::
1208 *qm start* `<vmid>` `[OPTIONS]`
1210 Start virtual machine.
1212 `<vmid>`: `<integer> (1 - N)` ::
1214 The (unique) ID of the VM.
1216 `--force-cpu` `<string>` ::
1218 Override QEMU's -cpu argument with the given string.
1220 `--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` ::
1222 Specifies the Qemu machine type.
1224 `--migratedfrom` `<string>` ::
1226 The cluster node name.
1228 `--migration_network` `<string>` ::
1230 CIDR of the (sub) network that is used for migration.
1232 `--migration_type` `<insecure | secure>` ::
1234 Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.
1236 `--skiplock` `<boolean>` ::
1238 Ignore locks - only root is allowed to use this option.
1240 `--stateuri` `<string>` ::
1242 Some command save/restore state from this location.
1244 `--targetstorage` `<string>` ::
1246 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.
1248 `--timeout` `<integer> (0 - N)` ('default =' `max(30, vm memory in GiB)`)::
1250 Wait maximal timeout seconds.
1252 *qm status* `<vmid>` `[OPTIONS]`
1256 `<vmid>`: `<integer> (1 - N)` ::
1258 The (unique) ID of the VM.
1260 `--verbose` `<boolean>` ::
1262 Verbose output format
1264 *qm stop* `<vmid>` `[OPTIONS]`
1266 Stop virtual machine. The qemu process will exit immediately. Thisis akin
1267 to pulling the power plug of a running computer and may damage the VM data
1269 `<vmid>`: `<integer> (1 - N)` ::
1271 The (unique) ID of the VM.
1273 `--keepActive` `<boolean>` ('default =' `0`)::
1275 Do not deactivate storage volumes.
1277 `--migratedfrom` `<string>` ::
1279 The cluster node name.
1281 `--skiplock` `<boolean>` ::
1283 Ignore locks - only root is allowed to use this option.
1285 `--timeout` `<integer> (0 - N)` ::
1287 Wait maximal timeout seconds.
1289 *qm suspend* `<vmid>` `[OPTIONS]`
1291 Suspend virtual machine.
1293 `<vmid>`: `<integer> (1 - N)` ::
1295 The (unique) ID of the VM.
1297 `--skiplock` `<boolean>` ::
1299 Ignore locks - only root is allowed to use this option.
1301 `--statestorage` `<string>` ::
1303 The storage for the VM state
1305 NOTE: Requires option(s): `todisk`
1307 `--todisk` `<boolean>` ('default =' `0`)::
1309 If set, suspends the VM to disk. Will be resumed on next VM start.
1311 *qm template* `<vmid>` `[OPTIONS]`
1315 `<vmid>`: `<integer> (1 - N)` ::
1317 The (unique) ID of the VM.
1319 `--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 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9>` ::
1321 If you want to convert only 1 disk to base image.
1323 *qm terminal* `<vmid>` `[OPTIONS]`
1325 Open a terminal using a serial device (The VM need to have a serial device
1326 configured, for example 'serial0: socket')
1328 `<vmid>`: `<integer> (1 - N)` ::
1330 The (unique) ID of the VM.
1332 `--escape` `<string>` ('default =' `^O`)::
1336 `--iface` `<serial0 | serial1 | serial2 | serial3>` ::
1338 Select the serial device. By default we simply use the first suitable device.
1340 *qm unlink* `<vmid> --idlist <string>` `[OPTIONS]`
1342 Unlink/delete disk images.
1344 `<vmid>`: `<integer> (1 - N)` ::
1346 The (unique) ID of the VM.
1348 `--force` `<boolean>` ::
1350 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.
1352 `--idlist` `<string>` ::
1354 A list of disk IDs you want to delete.
1356 *qm unlock* `<vmid>`
1360 `<vmid>`: `<integer> (1 - N)` ::
1362 The (unique) ID of the VM.
1364 *qm vncproxy* `<vmid>`
1366 Proxy VM VNC traffic to stdin/stdout
1368 `<vmid>`: `<integer> (1 - N)` ::
1370 The (unique) ID of the VM.
1372 *qm wait* `<vmid>` `[OPTIONS]`
1374 Wait until the VM is stopped.
1376 `<vmid>`: `<integer> (1 - N)` ::
1378 The (unique) ID of the VM.
1380 `--timeout` `<integer> (1 - N)` ::
1382 Timeout in seconds. Default is to wait forever.