Sync-VBRBackupCopyJob

In this article

    Short Description

    Synchronizes backup copy job data.

    Applies to

    Platform: VMware, Hyper-V

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

    Syntax

    Sync-VBRBackupCopyJob -Job <IJob> [-FullBackup]  [<CommonParameters>]

    Detailed Description

    This cmdlet starts manual data synchronization for the selected backup copy job.

    The backup copy job runs continuously synchronizing the backup repositories in user-defined time periods. With this cmdlet, you can synchronize the source and the target repositories manually.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Job

    Specifies the backup copy job. The cmdlet will synchronize this job.

    Accepts object containing a backup copy job or string type.

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    False

    FullBackup

    Indicates that the job will create an active full backup.

    False

    Named

    False

    False

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

    Example 1

    This command synchronizes the "AD Backup Copy" job using pipeline.

    1. Run Get-VBRJob to get the job.
    2. Pipe it to Sync-VBRBackupCopyJob.

    Get-VBRJob -Name "AD Backup Copy" | Sync-VBRBackupCopyJob

    Example 2

    This command synchronizes the "AD Backup Copy" job using variable.

    1. Run Get-VBRJob to get the job. Save it to the $ad variable.
    2. Run Sync-VBRBackupCopyJob with this variable.

    $ad = Get-VBRJob -Name "AD Backup Copy"

    Sync-VBRBackupCopyJob -Job $ad

    Example 3

    This command creates an active full for the "AD Backup Copy" job.

    1. Run Get-VBRJob to get the job. Save it to the $ad variable.
    2. Run Sync-VBRBackupCopyJob with this variable and FullBackup parameter.

    $ad = Get-VBRJob -Name "AD Backup Copy"

    Sync-VBRBackupCopyJob -Job $ad -FullBackup

    Related Commands

    Get-VBRJob

    I want to report a typo

    There is a misspelling right here:

     

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