Get-PveNodesStorageFileRestoreDownload
Extract a file or directory (as zip archive) from a PBS backup.
API: GET /nodes/{node}/storage/{storage}/file-restore/download, Proxmox VE API viewer
Syntax
Section titled “Syntax”Get-PveNodesStorageFileRestoreDownload [-PveTicket <PveTicket>] -Filepath <string> -Node <string> -Storage <string> [-Tar <bool>] -Volume <string> [<CommonParameters>]Parameters
Section titled “Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
-PveTicket |
PveTicket |
No | Ticket data connection. |
-Filepath |
string |
Yes | base64-path to the directory or file to download. |
-Node |
string |
Yes | The cluster node name. |
-Storage |
string |
Yes | The storage identifier. |
-Tar |
bool |
No | Download dirs as ‘tar.zst’ instead of ‘zip’. |
-Volume |
string |
Yes | Backup volume ID or name. Currently only PBS snapshots are supported. |
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.
