Add-VBRComputerBackupCopyJob (obsolete)

Short Description

Creates Veeam Agent backup copy jobs.

Note

This cmdlet is obsolete and only works for creating a simple mode backup copy job. It is recommended to create a new backup job using the Add-VBRBackupCopyJob cmdlet.

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

Syntax

This cmdlet provides the following parameter sets:

DirectOperation

Add-VBRComputerBackupCopyJob [-Name <String>] [-Description <String>] [-Backup <CBackup[]>]

[-BackupJob <VBRComputerBackupJob[]>] [-SourceRepository <CBackupRepository[]>]

[-Repository <CBackupRepository>] -OSPlatform <VBRAgentType> [-DirectOperation] [-Force]

[-EnableImmediateCopy] [-RecoveryPointObjective <VBRRecoveryPointObjective>]

[-RetentionPolicy <VBRRetentionPolicy>] [-BackupWindowOptions <VBRBackupWindowOptions>]

[-NotificationOptions <VBRNotificationOptions>] [-StorageOptions <VBRBackupCopyJobStorageOptions>]

[-HealthCheckOptions <VBRHealthCheckOptions>] [-ScriptOptions <VBRJobScriptOptions>]

[-RPOWarningOptions <VBRRpoNotificationOption[]>] [-EnableTransactionLogCopy]

[-GFSOptions <VBRComputerGFSOptions>] [-RetentionType <VBRRetentionType>] [-RetentionNumber <Int32>] [<CommonParameters>]

WanAccelerator

Add-VBRComputerBackupCopyJob [-Name <String>] [-Description <String>] [-Backup <CBackup[]>]

[-BackupJob <VBRComputerBackupJob[]>] [-SourceRepository <CBackupRepository[]>]

[-Repository <CBackupRepository>] -OSPlatform <VBRAgentType> -SourceAccelerator <CWanAccelerator>

[-TargetAccelerator <CWanAccelerator>] [-Force] [-EnableImmediateCopy]

[-RecoveryPointObjective <VBRRecoveryPointObjective>] [-RetentionPolicy <VBRRetentionPolicy>]

[-BackupWindowOptions <VBRBackupWindowOptions>] [-NotificationOptions <VBRNotificationOptions>]

[-StorageOptions <VBRBackupCopyJobStorageOptions>] [-HealthCheckOptions <VBRHealthCheckOptions>]

[-ScriptOptions <VBRJobScriptOptions>] [-RPOWarningOptions <VBRRpoNotificationOption[]>]

[-EnableTransactionLogCopy] [-GFSOptions <VBRComputerGFSOptions>] [-RetentionType <VBRRetentionType>]

[-RetentionNumber <Int32>] [<CommonParameters>]

Detailed Description

