qm-help

Display help for a specific command

$ qm help [command]

$ qm help [command] --verbose [true|false]

qm [OPTIONS]

create [OPTIONS]
    Create a new VM or container.

destroy [OPTIONS]
    Destroy/delete a VM or container.

start [OPTIONS]
    Start a VM or container.

stop [OPTIONS]
    Stop a VM or container.

shutdown [OPTIONS]
    Gracefully shut down a VM or container.

reset [OPTIONS]
    Reset a VM or container (forceful poweroff).

migrate [OPTIONS]
    Migrate a VM or container to another node.

clone [OPTIONS]
    Clone a VM or container.

snapshot [OPTIONS]
    Create a snapshot of a VM or container.

rollback [OPTIONS]
    Rollback a VM or container to a snapshot.

backup [OPTIONS]
    Create a backup of a VM or container.

restore [OPTIONS]
    Restore a VM or container from a backup file.

config [OPTIONS]
    Show or modify the configuration of a VM or container.

status [OPTIONS]
    Show the status of a VM or container.

--help
    Display help for a specific command.

The qm command is the primary command-line tool for managing virtual machines and containers within a Proxmox Virtual Environment (PVE) cluster. It provides a comprehensive interface for creating, configuring, starting, stopping, migrating, backing up, and restoring VMs and containers.

Using qm, you can interact with the PVE API to perform a wide range of administrative tasks, including resource allocation (CPU, memory, disk), network configuration, snapshot management, and user access control.

It is a crucial utility for automating PVE management tasks, scripting deployments, and integrating with other infrastructure management tools. Understanding the various options and subcommands of qm is essential for effectively managing a PVE environment.

Many qm subcommands require root privileges. Configuration changes can potentially cause system instability or data loss if not done carefully. Always refer to the Proxmox VE documentation for detailed information on each option.

The qm command enables fine-grained control over resource allocation for VMs and containers. Options allow adjustment of CPU cores, RAM, disk space, and network interfaces. Careful resource management is essential for optimizing performance and preventing resource contention in a virtualized environment.

pct(1), pvesh(1)