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