Get-VBRJobObject
Short Description
Returns VMs or VM containers of specific jobs.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
Get-VBRJobObject -Job <CBackupJob> [-Name <String[]>] [<CommonParameters>] |
Detailed Description
This cmdlet returns the following VMs or VM containers of specific jobs:
- VMs
- VM containers
- Datastores
- Resource pools
You can run this cmdlet for backup, replication, backup copy, VM copy or file copy jobs.
Note |
The cmdlet returns only the objects added to a job. For example, if you have added datastores, the cmdlet will return these datastores. The cmdlet will not return VMs from these datastores. |
Parameters
Parameter | Description | Type | Required | Position | Accept |
---|---|---|---|---|---|
Job | Specifies the job. The cmdlet will return objects of this job. | Accepts the CBackupJob object. To create this object, run the Get-VBRJob cmdlet. | True | 0 | True (ByProperty |
Name | Specifies the array of job object names (for example, VMs). The cmdlet will filter the objects of the job by these names. | String[] | False | Named | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.
Output Object
The cmdlet returns the CObjectInJob object that contains objects of a job.
Examples
Example 1. Looking for VM in Specific Job [Using Pipeline]
This example shows how to look for the SharePoint VM in the VM Copy Job 01 job.
Perform the following steps:
|
Example 2. Looking for VM in Specific Job [Using Variable]
This example shows how to look for the SharePoint VM in the job represented by the $job variable.
Perform the following steps:
|
Related Commands