LinuxCommandLibrary

qm-config

Manage configuration for Proxmox VE guests

TLDR

Display the virtual machine configuration

$ qm [[co|config]] [vm_id]
copy

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

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

SYNOPSIS

qm-config <vmid> [OPTIONS]

PARAMETERS

vmid
    The unique ID (integer) of the virtual machine whose configuration is to be displayed.

--full
    Display the full configuration, including default values that are not explicitly set in the VM's configuration file.

--type <type>
    Show only configuration properties of a specific type, such as 'net' for network interfaces, 'disk' for storage devices, 'cpu', 'memory', or 'boot'.

--raw
    Output the raw configuration data. This format is typically less human-readable but can be useful for scripting or internal system analysis.

--pretty
    Format the output for better human readability. This is often the default behavior when not specifying --raw.

--quiet
    Suppress error messages for non-existent VMIDs or other non-critical issues, useful in scripts.

DESCRIPTION

qm-config is a utility within the Proxmox VE ecosystem designed to display the current configuration settings of a specific QEMU/KVM virtual machine. It retrieves and formats various parameters such as CPU, memory, network interfaces, disk drives, boot order, and other hardware or system-level settings associated with a VM identified by its unique ID (VMID). This command is crucial for administrators to quickly review, troubleshoot, or verify a VM's setup without needing to access the Proxmox web interface or configuration files directly. It provides a human-readable output, which can be further refined using various options to show full details, specific sections, or raw data.

CAVEATS

This command is specific to Proxmox Virtual Environment (PVE) installations and is not a general Linux utility found on standard distributions. It requires a Proxmox VE environment to function correctly. The command's functionality and options are tightly coupled with the Proxmox VM management system.

OUTPUT FORMAT

By default, qm-config outputs configuration in a clear, human-readable key-value pair format. When using the --raw option, the output is often a direct dump of the internal configuration, which might be less structured but valuable for advanced debugging or programmatic parsing.

VMID REQUIREMENT

A valid VMID is mandatory for qm-config to operate. Without a valid and existing virtual machine identifier, the command will return an error indicating a missing or invalid virtual machine.

HISTORY

qm-config is an integral part of the Proxmox Virtual Environment (PVE) management toolset, developed by Proxmox Server Solutions GmbH. It emerged as part of the qm (QEMU/KVM manager) utility to provide command-line access to VM configurations, complementing the robust web-based user interface. Its development has mirrored the evolution of Proxmox VE itself, focusing on robust and user-friendly server virtualization management capabilities.

SEE ALSO

qm(1), pct(1), pve-manager(1)

Copied to clipboard