Set-VBOJob

In this article

    Short Description

    Modifies backup job settings.

    Syntax

    This cmdlet provides parameter sets that allow you to:

    • Modify a backup job that will back up only selected items.

    Set-VBOJob -Job <VBOJob> [-Name <string>] [-Repository <VBORepository>] [-Description <string>] [-SelectedItems <VBOBackupItem[]>] [-ExcludedItems <VBOBackupItem[]>] [-RunJob] [-SchedulePolicy <VBOJobSchedulePolicy>] [-SelectedOneDriveFolders <string[]>] [-ExcludedOneDriveFolders <string[]>]  [<CommonParameters>]

    • Modify a backup job that will back up the entire organization except for the excluded items.

    Set-VBOJob -Job <VBOJob> [-Name <string>] [-Repository <VBORepository>] [-Description <string>][-EntireOrganization] [-ExcludedItems <VBOBackupItem[]>] [-RunJob] [-SchedulePolicy <VBOJobSchedulePolicy>] [-SelectedOneDriveFolders <string[]>] [-ExcludedOneDriveFolders <string[]>]  [<CommonParameters>]

    Detailed Description

    This cmdlet modifies settings of a backup job.

    To modify settings, enter the necessary parameters with new values. The parameters that you omit will remain unchanged.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Accept Wildcard Characters

    Job

    Specifies a backup job. The cmdlet will modify that job.

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

    True

    Named

    True (ByValue)

    False

    Name

    Specifies a new name of a backup job. The cmdlet will replace a backup job name with this name.

    String

    False

    Named

    False

    False

    Repository

    Specifies a backup repository. Veeam Backup for Microsoft Office 365 will store backups created by a backup job you modify on this repository.

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

    False

    Named

    False

    False

    Description

    Specifies a description of a backup job.

    The default description contains information on the user who added the backup job, date and time when the backup job was added.

    String

    False

    Named

    False

    False

    SelectedItems

    Specifies objects that a job will back up.

    Accepts the VBOBackupItem[] object. To get this object, run the Get-VBOBackupItem cmdlet.

    False

    Named

    False

    False

    EntireOrganization

    Defines that a job will backup all objects of the organization.

    If you provide this parameter, the cmdlet will add all objects of the organization to the backup job. Otherwise, you must select objects that you want to back up.

    Note: The backup job will not back up objects, processed by other backup jobs.

    SwitchParameter

    False

    Named

    False

    False

    ExcludedItems

    Specifies an array of objects that the job will not back up.

    Note: You cannot exclude objects that have been specified for the SelectedItems parameter.

    Accepts the VBOBackupItem[] object. To get this object, run the Get-VBOBackupItem cmdlet.

    False

    Named

    False

    False

    RunJob

    Defines that a backup job will run right after you create it.

    If you provide this parameter, the job will start after you run the script. Otherwise, the cmdlet will create a backup job in the stopped status.

    SwitchParameter

    False

    Named

    False

    False

    SchedulePolicy

    Specifies schedule settings for a backup job.

    Accepts the VBOJobSchedulePolicy object. To create this object, run the New-VBOJobSchedulePolicy cmdlet.

    False

    Named

    False

    False

    SelectedOneDriveFolders

    Specifies an array of OneDrive folders that a backup job will back up.

    String[]

    False

    Named

    False

    False

    ExcludedOneDriveFolders

    Specifies an array of OneDrive folders that a backup job will not back up.

    String[]

    False

    Named

    False

    False

    <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

    Set-VBOJobExample 1. Modifying Repository of Backup Job

    This example shows how to modify the following settings of a backup job:

    • Select items for the backup job
    • Change the backup repository

    $job = Get-VBOJob -Name "Critical Backup"

    $repository = Get-VBORepository -Name "ABC Backup Files"

    $org = Get-VBOOrganization -Name "ABC Company"

    $User = Get-VBOOrganizationUser -Organization $org -DisplayName "UserAlpha"

    $item1 = New-VBOBackupItem -User $User -Mailbox

    Set-VBOJob -Job $job -Repository $repository -SelectedItems $item1

    Perform the following steps:

    1. Run the Get-VBOJob cmdlet. Specify the Name parameter value. Save the result to the $job variable.
    2. Run the Get-VBORepository cmdlet. Specify the Name parameter value. Save the result to the $repository variable.
    3. Run the Get-VBOOrganization cmdlet. Specify the Name parameter value. Save the result to the $org variable.
    4. Run the Get-VBOOrganizationUser cmdlet. Set the $org variable as the Organization parameter value. Specify the DisplayName parameter value. Save the result to the $User variable.
    5. Run the New-VBOBackupItem cmdlet. Set the $User variable as the User parameter value. Specify the Mailbox parameter value. Save the result to the $item1 variable.
    6. Run the Set-VBOJob cmdlet. Specify the following settings:
    • Set the $job variable as the Job parameter value.
    • Set the $repository variable as the Repository parameter value.
    • Set the $item1 variable as the SelectedItems parameter value.

    Set-VBOJobExample 2. Excluding Objects from Backup Job

    This example shows how to exclude objects from a backup job.

    $job = Get-VBOJob -Name "Critical Backup"

    $org = Get-VBOOrganization -Name "ABC Company"

    $User = Get-VBOOrganizationUser -Organization $org -DisplayName "JohnDoe"

    $excludedItem = New-VBOBackupItem -User $User

    Set-VBOJob -Job $job -ExcludedItems $excludedItem

    Perform the following steps:

    1. Run the Get-VBOJob cmdlet. Specify the Name parameter value. Save the result to the $job variable.
    2. Run the Get-VBOOrganization cmdlet. Specify the Name parameter value. Save the result to the $org variable.
    3. Run the Get-VBOOrganizationUser cmdlet. Set the $org variable as the Organization parameter value. Specify the DisplayName parameter value. Save the result to the $User variable.
    4. Run the New-VBOBackupItem cmdlet. Set the $User variable as the User parameter value. Save the result to the $excludedItem variable.
    5. Run the Set-VBOJob cmdlet. Specify the following settings:
    • Set the $job variable as the Job parameter value.
    • Set the $excludedItem variable as the ExcludedItems parameter value.

    Set-VBOJobExample 3. Setting New Schedule for Backup Job

    This example shows how to set new schedule settings for a backup job. The job will run with the following settings:

    • The job will run on workdays at 2:50 PM.
    • The job will be terminated if it exceeds the specified backup window: the job will be stopped if it is still running from 03:00 PM until 03:59 PM.
    • Veeam Backup for Microsoft Office 365 will not perform any retry attempts if the job fails.

    $job = Get-VBOJob -Name "Veeam Backup"

    $Window = New-VBOBackupWindowSettings -Enabled -FromDay Monday -ToDay Sunday -FromHour 16 -ToHour 15

    $schedule = New-VBOJobSchedulePolicy -Type Daily -DailyTime 14:50:00 -DailyType Workdays -EnableSchedule -RetryEnabled: $false -BackupWindowSettings $Window

    Set-VBOJob -Job $job -SchedulePolicy $schedule

    Perform the following steps:

    1. Run the Get-VBOJob cmdlet. Specify the Name parameter value. Save the result to the $job variable.
    2. Run the New-VBOBackupWindowSettings cmdlet. Specify the necessary parameters. Save the result to the $Window variable.
    3. Run the New-VBOJobSchedulePolicy cmdlet. Specify the necessary parameters. Save the result to the $schedule variable.
    4. Run the Set-VBOJob cmdlet. Set the $job variable as the Job parameter value. Set the $schedule variable as the SchedulePolicy parameter value.

    Set-VBOJobExample 4. Defining OneDrive Folders that Backup Job will Back Up

    This example shows how to specify an array of OneDrive folders that a backup job will back up.

    $org = Get-VBOOrganization -Name "ABC Company"

    $User = Get-VBOOrganizationUser -Organization $org -DisplayName "JohnDoe"

    $backupUser = New-VBOBackupItem -User $User -OneDrive

    $job = Get-VBOJob -Name "Veeam Backup"

    Set-VBOJob -Job $job -SelectedItems $backupUser -SelectedOneDriveFolders @("SelectedFolder1","SelectedFolder2")

    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-VBOOrganizationUser cmdlet. Set the $org variable as the Organization parameter value. Specify the DisplayName parameter value. Save the result to the $User variable.
    3. Run the New-VBOBackupItem cmdlet. Set the $User variable as the User parameter value. Specify the OneDrive parameter value. Save the result to the $backupUser variable.
    4. Run the Get-VBOJob cmdlet. Specify the Name parameter value. Save the result to the $job variable.
    5. Run the Set-VBOJob cmdlet. Specify the following settings:
    • Set the $job variable as the Job parameter value.
    • Set the $backupUser variable as the SelectedItems parameter value.
    • Provide an array of OneDrive folders that you want to back up as the SelectedOneDriveFolders parameter value.

    Set-VBOJobExample 5. Defining OneDrive Folders to Exclude from Backup Job

    This example shows how to specify an array of OneDrive folders that a backup job will not back up.

    $org = Get-VBOOrganization -Name "ABC Company"

    $User = Get-VBOOrganizationUser -Organization $org -DisplayName "JohnDoe"

    $backupUser = New-VBOBackupItem -User $User -OneDrive

    $job = Get-VBOJob -Name "Veeam Backup"

    Set-VBOJob -Job $job -SelectedItems $backupUser -ExcludedOneDriveFolders @("ExcludedFolder1","ExcludedFolder2")

    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-VBOOrganizationUser cmdlet. Set the $org variable as the Organization parameter value. Specify the DisplayName parameter value. Save the result to the $User variable.
    3. Run the New-VBOBackupItem cmdlet. Set the $User variable as the User parameter value. Specify the OneDrive parameter value. Save the result to the $backupUser variable.
    4. Run the Get-VBOJob cmdlet. Specify the Name parameter value. Save the result to the $job variable.
    5. Run the Set-VBOJob cmdlet. Specify the following settings:
    • Set the $job variable as the Job parameter value.
    • Set the $backupUser variable as the SelectedItems parameter value.
    • Provide an array of OneDrive folders that you want to back up as the ExcludedOneDriveFolders parameter value.

    Related Commands