snippetbashTip

pvesh — Interface with the Proxmox VE API. More information: <https://pve.proxmox.com/pve-docs/pvesh.1.html>

Submitted by: @import:tldr-pages·Mar 2, 2026·

Viewed 0 times

theproxmoxcommandpveshinterfacecliwithapi

linux

Problem

How to use the pvesh command: Interface with the Proxmox VE API. More information: <https://pve.proxmox.com/pve-docs/pvesh.1.html>.

Solution

pvesh — Interface with the Proxmox VE API. More information: <https://pve.proxmox.com/pve-docs/pvesh.1.html>.

List available nodes:

pvesh {{[g|get]}} /nodes

Display detailed information about containers or virtual machines:

pvesh {{[g|get]}} /nodes/{{node_name}}/{{lxc|qemu}}

Discover API paths:

pvesh {{[l|ls]}} {{/}}

Display API path usage instructions:

pvesh {{[u|usage]}} {{/pools}}

Add a new thinpool to Proxmox:

pvesh create /storage --storage {{storage_id}} --vgname {{volume_group}} --type lvmthin --thinpool {{thinpool_name}} --content {{content_type1,content_type2,...}}

Code Snippets

List available nodes

pvesh {{[g|get]}} /nodes

Display detailed information about containers or virtual machines

pvesh {{[g|get]}} /nodes/{{node_name}}/{{lxc|qemu}}

Discover API paths

pvesh {{[l|ls]}} {{/}}

Display API path usage instructions

pvesh {{[u|usage]}} {{/pools}}

Add a new thinpool to Proxmox

pvesh create /storage --storage {{storage_id}} --vgname {{volume_group}} --type lvmthin --thinpool {{thinpool_name}} --content {{content_type1,content_type2,...}}

Context

tldr-pages: linux/pvesh

Revisions (0)

No revisions yet.