This is an archive version of the document. To get the most up-to-date information, see the current version.

Get-VBOJob

In this article

    Short Description

    Returns backup jobs.

    Syntax

    This cmdlet provides the following parameter sets.

    • Get all backup jobs configured in Veeam Backup for Microsoft Office 365:

    Get-VBOJob  [<CommonParameters>]

    • Get a backup job configured in Veeam Backup for Microsoft Office 365 by system ID:

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

    • Get backup jobs configured in Veeam Backup for Microsoft Office 365 by name or associated Exchange organization:

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

    Detailed Description

    This cmdlet returns backup jobs configured in Veeam Backup for Microsoft Office 365. You can get the list of all jobs or look for instances directly by name, ID or associated Exchange organization.

    Run Get-VBOJobSession to get the information on the job session.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Id

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

    True

    Named

    False

    False

    Organization

    Specifies Exchange organization. The backup job backs up the mailboxes of this organization.

    False

    Named

    True (ByValue)

    False

    Name

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

    False

    Named

    False

    True

    <CommonParameters>

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

    Example 1

    This command returns a backup job by ID.

    Get-VBOJob -Id "dbdbfd55-aaf6-4add-a065-e791016777c7"

    Example 2

    This command returns a backup job by name.

    Get-VBOJob -Name "Monthly Backup"

    Example 3

    This command returns backup jobs by Exchange organization.

    1. Run Get-VBOOrganization to get Exchange organization and save the result to the $org variable.
    2. Run Get-VBOJob with the $org variable.

    $org = Get-VBOOrganization -Name "ABC"

    Get-VBOJob -Organization $org

    Example 4

    This command returns backup jobs with names starting with "sales".

    Get-VBOJob -Name Sales*

    Example 5

    This command returns a list of backup jobs with names containing "sales" within a specified Exchange organization.

    1. Run Get-VBOOrganization to get Exchange organization and save the result to the $org variable.
    2. Run Get-VBOJob with the $org variable.

    $org = Get-VBOOrganization -Name "ABC"

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

    Related Commands

    Get-VBOOrganization

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.