This cmdlet creates Veeam Agent backup copy jobs.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Backup	Specifies an array of backups. The cmdlet will add machines from these backups to a Veeam Agent backup copy job. Note: This parameter is available for a Veeam Agent backup copy job that is created with the periodic backup copy mode. Accepts the `CBackup[]` object. To create this object, run the `Get-VBRBackup` cmdlet.	`CBackup[]`	False	Named	True (ByPropertyName, ByValue)
BackupJob	Specifies an array of backup jobs. The cmdlet will add machines processed by these jobs to a Veeam Agent backup copy job. Accepts the `VBRComputerBackupJob[]` object. To create this object, run the `Get-VBRComputerBackupJob` cmdlet.	`VBRComputerBackupJob[]`	False	Named	True (ByPropertyName)
BackupWindowOptions	Specifies backup window settings for a Veeam Agent backup copy job. The cmdlet will create the job with these settings. Accepts the `VBRBackupWindowOptions` object. To create this object, run the `New-VBRBackupWindowOptions` cmdlet.	`VBRBackupWindowOptions`	False	Named	False
Description	Specifies a description of a Veeam Agent backup copy job.	`String`	False	Named	False
DirectOperation	Defines that the cmdlet will create a Veeam Agent backup copy job that will transfer data directly from the source backup repository to the target backup repository.	`SwitchParameter`	True	Named	False
EnableImmediateCopy	Defines that the cmdlet will enable the immediate copy mode. If you specify this parameter, Veeam Backup & Replication will copy new restore points and transaction logs as soon as they appear. Otherwise, Veeam Backup & Replication will copy data from backups once per backup copy interval. Note: To run the script with the `EnableImmediateCopy` parameter, you must provide the `BackupJob` parameter. To copy transaction logs you must provide the `EnableTransactionLogCopy` parameter.	`SwitchParameter`	False	Named	False
EnableTransactionLogCopy	Defines that the Veeam Agent backup copy job will process transaction logs of the source job.	`SwitchParameter`	False	Named	False
Force	Defines that the cmdlet will ADD INFO without showing warnings in the PowerShell console.	`SwitchParameter`	False	Named	False
GFSOptions	Specifies a GFS retention. The cmdlet will create Veeam Agent backup copy job with the specified policy. Note: This option is not available for Veeam Agent policies. Accepts the `VBRComputerGFSOptions` object. To get this object, run the `New-VBRComputerGFSOptions` cmdlet.	`VBRComputerGFSOptions`	False	Named	False
HealthCheckOptions	Specifies the health check schedule for a Veeam Agent backup copy job. The cmdlet will create the job with these settings. Accepts the `VBRFullBackupOptions` object. To create this object, run the `New-VBRFullBackupOptions` cmdlet.	`VBRHealthCheckOptions`	False	Named	False
Name	Specifies a name that you want to assign to a Veeam Agent backup copy job.	`String`	False	Named	False
NotificationOptions	Specifies notification settings for a Veeam Agent backup copy job. The cmdlet will create the job with these settings. Accepts the `VBRNotificationOptions` object. To create this object, run the `New-VBRNotificationOptions` cmdlet.	`VBRNotificationOptions`	False	Named	False
OSPlatform	Specifies the OS of the protected computers: `Linux` `Mac` `Unix` `Windows`	`VBRAgentType`	True	Named	False
RecoveryPointObjective	Specifies a schedule for a Veeam Agent backup copy job with the periodic backup copy mode. The cmdlet will create the job with these settings. Accepts the `VBRRecoveryPointObjective` object. To create this object, run the `Get-VBRRecoveryPointObjective` cmdlet.	`VBRRecoveryPointObjective`	False	Named	False
Repository	Specifies the target backup repository. The cmdlet will copy the machine data to this repository. Default: Default backup repository. Accepts the `CBackupRepository` object. To create this object, run the `Get-VBRBackupRepository` cmdlet.	`CBackupRepository`	False	Named	False
RetentionNumber	For the `RetentionType` set to the `RestoreDays` property. Specifies a number of days for which you want to store backup files in the target location. Default: 7 days.	`Int32`	False	Named	False
RetentionPolicy	Specifies a retention policy for a Veeam Agent backup copy job. The cmdlet will create the job with these settings. You can specify the following types of retention policies: Simple retention policy: use this option for short-time archiving. To create a job with this type of the policy, provide the `VBRSimpleRetentionPolicy` object. Run the `New-VBRSimpleRetentionPolicy` cmdlet to create this object. GFS retention policy: use this option for long-term archiving. To create a job with this type of the policy, provide the `VBRRetentionPolicy` object. Run the `New-VBRGFSRetentionPolicy` cmdlet to create this object. Accepts the following objects: `VBRRetentionPolicy`. Run the `New-VBRGFSRetentionPolicy` cmdlet to get this object. `VBRSimpleRetentionPolicy`. Run the `New-VBRSimpleRetentionPolicy` cmdlet to create this object.	`VBRRetentionPolicy`	False	Named	False
RetentionType	Specifies retention type for Veeam Agent copy jobs managed by the Veeam Backup server. You can specify one of the following types: `RestorePoints` `RestoreDays`	`VBRRetentionType`	False	Named	False
RPOWarningOptions	Specifies a period of time when data must be copied from the source repository to the target repository. Default: `1 hour`. Accepts the `VBRRPONotificationOptions[]` object. To create this object, run the `New-VBRRPONotificationOption` cmdlet.	`VBRRpoNotificationOption[]`	False	Named	False
ScriptOptions	Specifies pre-job and post-job script options for a Veeam Agent backup copy job. The cmdlet will create the job with these settings. Accepts the `VBRJobScriptOptions` object. To create this object, run the `New-VBRJobScriptOptions` cmdlet.	`VBRJobScriptOptions`	False	Named	False
SourceAccelerator	Specifies the WAN accelerator on the source side. Remember to set the pair of source and target WAN accelerators. Accepts the `CWanAccelerator` object. To get this object, run the `Get-VBRWANAccelerator` cmdlet.	`CWanAccelerator`	True	Named	False
SourceRepository	Specifies an array of source backup repositories. Accepts the `CBackupRepository[]` object. To create this object, run the `Get-VBRBackupRepository` cmdlet.	`CBackupRepository[]`	False	Named	True (ByPropertyName)
StorageOptions	Specifies the storage settings of the backup repository. The cmdlet will create the Veeam Agent backup copy job with these settings. Accepts the `VBRBackupCopyJobStorageOptions` object. To create this object, run the `New-VBRBackupCopyJobStorageOptions` cmdlet.	`VBRBackupCopyJobStorageOptions`	False	Named	False
TargetAccelerator	Specifies the WAN accelerator on the target side. Remember to set the pair of source and target WAN accelerators. Accepts the `CWanAccelerator` object. To get this object, run the `Get-VBRWANAccelerator` cmdlet.	`CWanAccelerator`	False	Named	False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

