Veeam Backup for Microsoft Office 365 5.0
PowerShell Reference
Related documents
User GuideREST API ReferenceVeeam Explorers User GuideVeeam Explorers PowerShell Reference
Search

Get-VBOJob

In this article

    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 Office 365.

    Get-VBOJob  [<CommonParameters>]

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

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

    • Get backup jobs configured in Veeam Backup for Microsoft Office 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 Office 365. You can get all backup jobs or look for 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

    Accept Wildcard Characters

    Id

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

    Guid

    True

    Named

    False

    False

    Organization

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

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

    False

    Named

    True (ByValue)

    False

    Name

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

    String

    False

    Named

    False

    True

    <CommonParameters>

    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-VBOJobExample 1. Getting Backup Job by ID

    This example shows how to get the 1fcd86ed-d7e3-4f1f-a60e-764e1c0ff37ea backup job.

    Get-VBOJobSession -Id 1fcd86ed-d7e3-4f1f-a60e-764e1c0ff37e

    Perform the following steps:

    1. Run the Get-VBOJobSession cmdlet. The cmdlet will return the backup job details. Copy the JobId value from the cmdlet output.
    2. Run the Get-VBOJob cmdlet. Set the JobId value as the Id parameter value.

    Get-VBOJobExample 2. Getting Backup Job by Name

    This command returns a backup job by name.

    Get-VBOJob -Name "Monthly Backup"

    Get-VBOJobExample 3. Getting Backup Job by Name Using Wildcards

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

    Get-VBOJob -Name Sales*

    Get-VBOJobExample 4. Getting Backup Job by Microsoft Organization

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

    $org = Get-VBOOrganization -Name "ABC"

    Get-VBOJob -Organization $org

    Perform the following steps:

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

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

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

    $org = Get-VBOOrganization -Name "ABC"

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

    Perform the following steps:

    1. Run the Get-VBOOrganization cmdlet. Specify the Name parameter value. Save the result to the $org variable.
    2. 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