Add-VBRvCloudJob

Short Description

Creates a vCloud backup job.

Applies to

Platform: VMware

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

Syntax

Add-VBRvCloudJob -Entity <IVcdItem[]> [-Name <String>] [-BackupRepository <CBackupRepository>] [-Description <String>] [-HighPriority] [-TargetBackup <CBackup>] [<CommonParameters>]

Detailed Description

This cmdlet creates a new vCloud backup job.

You should always use vCD backup jobs to back up VMs managed by vCloud Director. If you back up VMs managed by vCloud Director using a regular backup job, Veeam Backup & Replication will perform backup at the level of the underlying vCenter Server and will not capture vApp metadata. As a result, it will not let you restore a fully functioning VM to vCloud Director.

Note that when you create a backup job, you need to run it manually unless you enable a job schedule.

Run the Start-VBRJob cmdlet to start the created job.

Run the Set-VBRJobSchedule cmdlet to set schedule for the job.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Entity

Specifies the array of VMs. The cmdlet will add these VMs to the vCloud backup job.

Accepts the IVcdItem[] object. To get this object, run the Find-VBRvCloudEntity cmdlet.

True

Named

True

Name

Specifies the name you want to assign to the vCloud backup job.

String

False

Named

False

BackupRepository

Specifies the target backup repository.

Default: default backup repository.

Accepts the CBackupRepository object. To get this object, run the Get-VBRBackupRepository cmdlet.

False

Named

False

Description

Specifies the description of the new vCloud backup job.

String

False

Named

False

HighPriority

Defines that Veeam Backup & Replication will prioritize this job higher than other similar jobs and will allocate resources to it in the first place.

SwitchParameter

False

Named

False

<CommonParameters>

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

Output Object

CBackupJob

Examples

Add-VBRvCloudJobExample 1. Adding vCloud Director Backup Job [Using Variable]

This example shows how to create a new vCloud Director backup job.

$vm = Find-VBRvCloudEntity -Name "vCloud Server"

$brepository = Get-VBRBackupRepository -Name "Backups Vol2"

Add-VBRvCloudJob -Entity $vm -Name "vCD Backup Job" -BackupRepository $brepository -Description "vCloud Director Backup Job"

Perform the following steps:

  1. Run the Find-VBRvCloudEntity cmdlet. Specify the Name parameter value. Save the result to the $vm variable.
  2. Run the Get-VBRBackupRepository cmdlet. Specify the Name parameter value. Save the result to the $brepository variable.
  3. Run the Add-VBRvCloudJob cmdlet. Specify the following settings:
  • Set the $vm variable as the Entity parameter value.
  • Specify the Name parameter value.
  • Set the $brepository variable as the BackupRepository parameter value.
  • Specify the Description parameter value.

Add-VBRvCloudJobExample 2. Adding vCloud Director Backup Job [Using Pipeline]

This example shows how to create a new vCloud Director backup job. The target is the default backup repository.

Find-VBRvCloudEntity -Name "vCloud Server" | Add-VBRvCloudJob -Name "vCD Backup Job 2" -Description "vCloud Director Backup Job"

Perform the following steps:

  1. Run the Find-VBRvCloudEntity cmdlet. Specify the Name parameter value.
  2. Pipe the cmdlet output to the Add-VBRvCloudJob cmdlet. Specify the Name and the Description parameter values.

Related Commands