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|none>]` ::
132 Configure a audio device, useful in combination with QXL/Spice.
134 `--autostart` `<boolean>` ('default =' `0`)::
136 Automatic restart after crash (currently ignored).
138 `--balloon` `<integer> (0 - N)` ::
140 Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
142 `--bios` `<ovmf | seabios>` ('default =' `seabios`)::
144 Select BIOS implementation.
146 `--boot` `[[legacy=]<[acdn]{1,4}>] [,order=<device[;device...]>]` ::
148 Specify guest boot order. Use 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 | opennebula>` ::
172 Specifies the cloud-init configuration format. The default depends on the configured operating system type (`ostype`. We use the `nocloud` format for Linux, and `configdrive2` for windows.
174 `--ciuser` `<string>` ::
176 cloud-init: User name to change ssh keys and password for instead of the image's configured default user.
178 `--cores` `<integer> (1 - N)` ('default =' `1`)::
180 The number of cores per socket.
182 `--cpu` `[[cputype=]<string>] [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=<vendor-id>] [,phys-bits=<8-64|host>] [,reported-model=<enum>]` ::
186 `--cpulimit` `<number> (0 - 128)` ('default =' `0`)::
190 `--cpuunits` `<integer> (2 - 262144)` ('default =' `1024`)::
194 `--description` `<string>` ::
196 Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file.
198 `--efidisk0` `[file=]<volume> [,format=<enum>] [,size=<DiskSize>]` ::
200 Configure a Disk for storing EFI vars. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead.
202 `--force` `<boolean>` ::
204 Allow to overwrite existing VM.
206 NOTE: Requires option(s): `archive`
208 `--freeze` `<boolean>` ::
210 Freeze CPU at startup (use 'c' monitor command to start execution).
212 `--hookscript` `<string>` ::
214 Script that will be executed during various steps in the vms lifetime.
216 `--hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,legacy-igd=<1|0>] [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
218 Map host PCI devices into guest.
220 `--hotplug` `<string>` ('default =' `network,disk,usb`)::
222 Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to disable hotplug completely. 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|io_uring>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]` ::
230 Use volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
232 `--ipconfig[n]` `[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]` ::
234 cloud-init: Specify IP addresses and gateways for the corresponding interface.
236 IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.
238 The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit
239 gateway should be provided.
240 For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires
241 cloud-init 19.4 or newer.
243 If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using
246 `--ivshmem` `size=<integer> [,name=<string>]` ::
248 Inter-VM shared memory. Useful for direct communication between VMs, or to the host.
250 `--keephugepages` `<boolean>` ('default =' `0`)::
252 Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts.
254 `--keyboard` `<da | de | de-ch | en-gb | en-us | es | fi | fr | fr-be | fr-ca | fr-ch | hu | is | it | ja | lt | mk | nl | no | pl | pt | pt-br | sl | sv | tr>` ::
256 Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg' configuration file.It should not be necessary to set it.
258 `--kvm` `<boolean>` ('default =' `1`)::
260 Enable/disable KVM hardware virtualization.
262 `--live-restore` `<boolean>` ::
264 Start the VM immediately from the backup and restore in background. PBS only.
266 NOTE: Requires option(s): `archive`
268 `--localtime` `<boolean>` ::
270 Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
272 `--lock` `<backup | clone | create | migrate | rollback | snapshot | snapshot-delete | suspended | suspending>` ::
276 `--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` ::
278 Specifies the Qemu machine type.
280 `--memory` `<integer> (16 - N)` ('default =' `512`)::
282 Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
284 `--migrate_downtime` `<number> (0 - N)` ('default =' `0.1`)::
286 Set maximum tolerated downtime (in seconds) for migrations.
288 `--migrate_speed` `<integer> (0 - N)` ('default =' `0`)::
290 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
292 `--name` `<string>` ::
294 Set a name for the VM. Only used on the configuration web interface.
296 `--nameserver` `<string>` ::
298 cloud-init: Sets DNS server IP address for a container. Create will'
299 .' automatically use the setting from the host if neither searchdomain nor nameserver'
302 `--net[n]` `[model=]<enum> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,mtu=<integer>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]` ::
304 Specify network devices.
306 `--numa` `<boolean>` ('default =' `0`)::
310 `--numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
314 `--onboot` `<boolean>` ('default =' `0`)::
316 Specifies whether a VM will be started during system bootup.
318 `--ostype` `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win7 | win8 | wvista | wxp>` ::
320 Specify guest operating system.
322 `--parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` ::
324 Map host parallel devices (n is 0 to 2).
326 `--pool` `<string>` ::
328 Add the VM to the specified pool.
330 `--protection` `<boolean>` ('default =' `0`)::
332 Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
334 `--reboot` `<boolean>` ('default =' `1`)::
336 Allow reboot. If set to '0' the VM exit on reboot.
338 `--rng0` `[source=]</dev/urandom|/dev/random|/dev/hwrng> [,max_bytes=<integer>] [,period=<integer>]` ::
340 Configure a VirtIO-based Random Number Generator.
342 `--sata[n]` `[file=]<volume> [,aio=<native|threads|io_uring>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]` ::
344 Use volume as SATA hard disk or CD-ROM (n is 0 to 5). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
346 `--scsi[n]` `[file=]<volume> [,aio=<native|threads|io_uring>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,queues=<integer>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,scsiblock=<1|0>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]` ::
348 Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
350 `--scsihw` `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
352 SCSI controller model
354 `--searchdomain` `<string>` ::
356 cloud-init: Sets DNS search domains for a container. Create will'
357 .' automatically use the setting from the host if neither searchdomain nor nameserver'
360 `--serial[n]` `(/dev/.+|socket)` ::
362 Create a serial device inside the VM (n is 0 to 3)
364 `--shares` `<integer> (0 - 50000)` ('default =' `1000`)::
366 Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning. Auto-ballooning is done by pvestatd.
368 `--smbios1` `[base64=<1|0>] [,family=<Base64 encoded string>] [,manufacturer=<Base64 encoded string>] [,product=<Base64 encoded string>] [,serial=<Base64 encoded string>] [,sku=<Base64 encoded string>] [,uuid=<UUID>] [,version=<Base64 encoded string>]` ::
370 Specify SMBIOS type 1 fields.
372 `--smp` `<integer> (1 - N)` ('default =' `1`)::
374 The number of CPUs. Please use option -sockets instead.
376 `--sockets` `<integer> (1 - N)` ('default =' `1`)::
378 The number of CPU sockets.
380 `--spice_enhancements` `[foldersharing=<1|0>] [,videostreaming=<off|all|filter>]` ::
382 Configure additional enhancements for SPICE.
384 `--sshkeys` `<filepath>` ::
386 cloud-init: Setup public SSH keys (one key per line, OpenSSH format).
388 `--start` `<boolean>` ('default =' `0`)::
390 Start VM after it was created successfully.
392 `--startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
394 Set the initial date of the real time clock. Valid format for date are:'now' or '2006-06-17T16:01:21' or '2006-06-17'.
396 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
398 Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.
400 `--storage` `<string>` ::
404 `--tablet` `<boolean>` ('default =' `1`)::
406 Enable/disable the USB tablet device.
408 `--tags` `<string>` ::
410 Tags of the VM. This is only meta information.
412 `--tdf` `<boolean>` ('default =' `0`)::
414 Enable/disable time drift fix.
416 `--template` `<boolean>` ('default =' `0`)::
418 Enable/disable Template.
420 `--unique` `<boolean>` ::
422 Assign a unique random ethernet address.
424 NOTE: Requires option(s): `archive`
426 `--unused[n]` `[file=]<volume>` ::
428 Reference to unused volumes. This is used internally, and should not be modified manually.
430 `--usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
432 Configure an USB device (n is 0 to 4).
434 `--vcpus` `<integer> (1 - N)` ('default =' `0`)::
436 Number of hotplugged vcpus.
438 `--vga` `[[type=]<enum>] [,memory=<integer>]` ::
440 Configure the VGA hardware.
442 `--virtio[n]` `[file=]<volume> [,aio=<native|threads|io_uring>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
444 Use volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
446 `--vmgenid` `<UUID>` ('default =' `1 (autogenerated)`)::
448 Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly.
450 `--vmstatestorage` `<string>` ::
452 Default storage for VM state volumes/files.
454 `--watchdog` `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::
456 Create a virtual hardware watchdog device.
458 *qm delsnapshot* `<vmid> <snapname>` `[OPTIONS]`
460 Delete a VM snapshot.
462 `<vmid>`: `<integer> (1 - N)` ::
464 The (unique) ID of the VM.
466 `<snapname>`: `<string>` ::
468 The name of the snapshot.
470 `--force` `<boolean>` ::
472 For removal from config file, even if removing disk snapshots fails.
474 *qm destroy* `<vmid>` `[OPTIONS]`
476 Destroy the VM and all used/owned volumes. Removes any VM specific
477 permissions and firewall rules
479 `<vmid>`: `<integer> (1 - N)` ::
481 The (unique) ID of the VM.
483 `--destroy-unreferenced-disks` `<boolean>` ('default =' `0`)::
485 If set, destroy additionally all disks not referenced in the config but with a matching VMID from all enabled storages.
487 `--purge` `<boolean>` ::
489 Remove VMID from configurations, like backup & replication jobs and HA.
491 `--skiplock` `<boolean>` ::
493 Ignore locks - only root is allowed to use this option.
495 *qm guest cmd* `<vmid> <command>`
497 Execute Qemu Guest Agent commands.
499 `<vmid>`: `<integer> (1 - N)` ::
501 The (unique) ID of the VM.
503 `<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>` ::
507 *qm guest exec* `<vmid> [<extra-args>]` `[OPTIONS]`
509 Executes the given command via the guest agent
511 `<vmid>`: `<integer> (1 - N)` ::
513 The (unique) ID of the VM.
515 `<extra-args>`: `<array>` ::
517 Extra arguments as array
519 `--pass-stdin` `<boolean>` ('default =' `0`)::
521 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.
523 `--synchronous` `<boolean>` ('default =' `1`)::
525 If set to off, returns the pid immediately instead of waiting for the commmand to finish or the timeout.
527 `--timeout` `<integer> (0 - N)` ('default =' `30`)::
529 The maximum time to wait synchronously for the command to finish. If reached, the pid gets returned. Set to 0 to deactivate
531 *qm guest exec-status* `<vmid> <pid>`
533 Gets the status of the given pid started by the guest-agent
535 `<vmid>`: `<integer> (1 - N)` ::
537 The (unique) ID of the VM.
539 `<pid>`: `<integer>` ::
543 *qm guest passwd* `<vmid> <username>` `[OPTIONS]`
545 Sets the password for the given user to the given password
547 `<vmid>`: `<integer> (1 - N)` ::
549 The (unique) ID of the VM.
551 `<username>`: `<string>` ::
553 The user to set the password for.
555 `--crypted` `<boolean>` ('default =' `0`)::
557 set to 1 if the password has already been passed through crypt()
559 *qm help* `[OPTIONS]`
561 Get help about specified command.
563 `--extra-args` `<array>` ::
565 Shows help for a specific command
567 `--verbose` `<boolean>` ::
569 Verbose output format.
571 *qm importdisk* `<vmid> <source> <storage>` `[OPTIONS]`
573 Import an external disk image as an unused disk in a VM. The
574 image format has to be supported by qemu-img(1).
576 `<vmid>`: `<integer> (1 - N)` ::
578 The (unique) ID of the VM.
580 `<source>`: `<string>` ::
582 Path to the disk image to import
584 `<storage>`: `<string>` ::
588 `--format` `<qcow2 | raw | vmdk>` ::
592 *qm importovf* `<vmid> <manifest> <storage>` `[OPTIONS]`
594 Create a new VM using parameters read from an OVF manifest
596 `<vmid>`: `<integer> (1 - N)` ::
598 The (unique) ID of the VM.
600 `<manifest>`: `<string>` ::
604 `<storage>`: `<string>` ::
608 `--dryrun` `<boolean>` ::
610 Print a parsed representation of the extracted OVF parameters, but do not create a VM
612 `--format` `<qcow2 | raw | vmdk>` ::
616 *qm list* `[OPTIONS]`
618 Virtual machine index (per node).
620 `--full` `<boolean>` ::
622 Determine the full status of active VMs.
624 *qm listsnapshot* `<vmid>`
628 `<vmid>`: `<integer> (1 - N)` ::
630 The (unique) ID of the VM.
632 *qm migrate* `<vmid> <target>` `[OPTIONS]`
634 Migrate virtual machine. Creates a new migration task.
636 `<vmid>`: `<integer> (1 - N)` ::
638 The (unique) ID of the VM.
640 `<target>`: `<string>` ::
644 `--bwlimit` `<integer> (0 - N)` ('default =' `migrate limit from datacenter or storage config`)::
646 Override I/O bandwidth limit (in KiB/s).
648 `--force` `<boolean>` ::
650 Allow to migrate VMs which use local devices. Only root may use this option.
652 `--migration_network` `<string>` ::
654 CIDR of the (sub) network that is used for migration.
656 `--migration_type` `<insecure | secure>` ::
658 Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.
660 `--online` `<boolean>` ::
662 Use online/live migration if VM is running. Ignored if VM is stopped.
664 `--targetstorage` `<string>` ::
666 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.
668 `--with-local-disks` `<boolean>` ::
670 Enable live storage migration for local disk
672 *qm monitor* `<vmid>`
674 Enter Qemu Monitor interface.
676 `<vmid>`: `<integer> (1 - N)` ::
678 The (unique) ID of the VM.
680 *qm move_disk* `<vmid> <disk> <storage>` `[OPTIONS]`
682 Move volume to different storage.
684 `<vmid>`: `<integer> (1 - N)` ::
686 The (unique) ID of the VM.
688 `<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>` ::
690 The disk you want to move.
692 `<storage>`: `<string>` ::
696 `--bwlimit` `<integer> (0 - N)` ('default =' `move limit from datacenter or storage config`)::
698 Override I/O bandwidth limit (in KiB/s).
700 `--delete` `<boolean>` ('default =' `0`)::
702 Delete the original disk after successful copy. By default the original disk is kept as unused disk.
704 `--digest` `<string>` ::
706 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
708 `--format` `<qcow2 | raw | vmdk>` ::
714 Used by qmigrate - do not use manually.
716 *qm nbdstop* `<vmid>`
718 Stop embedded nbd server.
720 `<vmid>`: `<integer> (1 - N)` ::
722 The (unique) ID of the VM.
724 *qm pending* `<vmid>`
726 Get the virtual machine configuration with both current and pending values.
728 `<vmid>`: `<integer> (1 - N)` ::
730 The (unique) ID of the VM.
732 *qm reboot* `<vmid>` `[OPTIONS]`
734 Reboot the VM by shutting it down, and starting it again. Applies pending
737 `<vmid>`: `<integer> (1 - N)` ::
739 The (unique) ID of the VM.
741 `--timeout` `<integer> (0 - N)` ::
743 Wait maximal timeout seconds for the shutdown.
745 *qm rescan* `[OPTIONS]`
747 Rescan all storages and update disk sizes and unused disk images.
749 `--dryrun` `<boolean>` ('default =' `0`)::
751 Do not actually write changes out to VM config(s).
753 `--vmid` `<integer> (1 - N)` ::
755 The (unique) ID of the VM.
757 *qm reset* `<vmid>` `[OPTIONS]`
759 Reset virtual machine.
761 `<vmid>`: `<integer> (1 - N)` ::
763 The (unique) ID of the VM.
765 `--skiplock` `<boolean>` ::
767 Ignore locks - only root is allowed to use this option.
769 *qm resize* `<vmid> <disk> <size>` `[OPTIONS]`
773 `<vmid>`: `<integer> (1 - N)` ::
775 The (unique) ID of the VM.
777 `<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>` ::
779 The disk you want to resize.
781 `<size>`: `\+?\d+(\.\d+)?[KMGT]?` ::
783 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.
785 `--digest` `<string>` ::
787 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
789 `--skiplock` `<boolean>` ::
791 Ignore locks - only root is allowed to use this option.
793 *qm resume* `<vmid>` `[OPTIONS]`
795 Resume virtual machine.
797 `<vmid>`: `<integer> (1 - N)` ::
799 The (unique) ID of the VM.
801 `--nocheck` `<boolean>` ::
803 no description available
805 `--skiplock` `<boolean>` ::
807 Ignore locks - only root is allowed to use this option.
809 *qm rollback* `<vmid> <snapname>`
811 Rollback VM state to specified snapshot.
813 `<vmid>`: `<integer> (1 - N)` ::
815 The (unique) ID of the VM.
817 `<snapname>`: `<string>` ::
819 The name of the snapshot.
821 *qm sendkey* `<vmid> <key>` `[OPTIONS]`
823 Send key event to virtual machine.
825 `<vmid>`: `<integer> (1 - N)` ::
827 The (unique) ID of the VM.
829 `<key>`: `<string>` ::
831 The key (qemu monitor encoding).
833 `--skiplock` `<boolean>` ::
835 Ignore locks - only root is allowed to use this option.
837 *qm set* `<vmid>` `[OPTIONS]`
839 Set virtual machine options (synchrounous API) - You should consider using
840 the POST method instead for any actions involving hotplug or storage
843 `<vmid>`: `<integer> (1 - N)` ::
845 The (unique) ID of the VM.
847 `--acpi` `<boolean>` ('default =' `1`)::
851 `--agent` `[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>] [,type=<virtio|isa>]` ::
853 Enable/disable Qemu GuestAgent and its properties.
855 `--arch` `<aarch64 | x86_64>` ::
857 Virtual processor architecture. Defaults to the host.
859 `--args` `<string>` ::
861 Arbitrary arguments passed to kvm.
863 `--audio0` `device=<ich9-intel-hda|intel-hda|AC97> [,driver=<spice|none>]` ::
865 Configure a audio device, useful in combination with QXL/Spice.
867 `--autostart` `<boolean>` ('default =' `0`)::
869 Automatic restart after crash (currently ignored).
871 `--balloon` `<integer> (0 - N)` ::
873 Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
875 `--bios` `<ovmf | seabios>` ('default =' `seabios`)::
877 Select BIOS implementation.
879 `--boot` `[[legacy=]<[acdn]{1,4}>] [,order=<device[;device...]>]` ::
881 Specify guest boot order. Use with 'order=', usage with no key or 'legacy=' is deprecated.
883 `--bootdisk` `(ide|sata|scsi|virtio)\d+` ::
885 Enable booting from specified disk. Deprecated: Use 'boot: order=foo;bar' instead.
887 `--cdrom` `<volume>` ::
889 This is an alias for option -ide2
891 `--cicustom` `[meta=<volume>] [,network=<volume>] [,user=<volume>]` ::
893 cloud-init: Specify custom files to replace the automatically generated ones at start.
895 `--cipassword` `<password>` ::
897 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.
899 `--citype` `<configdrive2 | nocloud | opennebula>` ::
901 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.
903 `--ciuser` `<string>` ::
905 cloud-init: User name to change ssh keys and password for instead of the image's configured default user.
907 `--cores` `<integer> (1 - N)` ('default =' `1`)::
909 The number of cores per socket.
911 `--cpu` `[[cputype=]<string>] [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=<vendor-id>] [,phys-bits=<8-64|host>] [,reported-model=<enum>]` ::
915 `--cpulimit` `<number> (0 - 128)` ('default =' `0`)::
919 `--cpuunits` `<integer> (2 - 262144)` ('default =' `1024`)::
923 `--delete` `<string>` ::
925 A list of settings you want to delete.
927 `--description` `<string>` ::
929 Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file.
931 `--digest` `<string>` ::
933 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
935 `--efidisk0` `[file=]<volume> [,format=<enum>] [,size=<DiskSize>]` ::
937 Configure a Disk for storing EFI vars. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead.
939 `--force` `<boolean>` ::
941 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.
943 NOTE: Requires option(s): `delete`
945 `--freeze` `<boolean>` ::
947 Freeze CPU at startup (use 'c' monitor command to start execution).
949 `--hookscript` `<string>` ::
951 Script that will be executed during various steps in the vms lifetime.
953 `--hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,legacy-igd=<1|0>] [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
955 Map host PCI devices into guest.
957 `--hotplug` `<string>` ('default =' `network,disk,usb`)::
959 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'.
961 `--hugepages` `<1024 | 2 | any>` ::
963 Enable/disable hugepages memory.
965 `--ide[n]` `[file=]<volume> [,aio=<native|threads|io_uring>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]` ::
967 Use volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
969 `--ipconfig[n]` `[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]` ::
971 cloud-init: Specify IP addresses and gateways for the corresponding interface.
973 IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.
975 The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit
976 gateway should be provided.
977 For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires
978 cloud-init 19.4 or newer.
980 If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using
983 `--ivshmem` `size=<integer> [,name=<string>]` ::
985 Inter-VM shared memory. Useful for direct communication between VMs, or to the host.
987 `--keephugepages` `<boolean>` ('default =' `0`)::
989 Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts.
991 `--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>` ::
993 Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg' configuration file.It should not be necessary to set it.
995 `--kvm` `<boolean>` ('default =' `1`)::
997 Enable/disable KVM hardware virtualization.
999 `--localtime` `<boolean>` ::
1001 Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
1003 `--lock` `<backup | clone | create | migrate | rollback | snapshot | snapshot-delete | suspended | suspending>` ::
1007 `--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` ::
1009 Specifies the Qemu machine type.
1011 `--memory` `<integer> (16 - N)` ('default =' `512`)::
1013 Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
1015 `--migrate_downtime` `<number> (0 - N)` ('default =' `0.1`)::
1017 Set maximum tolerated downtime (in seconds) for migrations.
1019 `--migrate_speed` `<integer> (0 - N)` ('default =' `0`)::
1021 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
1023 `--name` `<string>` ::
1025 Set a name for the VM. Only used on the configuration web interface.
1027 `--nameserver` `<string>` ::
1029 cloud-init: Sets DNS server IP address for a container. Create will'
1030 .' automatically use the setting from the host if neither searchdomain nor nameserver'
1033 `--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>]` ::
1035 Specify network devices.
1037 `--numa` `<boolean>` ('default =' `0`)::
1039 Enable/disable NUMA.
1041 `--numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
1045 `--onboot` `<boolean>` ('default =' `0`)::
1047 Specifies whether a VM will be started during system bootup.
1049 `--ostype` `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win7 | win8 | wvista | wxp>` ::
1051 Specify guest operating system.
1053 `--parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` ::
1055 Map host parallel devices (n is 0 to 2).
1057 `--protection` `<boolean>` ('default =' `0`)::
1059 Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
1061 `--reboot` `<boolean>` ('default =' `1`)::
1063 Allow reboot. If set to '0' the VM exit on reboot.
1065 `--revert` `<string>` ::
1067 Revert a pending change.
1069 `--rng0` `[source=]</dev/urandom|/dev/random|/dev/hwrng> [,max_bytes=<integer>] [,period=<integer>]` ::
1071 Configure a VirtIO-based Random Number Generator.
1073 `--sata[n]` `[file=]<volume> [,aio=<native|threads|io_uring>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]` ::
1075 Use volume as SATA hard disk or CD-ROM (n is 0 to 5). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
1077 `--scsi[n]` `[file=]<volume> [,aio=<native|threads|io_uring>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,queues=<integer>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,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>]` ::
1079 Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
1081 `--scsihw` `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
1083 SCSI controller model
1085 `--searchdomain` `<string>` ::
1087 cloud-init: Sets DNS search domains for a container. Create will'
1088 .' automatically use the setting from the host if neither searchdomain nor nameserver'
1091 `--serial[n]` `(/dev/.+|socket)` ::
1093 Create a serial device inside the VM (n is 0 to 3)
1095 `--shares` `<integer> (0 - 50000)` ('default =' `1000`)::
1097 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.
1099 `--skiplock` `<boolean>` ::
1101 Ignore locks - only root is allowed to use this option.
1103 `--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>]` ::
1105 Specify SMBIOS type 1 fields.
1107 `--smp` `<integer> (1 - N)` ('default =' `1`)::
1109 The number of CPUs. Please use option -sockets instead.
1111 `--sockets` `<integer> (1 - N)` ('default =' `1`)::
1113 The number of CPU sockets.
1115 `--spice_enhancements` `[foldersharing=<1|0>] [,videostreaming=<off|all|filter>]` ::
1117 Configure additional enhancements for SPICE.
1119 `--sshkeys` `<filepath>` ::
1121 cloud-init: Setup public SSH keys (one key per line, OpenSSH format).
1123 `--startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
1125 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'.
1127 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
1129 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.
1131 `--tablet` `<boolean>` ('default =' `1`)::
1133 Enable/disable the USB tablet device.
1135 `--tags` `<string>` ::
1137 Tags of the VM. This is only meta information.
1139 `--tdf` `<boolean>` ('default =' `0`)::
1141 Enable/disable time drift fix.
1143 `--template` `<boolean>` ('default =' `0`)::
1145 Enable/disable Template.
1147 `--unused[n]` `[file=]<volume>` ::
1149 Reference to unused volumes. This is used internally, and should not be modified manually.
1151 `--usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
1153 Configure an USB device (n is 0 to 4).
1155 `--vcpus` `<integer> (1 - N)` ('default =' `0`)::
1157 Number of hotplugged vcpus.
1159 `--vga` `[[type=]<enum>] [,memory=<integer>]` ::
1161 Configure the VGA hardware.
1163 `--virtio[n]` `[file=]<volume> [,aio=<native|threads|io_uring>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
1165 Use volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
1167 `--vmgenid` `<UUID>` ('default =' `1 (autogenerated)`)::
1169 Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly.
1171 `--vmstatestorage` `<string>` ::
1173 Default storage for VM state volumes/files.
1175 `--watchdog` `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::
1177 Create a virtual hardware watchdog device.
1179 *qm showcmd* `<vmid>` `[OPTIONS]`
1181 Show command line which is used to start the VM (debug info).
1183 `<vmid>`: `<integer> (1 - N)` ::
1185 The (unique) ID of the VM.
1187 `--pretty` `<boolean>` ('default =' `0`)::
1189 Puts each option on a new line to enhance human readability
1191 `--snapshot` `<string>` ::
1193 Fetch config values from given snapshot.
1195 *qm shutdown* `<vmid>` `[OPTIONS]`
1197 Shutdown virtual machine. This is similar to pressing the power button on a
1198 physical machine.This will send an ACPI event for the guest OS, which
1199 should then proceed to a clean shutdown.
1201 `<vmid>`: `<integer> (1 - N)` ::
1203 The (unique) ID of the VM.
1205 `--forceStop` `<boolean>` ('default =' `0`)::
1207 Make sure the VM stops.
1209 `--keepActive` `<boolean>` ('default =' `0`)::
1211 Do not deactivate storage volumes.
1213 `--skiplock` `<boolean>` ::
1215 Ignore locks - only root is allowed to use this option.
1217 `--timeout` `<integer> (0 - N)` ::
1219 Wait maximal timeout seconds.
1221 *qm snapshot* `<vmid> <snapname>` `[OPTIONS]`
1225 `<vmid>`: `<integer> (1 - N)` ::
1227 The (unique) ID of the VM.
1229 `<snapname>`: `<string>` ::
1231 The name of the snapshot.
1233 `--description` `<string>` ::
1235 A textual description or comment.
1237 `--vmstate` `<boolean>` ::
1241 *qm start* `<vmid>` `[OPTIONS]`
1243 Start virtual machine.
1245 `<vmid>`: `<integer> (1 - N)` ::
1247 The (unique) ID of the VM.
1249 `--force-cpu` `<string>` ::
1251 Override QEMU's -cpu argument with the given string.
1253 `--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` ::
1255 Specifies the Qemu machine type.
1257 `--migratedfrom` `<string>` ::
1259 The cluster node name.
1261 `--migration_network` `<string>` ::
1263 CIDR of the (sub) network that is used for migration.
1265 `--migration_type` `<insecure | secure>` ::
1267 Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.
1269 `--skiplock` `<boolean>` ::
1271 Ignore locks - only root is allowed to use this option.
1273 `--stateuri` `<string>` ::
1275 Some command save/restore state from this location.
1277 `--targetstorage` `<string>` ::
1279 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.
1281 `--timeout` `<integer> (0 - N)` ('default =' `max(30, vm memory in GiB)`)::
1283 Wait maximal timeout seconds.
1285 *qm status* `<vmid>` `[OPTIONS]`
1289 `<vmid>`: `<integer> (1 - N)` ::
1291 The (unique) ID of the VM.
1293 `--verbose` `<boolean>` ::
1295 Verbose output format
1297 *qm stop* `<vmid>` `[OPTIONS]`
1299 Stop virtual machine. The qemu process will exit immediately. Thisis akin
1300 to pulling the power plug of a running computer and may damage the VM data
1302 `<vmid>`: `<integer> (1 - N)` ::
1304 The (unique) ID of the VM.
1306 `--keepActive` `<boolean>` ('default =' `0`)::
1308 Do not deactivate storage volumes.
1310 `--migratedfrom` `<string>` ::
1312 The cluster node name.
1314 `--skiplock` `<boolean>` ::
1316 Ignore locks - only root is allowed to use this option.
1318 `--timeout` `<integer> (0 - N)` ::
1320 Wait maximal timeout seconds.
1322 *qm suspend* `<vmid>` `[OPTIONS]`
1324 Suspend virtual machine.
1326 `<vmid>`: `<integer> (1 - N)` ::
1328 The (unique) ID of the VM.
1330 `--skiplock` `<boolean>` ::
1332 Ignore locks - only root is allowed to use this option.
1334 `--statestorage` `<string>` ::
1336 The storage for the VM state
1338 NOTE: Requires option(s): `todisk`
1340 `--todisk` `<boolean>` ('default =' `0`)::
1342 If set, suspends the VM to disk. Will be resumed on next VM start.
1344 *qm template* `<vmid>` `[OPTIONS]`
1348 `<vmid>`: `<integer> (1 - N)` ::
1350 The (unique) ID of the VM.
1352 `--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>` ::
1354 If you want to convert only 1 disk to base image.
1356 *qm terminal* `<vmid>` `[OPTIONS]`
1358 Open a terminal using a serial device (The VM need to have a serial device
1359 configured, for example 'serial0: socket')
1361 `<vmid>`: `<integer> (1 - N)` ::
1363 The (unique) ID of the VM.
1365 `--escape` `<string>` ('default =' `^O`)::
1369 `--iface` `<serial0 | serial1 | serial2 | serial3>` ::
1371 Select the serial device. By default we simply use the first suitable device.
1373 *qm unlink* `<vmid> --idlist <string>` `[OPTIONS]`
1375 Unlink/delete disk images.
1377 `<vmid>`: `<integer> (1 - N)` ::
1379 The (unique) ID of the VM.
1381 `--force` `<boolean>` ::
1383 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.
1385 `--idlist` `<string>` ::
1387 A list of disk IDs you want to delete.
1389 *qm unlock* `<vmid>`
1393 `<vmid>`: `<integer> (1 - N)` ::
1395 The (unique) ID of the VM.
1397 *qm vncproxy* `<vmid>`
1399 Proxy VM VNC traffic to stdin/stdout
1401 `<vmid>`: `<integer> (1 - N)` ::
1403 The (unique) ID of the VM.
1405 *qm wait* `<vmid>` `[OPTIONS]`
1407 Wait until the VM is stopped.
1409 `<vmid>`: `<integer> (1 - N)` ::
1411 The (unique) ID of the VM.
1413 `--timeout` `<integer> (1 - N)` ::
1415 Timeout in seconds. Default is to wait forever.