Proxmox VE
The Proxmox integration reads a Proxmox VE cluster, or a standalone node, through the Proxmox VE API. It runs on an Integrator inside your network.
It is read-only. The integration never starts, stops, migrates or reconfigures anything.
What it collects
| Sync | Collects |
|---|---|
| Hypervisor discovery | The cluster and every node with its Proxmox VE version, kernel, CPU, memory, state and cluster address |
| Virtual machine discovery | Virtual machines and LXC containers with their OS, addresses, MACs, bridges, VLANs, CPU, memory, state, tags, pool and node; templates |
| Network discovery | Every node's bridges and VLAN interfaces with their subnets, and SDN VNets with their subnets |
LXC containers appear under Compute > Containers and virtual machines under Compute > Instances, next to those from every other cloud. Templates appear under Compute > Registries.
A VM's operating system and addresses come from the QEMU guest agent. A VM without a running agent is still reported from its configuration, without addresses.
Create a read-only API token
- Under Datacenter > Permissions > Users, add a user (for example
inventory@pve). - Under Datacenter > Permissions > API Tokens, add a token for it (for example
inventory). Leave Privilege Separation checked and copy the secret: it is shown once. - Under Datacenter > Permissions, add two API Token Permissions on path
/with Propagate checked:- the built-in PVEAuditor role;
- to read guest-agent addresses, a role with
VM.GuestAgent.Audit(Proxmox VE 9) orVM.Monitor(Proxmox VE 8).
Or from a node's shell:
pveum user add inventory@pve
pveum user token add inventory@pve inventory --privsep 1
pveum acl modify / --tokens 'inventory@pve!inventory' --roles PVEAuditor
pveum role add GuestAgentAudit --privs VM.GuestAgent.Audit
pveum acl modify / --tokens 'inventory@pve!inventory' --roles GuestAgentAudit
On Proxmox VE 8, use --privs VM.Monitor instead.
Connect it
- Under Integrations, add Proxmox VE with any node's hostname, the token ID
(
inventory@pve!inventory) and the token secret. - In the integration's settings, assign the Integrator that can reach the node on port 8006.
- Enable the syncs you want.
Proxmox VE serves a self-signed certificate. The first connection records the certificate's fingerprint and later connections must present the same certificate. After replacing it, clear the pinned fingerprint in the integration's settings.