Cmdlet reference

702 cmdlets of module version 9.2.4: 22 written by hand, 680 generated from the Proxmox VE API, one per endpoint and method. How a cmdlet name maps to its endpoint is explained in Raw API.

Group	Cmdlets	Contents
Module functions	22	Functions written by hand in the module: connection, raw API, tasks, VMs by id or name, snapshots.
/access	45	/access: users, groups, roles, ACL, realms, API tokens, two-factor authentication.
/cluster	262	/cluster: cluster-wide configuration: SDN, firewall, notifications, HA, mappings, ACME, backup jobs, replication.
/nodes	360	/nodes: everything on a node: VMs (qemu), containers (lxc), Ceph, storage, disks, network, services, tasks.
/pools	7	/pools: resource pools.
/storage	5	/storage: storage definitions of the datacenter.
/version	1	/version: Proxmox VE version.

Aliases

Shorter names for common cmdlets, defined by the module.

Alias	Cmdlet
`Get-PveVm`	Get-PveGuest
`Get-PveVmSnapshot`	Get-PveGuestSnapshot
`Get-PveLxcConfig`	Get-PveNodesLxcConfig
`Get-PveLxcMonitoring`	Get-PveNodesLxcRrddata
`Get-PveLxcSnapshot`	Get-PveNodesLxcSnapshot
`Get-PveLxcSnapshotConfig`	Get-PveNodesLxcSnapshotConfig
`Get-PveQemuConfig`	Get-PveNodesQemuConfig
`Get-PveQemuMonitoring`	Get-PveNodesQemuRrddata
`Get-PveQemuSnapshot`	Get-PveNodesQemuSnapshot
`Get-PveQemuSnapshotConfig`	Get-PveNodesQemuSnapshotConfig
`Get-PveTasksStatus`	Get-PveNodesTasksStatus
`Show-PveSpice`	Invoke-PveSpice
`New-PveVmSnapshot`	New-PveGuestSnapshot
`Update-PveNode`	New-PveNodesAptUpdate
`New-PveLxc`	New-PveNodesLxc
`Copy-PveLxc`	New-PveNodesLxcClone
`Move-PveLxc`	New-PveNodesLxcMigrate
`Create-PveLxcSnapshot`	New-PveNodesLxcSnapshot
`Undo-PveLxcSnapshot`	New-PveNodesLxcSnapshotRollback
`Restart-PveLxc`	New-PveNodesLxcStatusReboot
`Resume-PveLxc`	New-PveNodesLxcStatusResume
`Shutdown-PveLxc`	New-PveNodesLxcStatusShutdown
`Start-PveLxc`	New-PveNodesLxcStatusStart
`Stop-PveLxc`	New-PveNodesLxcStatusStop
`Suspend-PveLxc`	New-PveNodesLxcStatusSuspend
`New-PveQemu`	New-PveNodesQemu
`Copy-PveQemu`	New-PveNodesQemuClone
`Move-PveQemu`	New-PveNodesQemuMigrate
`Create-PveQemuSnapshot`	New-PveNodesQemuSnapshot
`Undo-PveQemuSnapshot`	New-PveNodesQemuSnapshotRollback
`Restart-PveQemu`	New-PveNodesQemuStatusReboot
`Reset-PveQemu`	New-PveNodesQemuStatusReset
`Resume-PveQemu`	New-PveNodesQemuStatusResume
`Shutdown-PveQemu`	New-PveNodesQemuStatusShutdown
`Start-PveQemu`	New-PveNodesQemuStatusStart
`Stop-PveQemu`	New-PveNodesQemuStatusStop
`Suspend-PveQemu`	New-PveNodesQemuStatusSuspend
`Backup-PveVzdump`	New-PveNodesVzdump
`Remove-PveVmSnapshot`	Remove-PveGuestSnapshot
`Remove-PveLxc`	Remove-PveNodesLxc
`Remove-PveLxcSnapshot`	Remove-PveNodesLxcSnapshot
`Remove-PveQemu`	Remove-PveNodesQemu
`Remove-PveQemuSnapshot`	Remove-PveNodesQemuSnapshot
`Reset-PveVm`	Reset-PveGuest
`Resume-PveVm`	Resume-PveGuest
`Set-PveLxcConfig`	Set-PveNodesLxcConfig
`Set-PveLxcSnapshot`	Set-PveNodesLxcSnapshotConfig
`Set-PveQemuConfig`	Set-PveNodesQemuConfig
`Set-PveQemuSnapshot`	Set-PveNodesQemuSnapshotConfig
`Start-PveVm`	Start-PveGuest
`Stop-PveVm`	Stop-PveGuest
`Suspend-PveVm`	Suspend-PveGuest
`Undo-PveVmSnapshot`	Undo-PveGuestSnapshot
`Unlock-PveVm`	Unlock-PveGuest