Get-VBREPJob - Veeam Backup PowerShell Reference
Help Center
Choose product document...
Veeam Backup & Replication 9.5
PowerShell Reference

Get-VBREPJob

Short Description

Returns Veeam Agent for Microsoft Windows jobs.

Syntax

This cmdlet provides 3 parameter sets.

  • For looking for all Veeam Agent for Microsoft Windows jobs:

Get-VBREPJob  [<CommonParameters>]

  • For looking for Veeam Agent for Microsoft Windows jobs by job name:

Get-VBREPJob [-Name <string[]>]  [<CommonParameters>]

  • For looking for Veeam Agent for Microsoft Windows jobs by job ID:

Get-VBREPJob [-Id <guid[]>]  [<CommonParameters>]

Detailed Description

This cmdlet returns Veeam Agent for Microsoft Windows jobs.

You can get all Veeam Agent for Microsoft Windows jobs or search for instances directly by name or ID. Use an appropriate parameter set for each case.

Get-VBREPJob Note:

Veeam Agent for Microsoft Windows cmdlets will not work for jobs that were created using Veeam Agent management functionality. The ability to manage Veeam Agent management jobs will be provided in future versions of Veeam PowerShell.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Name

Specifies the array of Veeam Agent for Microsoft Windows job names. The cmdlet will return jobs with these names.

False

Named

False

True

Id

Specifies the array of job IDs. The cmdlet will return the Veeam Agent for Microsoft Windows jobs with these IDs.

Accepts GUID or string type.

False

Named

False

False

<CommonParameters>

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

Return Type

VBREPJob[]

Example 1

This command returns all Veeam Agent for Microsoft Windows jobs.

PS C:\PS> Get-VBREPJob

Example 2

This command gets a Veeam Agent for Microsoft Windows job by name.

PS C:\PS> Get-VBREPJob -Name "Backup Job Mediaserver"

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

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation