Add-VBRViJobObject

In this article

    Short Description

    Adds VMs to a VMware job.

    Applies to

    Platform: VMware

    For Hyper-V, run Add-VBRHvJobObject.

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

    Syntax

    Add-VBRViJobObject -Job <CBackupJob> -Entities <IViItem[]> [-Force][<CommonParameters>]

    Detailed Description

    This cmdlet adds VMs to an existing job.

    You can run this cmdlet with any kind of jobs.

    Starting from Veeam Backup & Replication version 9.5 Update 3, the cmdlet checks if the data of the VMs added to the job changes its geographical location.

    Add-VBRViJobObject Note:

    The cmdlet will not run if the geographical location of the VMs added to the job and the job target repository location do not match. If you still want to run the cmdlet, use the Force parameter.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Job

    Specifies the job. The cmdlet will add VMs to this job.

    True

    Named

    False

    False

    Entities

    Specifies the array of VMware VMs you want to add to the job.

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    False

    Force

    Indicates that the cmdlet will add VMs to the existing job even if the geographical location of these VMs and the target backup repository location do not match.

    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 adds a VM named "VM01" to the job represented by $job variable.  First the job object is got and assigned to $job variable.The VM object is piped down.

    Find-VBRViEntity -Name VM01 | Add-VBRViJobObject -Job $job

    Example 2

    This command adds a VM represented by $Vm variable to the job represented to $job variable. The variables are assigned beforehand.

    Add-VBRViJobObject -Job $job -Entities $Vm

    Related Commands

    Get-VBRJob

    Find-VBRViEntity

    Get-VBRLocation