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

Add-VBRCatalystCopyJob

Short Description

Creates backup copy jobs for HPE StoreOnce repositories.

Applies to

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

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

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

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

Related Commands

Get-VBRBackupRepository