Ls¶
proxmox ls --help¶
Input:
Output:
Usage: proxmox ls [OPTIONS] PATH
List child resources at a given API path.
Fetches a collection from the API endpoint and displays the results
with optional sorting, filtering, pagination, and format selection.
Filtering syntax:
- field=value : Exact match
- field~substring : Case-insensitive substring match
Examples:
# List all nodes
proxmox ls /nodes
# List VMs on a node
proxmox ls /nodes/pve1/qemu
# List with specific columns
proxmox ls /nodes/pve1/qemu --columns vmid,name,status
# Sort and limit results
proxmox ls /nodes/pve1/qemu --sort name --reverse --limit 10
# Filter running VMs and display as table
proxmox ls /nodes/pve1/qemu --filter status=running --output table
# Pagination (skip first 20, get 10)
proxmox ls /nodes/pve1/qemu --offset 20 --limit 10
# Watch mode (refresh every 5 seconds)
proxmox ls /nodes/pve1/qemu --watch 5
# Get storage list as JSON
proxmox ls /storage --json
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * path TEXT API path to list [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --columns -c TEXT Comma-separated columns to display │
│ --sort TEXT Field to sort by │
│ --reverse -r Sort in reverse order │
│ --limit -l INTEGER Maximum number of results to return │
│ --offset INTEGER Number of results to skip (for pagination) │
│ --filter -f TEXT Filter results (field=value or field~substring) │
│ --watch -w INTEGER Refresh every N seconds (Ctrl+C to stop) │
│ --output -o TEXT Output format (human, json, yaml, markdown, │
│ table, text, raw) │
│ --json Shortcut for --output json │
│ --yaml Shortcut for --output yaml │
│ --markdown Shortcut for --output markdown │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.227