Add-VBRJobObject (obsolete)

Short Description

Adds VMs to existing job.

Note

This cmdlet is obsolete. The cmdlet still works, but it is recommended to create a new backup job using the Add-VBRViJobObject or the Add-VBRHvJobObject cmdlets.

Platform: VMware

Syntax

This cmdlet provides the following parameter sets:

Object

Add-VBRJobObject [-Job] <CBackupJob> [-Server] <CHost> [-Objects] <String[]> [<CommonParameters>]
Entity

Add-VBRJobObject [-Job] <CBackupJob> [-Server] <CHost> [-Entities] <CEntity[]> [<CommonParameters>]

Detailed Description

This cmdlet allows you to add VMs or VM containers to existing backup, replication or copy job.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Entities	Specifies the VMs or VM containers you want to add to the job. You can assign multiple VMs to this object. Accepts the `CEntity[]` object. To get this object, run the `Find-VBRViEntity` or `Find-VBRHvEntity` cmdlet.	`CEntity[]`	True	2	True (ByPropertyName, ByValue)
Job	Specifies the job you want to add VMs to. Accepts the `CBackupJob` object. To get this object, run the `Get-VBRJob` cmdlet.	`CBackupJob`	True	0	False
Objects	Specifies the string with the names of VMs you want to add to the job. You can assign multiple VMs to this object.	`String[]`	True	2	True (ByPropertyName, ByValue)
Server	Specifies the host where the VMs or VM containers you want to add reside.	`CHost`	True	1	False

<CommonParameters>

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

Examples

Add-VBRJobObject (obsolete) Example 1. Adding VM to Existing Job [Using Variable]

This example shows how to add the vm3 VM to the Backup Job job.

$server = Get-VBRServer -Name "Hv"

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

Add-VBRJobObject -Job $job -Server $server -Objects vm3

Perform the following steps:

Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save it to the $server variable.
Run the Get-VBRJob cmdlet. Specify the Name parameter value. Save it to the $job variable.
Run the Add-VBRJobObject cmdlet. Specify the following settings:
- Set the $job variable as the Job parameter value.
- Set the $server variable as the Server parameter value.
- Specify the Objects parameter value.

Add-VBRJobObject (obsolete) Example 2. Adding VM to Existing Job [Using Pipeline]

This example shows how to add the vm3 VM to the Backup Job job.

$server = Get-VBRServer -Name "Hv"

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

Find-VBRViEntity -Name "vm3" | Add-VBRJobObject -Job $job -Server $server

Perform the following steps:

Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save it to the $server variable.
Run the Get-VBRJob cmdlet. Specify the Name parameter value. Save it to the $job variable.
Run the Find-VBRViEntity cmdlet. Specify the Name parameter value.
Pipe the cmdlet output to the Add-VBRJobObject cmdlet. Set the $job variable as the Job parameter value. Set the $server variable as the Server parameter value.