Get-PveNodesStoragePrunebackups
Get prune information for backups. NOTE: this is only a preview and might not be what a subsequent prune call does if backups are removed/added in the meantime.
API: GET /nodes/{node}/storage/{storage}/prunebackups, Proxmox VE API viewer
Syntax
Section titled “Syntax”Get-PveNodesStoragePrunebackups [-PveTicket <PveTicket>] -Node <string> [-PruneBackups <string>] -Storage <string> [-Type <string>] [-Vmid <int>] [<CommonParameters>]Parameters
Section titled “Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
-PveTicket |
PveTicket |
No | Ticket data connection. |
-Node |
string |
Yes | The cluster node name. |
-PruneBackups |
string |
No | Use these retention options instead of those from the storage configuration. |
-Storage |
string |
Yes | The storage identifier. |
-Type |
string |
No | Either ‘qemu’ or ‘lxc’. Only consider backups for guests of this type. Values: qemu, lxc. |
-Vmid |
int |
No | Only consider backups for this guest. |
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.
Output
Section titled “Output”A PveResponse: the data returned by Proxmox VE is in .Response.data, the outcome in .IsSuccessStatusCode. See Results and Errors.
