Add-VBRViJobObject

Short Description

Adds VMs to VMware jobs.

Applies to

Platform: VMware

For Hyper-V, run the Add-VBRHvJobObject cmdlet.

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

Syntax

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

Detailed Description

This cmdlet adds VMs to an existing job.

You can run this cmdlet with any kind of jobs.

Add-VBRViJobObject Note:

The cmdlet will not run if the geographic 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

Type

Required

Position

Accept
Pipeline
Input

Job

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

Accepts the CBackupJob object. To create this object, run the Get-VBRJob cmdlet.

True

Named

False

Entities

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

Accepts the IViItem[] object. To create this object, run the Find-VBRViEntity cmdlet.

True

Named

True (ByProperty
Name, ByValue)

Force

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

SwitchParameter

False

Named

False

Multitag

Defines that the cmdlet will add tags to an existing job.

SwitchParameter

False

Named

False

<CommonParameters>

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

Examples

Add-VBRViJobObjectExample 1. Adding VM to Job Represented by Variable [Using Pipeline]

This example shows how to add a VM named VM01 to the job represented by the $job variable.

$job = Get-VBRJob -Name "Backup Job"

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

Perform the following steps:

  1. Run the Get-VBRJob cmdlet. Specify the Name parameter value. Save the result to the $job variable.
  2. Run the Find-VBRViEntity cmdlet. Specify the Name parameter value.
  3. Pipe the cmdlet output to the Add-VBRViJobObject cmdlet. Set the $job variable as the Job parameter value.

Add-VBRViJobObjectExample 2. Adding VM to Specific Job [Using Variables]

This example shows how to add a VM represented by $Vm variable to the job represented by $job variable.

$job = Get-VBRJob -Name "Backup Job"

$Vm = Find-VBRViEntity -Name "VM01"

Add-VBRViJobObject -Job $job -Entities $Vm

Perform the following steps:

  1. Run the Get-VBRJob cmdlet. Specify the Name parameter value. Save the result to the $job variable.
  2. Run the Find-VBRViEntity cmdlet. Specify the Name parameter value. Save the result to the $Vm variable.
  3. Run the Add-VBRViJobObject cmdlet. Set the $job variable as the Job parameter value. Set $Vm variable as the Entities parameter value.

Related Commands

Page updated 8/14/2024

Page content applies to build 12.2.0.334