The cmdlet returns the VBRComputerBackupCopyJob object that contains settings of Veeam Agent backup copy jobs.

Examples

Add-VBRComputerBackupCopyJob (obsolete) Example 1. Creating Veeam Agent Backup Copy Job to Transfer Data Directly

This example shows how to create a Veeam Agent backup copy job that will transfer data directly from the source backup repository to the target backup repository.

$repository = Get-VBRBackupRepository -Name Repository 05

$job = Get-VBRComputerBackupJob -Name "Agent backup job 05"

Add-VBRComputerBackupCopyJob -OSPlatform Windows -DirectOperation -Name "Agent Backup Copy 05" -BackupJob $job -Repository $repository

Perform the following steps:

Run the Get-VBRBackupRepository cmdlet. Specify the Name parameter value. Save the result to the $repository variable.
Run the Get-VBRComputerBackupJob cmdlet. Specify the Name parameter value. Save the result to the $job variable.
Run the Add-VBRComputerBackupCopyJob cmdlet. Specify the following settings:
- Specify the OSPlatform parameter value.
- Provide the DirectOperation parameter.
- Specify the Name parameter value.
- Set the $job variable as the BackupJob parameter value.
- Set the $repository variable as the Repository parameter value.

Add-VBRComputerBackupCopyJob (obsolete) Example 2. Creating Veeam Agent Backup Copy Job to Transfer Data over WAN Accelerators

This example shows how to create a Veeam Agent backup copy job that will transfer data over WAN accelerators.

$wansource = Get-VBRWANAccelerator -Name "WAN Source"

$wantarget = Get-VBRWANAccelerator -Name "WAN02 Target"

$backup = Get-VBRBackup -Name "Windows Server Backup"

$repository = Get-VBRBackupRepository -Name Repository 05

Add-VBRComputerBackupCopyJob -OSPlatform Windows -SourceAccelerator $wansource -TargetAccelerator $wantarget -Backup $backup -Repository $repository

Perform the following steps:

Run the Get-VBRWANAccelerator cmdlet. Specify the Name parameter value. Save the result to the $wansource variable.
Run the Get-VBRWANAccelerator cmdlet. Specify the Name parameter value. Save the result to the $wantarget variable.
Run the Get-VBRBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable.
Run the Get-VBRBackupRepository cmdlet. Specify the Name parameter value. Save the result to the $repository variable.
Run the Add-VBRComputerBackupCopyJob cmdlet. Specify the following settings:
- Specify the OSPlatform parameter value.
- Set the $wansource variable as the SourceAccelerator parameter value.
- Set the $wantarget variable as the TargetAccelerator parameter value.
- Set the $backup variable as the Backup parameter value.
- Set the $repository variable as the Repository parameter value.