commands.sh

qm

linux

QEMU/KVM Virtual Machine Manager. Some subcommands such as `list`, `start`, `stop`, `clone`, etc. have their own usage documentation.

More info →

Subcommands (41)

qm agent

This command is an alias of `qm guest cmd`.

→
qm cleanup

Clean up resources on QEMU/KVM Virtual Machine Manager like tap devices, VGPUs, etc. Called after a VM shuts down, crashes, etc.

→
qm clone

Create a copy of virtual machine on QEMU/KVM Virtual Machine Manager.

→
qm cloudinit

Manage Cloud-Init settings.

→
qm config

Display the virtual machine configuration with pending configuration changes applied.

→
qm create

Create or restore a virtual machine on QEMU/KVM Virtual Machine Manager.

→
qm delsnapshot

Delete virtual machine snapshots.

→
qm destroy

Destroy a virtual machine in QEMU/KVM Virtual Machine Manager.

→
qm disk

Manage disk images.

→
qm guest

Manage a VM guest agent.

→
qm help

Display help for a command.

→
qm importdisk

This command is an alias of `qm disk import`.

→
qm list

List all virtual machines.

→
qm listsnapshot

List snapshots of virtual machines.

→
qm migrate

Migrate a virtual machine. Used to create a new migration task.

→
qm monitor

Enter the QEMU Monitor interface.

→
qm move_disk

This command is an alias of `qm disk move`.

→
qm mtunnel

Used by `qmigrate`. It should not be invoked manually.

→
qm nbdstop

Stop embedded nbd server.

→
qm pending

Get the virtual machine configuration with both current and pending values.

→
qm reboot

Reboot a virtual machine by shutting it down, and starting it again after applying pending changes.

→
qm rescan

This command is an alias of `qm disk rescan`.

→
qm reset

Reset a virtual machine on QEMU/KVM Virtual Machine Manager.

→
qm resize

This command is an alias of `qm disk resize`.

→
qm resume

Resume a virtual machine.

→
qm rollback

Rollback the VM state to a specified snapshot.

→
qm sendkey

Send QEMU monitor encoding key event to a virtual machine.

→
qm set

Set virtual machine options.

→
qm showcmd

Show command-line which is used to start the VM (debug info).

→
qm shutdown

Shutdown a virtual machine on QEMU/KVM Virtual Machine Manager.

→
qm snapshot

Create virtual machine snapshots.

→
qm start

Start a virtual machine on QEMU/KVM Virtual Machine Manager.

→
qm status

Show virtual machine status.

→
qm stop

Stop a virtual machine.

→
qm suspend

Suspend a virtual machine (VM) in the Proxmox Virtual Environment (PVE). Use `--skiplock` and `--skiplockstorage` flags with caution, as they may lead to data corruption in certain situations.

→
qm template

Create a Proxmox VM template.

→
qm terminal

Attach to the serial console of a VM.

→
qm unlink

This command is an alias of `qm disk unlink`.

→
qm unlock

Unlock a virtual machine in QEMU/KVM Virtual Machine Manager.

→
qm vncproxy

Proxy Virtual Machine VNC (Virtual network computing) traffic to `stdin` or `stdout`.

→
qm wait

Wait until the virtual machine is stopped.

→

Options (5)

boolean

Using an ISO file uploaded on the local storage, create a virtual machine with a 4 GB SCSI disk on the `local-lvm` storage and an ID of 100

Example: qm {{[cr|create]}} {{100}} --scsi0 {{local-lvm:4}} --net0 {{e1000}} --cdrom {{local:iso/proxmox-mailgateway_2.1.iso}}
boolean

Show the configuration of a virtual machine, specifying its ID

Example: qm {{[co|config]}} {{100}}
boolean

Send a shutdown request, then wait until the virtual machine is stopped

Example: qm {{[shu|shutdown]}} {{100}} && qm {{[w|wait]}} {{100}}
boolean

Send a shutdown request, then wait until the virtual machine is stopped

Example: qm {{[shu|shutdown]}} {{100}} && qm {{[w|wait]}} {{100}}
boolean

Destroy a virtual machine and remove all related resources

Example: qm {{[des|destroy]}} {{100}} --purge

Examples (6)

List all virtual machines

Using an ISO file uploaded on the local storage, create a virtual machine with a 4 GB SCSI disk on the `local-lvm` storage and an ID of 100

qm [cr|create] 100 --scsi0 local-lvm:4 --net0 e1000 --cdrom local:iso/proxmox-mailgateway_2.1.iso

Show the configuration of a virtual machine, specifying its ID

qm [co|config] 100

Start a specific virtual machine

Send a shutdown request, then wait until the virtual machine is stopped

qm [shu|shutdown] 100 && qm [w|wait] 100

Destroy a virtual machine and remove all related resources

qm [des|destroy] 100 --purge
made by @shridhargupta | data from tldr-pages