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 current virtual machine configuration. This does not include pending
87 configuration changes (see 'pending' API).
89 `<vmid>`: `<integer> (1 - N)` ::
91 The (unique) ID of the VM.
93 `--current` `<boolean>` ('default =' `0`)::
95 Get current values (instead of pending values).
97 `--snapshot` `<string>` ::
99 Fetch config values from given snapshot.
101 *qm create* `<vmid>` `[OPTIONS]`
103 Create or restore a virtual machine.
105 `<vmid>`: `<integer> (1 - N)` ::
107 The (unique) ID of the VM.
109 `--acpi` `<boolean>` ('default =' `1`)::
113 `--agent` `[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>] [,type=<virtio|isa>]` ::
115 Enable/disable Qemu GuestAgent and its properties.
117 `--arch` `<aarch64 | x86_64>` ::
119 Virtual processor architecture. Defaults to the host.
121 `--archive` `<string>` ::
125 `--args` `<string>` ::
127 Arbitrary arguments passed to kvm.
129 `--audio0` `device=<ich9-intel-hda|intel-hda|AC97> [,driver=<spice>]` ::
131 Configure a audio device, useful in combination with QXL/Spice.
133 `--autostart` `<boolean>` ('default =' `0`)::
135 Automatic restart after crash (currently ignored).
137 `--balloon` `<integer> (0 - N)` ::
139 Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
141 `--bios` `<ovmf | seabios>` ('default =' `seabios`)::
143 Select BIOS implementation.
145 `--boot` `[acdn]{1,4}` ('default =' `cdn`)::
147 Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).
149 `--bootdisk` `(ide|sata|scsi|virtio)\d+` ::
151 Enable booting from specified disk.
153 `--bwlimit` `<integer> (0 - N)` ('default =' `restore limit from datacenter or storage config`)::
155 Override I/O bandwidth limit (in KiB/s).
157 `--cdrom` `<volume>` ::
159 This is an alias for option -ide2
161 `--cicustom` `[meta=<volume>] [,network=<volume>] [,user=<volume>]` ::
163 cloud-init: Specify custom files to replace the automatically generated ones at start.
165 `--cipassword` `<password>` ::
167 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.
169 `--citype` `<configdrive2 | nocloud>` ::
171 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.
173 `--ciuser` `<string>` ::
175 cloud-init: User name to change ssh keys and password for instead of the image's configured default user.
177 `--cores` `<integer> (1 - N)` ('default =' `1`)::
179 The number of cores per socket.
181 `--cpu` `[cputype=]<enum> [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=<vendor-id>]` ::
185 `--cpulimit` `<number> (0 - 128)` ('default =' `0`)::
189 `--cpuunits` `<integer> (2 - 262144)` ('default =' `1024`)::
193 `--description` `<string>` ::
195 Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.
197 `--efidisk0` `[file=]<volume> [,format=<enum>] [,size=<DiskSize>]` ::
199 Configure a Disk for storing EFI vars
201 `--force` `<boolean>` ::
203 Allow to overwrite existing VM.
205 NOTE: Requires option(s): `archive`
207 `--freeze` `<boolean>` ::
209 Freeze CPU at startup (use 'c' monitor command to start execution).
211 `--hookscript` `<string>` ::
213 Script that will be executed during various steps in the vms lifetime.
215 `--hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
217 Map host PCI devices into guest.
219 `--hotplug` `<string>` ('default =' `network,disk,usb`)::
221 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'.
223 `--hugepages` `<1024 | 2 | any>` ::
225 Enable/disable hugepages memory.
227 `--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>]` ::
229 Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
231 `--ipconfig[n]` `[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]` ::
233 cloud-init: Specify IP addresses and gateways for the corresponding interface.
235 IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.
237 The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided.
238 For IPv6 the special string 'auto' can be used to use stateless autoconfiguration.
240 If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4.
242 `--ivshmem` `size=<integer> [,name=<string>]` ::
244 Inter-VM shared memory. Useful for direct communication between VMs, or to the host.
246 `--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>` ::
248 Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg' configuration file.It should not be necessary to set it.
250 `--kvm` `<boolean>` ('default =' `1`)::
252 Enable/disable KVM hardware virtualization.
254 `--localtime` `<boolean>` ::
256 Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
258 `--lock` `<backup | clone | create | migrate | rollback | snapshot | snapshot-delete | suspended | suspending>` ::
262 `--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` ::
264 Specifies the Qemu machine type.
266 `--memory` `<integer> (16 - N)` ('default =' `512`)::
268 Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
270 `--migrate_downtime` `<number> (0 - N)` ('default =' `0.1`)::
272 Set maximum tolerated downtime (in seconds) for migrations.
274 `--migrate_speed` `<integer> (0 - N)` ('default =' `0`)::
276 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
278 `--name` `<string>` ::
280 Set a name for the VM. Only used on the configuration web interface.
282 `--nameserver` `<string>` ::
284 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.
286 `--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>]` ::
288 Specify network devices.
290 `--numa` `<boolean>` ('default =' `0`)::
294 `--numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
298 `--onboot` `<boolean>` ('default =' `0`)::
300 Specifies whether a VM will be started during system bootup.
302 `--ostype` `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win7 | win8 | wvista | wxp>` ::
304 Specify guest operating system.
306 `--parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` ::
308 Map host parallel devices (n is 0 to 2).
310 `--pool` `<string>` ::
312 Add the VM to the specified pool.
314 `--protection` `<boolean>` ('default =' `0`)::
316 Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
318 `--reboot` `<boolean>` ('default =' `1`)::
320 Allow reboot. If set to '0' the VM exit on reboot.
322 `--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>]` ::
324 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
326 `--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>]` ::
328 Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
330 `--scsihw` `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
332 SCSI controller model
334 `--searchdomain` `<string>` ::
336 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.
338 `--serial[n]` `(/dev/.+|socket)` ::
340 Create a serial device inside the VM (n is 0 to 3)
342 `--shares` `<integer> (0 - 50000)` ('default =' `1000`)::
344 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.
346 `--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>]` ::
348 Specify SMBIOS type 1 fields.
350 `--smp` `<integer> (1 - N)` ('default =' `1`)::
352 The number of CPUs. Please use option -sockets instead.
354 `--sockets` `<integer> (1 - N)` ('default =' `1`)::
356 The number of CPU sockets.
358 `--spice_enhancements` `[foldersharing=<1|0>] [,videostreaming=<off|all|filter>]` ::
360 Configure additional enhancements for SPICE.
362 `--sshkeys` `<filepath>` ::
364 cloud-init: Setup public SSH keys (one key per line, OpenSSH format).
366 `--start` `<boolean>` ('default =' `0`)::
368 Start VM after it was created successfully.
370 `--startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
372 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'.
374 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
376 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.
378 `--storage` `<string>` ::
382 `--tablet` `<boolean>` ('default =' `1`)::
384 Enable/disable the USB tablet device.
386 `--tags` `<string>` ::
388 Tags of the VM. This is only meta information.
390 `--tdf` `<boolean>` ('default =' `0`)::
392 Enable/disable time drift fix.
394 `--template` `<boolean>` ('default =' `0`)::
396 Enable/disable Template.
398 `--unique` `<boolean>` ::
400 Assign a unique random ethernet address.
402 NOTE: Requires option(s): `archive`
404 `--unused[n]` `<string>` ::
406 Reference to unused volumes. This is used internally, and should not be modified manually.
408 `--usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
410 Configure an USB device (n is 0 to 4).
412 `--vcpus` `<integer> (1 - N)` ('default =' `0`)::
414 Number of hotplugged vcpus.
416 `--vga` `[[type=]<enum>] [,memory=<integer>]` ::
418 Configure the VGA hardware.
420 `--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>]` ::
422 Use volume as VIRTIO hard disk (n is 0 to 15).
424 `--vmgenid` `<UUID>` ('default =' `1 (autogenerated)`)::
426 Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly.
428 `--vmstatestorage` `<string>` ::
430 Default storage for VM state volumes/files.
432 `--watchdog` `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::
434 Create a virtual hardware watchdog device.
436 *qm delsnapshot* `<vmid> <snapname>` `[OPTIONS]`
438 Delete a VM snapshot.
440 `<vmid>`: `<integer> (1 - N)` ::
442 The (unique) ID of the VM.
444 `<snapname>`: `<string>` ::
446 The name of the snapshot.
448 `--force` `<boolean>` ::
450 For removal from config file, even if removing disk snapshots fails.
452 *qm destroy* `<vmid>` `[OPTIONS]`
454 Destroy the vm (also delete all used/owned volumes).
456 `<vmid>`: `<integer> (1 - N)` ::
458 The (unique) ID of the VM.
460 `--purge` `<boolean>` ::
462 Remove vmid from backup cron jobs.
464 `--skiplock` `<boolean>` ::
466 Ignore locks - only root is allowed to use this option.
468 *qm guest cmd* `<vmid> <command>`
470 Execute Qemu Guest Agent commands.
472 `<vmid>`: `<integer> (1 - N)` ::
474 The (unique) ID of the VM.
476 `<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>` ::
480 *qm guest exec* `<vmid> [<extra-args>]` `[OPTIONS]`
482 Executes the given command via the guest agent
484 `<vmid>`: `<integer> (1 - N)` ::
486 The (unique) ID of the VM.
488 `<extra-args>`: `<array>` ::
490 Extra arguments as array
492 `--synchronous` `<boolean>` ('default =' `1`)::
494 If set to off, returns the pid immediately instead of waiting for the commmand to finish or the timeout.
496 `--timeout` `<integer> (0 - N)` ('default =' `30`)::
498 The maximum time to wait synchronously for the command to finish. If reached, the pid gets returned. Set to 0 to deactivate
500 *qm guest exec-status* `<vmid> <pid>`
502 Gets the status of the given pid started by the guest-agent
504 `<vmid>`: `<integer> (1 - N)` ::
506 The (unique) ID of the VM.
508 `<pid>`: `<integer>` ::
512 *qm guest passwd* `<vmid> <username>` `[OPTIONS]`
514 Sets the password for the given user to the given password
516 `<vmid>`: `<integer> (1 - N)` ::
518 The (unique) ID of the VM.
520 `<username>`: `<string>` ::
522 The user to set the password for.
524 `--crypted` `<boolean>` ('default =' `0`)::
526 set to 1 if the password has already been passed through crypt()
528 *qm help* `[OPTIONS]`
530 Get help about specified command.
532 `--extra-args` `<array>` ::
534 Shows help for a specific command
536 `--verbose` `<boolean>` ::
538 Verbose output format.
540 *qm importdisk* `<vmid> <source> <storage>` `[OPTIONS]`
542 Import an external disk image as an unused disk in a VM. The
543 image format has to be supported by qemu-img(1).
545 `<vmid>`: `<integer> (1 - N)` ::
547 The (unique) ID of the VM.
549 `<source>`: `<string>` ::
551 Path to the disk image to import
553 `<storage>`: `<string>` ::
557 `--format` `<qcow2 | raw | vmdk>` ::
561 *qm importovf* `<vmid> <manifest> <storage>` `[OPTIONS]`
563 Create a new VM using parameters read from an OVF manifest
565 `<vmid>`: `<integer> (1 - N)` ::
567 The (unique) ID of the VM.
569 `<manifest>`: `<string>` ::
573 `<storage>`: `<string>` ::
577 `--dryrun` `<boolean>` ::
579 Print a parsed representation of the extracted OVF parameters, but do not create a VM
581 `--format` `<qcow2 | raw | vmdk>` ::
585 *qm list* `[OPTIONS]`
587 Virtual machine index (per node).
589 `--full` `<boolean>` ::
591 Determine the full status of active VMs.
593 *qm listsnapshot* `<vmid>`
597 `<vmid>`: `<integer> (1 - N)` ::
599 The (unique) ID of the VM.
601 *qm migrate* `<vmid> <target>` `[OPTIONS]`
603 Migrate virtual machine. Creates a new migration task.
605 `<vmid>`: `<integer> (1 - N)` ::
607 The (unique) ID of the VM.
609 `<target>`: `<string>` ::
613 `--bwlimit` `<integer> (0 - N)` ('default =' `migrate limit from datacenter or storage config`)::
615 Override I/O bandwidth limit (in KiB/s).
617 `--force` `<boolean>` ::
619 Allow to migrate VMs which use local devices. Only root may use this option.
621 `--migration_network` `<string>` ::
623 CIDR of the (sub) network that is used for migration.
625 `--migration_type` `<insecure | secure>` ::
627 Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.
629 `--online` `<boolean>` ::
631 Use online/live migration if VM is running. Ignored if VM is stopped.
633 `--targetstorage` `<string>` ::
635 Default target storage.
637 `--with-local-disks` `<boolean>` ::
639 Enable live storage migration for local disk
641 *qm monitor* `<vmid>`
643 Enter Qemu Monitor interface.
645 `<vmid>`: `<integer> (1 - N)` ::
647 The (unique) ID of the VM.
649 *qm move_disk* `<vmid> <disk> <storage>` `[OPTIONS]`
651 Move volume to different storage.
653 `<vmid>`: `<integer> (1 - N)` ::
655 The (unique) ID of the VM.
657 `<disk>`: `<efidisk0 | ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi2 | scsi3 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9>` ::
659 The disk you want to move.
661 `<storage>`: `<string>` ::
665 `--bwlimit` `<integer> (0 - N)` ('default =' `move limit from datacenter or storage config`)::
667 Override I/O bandwidth limit (in KiB/s).
669 `--delete` `<boolean>` ('default =' `0`)::
671 Delete the original disk after successful copy. By default the original disk is kept as unused disk.
673 `--digest` `<string>` ::
675 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
677 `--format` `<qcow2 | raw | vmdk>` ::
683 Used by qmigrate - do not use manually.
685 *qm nbdstop* `<vmid>`
687 Stop embedded nbd server.
689 `<vmid>`: `<integer> (1 - N)` ::
691 The (unique) ID of the VM.
693 *qm pending* `<vmid>`
695 Get virtual machine configuration, including pending changes.
697 `<vmid>`: `<integer> (1 - N)` ::
699 The (unique) ID of the VM.
701 *qm reboot* `<vmid>` `[OPTIONS]`
703 Reboot the VM by shutting it down, and starting it again. Applies pending
706 `<vmid>`: `<integer> (1 - N)` ::
708 The (unique) ID of the VM.
710 `--timeout` `<integer> (0 - N)` ::
712 Wait maximal timeout seconds for the shutdown.
714 *qm rescan* `[OPTIONS]`
716 Rescan all storages and update disk sizes and unused disk images.
718 `--dryrun` `<boolean>` ('default =' `0`)::
720 Do not actually write changes out to VM config(s).
722 `--vmid` `<integer> (1 - N)` ::
724 The (unique) ID of the VM.
726 *qm reset* `<vmid>` `[OPTIONS]`
728 Reset virtual machine.
730 `<vmid>`: `<integer> (1 - N)` ::
732 The (unique) ID of the VM.
734 `--skiplock` `<boolean>` ::
736 Ignore locks - only root is allowed to use this option.
738 *qm resize* `<vmid> <disk> <size>` `[OPTIONS]`
742 `<vmid>`: `<integer> (1 - N)` ::
744 The (unique) ID of the VM.
746 `<disk>`: `<efidisk0 | ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi2 | scsi3 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9>` ::
748 The disk you want to resize.
750 `<size>`: `\+?\d+(\.\d+)?[KMGT]?` ::
752 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.
754 `--digest` `<string>` ::
756 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
758 `--skiplock` `<boolean>` ::
760 Ignore locks - only root is allowed to use this option.
762 *qm resume* `<vmid>` `[OPTIONS]`
764 Resume virtual machine.
766 `<vmid>`: `<integer> (1 - N)` ::
768 The (unique) ID of the VM.
770 `--nocheck` `<boolean>` ::
772 no description available
774 `--skiplock` `<boolean>` ::
776 Ignore locks - only root is allowed to use this option.
778 *qm rollback* `<vmid> <snapname>`
780 Rollback VM state to specified snapshot.
782 `<vmid>`: `<integer> (1 - N)` ::
784 The (unique) ID of the VM.
786 `<snapname>`: `<string>` ::
788 The name of the snapshot.
790 *qm sendkey* `<vmid> <key>` `[OPTIONS]`
792 Send key event to virtual machine.
794 `<vmid>`: `<integer> (1 - N)` ::
796 The (unique) ID of the VM.
798 `<key>`: `<string>` ::
800 The key (qemu monitor encoding).
802 `--skiplock` `<boolean>` ::
804 Ignore locks - only root is allowed to use this option.
806 *qm set* `<vmid>` `[OPTIONS]`
808 Set virtual machine options (synchrounous API) - You should consider using
809 the POST method instead for any actions involving hotplug or storage
812 `<vmid>`: `<integer> (1 - N)` ::
814 The (unique) ID of the VM.
816 `--acpi` `<boolean>` ('default =' `1`)::
820 `--agent` `[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>] [,type=<virtio|isa>]` ::
822 Enable/disable Qemu GuestAgent and its properties.
824 `--arch` `<aarch64 | x86_64>` ::
826 Virtual processor architecture. Defaults to the host.
828 `--args` `<string>` ::
830 Arbitrary arguments passed to kvm.
832 `--audio0` `device=<ich9-intel-hda|intel-hda|AC97> [,driver=<spice>]` ::
834 Configure a audio device, useful in combination with QXL/Spice.
836 `--autostart` `<boolean>` ('default =' `0`)::
838 Automatic restart after crash (currently ignored).
840 `--balloon` `<integer> (0 - N)` ::
842 Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
844 `--bios` `<ovmf | seabios>` ('default =' `seabios`)::
846 Select BIOS implementation.
848 `--boot` `[acdn]{1,4}` ('default =' `cdn`)::
850 Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).
852 `--bootdisk` `(ide|sata|scsi|virtio)\d+` ::
854 Enable booting from specified disk.
856 `--cdrom` `<volume>` ::
858 This is an alias for option -ide2
860 `--cicustom` `[meta=<volume>] [,network=<volume>] [,user=<volume>]` ::
862 cloud-init: Specify custom files to replace the automatically generated ones at start.
864 `--cipassword` `<password>` ::
866 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.
868 `--citype` `<configdrive2 | nocloud>` ::
870 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.
872 `--ciuser` `<string>` ::
874 cloud-init: User name to change ssh keys and password for instead of the image's configured default user.
876 `--cores` `<integer> (1 - N)` ('default =' `1`)::
878 The number of cores per socket.
880 `--cpu` `[cputype=]<enum> [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=<vendor-id>]` ::
884 `--cpulimit` `<number> (0 - 128)` ('default =' `0`)::
888 `--cpuunits` `<integer> (2 - 262144)` ('default =' `1024`)::
892 `--delete` `<string>` ::
894 A list of settings you want to delete.
896 `--description` `<string>` ::
898 Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.
900 `--digest` `<string>` ::
902 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
904 `--efidisk0` `[file=]<volume> [,format=<enum>] [,size=<DiskSize>]` ::
906 Configure a Disk for storing EFI vars
908 `--force` `<boolean>` ::
910 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.
912 NOTE: Requires option(s): `delete`
914 `--freeze` `<boolean>` ::
916 Freeze CPU at startup (use 'c' monitor command to start execution).
918 `--hookscript` `<string>` ::
920 Script that will be executed during various steps in the vms lifetime.
922 `--hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
924 Map host PCI devices into guest.
926 `--hotplug` `<string>` ('default =' `network,disk,usb`)::
928 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'.
930 `--hugepages` `<1024 | 2 | any>` ::
932 Enable/disable hugepages memory.
934 `--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>]` ::
936 Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
938 `--ipconfig[n]` `[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]` ::
940 cloud-init: Specify IP addresses and gateways for the corresponding interface.
942 IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.
944 The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided.
945 For IPv6 the special string 'auto' can be used to use stateless autoconfiguration.
947 If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4.
949 `--ivshmem` `size=<integer> [,name=<string>]` ::
951 Inter-VM shared memory. Useful for direct communication between VMs, or to the host.
953 `--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>` ::
955 Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg' configuration file.It should not be necessary to set it.
957 `--kvm` `<boolean>` ('default =' `1`)::
959 Enable/disable KVM hardware virtualization.
961 `--localtime` `<boolean>` ::
963 Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
965 `--lock` `<backup | clone | create | migrate | rollback | snapshot | snapshot-delete | suspended | suspending>` ::
969 `--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` ::
971 Specifies the Qemu machine type.
973 `--memory` `<integer> (16 - N)` ('default =' `512`)::
975 Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
977 `--migrate_downtime` `<number> (0 - N)` ('default =' `0.1`)::
979 Set maximum tolerated downtime (in seconds) for migrations.
981 `--migrate_speed` `<integer> (0 - N)` ('default =' `0`)::
983 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
985 `--name` `<string>` ::
987 Set a name for the VM. Only used on the configuration web interface.
989 `--nameserver` `<string>` ::
991 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.
993 `--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>]` ::
995 Specify network devices.
997 `--numa` `<boolean>` ('default =' `0`)::
1001 `--numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
1005 `--onboot` `<boolean>` ('default =' `0`)::
1007 Specifies whether a VM will be started during system bootup.
1009 `--ostype` `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win7 | win8 | wvista | wxp>` ::
1011 Specify guest operating system.
1013 `--parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` ::
1015 Map host parallel devices (n is 0 to 2).
1017 `--protection` `<boolean>` ('default =' `0`)::
1019 Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
1021 `--reboot` `<boolean>` ('default =' `1`)::
1023 Allow reboot. If set to '0' the VM exit on reboot.
1025 `--revert` `<string>` ::
1027 Revert a pending change.
1029 `--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>]` ::
1031 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
1033 `--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>]` ::
1035 Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
1037 `--scsihw` `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
1039 SCSI controller model
1041 `--searchdomain` `<string>` ::
1043 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.
1045 `--serial[n]` `(/dev/.+|socket)` ::
1047 Create a serial device inside the VM (n is 0 to 3)
1049 `--shares` `<integer> (0 - 50000)` ('default =' `1000`)::
1051 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.
1053 `--skiplock` `<boolean>` ::
1055 Ignore locks - only root is allowed to use this option.
1057 `--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>]` ::
1059 Specify SMBIOS type 1 fields.
1061 `--smp` `<integer> (1 - N)` ('default =' `1`)::
1063 The number of CPUs. Please use option -sockets instead.
1065 `--sockets` `<integer> (1 - N)` ('default =' `1`)::
1067 The number of CPU sockets.
1069 `--spice_enhancements` `[foldersharing=<1|0>] [,videostreaming=<off|all|filter>]` ::
1071 Configure additional enhancements for SPICE.
1073 `--sshkeys` `<filepath>` ::
1075 cloud-init: Setup public SSH keys (one key per line, OpenSSH format).
1077 `--startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
1079 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'.
1081 `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
1083 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.
1085 `--tablet` `<boolean>` ('default =' `1`)::
1087 Enable/disable the USB tablet device.
1089 `--tags` `<string>` ::
1091 Tags of the VM. This is only meta information.
1093 `--tdf` `<boolean>` ('default =' `0`)::
1095 Enable/disable time drift fix.
1097 `--template` `<boolean>` ('default =' `0`)::
1099 Enable/disable Template.
1101 `--unused[n]` `<string>` ::
1103 Reference to unused volumes. This is used internally, and should not be modified manually.
1105 `--usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
1107 Configure an USB device (n is 0 to 4).
1109 `--vcpus` `<integer> (1 - N)` ('default =' `0`)::
1111 Number of hotplugged vcpus.
1113 `--vga` `[[type=]<enum>] [,memory=<integer>]` ::
1115 Configure the VGA hardware.
1117 `--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>]` ::
1119 Use volume as VIRTIO hard disk (n is 0 to 15).
1121 `--vmgenid` `<UUID>` ('default =' `1 (autogenerated)`)::
1123 Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly.
1125 `--vmstatestorage` `<string>` ::
1127 Default storage for VM state volumes/files.
1129 `--watchdog` `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::
1131 Create a virtual hardware watchdog device.
1133 *qm showcmd* `<vmid>` `[OPTIONS]`
1135 Show command line which is used to start the VM (debug info).
1137 `<vmid>`: `<integer> (1 - N)` ::
1139 The (unique) ID of the VM.
1141 `--pretty` `<boolean>` ('default =' `0`)::
1143 Puts each option on a new line to enhance human readability
1145 `--snapshot` `<string>` ::
1147 Fetch config values from given snapshot.
1149 *qm shutdown* `<vmid>` `[OPTIONS]`
1151 Shutdown virtual machine. This is similar to pressing the power button on a
1152 physical machine.This will send an ACPI event for the guest OS, which
1153 should then proceed to a clean shutdown.
1155 `<vmid>`: `<integer> (1 - N)` ::
1157 The (unique) ID of the VM.
1159 `--forceStop` `<boolean>` ('default =' `0`)::
1161 Make sure the VM stops.
1163 `--keepActive` `<boolean>` ('default =' `0`)::
1165 Do not deactivate storage volumes.
1167 `--skiplock` `<boolean>` ::
1169 Ignore locks - only root is allowed to use this option.
1171 `--timeout` `<integer> (0 - N)` ::
1173 Wait maximal timeout seconds.
1175 *qm snapshot* `<vmid> <snapname>` `[OPTIONS]`
1179 `<vmid>`: `<integer> (1 - N)` ::
1181 The (unique) ID of the VM.
1183 `<snapname>`: `<string>` ::
1185 The name of the snapshot.
1187 `--description` `<string>` ::
1189 A textual description or comment.
1191 `--vmstate` `<boolean>` ::
1195 *qm start* `<vmid>` `[OPTIONS]`
1197 Start virtual machine.
1199 `<vmid>`: `<integer> (1 - N)` ::
1201 The (unique) ID of the VM.
1203 `--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` ::
1205 Specifies the Qemu machine type.
1207 `--migratedfrom` `<string>` ::
1209 The cluster node name.
1211 `--migration_network` `<string>` ::
1213 CIDR of the (sub) network that is used for migration.
1215 `--migration_type` `<insecure | secure>` ::
1217 Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.
1219 `--skiplock` `<boolean>` ::
1221 Ignore locks - only root is allowed to use this option.
1223 `--stateuri` `<string>` ::
1225 Some command save/restore state from this location.
1227 `--targetstorage` `<string>` ::
1229 Target storage for the migration. (Can be '1' to use the same storage id as on the source node.)
1231 *qm status* `<vmid>` `[OPTIONS]`
1235 `<vmid>`: `<integer> (1 - N)` ::
1237 The (unique) ID of the VM.
1239 `--verbose` `<boolean>` ::
1241 Verbose output format
1243 *qm stop* `<vmid>` `[OPTIONS]`
1245 Stop virtual machine. The qemu process will exit immediately. Thisis akin
1246 to pulling the power plug of a running computer and may damage the VM data
1248 `<vmid>`: `<integer> (1 - N)` ::
1250 The (unique) ID of the VM.
1252 `--keepActive` `<boolean>` ('default =' `0`)::
1254 Do not deactivate storage volumes.
1256 `--migratedfrom` `<string>` ::
1258 The cluster node name.
1260 `--skiplock` `<boolean>` ::
1262 Ignore locks - only root is allowed to use this option.
1264 `--timeout` `<integer> (0 - N)` ::
1266 Wait maximal timeout seconds.
1268 *qm suspend* `<vmid>` `[OPTIONS]`
1270 Suspend virtual machine.
1272 `<vmid>`: `<integer> (1 - N)` ::
1274 The (unique) ID of the VM.
1276 `--skiplock` `<boolean>` ::
1278 Ignore locks - only root is allowed to use this option.
1280 `--statestorage` `<string>` ::
1282 The storage for the VM state
1284 NOTE: Requires option(s): `todisk`
1286 `--todisk` `<boolean>` ('default =' `0`)::
1288 If set, suspends the VM to disk. Will be resumed on next VM start.
1290 *qm template* `<vmid>` `[OPTIONS]`
1294 `<vmid>`: `<integer> (1 - N)` ::
1296 The (unique) ID of the VM.
1298 `--disk` `<efidisk0 | ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi2 | scsi3 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9>` ::
1300 If you want to convert only 1 disk to base image.
1302 *qm terminal* `<vmid>` `[OPTIONS]`
1304 Open a terminal using a serial device (The VM need to have a serial device
1305 configured, for example 'serial0: socket')
1307 `<vmid>`: `<integer> (1 - N)` ::
1309 The (unique) ID of the VM.
1311 `--escape` `<string>` ('default =' `^O`)::
1315 `--iface` `<serial0 | serial1 | serial2 | serial3>` ::
1317 Select the serial device. By default we simply use the first suitable device.
1319 *qm unlink* `<vmid> --idlist <string>` `[OPTIONS]`
1321 Unlink/delete disk images.
1323 `<vmid>`: `<integer> (1 - N)` ::
1325 The (unique) ID of the VM.
1327 `--force` `<boolean>` ::
1329 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.
1331 `--idlist` `<string>` ::
1333 A list of disk IDs you want to delete.
1335 *qm unlock* `<vmid>`
1339 `<vmid>`: `<integer> (1 - N)` ::
1341 The (unique) ID of the VM.
1343 *qm vncproxy* `<vmid>`
1345 Proxy VM VNC traffic to stdin/stdout
1347 `<vmid>`: `<integer> (1 - N)` ::
1349 The (unique) ID of the VM.
1351 *qm wait* `<vmid>` `[OPTIONS]`
1353 Wait until the VM is stopped.
1355 `<vmid>`: `<integer> (1 - N)` ::
1357 The (unique) ID of the VM.
1359 `--timeout` `<integer> (1 - N)` ::
1361 Timeout in seconds. Default is to wait forever.