Skip to content

Get-PveClusterBackupIncludedVolumes

Returns included guests and the backup status of their disks. Optimized to be used in ExtJS tree views.

API: GET /cluster/backup/{id}/included_volumes, Proxmox VE API viewer

Get-PveClusterBackupIncludedVolumes
[-PveTicket <PveTicket>]
-Id <string>
[<CommonParameters>]
Parameter Type Required Description
-PveTicket PveTicket No Ticket data connection.
-Id string Yes The job ID.

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.