This is an archive version of the document. To get the most up-to-date information, see the current version.Add-VBRvCloudJob
Short Description
Creates a vCloud Director backup job.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Add-VBRvCloudJob -Entity <IItem[]> [-Name <string>] [-BackupRepository <CBackupRepository>] [-Description <string>] [<CommonParameters>] |
Related Commands
Detailed Description
This cmdlet creates a new vCloud Director 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, you 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 Start-VBRJob to start the created job.
Run Set-VBRJobSchedule to set schedule for the job.
Parameters
Parameter | Description | Required | Position | Accept | Accept |
Entity | Specifies the VM(s) you want to backup. You can assign multiple VMs to this object. | True | Named | True | False |
Name | Specifies the name you want to assign to the backup job. | False | Named | False | False |
Backup | Specifies the backup repository object where the backup files will be stored. If not set, the files will be stored in Veeam Backup & Replication default backup repository. | False | Named | False | False |
Description | Specifies the description of the new backup job. | False | Named | False | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
Example 1
This command creates a new vCloud Director backup job with the following parameters:
- Job name: "vCD Backup Job 1".
- $vm: the VM to backup.
- $brepository: the backup repository to store the backup files.
- Description: "vCloud Director Backup Job".
PS C:\PS> Add-VBRvCloudJob -Entity $vm -Name "vCD Backup Job" -BackupRepository $brepository -Description "vCloud Director Backup Job" |
Example 2
This command creates a new vCloud Director backup job with the following parameters:
- Job name: "vCD Backup Job 2".
- Description: "vCloud Director Backup Job".
- The VM named "vCloud Server" is obtained with Find-VBRvCloudEntity and piped down.
- The -BackupRepository parameter is not set to enable use of the default backup repository.
