Get-VBORepositorySynchronizeSession

Short Description

Returns synchronization sessions of object storage cache.

Syntax

This cmdlet provides parameter sets that allow you to:

Get all synchronization sessions of object storage.

Get-VBORepositorySynchronizeSession [<CommonParameters>]

Get synchronization session for a specific object storage.

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

Detailed Description

This cmdlet returns sessions that are running to synchronize cache located in object storage with backup repositories.

Parameters

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

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Accept Wildcard Characters

Repository

Specifies a backup repository. The cmdlet will synchronize cache located on object storage with the specified repository.

Accepts the VBORepository object.

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

False

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

Get-VBORepositorySynchronizeSession Example 1. Getting All Synchronization Sessions

This command returns all sessions that are running to synchronize cache located in object storage.

Get-VBORepositorySynchronizeSession

Get-VBORepositorySynchronizeSession Example 2. Getting Synchronization Sessions of Specific Object Storage

This example shows how to get sessions that are running to synchronize cache on the specific object storage.

$azurestorage = Get-VBORepository -Name "Azure"

Get-VBORepositorySynchronizeSession -Repository $azurestorage

Perform the following steps:

Run the Get-VBORepository cmdlet. Specify the Name parameter value. Save the result to the $azurestorage variable.
Run the Get-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.

Related Commands

Get-VBORepository