Skip to content
Back to search

cv4pve-api-powershell

Proxmox VE PowerShell module for accessing API like VMware PowerCLI

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today

Check it deeper on your machine

It has changed since its scan on 11 Nov 2026.

As a Claude Code plugin, install it and then ask Claude Code:

/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/Corsinvest/cv4pve-api-powershell with scanskillsafety

Or from a terminal, clone it and run it:

git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/Corsinvest/cv4pve-api-powershell'

It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.

Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/corsinvest--cv4pve-api-powershell/badge.svg)](/listings/corsinvest--cv4pve-api-powershell)

HTML

<a href="/listings/corsinvest--cv4pve-api-powershell"><img src="/api/listings/corsinvest--cv4pve-api-powershell/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

Install-Module -Name Corsinvest.ProxmoxVE.Api -Scope CurrentUser

# connect to any node of the cluster, with an API token
Connect-PveCluster -HostsAndPorts pve01 -ApiToken 'automation@pve!ps=<secret>'

# every VM and container of the cluster
Get-PveGuest | Format-Table vmid, name, node, type, status

# the generated cmdlets return the data in .Response.data
(Get-PveNodesQemuConfig -Node pve01 -Vmid 100).Response.data

Requires PowerShell 7. With a self-signed certificate add `-SkipCertificateCheck`. What the token needs: [Permissions](https://corsinvest.github.io/cv4pve-api-powershell/permissions/).

---

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 128 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. # <img src="icon.png" alt="" height="36" align="top"> cv4pve-api-powershell
  2. ```
  3. ______ _ __
  4. / ____/___ __________(_)___ _ _____ _____/ /_
  5. / / / __ \/ ___/ ___/ / __ \ | / / _ \/ ___/ __/
  6. / /___/ /_/ / / (__ ) / / / / |/ / __(__ ) /_
  7. \____/\____/_/ /____/_/_/ /_/|___/\___/____/\__/
  8. PowerShell for Proxmox VE (Made in Italy)
  9. ```
  10. [![License](https://img.shields.io/github/license/Corsinvest/cv4pve-api-powershell.svg?style=flat-square)](LICENSE)
  11. [![PowerShell Gallery](https://img.shields.io/powershellgallery/v/Corsinvest.ProxmoxVE.Api?style=flat-square&logo=powershell)](https://www.powershellgallery.com/packages/Corsinvest.ProxmoxVE.Api/)
  12. [![Downloads](https://img.shields.io/powershellgallery/dt/Corsinvest.ProxmoxVE.Api?style=flat-square)](https://www.powershellgallery.com/packages/Corsinvest.ProxmoxVE.Api/)
  13. > **The PowerCLI for Proxmox VE**: a PowerShell module with a cmdlet for every endpoint of the Proxmox VE API, running on your machine and talking only to the API.
  14. >
  15. > **[Documentation](https://corsinvest.github.io/cv4pve-api-powershell/)**
  16. ---
  17. <p align="center">
  18. <img src="images/powershell.png" alt="PowerShell holding a shield with the Proxmox logo" width="320">
  19. </p>
  20. ## Why
  21. The Proxmox VE web interface is made for one action at a time. Snapshot forty VMs before an update, list every VM with its disks for an audit, clone a template ten times, shut down a lab every evening: by hand it is slow and error-prone.
  22. VMware administrators have PowerCLI for this. cv4pve-api-powershell is the same idea for Proxmox VE: the whole API as PowerShell cmdlets, so your scripts, scheduled tasks and habits keep working: objects in the pipeline, `Where-Object`, `Export-Csv`, `Get-Help`.
  23. It **runs on your machine and uses only the Proxmox VE API**: nothing to install on the nodes, no SSH.
  24. ---
  25. ## Features
  26. - **The whole API**: one cmdlet per endpoint and method, generated from the Proxmox VE API, with its parameters, types and allowed values.
  27. - **VMs by id or name**: `Get-PveGuest` finds VMs and containers by id, name, range, node, pool or tag, with exclusions; the same selection starts, stops or snapshots them all in one call.
  28. - **API token or password**: list several nodes and the first that answers is used.
  29. - **Objects, not text**: the Proxmox VE data as PowerShell objects, with the HTTP outcome beside it.
  30. - **Tasks**: start a backup, clone or migration and wait for it to finish, with a progress bar if you like.
  31. - **Anything else**: `Invoke-PveRestApi` calls any path of the API with the same connection.
  32. - **`-WhatIf` and `-Confirm`**: on every cmdlet that changes something, to see what would be done before doing it; without them nothing asks, as scripts expect.
  33. - **Cross-platform**: PowerShell 7 on Windows, Linux and macOS.
  34. ---
  35. ## Quick start
  36. ```powershell
  37. Install-Module -Name Corsinvest.ProxmoxVE.Api -Scope CurrentUser
  38. # connect to any node of the cluster, with an API token
  39. Connect-PveCluster -HostsAndPorts pve01 -ApiToken 'automation@pve!ps=<secret>'
  40. # every VM and container of the cluster
  41. Get-PveGuest | Format-Table vmid, name, node, type, status
  42. # the generated cmdlets return the data in .Response.data
  43. (Get-PveNodesQemuConfig -Node pve01 -Vmid 100).Response.data
  44. ```
  45. Requires PowerShell 7. With a self-signed certificate add `-SkipCertificateCheck`. What the token needs: [Permissions](https://corsinvest.github.io/cv4pve-api-powershell/permissions/).
  46. ---
  47. ## What it looks like
  48. ```powershell
  49. PS> Get-PveGuest | Format-Table vmid, name, node, type, status
  50. vmid name node type status
  51. ---- ---- ---- ---- ------
  52. 105 test pve01 lxc stopped
  53. 1006 dc01 pve01 qemu running
  54. 100 backup01 pve02 lxc running
  55. 102 firewall02 pve02 qemu running
  56. 1012 mailstore pve02 qemu running
  57. PS> Get-PveNode | Select-Object node, status, @{ n = 'cpu%'; e = { [math]::Round($_.cpu * 100, 1) } }
  58. node status cpu%
  59. ---- ------ ----
  60. pve02 online 1.50
  61. pve01 online 4.20
  62. ```
  63. `Get-PveGuest` returns the guests themselves; the generated cmdlets return a `PveResponse` with the data in `.Response.data`. More recipes, each with its output: [Common tasks](https://corsinvest.github.io/cv4pve-api-powershell/examples/common-tasks/).
  64. ---
  65. ## Documentation
  66. | | |
  67. |---|---|
  68. | [Getting started](https://corsinvest.github.io/cv4pve-api-powershell/getting-started/) | Install, connect, first cmdlets |
  69. | [Connection](https://corsinvest.github.io/cv4pve-api-powershell/connection/) | API token or password, several nodes, certificates, permissions |
  70. | [Coming from PowerCLI](https://corsinvest.github.io/cv4pve-api-powershell/coming-from-powercli/) | Each PowerCLI cmdlet mapped to its equivalent, and what works differently |
  71. | [Concepts](https://corsinvest.github.io/cv4pve-api-powershell/concepts/results/) | Results, parameters, tasks, errors, raw API calls |
  72. | [Guides](https://corsinvest.github.io/cv4pve-api-powershell/guides/finding-vms/) | VMs by id or name, power, snapshots, SPICE |
  73. | [Examples](https://corsinvest.github.io/cv4pve-api-powershell/examples/common-tasks/) | Common tasks with their output, inventory to CSV, creating VMs, guest agent, backups |
  74. | [Cmdlet reference](https://corsinvest.github.io/cv4pve-api-powershell/reference/) | Every cmdlet with its endpoint and parameters |
  75. | [AI assistants](https://corsinvest.github.io/cv4pve-api-powershell/ai-agents/) | Claude Code, Codex, the `cv4pve-api-powershell` skill |
  76. | [Troubleshooting](https://corsinvest.github.io/cv4pve-api-powershell/troubleshooting/) | `-Debug` and the common errors |
  77. ---
  78. ## Related tools
  79. Prefer the command line in any shell? [cv4pve-cli](https://github.com/Corsinvest/cv4pve-cli) calls the same API. From .NET: [cv4pve-api-dotnet](https://github.com/Corsinvest/cv4pve-api-dotnet). The whole suite: [corsinvest.it/cv4pve](https://www.corsinvest.it/en/cv4pve/).
  80. ---
  81. ## Support
  82. Professional support and consulting available through [Corsinvest](https://www.corsinvest.it/en/cv4pve/).
  83. ---
  84. **By sysadmins, for sysadmins.**
  85. Part of [cv4pve](https://www.corsinvest.it/en/cv4pve/) suite | Made with ❤️ in Italy by [Corsinvest](https://www.corsinvest.it)
  86. Proxmox® is a registered trademark of Proxmox Server Solutions GmbH. cv4pve is developed by Corsinvest and is not a Proxmox product.
  87. Copyright © Corsinvest Srl

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.