Get-VBRCapacityTierSyncInterval

In this article

    Short Description

    Returns a time period of checkpoints in capacity tier that are available for synchronization.

    Applies to Amazon S3, S3 Compatible

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

    Syntax

    This cmdlet provides parameter sets that allow you to:

    • Get a time period of checkpoints that are available for synchronization.

    Get-VBRCapacityTierSyncInterval -Repository <VBRScaleOutBackupRepository>  [<CommonParameters>]

    • Get a time period of checkpoints that are available for synchronization for the specified job.

    Get-VBRCapacityTierSyncInterval -Repository <VBRScaleOutBackupRepository> -Job <VBRJob>  [<CommonParameters>]

    • Get a time period of checkpoints that are available for synchronization for the specified backup.

    Get-VBRCapacityTierSyncInterval -Repository <VBRScaleOutBackupRepository> -Backup <CBackup>  [<CommonParameters>]

    Detailed Description

    This cmdlet returns a time period of checkpoints in capacity tier that are available for synchronization. You may want to run this cmdlet before you synchronize the state of the backup chains on performance tier with the state of the backup chains on capacity tier for the specific period of time.

    Run the Sync-VBRSOBREntityState cmdlet to synchronize the state of the backup chains.

    Get-VBRCapacityTierSyncInterval Important!

    This cmdlet applies only for object storage that support the Immutability option.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Repository

    Specifies a scale-out backup repository. The cmdlet will return a time period that contains checkpoints that were moved from this scale-out backup repository but are still available on the capacity tier.

    Accepts the VBRScaleOutBackupRepository object. To get this object, run the Get-VBRBackupRepository cmdlet.

    True

    Named

    True (ByValue)

    Job

    Specifies a job. The cmdlet will return a time period that contains checkpoints on the capacity tier for this job.

    Accepts the VBR  Job object. To get this object, run the Get-VBRJob cmdlet.

    True

    Named

    False

    Backup

    Specifies a backup. The cmdlet will return a time period that contains checkpoints on the capacity tier for this backup.

    Accepts the CBackup object. To get this object, run the Get-VBRBackup cmdlet.

    True

    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

    This cmdlet returns the VBRCapacityTierSyncInterval object that contains details on a time period of checkpoints in capacity tier that are available for synchronization

    Examples

    Get-VBRCapacityTierSyncIntervalExample 1. Getting Time Period for all Checkpoints Available on Capacity Tier

    This example shows how to get a time period with contains checkpoints on capacity tier that are available for synchronization.

    $repository = Get-VBRBackupRepository -ScaleOut

    Get-VBRCapacityTierSyncInterval -Repository $repository

     

    StartDateUtc                                                EndDateUtc

    ------------                                                ----------

    2/20/2020 1:54:26 PM                                        2/20/2020 1:54:26 PM

    Perform the following steps:

    1. Run the Get-VBRBackupRepository cmdlet. Provide the ScaleOut parameter value. Save the result to the $repository variable.
    2. Run the Get-VBRCapacityTierSyncInterval cmdlet. Set the $repository variable as the Repository parameter value.

    The cmdlet output will contain the following details on the time period for the checkpoints: StartDateUtc and EndDateUtc.

    Get-VBRCapacityTierSyncIntervalExample 2. Getting Time Period of Checkpoints for Specific Job

    This example shows how to get a time period that contains checkpoints on capacity tier that you can synchronize for the Backup05 job.

    $repository = Get-VBRBackupRepository -ScaleOut

    $job = Get-VBRJob -Name "Backup05"

    Get-VBRCapacityTierSyncInterval -Repository $repository -Job $job

     

    StartDateUtc                                                EndDateUtc

    ------------                                                ----------

    2/20/2020 1:54:26 PM                                        2/20/2020 1:54:26 PM

    Perform the following steps:

    1. Run the Get-VBRBackupRepository cmdlet. Provide the ScaleOut parameter value. Save the result to the $repository variable.
    2. Run the Get-VBRJob cmdlet. Specify the Name parameter value. Save the result to the $job variable.
    3. Run the Get-VBRCapacityTierSyncInterval cmdlet. Set the $repository variable as the Repository parameter value. Set the $job variable as the Job parameter value.

    The cmdlet output will contain the following details on the time period for the checkpoints: StartDateUtc and EndDateUtc.

    Get-VBRCapacityTierSyncIntervalExample 3. Getting Time Period of Checkpoints for Specific Backup

    This example shows how to get a time period that contains details on checkpoints on capacity tier that you can synchronize for the Report05 backup.

    $repository = Get-VBRBackupRepository -ScaleOut

    $backup = Get-VBRBackup -Name "Report05"

    Get-VBRCapacityTierSyncInterval -Repository <VBRScaleOutBackupRepository> -Backup $backup

     

    StartDateUtc                                                EndDateUtc

    ------------                                                ----------

    2/20/2020 1:54:26 PM                                        2/20/2020 1:54:26 PM

    Perform the following steps:

    1. Run the Get-VBRBackupRepository cmdlet. Provide the ScaleOut parameter value. Save the result to the $repository variable.
    2. Run the Get-VBRBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable.
    3. Run the Get-VBRCapacityTierSyncInterval cmdlet. Set the $repository variable as the Repository parameter value. Set the $backup variable as the Backup parameter value.

    The cmdlet output will contain the following details on the time period for the checkpoints: StartDateUtc and EndDateUtc.

    Related Commands

    I want to report a typo

    There is a misspelling right here:

     

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