Get-VBORepositorySynchronizeSession

In this article

    Short Description

    Returns synchronization sessions of object storage repositories cache.

    Syntax

    This cmdlet provides parameter sets that allow you to:

    • Get all synchronization sessions of object storage repositories.

    Get-VBORepositorySynchronizeSession  [<CommonParameters>]

    • Get synchronization session for a specific object storage repository.

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

    Detailed Description

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

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Accept Wildcard Characters

    Repository

    Specifies the backup repository. The cmdlet will sync cache located on this object storage with the specified repository.

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

    False

    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

    The cmdlet returns the VBORepositorySynchronizeSession object that contains details on the synchronization status of the object storage repository.

    Examples

    Get-VBORepositorySynchronizeSessionExample 1. Getting all Synchronization Sessions

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

    Get-VBORepositorySynchronizeSession

    Get-VBORepositorySynchronizeSessionExample 2. Getting Sync Sessions of Specific Object Storage Repository

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

    $azurestorage = Get-VBORepository -Name "Azure"

    Get-VBORepositorySynchronizeSession -Repository $azurestorage

    Perform the following steps:

    1. Run the Get-VBORepository cmdlet. Specify the Name parameter value. Save the result to the $azurestorage variable.
    2. 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 repository: RepositoryId, RepositoryName and Status.

    Related Commands

    Get-VBORepository

    I want to report a typo

    There is a misspelling right here:

     

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