/nodes
/nodes: everything on a node: VMs (qemu), containers (lxc), Ceph, storage, disks, network, services, tasks. 360 cmdlets.
- Get-PveNodes:
GET /nodes
Cluster node index. - Get-PveNodesIdx:
GET /nodes/{node}
Node index. - Get-PveNodesAplinfo:
GET /nodes/{node}/aplinfo
Get list of appliances. - New-PveNodesAplinfo:
POST /nodes/{node}/aplinfo
Download appliance templates. - Get-PveNodesApt:
GET /nodes/{node}/apt
Directory index for apt (Advanced Package Tool). - Get-PveNodesAptChangelog:
GET /nodes/{node}/apt/changelog
Get package changelogs. - Get-PveNodesAptRepositories:
GET /nodes/{node}/apt/repositories
Get APT repository information. - New-PveNodesAptRepositories:
POST /nodes/{node}/apt/repositories
Change the properties of a repository. - Set-PveNodesAptRepositories:
PUT /nodes/{node}/apt/repositories
Add a standard repository to the configuration - Get-PveNodesAptUpdate:
GET /nodes/{node}/apt/update
List available updates. - New-PveNodesAptUpdate:
POST /nodes/{node}/apt/update
This is used to resynchronize the package index files from their sources (apt-get update). - Get-PveNodesAptVersions:
GET /nodes/{node}/apt/versions
Get package information for important Proxmox packages. - Get-PveNodesCapabilities:
GET /nodes/{node}/capabilities
Node capabilities index. - Get-PveNodesCapabilitiesQemu:
GET /nodes/{node}/capabilities/qemu
QEMU capabilities index. - Get-PveNodesCapabilitiesQemuCpu:
GET /nodes/{node}/capabilities/qemu/cpu
List all custom and default CPU models. - Get-PveNodesCapabilitiesQemuCpuFlags:
GET /nodes/{node}/capabilities/qemu/cpu-flags
List of available VM-specific CPU flags. - Get-PveNodesCapabilitiesQemuMachines:
GET /nodes/{node}/capabilities/qemu/machines
Get available QEMU/KVM machine types. - Get-PveNodesCapabilitiesQemuMigration:
GET /nodes/{node}/capabilities/qemu/migration
Get node-specific QEMU migration capabilities of the node. - Get-PveNodesCeph:
GET /nodes/{node}/ceph
Directory index. - Get-PveNodesCephCfg:
GET /nodes/{node}/ceph/cfg
Directory index. - Get-PveNodesCephCfgDb:
GET /nodes/{node}/ceph/cfg/db
Get the Ceph configuration database. - Get-PveNodesCephCfgRaw:
GET /nodes/{node}/ceph/cfg/raw
Get the Ceph configuration file. - Get-PveNodesCephCfgValue:
GET /nodes/{node}/ceph/cfg/value
Get configured values from either ceph.conf or the mon config DB. - Get-PveNodesCephCmdSafety:
GET /nodes/{node}/ceph/cmd-safety
Heuristical check if it is safe to perform an action. - Get-PveNodesCephCrush:
GET /nodes/{node}/ceph/crush
Get OSD crush map - Get-PveNodesCephFs:
GET /nodes/{node}/ceph/fs
Directory index. - Remove-PveNodesCephFs:
DELETE /nodes/{node}/ceph/fs/{name}
Destroy a Ceph filesystem. - New-PveNodesCephFs:
POST /nodes/{node}/ceph/fs/{name}
Create a Ceph filesystem - New-PveNodesCephInit:
POST /nodes/{node}/ceph/init
Create the initial Ceph default configuration and set up symlinks. - Get-PveNodesCephLog:
GET /nodes/{node}/ceph/log
Read ceph log - Get-PveNodesCephMds:
GET /nodes/{node}/ceph/mds
MDS directory index. - Remove-PveNodesCephMds:
DELETE /nodes/{node}/ceph/mds/{name}
Destroy Ceph Metadata Server - New-PveNodesCephMds:
POST /nodes/{node}/ceph/mds/{name}
Create Ceph Metadata Server (MDS) - Get-PveNodesCephMgr:
GET /nodes/{node}/ceph/mgr
MGR directory index. - Remove-PveNodesCephMgr:
DELETE /nodes/{node}/ceph/mgr/{id}
Destroy Ceph Manager. - New-PveNodesCephMgr:
POST /nodes/{node}/ceph/mgr/{id}
Create Ceph Manager - Get-PveNodesCephMon:
GET /nodes/{node}/ceph/mon
Get Ceph monitor list. - Remove-PveNodesCephMon:
DELETE /nodes/{node}/ceph/mon/{monid}
Destroy a Ceph Monitor. - New-PveNodesCephMon:
POST /nodes/{node}/ceph/mon/{monid}
Create a Ceph Monitor. - Get-PveNodesCephOsd:
GET /nodes/{node}/ceph/osd
Get Ceph osd list/tree. - New-PveNodesCephOsd:
POST /nodes/{node}/ceph/osd
Create OSD - Remove-PveNodesCephOsd:
DELETE /nodes/{node}/ceph/osd/{osdid}
Destroy OSD - Get-PveNodesCephOsdIdx:
GET /nodes/{node}/ceph/osd/{osdid}
OSD index. - New-PveNodesCephOsdIn:
POST /nodes/{node}/ceph/osd/{osdid}/in
ceph osd in - Get-PveNodesCephOsdLvInfo:
GET /nodes/{node}/ceph/osd/{osdid}/lv-info
Get OSD volume details - Get-PveNodesCephOsdMetadata:
GET /nodes/{node}/ceph/osd/{osdid}/metadata
Get OSD details - New-PveNodesCephOsdOut:
POST /nodes/{node}/ceph/osd/{osdid}/out
ceph osd out - New-PveNodesCephOsdScrub:
POST /nodes/{node}/ceph/osd/{osdid}/scrub
Instruct the OSD to scrub. - Get-PveNodesCephPool:
GET /nodes/{node}/ceph/pool
List all pools and their settings (which are settable by the POST/PUT endpoints). - New-PveNodesCephPool:
POST /nodes/{node}/ceph/pool
Create Ceph pool - Remove-PveNodesCephPool:
DELETE /nodes/{node}/ceph/pool/{name}
Destroy pool - Get-PveNodesCephPoolIdx:
GET /nodes/{node}/ceph/pool/{name}
Pool index. - Set-PveNodesCephPool:
PUT /nodes/{node}/ceph/pool/{name}
Change POOL settings - Get-PveNodesCephPoolStatus:
GET /nodes/{node}/ceph/pool/{name}/status
Show the current pool status. - Get-PveNodesCephReleases:
GET /nodes/{node}/ceph/releases
List all known Ceph releases, marking which ones can be installed on this node. - New-PveNodesCephRestart:
POST /nodes/{node}/ceph/restart
Restart ceph services. - New-PveNodesCephRestartBulk:
POST /nodes/{node}/ceph/restart-bulk
Rolling restart of all Ceph OSDs on this node. - Get-PveNodesCephRules:
GET /nodes/{node}/ceph/rules
List ceph rules. - New-PveNodesCephStart:
POST /nodes/{node}/ceph/start
Start ceph services. - Get-PveNodesCephStatus:
GET /nodes/{node}/ceph/status
Get the Ceph cluster status (raw ‘ceph status’ output). - New-PveNodesCephStop:
POST /nodes/{node}/ceph/stop
Stop ceph services. - Get-PveNodesCertificates:
GET /nodes/{node}/certificates
Node index. - Get-PveNodesCertificatesAcme:
GET /nodes/{node}/certificates/acme
ACME index. - Remove-PveNodesCertificatesAcmeCertificate:
DELETE /nodes/{node}/certificates/acme/certificate
Revoke existing certificate from CA. - New-PveNodesCertificatesAcmeCertificate:
POST /nodes/{node}/certificates/acme/certificate
Order a new certificate from ACME-compatible CA. - Set-PveNodesCertificatesAcmeCertificate:
PUT /nodes/{node}/certificates/acme/certificate
Renew existing certificate from CA. - Remove-PveNodesCertificatesCustom:
DELETE /nodes/{node}/certificates/custom
DELETE custom certificate chain and key. - New-PveNodesCertificatesCustom:
POST /nodes/{node}/certificates/custom
Upload or update custom certificate chain and key. - Get-PveNodesCertificatesInfo:
GET /nodes/{node}/certificates/info
Get information about node’s certificates. - Get-PveNodesConfig:
GET /nodes/{node}/config
Get node configuration options. - Set-PveNodesConfig:
PUT /nodes/{node}/config
Set node configuration options. - Get-PveNodesDisks:
GET /nodes/{node}/disks
Node index. - Get-PveNodesDisksDirectory:
GET /nodes/{node}/disks/directory
PVE Managed Directory storages. - New-PveNodesDisksDirectory:
POST /nodes/{node}/disks/directory
Create a Filesystem on an unused disk. - Remove-PveNodesDisksDirectory:
DELETE /nodes/{node}/disks/directory/{name}
Unmounts the storage and removes the mount unit. - New-PveNodesDisksInitgpt:
POST /nodes/{node}/disks/initgpt
Initialize Disk with GPT - Get-PveNodesDisksList:
GET /nodes/{node}/disks/list
List local disks. - Get-PveNodesDisksLvm:
GET /nodes/{node}/disks/lvm
List LVM Volume Groups - New-PveNodesDisksLvm:
POST /nodes/{node}/disks/lvm
Create an LVM Volume Group - Remove-PveNodesDisksLvm:
DELETE /nodes/{node}/disks/lvm/{name}
Remove an LVM Volume Group. - Get-PveNodesDisksLvmthin:
GET /nodes/{node}/disks/lvmthin
List LVM thinpools - New-PveNodesDisksLvmthin:
POST /nodes/{node}/disks/lvmthin
Create an LVM thinpool - Remove-PveNodesDisksLvmthin:
DELETE /nodes/{node}/disks/lvmthin/{name}
Remove an LVM thin pool. - Get-PveNodesDisksSmart:
GET /nodes/{node}/disks/smart
Get SMART Health of a disk. - Set-PveNodesDisksWipedisk:
PUT /nodes/{node}/disks/wipedisk
Wipe a disk or partition. - Get-PveNodesDisksZfs:
GET /nodes/{node}/disks/zfs
List Zpools. - New-PveNodesDisksZfs:
POST /nodes/{node}/disks/zfs
Create a ZFS pool. - Remove-PveNodesDisksZfs:
DELETE /nodes/{node}/disks/zfs/{name}
Destroy a ZFS pool. - Get-PveNodesDisksZfsIdx:
GET /nodes/{node}/disks/zfs/{name}
Get details about a zpool. - Get-PveNodesDns:
GET /nodes/{node}/dns
Read DNS settings. - Set-PveNodesDns:
PUT /nodes/{node}/dns
Write DNS settings. - New-PveNodesExecute:
POST /nodes/{node}/execute
Execute multiple commands in order, root only. - Get-PveNodesFirewall:
GET /nodes/{node}/firewall
Directory index. - Get-PveNodesFirewallLog:
GET /nodes/{node}/firewall/log
Read firewall log - Get-PveNodesFirewallOptions:
GET /nodes/{node}/firewall/options
Get host firewall options. - Set-PveNodesFirewallOptions:
PUT /nodes/{node}/firewall/options
Set Firewall options. - Get-PveNodesFirewallRules:
GET /nodes/{node}/firewall/rules
List rules. - New-PveNodesFirewallRules:
POST /nodes/{node}/firewall/rules
Create new rule. - Remove-PveNodesFirewallRules:
DELETE /nodes/{node}/firewall/rules/{pos}
Delete rule. - Get-PveNodesFirewallRulesIdx:
GET /nodes/{node}/firewall/rules/{pos}
Get single rule data. - Set-PveNodesFirewallRules:
PUT /nodes/{node}/firewall/rules/{pos}
Modify rule data. - Get-PveNodesHardware:
GET /nodes/{node}/hardware
Index of hardware types - Get-PveNodesHardwarePci:
GET /nodes/{node}/hardware/pci
List local PCI devices. - Get-PveNodesHardwarePciIdx:
GET /nodes/{node}/hardware/pci/{pci-id-or-mapping}
Index of available pci methods - Get-PveNodesHardwarePciMdev:
GET /nodes/{node}/hardware/pci/{pci-id-or-mapping}/mdev
List mediated device types for given PCI device. - Get-PveNodesHardwareUsb:
GET /nodes/{node}/hardware/usb
List local USB devices. - Get-PveNodesHosts:
GET /nodes/{node}/hosts
Get the content of /etc/hosts. - New-PveNodesHosts:
POST /nodes/{node}/hosts
Write /etc/hosts. - Get-PveNodesJournal:
GET /nodes/{node}/journal
Read Journal - Get-PveNodesLxc:
GET /nodes/{node}/lxc
LXC container index (per node). - New-PveNodesLxc:
POST /nodes/{node}/lxc
Create or restore a container. - Remove-PveNodesLxc:
DELETE /nodes/{node}/lxc/{vmid}
Destroy the container (also delete all uses files). - Get-PveNodesLxcIdx:
GET /nodes/{node}/lxc/{vmid}
Directory index - New-PveNodesLxcClone:
POST /nodes/{node}/lxc/{vmid}/clone
Create a container clone/copy - Get-PveNodesLxcConfig:
GET /nodes/{node}/lxc/{vmid}/config
Get container configuration. - Set-PveNodesLxcConfig:
PUT /nodes/{node}/lxc/{vmid}/config
Set container options. - Get-PveNodesLxcFeature:
GET /nodes/{node}/lxc/{vmid}/feature
Check if feature for virtual machine is available. - Get-PveNodesLxcFirewall:
GET /nodes/{node}/lxc/{vmid}/firewall
Directory index. - Get-PveNodesLxcFirewallAliases:
GET /nodes/{node}/lxc/{vmid}/firewall/aliases
List aliases - New-PveNodesLxcFirewallAliases:
POST /nodes/{node}/lxc/{vmid}/firewall/aliases
Create IP or Network Alias. - Remove-PveNodesLxcFirewallAliases:
DELETE /nodes/{node}/lxc/{vmid}/firewall/aliases/{name}
Remove IP or Network alias. - Get-PveNodesLxcFirewallAliasesIdx:
GET /nodes/{node}/lxc/{vmid}/firewall/aliases/{name}
Read alias. - Set-PveNodesLxcFirewallAliases:
PUT /nodes/{node}/lxc/{vmid}/firewall/aliases/{name}
Update IP or Network alias. - Get-PveNodesLxcFirewallIpset:
GET /nodes/{node}/lxc/{vmid}/firewall/ipset
List IPSets - New-PveNodesLxcFirewallIpset:
POST /nodes/{node}/lxc/{vmid}/firewall/ipset
Create new IPSet - Remove-PveNodesLxcFirewallIpset:
DELETE /nodes/{node}/lxc/{vmid}/firewall/ipset/{name}
Delete IPSet - Get-PveNodesLxcFirewallIpsetIdx:
GET /nodes/{node}/lxc/{vmid}/firewall/ipset/{name}
List IPSet content - New-PveNodesLxcFirewallIpsetIdx:
POST /nodes/{node}/lxc/{vmid}/firewall/ipset/{name}
Add IP or Network to IPSet. - Remove-PveNodesLxcFirewallIpsetIdx:
DELETE /nodes/{node}/lxc/{vmid}/firewall/ipset/{name}/{cidr}
Remove IP or Network from IPSet. - Get-PveNodesLxcFirewallIpsetIdx1:
GET /nodes/{node}/lxc/{vmid}/firewall/ipset/{name}/{cidr}
Read IP or Network settings from IPSet. - Set-PveNodesLxcFirewallIpset:
PUT /nodes/{node}/lxc/{vmid}/firewall/ipset/{name}/{cidr}
Update IP or Network settings - Get-PveNodesLxcFirewallLog:
GET /nodes/{node}/lxc/{vmid}/firewall/log
Read firewall log - Get-PveNodesLxcFirewallOptions:
GET /nodes/{node}/lxc/{vmid}/firewall/options
Get VM firewall options. - Set-PveNodesLxcFirewallOptions:
PUT /nodes/{node}/lxc/{vmid}/firewall/options
Set Firewall options. - Get-PveNodesLxcFirewallRefs:
GET /nodes/{node}/lxc/{vmid}/firewall/refs
Lists possible IPSet/Alias reference which are allowed in source/dest properties. - Get-PveNodesLxcFirewallRules:
GET /nodes/{node}/lxc/{vmid}/firewall/rules
List rules. - New-PveNodesLxcFirewallRules:
POST /nodes/{node}/lxc/{vmid}/firewall/rules
Create new rule. - Remove-PveNodesLxcFirewallRules:
DELETE /nodes/{node}/lxc/{vmid}/firewall/rules/{pos}
Delete rule. - Get-PveNodesLxcFirewallRulesIdx:
GET /nodes/{node}/lxc/{vmid}/firewall/rules/{pos}
Get single rule data. - Set-PveNodesLxcFirewallRules:
PUT /nodes/{node}/lxc/{vmid}/firewall/rules/{pos}
Modify rule data. - Get-PveNodesLxcInterfaces:
GET /nodes/{node}/lxc/{vmid}/interfaces
Get IP addresses of the specified container interface. - Get-PveNodesLxcMigrate:
GET /nodes/{node}/lxc/{vmid}/migrate
Get preconditions for migration. - New-PveNodesLxcMigrate:
POST /nodes/{node}/lxc/{vmid}/migrate
Migrate the container to another node. - New-PveNodesLxcMoveVolume:
POST /nodes/{node}/lxc/{vmid}/move_volume
Move a rootfs-/mp-volume to a different storage or to a different container. - New-PveNodesLxcMtunnel:
POST /nodes/{node}/lxc/{vmid}/mtunnel
Migration tunnel endpoint - only for internal use by CT migration. - Get-PveNodesLxcMtunnelwebsocket:
GET /nodes/{node}/lxc/{vmid}/mtunnelwebsocket
Migration tunnel endpoint for websocket upgrade - only for internal use by VM migration. - Get-PveNodesLxcPending:
GET /nodes/{node}/lxc/{vmid}/pending
Get container configuration, including pending changes. - New-PveNodesLxcRemoteMigrate:
POST /nodes/{node}/lxc/{vmid}/remote_migrate
Migrate the container to another cluster. - Set-PveNodesLxcResize:
PUT /nodes/{node}/lxc/{vmid}/resize
Resize a container mount point. - Get-PveNodesLxcRrd:
GET /nodes/{node}/lxc/{vmid}/rrd
Read VM RRD statistics (returns PNG) - Get-PveNodesLxcRrddata:
GET /nodes/{node}/lxc/{vmid}/rrddata
Read VM RRD statistics - Get-PveNodesLxcSnapshot:
GET /nodes/{node}/lxc/{vmid}/snapshot
List all snapshots. - New-PveNodesLxcSnapshot:
POST /nodes/{node}/lxc/{vmid}/snapshot
Snapshot a container. - Remove-PveNodesLxcSnapshot:
DELETE /nodes/{node}/lxc/{vmid}/snapshot/{snapname}
Delete a LXC snapshot. - Get-PveNodesLxcSnapshotIdx:
GET /nodes/{node}/lxc/{vmid}/snapshot/{snapname} - Get-PveNodesLxcSnapshotConfig:
GET /nodes/{node}/lxc/{vmid}/snapshot/{snapname}/config
Get snapshot configuration - Set-PveNodesLxcSnapshotConfig:
PUT /nodes/{node}/lxc/{vmid}/snapshot/{snapname}/config
Update snapshot metadata. - New-PveNodesLxcSnapshotRollback:
POST /nodes/{node}/lxc/{vmid}/snapshot/{snapname}/rollback
Rollback LXC state to specified snapshot. - New-PveNodesLxcSpiceproxy:
POST /nodes/{node}/lxc/{vmid}/spiceproxy
Returns a SPICE configuration to connect to the CT. - Get-PveNodesLxcStatus:
GET /nodes/{node}/lxc/{vmid}/status
Directory index - Get-PveNodesLxcStatusCurrent:
GET /nodes/{node}/lxc/{vmid}/status/current
Get virtual machine status. - New-PveNodesLxcStatusReboot:
POST /nodes/{node}/lxc/{vmid}/status/reboot
Reboot the container by shutting it down, and starting it again. - New-PveNodesLxcStatusResume:
POST /nodes/{node}/lxc/{vmid}/status/resume
Resume the container. - New-PveNodesLxcStatusShutdown:
POST /nodes/{node}/lxc/{vmid}/status/shutdown
Shutdown the container. - New-PveNodesLxcStatusStart:
POST /nodes/{node}/lxc/{vmid}/status/start
Start the container. - New-PveNodesLxcStatusStop:
POST /nodes/{node}/lxc/{vmid}/status/stop
Stop the container. - New-PveNodesLxcStatusSuspend:
POST /nodes/{node}/lxc/{vmid}/status/suspend
Suspend the container. - New-PveNodesLxcTemplate:
POST /nodes/{node}/lxc/{vmid}/template
Create a Template. - New-PveNodesLxcTermproxy:
POST /nodes/{node}/lxc/{vmid}/termproxy
Creates a TCP proxy connection. - New-PveNodesLxcVncproxy:
POST /nodes/{node}/lxc/{vmid}/vncproxy
Creates a TCP VNC proxy connections. - Get-PveNodesLxcVncwebsocket:
GET /nodes/{node}/lxc/{vmid}/vncwebsocket
Opens a websocket for VNC traffic. - New-PveNodesMigrateall:
POST /nodes/{node}/migrateall
Migrate all VMs and Containers. - Get-PveNodesNetstat:
GET /nodes/{node}/netstat
Read tap/vm network device interface counters - Remove-PveNodesNetwork:
DELETE /nodes/{node}/network
Revert network configuration changes. - Get-PveNodesNetwork:
GET /nodes/{node}/network
List available networks - New-PveNodesNetwork:
POST /nodes/{node}/network
Create network device configuration - Set-PveNodesNetwork:
PUT /nodes/{node}/network
Reload network configuration - Remove-PveNodesNetworkIdx:
DELETE /nodes/{node}/network/{iface}
Delete network device configuration - Get-PveNodesNetworkIdx:
GET /nodes/{node}/network/{iface}
Read network device configuration - Set-PveNodesNetworkIdx:
PUT /nodes/{node}/network/{iface}
Update network device configuration - Get-PveNodesQemu:
GET /nodes/{node}/qemu
Virtual machine index (per node). - New-PveNodesQemu:
POST /nodes/{node}/qemu
Create or restore a virtual machine. - Remove-PveNodesQemu:
DELETE /nodes/{node}/qemu/{vmid}
Destroy the VM and all used/owned volumes. - Get-PveNodesQemuIdx:
GET /nodes/{node}/qemu/{vmid}
Directory index - Get-PveNodesQemuAgent:
GET /nodes/{node}/qemu/{vmid}/agent
QEMU Guest Agent command index. - New-PveNodesQemuAgent:
POST /nodes/{node}/qemu/{vmid}/agent
Execute QEMU Guest Agent commands. - New-PveNodesQemuAgentExec:
POST /nodes/{node}/qemu/{vmid}/agent/exec
Executes the given command in the vm via the guest-agent and returns an object with the pid. - Get-PveNodesQemuAgentExecStatus:
GET /nodes/{node}/qemu/{vmid}/agent/exec-status
Gets the status of the given pid started by the guest-agent - Get-PveNodesQemuAgentFileRead:
GET /nodes/{node}/qemu/{vmid}/agent/file-read
Reads the given file via guest agent. - New-PveNodesQemuAgentFileWrite:
POST /nodes/{node}/qemu/{vmid}/agent/file-write
Writes the given file via guest agent. - New-PveNodesQemuAgentFsfreezeFreeze:
POST /nodes/{node}/qemu/{vmid}/agent/fsfreeze-freeze
Execute fsfreeze-freeze. - New-PveNodesQemuAgentFsfreezeStatus:
POST /nodes/{node}/qemu/{vmid}/agent/fsfreeze-status
Execute fsfreeze-status. - New-PveNodesQemuAgentFsfreezeThaw:
POST /nodes/{node}/qemu/{vmid}/agent/fsfreeze-thaw
Execute fsfreeze-thaw. - New-PveNodesQemuAgentFstrim:
POST /nodes/{node}/qemu/{vmid}/agent/fstrim
Execute fstrim. - Get-PveNodesQemuAgentGetFsinfo:
GET /nodes/{node}/qemu/{vmid}/agent/get-fsinfo
Execute get-fsinfo. - Get-PveNodesQemuAgentGetHostName:
GET /nodes/{node}/qemu/{vmid}/agent/get-host-name
Execute get-host-name. - Get-PveNodesQemuAgentGetMemoryBlockInfo:
GET /nodes/{node}/qemu/{vmid}/agent/get-memory-block-info
Execute get-memory-block-info. - Get-PveNodesQemuAgentGetMemoryBlocks:
GET /nodes/{node}/qemu/{vmid}/agent/get-memory-blocks
Execute get-memory-blocks. - Get-PveNodesQemuAgentGetOsinfo:
GET /nodes/{node}/qemu/{vmid}/agent/get-osinfo
Execute get-osinfo. - Get-PveNodesQemuAgentGetTime:
GET /nodes/{node}/qemu/{vmid}/agent/get-time
Execute get-time. - Get-PveNodesQemuAgentGetTimezone:
GET /nodes/{node}/qemu/{vmid}/agent/get-timezone
Execute get-timezone. - Get-PveNodesQemuAgentGetUsers:
GET /nodes/{node}/qemu/{vmid}/agent/get-users
Execute get-users. - Get-PveNodesQemuAgentGetVcpus:
GET /nodes/{node}/qemu/{vmid}/agent/get-vcpus
Execute get-vcpus. - Get-PveNodesQemuAgentInfo:
GET /nodes/{node}/qemu/{vmid}/agent/info
Execute info. - Get-PveNodesQemuAgentNetworkGetInterfaces:
GET /nodes/{node}/qemu/{vmid}/agent/network-get-interfaces
Execute network-get-interfaces. - New-PveNodesQemuAgentPing:
POST /nodes/{node}/qemu/{vmid}/agent/ping
Execute ping. - New-PveNodesQemuAgentSetUserPassword:
POST /nodes/{node}/qemu/{vmid}/agent/set-user-password
Sets the password for the given user to the given password - New-PveNodesQemuAgentShutdown:
POST /nodes/{node}/qemu/{vmid}/agent/shutdown
Execute shutdown. - New-PveNodesQemuAgentSuspendDisk:
POST /nodes/{node}/qemu/{vmid}/agent/suspend-disk
Execute suspend-disk. - New-PveNodesQemuAgentSuspendHybrid:
POST /nodes/{node}/qemu/{vmid}/agent/suspend-hybrid
Execute suspend-hybrid. - New-PveNodesQemuAgentSuspendRam:
POST /nodes/{node}/qemu/{vmid}/agent/suspend-ram
Execute suspend-ram. - New-PveNodesQemuClone:
POST /nodes/{node}/qemu/{vmid}/clone
Create a copy of virtual machine/template. - Get-PveNodesQemuCloudinit:
GET /nodes/{node}/qemu/{vmid}/cloudinit
Get the cloudinit configuration with both current and pending values. - Set-PveNodesQemuCloudinit:
PUT /nodes/{node}/qemu/{vmid}/cloudinit
Regenerate and change cloudinit config drive. - Get-PveNodesQemuCloudinitDump:
GET /nodes/{node}/qemu/{vmid}/cloudinit/dump
Get automatically generated cloudinit config. - Get-PveNodesQemuConfig:
GET /nodes/{node}/qemu/{vmid}/config
Get the virtual machine configuration with pending configuration changes applied. - New-PveNodesQemuConfig:
POST /nodes/{node}/qemu/{vmid}/config
Set virtual machine options (asynchronous API). - Set-PveNodesQemuConfig:
PUT /nodes/{node}/qemu/{vmid}/config
Set virtual machine options (synchronous API) - You should consider using the POST method instead for any actions involving hotplug or storage allocation. - New-PveNodesQemuDbusVmstate:
POST /nodes/{node}/qemu/{vmid}/dbus-vmstate
Control the dbus-vmstate helper for a given running VM. - Get-PveNodesQemuFeature:
GET /nodes/{node}/qemu/{vmid}/feature
Check if feature for virtual machine is available. - Get-PveNodesQemuFirewall:
GET /nodes/{node}/qemu/{vmid}/firewall
Directory index. - Get-PveNodesQemuFirewallAliases:
GET /nodes/{node}/qemu/{vmid}/firewall/aliases
List aliases - New-PveNodesQemuFirewallAliases:
POST /nodes/{node}/qemu/{vmid}/firewall/aliases
Create IP or Network Alias. - Remove-PveNodesQemuFirewallAliases:
DELETE /nodes/{node}/qemu/{vmid}/firewall/aliases/{name}
Remove IP or Network alias. - Get-PveNodesQemuFirewallAliasesIdx:
GET /nodes/{node}/qemu/{vmid}/firewall/aliases/{name}
Read alias. - Set-PveNodesQemuFirewallAliases:
PUT /nodes/{node}/qemu/{vmid}/firewall/aliases/{name}
Update IP or Network alias. - Get-PveNodesQemuFirewallIpset:
GET /nodes/{node}/qemu/{vmid}/firewall/ipset
List IPSets - New-PveNodesQemuFirewallIpset:
POST /nodes/{node}/qemu/{vmid}/firewall/ipset
Create new IPSet - Remove-PveNodesQemuFirewallIpset:
DELETE /nodes/{node}/qemu/{vmid}/firewall/ipset/{name}
Delete IPSet - Get-PveNodesQemuFirewallIpsetIdx:
GET /nodes/{node}/qemu/{vmid}/firewall/ipset/{name}
List IPSet content - New-PveNodesQemuFirewallIpsetIdx:
POST /nodes/{node}/qemu/{vmid}/firewall/ipset/{name}
Add IP or Network to IPSet. - Remove-PveNodesQemuFirewallIpsetIdx:
DELETE /nodes/{node}/qemu/{vmid}/firewall/ipset/{name}/{cidr}
Remove IP or Network from IPSet. - Get-PveNodesQemuFirewallIpsetIdx1:
GET /nodes/{node}/qemu/{vmid}/firewall/ipset/{name}/{cidr}
Read IP or Network settings from IPSet. - Set-PveNodesQemuFirewallIpset:
PUT /nodes/{node}/qemu/{vmid}/firewall/ipset/{name}/{cidr}
Update IP or Network settings - Get-PveNodesQemuFirewallLog:
GET /nodes/{node}/qemu/{vmid}/firewall/log
Read firewall log - Get-PveNodesQemuFirewallOptions:
GET /nodes/{node}/qemu/{vmid}/firewall/options
Get VM firewall options. - Set-PveNodesQemuFirewallOptions:
PUT /nodes/{node}/qemu/{vmid}/firewall/options
Set Firewall options. - Get-PveNodesQemuFirewallRefs:
GET /nodes/{node}/qemu/{vmid}/firewall/refs
Lists possible IPSet/Alias reference which are allowed in source/dest properties. - Get-PveNodesQemuFirewallRules:
GET /nodes/{node}/qemu/{vmid}/firewall/rules
List rules. - New-PveNodesQemuFirewallRules:
POST /nodes/{node}/qemu/{vmid}/firewall/rules
Create new rule. - Remove-PveNodesQemuFirewallRules:
DELETE /nodes/{node}/qemu/{vmid}/firewall/rules/{pos}
Delete rule. - Get-PveNodesQemuFirewallRulesIdx:
GET /nodes/{node}/qemu/{vmid}/firewall/rules/{pos}
Get single rule data. - Set-PveNodesQemuFirewallRules:
PUT /nodes/{node}/qemu/{vmid}/firewall/rules/{pos}
Modify rule data. - Get-PveNodesQemuMigrate:
GET /nodes/{node}/qemu/{vmid}/migrate
Get preconditions for migration. - New-PveNodesQemuMigrate:
POST /nodes/{node}/qemu/{vmid}/migrate
Migrate virtual machine. - New-PveNodesQemuMonitor:
POST /nodes/{node}/qemu/{vmid}/monitor
Execute QEMU monitor commands. - New-PveNodesQemuMoveDisk:
POST /nodes/{node}/qemu/{vmid}/move_disk
Move volume to different storage or to a different VM. - New-PveNodesQemuMtunnel:
POST /nodes/{node}/qemu/{vmid}/mtunnel
Migration tunnel endpoint - only for internal use by VM migration. - Get-PveNodesQemuMtunnelwebsocket:
GET /nodes/{node}/qemu/{vmid}/mtunnelwebsocket
Migration tunnel endpoint for websocket upgrade - only for internal use by VM migration. - Get-PveNodesQemuPending:
GET /nodes/{node}/qemu/{vmid}/pending
Get the virtual machine configuration with both current and pending values. - New-PveNodesQemuRemoteMigrate:
POST /nodes/{node}/qemu/{vmid}/remote_migrate
Migrate virtual machine to a remote cluster. - Set-PveNodesQemuResize:
PUT /nodes/{node}/qemu/{vmid}/resize
Extend volume size. - Get-PveNodesQemuRrd:
GET /nodes/{node}/qemu/{vmid}/rrd
Read VM RRD statistics (returns PNG) - Get-PveNodesQemuRrddata:
GET /nodes/{node}/qemu/{vmid}/rrddata
Read VM RRD statistics - Set-PveNodesQemuSendkey:
PUT /nodes/{node}/qemu/{vmid}/sendkey
Send key event to virtual machine. - Get-PveNodesQemuSnapshot:
GET /nodes/{node}/qemu/{vmid}/snapshot
List all snapshots. - New-PveNodesQemuSnapshot:
POST /nodes/{node}/qemu/{vmid}/snapshot
Snapshot a VM. - Remove-PveNodesQemuSnapshot:
DELETE /nodes/{node}/qemu/{vmid}/snapshot/{snapname}
Delete a VM snapshot. - Get-PveNodesQemuSnapshotIdx:
GET /nodes/{node}/qemu/{vmid}/snapshot/{snapname} - Get-PveNodesQemuSnapshotConfig:
GET /nodes/{node}/qemu/{vmid}/snapshot/{snapname}/config
Get snapshot configuration - Set-PveNodesQemuSnapshotConfig:
PUT /nodes/{node}/qemu/{vmid}/snapshot/{snapname}/config
Update snapshot metadata. - New-PveNodesQemuSnapshotRollback:
POST /nodes/{node}/qemu/{vmid}/snapshot/{snapname}/rollback
Rollback VM state to specified snapshot. - New-PveNodesQemuSpiceproxy:
POST /nodes/{node}/qemu/{vmid}/spiceproxy
Returns a SPICE configuration to connect to the VM. - Get-PveNodesQemuStatus:
GET /nodes/{node}/qemu/{vmid}/status
Directory index - Get-PveNodesQemuStatusCurrent:
GET /nodes/{node}/qemu/{vmid}/status/current
Get virtual machine status. - New-PveNodesQemuStatusReboot:
POST /nodes/{node}/qemu/{vmid}/status/reboot
Reboot the VM by shutting it down, and starting it again. - New-PveNodesQemuStatusReset:
POST /nodes/{node}/qemu/{vmid}/status/reset
Reset virtual machine. - New-PveNodesQemuStatusResume:
POST /nodes/{node}/qemu/{vmid}/status/resume
Resume virtual machine. - New-PveNodesQemuStatusShutdown:
POST /nodes/{node}/qemu/{vmid}/status/shutdown
Shutdown virtual machine. - New-PveNodesQemuStatusStart:
POST /nodes/{node}/qemu/{vmid}/status/start
Start virtual machine. - New-PveNodesQemuStatusStop:
POST /nodes/{node}/qemu/{vmid}/status/stop
Stop virtual machine. - New-PveNodesQemuStatusSuspend:
POST /nodes/{node}/qemu/{vmid}/status/suspend
Suspend virtual machine. - New-PveNodesQemuTemplate:
POST /nodes/{node}/qemu/{vmid}/template
Create a Template. - New-PveNodesQemuTermproxy:
POST /nodes/{node}/qemu/{vmid}/termproxy
Creates a TCP proxy connections. - Set-PveNodesQemuUnlink:
PUT /nodes/{node}/qemu/{vmid}/unlink
Unlink/delete disk images. - New-PveNodesQemuVncproxy:
POST /nodes/{node}/qemu/{vmid}/vncproxy
Creates a TCP VNC proxy connections. - Get-PveNodesQemuVncwebsocket:
GET /nodes/{node}/qemu/{vmid}/vncwebsocket
Opens a websocket for VNC traffic. - Get-PveNodesQueryOciRepoTags:
GET /nodes/{node}/query-oci-repo-tags
List all tags for an OCI repository reference. - Get-PveNodesQueryUrlMetadata:
GET /nodes/{node}/query-url-metadata
Query metadata of an URL: file size, file name and mime type. - Get-PveNodesReplication:
GET /nodes/{node}/replication
List status of all replication jobs on this node. - Get-PveNodesReplicationIdx:
GET /nodes/{node}/replication/{id}
Directory index. - Get-PveNodesReplicationLog:
GET /nodes/{node}/replication/{id}/log
Read replication job log. - New-PveNodesReplicationScheduleNow:
POST /nodes/{node}/replication/{id}/schedule_now
Schedule replication job to start as soon as possible. - Get-PveNodesReplicationStatus:
GET /nodes/{node}/replication/{id}/status
Get replication job status. - Get-PveNodesReport:
GET /nodes/{node}/report
Gather various systems information about a node - Get-PveNodesRrd:
GET /nodes/{node}/rrd
Read node RRD statistics (returns PNG) - Get-PveNodesRrddata:
GET /nodes/{node}/rrddata
Read node RRD statistics - Get-PveNodesScan:
GET /nodes/{node}/scan
Index of available scan methods - Get-PveNodesScanCifs:
GET /nodes/{node}/scan/cifs
Scan remote CIFS server. - Get-PveNodesScanIscsi:
GET /nodes/{node}/scan/iscsi
Scan remote iSCSI server. - Get-PveNodesScanLvm:
GET /nodes/{node}/scan/lvm
List local LVM volume groups. - Get-PveNodesScanLvmthin:
GET /nodes/{node}/scan/lvmthin
List local LVM Thin Pools. - Get-PveNodesScanNfs:
GET /nodes/{node}/scan/nfs
Scan remote NFS server. - Get-PveNodesScanPbs:
GET /nodes/{node}/scan/pbs
Scan remote Proxmox Backup Server. - Get-PveNodesScanZfs:
GET /nodes/{node}/scan/zfs
Scan zfs pool list on local node. - Get-PveNodesSdn:
GET /nodes/{node}/sdn
SDN index. - Get-PveNodesSdnFabrics:
GET /nodes/{node}/sdn/fabrics/{fabric}
Directory index for SDN fabric status. - Get-PveNodesSdnFabricsInterfaces:
GET /nodes/{node}/sdn/fabrics/{fabric}/interfaces
Get all interfaces for a fabric. - Get-PveNodesSdnFabricsNeighbors:
GET /nodes/{node}/sdn/fabrics/{fabric}/neighbors
Get all neighbors for a fabric. - Get-PveNodesSdnFabricsRoutes:
GET /nodes/{node}/sdn/fabrics/{fabric}/routes
Get all routes for a fabric. - Get-PveNodesSdnVnets:
GET /nodes/{node}/sdn/vnets/{vnet} - Get-PveNodesSdnVnetsMacVrf:
GET /nodes/{node}/sdn/vnets/{vnet}/mac-vrf
Get the MAC VRF for a VNet in an EVPN zone. - Get-PveNodesSdnZones:
GET /nodes/{node}/sdn/zones
Get status for all zones. - Get-PveNodesSdnZonesIdx:
GET /nodes/{node}/sdn/zones/{zone}
Directory index for SDN zone status. - Get-PveNodesSdnZonesBridges:
GET /nodes/{node}/sdn/zones/{zone}/bridges
Get a list of all bridges (vnets) that are part of a zone, as well as the ports that are members of that bridge. - Get-PveNodesSdnZonesContent:
GET /nodes/{node}/sdn/zones/{zone}/content
List zone content. - Get-PveNodesSdnZonesIpVrf:
GET /nodes/{node}/sdn/zones/{zone}/ip-vrf
Get the IP VRF of an EVPN zone. - Get-PveNodesServices:
GET /nodes/{node}/services
Service list. - Get-PveNodesServicesIdx:
GET /nodes/{node}/services/{service}
Directory index - New-PveNodesServicesReload:
POST /nodes/{node}/services/{service}/reload
Reload service. - New-PveNodesServicesRestart:
POST /nodes/{node}/services/{service}/restart
Hard restart service. - New-PveNodesServicesStart:
POST /nodes/{node}/services/{service}/start
Start service. - Get-PveNodesServicesState:
GET /nodes/{node}/services/{service}/state
Read service properties - New-PveNodesServicesStop:
POST /nodes/{node}/services/{service}/stop
Stop service. - New-PveNodesSpiceshell:
POST /nodes/{node}/spiceshell
Creates a SPICE shell. - New-PveNodesStartall:
POST /nodes/{node}/startall
Start all VMs and containers located on this node (by default only those with onboot=1). - Get-PveNodesStatus:
GET /nodes/{node}/status
Read node status - New-PveNodesStatus:
POST /nodes/{node}/status
Reboot or shutdown a node. - New-PveNodesStopall:
POST /nodes/{node}/stopall
Stop all VMs and Containers. - Get-PveNodesStorage:
GET /nodes/{node}/storage
Get status for all datastores. - Get-PveNodesStorageIdx:
GET /nodes/{node}/storage/{storage} - Get-PveNodesStorageContent:
GET /nodes/{node}/storage/{storage}/content
List storage content. - New-PveNodesStorageContent:
POST /nodes/{node}/storage/{storage}/content
Allocate disk images. - Remove-PveNodesStorageContent:
DELETE /nodes/{node}/storage/{storage}/content/{volume}
Delete volume - Get-PveNodesStorageContentIdx:
GET /nodes/{node}/storage/{storage}/content/{volume}
Get volume attributes - New-PveNodesStorageContentIdx:
POST /nodes/{node}/storage/{storage}/content/{volume}
Copy a volume. - Set-PveNodesStorageContent:
PUT /nodes/{node}/storage/{storage}/content/{volume}
Update volume attributes - New-PveNodesStorageDownloadUrl:
POST /nodes/{node}/storage/{storage}/download-url
Download templates, ISO images, OVAs and VM images by using an URL. - Get-PveNodesStorageFileRestoreDownload:
GET /nodes/{node}/storage/{storage}/file-restore/download
Extract a file or directory (as zip archive) from a PBS backup. - Get-PveNodesStorageFileRestoreList:
GET /nodes/{node}/storage/{storage}/file-restore/list
List files and directories for single file restore under the given path. - Get-PveNodesStorageIdentity:
GET /nodes/{node}/storage/{storage}/identity
Return identity information for this storage instance. - Get-PveNodesStorageImportMetadata:
GET /nodes/{node}/storage/{storage}/import-metadata
Get the base parameters for creating a guest which imports data from a foreign importable guest, like an ESXi VM - New-PveNodesStorageOciRegistryPull:
POST /nodes/{node}/storage/{storage}/oci-registry-pull
Pull an OCI image from a registry. - Remove-PveNodesStoragePrunebackups:
DELETE /nodes/{node}/storage/{storage}/prunebackups
Prune backups. - Get-PveNodesStoragePrunebackups:
GET /nodes/{node}/storage/{storage}/prunebackups
Get prune information for backups. - Get-PveNodesStorageRrd:
GET /nodes/{node}/storage/{storage}/rrd
Read storage RRD statistics (returns PNG). - Get-PveNodesStorageRrddata:
GET /nodes/{node}/storage/{storage}/rrddata
Read storage RRD statistics. - Get-PveNodesStorageStatus:
GET /nodes/{node}/storage/{storage}/status
Read storage status. - New-PveNodesStorageUpload:
POST /nodes/{node}/storage/{storage}/upload
Upload templates, ISO images, OVAs and VM images. - Remove-PveNodesSubscription:
DELETE /nodes/{node}/subscription
Delete subscription key of this node. - Get-PveNodesSubscription:
GET /nodes/{node}/subscription
Read subscription info. - New-PveNodesSubscription:
POST /nodes/{node}/subscription
Update subscription info. - Set-PveNodesSubscription:
PUT /nodes/{node}/subscription
Set subscription key. - New-PveNodesSuspendall:
POST /nodes/{node}/suspendall
Suspend all VMs. - Get-PveNodesSyslog:
GET /nodes/{node}/syslog
Read system log - Get-PveNodesTasks:
GET /nodes/{node}/tasks
Read task list for one node (finished tasks). - Remove-PveNodesTasks:
DELETE /nodes/{node}/tasks/{upid}
Stop a task. - Get-PveNodesTasksIdx:
GET /nodes/{node}/tasks/{upid} - Get-PveNodesTasksLog:
GET /nodes/{node}/tasks/{upid}/log
Read task log. - Get-PveNodesTasksStatus:
GET /nodes/{node}/tasks/{upid}/status
Read task status. - New-PveNodesTermproxy:
POST /nodes/{node}/termproxy
Creates a VNC Shell proxy. - Get-PveNodesTime:
GET /nodes/{node}/time
Read server time and time zone settings. - Set-PveNodesTime:
PUT /nodes/{node}/time
Set time zone. - Get-PveNodesVersion:
GET /nodes/{node}/version
API version details - New-PveNodesVncshell:
POST /nodes/{node}/vncshell
Creates a VNC Shell proxy. - Get-PveNodesVncwebsocket:
GET /nodes/{node}/vncwebsocket
Opens a websocket for VNC traffic. - New-PveNodesVzdump:
POST /nodes/{node}/vzdump
Create backup. - Get-PveNodesVzdumpDefaults:
GET /nodes/{node}/vzdump/defaults
Get the currently configured vzdump defaults. - Get-PveNodesVzdumpExtractconfig:
GET /nodes/{node}/vzdump/extractconfig
Extract configuration from vzdump backup archive. - New-PveNodesWakeonlan:
POST /nodes/{node}/wakeonlan
Try to wake a node via ‘wake on LAN’ network packet.