Set-VBRCatalystCopyJob

In this article

    Short Description

    Modifies backup copy jobs for HPE StoreOnce repositories.

    Applies to

    Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

    Syntax

    This cmdlet provides parameter sets that allow you to:

    • Modify backup copy jobs for HPE StoreOnce repositories with the custom job backup window settings.

    Set-VBRCatalystCopyJob -Job <VBRCatalystCopyJob> [-Name <string>] [-Description <string>] [-SourceRepository <CBackupRepository[]>] [-TargetRepository <CBackupRepository[]>] [-NotificationOptions <VBRNotificationOptions>] [-ScriptOptions <VBRJobScriptOptions>] [-BackupWindowOptions <VBRBackupWindowOptions>]  [<CommonParameters>]

    • Modify backup copy jobs for HPE StoreOnce repositories with the continuous backup option.

    Set-VBRCatalystCopyJob -Job <VBRCatalystCopyJob> [-Name <string>] [-Description <string>] [-SourceRepository <CBackupRepository[]>] [-TargetRepository <CBackupRepository[]>] [-NotificationOptions <VBRNotificationOptions>] [-ScriptOptions <VBRJobScriptOptions>] [-AnyTime]  [<CommonParameters>]

    Detailed Description

    This cmdlet modifies backup copy jobs that are created for HPE StoreOnce repositories.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Job

    Specify a backup copy job for an HPE StoreOnce repository. The cmdlet will modify the settings of this job.

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

    True

    Named

    True (ByValue)

    Name

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

    String

    False

    Named

    False

    Description

    Specifies a description of a backup copy job. The cmdlet will create the backup copy job with this description.

    String

    False

    Named

    False

    SourceRepository

    Specifies an array of source HPE StoreOnce repositories. The cmdlet will copy backup files from these repositories.

    You can specify the following types of repositories:

    • HPE StoreOnce repositories.
    • HPE StoreOnce repositories added as extents to a Scale-Out Backup Repository.

    Accepts the String and the CBackupRepository[] object. To get this object, run the Get-VBRBackupRepository cmdlet.

    False

    Named

    False

    TargetRepository

    Specifies an array of target HPE StoreOnce repositories. The cmdlet will copy backup files to these repositories.

    You can specify the following types of repositories:

    • HPE StoreOnce repositories.
    • HPE StoreOnce repositories added as extents to a Scale-Out Backup Repository.

    Accepts the String and the CBackupRepository[] object. To get this object, run the Get-VBRBackupRepository cmdlet.

    False

    Named

    False

    NotificationOptions

    Specifies notification settings. The cmdlet will create the backup copy job with these settings

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

    False

    Named

    False

    ScriptOptions

    Specifies job scrip options. The cmdlet will create a copy job with these script options.

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

    False

    Named

    False

    BackupWindowOptions

    Specifies backup window settings for a job. The cmdlet will create the the backup copy job with these settings.

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

    False

    Named

    False

    AnyTime

    Defines that Veeam Backup & Replication will run a backup job continuously.

    SwitchParameter

    False

    Named

    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 VBRCatalystCopyJob object that contains settings of backup copy jobs for HPE StoreOnce repositories.

    Examples

    Set-VBRCatalystCopyJobExample 1. Modifying Backup Copy Job Schedule to Run at Specific Time

    This example shows how to modify backup window settings for a backup copy job. The backup copy job will run from 20:00 to 22:59 every day from Monday to Friday.

    $job = Get-VBRCatalystCopyJob -Name "Backup Copy StoreOnce 05"

    $windowoptions = New-VBRBackupWindowOptions -FromDay Monday -ToDay Friday -FromHour 20 -ToHour 22 -Enabled

    Set-VBRCatalystCopyJob -Job $job -BackupWindowOptions $windowoptions

    Perform the following steps:

    1. Run the Get-VBRCatalystCopyJob cmdlet. Specify the Name parameter value. Save the result to the $job variable.
    2. Run the New-VBRBackupWindowOptions cmdlet. Specify the necessary parameters. Save the result to the $windowoptions variable.
    3. Run the Set-VBRCatalystCopyJob cmdlet. Set the $job variable as the Job parameter value. Set the $windowoptions as the BackupWindowOptions parameter value.

    Set-VBRCatalystCopyJobExample 2. Modifying Backup Copy Job Schedule to Run Continuously

    This example shows how to modify schedule settings for a backup copy job. The backup copy job will run continuously.

    $job = Get-VBRCatalystCopyJob -Name "Backup Copy StoreOnce 05"

    Set-VBRCatalystCopyJob -Job -BackupWindowOptions $windowoptions -AnyTime

    Perform the following steps:

    1. Run the Get-VBRCatalystCopyJob cmdlet. Specify the Name parameter value. Save the result to the $job variable.
    2. Run the Set-VBRCatalystCopyJob cmdlet. Set the $job variable as the Job parameter value. Set the $windowoptions as the BackupWindowOptions parameter value. Provide the AnyTime parameter.

    Related Commands

    I want to report a typo

    There is a misspelling right here:

     

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