This is an archive version of the document. To get the most up-to-date information, see the current version.

Sync-VBRObjectStorageRepositoryEntityState

Short Description

Rolls back checkpoints located in object storage repositories to the previous state.

Applies to

Platform: VMware, Hyper-V

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

Syntax

This cmdlet provides parameter sets that allow you to:

Roll back checkpoints located in specific object storage repositories.

Sync-VBRObjectStorageRepositoryEntityState -Repository <VBRObjectStorageRepository> -PointInTime <datetime> [-RunAsync] [<CommonParameters>]

Roll back checkpoints in object storage repositories for the specified job.

Sync-VBRObjectStorageRepositoryEntityState -Job <VBRJob> -PointInTime <Datetime> [-RunAsync] [<CommonParameters>]

Roll back checkpoints in object storage repositories for the specified backup.

Sync-VBRObjectStorageRepositoryEntityState -Backup <CBackup> -PointInTime <Datetime> [-RunAsync] [<CommonParameters>]

Roll back checkpoints in object storage repositories for the specified cloud tenant.

Sync-VBRObjectStorageRepositoryEntityState -Repository <VBRObjectStorageRepository> -TenantId <Guid> -PointInTime <DateTime> [-RunAsync] [<CommonParameters>]

Roll back checkpoints in object storage repositories for the specified cloud tenant backup.

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

Detailed Description

This cmdlet rolls back checkpoints in object storage repositories to the previous state. You may can run this cmdlet if a specific checkpoint in your object storage repository is corrupted and you want to revert back to the previous checkpoint.

You can use the cmdlet for the following types of repositories:

Standalone object storage repositories.
Object storage repositories added as capacity tier extents.

Important

Consider the following:

Run this cmdlet only with checkpoints located in object storage repositories that support the immutability option.
This cmdlet is NOT supported for object storage repositories added as a performance extents of a scale-out backup repository.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Repository	Specifies at object storage repository. The cmdlet will roll back checkpoints located in this repository.	Accepts the VBRObjectStorageRepository object. To create this object, run the Get-VBRObjectStorageRepository cmdlet.	True Note: This parameter is required when you want to synchronize data for a specific job.	Named	False
PointInTime	Specifies a period in time to which you want to roll back a checkpoint.	Accepts the DateTime object. To get this object, run the Get-Date cmdlet.	True	Named	False
Job	Specifies a job. The cmdlet will roll back a checkpoint created by this job.	Accepts the VBRJob object. To get this object, run the Get-VBRJob cmdlet.	True	Named	False
Backup	Specifies a backup. The cmdlet will roll back a checkpoint added to this backup.	Accepts the CBackup object. To get this object, run the Get-VBRBackup cmdlet.	True	Named	False
RunAsync	Defines that the command returns immediately without waiting for the task to complete.	SwitchParameter	False	Named	False
TenantBackupId	Specifies an ID of the cloud tenant backup. The cmdlet will roll back a checkpoint added to this backup.	Guid	True	Named	False
TenantId	Specifies an ID of the cloud tenant. The cmdlet will roll back a checkpoint created by this tenant.	Guid	True	Named	False

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

Output Object

VBRSession

Examples

Example 1. Rolling Back Checkpoints Created by Specific Job

This example shows how to roll back checkpoints created by the BackupJob05 job.

$job = Get-VBRJob -Name "BackupJob05"

Sync-VBRObjectStorageRepositoryEntityState -Job $job -PointInTime "2/20/2023 1:54:26 PM"

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

EndTime : 2/20/2023 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-VBRObjectStorageRepositoryEntityState 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.

Example 2. Rolling Back Checkpoints Located in Specific Object Storage Repository

This example shows how to roll back checkpoints located in the Amazon S3 object storage repository.

$repository = Get-VBRObjectStorageRepository -Name "Amazon S3"

StartDateUtc EndDateUtc

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

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

Sync-VBRObjectStorageRepositoryEntityState -Repository $repository -PointInTime "2/20/2023 1:54:26 PM"

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

EndTime : 2/20/2023 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-VBRObjectStorageRepository cmdlet. Specify the Name parameter value. Save the result to the $repository variable.
Run the Sync-VBRObjectStorageRepositoryEntityState 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.

Example 3. Synchronizing Data for Specific Backup

This example shows how to roll back checkpoints for the specified backup.

$backup = Get-VBRBackup -Name "BackupJob05"

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

Sync-VBRObjectStorageRepositoryEntityState -Backup $backup -PointInTime $date

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

EndTime : 2/20/2023 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 $backup 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-VBRObjectStorageRepositoryEntityState 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.

Related Commands