Cleans up resources like tap devices, vgpus, etc. Called after a vm shuts
down, crashes, etc.
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
Create a copy of virtual machine/template.
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
-`<newid>`: `<integer> (1 - N)` ::
+`<newid>`: `<integer> (100 - 999999999)` ::
VMID for the clone.
Get automatically generated cloudinit config.
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
Get the cloudinit configuration with both current and pending values.
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
Regenerate and change cloudinit config drive.
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
applied. Set the 'current' parameter to get the current configuration
instead.
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
Create or restore a virtual machine.
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
List of host cores used to execute guest processes, for example: 0,5,8-11
-`--agent` `[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>] [,type=<virtio|isa>]` ::
+`--agent` `[enabled=]<1|0> [,freeze-fs-on-backup=<1|0>] [,fstrim_cloned_disks=<1|0>] [,type=<virtio|isa>]` ::
-Enable/disable communication with the Qemu Guest Agent and its properties.
+Enable/disable communication with the QEMU Guest Agent and its properties.
`--arch` `<aarch64 | x86_64>` ::
`--balloon` `<integer> (0 - N)` ::
-Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
+Amount of target RAM for the VM in MiB. Using zero disables the ballon driver.
`--bios` `<ovmf | seabios>` ('default =' `seabios`)::
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.
+`--ciupgrade` `<boolean>` ::
+
+cloud-init: do an automatic package upgrade after the first boot.
+
`--ciuser` `<string>` ::
cloud-init: User name to change ssh keys and password for instead of the image's configured default user.
`--efidisk0` `[file=]<volume> [,efitype=<2m|4m>] [,format=<enum>] [,import-from=<source volume>] [,pre-enrolled-keys=<1|0>] [,size=<DiskSize>]` ::
-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. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume.
+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. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume.
`--force` `<boolean>` ::
`--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` ::
-Specifies the Qemu machine type.
+Specifies the QEMU machine type.
`--memory` `<integer> (16 - N)` ('default =' `512`)::
-Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
+Amount of RAM for the VM in MiB. This is the maximum available memory when you use the balloon device.
`--migrate_downtime` `<number> (0 - N)` ('default =' `0.1`)::
Delete a VM snapshot.
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
Destroy the VM and all used/owned volumes. Removes any VM specific
permissions and firewall rules
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
Import an external disk image as an unused disk in a VM. The
image format has to be supported by qemu-img(1).
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
Move volume to different storage or to a different VM.
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
The config key the disk will be moved to on the target VM (for example, ide0 or scsi1). Default is the source disk key.
-`--target-vmid` `<integer> (1 - N)` ::
+`--target-vmid` `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
Do not actually write changes out to VM config(s).
-`--vmid` `<integer> (1 - N)` ::
+`--vmid` `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
Extend volume size.
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
Unlink/delete disk images.
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
*qm guest cmd* `<vmid> <command>`
-Execute Qemu Guest Agent commands.
+Execute QEMU Guest Agent commands.
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
Executes the given command via the guest agent
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
Gets the status of the given pid started by the guest-agent
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
Sets the password for the given user to the given password
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
Create a new VM using parameters read from an OVF manifest
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
List all snapshots.
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
Migrate virtual machine. Creates a new migration task.
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
*qm monitor* `<vmid>`
-Enter Qemu Monitor interface.
+Enter QEMU Monitor interface.
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
Stop embedded nbd server.
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
Get the virtual machine configuration with both current and pending values.
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
Reboot the VM by shutting it down, and starting it again. Applies pending
changes.
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
Migrate virtual machine to a remote cluster. Creates a new migration task.
EXPERIMENTAL feature!
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
-`<target-vmid>`: `<integer> (1 - N)` ::
+`<target-vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
Reset virtual machine.
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
Resume virtual machine.
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
Rollback VM state to specified snapshot.
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
`--start` `<boolean>` ('default =' `0`)::
-Whether the VM should get started after rolling back successfully
+Whether the VM should get started after rolling back successfully. (Note: VMs will be automatically started if the snapshot includes RAM.)
*qm sendkey* `<vmid> <key>` `[OPTIONS]`
Send key event to virtual machine.
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
the POST method instead for any actions involving hotplug or storage
allocation.
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
List of host cores used to execute guest processes, for example: 0,5,8-11
-`--agent` `[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>] [,type=<virtio|isa>]` ::
+`--agent` `[enabled=]<1|0> [,freeze-fs-on-backup=<1|0>] [,fstrim_cloned_disks=<1|0>] [,type=<virtio|isa>]` ::
-Enable/disable communication with the Qemu Guest Agent and its properties.
+Enable/disable communication with the QEMU Guest Agent and its properties.
`--arch` `<aarch64 | x86_64>` ::
`--balloon` `<integer> (0 - N)` ::
-Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
+Amount of target RAM for the VM in MiB. Using zero disables the ballon driver.
`--bios` `<ovmf | seabios>` ('default =' `seabios`)::
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.
+`--ciupgrade` `<boolean>` ::
+
+cloud-init: do an automatic package upgrade after the first boot.
+
`--ciuser` `<string>` ::
cloud-init: User name to change ssh keys and password for instead of the image's configured default user.
`--efidisk0` `[file=]<volume> [,efitype=<2m|4m>] [,format=<enum>] [,import-from=<source volume>] [,pre-enrolled-keys=<1|0>] [,size=<DiskSize>]` ::
-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. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume.
+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. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume.
`--force` `<boolean>` ::
`--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` ::
-Specifies the Qemu machine type.
+Specifies the QEMU machine type.
`--memory` `<integer> (16 - N)` ('default =' `512`)::
-Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
+Amount of RAM for the VM in MiB. This is the maximum available memory when you use the balloon device.
`--migrate_downtime` `<number> (0 - N)` ('default =' `0.1`)::
Show command line which is used to start the VM (debug info).
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
physical machine.This will send an ACPI event for the guest OS, which
should then proceed to a clean shutdown.
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
Snapshot a VM.
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
Start virtual machine.
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
`--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` ::
-Specifies the Qemu machine type.
+Specifies the QEMU machine type.
`--migratedfrom` `<string>` ::
Show VM status.
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
Stop virtual machine. The qemu process will exit immediately. Thisis akin
to pulling the power plug of a running computer and may damage the VM data
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
Suspend virtual machine.
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
Create a Template.
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
Open a terminal using a serial device (The VM need to have a serial device
configured, for example 'serial0: socket')
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
Unlock the VM.
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
Proxy VM VNC traffic to stdin/stdout
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
Wait until the VM is stopped.
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.