# Proxmox VE Resource Provider
[](LICENSE)
[](https://github.com/muhlba91/pulumi-proxmoxve/actions/workflows/verify.yml)
[](https://scorecard.dev/viewer/?uri=github.com/muhlba91/pulumi-proxmoxve)
[](https://github.com/muhlba91/pulumi-proxmoxve/releases)
[](https://pypi.org/project/pulumi-proxmoxve/)
[](https://pypi.org/project/pulumi-proxmoxve/)
[](https://www.nuget.org/packages/Pulumi.ProxmoxVE/)
[](https://www.nuget.org/packages/Pulumi.ProxmoxVE/)
[](https://www.npmjs.com/package/@muhlba91/pulumi-proxmoxve)
[](https://www.npmjs.com/package/@muhlba91/pulumi-proxmoxve)
[](#contributors)
<a href="https://www.buymeacoffee.com/muhlba91" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="28" width="150"></a>
The Proxmox VE Resource Provider for [Pulumi](https://www.pulumi.com) lets you manage [Proxmox VE](http://proxmox.com) resources.
The provider is built on https://github.com/bpg/terraform-provider-proxmox.
## Installing
This package is available in many languages in the standard packaging formats.
### Installing the Plugin
1. Download the appropriate archive file from the Releases page:
`wget https://github.com/muhlba91/pulumi-proxmoxve/releases/download/vX.Y.Z/pulumi-resource-proxmoxve-vX.Y.Z-OPERATING_SYSTEM-ARCH.tar.gz`
2. Add the plugin to Pulumi:
`pulumi plugin install resource proxmoxve X.Y.Z -f ./pulumi-resource-proxmoxve-vX.Y.Z-OPERATING_SYSTEM-ARCH.tar.gz`
### Node.js (JavaScript/TypeScript)
To use from JavaScript or TypeScript in Node.js, install using either `npm`:
```bash
npm install @muhlba91/pulumi-proxmoxve
```
or `yarn`:
```bash
yarn add @muhlba91/pulumi-proxmoxve
```
### Python
To use from Python, install using `pip`:
```bash
pip install pulumi-proxmoxve
```
### Go
To use from Go, use `go get` to grab the latest version of the library:
```bash
go get github.com/muhlba91/pulumi-proxmoxve/sdk/go/...
```
### .NET
To use from .NET, install using `dotnet add package`:
```bash
dotnet add package Pulumi.ProxmoxVE
```
## Configuration
Unfortunately, configuration via environment variables is not (yet) working.
To configure the provider you must create and pass it through.
Example for *Typescript*:
```typescript
import * as proxmox from '@muhlba91/pulumi-proxmoxve';
const provider = new proxmox.Provider('proxmoxve', {
endpoint: process.env.PROXMOX_VE_ENDPOINT,
insecure: process.env.PROXMOX_VE_INSECURE,
username: process.env.PROXMOX_VE_USERNAME,
password: process.env.PROXMOX_VE_PASSWORD
});
const args = {};
const vm = new proxmox.vm.VirtualMachine(
'vm',
args,
{
provider: provider,
},
);
```
## Reference
For detailed reference documentation, please visit the upstream Terraform provider's documentation at: https://registry.terraform.io/providers/bpg/proxmox/latest.
Some input parameters are required as per the [Proxmox API Viewer](https://pve.proxmox.com/pve-docs/api-viewer/index.html).
Please refer to this documentation for more information regarding required parameters for your Proxmox VE version.
## Contributors
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
<tbody>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://muehlbachler.io/"><img src="https://avatars.githubusercontent.com/u/653739?v=4?s=100" width="100px;" alt="Daniel Mühlbachler-Pietrzykowski"/><br /><sub><b>Daniel Mühlbachler-Pietrzykowski</b></sub></a><br /><a href="#maintenance-muhlba91" title="Maintenance">🚧</a> <a href="https://github.com/muhlba91/pulumi-proxmoxve/commits?author=muhlba91" title="Code">💻</a> <a href="https://github.com/muhlba91/pulumi-proxmoxve/commits?author=muhlba91" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/NCMartins"><img src="https://avatars.githubusercontent.com/u/11583533?v=4?s=100" width="100px;" alt="Nelson Costa Martins"/><br /><sub><b>Nelson Costa Martins</b></sub></a><br /><a href="#example-NCMartins" title="Examples">💡</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/guineveresaenger"><img src="https://avatars.githubusercontent.com/u/13116240?v=4?s=100" width="100px;" alt="Guinevere Saenger"/><br /><sub><b>Guinevere Saenger</b></sub></a><br /><a href="https://github.com/muhlba91/pulumi-proxmoxve/commits?author=guineveresaenger" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/susanev"><img src="https://avatars.githubusercontent.com/u/5489125?v=4?s=100" width="100px;" alt="Susan Evans"/><br /><sub><b>Susan Evans</b></sub></a><br /><a href="https://github.com/muhlba91/pulumi-proxmoxve/commits?author=susanev" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/zamrih"><img src="https://avatars.githubusercontent.com/u/1061718?v=4?s=100" width="100px;" alt="zamrih"/><br /><sub><b>zamrih</b></sub></a><br /><a href="https://github.com/muhlba91/pulumi-proxmoxve/commits?author=zamrih" title="Code">💻</a></td>
</tr>
</tbody>
</table>
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
Raw data
{
"_id": null,
"home_page": "https://github.com/muhlba91/pulumi-proxmoxve",
"name": "pulumi-proxmoxve",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "pulumi proxmox proxmoxve",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/12/b0/51976d47a5bbeceab67ccda3fdca1324d3316a83b8c76f997902127875a2/pulumi_proxmoxve-6.18.0.tar.gz",
"platform": null,
"description": "# Proxmox VE Resource Provider\n\n[](LICENSE)\n[](https://github.com/muhlba91/pulumi-proxmoxve/actions/workflows/verify.yml)\n[](https://scorecard.dev/viewer/?uri=github.com/muhlba91/pulumi-proxmoxve)\n[](https://github.com/muhlba91/pulumi-proxmoxve/releases)\n[](https://pypi.org/project/pulumi-proxmoxve/)\n[](https://pypi.org/project/pulumi-proxmoxve/)\n[](https://www.nuget.org/packages/Pulumi.ProxmoxVE/)\n[](https://www.nuget.org/packages/Pulumi.ProxmoxVE/)\n[](https://www.npmjs.com/package/@muhlba91/pulumi-proxmoxve)\n[](https://www.npmjs.com/package/@muhlba91/pulumi-proxmoxve)\n[](#contributors)\n<a href=\"https://www.buymeacoffee.com/muhlba91\" target=\"_blank\"><img src=\"https://cdn.buymeacoffee.com/buttons/default-orange.png\" alt=\"Buy Me A Coffee\" height=\"28\" width=\"150\"></a>\n\nThe Proxmox VE Resource Provider for [Pulumi](https://www.pulumi.com) lets you manage [Proxmox VE](http://proxmox.com) resources.\n\nThe provider is built on https://github.com/bpg/terraform-provider-proxmox.\n\n## Installing\n\nThis package is available in many languages in the standard packaging formats.\n\n### Installing the Plugin\n\n1. Download the appropriate archive file from the Releases page:\n `wget https://github.com/muhlba91/pulumi-proxmoxve/releases/download/vX.Y.Z/pulumi-resource-proxmoxve-vX.Y.Z-OPERATING_SYSTEM-ARCH.tar.gz`\n2. Add the plugin to Pulumi:\n `pulumi plugin install resource proxmoxve X.Y.Z -f ./pulumi-resource-proxmoxve-vX.Y.Z-OPERATING_SYSTEM-ARCH.tar.gz`\n\n### Node.js (JavaScript/TypeScript)\n\nTo use from JavaScript or TypeScript in Node.js, install using either `npm`:\n\n```bash\nnpm install @muhlba91/pulumi-proxmoxve\n```\n\nor `yarn`:\n\n```bash\nyarn add @muhlba91/pulumi-proxmoxve\n```\n\n### Python\n\nTo use from Python, install using `pip`:\n\n```bash\npip install pulumi-proxmoxve\n```\n\n### Go\n\nTo use from Go, use `go get` to grab the latest version of the library:\n\n```bash\ngo get github.com/muhlba91/pulumi-proxmoxve/sdk/go/...\n```\n\n### .NET\n\nTo use from .NET, install using `dotnet add package`:\n\n```bash\ndotnet add package Pulumi.ProxmoxVE\n```\n\n## Configuration\n\nUnfortunately, configuration via environment variables is not (yet) working.\nTo configure the provider you must create and pass it through.\n\nExample for *Typescript*:\n\n```typescript\nimport * as proxmox from '@muhlba91/pulumi-proxmoxve';\n\nconst provider = new proxmox.Provider('proxmoxve', {\n endpoint: process.env.PROXMOX_VE_ENDPOINT,\n insecure: process.env.PROXMOX_VE_INSECURE,\n username: process.env.PROXMOX_VE_USERNAME,\n password: process.env.PROXMOX_VE_PASSWORD\n});\n\nconst args = {};\nconst vm = new proxmox.vm.VirtualMachine(\n 'vm',\n args,\n {\n provider: provider,\n },\n);\n```\n\n## Reference\n\nFor detailed reference documentation, please visit the upstream Terraform provider's documentation at: https://registry.terraform.io/providers/bpg/proxmox/latest.\n\nSome input parameters are required as per the [Proxmox API Viewer](https://pve.proxmox.com/pve-docs/api-viewer/index.html).\nPlease refer to this documentation for more information regarding required parameters for your Proxmox VE version.\n\n## Contributors\n\nThanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->\n<!-- prettier-ignore-start -->\n<!-- markdownlint-disable -->\n<table>\n <tbody>\n <tr>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://muehlbachler.io/\"><img src=\"https://avatars.githubusercontent.com/u/653739?v=4?s=100\" width=\"100px;\" alt=\"Daniel M\u00fchlbachler-Pietrzykowski\"/><br /><sub><b>Daniel M\u00fchlbachler-Pietrzykowski</b></sub></a><br /><a href=\"#maintenance-muhlba91\" title=\"Maintenance\">\ud83d\udea7</a> <a href=\"https://github.com/muhlba91/pulumi-proxmoxve/commits?author=muhlba91\" title=\"Code\">\ud83d\udcbb</a> <a href=\"https://github.com/muhlba91/pulumi-proxmoxve/commits?author=muhlba91\" title=\"Documentation\">\ud83d\udcd6</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/NCMartins\"><img src=\"https://avatars.githubusercontent.com/u/11583533?v=4?s=100\" width=\"100px;\" alt=\"Nelson Costa Martins\"/><br /><sub><b>Nelson Costa Martins</b></sub></a><br /><a href=\"#example-NCMartins\" title=\"Examples\">\ud83d\udca1</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/guineveresaenger\"><img src=\"https://avatars.githubusercontent.com/u/13116240?v=4?s=100\" width=\"100px;\" alt=\"Guinevere Saenger\"/><br /><sub><b>Guinevere Saenger</b></sub></a><br /><a href=\"https://github.com/muhlba91/pulumi-proxmoxve/commits?author=guineveresaenger\" title=\"Documentation\">\ud83d\udcd6</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/susanev\"><img src=\"https://avatars.githubusercontent.com/u/5489125?v=4?s=100\" width=\"100px;\" alt=\"Susan Evans\"/><br /><sub><b>Susan Evans</b></sub></a><br /><a href=\"https://github.com/muhlba91/pulumi-proxmoxve/commits?author=susanev\" title=\"Documentation\">\ud83d\udcd6</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/zamrih\"><img src=\"https://avatars.githubusercontent.com/u/1061718?v=4?s=100\" width=\"100px;\" alt=\"zamrih\"/><br /><sub><b>zamrih</b></sub></a><br /><a href=\"https://github.com/muhlba91/pulumi-proxmoxve/commits?author=zamrih\" title=\"Code\">\ud83d\udcbb</a></td>\n </tr>\n </tbody>\n</table>\n\n<!-- markdownlint-restore -->\n<!-- prettier-ignore-end -->\n\n<!-- ALL-CONTRIBUTORS-LIST:END -->\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "A Pulumi package for creating and managing Proxmox Virtual Environment cloud resources.",
"version": "6.18.0",
"project_urls": {
"Homepage": "https://github.com/muhlba91/pulumi-proxmoxve",
"Repository": "https://github.com/muhlba91/pulumi-proxmoxve"
},
"split_keywords": [
"pulumi",
"proxmox",
"proxmoxve"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "12b051976d47a5bbeceab67ccda3fdca1324d3316a83b8c76f997902127875a2",
"md5": "62714493b16f45e5574ef50cca68b000",
"sha256": "0e4a77bf2323eef09833f5f576087a60cc5fa89a81a44aaf69153929aa9c71f6"
},
"downloads": -1,
"filename": "pulumi_proxmoxve-6.18.0.tar.gz",
"has_sig": false,
"md5_digest": "62714493b16f45e5574ef50cca68b000",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 165025,
"upload_time": "2024-12-18T07:56:36",
"upload_time_iso_8601": "2024-12-18T07:56:36.018264Z",
"url": "https://files.pythonhosted.org/packages/12/b0/51976d47a5bbeceab67ccda3fdca1324d3316a83b8c76f997902127875a2/pulumi_proxmoxve-6.18.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-18 07:56:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "muhlba91",
"github_project": "pulumi-proxmoxve",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pulumi-proxmoxve"
}
JSON
