Skip to content

Get-PvePools

List pools or get pool configuration.

API: GET /pools, Proxmox VE API viewer

Get-PvePools
[-PveTicket <PveTicket>]
[-Poolid <string>]
[-Type <string>]
[<CommonParameters>]
Parameter Type Required Description
-PveTicket PveTicket No Ticket data connection.
-Poolid string No
-Type string No Values: qemu, lxc, storage.

Every parameter also binds by property name from the pipeline, so an object with node and vmid properties (the output of Get-PveGuest, for one) fills -Node and -Vmid. Without -PveTicket the cmdlet uses the last connection, see Connection.

A PveResponse: the data returned by Proxmox VE is in .Response.data, the outcome in .IsSuccessStatusCode. See Results and Errors.