LinuxCommandLibrary

qm-config

Manage configuration for Proxmox VE guests

TLDR

Display the virtual machine configuration

$ qm config [vm_id]
copy

Display the current configuration values instead of pending values for the virtual machine
$ qm config --current [true] [vm_id]
copy

Fetch the configuration values from the given snapshot
$ qm config --snapshot [snapshot_name] [vm_id]
copy

SYNOPSIS

qm config [OPTIONS]

PARAMETERS

vmid
    The unique numerical ID of the virtual machine or container to configure.

--agent
    Enable or disable the QEMU Guest Agent.

--arch
    Set the CPU architecture. Common values are 'x86_64' and 'aarch64'.

--balloon
    Set the maximum memory balloon size (in MB).

--bios
    Select BIOS implementation ('seabios', 'ovmf').

--boot
    Boot order string (e.g., 'order=disk,net0').

--bootdisk
    Specify the disk to boot from.

--cores
    Number of CPU cores assigned to the VM/container.

--cpulimit
    CPU limit (percentage).

--cpuunits
    CPU weight (relative share).

--description
    VM description.

--disk =:[,options]
    Add or modify a virtual disk.

--efidisk :[,options]
    Create an EFI disk (for OVMF BIOS).

--hookscript :
    Hook script that will be executed during the VM's life cycle.

--ide :[,options]
    Add or modify an IDE disk.

--kvm
    Enable or disable KVM hardware virtualization.

--lock
    Lock the VM configuration (e.g., 'backup', 'migrate').

--memory
    Amount of memory assigned to the VM (in MB).

--name
    VM name.

--net =,[options]
    Add or modify a network interface.

--numa
    Enable or disable NUMA.

--onboot
    Start the VM on boot.

--ostype
    Guest operating system type (e.g., 'l26', 'win10').

--protection
    Enable or disable VM protection.

--scsi :[,options]
    Add or modify a SCSI disk.

--serial
    Add or modify a serial port.

--sockets
    Number of CPU sockets.

--startup
    Startup order (e.g., 'up=10,down=20').

--tags
    Add VM tags (comma separated).

--template
    Mark the VM as a template.

--vga
    Set VGA configuration.

--virtio :[,options]
    Add or modify a VirtIO disk.

DESCRIPTION

The `qm config` command is a crucial part of the Proxmox Virtual Environment (Proxmox VE) suite, a powerful open-source server virtualization management platform. It allows you to view and manipulate the configuration of individual virtual machines (VMs) and containers (LXCs). This includes modifying resource allocation (CPU cores, memory), networking parameters, storage configurations, boot options, and other critical settings.

By using `qm config`, you gain fine-grained control over your virtualized environments, enabling you to optimize performance, enhance security, and tailor your infrastructure to specific workload requirements. The command operates on configuration files that define each VM or container's characteristics. It is important to use this command with caution, as incorrect modifications can lead to VM/container instability or failure. Refer to Proxmox VE documentation for specific details and valid configurations.

CAVEATS

Incorrect configuration can lead to VM/container instability or failure.
Always consult the Proxmox VE documentation for specific details on options and valid configurations.

STORAGE OPTIONS

The storage parameter is used to specify where the virtual disks are stored. Available storage options depend on the configured storage types in Proxmox VE, such as local LVM, ZFS, Ceph, NFS, etc.

NETWORKING CONFIGURATION

The networking configuration utilizes the `net` parameter, enabling you to create and configure virtual network interfaces. Common driver types include `virtio` and `e1000`.

SEE ALSO

qm(1), pct(1)

Copied to clipboard