Skip to content

proxmox/inventory-items

Proxmox hypervisor Inventory details.

This Param defines the Proxmox Hypervisory Inventory data to collect after building the Proxmox Host.

The data collection is performed with the pvesh utility at the shell of the Proxmox hypervisor. The specific API endpoints that data is collected from is defined by this Param.

The format of this Param is a space separated list of API values that make up a full valid API call. These vales are used as follows; for the input of networks (as an example):

  • pvesh get /nodes/{node}/network --output-format json

Any defined calls MUST be an API GET request, and must result in valid JSON (meaning empty data should return either [], or {}). If it is not valid JSON, an error in JSON validation will occur and the inventory process will fail.

Valid Proxmox API endpoints are documented at:

  • https://pve.proxmox.com/pve-docs/api-viewer/