Skip to content

Module functions

Functions written by hand in the module: connection, raw API, tasks, VMs by id or name, snapshots. 22 cmdlets.

Cmdlet Description
Connect-PveCluster Connect to Proxmox VE Cluster.
ConvertFrom-PveUnixTime Convert Unix Time in DateTime
ConvertTo-PveUnixTime Convert System.DateTime objects to UNIX time.
Get-PveGuest Get VMs/CTs of the cluster from id, name, range, node, pool or tag.
Get-PveGuestSnapshot Get snapshots VM/CT.
Get-PveNode Get nodes
Get-PveTaskExitStatus Get the exit status of a finished task: ‘OK’ when it succeeded, otherwise the error of the task.
Get-PveTaskIsRunning Get task is running.
Invoke-PveRestApi Invoke Proxmox VE Rest API
Invoke-PveSpice Enter Spice VM.
New-PveGuestSnapshot Create snapshot VM/CT.
Remove-PveGuestSnapshot Delete a VM/CT snapshot.
Reset-PveGuest Reset VM/CT.
Restart-PveGuest Reboot VM/CT cleanly, through the guest operating system.
Resume-PveGuest Resume VM/CT.
Start-PveGuest Start VM/CT.
Stop-PveGuest Stop VM/CT immediately; with -Shutdown, shut it down cleanly through the guest operating system (ACPI or guest agent for a VM).
Suspend-PveGuest Suspend VM/CT.
Undo-PveGuestSnapshot Rollback VM/CT state to specified snapshot.
Unlock-PveGuest Unlock VM/CT.
Wait-PveTaskIsFinish Get task is running.
Wait-PveTaskIsFinishedWithProgress Wait for a task to finish, show Powershell Progressbar while waiting