Pulumi Proxmox VE Provider
A Pulumi package to manage Proxmox Virtual Environment (Proxmox VE) resources. This provider is built on the Terraform Proxmox Provider.
Installation
This package is available for multiple programming languages. Install using your preferred package manager:
Node.js (JavaScript/TypeScript)
npm install @muhlba91/pulumi-proxmoxve
# or
yarn add @muhlba91/pulumi-proxmoxve
Python
pip install pulumi-proxmoxve
Go
go get github.com/muhlba91/pulumi-proxmoxve/sdk/v6/go/proxmoxve
.NET
dotnet add package Pulumi.ProxmoxVE
Configuration
You must configure the provider with your Proxmox VE API credentials. Currently, you must explicitly pass configuration values to the provider constructor. You can use environment variables to manage these secrets:
| Variable | Description |
|---|---|
PROXMOX_VE_ENDPOINT |
The API endpoint of your Proxmox VE server (e.g., https://pve.example.com:8006) |
PROXMOX_VE_USERNAME |
Your Proxmox VE username |
PROXMOX_VE_PASSWORD |
Your Proxmox VE password or API token |
PROXMOX_VE_INSECURE |
Set to true to skip TLS certificate verification |
Example Usage
TypeScript
import * as pulumi from '@pulumi/pulumi';
import * as proxmox from '@muhlba91/pulumi-proxmoxve';
// Initialize the Proxmox provider
const provider = new proxmox.Provider('proxmoxve', {
endpoint: process.env.PROXMOX_VE_ENDPOINT,
username: process.env.PROXMOX_VE_USERNAME,
password: process.env.PROXMOX_VE_PASSWORD,
insecure: process.env.PROXMOX_VE_INSECURE === 'true',
});
// Create a Virtual Machine
const vm = new proxmox.vm.VirtualMachine('my-vm', {
nodeName: 'pve-node-1',
// ... further configuration
}, { provider });
Migration
v7 to v8 (Breaking Changes)
Version 8 introduces a breaking change in how resources are named to align with the upstream Terraform provider's transition to the modern provider framework.
- Standardized Resource Names: Due to the upstream provider introducing the
proxmox_prefix and standardizing resource identification, custom resource name and ID changes have been deprecated. - Legacy Namespacing: Resources that previously started with
proxmox_virtual_environment_have been moved to aLegacynaming format (e.g.,proxmoxve:VM/virtualMachine:VirtualMachineis nowproxmoxve:index/vmLegacy:VmLegacy). - Standardized Resource IDs: Resources which have an
idinput exposed by the Terraform provider are consistently renamed toresourceId. In particular, this affects resources created using the Terraform provider framework.
State Migration
You can migrate your existing stack by exporting the state, updating the resource tokens, and re-importing:
pulumi stack export > stack.json
# Example: updating the VirtualMachine resource token
sed -i 's/proxmoxve:VM\/virtualMachine:VirtualMachine/proxmoxve:index\/vmLegacy:VmLegacy/g' stack.json
pulumi stack import < stack.json
ID Migration
For resources that have an id input, you will need to update your code to use resourceId instead. For example:
// Example: updating a Vnet resource to use resourceId instead of id
// Before
const vnet = new proxmox.sdn.Vnet('my-vnet', {
vnetId: '1',
// ... further configuration
});
// After
const vnet = new proxmox.sdn.Vnet('my-vnet', {
resourceId: '1',
// ... further configuration
});
Reference
- Upstream Provider Reference: Terraform Proxmox Provider Documentation
- Proxmox API: Proxmox VE API Viewer
- Official Documentation: Proxmox VE Documentation
Contributors
Thanks goes to these wonderful people (emoji key):
 Daniel Mühlbachler-Pietrzykowski 🚧 💻 📖 |
 Nelson Costa Martins 💡 |
 Guinevere Saenger 📖 |
 Susan Evans 📖 |
 zamrih 💻 |
This project follows the all-contributors specification. Contributions of any kind welcome!
1 maintainer
Metadata
1 maintainer
Release files for pulumi-proxmoxve 8.6.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pulumi_proxmoxve-8.6.0.tar.gz | 405.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pulumi_proxmoxve-8.6.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.1 MB
Release files / pulumi_proxmoxve-8.6.0.tar.gz
| Download URL | pulumi_proxmoxve-8.6.0.tar.gz |
|---|---|
| Size | 405.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
eb5600fc464df9f5ce3d3a6bc0e3f54db291df664754bb0d300589130b102e96
|
|
BLAKE2b-256 checksum How to use checksums |
b3884cca08a448664f7a604e1676ae6d9e699cec457f82b48bb17d93d3524728
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 6, 2026.
Transparency logRelease files / pulumi_proxmoxve-8.6.0-py3-none-any.whl
| Download URL | pulumi_proxmoxve-8.6.0-py3-none-any.whl |
|---|---|
| Size | 715.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e386942bafabd3c724e43cc684ec861072066ef682ebcac32723a8e5b98873ce
|
|
BLAKE2b-256 checksum How to use checksums |
7d88ca63e1bac9cbf5eb54a32c45cc5d7b5b6c84beceb2ba2638a8b15e361635
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 6, 2026.
Transparency log
