mirror of
https://github.com/Grace-Solutions/PSProxmox.git
synced 2026-07-26 16:28:16 +00:00
PSProxmox Documentation
PSProxmox is a C#-based PowerShell module for managing Proxmox VE clusters. It provides a comprehensive set of cmdlets for interacting with Proxmox VE API, featuring structured return objects, mass deployment tools, automatic IP management, and more.
Features
- Session Management: Authenticate and persist sessions with Proxmox VE clusters
- Core CRUD Operations: Manage VMs, Storage, Network, Users, Roles, SDN, and Clusters
- Templates: Create and use VM deployment templates
- Mass Creation: Bulk create VMs with prefix/counter
- IP Management: CIDR parsing, subnetting, FIFO IP queue assignment
- Structured Objects: All outputs are typed C# classes (PowerShell-native)
- Pipeline Support: Cmdlets support pipeline input where appropriate
Getting Started
Documentation
- Cmdlet Reference - Detailed documentation for all cmdlets
- Examples - Example scripts for common tasks
- Guides - Comprehensive guides for various topics
Requirements
- PowerShell 5.1 or PowerShell 7+
- .NET Framework 4.7.2 or .NET Core 2.0+
Quick Start
# Install from PowerShell Gallery
Install-Module -Name PSProxmox -Scope CurrentUser
# Import the module
Import-Module PSProxmox
# Connect to a Proxmox VE server
$credential = Get-Credential
$connection = Connect-ProxmoxServer -Server "proxmox.example.com" -Credential $credential -Realm "pam"
# Get all VMs
$vms = Get-ProxmoxVM -Connection $connection
# Create a new VM
$vm = New-ProxmoxVM -Connection $connection -Node "pve1" -Name "test-vm" -Memory 2048 -Cores 2 -DiskSize 32 -Start
# Disconnect when done
Disconnect-ProxmoxServer -Connection $connection
Using the Documentation
For detailed documentation on each cmdlet, you can:
-
Use the built-in PowerShell help:
Get-Help Connect-ProxmoxServer -Full -
Browse the Cmdlet Reference for detailed documentation on all cmdlets.
-
Check the Examples for example scripts for common tasks.
-
Read the Guides for comprehensive guides on various topics.
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
License
This project is licensed under the MIT License - see the LICENSE file for details.