Help Center
Choose product document...
Veeam Backup & Replication 9.5 [Archived]
PowerShell Reference

Get-VBRJobObject

Short Description

Returns objects in a specified job.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Get-VBRJobObject [-Job] <CBackupJob> [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

Detailed Description

This cmdlet returns objects in a specified job. The job objects are:

  • VMs
  • VM containers
  • Datastores
  • Resource pools.

You can run this cmdlet for backup, replication, backup copy, VM copy or file copy jobs.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Job

Specifies the job. The cmdlet will return objects of this job.

True

1

True (ByValue,
ByProperty
Name)

False

Name

Specifies the array of job object names (for example, VMs). The cmdlet will filter the objects of the job by these names.

False

Named

False

True

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

Example 1

This command looks for the SharePoint VMs in the job named "VM Copy Job 01". The job is obtained with Get-VBRJob and piped down.

PS C:\PS> Get-VBRJob -Name "VM Copy Job 01" | Get-VBRJobObject -Name *SharePoint*

Example 2

This command looks for the VM named "SharePoint" in the job represented by the $job variable. The job is obtained with Get-VBRJob and assigned to the variable beforehand.

PS C:\PS> Get-VBRJobObject -Job $job -Name "SharePoint"

Related Commands

Get-VBRJob

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Agent Management Guide

Veeam Backup Explorers User Guide

Backup and Restore of SQL Server Databases

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide