Sync-VBRSOBREntityState

Short Description

Synchronizes the state of backup chains on performance extents with the state of data on capacity and archive extents of a scale-out backup repositories.

Syntax

This cmdlet provides the following parameter sets:

Job

Sync-VBRSOBREntityState -Job <VBRJob> -PointInTime <DateTime> [-ArchiveTier] [-RunAsync] [<CommonParameters>]
Repository

Sync-VBRSOBREntityState -Repository <VBRScaleOutBackupRepository> -PointInTime <DateTime> [-ArchiveTier]

[-RunAsync] [<CommonParameters>]
TenantId

Sync-VBRSOBREntityState -Repository <VBRScaleOutBackupRepository> -TenantId <Guid> -PointInTime <DateTime>

[-ArchiveTier] [-RunAsync] [<CommonParameters>]
Backup

Sync-VBRSOBREntityState -Backup <CBackup> -PointInTime <DateTime> [-ArchiveTier] [-RunAsync] [<CommonParameters>]
TenantBackupId

Sync-VBRSOBREntityState -TenantBackupId <Guid> -PointInTime <DateTime> [-ArchiveTier] [-RunAsync] [<CommonParameters>]

Detailed Description

This cmdlet synchronizes the state of backup chains on performance extents of scale-out backup repositories with the state of data on capacity and archive extents of scale-out backup repositories for the specific period of time.

Run the Get-VBRCapacityTierSyncInterval cmdlet to get details on the period of time when checkpoints in the capacity tier are available for synchronization.

Run the Get-VBRArchiveTierSyncInterval cmdlet to get details on the period of time when checkpoints in the archive tier are available for synchronization.

Important

Use this cmdlet only with object storage that support the immutability option.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
ArchiveTier	Defines that the cmdlet will synchronize the state of backup chains on performance extents with the state of backup chains located in the archive tier. If you do not provide this parameter, the cmdlet will synchronizes the state of backup chains on performance extents with the state of backup chains on the capacity extent. Default: `False`.	`SwitchParameter`	False	Named	False
Backup	Specifies a backup. The cmdlet will synchronize data for a specified period in time from the capacity extent for these backups. Accepts the `CBackup` object. To get this object, run the `Get-VBRBackup` cmdlet	`CBackup`	True	Named	False
Job	Specifies a job. The cmdlet will synchronize data for a specified period in time from the capacity extent for this job. Accepts the `VBRJob` object. To get this object, run the `Get-VBRJob` cmdlet	`VBRJob`	True	Named	False
PointInTime	Specifies a period in time to which you want to restore data. The cmdlet will synchronize data from the capacity extent to the specified period.	`DateTime`	True	Named	False
Repository	Specifies a scale-out backup repository. The cmdlet will synchronize data for a specified period in time from the capacity extent for this repository.	`VBRScaleOutBackupRepository`	True	Named	False
RunAsync	Defines that the command returns immediately without waiting for the task to complete.	`SwitchParameter`	False	Named	False
TenantBackupId	Specifies a ID of the tenant backup.	`Guid`	True	Named	False
TenantId	Specifies s tenant ID.	`Guid`	True	Named	False

<CommonParameters>

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

Output Object

VBRSession

Examples

Sync-VBRSOBREntityState Example 1. Synchronizing Data for Specific Job

This example shows how to synchronize data that is stored in the capacity extent for the BackupJob05 job.

$job = Get-VBRJob -Name "BackupJob05"

Sync-VBRSOBREntityState -Job $job -PointInTime "2/20/2020 1:54:26 PM"

CreationTime : 2/20/2020 6:26:59 AM

EndTime : 2/20/2020 6:28:24 AM

JobId : 876cddc2-2879-484e-9680-7b5b2261fa30

Result : Success

State : Stopped

Id : ae8fccee-78e5-4e73-a98d-0069fd61032f

Perform the following steps:

Run the Get-VBRJob cmdlet. Specify the Name parameter value. Save the result to the $job variable.
Run the Sync-VBRSOBREntityState cmdlet. Set the $job variable as the Job parameter value. Specify the PointInTime parameter value.

The cmdlet output will contain the following details on the time period for the checkpoints: CreationTime, EndTime, JobId, Result, State, and Id.

Sync-VBRSOBREntityState Example 2. Synchronizing Data for Scale-Out Backup Repository

This example shows how to synchronize data that is stored in the capacity extent for the specified scale-out backup repository.

$repository = Get-VBRBackupRepository -ScaleOut

Get-VBRCapacityTierSyncInterval -Repository $repository

StartDateUtc EndDateUtc

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

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

Sync-VBRSOBREntityState -Repository $repository -PointInTime "2/20/2020 1:54:26 PM"

CreationTime : 2/20/2020 6:26:59 AM

EndTime : 2/20/2020 6:28:24 AM

JobId : 23e57bae-a759-42a2-a47e-06219ac410df

Result : Success

State : Stopped

Id : 10957ec5-adc9-418c-a708-2f24ba11d40e

Perform the following steps:

Run the Get-VBRBackupRepository cmdlet. Provide the ScaleOut parameter value. Save the result to the $repository variable.
Run the Get-VBRCapacityTierSyncInterval cmdlet. Set the $repository variable as the Repository parameter value.
Run the Sync-VBRSOBREntityState cmdlet. Set the $repository variable as the Repository parameter value. Specify the PointInTime parameter value.

The cmdlet output will contain the following details on the time period for the checkpoints: CreationTime, EndTime, JobId, Result, State, and Id.

Sync-VBRSOBREntityState Example 3. Synchronizing Data for Specific Backup

This example shows how to synchronize data that is stored on extents for the specified backup.

$backup = Get-VBRBackup -Name "BackupJob05"

$date = Get-Date -Year 2020 -Month 2 -Day 2 -Hour 0 -Minute 0 -Second 0

Sync-VBRSOBREntityState -Backup $backup -PointInTime $date

CreationTime : 2/20/2020 6:26:59 AM

EndTime : 2/20/2020 6:28:24 AM

JobId : a1116d74-6d0e-4449-813e-08d094d355c1

Result : Success

State : Stopped

Id : 3cb43bcc-86fc-48a2-b08b-c79d4bfb7183

Perform the following steps:

Run the Get-VBRBackup cmdlet. Specify the Name parameter value. Save the result to the $job variable.
Run the Get-Date cmdlet. Specify the Year, Month, Day, Hour, Minute and Second parameter values. Save the result to the $date variable.
Run the Sync-VBRSOBREntityState cmdlet. Set the $backup variable as the Backup parameter value. Set the $date variable as the PointInTime parameter value.

The cmdlet output will contain the following details on the time period for the checkpoints: CreationTime, EndTime, JobId, Result, State, and Id.