Get-VBRUnstructuredBackupCopyJob

Short Description

Returns file backup copy jobs and object storage backup jobs.

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

Syntax

This cmdlet provides the following parameter sets:

AllParameterSets (Default)

Get-VBRUnstructuredBackupCopyJob [<CommonParameters>]
NasBackup

Get-VBRUnstructuredBackupCopyJob -ParentJob <VBRUnstructuredBackupJob>

[-BackupRepository <CBackupRepository[]>] [<CommonParameters>]
Name

Get-VBRUnstructuredBackupCopyJob -Name <String[]> [<CommonParameters>]
Id

Get-VBRUnstructuredBackupCopyJob -Id <Guid[]> [<CommonParameters>]

Detailed Description

This cmdlet returns file backup copy jobs and object storage backup jobs.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
BackupRepository	Specifies an array of secondary repositories. The cmdlet will get a file backup copy job or an object storage backup copy job that keep their backup files on these repositories. Accepts the `CBackupRepository[]` object. To create this object, run the `Get-VBRBackupRepository` cmdlet.	`CBackupRepository[]`	False	Named	False
Id	Specifies an ID of a file backup copy job or an object storage backup copy job. The cmdlet will return an array of jobs with the specified ID.	`Guid[]`	True	Named	False
Name	Specifies a name of a file backup copy job or an object storage backup copy job. The cmdlet will return an array of jobs with the specified name.	`String[]`	True	Named	False
ParentJob	Specifies a primary file backup job or an object storage backup job. The cmdlet will return a file backup copy job or an object storage backup copy job that processes backup files of this backup job. Accepts the `VBRUnstructuredBackupJob` object. To get this object, run the `Get-VBRUnstructuredBackupJob` cmdlet.	`VBRUnstructuredBackupJob`	True	Named	False

<CommonParameters>

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

Output Object

The cmdlet returns the VBRUnstructuredBackupCopyJob object that contains settings of file backup copy jobs or object storage backup copy jobs.

Examples

Get-VBRUnstructuredBackupCopyJob Example 1. Getting File Backup Copy Job by Primary Job

This example shows how to get a file backup copy job that was created to process backup files of the SMB Backup file backup job. The file backup copy jobs are stored on the Repository07 secondary repository.

$filebackupjob = Get-VBRUnstructuredBackupJob -Name "SMB Backup"

$repository = Get-VBRBackupRepository -Name "Repository07"

Get-VBRUnstructuredBackupCopyJob -ParentJob $filebackupjob -BackupRepository $repository

Perform the following steps:

Run the Get-VBRUnstructuredBackupJob cmdlet. Specify the Name parameter value. Save the result to the $filebackupjob variable.
Run the Get-VBRBackupRepository cmdlet. Specify the Name parameter value. Save the result to the $repository variable.
Run the Get-VBRUnstructuredBackupCopyJob cmdlet. Set the $filebackupjob variable as the ParentJob parameter value. Set the $repository variable as the BackupRepository parameter value.

Get-VBRUnstructuredBackupCopyJob Example 2. Getting Object Storage Backup Copy Jobs by Name

This command returns all object storage backup copy jobs with the names that begin with the letters C through T.

Get-VBRUnstructuredBackupCopyJob -Name [C-T]*

Get-VBRUnstructuredBackupCopyJob Example 3. Getting File Backup Copy Jobs by ID

This command returns the fdae7148-81e6-4cb0-8ea8-34512001fd4c file backup copy job.

Get-VBRUnstructuredBackupCopyJob -Id fdae7148-81e6-4cb0-8ea8-34512001fd4c