Get-VBRUnstructuredBackupRetrieval

Short Description

Returns active unstructured data retrieval operations.

Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

This cmdlet provides the following parameter sets:

AllParameterSets (Default)

Get-VBRUnstructuredBackupRetrieval [<CommonParameters>]
RestorePoint

Get-VBRUnstructuredBackupRetrieval -RestorePoint <VBRUnstructuredBackupRestorePoint[]> [<CommonParameters>]
NasBackup

Get-VBRUnstructuredBackupRetrieval [-Server <VBRUnstructuredServer[]>] -Backup <VBRUnstructuredBackup[]> [<CommonParameters>]

Detailed Description

This cmdlet returns active unstructured data retrieval operations from archive object storage repositories.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Backup	Specifies an array of backups created by unstructured data backup jobs. The cmdlet will return active retrieval operations for these backups. Accepts the `VBRUnstructuredBackup[]` object. To get this object, run the `Get-VBRUnstructuredBackup` cmdlet.	`VBRUnstructuredBackup[]`	True	Named	True (ByPropertyName, ByValue)
RestorePoint	Specifies an array of restore points created by unstructured data backup jobs. The cmdlet will return active retrieval operations for these restore points. Accepts the `VBRUnstructuredBackupRestorePoint[]` object. To get this object, run the `Get-VBRUnstructuredBackupRestorePoint` cmdlet.	`VBRUnstructuredBackupRestorePoint[]`	True	Named	False
Server	Specifies an array of source servers that store unstructured data. Note: Using this parameter together with the `Backup` parameter allows you to narrow down the list of active retrieval operations to those associated with the specified servers. Accepts the `VBRUnstructuredServer[]` object. To get this object, run the `Get-VBRUnstructuredServer` cmdlet.	`VBRUnstructuredServer[]`	False	Named	True (ByPropertyName)

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

This cmdlet returns the VBRUnstructuredBackupRetrievalOperation object that contains information about an active unstructured data retrieval operation.

Examples

Get-VBRUnstructuredBackupRetrieval Example 1. Getting Active Retrieval Operations for Backups

This example shows how to get active retrieval operations for backups created by the Backup01 job.

$backup = Get-VBRUnstructuredBackup -Name "Backup01"

Get-VBRUnstructuredBackupRetrieval -Backup $backup

Perform the following steps:

Run the Get-VBRUnstructuredBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable.
Run the Get-VBRUnstructuredBackupRetrieval cmdlet. Set the $backup variable as the Backup parameter value.

Get-VBRUnstructuredBackupRetrieval Example 2. Getting Active Retrieval Operations for Restore Points

This example shows how to get active retrieval operations for restore points with the 8e9b3c1a-4d5f-4a2b-9c8d-7e6f5a4b3c2d ID.

$restorepoint = Get-VBRUnstructuredBackupRestorePoint -Id "8e9b3c1a-4d5f-4a2b-9c8d-7e6f5a4b3c2d"

Get-VBRUnstructuredBackupRetrieval -RestorePoint $restorepoint

Perform the following steps:

Run the Get-VBRUnstructuredBackupRestorePoint cmdlet. Specify the Id parameter value. Save the result to the $restorepoint variable.
Run the Get-VBRUnstructuredBackupRetrieval cmdlet. Set the $restorepoint variable as the RestorePoint parameter value.