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