Get-VBOJob

Short Description

Returns backup jobs.

Syntax

This cmdlet provides parameter sets that allow you to:

Get all backup jobs configured in Veeam Backup for Microsoft 365.

Get-VBOJob [<CommonParameters>]

Get a backup job configured in Veeam Backup for Microsoft 365 by the job ID.

Get-VBOJob -Id <Guid> [<CommonParameters>]

Get backup jobs configured in Veeam Backup for Microsoft 365 by the job name or Microsoft organization.

Get-VBOJob [-Organization <VBOOrganization>] [-Name <String>] [<CommonParameters>]

Detailed Description

This cmdlet returns backup jobs configured in Veeam Backup for Microsoft 365. You can get all backup jobs or query a backup job by name, ID or associated Microsoft organization.

Run the Get-VBOJobSession cmdlet to get details on the backup job ID and name.

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input
Organization	Specifies a Microsoft organization. The backup job will back up objects of this organization.	Accepts the VBOOrganization object. To get this object, run the Get-VBOOrganization cmdlet.	False	Named	True (ByValue)
Name	Specifies a name of the backup job. The cmdlet will return the backup job with this name.	String	False	Named	False
Id	Specifies an ID of the backup job. The cmdlet will return the backup job with this ID.	Guid	True	Named	False

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Organization

Specifies a Microsoft organization. The backup job will back up objects of this organization.

Accepts the VBOOrganization object.

To get this object, run the Get-VBOOrganization cmdlet.

False

Named

True (ByValue)

Name

Specifies a name of the backup job. The cmdlet will return the backup job with this name.

String

False

Named

False

Specifies an ID of the backup job. The cmdlet will return the backup job with this ID.

Guid

True

Named

False

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Output Object

The cmdlet returns the VBOJob object that contains settings for a backup job.

Examples

Get-VBOJob Example 1. Getting Backup Job by ID

This example shows how to get a backup job by ID.

Get-VBOJobSession

Get-VBOJob -Id a19840ea-9cf5-413d-af29-57ecad85be9e

Perform the following steps:

Run the Get-VBOJobSession cmdlet. The cmdlet will return details of all backup jobs. Copy the JobId value from the cmdlet output.
Run the Get-VBOJob cmdlet. Set the JobId value as the Id parameter value.

Get-VBOJob Example 2. Getting Backup Job by Name

This command returns a backup job by name.

Get-VBOJob -Name "Monthly Backup"

Get-VBOJob Example 3. Getting Backup Job by Name Using Wildcards

This command returns backup jobs with names starting with Sales.

Get-VBOJob -Name "Sales*"

Get-VBOJob Example 4. Getting Backup Job by Microsoft Organization

This example shows how to get backup jobs that are created to back up a specific Microsoft organization.

$org = Get-VBOOrganization -Name "ABC"

Get-VBOJob -Organization $org

Perform the following steps:

Run the Get-VBOOrganization cmdlet. Specify the Name parameter value. Save the result to the $org variable.
Run the Get-VBOJob cmdlet. Set the $org variable as the Organization parameter value.

Get-VBOJob Example 5. Getting Backup Job by Name within Microsoft Organization

This example shows how to return a list of backup jobs with names containing Sales within the specified Microsoft organization.

$org = Get-VBOOrganization -Name "ABC"

Get-VBOJob -Organization $org -Name "*Sales*"

Perform the following steps:

Run the Get-VBOOrganization cmdlet. Specify the Name parameter value. Save the result to the $org variable.
Run the Get-VBOJob cmdlet with the $org variable. Set the $org variable as the Organization parameter value. Specify the Name parameter value.

Related Commands