Add-VBRCatalystCopyJob

Short Description

Creates backup copy jobs for HPE StoreOnce repositories.

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

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

Detailed Description

This cmdlet creates backup copy jobs for HPE StoreOnce repositories.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Name

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

String

True

0

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.

Note: The array of source repositories must contain the same number of the repositories as the array of the target repositories.

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

True

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.

Note: The array of target repositories must contain the same number of the repositories as the array of the source repositories.

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

True

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

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

<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

Add-VBRCatalystCopyJobExample 1. Creating Backup Copy Job for List of HPE StoreOnce Repositories

This example shows how to create a backup copy job that will copy data from a list of source repositories to a list of the target repositories. Veeam Backup & Replication will copy data according to the following scheme:

  • From HPE StoreOnce 1 to HPE StoreOnce 4
  • From HPE StoreOnce 2 to HPE StoreOnce 5
  • From HPE StoreOnce 3 to HPE StoreOnce 6

$source = Get-VBRBackupRepository

$source

 HPE StoreOnce 1

 HPE StoreOnce 2

 HPE StoreOnce 3

$target = Get-VBRBackupRepository

$target

 HPE StoreOnce 4

 HPE StoreOnce 5

 HPE StoreOnce 6

Add-VBRCatalystCopyJob -Name "StoreOnce copy job" -SourceRepository $source -TargetRepository $target-Description "Copy job for StoreOnce repository"

Perform the following steps:

  1. Run the Get-VBRBackupRepository cmdlet. Specify the Name parameter value. Save the result to the $source variable.
  2. Run the Get-VBRBackupRepository cmdlet. Specify the Name parameter value. Save the result to the $target variable.
  3. Run the Add-VBRCatalystCopyJob cmdlet. Specify the following settings:
  • Specify the Name parameter value.
  • Set the $source variable as the SourceRepository parameter value.
  • Set the $target variable as the TargetRepository parameter value.
  • Specify the Description parameter value.

Add-VBRCatalystCopyJobExample 2. Creating Backup Copy Job for Specific HPE StoreOnce Repositories

This example shows how to create a backup copy job that will copy data from the third source HPE StoreOnce repository to the second target  HPESO07 HPE StoreOnce repository.

$source = Get-VBRBackupRepository

$target = Get-VBRBackupRepository

Add-VBRCatalystCopyJob -Name "StoreOnce copy job" -SourceRepository $source[2] -TargetRepository $target[1] -Description "Copy job for StoreOnce repository"

Perform the following steps:

  1. Run the Get-VBRBackupRepository cmdlet. Save the result to the $source variable.
  2. Run the Get-VBRBackupRepository cmdlet. Save the result to the $target variable.
  3. Run the Add-VBRCatalystCopyJob cmdlet. Specify the following settings:
  • Specify the Name parameter value.
  • Set the $source[2] variable as the SourceRepository parameter value.

The Get-VBRBackupRepository cmdlet will return an array of source HPE StoreOnce repositories. Mind the ordinal number of the necessary source repository (in our example, it is the third source repository in the array).

  • Set the $target[1] variable as the TargetRepository parameter value.

The Get-VBRBackupRepository cmdlet will return an array of target HPE StoreOnce repositories. Mind the ordinal number of the necessary target repository (in our example, it is the second target repository in the array).

  • Specify the Description parameter value.

Add-VBRCatalystCopyJobExample 3. Creating Backup Copy Job for HPE StoreOnce Repository with Backup Window Options

This example shows how to create a backup copy job for an HPE StoreOnce repository. The job will run during the following period of time:

  • From 22:00 to 22:59 on Friday
  • From 22:00 to 22:59 on Saturday

$source = Get-VBRBackupRepository -Name "HPE SO 05"

$target = Get-VBRBackupRepository -Name "HPE SO 07"

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

Add-VBRCatalystCopyJob -Name "StoreOnce copy job" -SourceRepository $source -TargetRepository $target -Description "Copy job for StoreOnce repository" -BackupWindowOptions $windowoptions

Perform the following steps:

  1. Run the Get-VBRBackupRepository cmdlet. Specify the Name parameter value. Save the result to the $source variable.
  2. Run the Get-VBRBackupRepository cmdlet. Specify the Name parameter value. Save the result to the $target variable.
  3. Run the New-VBRBackupWindowOptions cmdlet. Specify the necessary parameters. Save the result to the $windowoptions variable.
  4. Run the Add-VBRCatalystCopyJob cmdlet. Specify the following settings:
  • Specify the Name parameter value.
  • Set the $source variable as the SourceRepository parameter value.
  • Set the $target variable as the TargetRepository parameter value.
  • Specify the Description  parameter value.

Related Commands

Get-VBRBackupRepository

I want to report a typo

There is a misspelling right here:

 

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