This is an archive version of the document. To get the most up-to-date information, see the current version.Get-VBRBackupFile
Short Description
Returns backup files.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
This cmdlet provides the following parameter sets.
- To get backup files from the specified backup.
Get-VBRBackupFile -Backup <CBackup> [-Path <string[]>] [<CommonParameters>] |
- To get backup files with the ID option.
Get-VBRBackupFile -Id <guid[]> [<CommonParameters>] |
Detailed Description
This cmdlet returns backup files. You can use this cmdlet to get backup files from an object storage and to move them to the object storage.
Parameters
Parameter | Description | Required | Position | Accept | Accept |
|---|---|---|---|---|---|
Backup | Specifies the backup. The cmdlet will return an array of backup files for this backup. | True | Named | True (ByValue) |
|
Id | Specifies an ID of a backup file. The cmdlet will return the backup file with the specified ID. | True | Named | False |
|
Path | Specifies a relative path to the folder with backup files. | False | Named | False |
|
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.
Return Type
Example 1
This example shows how to get all backup files from the specified backup.
- Run Get-VBRBackup to get the backup. Save the result to the $backup variable.
- Run Get-VBRBackupFile with the $backup variable.
$backup = Get-VBRBackup -Name "Exchange backups" Get-VBRBackupFile -Backup $backup |
Example 2
This example shows how to get all incremental backup files from the specified backup.
- Run Get-VBRBackup to get the backup. Save the result to the $backup variable.
- Run Get-VBRBackupFile with the $backup variable. Use the Path variable to specify a relative path to the folder with the backup files.
$backup = Get-VBRBackup -Name "Exchange backups" Get-VBRBackupFile -Backup $backup -Path "C:\Users\Administrator\Downloads\.vib" |
Related Commands