Add-VBRvCloudJob

In this article

    Short Description

    Creates a vCloud backup job.

    Applies to

    Platform: VMware

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

    Syntax

    Add-VBRvCloudJob -Entity <IItem[]> [-Name <string>] [-BackupRepository <CBackupRepository>] [-Description <string>] [<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 Start-VBRJob to start the created job.

    Run Set-VBRJobSchedule to set schedule for the job.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Entity

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

    True

    Named

    True

    False

    Name

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

    False

    Named

    False

    False

    BackupRepository

    Specifies the target backup repository.

    Default: default backup repository.

    False

    Named

    False

    False

    Description

    Specifies the description of the new vCloud backup job.

    False

    Named

    False

    False

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

    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".

    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.

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

    Related Commands

    Find-VBRvCloudEntity

    Get-VBRBackupRepository

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.