Set-VBRComputerBackupCopyJob
Short Description
Modifies Veeam Agent backup copy jobs.
Applies to
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Set-VBRComputerBackupCopyJob -Job <VBRComputerBackupCopyJob> [-Name <string>] [-Description <string>] [-Backup <CBackup[]>] [-BackupJob <VBRComputerBackupJob[]>] [-Repository <CBackupRepository>] [-DirectOperation][-SourceAccelerator <CWanAccelerator>] [-TargetAccelerator <CWanAccelerator>] [-RecoveryPointObjective <VBRRecoveryPointObjective>] [-RetentionPolicy <VBRRetentionPolicy>] [-BackupWindowOptions <VBRBackupWindowOptions>] [-NotificationOptions <VBRNotificationOptions>] [-StorageOptions <VBRBackupCopyJobStorageOptions>] [-HealthCheckOptions <VBRFullBackupOptions>] [-ScriptOptions <VBRJobScriptOptions>] [-RPOWarningOptions <VBRRpoNotificationOptions>] [-EnableRPOWarning][-EnableTransactionLogCopy] [-AnyTime] [<CommonParameters>] |
Detailed Description
This cmdlet modifies Veeam Agent backup copy jobs.
Parameters
Parameter | Description | Type | Required | Position | Accept Pipeline Input |
Job | Specifies a Veeam Agent backup copy job that you want to modify. | Accepts the VBRComputerBackupCopyJob object. To create this object, run the Get-VBRComputerBackupCopyJob cmdlet. | True | Named | True (ByValue) |
Name | Specifies a name that you want to assign to a Veeam Agent backup copy job. | String | False | Named | False |
Description | Specifies a description of a Veeam Agent backup copy job. | String | False | Named | False |
Backup | Specifies an array of backups. The cmdlet will add machines from these backups to a Veeam Agent backup copy. 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. | False | Named | True (ByValue, ByPropertyName) |
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. | False | Named | True (ByPropertyName) |
Repository | Specifies the backup repository. The cmdlet will copy the machine data to this repository. Default: Default backup repository. | Accepts the CBackupRepository object. To get this object, run the Get-VBRBackupRepository cmdlet. | 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 | 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-VBRWANAcceleratorcmdlet. | 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-VBRWANAcceleratorcmdlet. | False | 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. | 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:
| Accepts the following objects:
| False | Named | False |
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. | 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. | False | Named | False |
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. | 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. | 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. | 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-VBRRPONotificationOptions cmdlet. | False | Named | False |
EnableRPOWarning | Defines that the cmdlet will display a warning in case the job exceeds the period that is set for the job to copy data from the source repository to the target repository. Use the RPOWarningOptions parameter to specify the limitation. | 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 |
AnyTime | Defines that Veeam Backup & Replication will run a Veeam Agent backup copy job at any time according to its schedule. | 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 VBRComputerBackupCopyJob object that contains settings of Veeam Agent backup copy jobs.
Examples
Modifying Backup Window Settings for Veeam Agent Backup Copy Job
The following example shows how to modify backup window settings for a Veeam Agent Backup Copy job.
$job = Get-VBRComputerBackupCopyJob -Name "Windows Copy Job05" $windowoptions = New-VBRBackupWindowOptions -FromDay Monday -FromHour 08 -ToDay Friday -ToHour 20 Set-VBRComputerBackupCopyJob -Job $job -BackupWindowOptions $windowoptions |
Perform the following steps:
- Run the Get-VBRComputerBackupCopyJob cmdlet. Specify the Name parameter value. Save the result to the $job variable.
- Run the New-VBRBackupWindowOptions cmdlet. Specify the necessary parameters. Save the result to the $windowoptions variable.
- Run the Set-VBRComputerBackupCopyJob cmdlet. Set the $job variable as the Job parameter value. Set the $windowoptions variable as the BackupWindowOptions parameter value.
Related Commands