pvesh

List available nodes

$ pvesh get /nodes

$ pvesh get /nodes/[node_name]/[lxc|qemu]

$ pvesh ls /

$ pvesh usage /pools

$ pvesh create /storage --storage [storage_id] --vgname [volume_group] --type lvmthin --thinpool [thinpool_name] --content [content_types]

pvesh command path [options]

pvesh provides direct command-line access to the Proxmox VE REST API. It allows querying and modifying all cluster resources including nodes, VMs, containers, storage, and users. This is useful for scripting and automation tasks.
The tool mirrors the web interface's capabilities, enabling administrators to perform any operation available through the GUI from the command line or scripts.

get, g

Retrieve data from API path

List available subpaths

Show usage information for API path

Create new resource at API path

Modify existing resource

Remove resource at API path

Output format (text, json, json-pretty)

Requires root privileges or appropriate Proxmox permissions. API paths match the web interface structure. Complex operations may require multiple API calls.

Part of Proxmox VE, providing CLI access to the same API used by the web interface. Essential for automation, scripting, and headless administration of Proxmox clusters.

qm(1), pct(1), pvesm(1), pveum(1)