Start-VBORepositorySynchronizeSession

Short Description

Starts to synchronize cache located in object storage.

Syntax

Start-VBORepositorySynchronizeSession -Repository <VBORepository> [<CommonParameters>]

Detailed Description

This cmdlet starts to synchronize cache located in object storage with that of an on-premises backup repository. You can run this cmdlet if you have extended backup repository with object storage, and it already contains some data that you want to synchronize with the local cache.

For more information on cache synchronization, see the Synchronizing Repositories section of the Veeam Backup for Microsoft 365 User Guide.

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
Repository	Specifies a backup repository. The cmdlet will synchronize object storage with this backup repository.	Accepts the VBORepository object. To get this object, run the Get-VBORepository cmdlet.	True	Named	False	False

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Accept Wildcard Characters

Repository

Specifies a backup repository. The cmdlet will synchronize object storage with this backup repository.

Accepts the VBORepository object.

To get this object, run the Get-VBORepository cmdlet.

True

Named

False

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 VBORepositorySynchronizeSession object that contains details on the synchronization status of object storage.

Examples

Start-VBORepositorySynchronizeSession Example 1. Synchronizing Microsoft Azure Blob Storage Cache

This example shows how to start synchronizing Microsoft Azure Blob Storage cache with the backup repository.

$azurestorage = Get-VBORepository -Name "Azure"

Start-VBORepositorySynchronizeSession -Repository $azurestorage

RepositoryId RepositoryName Status

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

1e74b71a-def4-41c6-8826-5d6fc8ad7c0f Azure Synchronizing... (35%)

Perform the following steps:

Run the Get-VBORepository cmdlet. Specify the Name parameter value. Save the result to the $azurestorage variable.
Run the Start-VBORepositorySynchronizeSession cmdlet. Set the $azurestorage variable as the Repository parameter value.

The cmdlet output will contain the following details on synchronization status of object storage: RepositoryId, RepositoryName and Status.

Start-VBORepositorySynchronizeSession Example 2. Synchronizing Amazon S3 Object Storage

This example shows how to start synchronizing Amazon S3 object storage cache with the backup repository.

$amazonstorage = Get-VBORepository -Name "Amazon S3"

Start-VBORepositorySynchronizeSession -Repository $amazonstorage

RepositoryId RepositoryName Status

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

d745ba88-719d-4bc6-883a-5559e001ac62 Amazon S3 Synchronizing... (68%)

Perform the following steps:

Run the Get-VBORepository cmdlet. Specify the Name parameter value. Save the result to the $amazonstorage variable.
Run the Start-VBORepositorySynchronizeSession cmdlet. Set the $amazonstorage variable as the Repository parameter value.

The cmdlet output will contain the following details on synchronization status of object storage: RepositoryId, RepositoryName and Status.

Start-VBORepositorySynchronizeSession Example 3. Synchronizing S3 Compatible Object Storage

This example shows how to start synchronizing S3 Compatible object storage cache with the backup repository.

$s3compatible = Get-VBORepository -Name "S3 Compatible object storage"

Start-VBORepositorySynchronizeSession -Repository $s3compatible

RepositoryId RepositoryName Status

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

af061087-7b8b-4c76-84b7-8a2858b15ae6 S3 Compatible object storage Synchronizing... (51%)

Perform the following steps:

Run the Get-VBORepository cmdlet. Specify the Name parameter value. Save the result to the $s3compatible variable.
Run the Start-VBORepositorySynchronizeSession cmdlet. Set the $s3compatible variable as the Repository parameter value.

The cmdlet output will contain the following details on synchronization status of object storage: RepositoryId, RepositoryName and Status.

Related Commands

Get-VBORepository