Proxmox VM List

An Obsidian plugin that connects to the Proxmox VE API and generates a Markdown note with an inventory of all virtual machines and LXC containers in your host or cluster.

Features

• Fetches all QEMU VMs and LXC containers from every node in the cluster with a single command (command palette or ribbon icon).
• Generates a Markdown table with: VMID, name, type (VM/CT), host node, running status, CPU count, RAM, every disk with its size, operating system, and the VM notes/description field (handy if you use it for tags).
• Marks templates (📄) and shows running (🟢) / stopped (⚪) status at a glance.
• Supports API token authentication (recommended) or username + password.
• Works with the default self-signed Proxmox certificate (TLS verification is optional).
• Configurable destination folder and note name; the note is regenerated on every update.

Configuration

A Test connection button verifies credentials against the server before you fetch anything.

Creating an API token in Proxmox

1. Datacenter → Permissions → API Tokens → Add.
2. Pick the user (e.g. root@pam), set a Token ID (e.g. obsidian).
3. Copy the secret shown once at creation into the plugin settings.
4. The plugin only needs read access: the PVEAuditor role is sufficient. If the token uses Privilege Separation, grant the role to the token itself (Datacenter → Permissions → Add → API Token Permission, path /, role PVEAuditor).

Security notes

• Credentials are stored in plain text in the plugin's data.json, like most Obsidian plugin settings. Use a dedicated read-only (PVEAuditor) API token rather than a password.
• If your vault is synced or version-controlled, exclude .obsidian/plugins/proxmox-vm-list/data.json.
• The plugin talks to the Proxmox API directly over HTTPS using Node's https module (hence desktop-only). This is deliberate: Proxmox hosts typically use self-signed certificates, which requestUrl cannot be configured to accept.

Installation

Until the plugin is available in the community catalog, install it manually: copy main.js and manifest.json into <vault>/.obsidian/plugins/proxmox-vm-list/ and enable it in Settings → Community plugins, or use BRAT.

License

MIT